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:
- Load All Roles
- Search Roles
- Create Role
- Update Role
- Delete Role
- Batch Delete Roles
Examples
Example - create role and apply it to SSO Mapping
- Create a new role utilizing the Create Role API Endpoint
Example - create role and apply it to a user
- Create a new role utilizing the Create Role API Endpoint
- Utilize the new role to Create User, Update User, or Update User Add Roles
Delete Permission POST
### Delete a permission, using a valid management key. This API endpoint allows administrators to delete an existing permission. The endpoint takes the following one parameter: - name (required) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`
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. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`