Get users with metadata
Use GET /v1/accounts/{account-uuid}/users to get all users with metadata.
Endpoint
/v1/accounts/{account-uuid}/users
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| account-uuid | string | - | path | required |
| groupName | string | - | query | optional |
| userName | string | - | query | optional |
| userSurname | string | - | query | optional |
| userCompany | string | - | query | optional |
| userEmail | string | - | query | optional |
| userUid | string | - | query | optional |
| userStatus | string | - | query | optional |
| pageNumber | integer | - | query | optional |
| pageSize | integer | - | query | optional |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Rest | Get users |
| 404 | ExceptionMessage | Could not find requested account |
Response body objects
The ResponseBody object
The object doesn't provide any parameters.
The RestUser object
| Element | Type | Description |
|---|---|---|
| uid | string | - |
| string | - | |
| name | string | - |
| surname | string | - |
| password | string | - |
| company | string | - |
| countryCode | string | - |
| userStatus | string | - |
| accountUuids | string[] | - |
| ownerAccountUuid | string | - |
| type | string | - |
| dcsActive | boolean | - |
| passwordChangedAt | string | - |
| userLoginMetadata | Rest | - |
| createdAt | string | - |
| updatedAt | string | - |
The RestUserLoginMetadata object
| Element | Type | Description |
|---|---|---|
| successfulLoginCounter | integer | - |
| failedLoginCounter | integer | - |
| lastSuccessfulLogin | string | - |
| lastFailedLogin | string | - |
| resetPasswordTokenSentAt | string | - |
| lastSuccessfulBasicAuthentication | string | - |
| createdAt | string | - |
| updatedAt | string | - |
Response body JSON model
[
{
"uid": "string",
"email": "string",
"name": "string",
"surname": "string",
"password": "string",
"company": "string",
"countryCode": "string",
"userStatus": "string",
"accountUuids": [
"string"
],
"ownerAccountUuid": "string",
"type": "string",
"dcsActive": true,
"passwordChangedAt": "string",
"userLoginMetadata": {
"successfulLoginCounter": 1,
"failedLoginCounter": 1,
"lastSuccessfulLogin": "string",
"lastFailedLogin": "string",
"resetPasswordTokenSentAt": "string",
"lastSuccessfulBasicAuthentication": "string",
"createdAt": "string",
"updatedAt": "string"
},
"createdAt": "string",
"updatedAt": "string"
}
]