Retrieve a role

Retrieve a role with specified identifier string.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

query Parameters
expand
string

Expands a request to include embedded objects within the _embedded property of the response. This field accepts a comma-separated list of objects.

For more information, see Expand to include embedded objects.

Responses
200

Role retrieved.

Response Schema: application/json
name
required
string

Role name.

required
Array of objects (Acl)
Array
required
object

Scope of the API key.

permissions
required
Array of strings <operationId>

If you are creating a restricted API key, use this field to specify individual permissions. Use the wildcard character * to provide full access.

id
string <= 50 characters

Unique resource ID. Defaults to UUID v4.

description
string

Role description.

allowedIps
Array of strings or null <ip> (AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

seniorIds
Array of strings

List of senior roles identifiers.

juniorIds
Array of strings

List of junior roles identifiers.

usersCount
integer

Number of users with this role assigned.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of Self (object) or SeniorRolesLink (object) or JuniorRolesLink (object) non-empty

Links related to a resource.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
Array of JuniorRolesEmbed (object) non-empty

Embedded objects that are requested by the expand query parameter.

Array (non-empty)
Any of:

Junior roles collection.

juniors
Array of objects (Role)
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

404

Resource not found.

get/roles/{id}
Request samples
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "description": "string",
  • "acl": [
    ],
  • "allowedIps": [
    ],
  • "seniorIds": [
    ],
  • "juniorIds": [
    ],
  • "usersCount": 0,
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ],
  • "_embedded": [
    ]
}