MeDto
The authenticated user: profile, application roles and the tenants they belong to. The same whichever credential
authenticated the request; with an API key it is the key's owner.
Properties
| Name | Type | Description |
|---|---|---|
| code | string | The user's identifier (the same code the tenant's member list shows) |
The user's identifier (the same code the tenant's member list shows) | ||
| email* | string | Email address (also the sign-in name) |
Email address (also the sign-in name) | ||
| firstName | string | First name |
First name | ||
| lastName | string | Last name |
Last name | ||
| phoneNumber | string | Phone number (PUT /me replaces it, so a client editing the profile needs the current value) |
Phone number (PUT /me replaces it, so a client editing the profile needs the current value) | ||
| fullName* | string | First and last name, or the email address when neither is set |
First and last name, or the email address when neither is set | ||
| isEmailVerified* | boolean | Whether the email address has been verified |
Whether the email address has been verified | ||
| isSuperAdmin* | boolean | Whether the user is a super admin (application-wide administration) |
Whether the user is a super admin (application-wide administration) | ||
| isSupportAgent* | boolean | Whether the user is a support agent |
Whether the user is a support agent | ||
| canAccessBetaFeatures* | boolean | Whether the user can access beta features |
Whether the user can access beta features | ||
| managesMultipleTenants* | boolean | Whether the user manages several tenants on behalf of others (an accountant or bookkeeper), which changes how the |
Whether the user manages several tenants on behalf of others (an accountant or bookkeeper), which changes how the | ||
| roles* | array of string | Application roles (User, SuperAdmin, SupportAgent, BetaTester, HmrcXmlViewer). Every user has User. |
Application roles (User, SuperAdmin, SupportAgent, BetaTester, HmrcXmlViewer). Every user has User. | ||
| tenants* | array of TenantMembershipDto | The tenants the user is a member of, with the user's access level and the tenant's modules |
The tenants the user is a member of, with the user's access level and the tenant's modules | ||
JSON Example
{
"code": "00000000-0000-0000-0000-000000000000",
"email": "string",
"firstName": "string",
"lastName": "string",
"phoneNumber": "string",
"fullName": "string",
"isEmailVerified": false,
"isSuperAdmin": false,
"isSupportAgent": false,
"canAccessBetaFeatures": false,
"managesMultipleTenants": false,
"roles": [
"string"
],
"tenants": [
{
"code": "...",
"name": "...",
"accessLevel": "...",
"modules": "...",
"logoUrl": "..."
}
]
}