Roles

Get a role

Changed on

Get a role by its ID.

Requires ROLE_READ

get/v2/roles/{role_id}

Request

  • Base URL
    https://api.arize.com
  • URL
    https://api.arize.com/v2/roles/{role_id}
  • Auth
    HTTP bearer

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

  • 84ac8681f9e2Revision changes
    • warning

      added the new PROJECT_SPAN_EVAL_FEEDBACK_UPDATE enum value to the / response property for the response status

  • ab71b10cee8fRevision changes
    • warning

      added the new DASHBOARD_TEMPLATE_CREATE enum value to the / response property for the response status

    • warning

      added the new DASHBOARD_TEMPLATE_DELETE enum value to the / response property for the response status

    • warning

      added the new DASHBOARD_TEMPLATE_READ enum value to the / response property for the response status

    • warning

      added the new DASHBOARD_TEMPLATE_UPDATE enum value to the / response property for the response status