REST Resource: users.settings.cse.keypairs

Risorsa: CseKeyPair

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

  • Firmare i messaggi con crittografia lato client in uscita.
  • Salvare e riaprire le bozze dei messaggi con crittografia lato client.
  • Salvare e riaprire i messaggi inviati.
  • Decriptare i messaggi S/MIME in arrivo o archiviati.

Per gli amministratori che gestiscono le identità e le coppie di chiavi per gli utenti della loro organizzazione, le richieste richiedono l'autorizzazione con un account di servizio che disponga dell'autorità di delega a livello di dominio per simulare l'identità degli utenti con l'ambito https://www.googleapis.com/auth/gmail.settings.basic.

Per gli utenti che gestiscono le proprie identità e coppie di chiavi, le richieste richiedono che la crittografia della chiave hardware sia attivata e configurata.

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 della 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 lo stato della coppia di chiavi è passato da ENABLED a DISABLED. Questo campo è presente solo quando la coppia di chiavi è nello stato DISABLED.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

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

EnablementState

L'enumerazione per lo stato attuale della coppia di chiavi.

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

La coppia di chiavi è attivata. Per tutti i messaggi email criptati da questa coppia di chiavi, Gmail decripta i messaggi e firma le email in uscita con la chiave privata.

Per attivare una coppia di chiavi, utilizza 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 è disattivata per più di 30 giorni, puoi eliminarla definitivamente.

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

CsePrivateKeyMetadata

Metadati per un'istanza di chiave privata.

Rappresentazione JSON 
{
  "privateKeyMetadataId": string,

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

string

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

object (KaclsKeyMetadata)

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

object (HardwareKeyMetadata)

Metadati per le chiavi hardware.

KaclsKeyMetadata

Metadati per le chiavi private gestite da un servizio di elenco di controllo dell'accesso alle chiavi esterno. Per informazioni dettagliate sulla gestione dell'accesso alle chiavi, consulta la documentazione di riferimento dell'API Client-Side Encryption di Google Workspace.

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

string

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

string

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

HardwareKeyMetadata

Metadati per le chiavi hardware.

Se la crittografia con chiave hardware è configurata per l'organizzazione Google Workspace, gli utenti possono facoltativamente archiviare la chiave privata sulla smart card e utilizzarla per firmare e decriptare i messaggi email in Gmail inserendo la smart card in un lettore collegato al proprio dispositivo Windows.

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 di 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 permanente e immediato.