logo

Retrieve roles

Retrieves a list of user roles.

SecuritySecretApiKey or JWT
Request
query Parameters
limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

q
string

Use this field to perform a partial search of text fields.

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

List of roles retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
name
required
string

Name of the user role.

required
Array of objects (Acl)

Access Control List (ACL) information.

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

Description of the role.

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 role IDs.

juniorIds
Array of strings

List of junior role IDs.

usersCount
integer

Number of users assigned to this role.

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 objects

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Enum: "self" "seniorRoles" "juniorRoles"
object

Embedded objects that are requested by the expand query parameter.

juniorRoles
object
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/roles
Request samples 
Response samples 
application/json
[
  • {
    }
]
➔ Next to Create a role