Logo
Akamai APIs API Documentation

Create a role

POST https://{{host}}/identity-management/v3/user-admin/roles

This operation creates a custom role. A custom role combines grantable roles defined by Akamai. Roles exist at the account level regardless of group, but are constrained by contract type. If you create a role under one contract type, you can't apply that role to groups belonging to a different contract type, even if they're in the same account.

 

Body PARAM

Key Datatype Required Description 
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 
Content-Type
string
Accept
string




RESPONSES

status Created

{ "actions": { "delete": true, "edit": true }, "createdBy": "alfulani", "createdDate": "2017-09-11T13:43:54.005Z", "grantedRoles": [ { "grantedRoleDescription": "View Real User Monitoring", "grantedRoleId": 1234, "grantedRoleName": "RealUserMonitoring - View Only" } ], "modifiedBy": "mrossi", "modifiedDate": "2017-09-11T13:43:54.005Z", "roleDescription": "Provides users with edit and create access to reports.", "roleId": 12345678, "roleName": "Edit Role", "type": "custom", "users": [ { "accountId": "A-CCT5678", "email": "jsmith@example.com", "firstName": "John", "lastLoginDate": "2016-01-13T17:53:57Z", "lastName": "Smith", "uiIdentityId": "A-B-12345" } ] }

Curl
curl -X POST 'https://host/identity-management/v3/user-admin/roles?accountSwitchKey=' -H 'Content-Type: application/json' -H 'Accept: application/json' -d '{"grantedRoles":[{"grantedRoleId":2051}],"roleDescription":"This role lets users edit or create reports.","roleName":"Edit Reports"}'

ENDPOINTS