REST Resource: users.settings.cse.keypairs

Zasób: CseKeyPair

Para kluczy S/MIME z szyfrowaniem po stronie klienta, która składa się z klucza publicznego, łańcucha certyfikatów i metadanych sparowanego klucza prywatnego. Gmail używa pary kluczy do wykonywania tych czynności:

  • Podpisuj wychodzące wiadomości zaszyfrowane po stronie klienta.
  • Zapisuj i ponownie otwieraj wersje robocze wiadomości zaszyfrowanych po stronie klienta.
  • zapisywać i ponownie otwierać wysłane wiadomości;
  • Odszyfrowywanie przychodzących lub zarchiwizowanych wiadomości S/MIME.
Zapis JSON 
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
Pola
keyPairId

string

Tylko dane wyjściowe. Stały identyfikator pary kluczy S/MIME szyfrowania po stronie klienta.
pkcs7

string

Tylko dane wejściowe. Klucz publiczny i jego łańcuch certyfikatów. Łańcuch musi mieć format PKCS#7 i używać kodowania PEM oraz zbroi ASCII.
pem

string

Tylko dane wyjściowe. Klucz publiczny i jego łańcuch certyfikatów w formacie PEM.
subjectEmailAddresses[]

string

Tylko dane wyjściowe. Tożsamości adresów e-mail określone w certyfikacie liścia.
enablementState

enum (EnablementState)

Tylko dane wyjściowe. Bieżący stan pary kluczy.
disableTime

string (Timestamp format)

Tylko dane wyjściowe. Jeśli para kluczy ma wartość DISABLED, stan pary kluczy zmienił się z ENABLED na DISABLED. To pole występuje tylko wtedy, gdy para kluczy ma stan DISABLED.

Sygnatura czasowa w RFC3339 UTC „Zulu” z rozdzielczością nanosekundową i maksymalnie 9 cyframi po przecinku. Przykłady: "2014-10-02T15:01:23Z" i "2014-10-02T15:01:23.045123456Z".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Metadane instancji klucza prywatnego tej pary kluczy.

EnablementState

Wyliczenie bieżącego stanu pary kluczy.

Wartości w polu enum
stateUnspecified Obecny stan pary kluczy nie został ustawiony. Para kluczy nie jest włączona ani wyłączona.
enabled

Para kluczy jest włączona. W przypadku e-maili szyfrowanych przez tę parę kluczy Gmail odszyfrowuje je i podpisuje wszystkie wiadomości wychodzące kluczem prywatnym.

Aby włączyć parę kluczy, użyj metody keypairs.enable.
disabled

Para kluczy jest wyłączona. Uwierzytelnieni użytkownicy nie mogą odszyfrowywać e-maili ani podpisywać wiadomości wychodzących. Jeśli para kluczy jest wyłączona przez ponad 30 dni, możesz ją trwale usunąć.

Aby wyłączyć parę kluczy, użyj metody keypairs.disable.

CsePrivateKeyMetadata

Metadane instancji klucza prywatnego.

Zapis 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.
}
Pola
privateKeyMetadataId

string

Tylko dane wyjściowe. Stały identyfikator instancji metadanych klucza prywatnego.
Pole sumy metadata_variant. Pole sumowania: musi występować dokładnie jeden z tych typów wariantów metadanych. metadata_variant może mieć tylko jedną z tych wartości:
kaclsKeyMetadata

object (KaclsKeyMetadata)

Metadane instancji klucza prywatnego zarządzanej przez zewnętrzną usługę kontroli dostępu do kluczy.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Metadane kluczy sprzętowych.

KaclsKeyMetadata

Metadane kluczy prywatnych zarządzanych przez zewnętrzną usługę kontroli dostępu do kluczy. Szczegółowe informacje o zarządzaniu dostępem do klucza znajdziesz w dokumentacji interfejsu Google Workspace CSE API.

Zapis JSON 
{
  "kaclsUri": string,
  "kaclsData": string
}
Pola
kaclsUri

string

Identyfikator URI usługi listy kontroli dostępu do kluczy, która zarządza kluczem prywatnym.
kaclsData

string

Nieprzejrzyste dane generowane i używane przez usługę listy kontroli dostępu do kluczy. Maksymalny rozmiar: 8 KiB.

HardwareKeyMetadata

Metadane kluczy sprzętowych.

Zapis JSON 
{
  "description": string
}
Pola
description

string

Opis klucza sprzętowego.

Metody

create

 Tworzy i przesyła metadane klucza publicznego S/MIME do szyfrowania po stronie klienta oraz metadane kluczy prywatnych dla uwierzytelnionego użytkownika.

disable

 Wyłącza parę kluczy szyfrowania po stronie klienta.

enable

 Włącza parę kluczy szyfrowania po stronie klienta, która została wyłączona.

get

 Pobiera istniejącą parę kluczy szyfrowania po stronie klienta.

list

 Wyświetla listę par kluczy szyfrowania po stronie klienta dla uwierzytelnionego użytkownika.

obliterate

 Trwale i natychmiast usuwa parę kluczy szyfrowania po stronie klienta.