Method: users.settings.cse.keypairs.enable

オフになっているクライアントサイド暗号鍵ペアをオンにします。鍵ペアは、関連付けられているクライアントサイド暗号化 ID に対して再び有効になります。

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

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

HTTP リクエスト

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

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

パスパラメータ

パラメータ
userId

string

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

keyPairId

string

有効にする鍵ペアの識別子。

リクエストの本文

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

レスポンスの本文

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

認可スコープ

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

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

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