Class: GroupDocs::User

Inherits:
Api::Entity show all
Includes:
Api::Helpers::AccessRights
Defined in:
lib/groupdocs/user.rb

Constant Summary

Constants included from Api::Helpers::AccessRights

Api::Helpers::AccessRights::ACCESS_RIGHTS

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Api::Helpers::ByteFlag

#array_from_byte, #byte_from_array

Methods inherited from Api::Entity

#initialize, #inspect, #to_hash

Methods included from Api::Helpers::Accessor

#alias_accessor

Constructor Details

This class inherits a constructor from GroupDocs::Api::Entity

Instance Attribute Details

#active ⇒ Object 



369
370
371
 
# File 'lib/groupdocs/user.rb', line 369

def active
  @active
end

#claimed_id ⇒ Object 



361
362
363
 
# File 'lib/groupdocs/user.rb', line 361

def claimed_id
  @claimed_id
end

#color ⇒ Object 



375
376
377
 
# File 'lib/groupdocs/user.rb', line 375

def color
  @color
end

#customEmailMessage ⇒ Object 



377
378
379
 
# File 'lib/groupdocs/user.rb', line 377

def customEmailMessage
  @customEmailMessage
end

#firstname ⇒ Object 



351
352
353
 
# File 'lib/groupdocs/user.rb', line 351

def firstname
  @firstname
end

#guid ⇒ Object 



347
348
349
 
# File 'lib/groupdocs/user.rb', line 347

def guid
  @guid
end

#id ⇒ Object 



345
346
347
 
# File 'lib/groupdocs/user.rb', line 345

def id
  @id
end

#lastname ⇒ Object 



353
354
355
 
# File 'lib/groupdocs/user.rb', line 353

def lastname
  @lastname
end

#news_enabled ⇒ Object 



371
372
373
 
# File 'lib/groupdocs/user.rb', line 371

def news_enabled
  @news_enabled
end

#nickname ⇒ Object 



349
350
351
 
# File 'lib/groupdocs/user.rb', line 349

def nickname
  @nickname
end

#password_salt ⇒ Object 



359
360
361
 
# File 'lib/groupdocs/user.rb', line 359

def password_salt
  @password_salt
end

#photo ⇒ Object 



367
368
369
 
# File 'lib/groupdocs/user.rb', line 367

def photo
  @photo
end

#primary_email ⇒ Object 



355
356
357
 
# File 'lib/groupdocs/user.rb', line 355

def primary_email
  @primary_email
end

#private_key ⇒ Object 



357
358
359
 
# File 'lib/groupdocs/user.rb', line 357

def private_key
  @private_key
end

#signed_up_on ⇒ Time

Converts timestamp which is return by API server to Time object.

Returns:

  • (Time) 


373
374
375
 
# File 'lib/groupdocs/user.rb', line 373

def signed_up_on
  @signed_up_on
end

#storage ⇒ Object 



365
366
367
 
# File 'lib/groupdocs/user.rb', line 365

def storage
  @storage
end

#token ⇒ Object 



363
364
365
 
# File 'lib/groupdocs/user.rb', line 363

def token
  @token
end

Class Method Details

.area!(embed_key, access = {}) ⇒ String

Get area name by embed key.

Examples:

GroupDocs::User.area!('60a06eg8f23a49cf807977f1444fbdd8')
#=> "test-area"

Parameters:

  • embed_key (String)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


150
151
152
153
154
155
156
157
158
 
# File 'lib/groupdocs/user.rb', line 150

