Method: roles.get
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
The unique ID for the customer's Google Workspace account. In case of a multi-domain account, to fetch all groups for a customer, use this field instead of domain. You can also use the my_customer alias to represent your account's customerId. The customerId is also returned as part of the Users resource. You must provide either the customer or the domain parameter.
|
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 Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-08-22 UTC.
[null,null,["Last updated 2024-08-22 UTC."],[[["Retrieves a specific role within a Google Workspace account using a `GET` request."],["Requires providing either the customer ID or domain, along with the role's immutable ID in the request URL."],["The response returns details about the specified role if the request is successful."],["Authorization is necessary using specific OAuth scopes related to role management."]]],["This describes how to retrieve a role using a `GET` request to the specified URL, which includes the `customer` and `roleId` as path parameters. The `customer` parameter represents the Google Workspace account ID or the `my_customer` alias. The `roleId` is the immutable ID of the role. The request body should be empty. A successful response returns a `Role` instance, and requires specific OAuth scopes for authorization.\n"]]
