Method: users.settings.delegates.get
Gets the specified delegate.
Note that a delegate user must be referred to by their primary email address, and not an email alias.
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/{delegateEmail}
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.
|
delegateEmail |
string
The email address of the user whose delegate relationship is to be retrieved.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of Delegate.
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."],[[["Retrieves a specific delegate for a Gmail user, identified by their primary email address."],["This functionality is exclusive to service accounts with domain-wide authority."],["Requires providing the user's email address (or \"me\" for the authenticated user) and the delegate's email address as path parameters."],["The response provides details of the delegate relationship if successful."],["Several OAuth scopes, including `https://www.googleapis.com/auth/gmail.settings.basic` and `https://www.googleapis.com/auth/gmail.modify`, are necessary for authorization."]]],["This describes retrieving a delegate user's information via a `GET` request to `https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/delegates/{delegateEmail}`. The `userId` parameter specifies the user, and `delegateEmail` the delegate. The request body must be empty. A successful response contains a `Delegate` instance. This operation requires domain-wide authority for service accounts and one of the listed OAuth scopes for authorization. Delegate user must be referred by their primary email.\n"]]
