/gmail/v1/users/{userId}/settings/delegates

GET

users

Lists the delegates for the specified account. This method is only available to service account clients that have been delegated domain-wide authority.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://gmail.googleapis.com//gmail/v1/users//settings/delegates'

Response Example

{
  "delegates": [
    {
      "delegateEmail": "string",
      "verificationStatus": "verificationStatusUnspecified"
    }
  ]
}

Request

Path Params

userId

string

required

User's email address. The special value "me" can be used to indicate the authenticated user.

Responses

🟢200Successful response

application/json

Body

Response for the ListDelegates method.

delegates

array[object (Delegate) {2}]

optional

List of the user's delegates (with any verification status). If an account doesn't have delegates, this field doesn't appear.

delegateEmail

string

optional

The email address of the delegate.

verificationStatus

enum<string>

optional

Indicates whether this address has been verified and can act as a delegate for the account. Read-only.

Allowed values:

verificationStatusUnspecifiedacceptedpendingrejectedexpired

Modified at 2023-08-15 05:40:23

/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate

/gmail/v1/users/{userId}/settings/delegates