| Property | Description | Returns |
|---|---|---|
| groups | Get the groups this user('s person) belongs to | Collection |
| frontendUser | Check whether the user is a frontend user | bool |
| backendUser | Check whether the user is a backend user | bool |
| admin | Check whether the user is an admin. Doesn't check if he is an admin for the current site. Also returns true if the user is a developer or a superadmin. | bool |
| superAdmin | Check whether the user is a superadmin. Also returns true if the user is a developer. | bool |
| developer | Check whether the user is a developer. | bool |
| fullName | Get the full name for the user | string |
| active | Is user active? | bool |
| statusLabels | Gets all available statuses with their labels | array |
| statusDisplay | Gets status display label | string |
| userOauthClientGroupedByApp | Get User's OAuth authorisations by application | array |
| currentActivity | Get collection of active access tokens | Collection |
| hateoasLinks | Get the HATEOAS links for the record | array |
| deleteUrl | Get the url for deleting the record. | string |
| editUrl | Get the url for editing the record. | string |
| manageUrl | Get the url for managing records. | string |
| id | int | |
| type | string | |
| status | string | |
| username | string | |
| created | Date the record was created. | DateTime |
| modified | Last modification date for the record. | DateTime |
| person | Person | |
| globalUser | GlobalUser | |
| settings | Collection (Setting) | |
| confirmPassword | string | |
| loginTokens | Collection (LoginToken) | |
| refreshTokens | Collection (RefreshToken) | |
| accessTokens | Collection (AccessToken) | |
| userAuthenticators | Collection (UserAuthenticator) | |
| userOauthClients | Collection (UserOauthClient) | |
| customFieldValues | Collection (UserCustomFieldValue) | |
| customFieldContent | Get a serialized representation of the custom fields associated with the record | object |
| customFields | Get the custom fields for this entity | array |
| firstName | Get the first name for the user | string |
| middleName | Get the middle name for the user | string |
| lastName | Get the last name for the user | string |
| Get the email address for the user | string |
Users\Models\Api\User
User