Skip to Content
bpms.ai
ReferenceAccess

Update a role

PUT
/api/v1/access/roles/{roleId}

Replaces the name and description of a role of the tenant of the request; its uuid and codes stay. The caller needs 6.2.1.2 (edit roles). The name is unique in the tenant regardless of case.

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Path Parameters

roleId*integer

Id of the role

Formatint64

Request Body

The new name and description of the role

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

Response Body

The role as stored

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