Method: roleAssignments.list

Retrieves a paginated list of all roleAssignments.

HTTP request

GET https://admin.googleapis.com/admin/directory/v1/customer/{customer}/roleassignments

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customer

string

Immutable ID of the Google Workspace account.

Query parameters

Parameters
maxResults

integer

Maximum number of results to return.

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.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

JSON representation
{
  "kind": string,
  "etag": string,
  "items": [
    {
      object (RoleAssignment)
    }
  ],
  "nextPageToken": string
}
Fields
kind

string

The type of the API resource. This is always admin#directory#roleAssignments.

etag

string

ETag of the resource.

items[]

object (RoleAssignment)

A list of RoleAssignment resources.

nextPageToken

string

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/admin.directory.rolemanagement
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly

For more information, see the OAuth 2.0 Overview.