Method: users.settings.cse.identities.get

Retrieves a client-side encryption identity configuration.

HTTP request

GET https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
userId

string

The requester's primary email address. To indicate the authenticated user, you can use the special value me.
cseEmailAddress

string

The primary email address associated with the client-side encryption identity configuration that's retrieved.

Request body

The request body must be empty.

Response body

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

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
  • https://www.googleapis.com/auth/gmail.settings.sharing

For more information, see the Authorization guide.