Class: BrickFTP::RESTfulAPI::SearchUser

Inherits:

Object

• Object
• BrickFTP::RESTfulAPI::SearchUser

Includes:

Command

Defined in:

lib/brick_ftp/restful_api/search_user.rb

Overview

Search users

See Also:

• Search users

Instance Method Summary

• #call(username) ⇒ BrickFTP::Types::User^?

  Returns a single user.

Methods included from Command

included, #initialize

Instance Method Details

#call(username) ⇒ BrickFTP::Types::User^?

Returns a single user.

Parameters:

• username (String) —

  Username for the user. This is how the user will be displayed on the site. Maximum of 50 characters.

Returns:

• (BrickFTP::Types::User, nil) —

  found User or nil

# File 'lib/brick_ftp/restful_api/search_user.rb', line 21

def call(username)
  res = client.get("/api/rest/v1/users.json?q[username]=#{ERB::Util.url_encode(username)}")
  return nil if !res || res.empty?

  BrickFTP::Types::User.new(**res.first.symbolize_keys)
end