google_api_identity_toolkit v0.5.0 GoogleApi.IdentityToolkit.V3.Model.VerifyAssertionResponse View Source
Response of verifying the IDP assertion.
Attributes
-
providerId
(type:String.t
, default:nil
) - The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. If the "providerId" param is set to OpenID OP identifer other than the whilte listed IdPs the OP identifier is returned. If the "identifier" param is federated ID in the createAuthUri request. The domain part of the federated ID is returned. -
oauthExpireIn
(type:integer()
, default:nil
) - The lifetime in seconds of the OAuth2 access token. -
oauthRequestToken
(type:String.t
, default:nil
) - The user approved request token for the OpenID OAuth extension. -
displayName
(type:String.t
, default:nil
) - The display name of the user. -
needEmail
(type:boolean()
, default:nil
) - Whether need client to supply email to complete the federated login flow. -
localId
(type:String.t
, default:nil
) - The RP local ID if it's already been mapped to the IdP account identified by the federated ID. -
language
(type:String.t
, default:nil
) - The language preference of the user. -
email
(type:String.t
, default:nil
) - The email returned by the IdP. NOTE: The federated login user may not own the email. -
oauthScope
(type:String.t
, default:nil
) - The scope for the OpenID OAuth extension. -
context
(type:String.t
, default:nil
) - The opaque value used by the client to maintain context info between the authentication request and the IDP callback. -
appInstallationUrl
(type:String.t
, default:nil
) - URL for OTA app installation. -
firstName
(type:String.t
, default:nil
) - The first name of the user. -
timeZone
(type:String.t
, default:nil
) - The timezone of the user. -
kind
(type:String.t
, default:identitytoolkit#VerifyAssertionResponse
) - The fixed string "identitytoolkit#VerifyAssertionResponse". -
inputEmail
(type:String.t
, default:nil
) - It's the identifier param in the createAuthUri request if the identifier is an email. It can be used to check whether the user input email is different from the asserted email. -
appScheme
(type:String.t
, default:nil
) - The custom scheme used by mobile app. -
dateOfBirth
(type:String.t
, default:nil
) - The birth date of the IdP account. -
oauthTokenSecret
(type:String.t
, default:nil
) - The OAuth1 access token secret. -
emailRecycled
(type:boolean()
, default:nil
) - It's true if the email is recycled. -
expiresIn
(type:String.t
, default:nil
) - If idToken is STS id token, then this field will be expiration time of STS id token in seconds. -
screenName
(type:String.t
, default:nil
) - The screen_name of a Twitter user or the login name at Github. -
verifiedProvider
(type:list(String.t)
, default:nil
) - When action is 'map', contains the idps which can be used for confirmation. -
needConfirmation
(type:boolean()
, default:nil
) - Whether the assertion is from a non-trusted IDP and need account linking confirmation. -
nickName
(type:String.t
, default:nil
) - The nick name of the user. -
errorMessage
(type:String.t
, default:nil
) - Client error code. -
oauthAuthorizationCode
(type:String.t
, default:nil
) - The OAuth2 authorization code. -
photoUrl
(type:String.t
, default:nil
) - The URI of the public accessible profiel picture. -
oauthIdToken
(type:String.t
, default:nil
) - The OIDC id token. -
emailVerified
(type:boolean()
, default:nil
) - The value is true if the IDP is also the email provider. It means the user owns the email. -
federatedId
(type:String.t
, default:nil
) - The unique ID identifies the IdP account. -
idToken
(type:String.t
, default:nil
) - The ID token. -
refreshToken
(type:String.t
, default:nil
) - If idToken is STS id token, then this field will be refresh token. -
originalEmail
(type:String.t
, default:nil
) - The original email stored in the mapping storage. It's returned when the federated ID is associated to a different email. -
lastName
(type:String.t
, default:nil
) - The last name of the user. -
fullName
(type:String.t
, default:nil
) - The full name of the user. -
oauthAccessToken
(type:String.t
, default:nil
) - The OAuth2 access token. -
action
(type:String.t
, default:nil
) - The action code. -
rawUserInfo
(type:String.t
, default:nil
) - Raw IDP-returned user info. -
isNewUser
(type:boolean()
, default:nil
) - True if it's a new user sign-in, false if it's a returning 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.VerifyAssertionResponse{ action: String.t(), appInstallationUrl: String.t(), appScheme: String.t(), context: String.t(), dateOfBirth: String.t(), displayName: String.t(), email: String.t(), emailRecycled: boolean(), emailVerified: boolean(), errorMessage: String.t(), expiresIn: String.t(), federatedId: String.t(), firstName: String.t(), fullName: String.t(), idToken: String.t(), inputEmail: String.t(), isNewUser: boolean(), kind: String.t(), language: String.t(), lastName: String.t(), localId: String.t(), needConfirmation: boolean(), needEmail: boolean(), nickName: String.t(), oauthAccessToken: String.t(), oauthAuthorizationCode: String.t(), oauthExpireIn: integer(), oauthIdToken: String.t(), oauthRequestToken: String.t(), oauthScope: String.t(), oauthTokenSecret: String.t(), originalEmail: String.t(), photoUrl: String.t(), providerId: String.t(), rawUserInfo: String.t(), refreshToken: String.t(), screenName: String.t(), timeZone: String.t(), verifiedProvider: [String.t()] }
Link to this section Functions
Specs
Unwrap a decoded JSON object into its complex fields.