Akamai APIs API Documentation
List groups
GET https://{{host}}/identity-management/v3/user-admin/groups
This operation lists all groups the administrator can manage for the current account and contract type or other managed accounts using the accountSwitchKey parameter. The account and contract type are determined by the access tokens in your API client.
Body
PARAM
| Key | Datatype | Required | Description |
actions
|
string | (Optional) Includes information about actions such as `edit` or `delete` that you can take for the object, `false` by default. Don't confuse this with the `action` parameter, which applies to the [Set two-factor authentication](https://techdocs.akamai.com/iam-api/reference/put-user-profile-tfa) operation. | |
accountSwitchKey
|
string | (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys). |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| [
{
"actions": {
"delete": false,
"edit": true
},
"createdBy": "szhang",
"createdDate": "2012-04-28T00:00:00.000Z",
"groupId": 12345,
"groupName": "Main Street Corporation",
"modifiedBy": "hgildong",
"modifiedDate": "2012-04-28T00:00:00.000Z",
"subGroups": [
{
"actions": {
"delete": false,
"edit": true
},
"createdBy": "szhang",
"createdDate": "2013-10-29T19:05:52.000Z",
"groupId": 12345,
"groupName": "Internet Company",
"modifiedBy": "mrossi",
"modifiedDate": "2017-07-25T22:30:20.000Z",
"parentGroupId": 12345,
"subGroups": [
{
"actions": {
"delete": false,
"edit": true
},
"createdBy": "jkowalski",
"createdDate": "2017-07-25T22:30:47.000Z",
"groupId": 54321,
"groupName": "Digital Company",
"modifiedBy": "jkowalski",
"modifiedDate": "2017-07-25T22:30:47.000Z",
"parentGroupId": 11111,
"subGroups": []
}
]
}
]
}
] |
Curl
curl -X GET 'https://host/identity-management/v3/user-admin/groups?actions=&accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS