Open Inventory / Docs
EndpunkteAccess controlApiAccessRoles

Create an access role

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.

POST
/api/access/roles

Requires an authenticated browser session with the roles.manage permission. Role keys are stable identifiers used by users and conditional rules.

Authentifizierung

adminSession
cookieauthjs.session-token<token>

Authenticated Auth.js browser session cookie; each operation declares its required permission. Not restricted to administrators. HTTPS deployments use the secure-prefixed cookie variant.

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

Anfrageinhalt

application/json
  1. body
key*AccessRoleKey

Stable lowercase identifier for a built-in or custom role.

Muster^[a-z][a-z0-9_-]{0,63}$
Länge1 <= length <= 64
name*string
Länge1 <= length <= 120
description?string
Längelength <= 1000
Standard""
permissions?array<>
Einträgeitems <= 30
Standard[]

Antwortinhalt

Role created

application/json
  1. response
role*
Beispielanfrage
curl -X POST 'https://example.com/api/access/roles' \  -H 'Content-Type: application/json' \  -d '{  "key": "editor",  "name": "string"}'
Beispielantwort
{  "role": {    "key": "editor",    "name": "string",    "description": "string",    "permissions": [      "inventory.read"    ],    "isSystem": true,    "memberCount": 0,    "createdBy": "string",    "updatedBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z"  }}