UpdatePermissions
Updates which users in a workspace have the Grafana Admin or
Editor roles.
Request Syntax
PATCH /workspaces/workspaceId/permissions HTTP/1.1
Content-type: application/json
{
"updateInstructionBatch": [
{
"action": "string",
"role": "string",
"users": [
{
"id": "string",
"type": "string"
}
]
}
]
}URI Request Parameters
The request uses the following URI parameters.
- workspaceId
-
The ID of the workspace to update.
Pattern:
^g-[0-9a-f]{10}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- updateInstructionBatch
-
An array of structures that contain the permission updates to make.
Type: Array of UpdateInstruction objects
Array Members: Minimum number of 0 items. Maximum number of 20 items.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"errors": [
{
"causedBy": {
"action": "string",
"role": "string",
"users": [
{
"id": "string",
"type": "string"
}
]
},
"code": number,
"message": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- errors
-
An array of structures that contain the errors from the operation, if any.
Type: Array of UpdateError objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient permissions to perform this action.
HTTP Status Code: 403
- InternalServerException
-
Unexpected error while processing the request. Retry the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The request references a resource that does not exist.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied because of request throttling. Retry the request.
HTTP Status Code: 429
- ValidationException
-
The value of a parameter in the request caused an error.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
