Roles

List roles

Changed on

List custom and predefined roles for the authenticated user's account. Results are paginated; use limit and cursor for subsequent pages.

Account admins, members, and other callers with ROLE_READ receive each role's full permission list. Callers without ROLE_READ are rejected with 403.

get/v2/roles

Request

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

Query parameters

limitinteger

Maximum items to return. Defaults to 50 if omitted; maximum is 100.

cursorstring

Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.

is_predefinedboolean

Filter roles by predefined status.

  • true - Return only system-defined predefined roles.
  • false - Return only custom (account-defined) roles.

When not specified, returns all roles (both predefined and custom).

Response

Returns a list of role objects.

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