From a4ca99c42e5c618e57071a800f49d784a0bb6eea Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 20 Dec 2022 07:08:02 +0000 Subject: [PATCH] feat(gmail): update the api #### gmail:v1 The following keys were added: - resources.users.resources.settings.resources.cse.resources.identities.methods.create (Total Keys: 12) - resources.users.resources.settings.resources.cse.resources.identities.methods.delete (Total Keys: 13) - resources.users.resources.settings.resources.cse.resources.identities.methods.get (Total Keys: 14) - resources.users.resources.settings.resources.cse.resources.identities.methods.list (Total Keys: 17) - resources.users.resources.settings.resources.cse.resources.identities.methods.patch (Total Keys: 15) - resources.users.resources.settings.resources.cse.resources.keypairs.methods.create (Total Keys: 12) - resources.users.resources.settings.resources.cse.resources.keypairs.methods.disable (Total Keys: 15) - resources.users.resources.settings.resources.cse.resources.keypairs.methods.enable (Total Keys: 15) - resources.users.resources.settings.resources.cse.resources.keypairs.methods.get (Total Keys: 14) - resources.users.resources.settings.resources.cse.resources.keypairs.methods.list (Total Keys: 17) - resources.users.resources.settings.resources.cse.resources.keypairs.methods.obliterate (Total Keys: 14) - schemas.CseIdentity (Total Keys: 4) - schemas.CseKeyPair (Total Keys: 17) - schemas.CsePrivateKeyMetadata (Total Keys: 5) - schemas.DisableCseKeyPairRequest (Total Keys: 2) - schemas.EnableCseKeyPairRequest (Total Keys: 2) - schemas.KaclsKeyMetadata (Total Keys: 4) - schemas.ListCseIdentitiesResponse (Total Keys: 5) - schemas.ListCseKeyPairsResponse (Total Keys: 5) - schemas.ObliterateCseKeyPairRequest (Total Keys: 2) --- docs/dyn/gmail_v1.users.settings.cse.html | 96 +++ ...mail_v1.users.settings.cse.identities.html | 237 ++++++++ .../gmail_v1.users.settings.cse.keypairs.html | 361 ++++++++++++ docs/dyn/gmail_v1.users.settings.html | 5 + .../discovery_cache/documents/gmail.v1.json | 552 +++++++++++++++++- 5 files changed, 1250 insertions(+), 1 deletion(-) create mode 100644 docs/dyn/gmail_v1.users.settings.cse.html create mode 100644 docs/dyn/gmail_v1.users.settings.cse.identities.html create mode 100644 docs/dyn/gmail_v1.users.settings.cse.keypairs.html diff --git a/docs/dyn/gmail_v1.users.settings.cse.html b/docs/dyn/gmail_v1.users.settings.cse.html new file mode 100644 index 00000000000..4bd431738b3 --- /dev/null +++ b/docs/dyn/gmail_v1.users.settings.cse.html @@ -0,0 +1,96 @@ + + + +

Gmail API . users . settings . cse

+

Instance Methods

+

+ identities() +

+

Returns the identities Resource.

+ +

+ keypairs() +

+

Returns the keypairs Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ + \ No newline at end of file diff --git a/docs/dyn/gmail_v1.users.settings.cse.identities.html b/docs/dyn/gmail_v1.users.settings.cse.identities.html new file mode 100644 index 00000000000..45b603d5ef5 --- /dev/null +++ b/docs/dyn/gmail_v1.users.settings.cse.identities.html @@ -0,0 +1,237 @@ + + + +

Gmail API . users . settings . cse . identities

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(userId, body=None, x__xgafv=None)

+

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).

+

+ delete(userId, cseEmailAddress, x__xgafv=None)

+

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).

+

+ get(userId, cseEmailAddress, x__xgafv=None)

+

Retrieves a client-side encryption identity configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).

+

+ list(userId, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).

+

+ list_next()

+

Retrieves the next page of results.

+

+ patch(userId, emailAddress, body=None, x__xgafv=None)

