Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UploadAccountRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1UploadAccountRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1UploadAccountRequest.



3464
3465
3466
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3464

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

Instance Attribute Details

#allow_overwrite ⇒ Boolean Also known as: allow_overwrite?

Whether to overwrite an existing account in Identity Platform with a matching local_id in the request. If true, the existing account will be overwritten. If false, an error will be returned. Corresponds to the JSON property allowOverwrite

Returns:

  • (Boolean) 


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

def allow_overwrite
  @allow_overwrite
end

#argon2_parameters ⇒ Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1Argon2Parameters

The parameters for Argon2 hashing algorithm. Corresponds to the JSON property argon2Parameters

Returns:



3364
3365
3366
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3364

def argon2_parameters
  @argon2_parameters
end

#block_size ⇒ Fixnum

The block size parameter used by the STANDARD_SCRYPT hashing function. This parameter, along with parallelization and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance. Corresponds to the JSON property blockSize

Returns:

  • (Fixnum) 


3372
3373
3374
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3372

def block_size
  @block_size
end

#cpu_mem_cost ⇒ Fixnum

The CPU memory cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance. Corresponds to the JSON property cpuMemCost

Returns:

  • (Fixnum) 


3380
3381
3382
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3380

def cpu_mem_cost
  @cpu_mem_cost
end

#delegated_project_number ⇒ Fixnum

Corresponds to the JSON property delegatedProjectNumber

Returns:

  • (Fixnum) 


3385
3386
3387
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3385

def delegated_project_number
  @delegated_project_number
end

#dk_len ⇒ Fixnum

The desired key length for the STANDARD_SCRYPT hashing function. Must be at least 1. Corresponds to the JSON property dkLen

Returns:

  • (Fixnum) 


3391
3392
3393
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3391

def dk_len
  @dk_len
end

#hash_algorithm ⇒ String

Required. The hashing function used to hash the account passwords. Must be one of the following: * HMAC_SHA256 * HMAC_SHA1 * HMAC_MD5 * SCRYPT * PBKDF_SHA1 * MD5 * HMAC_SHA512 * SHA1 * BCRYPT * PBKDF2_SHA256 * SHA256 * SHA512 * STANDARD_SCRYPT * ARGON2 Corresponds to the JSON property hashAlgorithm

Returns:

  • (String) 


3399
3400
3401
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3399

def hash_algorithm
  @hash_algorithm
end

#memory_cost ⇒ Fixnum

Memory cost for hash calculation. Only required when the hashing function is SCRYPT. Corresponds to the JSON property memoryCost

Returns:

  • (Fixnum) 


3405
3406
3407
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3405

def memory_cost
  @memory_cost
end

#parallelization ⇒ Fixnum

The parallelization cost parameter to be used by the STANDARD_SCRYPT hashing function. This parameter, along with block_size and cpu_mem_cost help tune the resources needed to hash a password, and should be tuned as processor speeds and memory technologies advance. Corresponds to the JSON property parallelization

Returns:

  • (Fixnum) 


3413
3414
3415
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3413

def parallelization
  @parallelization
end

#password_hash_order ⇒ String

Password and salt order when verify password. Corresponds to the JSON property passwordHashOrder

Returns:

  • (String) 


3418
3419
3420
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3418

def password_hash_order
  @password_hash_order
end

#rounds ⇒ Fixnum

The number of rounds used for hash calculation. Only required for the following hashing functions: * MD5 * SHA1 * SHA256 * SHA512 * PBKDF_SHA1 * PBKDF2_SHA256 * SCRYPT Corresponds to the JSON property rounds

Returns:

  • (Fixnum) 


3425
3426
3427
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3425

def rounds
  @rounds
end

#salt_separator ⇒ String

One or more bytes to be inserted between the salt and plain text password. For stronger security, this should be a single non-printable character. Corresponds to the JSON property saltSeparator NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3432
3433
3434
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3432

def salt_separator
  @salt_separator
end

#sanity_check ⇒ Boolean Also known as: sanity_check?

If true, the service will do the following list of checks before an account is uploaded: * Duplicate emails * Duplicate federated IDs * Federated ID provider validation If the duplication exists within the list of accounts to be uploaded, it will prevent the entire list from being uploaded. If the email or federated ID is a duplicate of a user already within the project/tenant, the account will not be uploaded, but the rest of the accounts will be unaffected. If false, these checks will be skipped. Corresponds to the JSON property sanityCheck

Returns:

  • (Boolean) 


3443
3444
3445
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3443

def sanity_check
  @sanity_check
end

#signer_key ⇒ String

The signer key used to hash the password. Required for the following hashing functions: * SCRYPT, * HMAC_MD5, * HMAC_SHA1, * HMAC_SHA256, * HMAC_SHA512 Corresponds to the JSON property signerKey NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


3451
3452
3453
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3451

def signer_key
  @signer_key
end

#tenant_id ⇒ String

The ID of the Identity Platform tenant the account belongs to. Corresponds to the JSON property tenantId

Returns:

  • (String) 


3456
3457
3458
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3456

def tenant_id
  @tenant_id
end

#users ⇒ Array<Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1UserInfo>

A list of accounts to upload. local_id is required for each user; everything else is optional. Corresponds to the JSON property users

Returns:



3462
3463
3464
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3462

def users
  @users
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 3469

def update!(**args)
  @allow_overwrite = args[:allow_overwrite] if args.key?(:allow_overwrite)
  @argon2_parameters = args[:argon2_parameters] if args.key?(:argon2_parameters)
  @block_size = args[:block_size] if args.key?(:block_size)
  @cpu_mem_cost = args[:cpu_mem_cost] if args.key?(:cpu_mem_cost)
  @delegated_project_number = args[:delegated_project_number] if args.key?(:delegated_project_number)
  @dk_len = args[:dk_len] if args.key?(:dk_len)
  @hash_algorithm = args[:hash_algorithm] if args.key?(:hash_algorithm)
  @memory_cost = args[:memory_cost] if args.key?(:memory_cost)
  @parallelization = args[:parallelization] if args.key?(:parallelization)
  @password_hash_order = args[:password_hash_order] if args.key?(:password_hash_order)
  @rounds = args[:rounds] if args.key?(:rounds)
  @salt_separator = args[:salt_separator] if args.key?(:salt_separator)
  @sanity_check = args[:sanity_check] if args.key?(:sanity_check)
  @signer_key = args[:signer_key] if args.key?(:signer_key)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
  @users = args[:users] if args.key?(:users)
end