Sign in
Roles

Get a role

Get a role by its ID.

Requires ROLE_READ

<Note>This endpoint is in beta, read more here.</Note>

get/v2/roles/{role_id}

Path parameters

role_idstring required

A universally unique identifier (base64-encoded opaque string).

Example:RW50aXR5OjEyMzQ1

The unique role identifier (base64)

Response

A role object.

idstring required

Unique identifier for the role.

namestring required

Human-readable name of the role.

descriptionstring

A brief description of the role's purpose.

permissionsPermission[] required

List of permissions granted by this role. Each value corresponds to a permission identifier (e.g. PROJECT_READ, DATASET_CREATE). Returned only to callers with ROLE_READ.

is_predefinedboolean required

Whether this role is a system-defined predefined role. Predefined roles cannot be updated or deleted.

created_atstring date-time required

Timestamp when the role was created.

updated_atstring date-time required

Timestamp when the role was last updated.

Changes

Changed in 3 of the 16 revisions of this API.81

  • f63ac334fd4a1See the full diff
    • ○

      added the non-success response with the status 403

      response-non-success-status-added

  • c26a00e9b3184See the full diff
    • ●

      added the new AGENT_ROLE_CREATE enum value to the permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AGENT_ROLE_DELETE enum value to the permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AGENT_ROLE_READ enum value to the permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new AGENT_ROLE_UPDATE enum value to the permissions/items/ response property for the response status 200

      response-property-enum-value-added

  • ddf93df2c2954See the full diff
    • ●

      added the new ROLE_CREATE enum value to the permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ROLE_DELETE enum value to the permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ROLE_READ enum value to the permissions/items/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new ROLE_UPDATE enum value to the permissions/items/ response property for the response status 200

      response-property-enum-value-added

Of the 16 revisions, 1 has no diff computed.