+

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).

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(userId, body=None, x__xgafv=None) + 
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).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+  "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+  "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+  "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+  "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+
+ +
+ delete(userId, cseEmailAddress, x__xgafv=None) + 
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).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  cseEmailAddress: string, The primary email address associated with the client-side encryption identity configuration that's removed. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ +
+ get(userId, cseEmailAddress, x__xgafv=None) + 
Retrieves a client-side encryption identity configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  cseEmailAddress: string, The primary email address associated with the client-side encryption identity configuration that's retrieved. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+  "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+  "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+
+ +
+ list(userId, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  pageSize: integer, The number of identities to return. If not provided, the page size will default to 20 entries.
+  pageToken: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "cseIdentities": [ # One page of the list of CSE identities configured for the user.
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+      "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+      "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+    },
+  ],
+  "nextPageToken": "A String", # Pagination token to be passed to a subsequent ListCseIdentities call in order to retrieve the next page of identities. If this value is not returned or is the empty string, then no further pages remain.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(userId, emailAddress, body=None, x__xgafv=None) + 
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).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  emailAddress: string, The email address of the client-side encryption identity to update. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+  "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+  "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.
+  "emailAddress": "A String", # The email address for the sending identity. The email address must be the primary email address of the authenticated user.
+  "primaryKeyPairId": "A String", # If a key pair is associated, the identifier of the key pair, CseKeyPair.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/gmail_v1.users.settings.cse.keypairs.html b/docs/dyn/gmail_v1.users.settings.cse.keypairs.html new file mode 100644 index 00000000000..bdc7c68ee27 --- /dev/null +++ b/docs/dyn/gmail_v1.users.settings.cse.keypairs.html @@ -0,0 +1,361 @@ + + + +

Gmail API . users . settings . cse . keypairs

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ create(userId, body=None, x__xgafv=None)

+

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).

+

+ disable(userId, keyPairId, body=None, x__xgafv=None)

+

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).

+

+ enable(userId, keyPairId, body=None, x__xgafv=None)

+

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).

+

+ get(userId, keyPairId, x__xgafv=None)

+

Retrieves an existing client-side encryption key pair. [Beta](https://workspace.google.com/terms/service-terms/index.html).

+

+ list(userId, pageSize=None, pageToken=None, x__xgafv=None)

+

Lists client-side encryption key pairs for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).

+

+ list_next()

+

Retrieves the next page of results.

+

+ obliterate(userId, keyPairId, body=None, x__xgafv=None)

+

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).

+

Method Details

