PUT /roles

Owner administration or the explicitly assigned business permission is required. Actions are scoped to the signed-in branch. A request cannot be approved by its creator. Locked sessions return 423.

PUT/api/v1/security/roles

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Request body

requiredapplication/json

idstringrequired

matches ^[a-z][a-z0-9_]{1,49}$

namestringrequired

min length 2 · max length 80

permissionsstring[]required

max items 50

activebooleanrequired

Responses

200

Operation completed

any

201

Record created

400

Invalid request

detailstringrequired

401

Session expired or revoked

detailstringrequired

403

Permission denied or self-approval

detailstringrequired

409

Record changed or no longer actionable

detailstringrequired

423

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Bodyapplication/json

Request body

Request

curl -X PUT 'http://localhost:8000/api/v1/security/roles' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "id": "string",
  "name": "string",
  "permissions": [
    "sales.prepare"
  ],
  "active": true
}'

const response = await fetch("http://localhost:8000/api/v1/security/roles", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"id\": \"string\",\n  \"name\": \"string\",\n  \"permissions\": [\n    \"sales.prepare\"\n  ],\n  \"active\": true\n}"
});

import requests

response = requests.put(
    "http://localhost:8000/api/v1/security/roles",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"id\": \"string\",\n  \"name\": \"string\",\n  \"permissions\": [\n    \"sales.prepare\"\n  ],\n  \"active\": true\n}",
)

Response

Operation completed

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}

{
  "detail": "string"
}