module Octokit::EnterpriseAdminClient::Users
Methods for the Enterprise User
Administration API
@see developer.github.com/enterprise/v3/enterprise-admin/users/
Public Instance Methods
Creates an impersonation OAuth token.
@param login [String] The user to create a token for. @param options [Array<String>] :scopes The scopes to apply. @see developer.github.com/enterprise/v3/enterprise-admin/users/#create-an-impersonation-oauth-token @example
@admin_client.create_impersonation_token('foobar', {:scopes => ['repo:write']})
# File lib/octokit/enterprise_admin_client/users.rb, line 94 def create_impersonation_token(login, options = {}) post "admin/users/#{login}/authorizations", options end
Create a new user.
@param login [String] The user's username. @param email [String] The user's email address. @see developer.github.com/enterprise/v3/enterprise-admin/users#create-a-new-user @example
@admin_client.create_user('foobar', 'notreal@foo.bar')
# File lib/octokit/enterprise_admin_client/users.rb, line 15 def create_user(login, email, options = {}) options[:login] = login options[:email] = email post "admin/users", options end
Deletes an impersonation OAuth token.
@param login [String] The user whose token should be deleted. @see developer.github.com/enterprise/v3/enterprise-admin/users/#delete-an-impersonation-oauth-token @example
@admin_client.delete_impersonation_token('foobar')
# File lib/octokit/enterprise_admin_client/users.rb, line 104 def delete_impersonation_token(login, options = {}) boolean_from_response :delete, "admin/users/#{login}/authorizations", options end
Deletes a public SSH keys.
@param id [Number] The ID of the key to delete. @see developer.github.com/enterprise/v3/enterprise-admin/users/#delete-a-public-key @example
@admin_client.delete_key(1)
# File lib/octokit/enterprise_admin_client/users.rb, line 123 def delete_key(id, options = {}) boolean_from_response :delete, "admin/keys/#{id}", options end
Deletes a user.
@param username [String] The username to delete. @see developer.github.com/enterprise/v3/enterprise-admin/users/#delete-a-user @example
@admin_client.delete_key(1)
# File lib/octokit/enterprise_admin_client/users.rb, line 61 def delete_user(username, options = {}) boolean_from_response :delete, "admin/users/#{username}", options end
Demote a site administrator to an ordinary user
@param user [String] Username of the user to demote. @return [Boolean] True if demote was successful, false otherwise. @see developer.github.com/enterprise/v3/enterprise-admin/users/#demote-a-site-administrator-to-an-ordinary-user @example
@admin_client.demote('holman')
# File lib/octokit/enterprise_admin_client/users.rb, line 39 def demote(user, options = {}) boolean_from_response :delete, "users/#{user}/site_admin", options end
Lists all the public SSH keys.
@see developer.github.com/enterprise/v3/enterprise-admin/users/#list-all-public-keys @example
@admin_client.list_all_keys
# File lib/octokit/enterprise_admin_client/users.rb, line 113 def list_all_keys(options = {}) get "admin/keys", options end
Promote an ordinary user to a site administrator
@param user [String] Username of the user to promote. @return [Boolean] True if promote was successful, false otherwise. @see developer.github.com/enterprise/v3/enterprise-admin/users/#promote-an-ordinary-user-to-a-site-administrator @example
@admin_client.promote('holman')
# File lib/octokit/enterprise_admin_client/users.rb, line 28 def promote(user, options = {}) boolean_from_response :put, "users/#{user}/site_admin", options end
Rename a user.
@param old_login [String] The user's old username. @param new_login [String] The user's new username. @see developer.github.com/enterprise/v3/enterprise-admin/users/#rename-an-existing-user @example
@admin_client.rename_user('foobar', 'foofoobar')
# File lib/octokit/enterprise_admin_client/users.rb, line 50 def rename_user(old_login, new_login, options = {}) options[:login] = new_login patch "admin/users/#{old_login}", options end
Suspend a user.
@param user [String] Username of the user to suspend. @return [Boolean] True if suspend was successful, false otherwise. @see developer.github.com/enterprise/v3/enterprise-admin/users/#suspend-a-user @example
@admin_client.suspend('holman')
# File lib/octokit/enterprise_admin_client/users.rb, line 72 def suspend(user, options = {}) boolean_from_response :put, "users/#{user}/suspended", options end
Unsuspend a user.
@param user [String] Username of the user to unsuspend. @return [Boolean] True if unsuspend was successful, false otherwise. @see developer.github.com/enterprise/v3/enterprise-admin/users/#unsuspend-a-user @example
@admin_client.unsuspend('holman')
# File lib/octokit/enterprise_admin_client/users.rb, line 83 def unsuspend(user, options = {}) boolean_from_response :delete, "users/#{user}/suspended", options end