Class: Google::Apis::IdentitytoolkitV3::CreateAuthUriResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/identitytoolkit_v3/classes.rb,
generated/google/apis/identitytoolkit_v3/representations.rb,
generated/google/apis/identitytoolkit_v3/representations.rb

Overview

Response of creating the IDP authentication URL.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CreateAuthUriResponse

Returns a new instance of CreateAuthUriResponse



72
73
74
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 72

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

Instance Attribute Details

#all_providers ⇒ Array<String>

all providers the user has once used to do federated login Corresponds to the JSON property allProviders

Returns:

  • (Array<String>) 


32
33
34
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 32

def all_providers
  @all_providers
end

#auth_uri ⇒ String

The URI used by the IDP to authenticate the user. Corresponds to the JSON property authUri

Returns:

  • (String) 


37
38
39
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 37

def auth_uri
  @auth_uri
end

#captcha_required ⇒ Boolean Also known as: captcha_required?

True if captcha is required. Corresponds to the JSON property captchaRequired

Returns:

  • (Boolean) 


42
43
44
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 42

def captcha_required
  @captcha_required
end

#for_existing_provider ⇒ Boolean Also known as: for_existing_provider?

True if the authUri is for user's existing provider. Corresponds to the JSON property forExistingProvider

Returns:

  • (Boolean) 


48
49
50
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 48

def for_existing_provider
  @for_existing_provider
end

#kind ⇒ String

The fixed string identitytoolkit#CreateAuthUriResponse". Corresponds to the JSON property kind

Returns:

  • (String) 


54
55
56
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 54

def kind
  @kind
end

#provider_id ⇒ String

The provider ID of the auth URI. Corresponds to the JSON property providerId

Returns:

  • (String) 


59
60
61
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 59

def provider_id
  @provider_id
end

#registered ⇒ Boolean Also known as: registered?

Whether the user is registered if the identifier is an email. Corresponds to the JSON property registered

Returns:

  • (Boolean) 


64
65
66
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 64

def registered
  @registered
end

#session_id ⇒ String

Session ID which should be passed in the following verifyAssertion request. Corresponds to the JSON property sessionId

Returns:

  • (String) 


70
71
72
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 70

def session_id
  @session_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



77
78
79
80
81
82
83
84
85
86
 
# File 'generated/google/apis/identitytoolkit_v3/classes.rb', line 77

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)
end