Open Inventory / Docs
EndpunkteAuthenticationAuthCapabilities

Inspect the authenticated token's available scopes

Die API läuft auf deiner Anwendungsinstanz. Schemas und Feldnamen stammen unverändert aus der OpenAPI-Spezifikation. Browsergebundene Aufrufe benötigen eine Sitzung auf der Instanz.

GET
/auth/capabilities

Authentifizierung

bearerAuth
headerAuthentifizierungBearer <inv_ token>

Header-Parameter

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Antwortinhalt

Token identity and capabilities

application/json
  1. response
name*string
principal*string

Opaque organization-scoped principal identifier for binding durable client state.

scopes*array<>
role*|

Stable role key for user-bound identities; null for standalone API tokens.

Muster^[a-z][a-z0-9_-]{0,63}$
roleName*|

Human-readable role name for user-bound identities; null for standalone API tokens.

permissions*array<>

Granular workspace-wide permissions available through this token.

organization*
organizations*array<>
Beispielanfrage
curl -X GET 'https://inventory.example.com/api/v1/auth/capabilities'
Beispielantwort
{  "name": "string",  "principal": "string",  "scopes": [    "read"  ],  "role": "string",  "roleName": "string",  "permissions": [    "inventory.read"  ],  "organization": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "slug": "string",    "role": "string",    "roleName": "string",    "isReadOnly": true,    "allowNegativeStock": true,    "canManage": true  },  "organizations": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "name": "string",      "slug": "string",      "role": "string",      "roleName": "string",      "isReadOnly": true,      "allowNegativeStock": true,      "canManage": true    }  ]}