v2

OpenAPI 3.0.3Apache-2.02026-08-07119359591.9 KB

Roles

Get a role

Get a role by its ID.

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

get/v2/roles/{role_id}

role_idstring required

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

Example:RW50aXR5OjEyMzQ1

The unique role identifier (base64)

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).

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.