REST Resource: users.settings.cse.keypairs

リソース: CseKeyPair

クライアントサイド暗号化の S/MIME 鍵ペア。公開鍵、証明書チェーン、ペアの秘密鍵のメタデータで構成されます。Gmail は鍵ペアを使用して次のタスクを行います。

  • クライアントサイド暗号化が適用された送信メールに署名する。
  • クライアントサイド暗号化が適用されたメールの下書きを保存して再度開く。
  • 送信済みメールを保存して再度開く。
  • 受信またはアーカイブされた S/MIME メールを復号します。
JSON 表現
{
  "keyPairId": string,
  "pkcs7": string,
  "pem": string,
  "subjectEmailAddresses": [
    string
  ],
  "enablementState": enum (EnablementState),
  "disableTime": string,
  "privateKeyMetadata": [
    {
      object (CsePrivateKeyMetadata)
    }
  ]
}
フィールド
keyPairId

string

出力のみ。クライアントサイド暗号化の S/MIME 鍵ペアの不変の ID。

pkcs7

string

入力のみ。公開鍵とその証明書チェーン。チェーンは PKCS#7 形式で、PEM エンコードと ASCII Armor を使用する必要があります。

pem

string

出力のみ。PEM 形式の公開鍵とその証明書チェーン。

subjectEmailAddresses[]

string

出力のみ。リーフ証明書に指定されているメールアドレスの ID。

enablementState

enum (EnablementState)

出力のみ。鍵ペアの現在の状態。

disableTime

string (Timestamp format)

出力のみ。鍵ペアが DISABLED に設定されている場合、鍵ペアの状態が ENABLED から DISABLED に変わった時刻。このフィールドは、鍵ペアの状態が DISABLED の場合にのみ存在します。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

privateKeyMetadata[]

object (CsePrivateKeyMetadata)

この鍵ペアの秘密鍵のインスタンスのメタデータ。

EnablementState

鍵ペアの現在の状態の列挙。

列挙型
stateUnspecified 鍵ペアの現在の状態は設定されていません。鍵ペアがオンでもオフでもない。
enabled

鍵ペアがオンになっています。この鍵ペアで暗号化したすべてのメールは、Gmail によって復号され、秘密鍵ですべての送信メールに署名されます。

鍵ペアを有効にするには、keypairs.enable メソッドを使用します。

disabled

鍵ペアが無効になっています。認証されたユーザーは、メールを復号したり、送信メールに署名したりすることはできません。鍵ペアが 30 日以上無効になっている場合は、完全に削除できます。

鍵ペアをオフにするには、keypairs.disable メソッドを使用します。

CsePrivateKeyMetadata

秘密鍵インスタンスのメタデータ。

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.
}
フィールド
privateKeyMetadataId

string

出力のみ。秘密鍵メタデータ インスタンスの不変の ID。

共用体フィールド metadata_variant。共用体フィールド: 次のメタデータ バリアント タイプのいずれか 1 つのみが存在している必要があります。metadata_variant は次のいずれかになります。
kaclsKeyMetadata

object (KaclsKeyMetadata)

外部鍵アクセス制御リストサービスによって管理される秘密鍵インスタンスのメタデータ。

hardwareKeyMetadata

object (HardwareKeyMetadata)

ハードウェア キーのメタデータ。

KaclsKeyMetadata

外部鍵アクセス制御リストサービスによって管理される秘密鍵のメタデータ。鍵アクセスの管理について詳しくは、Google Workspace CSE API リファレンスをご覧ください。

JSON 表現
{
  "kaclsUri": string,
  "kaclsData": string
}
フィールド
kaclsUri

string

秘密鍵を管理する鍵アクセス制御リストサービスの URI。

kaclsData

string

鍵アクセス制御リストサービスによって生成され、使用される不透明データ。最大サイズ: 8 KiB。

HardwareKeyMetadata

ハードウェア キーのメタデータ。

JSON 表現
{
  "description": string
}
フィールド
description

string

ハードウェア キーの説明。

Methods

create

認証されたユーザーの S/MIME 公開鍵証明書チェーンと秘密鍵メタデータを作成して、クライアントサイド暗号化にアップロードします。

disable

クライアントサイドの暗号鍵ペアを無効にします。

enable

無効にされたクライアントサイドの暗号鍵ペアを有効にします。

get

既存のクライアントサイド暗号鍵ペアを取得します。

list

認証されたユーザーのクライアントサイド暗号鍵ペアを一覧表示します。

obliterate

クライアントサイドの暗号鍵ペアを完全かつ直ちに削除します。