Skip to Content
bpms.ai
ReferenceAccess

List the roles

GET
/api/v1/access/roles

Lists the BPMS 3.x roles of the tenant of the request, read-only and paginated; deleted roles are excluded.

Authorization

bearer
headerAuthorizationBearer <token>

The token of a session that createSession opened

Query Parameters

page?integer

Zero-based page index

Formatint32
Default0
size?integer

Page size, from 1; values above 100 are capped

Formatint32
Default20
sort?string

Sort field, name or id; ties are ordered by id

Default"name"

Response Body

A page of roles

application/json
  1. response
items?array<>
page?integer
Formatint32
size?integer
Formatint32
totalElements?integer
Formatint64
totalPages?integer
Formatint32
Example Request
curl -X GET 'https://bpms.bpms.work/api/v1/access/roles'
Example Response
{  "items": [    {      "description": "string",      "id": 0,      "name": "string",      "uuid": "string"    }  ],  "page": 0,  "size": 0,  "totalElements": 0,  "totalPages": 0}