class Google::Apis::IdentitytoolkitV3::CreateAuthUriRequest

Request to get the IDP authentication URL.

Attributes

app_id[RW]

The app ID of the mobile app, base64(CERT_SHA1):PACKAGE_NAME for Android, BUNDLE_ID for iOS. Corresponds to the JSON property `appId` @return [String]

auth_flow_type[RW]

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` @return [String]

client_id[RW]

The relying party OAuth client ID. Corresponds to the JSON property `clientId` @return [String]

context[RW]

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` @return [String]

continue_uri[RW]

The URI to which the IDP redirects the user after the federated login flow. Corresponds to the JSON property `continueUri` @return [String]

custom_parameter[RW]

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` @return [Hash<String,String>]

hosted_domain[RW]

The hosted domain to restrict sign-in to accounts at that domain for Google Apps hosted accounts. Corresponds to the JSON property `hostedDomain` @return [String]

identifier[RW]

The email or federated ID of the user. Corresponds to the JSON property `identifier` @return [String]

oauth_consumer_key[RW]

The developer's consumer key for OpenId OAuth Extension Corresponds to the JSON property `oauthConsumerKey` @return [String]

oauth_scope[RW]

Additional oauth scopes, beyond the basid user profile, that the user would be prompted to grant Corresponds to the JSON property `oauthScope` @return [String]

openid_realm[RW]

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` @return [String]

ota_app[RW]

The native app package for OTA installation. Corresponds to the JSON property `otaApp` @return [String]

provider_id[RW]

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` @return [String]

session_id[RW]

The session_id passed by client. Corresponds to the JSON property `sessionId` @return [String]

tenant_id[RW]

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` @return [String]

tenant_project_number[RW]

Tenant project number to be used for idp discovery. Corresponds to the JSON property `tenantProjectNumber` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/identitytoolkit_v3/classes.rb, line 434
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# 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