Relyingparty: getOobConfirmationCode

Get a code for user action confirmation.

Request

HTTP request

POST https://www.googleapis.com/identitytoolkit/v3/relyingparty/getOobConfirmationCode

Request body

In the request body, supply data with the following structure:

{
  "kind": "identitytoolkit#relyingparty",
  "requestType": string,
  "email": string,
  "challenge": string,
  "captchaResp": string,
  "userIp": string,
  "newEmail": string,
  "idToken": string
}
Property name Value Description Notes
kind string The fixed string "identitytoolkit#relyingparty".
requestType string The request type.

Acceptable values are:
  • "NEW_EMAIL_ACCEPT"
  • "OLD_EMAIL_AGREE"
  • "PASSWORD_RESET"
  • "VERIFY_EMAIL"
email string The email of the user.
challenge string The recaptcha challenge presented to the user.
captchaResp string The recaptcha response from the user.
userIp string The IP address of the user.
newEmail string The new email if the code is for email change.
idToken string The user's Gitkit login token for email change.

Response

If successful, this method returns a response body with the following structure:

{
  "kind": "identitytoolkit#GetOobConfirmationCodeResponse",
  "oobCode": string
}
Property name Value Description Notes
kind string The fixed string "identitytoolkit#GetOobConfirmationCodeResponse".
oobCode string The code to be send to the user.