Method: roles.get

Retrieves a role.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
customer

string

Immutable ID of the G Suite account.

roleId

string

Immutable ID of the role.

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of Role.

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.