Akamai APIs API Documentation
Get a group
GET https://{{host}}/identity-management/v3/user-admin/groups/:groupId
This operation retrieves a group's details.
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": "jsmith",
"modifiedDate": "2012-04-28T00:00:00.000Z",
"subGroups": [
{
"actions": {
"delete": false,
"edit": true
},
"createdBy": "jkowalski",
"createdDate": "2013-10-29T19:05:52.000Z",
"groupId": 54321,
"groupName": "Internet Company",
"modifiedBy": "mrossi",
"modifiedDate": "2017-07-25T22:30:20.000Z",
"parentGroupId": 12345,
"subGroups": [
{
"actions": {
"delete": false,
"edit": true
},
"createdBy": "adevi",
"createdDate": "2017-07-25T22:30:47.000Z",
"groupId": 32145,
"groupName": "Digital Company",
"modifiedBy": "jsmith",
"modifiedDate": "2017-07-25T22:30:47.000Z",
"parentGroupId": 11111,
"subGroups": []
}
]
}
]
} |
Curl
curl -X GET 'https://host/identity-management/v3/user-admin/groups/:groupId?actions=&accountSwitchKey=' -H 'Accept: application/json'
ENDPOINTS