API ReferenceManagement

Role Management

Overview

Using the role management APIs enables administrators to manage their roles utilizing a management key.

Management keys are generated from Company > Management Keys. These keys will be used within the bearer token. The format is <Project ID>:<Management Key>.

Use Cases

Role Management:

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

Examples

Example - create role and apply it to SSO Mapping

  1. Create a new role utilizing the Create Role API Endpoint

Example - create role and apply it to a user

  1. Create a new role utilizing the Create Role API Endpoint
  2. Utilize the new role to Create User, Update User, or Update User Add Roles
Was this helpful?

On this page