Method: users.settings.cse.keypairs.disable

クライアントサイド暗号化の鍵ペアを無効にします。認証されたユーザーは、鍵ペアを使用して受信した CSE メッセージのテキストを復号したり、送信する CSE メールに署名したりできなくなります。

アクセス権を再取得するには、keypairs.enable を使用して鍵ペアをオンにします。

30 日が経過すると、keypairs.obliterate メソッドを使用して鍵ペアを完全に削除できます。

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
userId

string

リクエスト送信者のメインのメールアドレス。認証済みユーザーを示すには、特別な値 me を使用できます。
keyPairId

string

オフにする鍵ペアの ID。

リクエストの本文

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

レスポンスの本文

成功した場合、レスポンスの本文には CseKeyPair のインスタンスが含まれます。

認可スコープ

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

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

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