1Update Role
Overview
This API updates an existing Role using the details provided.
Method: PUT
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 |
|---|---|---|---|
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 |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Role to be updated. | – |
Query Parameters
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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
privileges | String | JSON object containing the privileges and permissions to be assigned or updated for the Role. Note: At least one of the following parameters must be provided: json or privileges. | – |
json | String | JSON object containing the Role details and configuration to be updated. Note: An example JSON is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated role: Admin"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | Connection, database, schema, or table not found. |
412 | Precondition failed. Required parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the json parameter in the request body.
{
"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":"Admin",
"description":"1223",
"id":"17816899542686547269"
}