Roles

Number of APIs: 5

1. 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.

---

2. List roles

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

This operation lists roles for the current account and contract type or other accounts using the accountSwitchKey parameter. The account and contract type are determined by the access tokens in your API client.

---

3. Get a role

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

This operation retrieves a role's details.

---

4. Edit a role

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

This operation adds or removes a role's group role assignments, along with other data such as name and description. When you modify a role, those changes affect existing API clients. Review all API clients belonging to the user before modifying a role.

---

5. Delete a role

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

This operation deletes a custom role. You can't delete a role if it's assigned to a user.

---