REST Resource: users.settings.cse.keypairs

Ressource: CseKeyPair

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

  • Signez les messages chiffrés côté client sortants.
  • Enregistrer et rouvrir des 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
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 l'armure ASCII.
pem

string

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

string

Uniquement en sortie. Identifiants des adresses e-mail spécifiés sur le certificat de feuille.
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, l'heure à laquelle son état 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 est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" 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 pour les 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 les déchiffre et signe 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,

  // 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 de liste de contrôle d'accès aux clés externe.
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 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 des clés. Taille maximale: 8 Ko.

HardwareKeyMetadata

Métadonnées des 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 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 était 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 définitivement et immédiatement une paire de clés de chiffrement côté client.