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 chiffrés côté client sortant.
  • Enregistrez et rouvrez les brouillons des messages chiffrés côté client.
  • Enregistrez et rouvrez les messages envoyés.
  • Déchiffrez 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 de 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 ainsi que 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. Identités d'adresses e-mail spécifiées sur le certificat 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, 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 l'état de la paire de clés est DISABLED.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres fractionnaires. 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 correspondant à 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 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 pas déchiffrer les e-mails ni signer de 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)
  }
  // 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 spécifié. 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 externes.

Métadonnées Key

Métadonnées pour les clés privées gérées par un service de liste de contrôle d'accès de clés externe. Pour en savoir plus sur la gestion des accès aux clés, consultez la documentation de référence de l'API CS Workspace de Google Workspace.

Représentation JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
Champs
kaclsUri

string

URI du service de liste de contrôle d'accès des 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.

Méthodes

create

 Crée et importe une chaîne de certificats de clé publique S/MIME 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

 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 définitive et immédiate.