- Ressource: CseKeyPair
- EnablementState
- CsePrivateKeyMetadata
- KaclsKeyMetadata
- HardwareKeyMetadata
- Méthodes
Ressource: CseKeyPair
Paire de clés S/MIME de chiffrement côté client qui comprend une clé publique, sa chaîne de certificat et les métadonnées de sa clé privée associée. Gmail utilise cette paire de clés pour effectuer les tâches suivantes:
- Signer les messages sortants chiffrés côté client
- Enregistrez et rouvrez les brouillons de messages chiffrés côté client.
- Enregistrez et rouvrez les messages envoyés.
- Déchiffrer les messages S/MIME entrants ou archivés
Représentation JSON |
---|
{ "keyPairId": string, "pkcs7": string, "pem": string, "subjectEmailAddresses": [ string ], "enablementState": enum ( |
Champs | |
---|---|
keyPairId |
Uniquement en sortie. ID immuable pour la paire de clés S/MIME de chiffrement côté client. |
pkcs7 |
Uniquement en entrée. La clé publique et sa chaîne de certificats La chaîne doit être au format PKCS#7 et utiliser l'encodage PEM et l'armure ASCII. |
pem |
Uniquement en sortie. La clé publique et sa chaîne de certificat, au format PEM. |
subjectEmailAddresses[] |
Uniquement en sortie. Identités d'adresse e-mail spécifiées sur le certificat d'entité finale. |
enablementState |
Uniquement en sortie. État actuel de la paire de clés. |
disableTime |
Uniquement en sortie. Si une paire de clés est définie sur Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: |
privateKeyMetadata[] |
Métadonnées des instances de la clé privée de cette paire de clés. |
EnablementState
Énumération pour l'état actuel de la paire de clés.
Enums | |
---|---|
stateUnspecified |
L'état actuel de la paire de clés n'est pas défini. La paire de clés n'est ni activée, ni désactivée. |
enabled |
La paire de clés est activée. Gmail déchiffre tous les e-mails chiffrés par cette paire de clés et signe tous les messages sortants à l'aide de la clé privée. Pour activer une paire de clés, utilisez la méthode |
disabled |
La paire de clés est désactivée. Les utilisateurs authentifiés ne peuvent pas déchiffrer les e-mails ni signer les messages sortants. Si une paire de clés est désactivée pendant plus de 30 jours, vous pouvez la supprimer définitivement. Pour désactiver une paire de clés, utilisez la méthode |
CsePrivateKeyMetadata
Métadonnées d'une instance de clé privée.
Représentation JSON |
---|
{ "privateKeyMetadataId": string, // Union field |
Champs | |
---|---|
privateKeyMetadataId |
Uniquement en sortie. ID immuable pour l'instance de métadonnées de clé privée. |
Champ d'union metadata_variant . Champ "union" : un seul des types de variantes de métadonnées suivants doit être présent. metadata_variant ne peut être qu'un des éléments suivants : |
|
kaclsKeyMetadata |
Métadonnées d'une instance de clé privée gérée par un service de liste de contrôle d'accès aux clés externes. |
hardwareKeyMetadata |
Métadonnées des clés matérielles. |
KaclsKeyMetadata
Métadonnées des clés privées gérées par un service de liste de contrôle d'accès aux clés externes. Pour en savoir plus sur la gestion de l'accès aux clés, consultez la documentation de référence de l'API Google Workspace CSE.
Représentation JSON |
---|
{ "kaclsUri": string, "kaclsData": string } |
Champs | |
---|---|
kaclsUri |
URI du service de liste de contrôle d'accès aux clés qui gère la clé privée. |
kaclsData |
Données opaques générées et utilisées par le service de liste de contrôle d'accès aux clés. Taille maximale: 8 Kio. |
HardwareKeyMetadata
Métadonnées des clés matérielles.
Représentation JSON |
---|
{ "description": string } |
Champs | |
---|---|
description |
Description de la clé matérielle. |
Méthodes |
|
---|---|
|
Crée et importe une chaîne de certificats de clé publique S/MIME de chiffrement côté client et des métadonnées de clé privée pour l'utilisateur authentifié. |
|
Désactive une paire de clés de chiffrement côté client. |
|
Active une paire de clés de chiffrement côté client qui a été désactivée. |
|
Récupère une paire de clés de chiffrement côté client existante. |
|
Liste les paires de clés de chiffrement côté client pour un utilisateur authentifié. |
|
Supprime définitivement et immédiatement une paire de clés de chiffrement côté client. |