Look up permission definitions for the authenticated caller

Returns compact canonical permission definitions. scope=mine is resolved from the current authenticated user only; it accepts no user or role identifier. Definitions explain what each permission contributes, not a promise that a requested action or record will be allowed.

GET/administration/permission-definitions

Authorization

AuthorizationOAuth2 access token · headerrequired

Scopes:api:read

AuthorizationBearer token (JWT) · headerrequired

Query parameters

keysstring[]

Comma-separated permission keys to return.

groupstring

Exact shared RBAC permission group.

searchstring

Case-insensitive search over key, group, subgroup, name, and description.

scopestring

Restrict results to the authenticated caller’s effective permission keys.

Allowed:mine

limitnumber

Maximum entries. Defaults to 25 for unscoped catalog browsing and 200 for scope=mine.

min 1 · max 200

Responses

200

Array of PermissionDefinitionItem

descriptionstringrequired

What the permission lets a person do and its most important boundary or condition.

groupstring

Shared RBAC UI group, when defined.

keystringrequired

Canonical permission key.

namestringrequired

Product-facing permission name.

subgroupstring

Shared RBAC UI subgroup.

401

Unauthorized - Invalid or missing authentication token

403

Forbidden - Insufficient API scopes or permissions

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

OAuth2 access tokenRemember on this deviceInclude my values in samples

Parameters

keysqueryComma-separated permission keys to return.groupqueryExact shared RBAC permission group.searchqueryCase-insensitive search over key, group, subgroup, name, and description.scopequeryRestrict results to the authenticated caller’s effective permission keys.limitqueryMaximum entries. Defaults to 25 for unscoped catalog browsing and 200 for scope=mine.

Request

curl -X GET "https://leadtime.app/api/public/administration/permission-definitions" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

const response = await fetch("https://leadtime.app/api/public/administration/permission-definitions", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  }
});

import requests

response = requests.get(
    "https://leadtime.app/api/public/administration/permission-definitions",
    headers={
        "Authorization": "Bearer YOUR_ACCESS_TOKEN"
    },
)

Response

[
  {
    "description": "string",
    "group": "string",
    "key": "tasks.create",
    "name": "string",
    "subgroup": "string"
  }
]