def self.area!(embed_key, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/{{client_id}}/embedkey/guid/#{embed_key}"
  end.execute!

  json[:key][:area]
end

.claimed_token!(caller_id, options = {}, access = {}) ⇒ String

Get user profile by claimed token

Parameters:

  • callerId (String)
  • options (Array) (defaults to: {})
  • access (Hash) (defaults to: {}) —

    Access credentials

  • [Hash] (Hash) —

    a customizable set of options

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


536
537
538
539
540
541
542
543
544
545
 
# File 'lib/groupdocs/user.rb', line 536

def self.claimed_token!(caller_id, options ={}, access = {})
  api = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/#{caller_id}/claimed-tokens"
  end
  api.add_params(options)
  api.execute!

end

.create_login!(caller_id, options = {}, access = {}) ⇒ GroupDocs::User

Create new login

Parameters:

  • callerId (String)
  • options (Hash) (defaults to: {})
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (options):

  • :password (String)

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



616
617
618
619
620
621
622
623
624
625
 
# File 'lib/groupdocs/user.rb', line 616

def self.create_login!(caller_id, options = {}, access = {})
  api = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :POST
    request[:path] = "/mgmt/#{caller_id}/user/{{client_id}}/logins"
  end
  api.add_params(options)
  api.execute!

end

.delete!(user, access = {}) ⇒ String

Delete account user.

Examples:

user = GroupDocs::User.get!
GroupDocs::User.delete!(user.users!.last)
#=> "826e3b54e009ce51"

Parameters:

  • user (GroupDocs::User)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String)

Raises:

  • (ArgumentError) —

    if user is not GroupDocs::User object



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/groupdocs/user.rb', line 78

def self.delete!(user, access = {})
  user.is_a?(GroupDocs::User) or raise ArgumentError,
    "User should be GroupDocs::User object, received: #{user.inspect}"

  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :DELETE
    request[:path] = "/mgmt/{{client_id}}/account/users/#{user.primary_email}"
  end.execute!

  json[:guid]
end

.download!(path, name, guid, options = {}) ⇒ Object

Logins user using user name and password.

Parameters:

  • guid (String)
  • options (Hash) (defaults to: {})
  • [String] (Hash) —

    a customizable set of options

  • [Boolean] (Hash) —

    a customizable set of options



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/groupdocs/user.rb', line 268

def self.download!(path, name, guid, options = {})
  api = Api::Request.new do |request|
    request[:sign] = false
    request[:method] = :DOWNLOAD
    request[:path] = "/shared/files/#{guid}"
  end
  api.add_params(options)
  response = api.execute!

  filepath = "#{path}/#{name}"
  Object::File.open(filepath, 'wb') do |file|
    file.write(response)
  end

  filepath
end

.generate_embed_key!(area, access = {}) ⇒ String

Generates new user embed key.

Examples:

GroupDocs::User.generate_embed_key!('test-area')
#=> "60a06ef8f23a49cf807977f1444fbdd8"

Parameters:

  • area (String)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


104
105
106
107
108
109
110
111
112
 
# File 'lib/groupdocs/user.rb', line 104

