ListPermissions
Lists the users and groups who have the Grafana Admin and
Editor roles in this workspace. If you use this operation without
specifying userId or groupId, the operation returns the roles
of all users and groups. If you specify a userId or a groupId,
only the roles for that user or group are returned. If you do this, you can specify only
one userId or one groupId.
Request Syntax
GET /workspaces/workspaceId/permissions?groupId=groupId&maxResults=maxResults&nextToken=nextToken&userId=userId&userType=userType HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- groupId
-
(Optional) Limits the results to only the group that matches this ID.
Length Constraints: Minimum length of 1. Maximum length of 47.
- maxResults
-
The maximum number of results to include in the response.
Valid Range: Minimum value of 1. Maximum value of 100.
- nextToken
-
The token to use when requesting the next set of results. You received this token from a previous
ListPermissionsoperation. - userId
-
(Optional) Limits the results to only the user that matches this ID.
Length Constraints: Minimum length of 1. Maximum length of 47.
- userType
-
(Optional) If you specify
SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specifySSO_GROUP, only the permissions of IAM Identity Center groups are returned.Valid Values:
SSO_USER | SSO_GROUP - workspaceId
-
The ID of the workspace to list permissions for. This parameter is required.
Pattern:
^g-[0-9a-f]{10}$Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"nextToken": "string",
"permissions": [
{
"role": "string",
"user": {
"id": "string",
"type": "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.
- nextToken
-
The token to use in a subsequent
ListPermissionsoperation to return the next set of results.Type: String
- permissions
-
The permissions returned by the operation.
Type: Array of PermissionEntry 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:
