Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateAuthUriResponse

Inherits:
Object
  • Object
show all
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

Response message for CreateAuthUri.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1CreateAuthUriResponse

Returns a new instance of GoogleCloudIdentitytoolkitV1CreateAuthUriResponse.



373
374
375
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 373

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#all_providers ⇒ Array<String>

Corresponds to the JSON property allProviders

Returns:

  • (Array<String>) 


318
319
320
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 318

def all_providers
  @all_providers
end

#auth_uri ⇒ String

The authorization URI for the requested provider. Present only when a provider ID is set in the request. Corresponds to the JSON property authUri

Returns:

  • (String) 


324
325
326
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 324

def auth_uri
  @auth_uri
end

#captcha_required ⇒ Boolean Also known as: captcha_required?

Whether a CAPTCHA is needed because there have been too many failed login attempts by the user. Present only when a registered email identifier is set in the request. Corresponds to the JSON property captchaRequired

Returns:

  • (Boolean) 


331
332
333
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 331

def captcha_required
  @captcha_required
end

#for_existing_provider ⇒ Boolean Also known as: for_existing_provider?

Whether the user has previously signed in with the provider ID in the request. Present only when a registered email identifier is set in the request. Corresponds to the JSON property forExistingProvider

Returns:

  • (Boolean) 


338
339
340
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 338

def for_existing_provider
  @for_existing_provider
end

#kind ⇒ String

Corresponds to the JSON property kind

Returns:

  • (String) 


344
345
346
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 344

def kind
  @kind
end

#provider_id ⇒ String

The provider ID from the request, if provided. Corresponds to the JSON property providerId

Returns:

  • (String) 


349
350
351
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 349

def provider_id
  @provider_id
end

#registered ⇒ Boolean Also known as: registered?

Whether the email identifier represents an existing account. Present only when an email identifier is set in the request. Corresponds to the JSON property registered

Returns:

  • (Boolean) 


355
356
357
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 355

def registered
  @registered
end

#session_id ⇒ String

The session ID from the request, or a random string generated by CreateAuthUri if absent. It is used to prevent session fixation attacks. Corresponds to the JSON property sessionId

Returns:

  • (String) 


362
363
364
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 362

def session_id
  @session_id
end

#signin_methods ⇒ Array<String>

The list of sign-in methods that the user has previously used. Each element is one of password, emailLink, or the provider ID of an IdP. Present only when a registered email identifier is set in the request. If email enumeration protection is enabled, this method returns an empty list. Corresponds to the JSON property signinMethods

Returns:

  • (Array<String>) 


371
372
373
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 371

def 
  @signin_methods
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 378

def update!(**args)
  @all_providers = args[:all_providers] if args.key?(:all_providers)
  @auth_uri = args[:auth_uri] if args.key?(:auth_uri)
  @captcha_required = args[:captcha_required] if args.key?(:captcha_required)
  @for_existing_provider = args[:for_existing_provider] if args.key?(:for_existing_provider)
  @kind = args[:kind] if args.key?(:kind)
  @provider_id = args[:provider_id] if args.key?(:provider_id)
  @registered = args[:registered] if args.key?(:registered)
  @session_id = args[:session_id] if args.key?(:session_id)
  @signin_methods = args[:signin_methods] if args.key?(:signin_methods)
end