リソース: CseKeyPair
クライアントサイド暗号化の S/MIME 鍵ペア。公開鍵、証明書チェーン、ペアの秘密鍵のメタデータで構成されます。Gmail は鍵ペアを使用して次のタスクを行います。
- クライアントサイド暗号化が適用された送信メールに署名する。
- クライアントサイド暗号化が適用されたメールの下書きを保存して再度開く。
- 送信済みメールを保存して再度開く。
- 受信またはアーカイブされた S/MIME メールを復号します。
JSON 表現 |
---|
{ "keyPairId": string, "pkcs7": string, "pem": string, "subjectEmailAddresses": [ string ], "enablementState": enum ( |
フィールド | |
---|---|
keyPairId |
出力のみ。クライアントサイド暗号化の S/MIME 鍵ペアの不変の ID。 |
pkcs7 |
入力のみ。公開鍵とその証明書チェーン。チェーンは PKCS#7 形式で、PEM エンコードと ASCII Armor を使用する必要があります。 |
pem |
出力のみ。PEM 形式の公開鍵とその証明書チェーン。 |
subjectEmailAddresses[] |
出力のみ。リーフ証明書に指定されているメールアドレスの ID。 |
enablementState |
出力のみ。鍵ペアの現在の状態。 |
disableTime |
出力のみ。鍵ペアが RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
privateKeyMetadata[] |
この鍵ペアの秘密鍵のインスタンスのメタデータ。 |
EnablementState
鍵ペアの現在の状態の列挙。
列挙型 | |
---|---|
stateUnspecified |
鍵ペアの現在の状態は設定されていません。鍵ペアがオンでもオフでもない。 |
enabled |
鍵ペアがオンになっています。この鍵ペアで暗号化したすべてのメールは、Gmail によって復号され、秘密鍵ですべての送信メールに署名されます。 鍵ペアを有効にするには、 |
disabled |
鍵ペアが無効になっています。認証されたユーザーは、メールを復号したり、送信メールに署名したりすることはできません。鍵ペアが 30 日以上無効になっている場合は、完全に削除できます。 鍵ペアをオフにするには、 |
CsePrivateKeyMetadata
秘密鍵インスタンスのメタデータ。
JSON 表現 |
---|
{ "privateKeyMetadataId": string, // Union field |
フィールド | |
---|---|
privateKeyMetadataId |
出力のみ。秘密鍵メタデータ インスタンスの不変の ID。 |
共用体フィールド metadata_variant 。共用体フィールド: 次のメタデータ バリアント タイプのいずれか 1 つのみが存在している必要があります。metadata_variant は次のいずれかになります。 |
|
kaclsKeyMetadata |
外部鍵アクセス制御リストサービスによって管理される秘密鍵インスタンスのメタデータ。 |
hardwareKeyMetadata |
ハードウェア キーのメタデータ。 |
KaclsKeyMetadata
外部鍵アクセス制御リストサービスによって管理される秘密鍵のメタデータ。鍵アクセスの管理について詳しくは、Google Workspace CSE API リファレンスをご覧ください。
JSON 表現 |
---|
{ "kaclsUri": string, "kaclsData": string } |
フィールド | |
---|---|
kaclsUri |
秘密鍵を管理する鍵アクセス制御リストサービスの URI。 |
kaclsData |
鍵アクセス制御リストサービスによって生成され、使用される不透明データ。最大サイズ: 8 KiB。 |
HardwareKeyMetadata
ハードウェア キーのメタデータ。
JSON 表現 |
---|
{ "description": string } |
フィールド | |
---|---|
description |
ハードウェア キーの説明。 |
Methods |
|
---|---|
|
認証されたユーザーの S/MIME 公開鍵証明書チェーンと秘密鍵メタデータを作成して、クライアントサイド暗号化にアップロードします。 |
|
クライアントサイドの暗号鍵ペアを無効にします。 |
|
無効にされたクライアントサイドの暗号鍵ペアを有効にします。 |
|
既存のクライアントサイド暗号鍵ペアを取得します。 |
|
認証されたユーザーのクライアントサイド暗号鍵ペアを一覧表示します。 |
|
クライアントサイドの暗号鍵ペアを完全かつ直ちに削除します。 |