Get a user's group memberships
Use GET /v1/accounts/{account-uuid}/users/{email}/groups to fetch a user's group memberships.
Endpoint
/v1/accounts/{account-uuid}/users/{email}/groups
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| account-uuid | string | - | path | required |
| string | - | path | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Rest | User groups fetched successfully |
| 400 | ExceptionMessage | Invalid email or account uuid |
| 404 | NotFoundException | User not found or does not belong to account |
Response body objects
The RestUserWithGroups 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 | - |
| groups | Rest | - |
The RestUserLoginMetadata object
| Element | Type | Description |
|---|---|---|
| successfulLoginCounter | integer | - |
| failedLoginCounter | integer | - |
| lastSuccessfulLogin | string | - |
| lastFailedLogin | string | - |
| resetPasswordTokenSentAt | string | - |
| lastSuccessfulBasicAuthentication | string | - |
| createdAt | string | - |
| updatedAt | string | - |
The RestUserGroup object
| Element | Type | Description |
|---|---|---|
| groupName | string | - |
| uuid | string | - |
| owner | string | - |
| description | string | - |
| accountUUID | string | - |
| accountName | string | - |
| federatedAttributeValues | 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",
"groups": [
{
"groupName": "string",
"uuid": "string",
"owner": "string",
"description": "string",
"accountUUID": "string",
"accountName": "string",
"federatedAttributeValues": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
]
}