ユーザーのサスペンドとサスペンドの解除

ユーザーが企業を離れたり異動したりした場合には、お使いの GitHub Enterprise Server インスタンスに対するそのユーザーのアクセス権を削除したり変更したりしなければなりません。

この記事の内容

一時停止されたユーザーについて

従業員が企業を退職した場合、そのGitHub Enterprise Serverアカウントをサスペンドすれば、GitHub Enterpriseライセンス中のユーザライセンスを空けながら、Issue、コメント、リポジトリ、Gist、そしてそのユーザが作成した他のデータを保持しておくことができます。サスペンドされたユーザはインスタンスにサインインすることも、コードをプッシュやプルすることもできません。

ユーザをサスペンドした場合、その変更はすぐに有効になり、ユーザには通知されません。ユーザがリポジトリからのプルやプッシュをしようとすると、以下のエラーが返されます:

$ 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

Tip

GitHub では、アカウントの削除ではなく、可能な限りユーザーを中断することをお勧めします。

ユーザーを一時停止できないシナリオ

サイト管理者をサスペンドする前には、そのユーザを通常のユーザに降格させなければなりません。「サイト管理者の昇格あるいは降格」を参照してください。

特定の外部認証機能を使用する場合、サイト管理者ダッシュボードまたはコマンドラインからユーザーの停止を管理することはできません。

お使いの GitHub Enterprise Server インスタンスに対して LDAP 同期が有効な場合、「LDAPの利用」で説明されているシナリオに基づいて、ユーザーは自動的に一時停止されます。
SCIM プロビジョニングが有効になっている場合、SCIM プロビジョニングされたユーザーは、ID プロバイダーを通じて一時停止または停止解除する必要があります。

サイト管理者ダッシュボードで一時停止されたユーザーを表示する

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅でをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
左側のサイドバーで、 [一時停止されたユーザー] をクリックします。
一時停止されたユーザーのリストが表示されます。

サイト管理ダッシュボードからユーザを一時停止する

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅でをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
[ユーザー、Organization、チーム、リポジトリ、gist、アプリケーションを検索する] のテキストフィールドに、ユーザーの名前を入力します。
テキストフィールドの右側にある [検索] をクリックします。
- 正確に一致するアカウント名が見つからない場合は、[検索結果 – アカウント] の [あいまい一致] セクションで、管理するユーザーの名前をクリックします。
サイト管理者ページでユーザーについて詳しく確認し、正しいユーザーを特定したことを確認します。
ページの右上隅にある [管理] をクリックします。
[アカウントの一時停止] の [危険ゾーン] セクションで、 [一時停止] をクリックします。
[ログの理由] フィールドに、ユーザーを一時停止する理由を入力します。
[一時停止] をクリックします。

サイト管理ダッシュボードからユーザのサスペンドを解除する

ユーザのサスペンドの場合と同じく、ユーザのサスペンド解除もすぐに有効になります。ユーザには通知されません。

GitHub Enterprise Server の管理アカウントから、任意のページの右上隅でをクリックします。
[サイト管理者] ページにまだ表示されていない場合は、左上隅の [サイト管理者] をクリックします。
左側のサイドバーで、 [一時停止されたユーザー] をクリックします。
サスペンドを解除したいユーザアカウントの名前をクリックします。
ページの右上隅にある [管理] をクリックします。
[アカウントの一時停止] の [危険ゾーン] セクションで、 [停止解除] をクリックします。
[ログの理由] フィールドに、ユーザーの停止を解除する理由を入力します。
[停止解除] をクリックします。

コマンドラインからユーザをサスペンドする

お使いの GitHub Enterprise Server インスタンスに SSH で接続します。インスタンスが複数のノードで構成されている場合は (高可用性や geo レプリケーションが構成されている場合など)、プライマリノードに SSH 接続します。クラスターを使用する場合は、任意のノードに SSH 接続できます。 HOSTNAME をインスタンスのホスト名、またはノードのホスト名または IP アドレスに置き換えます。詳しくは、「管理シェル (SSH) にアクセスする」を参照してください。
Shell
```
ssh -p 122 admin@HOSTNAME
```
```
ssh -p 122 admin@HOSTNAME
```
一時停止するユーザー名を指定して ghe-user-suspend を実行します。
```
ghe-user-suspend USERNAME
```

サスペンドされたユーザのためのカスタムメッセージを作成する

サスペンドされたユーザがサインインしようとしたときに表示されるカスタムメッセージを作成できます。

GitHub Enterprise Server の右上で、ご自分のプロフィールフォトをクリックしてから、 [Enterprise 設定] をクリックします。
ページの左側にある Enterprise アカウントのサイドバーで、 [設定] をクリックします。
[ Settings] で、[Messages] をクリックします。
[一時停止されたユーザーページ] の右側にある [メッセージの追加] をクリックします。
[ユーザーの一時停止メッセージ] フィールドに、メッセージを入力します。 Markdownをタイプするか、Markdownツールバーを使ってメッセージのスタイルを指定できます。
レンダリングされたメッセージを表示するには、 [プレビュー] をクリックします。
ページの下部にある [変更の保存] をクリックします。

コマンドラインからユーザのサスペンドを解除する

お使いの GitHub Enterprise Server インスタンスに SSH で接続します。インスタンスが複数のノードで構成されている場合は (高可用性や geo レプリケーションが構成されている場合など)、プライマリノードに SSH 接続します。クラスターを使用する場合は、任意のノードに SSH 接続できます。 HOSTNAME をインスタンスのホスト名、またはノードのホスト名または IP アドレスに置き換えます。詳しくは、「管理シェル (SSH) にアクセスする」を参照してください。
Shell
```
ssh -p 122 admin@HOSTNAME
```
```
ssh -p 122 admin@HOSTNAME
```
停止解除するユーザー名を指定して ghe-user-unsuspend を実行します。
```
ghe-user-unsuspend USERNAME
```

参考資料

エンタープライズユーザー用の REST API エンドポイント