Method: roles.list

Retrieves a paginated list of all the roles in a domain.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customer

string

Immutable ID of the G Suite account.

Query parameters

Parameters
maxResults

integer

Maximum number of results to return.

pageToken

string

Token to specify the next page in the list.

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 (Role)
    }
  ],
  "nextPageToken": string
}
Fields
kind

string

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

etag

string

ETag of the resource.

items[]

object (Role)

A list of Role 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.