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 metadatos para su clave privada vinculada. Gmail usa el par de claves para completar las siguientes tareas:

  • Firma mensajes salientes con encriptación del cliente.
  • Guarda y vuelve a abrir borradores de mensajes con encriptación del cliente.
  • Guarda y vuelve a abrir mensajes enviados.
  • Desencripta mensajes S/MIME entrantes o archivados.

Para los administradores que administran identidades y pares de claves para los usuarios de su organización, las solicitudes requieren autorización con una cuenta de servicio que tenga autoridad de delegación en todo el dominio para suplantar a los usuarios con el alcance https://www.googleapis.com/auth/gmail.settings.basic.

Para los usuarios que administran sus propias identidades y pares de claves, las solicitudes requieren que la encriptación de claves de hardware esté activada y configurada.

Representación JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Campos
keyPairId

string

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

string

Solo entrada. Es 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. Es la clave pública y su cadena de certificados, en PEM.
subjectEmailAddresses[]

string

Solo salida. Son las identidades de dirección de correo electrónico que se especifican en el certificado 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, es la hora 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 estado DISABLED.

Usa el formato RFC 3339, en el que el resultado generado siempre usará la normalización Z y los dígitos fraccionarios 0, 3, 6 o 9. También se aceptan otras compensaciones que no sean “Z”. Ejemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Son los 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.

Enums
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. Para cualquier mensaje de correo electrónico que encripta este par de claves, Gmail desencripta los mensajes y firma cualquier 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 mensajes de correo electrónico ni firmar 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

Son los metadatos de una instancia de clave privada.

Representación JSON 
{
  "privateKeyMetadataId": string,

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

string

Solo salida. Es 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. metadata_variant puede ser solo uno de los siguientes:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Son los metadatos de una instancia de clave privada administrada por un servicio externo de lista de control de acceso a claves.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Son los metadatos de las claves de hardware.

KaclsKeyMetadata

Son los metadatos de las claves privadas administradas por un servicio externo de lista de control de acceso a claves. Para obtener detalles sobre la administración del 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 a claves que administra la clave privada.
kaclsData

string

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

HardwareKeyMetadata

Son los metadatos de las claves de hardware.

Si la encriptación de claves de hardware está configurada para la organización de Google Workspace, los usuarios pueden almacenar de forma opcional su clave privada en su tarjeta inteligente y usarla para firmar y desencriptar mensajes de correo electrónico en Gmail insertando la tarjeta inteligente en un lector conectado a su dispositivo Windows.

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

string

Es la 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 se desactivó.

get

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

list

 Muestra 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 y de inmediato.