Skip to Content
bpms.ai
ReferenceAccess

Create a role

POST
/api/v1/access/roles

Creates a role in the tenant of the request with a new uuid. The caller needs 6.2.1.1 (create roles) and every code the role starts with. The name is unique in the tenant regardless of case.

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Request Body

The name, description, and first authority codes of the role

application/json
  1. body
authorities*array<string>
description?|
Lengthlength <= 2048
name*string
Lengthlength <= 100

Response Body

The role was created

application/json
  1. response
description?string|null
id?integer
Formatint64
name?string
uuid?string|null
Example Request
curl -X POST 'https://bpms.bpms.work/api/v1/access/roles' \  -H 'Content-Type: application/json' \  -d '{  "authorities": [    "string"  ],  "name": "string"}'
Example Response
{  "description": "string",  "id": 0,  "name": "string",  "uuid": "string"}