BLblackkitetech
Roles

Get the roles the credential creator can see.

Changed on

Returns the roles visible to the user who created this credential, including visible legacy roles. Requires the "User Access Management - Read" permission. When User Access Management for groups has not been enabled for the tenant, the call is rejected before roles are read.

get/api/v2/roles

Request

Query parameters

page_numberinteger
Example:1

The number of the page requested. Values below 1 are clamped to 1.

page_size10 | 20 | 30 | 50 | 100 | 250
Example:10

The number of result items in a single response. Allowed values are 10, 20, 30, 50, 100 and 250. Any other value is clamped to 10.

Response

A bare array. Field order is RoleId, Name, Description, NumberOfCompanyPermissions, NumberOfTenantPermissions, NumberOfGroups, Permissions.

RoleIdinteger required

The id of the role.

Namestring required

The display name of the role.

Descriptionstring required

A short description of the role.

NumberOfCompanyPermissionsinteger required

The number of company-scoped permissions the role grants.

NumberOfTenantPermissionsinteger required

The number of tenant-scoped permissions the role grants.

NumberOfGroupsinteger required

The number of groups the role is assigned to.

Example response

[
  {
    "RoleId": 11,
    "Name": "Analyst",
    "Description": "Reads company data",
    "NumberOfCompanyPermissions": 1,
    "NumberOfTenantPermissions": 1,
    "NumberOfGroups": 2,
    "Permissions": [
      {
        "PermissionName": "Company read"
      }
    ]
  }
]

Changes