Class: Google::Apis::IdentitytoolkitV3::CreateAuthUriRequest

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

Overview

Request to get the IDP authentication URL.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CreateAuthUriRequest

Returns a new instance of CreateAuthUriRequest.



434
435
436
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 434

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

Instance Attribute Details

#app_id ⇒ String

The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS. Corresponds to the JSON property appId

Returns:

  • (String) 


347
348
349
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 347

def app_id
  @app_id
end

#auth_flow_type ⇒ String

Explicitly specify the auth flow type. Currently only support "CODE_FLOW" type. The field is only used for Google provider. Corresponds to the JSON property authFlowType

Returns:

  • (String) 


353
354
355
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 353

def auth_flow_type
  @auth_flow_type
end

#client_id ⇒ String

The relying party OAuth client ID. Corresponds to the JSON property clientId

Returns:

  • (String) 


358
359
360
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 358

def client_id
  @client_id
end

#context ⇒ String

The opaque value used by the client to maintain context info between the authentication request and the IDP callback. Corresponds to the JSON property context

Returns:

  • (String) 


364
365
366
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 364

def context
  @context
end

#continue_uri ⇒ String

The URI to which the IDP redirects the user after the federated login flow. Corresponds to the JSON property continueUri

Returns:

  • (String) 


369
370
371
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 369

def continue_uri
  @continue_uri
end

#custom_parameter ⇒ Hash<String,String>

The query parameter that client can customize by themselves in auth url. The following parameters are reserved for server so that they cannot be customized by clients: client_id, response_type, scope, redirect_uri, state, oauth_token. Corresponds to the JSON property customParameter

Returns:

  • (Hash<String,String>) 


376
377
378
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 376

def custom_parameter
  @custom_parameter
end

#hosted_domain ⇒ String

The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts. Corresponds to the JSON property hostedDomain

Returns:

  • (String) 


382
383
384
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 382

def hosted_domain
  @hosted_domain
end

#identifier ⇒ String

The email or federated ID of the user. Corresponds to the JSON property identifier

Returns:

  • (String) 


387
388
389
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 387

def identifier
  @identifier
end

#oauth_consumer_key ⇒ String

The developer's consumer key for OpenId OAuth Extension Corresponds to the JSON property oauthConsumerKey

Returns:

  • (String) 


392
393
394
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 392

def oauth_consumer_key
  @oauth_consumer_key
end

#oauth_scope ⇒ String

Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant Corresponds to the JSON property oauthScope

Returns:

  • (String) 


398
399
400
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 398

def oauth_scope
  @oauth_scope
end

#openid_realm ⇒ String

Optional realm for OpenID protocol. The sub string "scheme://domain:port" of the param "continueUri" is used if this is not set. Corresponds to the JSON property openidRealm

Returns:

  • (String) 


404
405
406
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 404

def openid_realm
  @openid_realm
end

#ota_app ⇒ String

The native app package for OTA installation. Corresponds to the JSON property otaApp

Returns:

  • (String) 


409
410
411
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 409

def ota_app
  @ota_app
end

#provider_id ⇒ String

The IdP ID. For white listed IdPs it's a short domain name e.g. google.com, aol.com, live.net and yahoo.com. For other OpenID IdPs it's the OP identifier. Corresponds to the JSON property providerId

Returns:

  • (String) 


415
416
417
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 415

def provider_id
  @provider_id
end

#session_id ⇒ String

The session_id passed by client. Corresponds to the JSON property sessionId

Returns:

  • (String) 


420
421
422
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 420

def session_id
  @session_id
end

#tenant_id ⇒ String

For multi-tenant use cases, in order to construct sign-in URL with the correct IDP parameters, Firebear needs to know which Tenant to retrieve IDP configs from. Corresponds to the JSON property tenantId

Returns:

  • (String) 


427
428
429
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 427

def tenant_id
  @tenant_id
end

#tenant_project_number ⇒ Fixnum

Tenant project number to be used for idp discovery. Corresponds to the JSON property tenantProjectNumber

Returns:

  • (Fixnum) 


432
433
434
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 432

def tenant_project_number
  @tenant_project_number
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
 
# File 'lib/google/apis/identitytoolkit_v3/classes.rb', line 439

def update!(**args)
  @app_id = args[:app_id] if args.key?(:app_id)
  @auth_flow_type = args[:auth_flow_type] if args.key?(:auth_flow_type)
  @client_id = args[:client_id] if args.key?(:client_id)
  @context = args[:context] if args.key?(:context)
  @continue_uri = args[:continue_uri] if args.key?(:continue_uri)
  @custom_parameter = args[:custom_parameter] if args.key?(:custom_parameter)
  @hosted_domain = args[:hosted_domain] if args.key?(:hosted_domain)
  @identifier = args[:identifier] if args.key?(:identifier)
  @oauth_consumer_key = args[:oauth_consumer_key] if args.key?(:oauth_consumer_key)
  @oauth_scope = args[:oauth_scope] if args.key?(:oauth_scope)
  @openid_realm = args[:openid_realm] if args.key?(:openid_realm)
  @ota_app = args[:ota_app] if args.key?(:ota_app)
  @provider_id = args[:provider_id] if args.key?(:provider_id)
  @session_id = args[:session_id] if args.key?(:session_id)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @tenant_project_number = args[:tenant_project_number] if args.key?(:tenant_project_number)
end