Method: accounts.sendOobCode

アカウントのアウトオブバンド確認コードを送信します。認証済みリクエストからのリクエストでは、OOB コードを送信する代わりに、OOB コードを含むリンクを返すことができます。

HTTP リクエスト

POST https://identitytoolkit.googleapis.com/v1/accounts:sendOobCode

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

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "requestType": enum (OobReqType),
  "email": string,
  "challenge": string,
  "captchaResp": string,
  "userIp": string,
  "newEmail": string,
  "idToken": string,
  "continueUrl": string,
  "iOSBundleId": string,
  "iOSAppStoreId": string,
  "androidPackageName": string,
  "androidInstallApp": boolean,
  "androidMinimumVersion": string,
  "canHandleCodeInApp": boolean,
  "tenantId": string,
  "targetProjectId": string,
  "dynamicLinkDomain": string,
  "returnOobLink": boolean,
  "clientType": enum (ClientType),
  "recaptchaVersion": enum (RecaptchaVersion),
  "linkDomain": string
}
フィールド
requestType

enum (OobReqType)

必須。送信するアウトオブバンド（OOB）コードのタイプ。この値に応じて、このリクエストの他のフィールドが必須になるか、意味が異なる場合があります。送信できる OOB コードは 4 種類あります。* PASSWORD_RESET * EMAIL_SIGNIN * VERIFY_EMAIL * VERIFY_AND_CHANGE_EMAIL
email

string

OOB コードを送信するアカウントのメールアドレス。通常は、更新が必要なアカウントのメールアドレスです。PASSWORD_RESET、EMAIL_SIGNIN、VERIFY_EMAIL に必要です。returnOobLink が true に設定されている場合の VERIFY_AND_CHANGE_EMAIL リクエストでのみ必要です。この場合は、ユーザーの元のメールアドレスです。
challenge
(deprecated)

string
captchaResp

string

PASSWORD_RESET リクエストの場合、不正使用の可能性があるアクティビティがシステムで検出されると、reCaptcha レスポンスが必要になります。この場合、これは呼び出し元の確認に使用される reCaptcha チャレンジからのレスポンスです。
userIp

string

呼び出し元の IP アドレス。PASSWORD_RESET リクエストでのみ必要です。
newEmail

string

アカウントの更新先のメールアドレス。VERIFY_AND_CHANGE_EMAIL リクエストでのみ必須です。
idToken

string

アカウントの ID トークン。returnOobLink が true に設定されていない限り、VERIFY_AND_CHANGE_EMAIL リクエストと VERIFY_EMAIL リクエストで必須です。
continueUrl

string

ユーザーがメールで送信されたリンクをクリックした後に続行する URL。ウェブ ウィジェットが OOB コードを処理できるようにする URL です。
iOSBundleId

string

関連付けられた iOS アプリが OOB コードを処理できる場合は、このアプリの iOS バンドル ID。これにより、正しいアプリがすでにインストールされている場合は、そのアプリが開きます。
iOSAppStoreId

string

関連付けられた iOS アプリが OOB コードを処理できる場合は、そのアプリの App Store ID。これにより、アプリがまだインストールされていない場合に、App Store で正しいアプリを開くことができます。
androidPackageName

string

関連付けられた Android アプリが OOB コードを処理できる場合は、この OOB コードが使用されたときにコールバックを処理する Android アプリの Android パッケージ名。これにより、正しいアプリがすでにインストールされている場合はそのアプリが開き、まだインストールされていない場合は Google Play ストアが開いて正しいアプリが表示されます。
androidInstallApp

boolean

関連付けられた Android アプリが OOB コードを処理できるかどうか、リンクが開かれたデバイスに Android アプリがまだインストールされていない場合に Android アプリをインストールするかどうか。
androidMinimumVersion

string

関連付けられている Android アプリが OOB コードを処理できる場合は、アプリの最小バージョン。デバイスのバージョンがこのバージョンより低い場合、ユーザーは Google Play ストアにリダイレクトされ、アプリのアップグレードを促されます。
canHandleCodeInApp

boolean

true に設定すると、OOB コード リンクはユニバーサル リンクまたは Android アプリリンクとして送信され、対応するアプリがインストールされている場合はそのアプリで開かれます。未設定または false に設定されている場合、OOB コードは最初にウェブ ウィジェットに送信され、続いてアプリがインストールされている場合はそのアプリにリダイレクトされます。
tenantId

string

アカウントが属する Identity Platform テナントのテナント ID。
targetProjectId

string

アカウントが属する Identity Platform プロジェクトのプロジェクト ID。このフィールドを指定するには、適切な権限を持つ Google OAuth 2.0 認証情報が必要です。

認可には、指定されたリソース targetProjectId に対する次の IAM の権限が必要です。

  • firebaseauth.users.sendEmail
clientType

enum (ClientType)

クライアントの種類: ウェブ、Android、iOS。reCAPTCHA Enterprise 保護が有効になっている場合に必要です。
recaptchaVersion

enum (RecaptchaVersion)

captchaResponse 内の reCAPTCHA トークンの reCAPTCHA バージョン。

レスポンスの本文

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

認可スコープ

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

  • https://www.googleapis.com/auth/identitytoolkit
  • https://www.googleapis.com/auth/cloud-platform

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