Skip to main content

Suspending and unsuspending users

If a user leaves or moves to a different part of the company, you should remove or modify their ability to access your GitHub Enterprise Server instance.

If employees leave the company, you can suspend their GitHub Enterprise Server accounts to open up user licenses in your GitHub Enterprise license while preserving the issues, comments, repositories, gists, and other data they created. Suspended users cannot sign into your instance, nor can they push or pull code.

When you suspend a user, the change takes effect immediately with no notification to the user. If the user attempts to pull or push to a repository, they'll receive this error:

$ git clone git@[hostname]:john-doe/test-repo.git
Cloning into 'test-repo'...
ERROR: Your account is suspended. Please check with your installation administrator.
fatal: The remote end hung up unexpectedly

Before suspending site administrators, you must demote them to regular users. For more information, see "Promoting or demoting a site administrator."

Note: If LDAP Sync is enabled for your GitHub Enterprise Server instance, users are automatically suspended when they're removed from the LDAP directory server. When LDAP Sync is enabled for your instance, normal user suspension methods are disabled.

Suspending a user from the user admin dashboard

  1. 从 GitHub Enterprise Server 上的管理帐户任意页面的右上角,单击

    用于访问站点管理员设置的火箭图标的屏幕截图

  2. 如果你尚未在“站点管理员”页上,请在左上角单击“站点管理员”。

    “站点管理员”链接的屏幕截图

  3. 在搜索字段中,键入用户的名称,然后单击“搜索”。 站点管理员设置搜索字段

  4. 在搜索结果中,单击用户名称。 站点管理设置搜索选项

  5. 在页面的右上角,单击 “管理员”。管理员工具

  6. 在左侧栏中,单击“管理员”。管理员工具

  7. Under "Account suspension," in the red Danger Zone box, click Suspend. Suspend button

  8. Provide a reason to suspend the user. Suspend reason

Unsuspending a user from the user admin dashboard

As when suspending a user, unsuspending a user takes effect immediately. The user will not be notified.

  1. 从 GitHub Enterprise Server 上的管理帐户任意页面的右上角,单击

    用于访问站点管理员设置的火箭图标的屏幕截图

  2. 如果你尚未在“站点管理员”页上,请在左上角单击“站点管理员”。

    “站点管理员”链接的屏幕截图

  3. In the left sidebar, click Suspended users. Suspended users tab

  4. Click the name of the user account that you would like to unsuspend. Suspended user

  5. 在页面的右上角,单击 “管理员”。管理员工具

  6. 在左侧栏中,单击“管理员”。管理员工具

  7. Under "Account suspension," in the red Danger Zone box, click Unsuspend. Unsuspend button

  8. Provide a reason to unsuspend the user. Unsuspend reason

Suspending a user from the command line

  1. SSH into your GitHub Enterprise Server instance. If your instance comprises multiple nodes, for example if high availability or geo-replication are configured, SSH into the primary node. If you use a cluster, you can SSH into any node. For more information about SSH access, see "Accessing the administrative shell (SSH)."

    $ ssh -p 122 admin@HOSTNAME
  2. Run ghe-user-suspend with the username to suspend.

    $ ghe-user-suspend USERNAME

Creating a custom message for suspended users

You can create a custom message that suspended users will see when attempting to sign in.

  1. 在 GitHub Enterprise Server 的右上角,单击你的个人资料照片,然后单击“企业设置”。 GitHub Enterprise Server 上个人资料照片下拉菜单中的“企业设置”
  2. 在企业帐户侧边栏中,单击 “设置”。 企业帐户侧边栏中的“设置”选项卡
  3. 在“ 设置”下,单击“消息” 。 企业设置侧边栏中的“消息”选项卡
  4. Click Add message. Add message
  5. Type your message into the Suspended user message box. You can type Markdown, or use the Markdown toolbar to style your message. Suspended user message
  6. Click the Preview button under the Suspended user message field to see the rendered message. Preview button
  7. Review the rendered message. Suspended user message rendered
  8. 在页面的底部,单击“保存更改”。 保存更改

Unsuspending a user from the command line

  1. SSH into your GitHub Enterprise Server instance. If your instance comprises multiple nodes, for example if high availability or geo-replication are configured, SSH into the primary node. If you use a cluster, you can SSH into any node. For more information about SSH access, see "Accessing the administrative shell (SSH)."

    $ ssh -p 122 admin@HOSTNAME
  2. Run ghe-user-unsuspend with the username to unsuspend.

    $ ghe-user-unsuspend USERNAME

Further reading