def self.generate_embed_key!(area, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/{{client_id}}/embedkey/new/#{area}"
  end.execute!

  json[:key][:guid]
end

.get!(access = {}) ⇒ GroupDocs::User

Returns current user profile.

Examples:

user = GroupDocs::User.get!
user.first_name
#=> "John"

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



19
20
21
22
23
24
25
26
27
 
# File 'lib/groupdocs/user.rb', line 19

def self.get!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/mgmt/{{client_id}}/profile'
  end.execute!

  new(json[:user])
end

.get_account!(access = {}) ⇒ Array

Returns an account information

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (Array) 


736
737
738
739
740
741
742
 
# File 'lib/groupdocs/user.rb', line 736

def self.get_account!(access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/{{client_id}}/account"
  end.execute!
end

.get_embed_key!(area, access = {}) ⇒ String

Get user embed key. Generate new embed key if area not exists.

Examples:

GroupDocs::User.get_embed_key!('test-area')
#=> "60a06ef8f23a49cf807977f1444fbdd8"

Parameters:

  • area (String)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


127
128
129
130
131
132
133
134
135
 
# File 'lib/groupdocs/user.rb', line 127

def self.get_embed_key!(area, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/{{client_id}}/embedkey/#{area}"
  end.execute!

  json[:key][:guid]
end

.get_html!(path, name, guid) ⇒ Object

Get file in html.

Parameters:

  • guid (String) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/groupdocs/user.rb', line 310

def self.get_html!(path, name, guid)
  response = Api::Request.new do |request|
    request[:sign] = false
    request[:method] = :DOWNLOAD
    request[:path] = "/shared/files/#{guid}/html"
  end.execute!

  filepath = "#{path}/#{name}"
  Object::File.open(filepath, 'wb') do |file|
    file.write(response)
  end

  filepath
end

.get_profile!(caller_id, access = {}) ⇒ String

Get alien user profile

Parameters:

  • callerId (String)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


556
557
558
559
560
561
562
563
564
 
# File 'lib/groupdocs/user.rb', line 556

def self.get_profile!(caller_id, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/#{caller_id}/user/{{client_id}}/profile"
  end.execute!

  json[:user]
end

.get_xml!(path, name, guid) ⇒ Object

Get file in xml.

Parameters:

  • guid (String) 


290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/groupdocs/user.rb', line 290

def self.get_xml!(path, name, guid)
  response = Api::Request.new do |request|
    request[:sign] = false
    request[:method] = :DOWNLOAD
    request[:path] = "/shared/files/#{guid}/xml"
  end.execute!

  filepath = "#{path}/#{name}"
  Object::File.open(filepath, 'wb') do |file|
    file.write(response)
  end

  filepath
end

.login!(email, password) ⇒ GroupDocs::User

Logins user using user name and password.

Examples:

user = GroupDocs::User.login!('[email protected]', 'password')
user.first_name
#=> "John"

Returns:



249
250
251
252
253
254
255
256
257
258
 
# File 'lib/groupdocs/user.rb', line 249

def self.login!(email, password)
  json = Api::Request.new do |request|
    request[:sign] = false
    request[:method] = :POST
    request[:path] = "/shared/users/#{email}/logins"
    request[:request_body] = password
  end.execute!

  new(json[:user])
end

.providers!(access = {}) ⇒ Array<GroupDocs::Storage::Provider>

Returns an array of storage providers.

Examples:

providers = GroupDocs::User.providers!
providers.first.provider
#=> "Dropbox"

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/groupdocs/user.rb', line 173

def self.providers!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/mgmt/{{client_id}}/storages'
  end.execute!

  json[:providers].map do |provider|
    Storage::Provider.new(provider)
  end
end

.remove_account!(access = {}) ⇒ String

Remove account user.

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


752
753
754
755
756
757
758
 
# File 'lib/groupdocs/user.rb', line 752

def self.remove_account!(access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :DELETE
    request[:path] = "/mgmt/{{client_id}}/account"
  end.execute!
end

.reset_alien_password!(caller_id, access = {}) ⇒ Object

Change alien user password.

Parameters:

  • callerId (String)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


661
662
663
664
665
666
667
668
669
 
# File 'lib/groupdocs/user.rb', line 661

def self.reset_alien_password!(caller_id, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :DELETE
    request[:path] = "/mgmt/#{caller_id}/users/{{client_id}}password"
  end.execute!

  json[:user_name]
end

.reset_token!(caller_id, options = {}, access = {}) ⇒ String

Get user profile by reset token

Parameters:

  • callerId (String)
  • options (Array) (defaults to: {})
  • access (Hash) (defaults to: {}) —

    Access credentials

  • [Hash] (Hash) —

    a customizable set of options

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


472
473
474
475
476
477
478
479
480
481
 
# File 'lib/groupdocs/user.rb', line 472

def self.reset_token!(caller_id, options ={}, access = {})
  api = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/#{caller_id}/reset-tokens"
  end
  api.add_params(options)
  api.execute!

end

.revoke!(access = {}) ⇒ Object

Revoke.

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


231
232
233
234
235
236
237
238
 
# File 'lib/groupdocs/user.rb', line 231

def self.revoke!(access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/mgmt/{{client_id}}/revoke"
  end.execute!

end

.set_user_roles!(caller_id, role_info = {}, access = {}) ⇒ Array

Set user roles.

Parameters:

  • callerId (String)
  • role_info (Hash) (defaults to: {}) —

    (:id, :name)

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (Array) 


718
719
720
721
722
723
724
725
726
 
# File 'lib/groupdocs/user.rb', line 718

def self.set_user_roles!(caller_id, role_info = {}, access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/#{caller_id}/users/{{client_id}}/roles"
    request[:request_body] = role_info
  end.execute!

end

.update_account!(user, access = {}) ⇒ GroupDocs::User

Updates user account if it’s created, otherwise creates new.

Examples:

user = GroupDocs::User.new
user.primary_email = '[email protected]'
user.nickname = 'johnsmith'
user.first_name = 'John'
user.last_name = 'Smith'
# make sure to save user as it has updated attributes
user = GroupDocs::User.update_account!(user)

Parameters:

  • user (GroupDocs::User)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/groupdocs/user.rb', line 47

def self.update_account!(user, access = {})
  user.is_a?(GroupDocs::User) or raise ArgumentError,
    "User should be GroupDocs::User object, received: #{user.inspect}"

  data = user.to_hash
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/mgmt/{{client_id}}/account/users/#{user.nickname}"
    request[:request_body] = data
  end.execute!

  GroupDocs::User.new data.merge(json)
end

.update_alien_password!(caller_id, pas_info = {}, access = {}) ⇒ Object

Change alien user password.

Examples:

user = GroupDocs::User.get!
old_password = user.password_salt
new_password = 'Smith'
user.update_password!

Parameters:

  • callerId (String)
  • pas_info (Array) (defaults to: {}) —

    ([old_password, new_password, reset_token])

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


642
643
644
645
646
647
648
649
650
651
 
# File 'lib/groupdocs/user.rb', line 642

def self.update_alien_password!(caller_id, pas_info = {}, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/mgmt/#{caller_id}/users/{{client_id}}password"
    request[:request_body] = pas_info
  end.execute!

  json[:user_guid]
end

.update_password!(pas_info = {}, access = {}) ⇒ Object

Updates user profile.

Examples:

user = GroupDocs::User.get!
old_password = user.password_salt
new_password = 'Smith'
user.update_password!

Parameters:

  • pas_info (Array) (defaults to: {}) —

    ([old_password, new_password, reset_token])

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


452
453
454
455
456
457
458
459
 
# File 'lib/groupdocs/user.rb', line 452

def self.update_password!(pas_info = {}, access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = '/mgmt/{{client_id}}/profile/password'
    request[:request_body] = pas_info
  end.execute!
end

.user_roles!(caller_id, access = {}) ⇒ Array

Returns an array of roles.

# @param [String] callerId

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (Array) 


698
699
700
701
702
703
704
705
706
 
# File 'lib/groupdocs/user.rb', line 698

def self.user_roles!(caller_id, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/#{caller_id}/users/{{client_id}}/roles"
  end.execute!

  json[:roles]
end

.verif_token!(caller_id, options = {}, access = {}) ⇒ String

Get user profile by reset token

Parameters:

  • callerId (String)
  • options (Array) (defaults to: {})
  • access (Hash) (defaults to: {}) —

    Access credentials

  • [Hash] (Hash) —

    a customizable set of options

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


494
495
496
497
498
499
500
501
502
503
 
# File 'lib/groupdocs/user.rb', line 494

def self.verif_token!(caller_id, options ={}, access = {})
  api = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = "/mgmt/#{caller_id}/verif-tokens"
  end
  api.add_params(options)
  api.execute!

end

Instance Method Details

#access_rights ⇒ Array<Symbol>

Converts access rights to human-readable format flag.

Returns:

  • (Array<Symbol>) 


388
389
390
 
# File 'lib/groupdocs/user.rb', line 388

def access_rights
  convert_byte_to_access_rights @access_rights if @access_rights
end

#access_rights=(rights) ⇒ Object

Converts access rights to machine-readable format flag.

Parameters:

  • rights (Array<Symbol>) 


396
397
398
399
400
401
 
# File 'lib/groupdocs/user.rb', line 396

def access_rights=(rights)
  if rights.is_a?(Array)
    rights = convert_access_rights_to_byte(rights)
  end
  @access_rights = rights
end

#add_provider!(provider, provider_info = {}, access = {}) ⇒ Object

Adds a new storage provider configuration.

Parameters:

  • provider (String) —

    Storage provider name

  • access (Hash) (defaults to: {}) —

    Access credentials

  • provider_info (Array) (defaults to: {})

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


194
195
196
197
198
199
200
201
202
 
# File 'lib/groupdocs/user.rb', line 194

def add_provider!(provider, provider_info = {}, access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :POST
    request[:path] = "/mgmt/{{client_id}}/storages/#{provider}"
    request[:request_body] = provider_info
  end.execute!

end

#create_user!(caller_id, access = {}) ⇒ GroupDocs::User

Create new user

Parameters:

  • callerId (String)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



595
596
597
598
599
600
601
602
603
 
# File 'lib/groupdocs/user.rb', line 595

def create_user!(caller_id, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :POST
    request[:path] = "/mgmt/#{caller_id}/user"
    request[:request_body] = to_hash
  end.execute!

end

#get_packages!(path) ⇒ Object

Get file in html.

Parameters:

  • path (String) 


330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/groupdocs/user.rb', line 330

def get_packages!(path)
  response = Api::Request.new do |request|
    request[:sign] = false
    request[:method] = :GET
    request[:path] = "/shared/packages/#{path}"
  end.execute!

  Object::File.open(path, 'wb') do |file|
    file.write(response)
  end

  path
end

#roles!(access = {}) ⇒ Array

Returns an array of roles.

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (Array) 


679
680
681
682
683
684
685
686
687
 
# File 'lib/groupdocs/user.rb', line 679

def roles!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/mgmt/{{client_id}}/roles'
  end.execute!

  json[:roles]
end

#update!(access = {}) ⇒ Object

Updates user profile.

Examples:

user = GroupDocs::User.get!
user.first_name = 'John'
user.last_name = 'Smith'
user.update!

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


430
431
432
433
434
435
436
437
 
# File 'lib/groupdocs/user.rb', line 430

def update!(access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = '/mgmt/{{client_id}}/profile'
    request[:request_body] = to_hash
  end.execute!
end

#update_profile!(caller_id, access = {}) ⇒ String

Update alien user profile

Parameters:

  • callerId (String)
  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:

  • (String) 


575
576
577
578
579
580
581
582
583
584
 
# File 'lib/groupdocs/user.rb', line 575

def update_profile!(caller_id, access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/mgmt/#{caller_id}/user/{{client_id}}/profile"
    request[:request_body] = to_hash
  end.execute!

  json[:user_guid]
end

#update_provider!(provider, provider_info = {}, access = {}) ⇒ Object

Updates user’s storage provider configuration.

Parameters:

  • provider (String) —

    Storage provider name

  • access (Hash) (defaults to: {}) —

    Access credentials

  • provider_info (Array) (defaults to: {})

Options Hash (access):

  • :client_id (String)
  • :private_key (String) 


213
214
215
216
217
218
219
220
221
 
# File 'lib/groupdocs/user.rb', line 213

def update_provider!(provider, provider_info = {}, access = {})
  Api::Request.new do |request|
    request[:access] = access
    request[:method] = :PUT
    request[:path] = "/mgmt/{{client_id}}/storages/#{provider}"
    request[:request_body] = provider_info
  end.execute!

end

#users!(access = {}) ⇒ Array<GroupDocs::User>

Get user profile by verif token

Parameters:

  • access (Hash) (defaults to: {}) —

    Access credentials

Options Hash (access):

  • :client_id (String)
  • :private_key (String)

Returns:



513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/groupdocs/user.rb', line 513

def users!(access = {})
  json = Api::Request.new do |request|
    request[:access] = access
    request[:method] = :GET
    request[:path] = '/mgmt/{{client_id}}/account/users'
  end.execute!

  json[:users].map do |user|
    GroupDocs::User.new(user)
  end
end