Method: users.settings.cse.keypairs.disable

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

アクセスを回復するには、keypairs.enable を使用して鍵ペアを有効にしてください。

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

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

詳細については、承認ガイドをご覧ください。