List all available role definitions

Overview

Retrieve a list of all role names that can be assigned to users within your organization.

Use Cases

• Discovery: Find out which roles are valid for assignment before calling the Add Roles endpoint.
• UI Population: Populate a dropdown in your internal management tool with valid role names and descriptions.

Why Use This?

Use this endpoint to discover valid role identifiers before assigning them. This ensures you only use roles that are active and compatible with your organization's permissions.

Related Operations

• Assign Roles to User: POST /public/v1/users/{userId}/roles
• View User's Roles: GET /public/v1/users/{userId}/roles
• Onboard New User: POST /public/v1/users

Required Permission

access_public_users