Get a role

get https://{hostname}/identity-management/v3/user-admin/roles/{roleId}

This operation retrieves a role's details.

Response

Response body

object

actions

object

Specifies activities available for the role.

delete

boolean

required

Whether you can remove the role.

edit

boolean

required

Whether you can modify the role.

createdBy

string

required

length ≥ 1

The user who created the granted role.

createdDate

date-time

required

ISO 8601 timestamp indicating when the granted role was originally created.

grantedRoles

array of objects

length ≥ 0

Granted roles for the account.

grantedRoles

object

grantedRoleDescription

string

length ≥ 1

Descriptive label for the role to convey its use.

grantedRoleId

integer

required

≥ 1

Unique identifier for each granted role.

grantedRoleName

string

required

length ≥ 1

Descriptive label for the granted role.

modifiedBy

string

required

length ≥ 1

The user who last edited the granted role.

modifiedDate

date-time

required

ISO 8601 timestamp indicating when the granted role was last updated.

roleDescription

string

required

length ≥ 1

Descriptive label for the role to convey its use.

roleId

integer

required

≥ 1

Unique identifier for each role.

roleName

string

required

length ≥ 1

Descriptive label for the role.

type

string

required

Whether it's a standard or account role defined by Akamai, or a custom role created by one of your account's users. You can only modify or delete custom roles. To learn more, see About roles.

custom standard account

users

array of objects

length ≥ 0

Users on the account who share the same role.

users

object

accountId

string

required

length ≥ 1

Unique identifier for each account.

string

required

The user's email address.

firstName

string

required

length ≥ 1

The user's first name.

lastLoginDate

date-time

ISO 8601 timestamp indicating when the user last logged in.

lastName

string

required

length ≥ 1

The user's surname.

uiIdentityId

string

required

length ≥ 1

Unique identifier for each user, which corresponds to their Control Center profile or client ID. Also known as a contactId in other APIs.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/identity-management/v3/user-admin/roles/roleId \
3
     --header 'accept: application/json'


xxxxxxxxxx
39
}
1
{
2
  "actions": {
3
    "delete": false,
4
    "edit": false
5
  },
6
  "createdBy": "afero@example.com",
7
  "createdDate": "2017-07-27T18:11:25.000Z",
8
  "grantedRoles": [
9
    {
10
      "grantedRoleDescription": "Security View Only",
11
      "grantedRoleId": 12345,
12
      "grantedRoleName": "SecurityViewOnly"
13
    }
14
  ],
15
  "modifiedBy": "asingh@example.com",
16
  "modifiedDate": "2017-07-27T18:11:25.000Z",
17
  "roleDescription": "This role will allow you to look at the security reports",
18
  "roleId": 123456,
19
  "roleName": "Security View Only",
20
  "type": "custom",
21
  "users": [
22
    {
23
      "accountId": "A-CCT9012",
24
      "email": "jsmith@example.com",
25
      "firstName": "John",

200The response provides the role's details.