Module: Gitlab::Client::Users

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

Overview

Defines methods related to users.

Instance Method Summary collapse

Instance Method Details

#add_email(email, user_id = nil) ⇒ Gitlab::ObjectifiedHash

Creates a new email Will create a new email an authorized user if no user ID passed.

Examples:

Gitlab.add_email('[email protected]')
Gitlab.add_email('[email protected]', 2)

Parameters:

  • email (String)

    Email address

  • user_id (Integer) (defaults to: nil)

    The ID of a user.

Returns:


231
232
233
234
# File 'lib/gitlab/client/users.rb', line 231

def add_email(email, user_id = nil)
  url = user_id.to_i.zero? ? '/user/emails' : "/users/#{user_id}/emails"
  post(url, body: { email: email })
end

#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


100
101
102
# File 'lib/gitlab/client/users.rb', line 100

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

#create_ssh_key(title, key, options = {}) ⇒ 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.

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

    A customizable set of options.

Options Hash (options):

  • :user_id (Integer)

    id of the user to associate the key with

Returns:


169
170
171
172
173
174
175
176
# File 'lib/gitlab/client/users.rb', line 169

def create_ssh_key(title, key, options = {})
  user_id = options.delete :user_id
  if user_id.to_i.zero?
    post('/user/keys', body: { title: title, key: key })
  else
    post("/users/#{user_id}/keys", body: { title: title, key: key })
  end
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:


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

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

#delete_email(id, user_id = nil) ⇒ Boolean

Delete email Will delete a email an authorized user if no user ID passed.

Examples:

Gitlab.delete_email(2)
Gitlab.delete_email(3, 2)

Parameters:

  • id (Integer)

    Email address ID

  • user_id (Integer) (defaults to: nil)

    The ID of a user.

Returns:

  • (Boolean)

246
247
248
249
# File 'lib/gitlab/client/users.rb', line 246

def delete_email(id, user_id = nil)
  url = user_id.to_i.zero? ? "/user/emails/#{id}" : "/users/#{user_id}/emails/#{id}"
  delete(url)
end

#delete_ssh_key(id, options = {}) ⇒ Gitlab::ObjectifiedHash

Deletes an SSH key.

Examples:

Gitlab.delete_ssh_key(1)

Parameters:

  • id (Integer)

    The ID of a user's SSH key.

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

    A customizable set of options.

Options Hash (options):

  • :user_id (Integer)

    id of the user to associate the key with

Returns:


187
188
189
190
191
192
193
194
# File 'lib/gitlab/client/users.rb', line 187

def delete_ssh_key(id, options = {})
  user_id = options.delete :user_id
  if user_id.to_i.zero?
    delete("/user/keys/#{id}")
  else
    delete("/users/#{user_id}/keys/#{id}")
  end
end

#delete_user(user_id) ⇒ Gitlab::ObjectifiedHash

Deletes a user.

Examples:

Gitlab.delete_user(1)

Parameters:

  • id (Integer)

    The ID of a user.

Returns:


89
90
91
# File 'lib/gitlab/client/users.rb', line 89

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:


78
79
80
# File 'lib/gitlab/client/users.rb', line 78

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

#email(id) ⇒ Gitlab::ObjectifiedHash

Get a single email.

Examples:

Gitlab.email(3)

Parameters:

  • id (Integer)

    The ID of a email.

Returns:


217
218
219
# File 'lib/gitlab/client/users.rb', line 217

def email(id)
  get("/user/emails/#{id}")
end

#emails(user_id = nil) ⇒ Gitlab::ObjectifiedHash

Gets user emails. Will return emails an authorized user if no user ID passed.

Examples:

Gitlab.emails
Gitlab.emails(2)

Parameters:

  • user_id (Integer) (defaults to: nil)

    The ID of a user.

Returns:


205
206
207
208
# File 'lib/gitlab/client/users.rb', line 205

def emails(user_id = nil)
  url = user_id.to_i.zero? ? '/user/emails' : "/users/#{user_id}/emails"
  get(url)
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:


124
125
126
# File 'lib/gitlab/client/users.rb', line 124

def session(email, password)
  post('/session', body: { email: email, password: password }, unauthenticated: true)
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:


155
156
157
# File 'lib/gitlab/client/users.rb', line 155

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
Gitlab.ssh_keys({ user_id: 2 })

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.

  • :user_id (Integer)

    The ID of the user to retrieve the keys for.

Returns:


139
140
141
142
143
144
145
146
# File 'lib/gitlab/client/users.rb', line 139

def ssh_keys(options = {})
  user_id = options.delete :user_id
  if user_id.to_i.zero?
    get('/user/keys', query: options)
  else
    get("/users/#{user_id}/keys", query: options)
  end
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


111
112
113
# File 'lib/gitlab/client/users.rb', line 111

def unblock_user(user_id)
  post("/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:


30
31
32
# File 'lib/gitlab/client/users.rb', line 30

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

#user_search(search, options = {}) ⇒ Array<Gitlab::ObjectifiedHash>

Search for groups by name

Examples:

Gitlab.user_search('gitlab')

Parameters:

  • search (String)

    A string to search for in user names and paths.

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

    A customizable set of options.

Options Hash (options):

  • :per_page (String)

    Number of user to return per page

  • :page (String)

    The page to retrieve

Returns:


261
262
263
264
# File 'lib/gitlab/client/users.rb', line 261

def user_search(search, options = {})
  options[:search] = search
  get('/users', query: options)
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:


17
18
19
# File 'lib/gitlab/client/users.rb', line 17

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