Class: Google::Apis::IdentitytoolkitV1::GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest

Returns a new instance of GoogleCloudIdentitytoolkitV1BatchDeleteAccountsRequest.



128
129
130
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 128

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

Instance Attribute Details

#force ⇒ Boolean Also known as: force?

Whether to force deleting accounts that are not in disabled state. If false, only disabled accounts will be deleted, and accounts that are not disabled will be added to the errors. Corresponds to the JSON property force

Returns:

  • (Boolean) 


113
114
115
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 113

def force
  @force
end

#local_ids ⇒ Array<String>

Required. List of user IDs to be deleted. Corresponds to the JSON property localIds

Returns:

  • (Array<String>) 


119
120
121
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 119

def local_ids
  @local_ids
end

#tenant_id ⇒ String

If the accounts belong to an Identity Platform tenant, the ID of the tenant. If the accounts belong to a default Identity Platform project, the field is not needed. Corresponds to the JSON property tenantId

Returns:

  • (String) 


126
127
128
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 126

def tenant_id
  @tenant_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



133
134
135
136
137
 
# File 'lib/google/apis/identitytoolkit_v1/classes.rb', line 133

def update!(**args)
  @force = args[:force] if args.key?(:force)
  @local_ids = args[:local_ids] if args.key?(:local_ids)
  @tenant_id = args[:tenant_id] if args.key?(:tenant_id)
end