2022-12-16
▼ ▲ gmail.users.settings.cse.identities.create
Description: Creates and configures a client-side encryption identity that's authorized to send mail from the user account. Google publishes the S/MIME certificate to a shared domain-wide directory so that people within a Google Workspace organization can encrypt and send mail to the identity. [Beta](https://workspace.google.com/terms/service-terms/index.html).
Parameters:
userId
Type: string
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Location: path
Required: Yes
Default: me
Path: gmail/v1/users/{userId}/settings/cse/identities
Flat Path: gmail/v1/users/{userId}/settings/cse/identities
Parameter Order: userId
HTTP Method: POST
Scopes:
▼ ▲ gmail.users.settings.cse.identities.get
HTTP Method: GET
Parameters:
cseEmailAddress
Type: string
Location: path
Description: The primary email address associated with the client-side encryption identity configuration that's retrieved.
Required: Yes
userId
Default: me
Location: path
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Type: string
Required: Yes
Description: Retrieves a client-side encryption identity configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).
Parameter Order:
Flat Path: gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Path: gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Scopes:
▼ ▲ gmail.users.settings.cse.identities.patch
Parameters:
emailAddress
Description: The email address of the client-side encryption identity to update.
Required: Yes
Type: string
Location: path
userId
Type: string
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Default: me
Location: path
Required: Yes
Scopes:
Parameter Order:
Path: gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
Description: Associates a different key pair with an existing client-side encryption identity. The updated key pair must validate against Google's [S/MIME certificate profiles](https://support.google.com/a/answer/7300887?hl=en). [Beta](https://workspace.google.com/terms/service-terms/index.html).
HTTP Method: PATCH
Flat Path: gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}
▼ ▲ gmail.users.settings.cse.identities.delete
Flat Path: gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Parameter Order:
Parameters:
cseEmailAddress
Type: string
Location: path
Description: The primary email address associated with the client-side encryption identity configuration that's removed.
Required: Yes
userId
Default: me
Type: string
Required: Yes
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Location: path
HTTP Method: DELETE
Path: gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}
Scopes:
Description: Deletes a client-side encryption identity. The authenticated user can no longer use the identity to send encrypted messages. You cannot restore the identity after you delete it. Instead, use the CreateCseIdentity method to create another identity with the same configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).
▼ ▲ gmail.users.settings.cse.identities.list
Flat Path: gmail/v1/users/{userId}/settings/cse/identities
Parameter Order: userId
HTTP Method: GET
Description: Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
Path: gmail/v1/users/{userId}/settings/cse/identities
Parameters:
pageToken
Description: Pagination token indicating which page of identities to return. If the token is not supplied, then the API will return the first page of results.
Location: query
Type: string
pageSize
Description: The number of identities to return. If not provided, the page size will default to 20 entries.
Type: integer
Format: int32
Default: 20
Location: query
userId
Type: string
Location: path
Default: me
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Required: Yes
Scopes:
▼ ▲ gmail.users.settings.cse.keypairs.create
HTTP Method: POST
Flat Path: gmail/v1/users/{userId}/settings/cse/keypairs
Parameter Order: userId
Path: gmail/v1/users/{userId}/settings/cse/keypairs
Parameters:
userId
Required: Yes
Type: string
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Default: me
Location: path
Scopes:
Description: Creates and uploads a client-side encryption S/MIME public key certificate chain and private key metadata for the authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
▼ ▲ gmail.users.settings.cse.keypairs.list
Parameter Order: userId
Path: gmail/v1/users/{userId}/settings/cse/keypairs
Description: Lists client-side encryption key pairs for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
HTTP Method: GET
Flat Path: gmail/v1/users/{userId}/settings/cse/keypairs
Parameters:
pageSize
Description: The number of key pairs to return. If not provided, the page size will default to 20 entries.
Format: int32
Location: query
Default: 20
Type: integer
pageToken
Type: string
Description: Pagination token indicating which page of key pairs to return. If the token is not supplied, then the API will return the first page of results.
Location: query
userId
Type: string
Required: Yes
Location: path
Default: me
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Scopes:
▼ ▲ gmail.users.settings.cse.keypairs.disable
HTTP Method: POST
Parameters:
userId
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Type: string
Location: path
Required: Yes
Default: me
keyPairId
Required: Yes
Location: path
Description: The identifier of the key pair to turn off.
Type: string
Parameter Order:
Flat Path: gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Path: gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable
Description: Turns off a client-side encryption key pair. The authenticated user can no longer use the key pair to decrypt incoming CSE message texts or sign outgoing CSE mail. To regain access, use the EnableCseKeyPair to turn on the key pair. After 30 days, you can permanently delete the key pair by using the ObliterateCseKeyPair method. [Beta](https://workspace.google.com/terms/service-terms/index.html).
Scopes:
▼ ▲ gmail.users.settings.cse.keypairs.obliterate
Parameter Order:
Scopes:
Flat Path: gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
Parameters:
keyPairId
Location: path
Required: Yes
Description: The identifier of the key pair to obliterate.
Type: string
userId
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Default: me
Type: string
Location: path
Required: Yes
Description: Deletes a client-side encryption key pair permanently and immediately. You can only permanently delete key pairs that have been turned off for more than 30 days. To turn off a key pair, use the DisableCseKeyPair method. Gmail can't restore or decrypt any messages that were encrypted by an obliterated key. Authenticated users and Google Workspace administrators lose access to reading the encrypted messages. [Beta](https://workspace.google.com/terms/service-terms/index.html).
HTTP Method: POST
Path: gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate
▼ ▲ gmail.users.settings.cse.keypairs.get
Scopes:
HTTP Method: GET
Parameter Order:
Description: Retrieves an existing client-side encryption key pair. [Beta](https://workspace.google.com/terms/service-terms/index.html).
Flat Path: gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
Parameters:
userId
Type: string
Location: path
Default: me
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Required: Yes
keyPairId
Description: The identifier of the key pair to retrieve.
Required: Yes
Location: path
Type: string
Path: gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}
▼ ▲ gmail.users.settings.cse.keypairs.enable
Parameter Order:
Path: gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Flat Path: gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable
Description: Turns on a client-side encryption key pair that was turned off. The key pair becomes active again for any associated client-side encryption identities. [Beta](https://workspace.google.com/terms/service-terms/index.html).
Parameters:
userId
Description: The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.
Required: Yes
Location: path
Default: me
Type: string
keyPairId
Type: string
Description: The identifier of the key pair to turn on.
Required: Yes
Location: path
HTTP Method: POST
Scopes: