Roles: list

Requires authorization

Retrieves a paginated list of all the roles in a domain. 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 100, inclusive.
pageToken string Token to specify the next page in the list.


This request requires authorization with at least one of the following scopes (read more about authentication and authorization).


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#roles",
  "etag": etag,
  "items": [
    roles Resource
  "nextPageToken": string
Property name Value Description Notes
kind string The type of the API resource. This is always admin#directory#roles.
etag etag ETag of the resource.
items[] list A list of Role resources.
nextPageToken string

Try it!

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