Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1SignUpRequest

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 SignUp.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1SignUpRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1SignUpRequest.



3360
3361
3362
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3360

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

Instance Attribute Details

#captcha_challenge ⇒ String

Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 


3251
3252
3253
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3251

def captcha_challenge
  @captcha_challenge
end

#captcha_response ⇒ String

The reCAPTCHA token provided by the reCAPTCHA client-side integration. reCAPTCHA Enterprise uses it for assessment. Required when reCAPTCHA enterprise is enabled. Corresponds to the JSON property captchaResponse

Returns:

  • (String) 


3258
3259
3260
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3258

def captcha_response
  @captcha_response
end

#client_type ⇒ String

The client type: web, Android or iOS. Required when enabling reCAPTCHA enterprise protection. Corresponds to the JSON property clientType

Returns:

  • (String) 


3264
3265
3266
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3264

def client_type
  @client_type
end

#disabled ⇒ Boolean Also known as: disabled?

Whether the user will be disabled upon creation. Disabled accounts are inaccessible except for requests bearing a Google OAuth2 credential with proper permissions. Corresponds to the JSON property disabled

Returns:

  • (Boolean) 


3272
3273
3274
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3272

def disabled
  @disabled
end

#display_name ⇒ String

The display name of the user to be created. Corresponds to the JSON property displayName

Returns:

  • (String) 


3278
3279
3280
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3278

def display_name
  @display_name
end

#email ⇒ String

The email to assign to the created user. The length of the email should be less than 256 characters and in the format of name@domain.tld. The email should also match the RFC 822 addr-spec production. An anonymous user will be created if not provided. Corresponds to the JSON property email

Returns:

  • (String) 


3286
3287
3288
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3286

def email
  @email
end

#email_verified ⇒ Boolean Also known as: email_verified?

Whether the user's email is verified. Specifying this field requires a Google OAuth 2.0 credential with the proper permissions. Corresponds to the JSON property emailVerified

Returns:

  • (Boolean) 


3293
3294
3295
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3293

def email_verified
  @email_verified
end

#id_token ⇒ String

A valid ID token for an Identity Platform user. If set, this request will link the authentication credential to the user represented by this ID token. For a non-admin request, both the email and password fields must be set. For an admin request, local_id must not be set. Corresponds to the JSON property idToken

Returns:

  • (String) 


3302
3303
3304
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3302

def id_token
  @id_token
end

#instance_id ⇒ String

Corresponds to the JSON property instanceId

Returns:

  • (String) 


3307
3308
3309
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3307

def instance_id
  @instance_id
end

#local_id ⇒ String

The ID of the user to create. The ID must be unique within the project that the user is being created under. Specifying this field requires a Google OAuth 2.0 credential with the proper permissions. Corresponds to the JSON property localId

Returns:

  • (String) 


3315
3316
3317
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3315

def local_id
  @local_id
end

#mfa_info ⇒ Array<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1MfaFactor>

The multi-factor authentication providers for the user to create. Corresponds to the JSON property mfaInfo

Returns:



3320
3321
3322
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3320

def mfa_info
  @mfa_info
end

#password ⇒ String

The password to assign to the created user. The password must be be at least 6 characters long. If set, the email field must also be set. Corresponds to the JSON property password

Returns:

  • (String) 


3326
3327
3328
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3326

def password
  @password
end

#phone_number ⇒ String

The phone number of the user to create. Specifying this field requires a Google OAuth 2.0 credential with the proper permissions. Corresponds to the JSON property phoneNumber

Returns:

  • (String) 


3333
3334
3335
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3333

def phone_number
  @phone_number
end

#photo_url ⇒ String

The profile photo url of the user to create. Corresponds to the JSON property photoUrl

Returns:

  • (String) 


3338
3339
3340
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3338

def photo_url
  @photo_url
end

#recaptcha_version ⇒ String

The reCAPTCHA version of the reCAPTCHA token in the captcha_response. Corresponds to the JSON property recaptchaVersion

Returns:

  • (String) 


3343
3344
3345
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3343

def recaptcha_version
  @recaptcha_version
end

#target_project_id ⇒ String

The project ID of the project which the user should belong to. Specifying this field requires a Google OAuth 2.0 credential with the proper permissions. If this is not set, the target project is inferred from the scope associated to the Bearer access token. Corresponds to the JSON property targetProjectId

Returns:

  • (String) 


3352
3353
3354
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3352

def target_project_id
  @target_project_id
end

#tenant_id ⇒ String

The ID of the Identity Platform tenant to create a user under. If not set, the user will be created under the default Identity Platform project. Corresponds to the JSON property tenantId

Returns:

  • (String) 


3358
3359
3360
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3358

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3365

def update!(**args)
  @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge)
  @captcha_response = args[:captcha_response] if args.key?(:captcha_response)
  @client_type = args[:client_type] if args.key?(:client_type)
  @disabled = args[:disabled] if args.key?(:disabled)
  @display_name = args[:display_name] if args.key?(:display_name)
  @email = args[:email] if args.key?(:email)
  @email_verified = args[:email_verified] if args.key?(:email_verified)
  @id_token = args[:id_token] if args.key?(:id_token)
  @instance_id = args[:instance_id] if args.key?(:instance_id)
  @local_id = args[:local_id] if args.key?(:local_id)
  @mfa_info = args[:mfa_info] if args.key?(:mfa_info)
  @password = args[:password] if args.key?(:password)
  @phone_number = args[:phone_number] if args.key?(:phone_number)
  @photo_url = args[:photo_url] if args.key?(:photo_url)
  @recaptcha_version = args[:recaptcha_version] if args.key?(:recaptcha_version)
  @target_project_id = args[:target_project_id] if args.key?(:target_project_id)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end