REST Resource: users.settings.cse.keypairs

Risorsa: CseKeyPair

Una coppia di chiavi S/MIME di crittografia lato client, composta da una chiave pubblica, la relativa catena di certificati e i metadati della chiave privata accoppiata. Gmail utilizza la coppia di chiavi per completare le seguenti attività:

  • Firma i messaggi con crittografia lato client in uscita.
  • Salvare e riaprire le bozze di messaggi con crittografia lato client.
  • Salvare e riaprire i messaggi inviati.
  • Decripta i messaggi S/MIME in entrata o archiviati.
Rappresentazione JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Campi
keyPairId

string

Solo output. L'ID immutabile per la coppia di chiavi S/MIME di crittografia lato client.
pkcs7

string

Solo input. La chiave pubblica e la relativa catena di certificati. La catena deve essere in formato PKCS#7 e utilizzare la codifica PEM e l'armatura ASCII.
pem

string

Solo output. La chiave pubblica e la relativa catena di certificati in formato PEM.
subjectEmailAddresses[]

string

Solo output. Le identità degli indirizzi email specificate nel certificato foglia.
enablementState

enum (EnablementState)

Solo output. Lo stato attuale della coppia di chiavi.
disableTime

string (Timestamp format)

Solo output. Se una coppia di chiavi è impostata su DISABLED, l'ora in cui il suo stato è cambiato da ENABLED a DISABLED. Questo campo è presente solo quando la coppia di chiavi è nello stato DISABLED.

Un timestamp in formato "Zulu" UTC RFC3339, con risoluzione in nanosecondi e fino a nove cifre frazionarie. Esempi: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Metadati per le istanze della chiave privata di questa coppia di chiavi.

EnablementState

L'enumerazione dello stato corrente della coppia di chiavi.

Enum
stateUnspecified Lo stato attuale della coppia di chiavi non è impostato. La coppia di chiavi non è né accesa né spenta.
enabled

La coppia di chiavi è attiva. Gmail cripta tutti i messaggi email criptati da questa coppia di chiavi e firma tutti i messaggi in uscita con la chiave privata.

Per attivare una coppia di chiavi, usa il metodo keypairs.enable.
disabled

La coppia di chiavi è disattivata. Gli utenti autenticati non possono decriptare i messaggi email né firmare i messaggi in uscita. Se una coppia di chiavi viene disattivata per più di 30 giorni, puoi eliminarla definitivamente.

Per disattivare una coppia di chiavi, usa il metodo keypairs.disable.

CsePrivateKeyMetadata

Metadati per un'istanza di chiave privata.

Rappresentazione 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.
}
Campi
privateKeyMetadataId

string

Solo output. L'ID immutabile per l'istanza dei metadati della chiave privata.
Campo di unione metadata_variant. Campo di unione: deve essere presente esattamente uno dei seguenti tipi di varianti dei metadati. metadata_variant può essere solo uno dei seguenti:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Metadati per un'istanza di chiave privata gestita da un servizio di elenco di controllo dell'accesso per le chiavi esterno.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Metadati per le chiavi hardware.

KaclsKeyMetadata

Metadati per chiavi private gestite da un servizio di elenco di controllo dell'accesso alle chiavi esterno. Per maggiori dettagli sulla gestione dell'accesso alle chiavi, consulta il riferimento per le API della crittografia lato client di Google Workspace.

Rappresentazione JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
Campi
kaclsUri

string

L'URI del servizio per l'elenco di controllo dell'accesso alle chiavi che gestisce la chiave privata.
kaclsData

string

Dati opachi generati e utilizzati dal servizio dell'elenco di controllo dell'accesso per le chiavi. Dimensione massima: 8 KiB.

HardwareKeyMetadata

Metadati per le chiavi hardware.

Rappresentazione JSON 
{
  "description": string
}
Campi
description

string

Descrizione della chiave hardware.

Metodi

create

 Crea e carica una catena di certificati di chiave pubblica S/MIME con crittografia lato client e i metadati della chiave privata per l'utente autenticato.

disable

 Disattiva una coppia di chiavi di crittografia lato client.

enable

 Attiva una coppia di chiavi di crittografia lato client che è stata disattivata.

get

 Recupera una coppia di chiavi di crittografia lato client esistente.

list

 Elenca le coppie di chiavi di crittografia lato client per un utente autenticato.

obliterate

 Elimina una coppia di chiavi di crittografia lato client in modo definitivo e immediato.