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 des métadonnées de la clé privée associée Gmail utilise la paire de clés pour effectuer les tâches suivantes:

  • Signez les messages sortants chiffrés côté client.
  • Enregistrez et rouvrez des 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 (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Champs
keyPairId

string

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

string

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 ASCII Armor.
pem

string

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

string

Uniquement en sortie. Identités d'adresse e-mail spécifiées sur le certificat d'entité finale.
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 possède l'état DISABLED.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

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

EnablementState

Énumération indiquant 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 allumée. Pour tous les e-mails chiffrés par cette paire de clés, Gmail les déchiffre et signe tous les messages 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 ni déchiffrer les e-mails, ni signer les messages sortants. Si une paire de clés est éteinte 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 pour une instance de clé privée.

Représentation JSON 
{
  "privateKeyMetadataId": string,

  // Union field metadata_variant can be only one of the following:
  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
  // End of list of possible types for union field metadata_variant.
}
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 listes de contrôle d'accès aux clés.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Métadonnées pour les clés matérielles.

KaclsKeyMetadata

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

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

string

Description de la clé matérielle.

Méthodes

create

 Crée et importe des métadonnées de clé privée et une chaîne de certificats de clé publique S/MIME côté client 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

 Répertorie 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 de manière permanente et immédiate.