REST Resource: users.settings.cse.keypairs

Recurso: CseKeyPair

Un par de claves S/MIME de encriptación del cliente, que se compone de una clave pública, su cadena de certificados y los metadatos de su clave privada vinculada. Gmail usa ese par de claves para realizar las siguientes tareas:

  • Firma los mensajes salientes con encriptación del cliente.
  • Guarda y vuelve a abrir borradores de mensajes con encriptación del cliente.
  • Guardar y volver a abrir los mensajes enviados
  • Desencripta los mensajes de S/MIME entrantes o archivados.
Representación JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Campos
keyPairId

string

Solo salida. El ID inmutable para el par de claves S/MIME de encriptación del cliente.
pkcs7

string

Solo entrada. La clave pública y su cadena de certificados La cadena debe estar en formato PKCS#7 y usar la codificación PEM y ASCII armor.
pem

string

Solo salida. La clave pública y su cadena de certificados, en formato PEM.
subjectEmailAddresses[]

string

Solo salida. Las identidades de dirección de correo electrónico que se especifican en el certificado de hoja.
enablementState

enum (EnablementState)

Solo salida. Es el estado actual del par de claves.
disableTime

string (Timestamp format)

Solo salida. Si un par de claves se establece en DISABLED, la hora en la que el estado del par de claves cambió de ENABLED a DISABLED. Este campo está presente solo cuando el par de claves está en el estado DISABLED.

Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: "2014-10-02T15:01:23Z" y "2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Metadatos de las instancias de la clave privada de este par de claves.

EnablementState

La enumeración para el estado actual del par de claves.

Enumeradores
stateUnspecified No se estableció el estado actual del par de claves. El par de claves no está activado ni desactivado.
enabled

El par de claves está activado. Gmail desencripta todos los mensajes de correo electrónico que encripta este par de claves y firma los mensajes salientes con la clave privada.

Para activar un par de claves, usa el método keypairs.enable.
disabled

El par de claves está desactivado. Los usuarios autenticados no pueden desencriptar mensajes de correo electrónico ni firmar los mensajes salientes. Si un par de claves permanece desactivado durante más de 30 días, puedes borrarlo de forma permanente.

Para desactivar un par de claves, usa el método keypairs.disable.

CsePrivateKeyMetadata

Metadatos de una instancia de clave privada.

Representación 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.
}
Campos
privateKeyMetadataId

string

Solo salida. El ID inmutable para la instancia de metadatos de la clave privada.
Campo de unión metadata_variant. Campo de unión: Debe haber exactamente uno de los siguientes tipos de variantes de metadatos. Las direcciones (metadata_variant) solo pueden ser una de las siguientes opciones:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Metadatos de una instancia de clave privada administrada por un servicio externo de listas de control de acceso de claves.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Metadatos de claves de hardware.

KaclsKeyMetadata

Metadatos de claves privadas administradas por un servicio externo de listas de control de acceso a claves. Para obtener detalles sobre cómo administrar el acceso a las claves, consulta la Referencia de la API de CSE de Google Workspace.

Representación JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
Campos
kaclsUri

string

Es el URI del servicio de lista de control de acceso de claves que administra la clave privada.
kaclsData

string

Datos opacos que genera y usa el servicio de listas de control de acceso de claves. Tamaño máximo: 8 KiB.

HardwareKeyMetadata

Metadatos de claves de hardware.

Representación JSON 
{
  "description": string
}
Campos
description

string

Descripción de la clave de hardware.

Métodos

create

 Crea y sube una cadena de certificados de clave pública S/MIME con encriptación del cliente y metadatos de clave privada para el usuario autenticado.

disable

 Desactiva un par de claves de encriptación del cliente.

enable

 Activa un par de claves de encriptación del cliente que se desactivó.

get

 Recupera un par existente de claves de encriptación del cliente.

list

 Enumera los pares de claves de encriptación del cliente para un usuario autenticado.

obliterate

 Borra un par de claves de encriptación del cliente de forma inmediata y permanente.