Method: users.settings.cse.keypairs.obliterate

クライアントサイド暗号化鍵ペアを直ちに完全に削除します。完全に削除できるのは、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

消去する鍵ペアの ID。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

詳しくは、認可ガイドをご覧ください。