Module: Octokit::EnterpriseAdminClient::Users
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Defined in: | lib/octokit/enterprise_admin_client/users.rb |
Overview
Methods for the Enterprise User Administration API
Instance Method Summary
-
#create_impersonation_token(login, options = {})
Creates an impersonation OAuth token.
-
#create_user(login, email, options = {})
Create a new user.
-
#delete_impersonation_token(login, options = {})
Deletes an impersonation OAuth token.
-
#delete_key(id, options = {})
Deletes a public SSH keys.
-
#delete_user(username, options = {})
Deletes a user.
-
#demote(user, options = {}) ⇒ Boolean
Demote a site administrator to an ordinary user.
-
#list_all_keys(options = {})
Lists all the public SSH keys.
-
#promote(user, options = {}) ⇒ Boolean
Promote an ordinary user to a site administrator.
-
#rename_user(old_login, new_login, options = {})
Rename a user.
-
#suspend(user, options = {}) ⇒ Boolean
Suspend a user.
-
#unsuspend(user, options = {}) ⇒ Boolean
Unsuspend a user.
Instance Method Details
#create_impersonation_token(login, options = {})
Creates an impersonation OAuth token.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 95
def create_impersonation_token(login, = {}) post "admin/users/#{login}/authorizations", end
#create_user(login, email, options = {})
Create a new user.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 16
def create_user(login, email, = {}) [:login] = login [:email] = email post 'admin/users', end
#delete_impersonation_token(login, options = {})
Deletes an impersonation OAuth token.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 105
def delete_impersonation_token(login, = {}) boolean_from_response :delete, "admin/users/#{login}/authorizations", end
#delete_key(id, options = {})
Deletes a public SSH keys.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 124
def delete_key(id, = {}) boolean_from_response :delete, "admin/keys/#{id}", end
#delete_user(username, options = {})
Deletes a user.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 62
def delete_user(username, = {}) boolean_from_response :delete, "admin/users/#{username}", end
#demote(user, options = {}) ⇒ Boolean
Demote a site administrator to an ordinary user
# File 'lib/octokit/enterprise_admin_client/users.rb', line 40
def demote(user, = {}) boolean_from_response :delete, "users/#{user}/site_admin", end
#list_all_keys(options = {})
Lists all the public SSH keys.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 114
def list_all_keys( = {}) get 'admin/keys', end
#promote(user, options = {}) ⇒ Boolean
Promote an ordinary user to a site administrator
# File 'lib/octokit/enterprise_admin_client/users.rb', line 29
def promote(user, = {}) boolean_from_response :put, "users/#{user}/site_admin", end
#rename_user(old_login, new_login, options = {})
Rename a user.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 51
def rename_user(old_login, new_login, = {}) [:login] = new_login patch "admin/users/#{old_login}", end
#suspend(user, options = {}) ⇒ Boolean
Suspend a user.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 73
def suspend(user, = {}) boolean_from_response :put, "users/#{user}/suspended", end
#unsuspend(user, options = {}) ⇒ Boolean
Unsuspend a user.
# File 'lib/octokit/enterprise_admin_client/users.rb', line 84
def unsuspend(user, = {}) boolean_from_response :delete, "users/#{user}/suspended", end