Roles

Overview

The Roles endpoints enable querying of role resources within the SCIM system. These APIs allow you to perform read operations on role entities. Authentication is required for all role management operations.

Available Operations

List Roles

• Retrieve a paginated list of roles
• Support filtering and sorting capabilities

Get Role

• Retrieve detailed information about a specific role
• Access by unique role identifier (roleName)

Common Role Attributes

• name: Unique identifier for the role
• description: Detailed description of the role's purpose
• permissions: List of permissions associated with the role

For detailed API specifications, request/response examples, and implementation guidelines, please refer to the specific API endpoint documentation.

Note: Unlike the Users endpoints, the Roles API only supports read operations (GET). Create, Update, and Delete operations are not available through this API.