REST Resource: users.settings.cse.keypairs

Recurso: CseKeyPair

Um par de chaves S/MIME de criptografia do lado do cliente, composto por uma chave pública, a cadeia de certificados e os metadados da chave privada pareada. O Gmail usa o par de chaves para concluir as seguintes tarefas:

  • Assinar mensagens criptografadas do lado do cliente.
  • Salvar e reabrir rascunhos de mensagens criptografadas do lado do cliente.
  • Salvar e reabrir mensagens enviadas.
  • Descriptografar mensagens S/MIME recebidas ou arquivadas.

Para administradores que gerenciam identidades e pares de chaves para usuários na organização, as solicitações exigem autorização com uma conta de serviço que tenha autoridade de delegação em todo o domínio para representar usuários com o escopo https://www.googleapis.com/auth/gmail.settings.basic.

Para usuários que gerenciam as próprias identidades e pares de chaves, as solicitações exigem que a criptografia de chaves de hardware esteja ativada e configurada.

Representação JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Campos
keyPairId

string

Apenas saída. O ID imutável do par de chaves S/MIME de criptografia do lado do cliente.
pkcs7

string

Somente entrada. A chave pública e a cadeia de certificados. A cadeia precisa estar no formato PKCS#7 e usar codificação PEM e proteção ASCII.
pem

string

Apenas saída. A chave pública e a cadeia de certificados, no formato PEM.
subjectEmailAddresses[]

string

Apenas saída. As identidades de endereço de e-mail especificadas no certificado folha.
enablementState

enum (EnablementState)

Apenas saída. O estado atual do par de chaves.
disableTime

string (Timestamp format)

Apenas saída. Se um par de chaves estiver definido como DISABLED, o horário em que o estado do par de chaves mudou de ENABLED para DISABLED. Esse campo só está presente quando o par de chaves está no estado DISABLED.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Metadados para instâncias da chave privada desse par de chaves.

EnablementState

A enumeração do estado atual do par de chaves.

Tipos enumerados
stateUnspecified O estado atual do par de chaves não está definido. O par de chaves não está ativado nem desativado.
enabled

O par de chaves está ativado. Para todas as mensagens de e-mail criptografadas por esse par de chaves, o Gmail descriptografa as mensagens e assina qualquer e-mail enviado com a chave privada.

Para ativar um par de chaves, use o método keypairs.enable.
disabled

O par de chaves está desativado. Os usuários autenticados não podem descriptografar mensagens de e-mail nem assinar mensagens enviadas. Se um par de chaves for desativado por mais de 30 dias, ele poderá ser excluído permanentemente.

Para desativar um par de chaves, use o método keypairs.disable.

CsePrivateKeyMetadata

Metadados para uma instância de chave privada.

Representação JSON 
{
  "privateKeyMetadataId": string,

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

string

Apenas saída. O ID imutável da instância de metadados de chave privada.
Campo de união metadata_variant. Campo de união: exatamente um dos seguintes tipos de variante de metadados precisa estar presente. metadata_variant pode ser apenas um dos seguintes:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Metadados para uma instância de chave privada gerenciada por um serviço externo de lista de controle de acesso a chaves.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Metadados para chaves de hardware.

KaclsKeyMetadata

Metadados para chaves privadas gerenciadas por um serviço externo de lista de controle de acesso a chaves. Para mais detalhes sobre como gerenciar o acesso a chaves, consulte a referência da API CSE do Google Workspace.

Representação JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
Campos
kaclsUri

string

O URI do serviço de lista de controle de acesso a chaves que gerencia a chave privada.
kaclsData

string

Dados opacos gerados e usados pelo serviço de lista de controle de acesso a chaves. Tamanho máximo: 8 KiB.

HardwareKeyMetadata

Metadados para chaves de hardware.

Se a criptografia de chaves de hardware estiver configurada para a organização do Google Workspace, os usuários poderão armazenar a chave privada no cartão inteligente e usá-la para assinar e descriptografar mensagens de e-mail no Gmail inserindo o cartão inteligente em um leitor conectado ao dispositivo Windows.

Representação JSON 
{
  "description": string
}
Campos
description

string

Descrição sobre a chave de hardware.

Métodos

create

 Cria e faz upload de uma cadeia de certificados de chave pública S/MIME de criptografia do lado do cliente e metadados de chave privada para o usuário autenticado.

disable

 Desativa um par de chaves de criptografia do lado do cliente.

enable

 Ativa um par de chaves de criptografia do lado do cliente que foi desativado.

get

 Recupera um par de chaves de criptografia do lado do cliente.

list

 Lista pares de chaves de criptografia do lado do cliente para um usuário autenticado.

obliterate

 Exclui um par de chaves de criptografia do lado do cliente de forma permanente e imediata.