+
+ close() + 
Close httplib2 connections.
+
+ +
+ create(userId, body=None, x__xgafv=None) + 
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).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+  "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+  "enablementState": "A String", # Output only. The current state of the key pair.
+  "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+  "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+  "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+  "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+    { # Metadata for a private key instance.
+      "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+        "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+        "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+      },
+      "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+    },
+  ],
+  "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+    "A String",
+  ],
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+  "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+  "enablementState": "A String", # Output only. The current state of the key pair.
+  "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+  "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+  "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+  "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+    { # Metadata for a private key instance.
+      "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+        "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+        "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+      },
+      "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+    },
+  ],
+  "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+    "A String",
+  ],
+}
+
+ +
+ disable(userId, keyPairId, body=None, x__xgafv=None) + 
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).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  keyPairId: string, The identifier of the key pair to turn off. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Requests to turn off a client-side encryption key pair.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+  "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+  "enablementState": "A String", # Output only. The current state of the key pair.
+  "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+  "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+  "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+  "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+    { # Metadata for a private key instance.
+      "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+        "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+        "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+      },
+      "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+    },
+  ],
+  "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+    "A String",
+  ],
+}
+
+ +
+ enable(userId, keyPairId, body=None, x__xgafv=None) + 
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).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  keyPairId: string, The identifier of the key pair to turn on. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Requests to turn on a client-side encryption key pair.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+  "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+  "enablementState": "A String", # Output only. The current state of the key pair.
+  "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+  "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+  "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+  "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+    { # Metadata for a private key instance.
+      "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+        "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+        "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+      },
+      "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+    },
+  ],
+  "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+    "A String",
+  ],
+}
+
+ +
+ get(userId, keyPairId, x__xgafv=None) + 
Retrieves an existing client-side encryption key pair. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  keyPairId: string, The identifier of the key pair to retrieve. (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+  "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+  "enablementState": "A String", # Output only. The current state of the key pair.
+  "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+  "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+  "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+  "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+    { # Metadata for a private key instance.
+      "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+        "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+        "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+      },
+      "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+    },
+  ],
+  "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+    "A String",
+  ],
+}
+
+ +
+ list(userId, pageSize=None, pageToken=None, x__xgafv=None) + 
Lists client-side encryption key pairs for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  pageSize: integer, The number of key pairs to return. If not provided, the page size will default to 20 entries.
+  pageToken: string, 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.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "cseKeyPairs": [ # One page of the list of CSE key pairs installed for the user.
+    { # [Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.
+      "disableTime": "A String", # Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.
+      "enablementState": "A String", # Output only. The current state of the key pair.
+      "keyPairId": "A String", # Output only. The immutable ID for the client-side encryption S/MIME key pair.
+      "pem": "A String", # Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.
+      "pkcs7": "A String", # Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.
+      "privateKeyMetadata": [ # Metadata for instances of this key pair's private key.
+        { # Metadata for a private key instance.
+          "kaclsKeyMetadata": { # Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference). # Metadata for a private key instance managed by an external key access control list service.
+            "kaclsData": "A String", # Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.
+            "kaclsUri": "A String", # The URI of the key access control list service that manages the private key.
+          },
+          "privateKeyMetadataId": "A String", # Output only. The immutable ID for the private key metadata instance.
+        },
+      ],
+      "subjectEmailAddresses": [ # Output only. The email address identities that are specified on the leaf certificate.
+        "A String",
+      ],
+    },
+  ],
+  "nextPageToken": "A String", # Pagination token to be passed to a subsequent ListCseKeyPairs call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain.
+}
+
+ +
+ list_next() + 
Retrieves the next page of results.
+
+        Args:
+          previous_request: The request for the previous page. (required)
+          previous_response: The response from the request for the previous page. (required)
+
+        Returns:
+          A request object that you can call 'execute()' on to request the next
+          page. Returns None if there are no more items in the collection.
+
+
+ +
+ obliterate(userId, keyPairId, body=None, x__xgafv=None) + 
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).
+
+Args:
+  userId: string, The requester's primary email address. To indicate the authenticated user, you can use the special value `me`. (required)
+  keyPairId: string, The identifier of the key pair to obliterate. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to obliterate a CSE key pair.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/gmail_v1.users.settings.html b/docs/dyn/gmail_v1.users.settings.html index 4a657d2b241..ac06ec23f65 100644 --- a/docs/dyn/gmail_v1.users.settings.html +++ b/docs/dyn/gmail_v1.users.settings.html @@ -74,6 +74,11 @@

Gmail API . users . settings

Instance Methods

+

+ cse() +

+

Returns the cse Resource.

+

delegates()

