Roles
Create a role
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"
}
<Note>This endpoint is in beta, read more here.</Note>
post/v2/roles
Request body
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.