REST Resource: users.settings.cse.keypairs

リソース: CseKeyPair

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

  • 送信するクライアントサイド暗号化メールに署名します。
  • クライアントサイド暗号化が適用されたメールの下書きを保存して再度開く。
  • 送信したメッセージを保存して再度開く。
  • 受信した S/MIME メールまたはアーカイブされた S/MIME メールを復号します。

組織内のユーザーの ID と鍵ペアを管理する管理者の場合、リクエストには、https://www.googleapis.com/auth/gmail.settings.basic スコープでユーザーに成り代わるためのドメイン全体の委任権限を持つサービス アカウントによる承認が必要です。

独自の ID と鍵ペアを管理しているユーザーの場合、リクエストにはハードウェア キー暗号化が有効になっていて、構成されている必要があります。

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 アーマーを使用する必要があります。
pem

string

出力専用。公開鍵とその証明書チェーン（PEM 形式）。
subjectEmailAddresses[]

string

出力専用。リーフ証明書で指定されているメールアドレス ID。
enablementState

enum (EnablementState)

出力専用。鍵ペアの現在の状態。
disableTime

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
privateKeyMetadata[]

object (CsePrivateKeyMetadata)

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

EnablementState

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

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

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

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

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

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

CsePrivateKeyMetadata

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

JSON 表現 
{
  "privateKeyMetadataId": string,

  "kaclsKeyMetadata": {
    object (KaclsKeyMetadata)
  },
  "hardwareKeyMetadata": {
    object (HardwareKeyMetadata)
  }
}
フィールド
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

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

Google Workspace 組織でハードウェア キー暗号化が設定されている場合、ユーザーは必要に応じて秘密鍵をスマートカードに保存し、Windows デバイスに接続されたカードリーダーにスマートカードを挿入して、Gmail でメールの署名と復号を行うことができます。

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

string

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

メソッド

create

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

disable

 クライアントサイド暗号化の鍵ペアをオフにします。

enable

 オフになっているクライアントサイド暗号化鍵ペアをオンにします。

get

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

list

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

obliterate

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