Get a code for user action confirmation.

Scopes

You will need authorization for the https://www.googleapis.com/auth/cloud-platform scope to make a valid call.

If unset, the scope for this method defaults to https://www.googleapis.com/auth/cloud-platform. You can set the scope for this method like this: identitytoolkit3 --scope <scope> relyingparty get-oob-confirmation-code ...

Required Request Value

The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure. In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.

For example, a structure like this:

Relyingparty:
  android-install-app: boolean
  android-minimum-version: string
  android-package-name: string
  can-handle-code-in-app: boolean
  captcha-resp: string
  challenge: string
  continue-url: string
  email: string
  i-os-app-store-id: string
  i-os-bundle-id: string
  id-token: string
  kind: string
  new-email: string
  request-type: string
  user-ip: string

can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.

  • -r . android-install-app=true
    • whether or not to install the android app on the device where the link is opened
  • android-minimum-version=ea
    • minimum version of the app. if the version on the device is lower than this version then the user is taken to the play store to upgrade the app
  • android-package-name=dolor
    • android package name of the android app to handle the action code
  • can-handle-code-in-app=true
    • whether or not the app can handle the oob code without first going to web
  • captcha-resp=eos
    • The recaptcha response from the user.
  • challenge=labore
    • The recaptcha challenge presented to the user.
  • continue-url=sed
    • The url to continue to the Gitkit app
  • email=duo
    • The email of the user.
  • i-os-app-store-id=sed
    • iOS app store id to download the app if it's not already installed
  • i-os-bundle-id=no
    • the iOS bundle id of iOS app to handle the action code
  • id-token=stet
    • The user's Gitkit login token for email change.
  • kind=kasd
    • The fixed string "identitytoolkit#relyingparty".
  • new-email=et
    • The new email if the code is for email change.
  • request-type=sed
    • The request type.
  • user-ip=et
    • The IP address of the user.

About Cursors

The cursor position is key to comfortably set complex nested structures. The following rules apply:

  • The cursor position is always set relative to the current one, unless the field name starts with the . character. Fields can be nested such as in -r f.s.o .
  • The cursor position is set relative to the top-level structure if it starts with ., e.g. -r .s.s
  • You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify -r struct.sub_struct=bar.
  • You can move the cursor one level up by using ... Each additional . moves it up one additional level. E.g. ... would go three levels up.

Optional Output Flags

The method's return value a JSON encoded structure, which will be written to standard output by default.

  • -o out
    • out specifies the destination to which to write the server's result to. It will be a JSON-encoded structure. The destination may be - to indicate standard output, or a filepath that is to contain the received bytes. If unset, it defaults to standard output.

Optional General Properties

The following properties can configure any call, and are not specific to this method.

  • -p alt=string

    • Data format for the response.

  • -p fields=string

    • Selector specifying which fields to include in a partial response.

  • -p key=string

    • API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

  • -p oauth-token=string

    • OAuth 2.0 token for the current user.

  • -p pretty-print=boolean

    • Returns response with indentations and line breaks.

  • -p quota-user=string

    • An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

  • -p user-ip=string

    • Deprecated. Please use quotaUser instead.