List all groups
Use GET /v2/accounts/{account-uuid}/groups to list all user groups.
Endpoint
/v2/accounts/{account-uuid}/groups
Parameters
| Parameter | Type | Description | In | Required |
|---|---|---|---|---|
| account-uuid | string | - | path | optional |
| groupName | string | - | query | required |
| groupOwner | string | - | query | required |
| pageNumber | integer | - | query | required |
| pageSize | integer | - | query | required |
Response
Response codes
| Code | Type | Description |
|---|---|---|
| 200 | Rest | Get groups |
| 404 | Exception | Could not find requested account |
Response body objects
The RestGroup object
| Element | Type | Description | Required |
|---|---|---|---|
| uuid | string | - | optional |
| name | string | - | optional |
| owner | string | - | optional |
| description | string | - | optional |
| federatedAttributeValues | string[] | - | optional |
| createdAt | string | - | optional |
| updatedAt | string | - | optional |
Response body JSON model
[
{
"uuid": "string",
"name": "string",
"owner": "string",
"description": "string",
"federatedAttributeValues": [
"string"
],
"createdAt": "string",
"updatedAt": "string"
}
]