update-permissions¶
Description¶
Updates which users in a workspace have the Grafana Admin or Editor roles.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-permissions
--update-instruction-batch <value>
--workspace-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--update-instruction-batch (list)
An array of structures that contain the permission updates to make.
(structure)
Contains the instructions for one Grafana role permission update in a UpdatePermissions operation.
action -> (string)
Specifies whether this update is to add or revoke role permissions.
role -> (string)
The role to add or revoke for the user or the group specified in
users.users -> (list)
A structure that specifies the user or group to add or revoke the role for.
(structure)
A structure that specifies one user or group in the workspace.
id -> (string)
The ID of the user or group.
type -> (string)
Specifies whether this is a single user or a group.
Shorthand Syntax:
action=string,role=string,users=[{id=string,type=string},{id=string,type=string}] ...
JSON Syntax:
[
{
"action": "ADD"|"REVOKE",
"role": "ADMIN"|"EDITOR",
"users": [
{
"id": "string",
"type": "SSO_USER"|"SSO_GROUP"
}
...
]
}
...
]
--workspace-id (string)
The ID of the workspace to update.
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
Output¶
errors -> (list)
An array of structures that contain the errors from the operation, if any.
(structure)
A structure containing information about one error encountered while performing an UpdatePermissions operation.
causedBy -> (structure)
Specifies which permission update caused the error.
action -> (string)
Specifies whether this update is to add or revoke role permissions.
role -> (string)
The role to add or revoke for the user or the group specified in
users.users -> (list)
A structure that specifies the user or group to add or revoke the role for.
(structure)
A structure that specifies one user or group in the workspace.
id -> (string)
The ID of the user or group.
type -> (string)
Specifies whether this is a single user or a group.
code -> (integer)
The error code.
message -> (string)
The message for this error.