diff --git a/googleapiclient/discovery_cache/documents/gmail.v1.json b/googleapiclient/discovery_cache/documents/gmail.v1.json index f4ce939490b..8784e608743 100644 --- a/googleapiclient/discovery_cache/documents/gmail.v1.json +++ b/googleapiclient/discovery_cache/documents/gmail.v1.json @@ -1633,6 +1633,401 @@ } }, "resources": { + "cse": { + "resources": { + "identities": { + "methods": { + "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).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/identities", + "httpMethod": "POST", + "id": "gmail.users.settings.cse.identities.create", + "parameterOrder": [ + "userId" + ], + "parameters": { + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/identities", + "request": { + "$ref": "CseIdentity" + }, + "response": { + "$ref": "CseIdentity" + }, + "scopes": [ + "https://www.googleapis.com/auth/gmail.settings.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "delete": { + "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).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}", + "httpMethod": "DELETE", + "id": "gmail.users.settings.cse.identities.delete", + "parameterOrder": [ + "userId", + "cseEmailAddress" + ], + "parameters": { + "cseEmailAddress": { + "description": "The primary email address associated with the client-side encryption identity configuration that's removed.", + "location": "path", + "required": true, + "type": "string" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}", + "scopes": [ + "https://www.googleapis.com/auth/gmail.settings.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "get": { + "description": "Retrieves a client-side encryption identity configuration. [Beta](https://workspace.google.com/terms/service-terms/index.html).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}", + "httpMethod": "GET", + "id": "gmail.users.settings.cse.identities.get", + "parameterOrder": [ + "userId", + "cseEmailAddress" + ], + "parameters": { + "cseEmailAddress": { + "description": "The primary email address associated with the client-side encryption identity configuration that's retrieved.", + "location": "path", + "required": true, + "type": "string" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/identities/{cseEmailAddress}", + "response": { + "$ref": "CseIdentity" + }, + "scopes": [ + "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.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "list": { + "description": "Lists the client-side encrypted identities for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/identities", + "httpMethod": "GET", + "id": "gmail.users.settings.cse.identities.list", + "parameterOrder": [ + "userId" + ], + "parameters": { + "pageSize": { + "default": "20", + "description": "The number of identities to return. If not provided, the page size will default to 20 entries.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "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" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/identities", + "response": { + "$ref": "ListCseIdentitiesResponse" + }, + "scopes": [ + "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.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "patch": { + "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).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}", + "httpMethod": "PATCH", + "id": "gmail.users.settings.cse.identities.patch", + "parameterOrder": [ + "userId", + "emailAddress" + ], + "parameters": { + "emailAddress": { + "description": "The email address of the client-side encryption identity to update.", + "location": "path", + "required": true, + "type": "string" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/identities/{emailAddress}", + "request": { + "$ref": "CseIdentity" + }, + "response": { + "$ref": "CseIdentity" + }, + "scopes": [ + "https://www.googleapis.com/auth/gmail.settings.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + } + } + }, + "keypairs": { + "methods": { + "create": { + "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).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/keypairs", + "httpMethod": "POST", + "id": "gmail.users.settings.cse.keypairs.create", + "parameterOrder": [ + "userId" + ], + "parameters": { + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/keypairs", + "request": { + "$ref": "CseKeyPair" + }, + "response": { + "$ref": "CseKeyPair" + }, + "scopes": [ + "https://www.googleapis.com/auth/gmail.settings.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "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).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable", + "httpMethod": "POST", + "id": "gmail.users.settings.cse.keypairs.disable", + "parameterOrder": [ + "userId", + "keyPairId" + ], + "parameters": { + "keyPairId": { + "description": "The identifier of the key pair to turn off.", + "location": "path", + "required": true, + "type": "string" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:disable", + "request": { + "$ref": "DisableCseKeyPairRequest" + }, + "response": { + "$ref": "CseKeyPair" + }, + "scopes": [ + "https://www.googleapis.com/auth/gmail.settings.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "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).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable", + "httpMethod": "POST", + "id": "gmail.users.settings.cse.keypairs.enable", + "parameterOrder": [ + "userId", + "keyPairId" + ], + "parameters": { + "keyPairId": { + "description": "The identifier of the key pair to turn on.", + "location": "path", + "required": true, + "type": "string" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:enable", + "request": { + "$ref": "EnableCseKeyPairRequest" + }, + "response": { + "$ref": "CseKeyPair" + }, + "scopes": [ + "https://www.googleapis.com/auth/gmail.settings.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "get": { + "description": "Retrieves an existing client-side encryption key pair. [Beta](https://workspace.google.com/terms/service-terms/index.html).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}", + "httpMethod": "GET", + "id": "gmail.users.settings.cse.keypairs.get", + "parameterOrder": [ + "userId", + "keyPairId" + ], + "parameters": { + "keyPairId": { + "description": "The identifier of the key pair to retrieve.", + "location": "path", + "required": true, + "type": "string" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}", + "response": { + "$ref": "CseKeyPair" + }, + "scopes": [ + "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.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "list": { + "description": "Lists client-side encryption key pairs for an authenticated user. [Beta](https://workspace.google.com/terms/service-terms/index.html).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/keypairs", + "httpMethod": "GET", + "id": "gmail.users.settings.cse.keypairs.list", + "parameterOrder": [ + "userId" + ], + "parameters": { + "pageSize": { + "default": "20", + "description": "The number of key pairs to return. If not provided, the page size will default to 20 entries.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "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", + "type": "string" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/keypairs", + "response": { + "$ref": "ListCseKeyPairsResponse" + }, + "scopes": [ + "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.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + }, + "obliterate": { + "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).", + "flatPath": "gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate", + "httpMethod": "POST", + "id": "gmail.users.settings.cse.keypairs.obliterate", + "parameterOrder": [ + "userId", + "keyPairId" + ], + "parameters": { + "keyPairId": { + "description": "The identifier of the key pair to obliterate.", + "location": "path", + "required": true, + "type": "string" + }, + "userId": { + "default": "me", + "description": "The requester's primary email address. To indicate the authenticated user, you can use the special value `me`.", + "location": "path", + "required": true, + "type": "string" + } + }, + "path": "gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate", + "request": { + "$ref": "ObliterateCseKeyPairRequest" + }, + "scopes": [ + "https://www.googleapis.com/auth/gmail.settings.basic", + "https://www.googleapis.com/auth/gmail.settings.sharing" + ] + } + } + } + } + }, "delegates": { "methods": { "create": { @@ -2682,7 +3077,7 @@ } } }, - "revision": "20221128", + "revision": "20221212", "rootUrl": "https://gmail.googleapis.com/", "schemas": { "AutoForwarding": { @@ -2758,6 +3153,94 @@ }, "type": "object" }, + "CseIdentity": { + "description": "[Beta](https://workspace.google.com/terms/service-terms/index.html). The client-side encryption (CSE) configuration for the email address of an authenticated user. Gmail uses CSE configurations to save drafts of client-side encrypted email messages, and to sign and send encrypted email messages.", + "id": "CseIdentity", + "properties": { + "emailAddress": { + "description": "The email address for the sending identity. The email address must be the primary email address of the authenticated user.", + "type": "string" + }, + "primaryKeyPairId": { + "description": "If a key pair is associated, the identifier of the key pair, CseKeyPair.", + "type": "string" + } + }, + "type": "object" + }, + "CseKeyPair": { + "description": "[Beta](https://workspace.google.com/terms/service-terms/index.html). A client-side encryption S/MIME key pair, which is comprised of a public key, its certificate chain, and metadata for its paired private key. Gmail uses the key pair to complete the following tasks: - Sign outgoing client-side encrypted messages. - Save and reopen drafts of client-side encrypted messages. - Save and reopen sent messages. - Decrypt incoming or archived S/MIME messages.", + "id": "CseKeyPair", + "properties": { + "disableTime": { + "description": "Output only. If a key pair is set to `DISABLED`, the time that the key pair's state changed from `ENABLED` to `DISABLED`. This field is present only when the key pair is in state `DISABLED`.", + "format": "google-datetime", + "readOnly": true, + "type": "string" + }, + "enablementState": { + "description": "Output only. The current state of the key pair.", + "enum": [ + "stateUnspecified", + "enabled", + "disabled" + ], + "enumDescriptions": [ + "The current state of the key pair is not set. The key pair is neither turned on nor turned off.", + "The key pair is turned on. For any email messages that this key pair encrypts, Gmail decrypts the messages and signs any outgoing mail with the private key. To turn on a key pair, use the EnableCseKeyPair method.", + "The key pair is turned off. Authenticated users cannot decrypt email messages nor sign outgoing messages. If a key pair is turned off for more than 30 days, you can permanently delete it. To turn off a key pair, use the DisableCseKeyPair method." + ], + "readOnly": true, + "type": "string" + }, + "keyPairId": { + "description": "Output only. The immutable ID for the client-side encryption S/MIME key pair.", + "readOnly": true, + "type": "string" + }, + "pem": { + "description": "Output only. The public key and its certificate chain, in [PEM](https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail) format.", + "readOnly": true, + "type": "string" + }, + "pkcs7": { + "description": "Input only. The public key and its certificate chain. The chain must be in [PKCS#7](https://en.wikipedia.org/wiki/PKCS_7) format and use PEM encoding and ASCII armor.", + "type": "string" + }, + "privateKeyMetadata": { + "description": "Metadata for instances of this key pair's private key.", + "items": { + "$ref": "CsePrivateKeyMetadata" + }, + "type": "array" + }, + "subjectEmailAddresses": { + "description": "Output only. The email address identities that are specified on the leaf certificate.", + "items": { + "type": "string" + }, + "readOnly": true, + "type": "array" + } + }, + "type": "object" + }, + "CsePrivateKeyMetadata": { + "description": "Metadata for a private key instance.", + "id": "CsePrivateKeyMetadata", + "properties": { + "kaclsKeyMetadata": { + "$ref": "KaclsKeyMetadata", + "description": "Metadata for a private key instance managed by an external key access control list service." + }, + "privateKeyMetadataId": { + "description": "Output only. The immutable ID for the private key metadata instance.", + "readOnly": true, + "type": "string" + } + }, + "type": "object" + }, "Delegate": { "description": "Settings for a delegate. Delegates can read, send, and delete messages, as well as view and add contacts, for the delegator's account. See \"Set up mail delegation\" for more information about delegates.", "id": "Delegate", @@ -2787,6 +3270,12 @@ }, "type": "object" }, + "DisableCseKeyPairRequest": { + "description": "Requests to turn off a client-side encryption key pair.", + "id": "DisableCseKeyPairRequest", + "properties": {}, + "type": "object" + }, "Draft": { "description": "A draft email in the user's mailbox.", "id": "Draft", @@ -2807,6 +3296,12 @@ }, "type": "object" }, + "EnableCseKeyPairRequest": { + "description": "Requests to turn on a client-side encryption key pair.", + "id": "EnableCseKeyPairRequest", + "properties": {}, + "type": "object" + }, "Filter": { "description": "Resource definition for Gmail filters. Filters apply to specific messages instead of an entire email thread.", "id": "Filter", @@ -3063,6 +3558,21 @@ }, "type": "object" }, + "KaclsKeyMetadata": { + "description": "Metadata for private keys managed by an external key access control list service. For details about managing key access, see [Google Workspace CSE API Reference](https://developers.google.com/workspace/cse/reference).", + "id": "KaclsKeyMetadata", + "properties": { + "kaclsData": { + "description": "Opaque data generated and used by the key access control list service. Maximum size: 8 KiB.", + "type": "string" + }, + "kaclsUri": { + "description": "The URI of the key access control list service that manages the private key.", + "type": "string" + } + }, + "type": "object" + }, "Label": { "description": "Labels are used to categorize messages and threads within the user's mailbox. The maximum number of labels supported for a user's mailbox is 10,000.", "id": "Label", @@ -3188,6 +3698,40 @@ }, "type": "object" }, + "ListCseIdentitiesResponse": { + "id": "ListCseIdentitiesResponse", + "properties": { + "cseIdentities": { + "description": "One page of the list of CSE identities configured for the user.", + "items": { + "$ref": "CseIdentity" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token to be passed to a subsequent ListCseIdentities call in order to retrieve the next page of identities. If this value is not returned or is the empty string, then no further pages remain.", + "type": "string" + } + }, + "type": "object" + }, + "ListCseKeyPairsResponse": { + "id": "ListCseKeyPairsResponse", + "properties": { + "cseKeyPairs": { + "description": "One page of the list of CSE key pairs installed for the user.", + "items": { + "$ref": "CseKeyPair" + }, + "type": "array" + }, + "nextPageToken": { + "description": "Pagination token to be passed to a subsequent ListCseKeyPairs call in order to retrieve the next page of key pairs. If this value is not returned, then no further pages remain.", + "type": "string" + } + }, + "type": "object" + }, "ListDelegatesResponse": { "description": "Response for the ListDelegates method.", "id": "ListDelegatesResponse", @@ -3528,6 +4072,12 @@ }, "type": "object" }, + "ObliterateCseKeyPairRequest": { + "description": "Request to obliterate a CSE key pair.", + "id": "ObliterateCseKeyPairRequest", + "properties": {}, + "type": "object" + }, "PopSettings": { "description": "POP settings for an account.", "id": "PopSettings",