REST Resource: users.settings.cse.keypairs

Recurso: CseKeyPair

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

  • Assine as mensagens enviadas com criptografia do lado do cliente.
  • Salve e reabra rascunhos de mensagens criptografadas do lado do cliente.
  • Salvar e reabrir as mensagens enviadas.
  • Descriptografar mensagens S/MIME recebidas ou arquivadas.
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 da criptografia do lado do cliente.
pkcs7

string

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

string

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

string

Apenas saída. As identidades de endereço de e-mail especificadas no certificado de 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 for definido como DISABLED, o horário em que o estado do par vai mudar de ENABLED para DISABLED. Este campo está presente apenas quando o par de chaves está no estado DISABLED.

Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: "2014-10-02T15:01:23Z" e "2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

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

EnablementState

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

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

O par de chaves está ativado. O Gmail descriptografa todas as mensagens de e-mail criptografadas por esse par de chaves e assina todos os e-mails enviados 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 ficar 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,

  // 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

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

object (KaclsKeyMetadata)

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

object (HardwareKeyMetadata)

Metadados das chaves de hardware.

KaclsKeyMetadata

Metadados das chaves privadas gerenciadas por um serviço de lista de controle de acesso a chaves externo. Saiba como gerenciar o acesso a chaves em Referência da API Google Workspace CSE.

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

string

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

string

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

HardwareKeyMetadata

Metadados das chaves de hardware.

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