Module: Gitlab::Client::Users

Included in:
Gitlab::Client
Defined in:
lib/gitlab/client/users.rb

Overview

Defines methods related to users.

See Also:

Instance Method Summary collapse

Instance Method Details

#block_user(user_id) ⇒ Boolean

Blocks the specified user. Available only for admin.

Examples:

Gitlab.block_user(15)

Parameters:

  • user_id (Integer) —

    The Id of user

Returns:

  • (Boolean) —

    success or not



98
99
100
 
# File 'lib/gitlab/client/users.rb', line 98

def block_user(user_id)
  put("/users/#{user_id}/block")
end

#create_ssh_key(title, key) ⇒ Gitlab::ObjectifiedHash

Creates a new SSH key.

Examples:

Gitlab.create_ssh_key('key title', 'key body')

Parameters:

  • title (String) —

    The title of an SSH key.

  • key (String) —

    The SSH key body.

Returns:



158
159
160
 
# File 'lib/gitlab/client/users.rb', line 158

def create_ssh_key(title, key)
  post("/user/keys", :body => {:title => title, :key => key})
end

#create_user(*args) ⇒ Gitlab::ObjectifiedHash

Creates a new user. Requires authentication from an admin account.

Examples:

Gitlab.create_user('[email protected]', 'secret', 'joe', :name => 'Joe Smith')
or
Gitlab.create_user('[email protected]', 'secret')

Parameters:

  • email (String) —

    The email of a user.

  • password (String) —

    The password of a user.

  • username (String) —

    The username of a user.

  • options (Hash) —

    A customizable set of options.

Returns:



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/gitlab/client/users.rb', line 50

def create_user(*args)
  options = Hash === args.last ? args.pop : {}
  if args[2]
    body = { email: args[0], password: args[1], username: args[2] }
  else
    body = { email: args[0], password: args[1], name: args[0] }
  end
  body.merge!(options)
  post('/users', body: body)
end

#delete_ssh_key(id) ⇒ Gitlab::ObjectifiedHash

Deletes an SSH key.

Examples:

Gitlab.delete_ssh_key(1)

Parameters:

  • id (Integer) —

    The ID of a user’s SSH key.

Returns:



169
170
171
 
# File 'lib/gitlab/client/users.rb', line 169

def delete_ssh_key(id)
  delete("/user/keys/#{id}")
end

#delete_user(user_id) ⇒ Gitlab::ObjectifiedHash

Deletes a user.

Examples:

Gitlab.delete_user(1)

Parameters:

  • id (Integer) —

    The ID of a user.

Returns:



87
88
89
 
# File 'lib/gitlab/client/users.rb', line 87

def delete_user(user_id)
  delete("/users/#{user_id}")
end

#edit_user(user_id, options = {}) ⇒ Gitlab::ObjectifiedHash

Updates a user.

Examples:

Gitlab.edit_user(15, :email => '[email protected]', :projects_limit => 20)

Parameters:

  • id (Integer) —

    The ID of a user.

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

    A customizable set of options.

Options Hash (options):

  • :email (String) —

    The email of a user.

  • :password (String) —

    The password of a user.

  • :name (String) —

    The name of a user. Defaults to email.

  • :skype (String) —

    The skype of a user.

  • :linkedin (String) —

    The linkedin of a user.

  • :twitter (String) —

    The twitter of a user.

  • :projects_limit (Integer) —

    The limit of projects for a user.

Returns:



76
77
78
 
# File 'lib/gitlab/client/users.rb', line 76

def edit_user(user_id, options={})
  put("/users/#{user_id}", :body => options)
end

#session(email, password) ⇒ Gitlab::ObjectifiedHash

Note:

This method doesn’t require private_token to be set.

Creates a new user session.

Examples:

Gitlab.session('[email protected]', 'secret12345')

Parameters:

  • email (String) —

    The email of a user.

  • password (String) —

    The password of a user.

Returns:



122
123
124
 
# File 'lib/gitlab/client/users.rb', line 122

def session(email, password)
  post("/session", :body => {:email => email, :password => password})
end

#ssh_key(id) ⇒ Gitlab::ObjectifiedHash

Gets information about SSH key.

Examples:

Gitlab.ssh_key(1)

Parameters:

  • id (Integer) —

    The ID of a user’s SSH key.

Returns:



146
147
148
 
# File 'lib/gitlab/client/users.rb', line 146

def ssh_key(id)
  get("/user/keys/#{id}")
end

#ssh_keys(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of user’s SSH keys.

Examples:

Gitlab.ssh_keys

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



135
136
137
 
# File 'lib/gitlab/client/users.rb', line 135

def ssh_keys(options={})
  get("/user/keys", :query => options)
end

#unblock_user(user_id) ⇒ Boolean

Unblocks the specified user. Available only for admin.

Examples:

Gitlab.unblock_user(15)

Parameters:

  • user_id (Integer) —

    The Id of user

Returns:

  • (Boolean) —

    success or not



109
110
111
 
# File 'lib/gitlab/client/users.rb', line 109

def unblock_user(user_id)
  put("/users/#{user_id}/unblock")
end

#user(id = nil) ⇒ Gitlab::ObjectifiedHash

Gets information about a user. Will return information about an authorized user if no ID passed.

Examples:

Gitlab.user
Gitlab.user(2)

Parameters:

  • id (Integer) (defaults to: nil) —

    The ID of a user.

Returns:



28
29
30
 
# File 'lib/gitlab/client/users.rb', line 28

def user(id=nil)
  id.to_i.zero? ? get("/user") : get("/users/#{id}")
end

#users(options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Gets a list of users.

Examples:

Gitlab.users

Parameters:

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

    A customizable set of options.

Options Hash (options):

  • :page (Integer) —

    The page number.

  • :per_page (Integer) —

    The number of results per page.

Returns:



15
16
17
 
# File 'lib/gitlab/client/users.rb', line 15

def users(options={})
  get("/users", :query => options)
end