API ReferenceManagement

Role Management

Overview

The Role Management APIs let you programmatically manage roles using a management key.

Management keys are generated from Company > Management Keys. Include the key in the Authorization header as a bearer token in the format <Project ID>:<Management Key>.

Use Cases

  1. Load All Roles
  2. Search Roles
  3. Create Role
  4. Update Role
  5. Delete Role
  6. Batch Delete Roles

Examples

Example - create a role and apply it to SSO mapping

  1. Create a new role using the Create Role API endpoint.

Example - create a role and apply it to a user

  1. Create a new role using the Create Role API endpoint.
  2. Apply the role to a user with Create User, Update User, or Update User Add Roles.
Was this helpful?

Bulk Delete Permissions POST

Bulk delete Permissions, using a valid management key.

Load All Roles GET

### Load all roles, using a valid management key. This API endpoint allows administrators to load all existing roles. This endpoint returns an array of roles including their name, description, and permissionsNames. ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions.

On this page

Role ManagementOverviewUse CasesExamplesExample - create a role and apply it to SSO mappingExample - create a role and apply it to a user