1Get Roles List

Overview

This API retrieves a list of Roles.

Method: GET

Request URL: {kyvos-url}/rest/v2/roles

Authorization

API Key: `sessionid`

This method authenticates requests using a session ID which acts like an API key.

BasicAuth: HTTP Authorization Scheme

This method authenticates requests using a username and password sent in the HTTP Authorization header.

Headers

Header Name	Type	Description	Possible Values

Header Name

Type

Description

Possible Values

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

Responses

200 Success

{
  "roles": [
    {
      "name": "Custom_Role",
      "id": "17424696808697127031045127375889"
    },
    {
      "name": "Administrator",
      "id": "0"
    },
    {
      "name": "Designer",
      "id": "1"
    },
    {
      "name": "Business User",
      "id": "2"
    },
    {
      "name": "End User",
      "id": "3"
    },
    {
      "name": "IT Admin",
      "id": "4"
    },
    {
      "name": "Monitor",
      "id": "5"
    }
  ]
}

Status Code	Description

Status Code	Description
401	Authorization information is missing or invalid.
404	No matching record found.
500	Internal Server Error.