Role

User roles you define in the settings.

Operations

GET/v1/roles/specGET/v1/rolesGET/v1/roles/{roleId}

---

OpenAPI Spec

GET

/v1/roles/spec

Get OpenAPI 3.1.0 spec for Role API

Responses

The spec itself as json

Content-Type

application/json

{

}

GET

/v1/roles/spec

Playground

Samples

cURL

JavaScript

PHP

Python

---

List Roles

GET

/v1/roles

List Roles

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Query Parameters

page

Typenumber

minimum0

default0

size

Typenumber

minimum1

maximum20

default10

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"name": "string",

"type": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

}

GET

/v1/roles

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

createdAt

updatedAt

Samples

cURL

JavaScript

PHP

Python

---

Get a Role

GET

/v1/roles/{roleId}

Get a Role by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

roleId*

Typeinteger

Required

formatint32

Responses

Role found

Content-Type

application/json

{

"id": 0,

"name": "string",

"type": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/v1/roles/{roleId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

roleId*

Samples

cURL

JavaScript

PHP

Python

---