Role

The user roles you define in the settings. Every user has one; its type is the kind of access it grants. They are set up in Artesa, so this API only reads them.

Operations

GET/v2/roles/specGET/v2/rolesGET/v2/roles/{roleUuid}

---

OpenAPI Spec

GET

/v2/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

{

}

GET

/v2/roles/spec

Playground

Samples

---

List Roles

GET

/v2/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

uuid

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

  

"page": 0,

  

"pages": 0,

  

"size": 10,

  

"items": [

  

  

{

  

  

  

"uuid": "string",

  

  

  

"name": "string",

  

  

  

"type": "string",

  

  

  

"createdAt": "string",

  

  

  

"updatedAt": "string"

  

  

}

  

]

}

GET

/v2/roles

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

uuid

createdAt

updatedAt

Samples

---

Get a Role

GET

/v2/roles/{roleUuid}

Get a Role by ID

Authorizations

apiKey

Type

HTTP (bearer)

Parameters

Path Parameters

roleUuid*

Type

string

Required

Format

"uuid"

Responses

Role found

Content-Type

application/json

{

  

"uuid": "string",

  

"name": "string",

  

"type": "string",

  

"createdAt": "string",

  

"updatedAt": "string"

}

GET

/v2/roles/{roleUuid}

Playground

Server

Authorization

apiKey

Variables

Key

Value

roleUuid*

Samples

---