List Permissions

managedgrafana_list_permissions

R Documentation

Lists the users and groups who have the Grafana Admin and Editor roles in this workspace¶

Description¶

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.

Usage¶

managedgrafana_list_permissions(groupId, maxResults, nextToken, userId,
  userType, workspaceId)

Arguments¶

groupId

(Optional) Limits the results to only the group that matches this ID.

maxResults

The maximum number of results to include in the response.

nextToken

The token to use when requesting the next set of results. You received this token from a previous list_permissions operation.

userId

(Optional) Limits the results to only the user that matches this ID.

userType

(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

workspaceId

[required] The ID of the workspace to list permissions for. This parameter is required.

Value¶

A list with the following syntax:

list(
  nextToken = "string",
  permissions = list(
    list(
      role = "ADMIN"|"EDITOR"|"VIEWER",
      user = list(
        id = "string",
        type = "SSO_USER"|"SSO_GROUP"
      )
    )
  )
)

Request syntax¶

svc$list_permissions(
  groupId = "string",
  maxResults = 123,
  nextToken = "string",
  userId = "string",
  userType = "SSO_USER"|"SSO_GROUP",
  workspaceId = "string"
)