Method: users.settings.cse.keypairs.obliterate

• HTTP リクエスト
• パスパラメータ
• リクエストの本文
• レスポンスの本文
• 認可スコープ
• 試してみる

クライアントサイドの暗号鍵ペアを完全に即座に削除します。完全に削除できるのは、30 日以上オフになっている鍵ペアのみです。鍵ペアをオフにするには、keypairs.disable メソッドを使用します。

削除された鍵で暗号化されたメールは、Gmail で復元または復号できません。認証済みのユーザーと Google Workspace 管理者は、暗号化されたメッセージを読めなくなります。

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

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

HTTP リクエスト

POST https://gmail.googleapis.com/gmail/v1/users/{userId}/settings/cse/keypairs/{keyPairId}:obliterate

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
userId	string リクエスト元のメインのメールアドレス。認証済みユーザーを示すには、特別な値 me を使用します。
keyPairId	string 消去する鍵ペアの識別子。

リクエストの本文

リクエストの本文は空にする必要があります。

レスポンスの本文

成功した場合、レスポンスの本文は空の JSON オブジェクトになります。

認可スコープ

次の OAuth スコープのいずれかが必要です。

• https://www.googleapis.com/auth/gmail.settings.basic
• https://www.googleapis.com/auth/gmail.settings.sharing

詳細については、OAuth 2.0 Overview をご覧ください。