BLblackkitetech
Permissions

Get the permissions the credential creator can grant.

Changed on

Returns the licensed permissions the user who created this credential can grant. 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 the catalog is read.

get/api/v2/permissions

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 PermissionName, PermissionDescription, PermissionCategory, PermissionType.

PermissionNamestring required

The display name of the permission.

PermissionDescriptionstring required

A short description of what the permission allows.

PermissionCategorystring required

The name of the permission group the permission belongs to.

PermissionType'Company' | 'Tenant' required

Whether the permission applies to individual companies or to the whole tenant.

Example response

[
  {
    "PermissionName": "Company read",
    "PermissionDescription": "Read company data",
    "PermissionCategory": "Company",
    "PermissionType": "Company"
  }
]

Changes