Get Role Details

Overview

This API retrieves details of the specified Role.

Method: GET

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

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.

–

Path Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name	Type	Description	Possible Values
name-or-id (Required)	String	Name or ID of the Role to be retrieved.	–

Query Parameters

Parameter Name	Type	Description	Possible Values

Parameter Name

Type

Description

Possible Values

by

String

Specifies whether the name-or-id parameter should be interpreted as a Role name or Role ID.

If by=name, provide the Role name in the name-or-id parameter.

If by=id, provide the Role ID in the name-or-id parameter.

The default value is name.

–

Responses

200 Success

{
  "privileges": {
    "relationships": {
      "crud": false,
      "view": false,
      "use": false,
      "share": false,
      "addFolder": false
    },
    "workbooks": {
      "crud": true,
      "view": true,
      "share": true,
      "addFolder": true,
      "export": true
    },
    "notification": {
      "cubeBuildFailure": false,
      "notificationAdmin": false,
      "cubeBuildSuccess": false,
      "cubeBuildStart": false,
      "systemEvents": false,
      "datasetBuildFailure": false,
      "datasetBuildStart": false,
      "datasetBuildSuccess": false,
      "entityModified": true
    },
    "cubes": {
      "crud": false,
      "view": false,
      "use": true,
      "setupDataSecurity": false,
      "exportCubeMetadata": false,
      "setupCacheRules": false,
      "addJob": 0,
      "advancedSystemProperties": false,
      "share": false,
      "addFolder": false,
      "drillThrough": true
    },
    "setup": {
      "view": false,
      "resourceAllocation": {
        "crud": false,
        "view": false
      },
      "licenseMgmt": {
        "crud": false,
        "view": false
      },
      "userMgmt": {
        "crud": true,
        "view": true
      },
      "clusterScaling": {
        "crud": false,
        "view": false,
        "viewSystemUsage": false
      },
      "exportCab": false,
      "connections": {
        "crud": false,
        "view": false,
        "share": false
      },
      "importCab": false
    },
    "files": {
      "crud": false,
      "view": false,
      "use": false,
      "addJob": 0,
      "share": false,
      "addFolder": false
    },
    "thirdPartyBITools": {
      "sqlUserImpersonation": false
    },
    "kyvosreporting": {
      "view": false
    },
    "monitor": {
      "view": false,
      "viewOverview": false,
      "viewUsers": false,
      "viewJobs": {
        "view": false,
        "showJobs": 0,
        "cancelJobs": false
      },
      "viewAuditLogs": false,
      "viewKyvosEngines": false
    },
    "datasets": {
      "crud": false,
      "view": false,
      "use": false,
      "addJob": 0,
      "share": false,
      "addFolder": false
    },
    "queryplayground": {
      "view": true
    }
  },
  "creationTime": "1781689954412",
  "userCount": 0,
  "groupCount": 0,
  "name": "Custom End User",
  "description": "This is a custom role for end users.",
  "id": "17816899542686547269"
}

Status Code	Description

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

1Get Role