REST Resource: users.settings.cse.keypairs

Zasób: CseKeyPair

Para kluczy S/MIME do szyfrowania po stronie klienta, która składa się z klucza publicznego, łańcucha certyfikatów i metadanych powiązanego klucza prywatnego. Gmail używa pary kluczy do wykonywania tych zadań:

  • podpisywać wychodzące wiadomości zaszyfrowane po stronie klienta;
  • Zapisywanie i ponowne otwieranie wersji roboczych wiadomości zaszyfrowanych po stronie klienta.
  • zapisywać i ponownie otwierać wysłane wiadomości;
  • odszyfrowywać przychodzące lub zarchiwizowane wiadomości S/MIME;

W przypadku administratorów zarządzających tożsamościami i parami kluczy użytkowników w organizacji żądania wymagają autoryzacji za pomocą konta usługi, które ma uprawnienia do delegowania w całej domenie, aby podszywać się pod użytkowników w zakresie https://www.googleapis.com/auth/gmail.settings.basic.

W przypadku użytkowników zarządzających własnymi tożsamościami i parami kluczy żądania wymagają włączenia i skonfigurowania szyfrowania za pomocą kluczy sprzętowych.

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. Niezmienny identyfikator pary kluczy S/MIME do szyfrowania po stronie klienta.
pkcs7

string

Tylko dane wejściowe. klucz publiczny i jego łańcuch certyfikatów; Łańcuch musi być w formacie PKCS#7 i używać kodowania PEM oraz ASCII armor.
pem

string

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

string

Tylko dane wyjściowe. Adresy e-mail podane 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 stan DISABLED, jest to czas, w którym stan pary kluczy zmienił się z ENABLED na DISABLED. To pole jest obecne tylko wtedy, gdy para kluczy jest w stanie DISABLED.

Korzysta ze standardu RFC 3339, w którym wygenerowane dane wyjściowe są zawsze znormalizowane do formatu Z i zawierają 0, 3, 6 lub 9 cyfr po przecinku. Akceptowane są też przesunięcia inne niż „Z”. Przykłady: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" lub "2014-10-02T15:01:23+05:30".
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

Metadane instancji klucza prywatnego tej pary kluczy.

EnablementState

Wyliczenie bieżącego stanu pary kluczy.

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

Para kluczy jest włączona. W przypadku wszystkich e-maili zaszyfrowanych za pomocą tej pary kluczy Gmail odszyfrowuje wiadomości i podpisuje wszystkie wychodzące e-maile 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,

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

string

Tylko dane wyjściowe. Niezmienny identyfikator instancji metadanych klucza prywatnego.
Pole zbiorcze metadata_variant. Pole typu union: musi być obecny 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ę listy kontroli dostępu do kluczy.
hardwareKeyMetadata

object (HardwareKeyMetadata)

Metadane klawiszy sprzętowych.

KaclsKeyMetadata

Metadane kluczy prywatnych zarządzanych przez zewnętrzną usługę listy kontroli dostępu do kluczy. Szczegółowe informacje o zarządzaniu dostępem do kluczy 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

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

HardwareKeyMetadata

Metadane klawiszy sprzętowych.

Jeśli w organizacji Google Workspace skonfigurowane jest szyfrowanie za pomocą klucza sprzętowego, użytkownicy mogą opcjonalnie przechowywać klucz prywatny na karcie inteligentnej i używać go do podpisywania i odszyfrowywania e-maili w Gmailu, wkładając kartę inteligentną do czytnika podłączonego do urządzenia z systemem Windows.

Zapis JSON 
{
  "description": string
}
Pola
description

string

Opis klucza sprzętowego.

Metody

create

 Tworzy i przesyła łańcuch certyfikatów kluczy publicznych S/MIME szyfrowania po stronie klienta oraz metadane kluczy prywatnych uwierzytelnionego użytkownika.

disable

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

enable

 Włącza wyłączoną parę kluczy szyfrowania po stronie klienta.

get

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

list

 Wyświetla pary kluczy szyfrowania po stronie klienta dla uwierzytelnionego użytkownika.

obliterate

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