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.



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

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

Instance Attribute Details

#captcha_challenge ⇒ String

Corresponds to the JSON property captchaChallenge

Returns:

  • (String) 


3187
3188
3189
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3187

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) 


3194
3195
3196
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3194

def captcha_response
  @captcha_response
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) 


3202
3203
3204
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3202

def disabled
  @disabled
end

#display_name ⇒ String

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

Returns:

  • (String) 


3208
3209
3210
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3208

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) 


3216
3217
3218
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3216

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) 


3223
3224
3225
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3223

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) 


3232
3233
3234
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3232

def id_token
  @id_token
end

#instance_id ⇒ String

Corresponds to the JSON property instanceId

Returns:

  • (String) 


3237
3238
3239
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3237

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) 


3245
3246
3247
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3245

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:



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

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) 


3256
3257
3258
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3256

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) 


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

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) 


3268
3269
3270
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3268

def photo_url
  @photo_url
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) 


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

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) 


3283
3284
3285
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3283

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3290

def update!(**args)
  @captcha_challenge = args[:captcha_challenge] if args.key?(:captcha_challenge)
  @captcha_response = args[:captcha_response] if args.key?(:captcha_response)
  @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)
  @target_project_id = args[:target_project_id] if args.key?(:target_project_id)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end