Roles

Create a role

Changed on

Create a new custom role for the authenticated user's account.

Payload Requirements

  • name is required and must be unique within the account.
  • permissions is required and must contain at least one valid permission identifier (e.g. PROJECT_READ, DATASET_CREATE).
  • System-managed fields (id, created_at, updated_at, is_predefined) are rejected if provided.

Valid example

{
  "name": "Data Scientist",
  "description": "Can read and create datasets and experiments.",
  "permissions": ["PROJECT_READ", "DATASET_READ", "DATASET_CREATE"]
}

Invalid example (missing required permissions)

{
  "name": "Data Scientist"
}
post/v2/roles

Request

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

Request body

namestring required

Human-readable name for the role. Must be unique within the account.

descriptionstring

Optional description of the role's purpose. Omitted from the response if empty.

permissionsPermission[] required

List of permissions to grant. At least one permission is required. Each value must be a valid permission identifier (e.g. PROJECT_READ, DATASET_CREATE).

Example request

{
  "name": "AI Engineer",
  "description": "Can read and create datasets and experiments but cannot manage spaces.",
  "permissions": [
    "PROJECT_READ",
    "DATASET_READ",
    "DATASET_CREATE",
    "EXPERIMENT_READ",
    "EXPERIMENT_CREATE"
  ]
}

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

    • info

      added the new PROJECT_SPAN_EVAL_FEEDBACK_UPDATE enum value to the request property /

  • 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

    • info

      added the new DASHBOARD_TEMPLATE_CREATE enum value to the request property /

    • info

      added the new DASHBOARD_TEMPLATE_DELETE enum value to the request property /

    • info

      added the new DASHBOARD_TEMPLATE_READ enum value to the request property /

    • info

      added the new DASHBOARD_TEMPLATE_UPDATE enum value to the request property /