Method: users.settings.delegates.list
Lists the delegates for the specified account.
This method is only available to service account clients that have been delegated domain-wide authority.
HTTP request
GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
userId |
string
User's email address. The special value "me" can be used to indicate the authenticated user.
|
Request body
The request body must be empty.
Response body
Response for the delegates.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"delegates": [
{
object (Delegate)
}
]
} |
| Fields |
delegates[] |
object (Delegate)
List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/gmail.settings.basic
https://mail.google.com/
https://www.googleapis.com/auth/gmail.modify
https://www.googleapis.com/auth/gmail.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-09-04 UTC.
[null,null,["Last updated 2024-09-04 UTC."],[[["Lists delegates for a specified account, accessible only to service accounts with domain-wide authority."],["Employs a `GET` request to the endpoint `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates`, using gRPC Transcoding syntax."],["Requires an empty request body and returns a JSON response containing a list of delegates, if any."],["Needs authorization with specific OAuth scopes like `https://www.googleapis.com/auth/gmail.settings.basic` or `https://www.googleapis.com/auth/gmail.modify`."]]],["A `GET` request is made to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates` to list an account's delegates. The `userId` path parameter, which can be \"me,\" specifies the user. The request body must be empty. The response body, if successful, includes a JSON structure with a list of delegate objects under the \"delegates\" field. This action requires service account clients with domain-wide authority and specific OAuth scopes.\n"]]
