Plane DocsSign in

Permission schemes overview ​

Permission schemes are the named bundles of grants a role can carry.

The permission scheme object ​

Attributes ​

  • description string

    Free-form description.

  • id string (uuid)

    Unique identifier.

  • is_system boolean

    Whether is system.

  • name string

    Display name.

  • namespace string

    The namespace.

  • permissions array of string

    The permissions.

  • slug string

    The slug.

  • sort_order integer

    Manual ordering weight. Lower sorts first.

Response200
json
{
  "description": "What this is for.",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_system": false,
  "name": "Example name",
  "namespace": "instance",
  "permissions": ["example"],
  "slug": "my-team",
  "sort_order": 65535
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/permission-schemes/List permission schemes
GET/api/v2/workspaces/{slug}/permission-schemes/{pk}/Get a permission scheme

Response shaping ​

Every permission scheme read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.