Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest
- Inherits:
-
Object
- Object
- Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- lib/google/apis/identitytoolkit_v1/classes.rb,
lib/google/apis/identitytoolkit_v1/representations.rb,
lib/google/apis/identitytoolkit_v1/representations.rb
Overview
Request message for SignInWithEmailLink
Instance Attribute Summary collapse
-
#email ⇒ String
Required.
-
#id_token ⇒ String
A valid ID token for an Identity Platform account.
-
#oob_code ⇒ String
Required.
-
#tenant_id ⇒ String
The ID of the Identity Platform tenant the user is signing in to.
Instance Method Summary collapse
-
#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest
constructor
A new instance of GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest
Returns a new instance of GoogleCloudIdentitytoolkitV1SignInWithEmailLinkRequest.
2277 2278 2279 |
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2277 def initialize(**args) update!(**args) end |
Instance Attribute Details
#email ⇒ String
Required. The email address the sign-in link was sent to. The length of email
should be less than 256 characters and in the format of name@domain.tld
. The
email should also match the RFC 822 addr-
spec production.
Corresponds to the JSON property email
2257 2258 2259 |
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2257 def email @email end |
#id_token ⇒ String
A valid ID token for an Identity Platform account. If passed, this request
will link the email address to the user represented by this ID token and
enable sign-in with email link on the account for the future.
Corresponds to the JSON property idToken
2264 2265 2266 |
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2264 def id_token @id_token end |
#oob_code ⇒ String
Required. The out-of-band code from the email link.
Corresponds to the JSON property oobCode
2269 2270 2271 |
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2269 def oob_code @oob_code end |
#tenant_id ⇒ String
The ID of the Identity Platform tenant the user is signing in to. If not set,
the user will sign in to the default Identity Platform project.
Corresponds to the JSON property tenantId
2275 2276 2277 |
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2275 def tenant_id @tenant_id end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
2282 2283 2284 2285 2286 2287 |
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 2282 def update!(**args) @email = args[:email] if args.key?(:email) @id_token = args[:id_token] if args.key?(:id_token) @oob_code = args[:oob_code] if args.key?(:oob_code) @tenant_id = args[:tenant_id] if args.key?(:tenant_id) end |