RoleAssignments: list

Retrieves a paginated list of all roleAssignments. Try it now.


HTTP request



Parameter name Value Description
Path parameters
customer string Immutable ID of the G Suite account.
Optional query parameters
maxResults integer Maximum number of results to return. Acceptable values are 1 to 200, inclusive.
pageToken string Token to specify the next page in the list.
roleId string Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
userKey string The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.


This request requires authorization with at least one of the following scopes:


For more information, see the authentication and authorization page.

Request body

Do not supply a request body with this method.


If successful, this method returns a response body with the following structure:

  "kind": "admin#directory#roleAssignments",
  "etag": etag,
  "items": [
    roleAssignments Resource
  "nextPageToken": string
Property name Value Description Notes
kind string The type of the API resource. This is always admin#directory#roleAssignments.
etag etag ETag of the resource.
items[] list A list of RoleAssignment resources.
nextPageToken string

Try it!

Use the APIs Explorer below to call this method on live data and see the response.