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. Desde una cuenta administrativa de GitHub Enterprise Server, en la esquina superior derecha de cualquier página, haz clic en .

    Captura de pantalla del icono de cohete para acceder a los ajustes administrativos

  2. Si todavía no está en la página "Administrador del sitio", en la esquina superior izquierda, haga clic en Administrador del sitio.

    Captura de pantalla del vínculo "Administrador del sitio"

  3. En el campo de búsqueda, escriba el nombre del usuario y haga clic en Buscar. Campo de búsqueda en la configuración de administrador del sitio

  4. En los resultados de búsqueda, da clic en el nombre del usuario. Opciones de búsqueda en la configuración de administración del sitio

  5. En la esquina superior derecha de la página, haga clic en Administración. Herramientas de administración

  6. En la barra lateral de la izquierda, haga clic en Administración. Herramientas de administración

  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. Desde una cuenta administrativa de GitHub Enterprise Server, en la esquina superior derecha de cualquier página, haz clic en .

    Captura de pantalla del icono de cohete para acceder a los ajustes administrativos

  2. Si todavía no está en la página "Administrador del sitio", en la esquina superior izquierda, haga clic en Administrador del sitio.

    Captura de pantalla del vínculo "Administrador del sitio"

  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. En la esquina superior derecha de la página, haga clic en Administración. Herramientas de administración

  6. En la barra lateral de la izquierda, haga clic en Administración. Herramientas de administración

  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. En la esquina superior derecha de GitHub Enterprise Server, haga clic en la foto de perfil y luego en Configuración de empresa. "Configuración de empresa" en el menú desplegable de la foto de perfil de GitHub Enterprise Server
  2. En la barra lateral de la cuenta de empresa, haga clic en Configuración. Pestaña Configuración en la barra lateral de la cuenta de empresa
  3. En Settings, haga clic en Mensajes. Pestaña Mensajes en la barra lateral de configuración de la empresa
  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. En la parte inferior de la página, haga clic en Save changes. Guardar cambios

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