Get users with groups
Use GET /v1/accounts/{account-uuid}/users/groups
to get all users with groups.
Endpoint
/v1/accounts/{account-uuid}/users/groups
Parameters
Parameter | Type | Description | In | Required |
---|---|---|---|---|
account-uuid | string | - | path | required |
pageNumber | integer | - | query | optional |
pageSize | integer | - | query | optional |
Response
Response codes
Code | Type | Description |
---|---|---|
200 | Rest | Get users |
404 | Exception | Could not find requested account |
Response body objects
The RestUserWithGroups
object
Element | Type | Description |
---|---|---|
uid | string | - Can be |
string | - Can be | |
name | string | - Can be |
surname | string | - Can be |
password | string | - Can be |
company | string | - Can be |
countryCode | string | - Can be |
userStatus | string | - Can be |
accountUuids | string[] | - Can be |
ownerAccountUuid | string | - Can be |
type | string | - Can be |
dcsActive | boolean | - Can be |
passwordChangedAt | string | - Can be |
userLoginMetadata | Rest | - Can be |
createdAt | string | - Can be |
updatedAt | string | - Can be |
groups | Rest | - Can be |
The RestUserLoginMetadata
object
Element | Type | Description |
---|---|---|
successfulLoginCounter | integer | - Can be |
failedLoginCounter | integer | - Can be |
lastSuccessfulLogin | string | - Can be |
lastFailedLogin | string | - Can be |
resetPasswordTokenSentAt | string | - Can be |
lastSuccessfulBasicAuthentication | string | - Can be |
createdAt | string | - Can be |
updatedAt | string | - Can be |
The RestUserGroup
object
Element | Type | Description |
---|---|---|
groupName | string | - Can be |
uuid | string | - Can be |
owner | string | - Can be |
description | string | - Can be |
accountUUID | string | - Can be |
accountName | string | - Can be |
federatedAttributeValues | string[] | - Can be |
createdAt | string | - Can be |
updatedAt | string | - Can be |
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",
"groups": [
{
"groupName": "string",
"uuid": "string",
"owner": "string",
"description": "string",
"accountUUID": "string",
"accountName": "string",
"federatedAttributeValues": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
]
}
]