Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1CreateAuthUriRequest

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

Request message for CreateAuthUri.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1CreateAuthUriRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1CreateAuthUriRequest.



288
289
290
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 288

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

Instance Attribute Details

#app_id ⇒ String

Corresponds to the JSON property appId

Returns:

  • (String) 


197
198
199
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 197

def app_id
  @app_id
end

#auth_flow_type ⇒ String

Used for the Google provider. The type of the authentication flow to be used. If present, this should be CODE_FLOW to specify the authorization code flow. Otherwise, the default ID Token flow will be used. Corresponds to the JSON property authFlowType

Returns:

  • (String) 


204
205
206
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 204

def auth_flow_type
  @auth_flow_type
end

#context ⇒ String

An opaque string used to maintain contextual information between the authentication request and the callback from the IdP. Corresponds to the JSON property context

Returns:

  • (String) 


210
211
212
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 210

def context
  @context
end

#continue_uri ⇒ String

A valid URL for the IdP to redirect the user back to. The URL cannot contain fragments or the reserved state query parameter. Corresponds to the JSON property continueUri

Returns:

  • (String) 


216
217
218
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 216

def continue_uri
  @continue_uri
end

#custom_parameter ⇒ Hash<String,String>

Additional customized query parameters to be added to the authorization URI. The following parameters are reserved and cannot be added: client_id, response_type, scope, redirect_uri, state. For the Microsoft provider, the Azure AD tenant to sign-in to can be specified in the tenant custom parameter. Corresponds to the JSON property customParameter

Returns:

  • (Hash<String,String>) 


225
226
227
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 225

def custom_parameter
  @custom_parameter
end

#hosted_domain ⇒ String

Used for the Google provider. The G Suite hosted domain of the user in order to restrict sign-in to users at that domain. Corresponds to the JSON property hostedDomain

Returns:

  • (String) 


231
232
233
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 231

def hosted_domain
  @hosted_domain
end

#identifier ⇒ String

The email identifier of the user account to fetch associated providers for. At least one of the fields identifier and provider_id must be set. The length of the email address should be less than 256 characters and in the format of name@domain.tld. The email address should also match the RFC 822 addr-spec production. Corresponds to the JSON property identifier

Returns:

  • (String) 


240
241
242
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 240

def identifier
  @identifier
end

#oauth_consumer_key ⇒ String

Corresponds to the JSON property oauthConsumerKey

Returns:

  • (String) 


245
246
247
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 245

def oauth_consumer_key
  @oauth_consumer_key
end

#oauth_scope ⇒ String

Additional space-delimited OAuth 2.0 scopes specifying the scope of the authentication request with the IdP. Used for OAuth 2.0 IdPs. For the Google provider, the authorization code flow will be used if this field is set. Corresponds to the JSON property oauthScope

Returns:

  • (String) 


252
253
254
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 252

def oauth_scope
  @oauth_scope
end

#openid_realm ⇒ String

Corresponds to the JSON property openidRealm

Returns:

  • (String) 


257
258
259
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 257

def openid_realm
  @openid_realm
end

#ota_app ⇒ String

Corresponds to the JSON property otaApp

Returns:

  • (String) 


262
263
264
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 262

def ota_app
  @ota_app
end

#provider_id ⇒ String

The provider ID of the IdP for the user to sign in with. This should be a provider ID enabled for sign-in, which is either from the list of default supported IdPs, or of the format oidc.* or saml.*. Some examples are google.com, facebook.com, oidc.testapp, and saml.testapp. At least one of the fields identifier and provider_id must be set. Corresponds to the JSON property providerId

Returns:

  • (String) 


272
273
274
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 272

def provider_id
  @provider_id
end

#session_id ⇒ String

A session ID that can be verified against in SignInWithIdp to prevent session fixation attacks. If absent, a random string will be generated and returned as the session ID. Corresponds to the JSON property sessionId

Returns:

  • (String) 


279
280
281
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 279

def session_id
  @session_id
end

#tenant_id ⇒ String

The ID of the Identity Platform tenant to create an authorization URI or lookup an email identifier for. If not set, the operation will be performed in the default Identity Platform instance in the project. Corresponds to the JSON property tenantId

Returns:

  • (String) 


286
287
288
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 286

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 293

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