AXaxiom
rbac

Get role by ID

Changed on

Retrieves a custom role by ID with its capabilities and the IDs of users assigned the role directly. Built-in role IDs such as axiom-admin return 404.

get/rbac/roles/{id}

Request

Path parameters

idstring required

Unique identifier of the role to retrieve

Response

The role.

datasetCapabilitiesRoleDatasetCapabilities

Defines the available permissions for dataset operations

descriptionstring

Detailed description of the role's purpose and scope

membersstring[]

IDs of users assigned this role directly. Returned in responses and ignored in requests. To assign a role to a user, use the Update user role endpoint.

namestring required

Unique name identifier for the role

viewCapabilitiesRoleViewCapabilities

Defines the available permissions for view operations

idstring required

Unique identifier for the role

Changes

  • v2fbc1b8430febRevision changes
    • info

      added the non-success response with the status

  • v28920e1697284Revision changes
    • warning

      removed the optional property ////// from the response with the status

    • warning

      removed the optional property ///// from the response with the status

    • info

      added the optional property ///// to the response with the status