Role

User roles you define in the settings.

Operations

GET/v1/roles/spec GET/v1/roles GET/v1/roles/{roleId}

OpenAPI Spec

GET

/v1/roles/spec

Get OpenAPI 3.1.0 spec for Role API

Responses

Returns OpenAPI 3.1.0 spec for Role API

Content-Type

application/json

JSON

{

}

GET

/v1/roles/spec

Playground

Samples

List Roles

GET

/v1/roles

List Roles

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Query Parameters

page

Type

number

Minimum

0

Default

0

size

Type

number

Minimum

1

Maximum

20

Default

10

id

createdAt

updatedAt

Responses

List response

Content-Type

application/json

JSON

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"name": "string",

"type": "string",

"createdAt": "string",

"updatedAt": "string"

}

]

}

Get a Role

GET

/v1/roles/{roleId}

Get a Role by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

roleId*

Type

integer

Required

Format

"int32"

Responses

Role found

Content-Type

application/json

JSON

{

"id": 0,

"name": "string",

"type": "string",

"createdAt": "string",

"updatedAt": "string"

}

GET

/v1/roles/{roleId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

roleId*

Samples