REST Resource: users.settings.cse.keypairs

Zasób: CseKeyPair

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

  • podpisywać wychodzące wiadomości zaszyfrowane po stronie klienta.
  • zapisywać i ponownie otwierać wersje robocze 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 prośby wymagają autoryzacji konta usługi, które ma uprawnienia do delegowania uprawnień 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ą klucza sprzętowego.

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 na potrzeby 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 zabezpieczenia 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 poziomu 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, oznacza to, że stan pary kluczy zmienił się z ENABLED na DISABLED. To pole jest widoczne tylko wtedy, gdy para kluczy jest w stanie DISABLED.

Używa standardu RFC 3339, w którym wygenerowany wynik jest zawsze znormalizowany według normy Z i zawiera 0, 3, 6 lub 9 cyfr ułamkowych. Dopuszczalne 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 tego klucza pary.

EnablementState

Wyliczenie bieżącego stanu pary kluczy.

Wartości w polu enum
stateUnspecified Nie ustawiono bieżącego stanu pary kluczy. Para kluczy nie jest włączona ani wyłączona.
enabled

para kluczy jest włączona; W przypadku wszystkich wiadomości e-mail zaszyfrowanych za pomocą tej pary kluczy Gmail odszyfrowuje wiadomości i podpisuje wszystkie wychodzące e-maile za pomocą klucza prywatnego.

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

Para kluczy jest wyłączona. Użytkownicy uwierzytelnieni nie mogą odszyfrować wiadomości e-mail ani podpisać wychodzących wiadomości. 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. Niezmienny identyfikator instancji metadanych klucza prywatnego.
Pole unii metadata_variant. Pole z union: musi być obecny dokładnie jeden z tych typów wariantów metadanych. metadata_variant może być tylko jednym z tych elementów:
kaclsKeyMetadata

object (KaclsKeyMetadata)

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

object (HardwareKeyMetadata)

Metadane kluczy 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 artykule Referencje dotyczące 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 kluczy sprzętowych.

Jeśli w organizacji Google Workspace skonfigurowano szyfrowanie klucza sprzętowego, użytkownicy mogą opcjonalnie przechowywać klucz prywatny na karcie inteligentnej i używać go do podpisywania i odszyfrowywania wiadomości e-mail 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 S/MIME kluczy publicznych i metadane kluczy prywatnych na potrzeby szyfrowania po stronie klienta dla uwierzytelnionego użytkownika.

disable

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

enable

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

get

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

list

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

obliterate

 natychmiast usuwa parę kluczy szyfrowania po stronie klienta.