Authorization

Create Role

Changed on

Create a custom (non-system) role.

post/api/v1/authz/roles

Request

  • The document declares no server URL.
  • Auth
    • OAuth 2
      Password
      Token URL: api/v1/login
    • or API key in query parameter x-api-key
    • or API key in header x-api-key

Headers

X-Langflow-Operation-IDstring nullable

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 user, team, role, flow, deployment, project, knowledge_base, variable, file, share, provider_account, voice, plus the narrow model-provider form component:models/<provider-id>:read. 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. * is accepted only for resource vocabularies that expose it; administration resources use the explicit manage action. 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

Changes