google_api_identity_toolkit v0.5.0 GoogleApi.IdentityToolkit.V3.Model.Relyingparty View Source

Request of getting a code for user confirmation (reset password, change email etc.)

Attributes

  • androidInstallApp (type: boolean(), default: nil) - whether or not to install the android app on the device where the link is opened
  • androidMinimumVersion (type: String.t, default: nil) - 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
  • androidPackageName (type: String.t, default: nil) - android package name of the android app to handle the action code
  • canHandleCodeInApp (type: boolean(), default: nil) - whether or not the app can handle the oob code without first going to web
  • captchaResp (type: String.t, default: nil) - The recaptcha response from the user.
  • challenge (type: String.t, default: nil) - The recaptcha challenge presented to the user.
  • continueUrl (type: String.t, default: nil) - The url to continue to the Gitkit app
  • email (type: String.t, default: nil) - The email of the user.
  • iOSAppStoreId (type: String.t, default: nil) - iOS app store id to download the app if it's not already installed
  • iOSBundleId (type: String.t, default: nil) - the iOS bundle id of iOS app to handle the action code
  • idToken (type: String.t, default: nil) - The user's Gitkit login token for email change.
  • kind (type: String.t, default: identitytoolkit#relyingparty) - The fixed string "identitytoolkit#relyingparty".
  • newEmail (type: String.t, default: nil) - The new email if the code is for email change.
  • requestType (type: String.t, default: nil) - The request type.
  • userIp (type: String.t, default: nil) - The IP address of the user.

Link to this section Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Link to this section Types

Specs

t() :: %GoogleApi.IdentityToolkit.V3.Model.Relyingparty{
  androidInstallApp: boolean(),
  androidMinimumVersion: String.t(),
  androidPackageName: String.t(),
  canHandleCodeInApp: boolean(),
  captchaResp: String.t(),
  challenge: String.t(),
  continueUrl: String.t(),
  email: String.t(),
  iOSAppStoreId: String.t(),
  iOSBundleId: String.t(),
  idToken: String.t(),
  kind: String.t(),
  newEmail: String.t(),
  requestType: String.t(),
  userIp: String.t()
}

Link to this section Functions

Specs

decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.