REST Resource: users.settings.cse.keypairs

Ressource : CseKeyPair

Paire de clés S/MIME de chiffrement côté client, composée d'une clé publique, de sa chaîne de certificats et de métadonnées pour sa clé privée associée. Gmail utilise la paire de clés pour effectuer les tâches suivantes :

  • Signer les messages sortants chiffrés côté client.
  • Enregistrer et rouvrir les brouillons de messages chiffrés côté client.
  • Enregistrer et rouvrir les messages envoyés.
  • Déchiffrer les messages S/MIME entrants ou archivés.

Pour les administrateurs qui gèrent les identités et les paires de clés des utilisateurs de leur organisation, les requêtes nécessitent une autorisation avec un compte de service disposant d'une délégation à l'échelle du domaine pour emprunter l'identité des utilisateurs avec le champ d'application https://www.googleapis.com/auth/gmail.settings.basic.

Pour les utilisateurs qui gèrent leurs propres identités et paires de clés, les requêtes nécessitent que le chiffrement par clé matérielle soit activé et configuré.

Représentation JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Champs
keyPairId

string

Uniquement en sortie. ID immuable de la paire de clés S/MIME de chiffrement côté client.
pkcs7

string

Uniquement en entrée. Clé publique et sa chaîne de certificats. La chaîne doit être au format PKCS#7, utiliser l'encodage PEM et l'armure ASCII.
pem

string

Uniquement en sortie. Clé publique et sa chaîne de certificats, au format PEM.
subjectEmailAddresses[]

string

Uniquement en sortie. Identités d'adresse e-mail spécifiées dans le certificat final.
enablementState

enum (EnablementState)

Uniquement en sortie. État actuel de la paire de clés.
disableTime

string (Timestamp format)

Uniquement en sortie. Si une paire de clés est définie sur DISABLED, il s'agit de l'heure à laquelle l'état de la paire de clés est passé de ENABLED à DISABLED. Ce champ n'est présent que lorsque la paire de clés est à l'état DISABLED.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Métadonnées des instances de la clé privée de cette paire de clés.

EnablementState

Énumération de 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. Pour tous les e-mails chiffrés par cette paire de clés, Gmail déchiffre les messages et signe tous les e-mails sortants avec la clé privée.

Pour activer une paire de clés, utilisez la méthode keypairs.enable.
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 keypairs.disable.

CsePrivateKeyMetadata

Métadonnées d'une instance de clé privée.

Représentation JSON 
{
  "privateKeyMetadataId": string,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
Champs
privateKeyMetadataId

string

Uniquement en sortie. ID immuable de l'instance de métadonnées de clé privée.
Champ d'union metadata_variant. Champ d'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

object (KaclsKeyMetadata)

Métadonnées d'une instance de clé privée gérée par un service externe de liste de contrôle d'accès aux clés.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Métadonnées des clés matérielles.

KaclsKeyMetadata

Métadonnées des clés privées gérées par un service externe de liste de contrôle d'accès aux clés. 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

string

URI du service de liste de contrôle d'accès aux clés qui gère la clé privée.
kaclsData

string

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.

Si le chiffrement par clé matérielle est configuré pour l'organisation Google Workspace, les utilisateurs peuvent éventuellement stocker leur clé privée sur leur carte à puce et l'utiliser pour signer et déchiffrer des e-mails dans Gmail en insérant leur carte à puce dans un lecteur connecté à leur appareil Windows.

Représentation JSON 
{
  "description": string
}
Champs
description

string

Description de la clé matérielle.

Méthodes

create

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

disable

 Désactive une paire de clés de chiffrement côté client.

enable

 Active une paire de clés de chiffrement côté client qui a été désactivée.

get

 Récupère une paire de clés de chiffrement côté client existante.

list

 Liste les paires de clés de chiffrement côté client pour un utilisateur authentifié.

obliterate

 Supprime une paire de clés de chiffrement côté client immédiatement et de manière définitive.