v21

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01144108427.9 KB

Authorization

Create Role

Create a custom (non-system) role. Superuser-only.

post/api/v1/authz/roles

Request body

descriptionstring nullable

namestring required

parent_role_idstring uuid nullable

permissionsstring[]

Permission slugs in the canonical <resource>:<action> form — for example flow:read, deployment:execute, share:create. Resources must be one of flow, deployment, project, knowledge_base, variable, file, share. Actions are constrained per-resource (see services/authorization/actions.py): e.g. deploy is only valid on flow, ingest only on knowledge_base, update only on share. * (all actions on that resource) is always accepted. A registered authorization plugin is responsible for compiling these into its policy format.

Response

Successful Response

created_atstring date-time required

created_bystring uuid nullable required

descriptionstring nullable required

idstring uuid required

is_systemboolean required

namestring required

parent_role_idstring uuid nullable required

permissionsstring[] required

updated_atstring date-time required

workspace_idstring uuid nullable required