Module: Octokit::EnterpriseAdminClient::Users

Included in:

Octokit::EnterpriseAdminClient

Defined in:

lib/octokit/enterprise_admin_client/users.rb

Overview

Methods for the Enterprise User Administration API

See Also:

• https://developer.github.com/v3/users/administration/

Instance Method Summary

• #demote(user, options = {}) ⇒ Boolean

  Demote a site administrator to an ordinary user.

• #promote(user, options = {}) ⇒ Boolean

  Promote an ordinary user to a site administrator.

• #suspend(user, options = {}) ⇒ Boolean

  Suspend a user.

• #unsuspend(user, options = {}) ⇒ Boolean

  Unsuspend a user.

Instance Method Details

#demote(user, options = {}) ⇒ Boolean

Demote a site administrator to an ordinary user

Examples:

@admin_client.demote('holman')

Parameters:

• user (String) —

  Username of the user to demote.

Returns:

• (Boolean) —

  True if demote was successful, false otherwise.

See Also:

• https://developer.github.com/v3/users/administration/#demote-a-site-administrator-to-an-ordinary-user

# File 'lib/octokit/enterprise_admin_client/users.rb', line 26

def demote(user, options = {})
  boolean_from_response :delete, "users/#{user}/site_admin", options
end

#promote(user, options = {}) ⇒ Boolean

Promote an ordinary user to a site administrator

Examples:

@admin_client.promote('holman')

Parameters:

• user (String) —

  Username of the user to promote.

Returns:

• (Boolean) —

  True if promote was successful, false otherwise.

See Also:

• https://developer.github.com/v3/users/administration/#promote-an-ordinary-user-to-a-site-administrator

# File 'lib/octokit/enterprise_admin_client/users.rb', line 15

def promote(user, options = {})
  boolean_from_response :put, "users/#{user}/site_admin", options
end

#suspend(user, options = {}) ⇒ Boolean

Suspend a user.

Examples:

@admin_client.suspend('holman')

Parameters:

• user (String) —

  Username of the user to suspend.

Returns:

• (Boolean) —

  True if suspend was successful, false otherwise.

See Also:

• https://developer.github.com/v3/users/administration/#suspend-a-user

# File 'lib/octokit/enterprise_admin_client/users.rb', line 37

def suspend(user, options = {})
  boolean_from_response :put, "users/#{user}/suspended", options
end

#unsuspend(user, options = {}) ⇒ Boolean

Unsuspend a user.

Examples:

@admin_client.unsuspend('holman')

Parameters:

• user (String) —

  Username of the user to unsuspend.

Returns:

• (Boolean) —

  True if unsuspend was successful, false otherwise.

See Also:

• https://developer.github.com/v3/users/administration/#unsuspend-a-user

# File 'lib/octokit/enterprise_admin_client/users.rb', line 48

def unsuspend(user, options = {})
  boolean_from_response :delete, "users/#{user}/suspended", options
end