- Recurso: CseKeyPair
- EnablementState
- CsePrivateKeyMetadata
- KaclsKeyMetadata
- HardwareKeyMetadata
- Métodos
Recurso: CseKeyPair
Um par de chaves S/MIME de criptografia do lado do cliente, que é composto por uma chave pública, a cadeia de certificados dela 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 enviadas.
- Salve e reabra rascunhos de mensagens criptografadas do lado do cliente.
- Salve e reabra mensagens enviadas.
- Descriptografar mensagens S/MIME recebidas ou arquivadas.
Representação JSON |
---|
{ "keyPairId": string, "pkcs7": string, "pem": string, "subjectEmailAddresses": [ string ], "enablementState": enum ( |
Campos | |
---|---|
keyPairId |
Apenas saída. O ID imutável do par de chaves S/MIME de criptografia do lado do cliente. |
pkcs7 |
Somente entrada. A chave pública e a cadeia de certificados dela. A cadeia precisa estar no formato PKCS#7 e usar a codificação PEM e a proteção ASCII. |
pem |
Apenas saída. A chave pública e a cadeia de certificados dela, no formato PEM. |
subjectEmailAddresses[] |
Apenas saída. As identidades de endereço de e-mail especificadas no certificado de folha. |
enablementState |
Apenas saída. O estado atual do par de chaves. |
disableTime |
Apenas saída. Se um par de chaves estiver definido como Usa o RFC 3339, em que a saída gerada é sempre normalizada em Z e usa 0, 3, 6 ou 9 dígitos fracionários. Deslocamentos diferentes de "Z" também são aceitos. Exemplos: |
privateKeyMetadata[] |
metadados para instâncias da chave privada desse par de chaves. |
EnablementState
A enumeração do estado atual do par de chaves.
Enums | |
---|---|
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 |
disabled |
O par de chaves está desativado. Os usuários autenticados não podem descriptografar mensagens de e-mail nem assinar mensagens de saída. Se um par de chaves ficar desativado por mais de 30 dias, você poderá excluí-lo permanentemente. Para desativar um par de chaves, use o método |
CsePrivateKeyMetadata
metadados de uma instância de chave privada.
Representação JSON |
---|
{ "privateKeyMetadataId": string, // Union field |
Campos | |
---|---|
privateKeyMetadataId |
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 seguintes tipos de variante de metadados precisa estar presente. metadata_variant pode ser apenas de um dos tipos a seguir: |
|
kaclsKeyMetadata |
metadados de uma instância de chave privada gerenciada por um serviço externo de lista de controle de acesso a chaves. |
hardwareKeyMetadata |
metadados para chaves de hardware. |
KaclsKeyMetadata
metadados de chaves privadas gerenciadas por um serviço externo de lista de controle de acesso às chaves. Para saber como gerenciar o acesso à chave, consulte a Referência da API Google Workspace CSE.
Representação JSON |
---|
{ "kaclsUri": string, "kaclsData": string } |
Campos | |
---|---|
kaclsUri |
O URI do serviço de lista de controle de acesso às chaves que gerencia a chave privada. |
kaclsData |
Dados opacos gerados e usados pelo serviço de lista de controle de acesso principal. Tamanho máximo: 8 KiB. |
HardwareKeyMetadata
metadados para chaves de hardware.
Representação JSON |
---|
{ "description": string } |
Campos | |
---|---|
description |
Descrição da chave de hardware. |
Métodos |
|
---|---|
|
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. |
|
Desativa um par de chaves de criptografia do lado do cliente. |
|
Ativa um par de chaves de criptografia do lado do cliente que estava desativado. |
|
Recupera um par de chaves de criptografia do lado do cliente. |
|
Lista pares de chaves de criptografia do lado do cliente para um usuário autenticado. |
|
Exclui um par de chaves de criptografia do lado do cliente de forma permanente e imediata. |