Class: BrickFTP::RESTfulAPI::DeleteUser

Inherits:
Object
  • Object
show all
Includes:
Command
Defined in:
lib/brick_ftp/restful_api/delete_user.rb

Overview

Delete a user

See Also:

Instance Method Summary collapse

Methods included from Command

included, #initialize

Instance Method Details

#call(id) ⇒ Object

Deletes the specified user.

For additional security, this method requires reauthentication when updating a password unless an API key is used.

Parameters:

  • id (Integer)

    Globally unique identifier of each user. Each user is given an ID automatically upon creation.



19
20
21
22
# File 'lib/brick_ftp/restful_api/delete_user.rb', line 19

def call(id)
  client.delete("/api/rest/v1/users/#{id}.json")
  true
end