REST Resource: users.settings.cse.keypairs

Recurso: CseKeyPair

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

  • Firma los mensajes salientes con encriptación del cliente.
  • Guardar y volver a abrir borradores de mensajes con encriptación del cliente
  • Guardar y volver a abrir mensajes enviados
  • Desencriptar mensajes 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 la 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 codificación PEM y protección ASCII.
pem

string

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

string

Solo salida. Las identidades de las direcciones de correo electrónico que se especifican en el certificado de entidad final
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, el momento en que el estado del par de claves cambió de ENABLED a DISABLED Este campo solo está presente cuando el par de claves está en el estado DISABLED.

Usa RFC 3339, en el que el resultado generado siempre se normalizará en Z y usará 0, 3, 6 o 9 dígitos fraccionarios. También se aceptan compensaciones distintas de "Z". Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

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

EnablementState

Es la enumeración del estado actual del par de claves.

Enumeraciones
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. En el caso de los mensajes de correo electrónico que encripta este par de claves, Gmail desencripta los mensajes y firma el correo saliente 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 los mensajes de correo electrónico ni firmar los mensajes salientes. Si un par de claves está 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 de la instancia de metadatos de clave privada.
Campo de unión metadata_variant. Campo de unión: Debe estar presente 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 lista de control de acceso de claves
hardwareKeyMetadata

object (HardwareKeyMetadata)

metadatos de las teclas de hardware.

KaclsKeyMetadata

metadatos de claves privadas administradas por un servicio externo de lista de control de acceso de 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 la lista de control de acceso a las claves que administra la clave privada.
kaclsData

string

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

HardwareKeyMetadata

metadatos de las teclas 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 de 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 estaba desactivado.

get

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

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 permanente e inmediata.