ユーザーモデレーションAPI
- プラン: Free、Premium、Ultimate
- 提供形態: GitLab Self-Managed、GitLab Dedicated
このAPIを使用してユーザーアカウントをモデレートします。詳細については、ユーザーのモデレートを参照してください。
ユーザーへのアクセスを承認
承認待ちの指定されたユーザーアカウントへのアクセスを承認します。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
POST /users/:id/approveサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | ユーザーアカウントのID |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/42/approve"戻り値:
- 成功した場合は
201 Created。 - ユーザーが見つからない場合は
404 User Not Found。 403 Forbiddenは、ユーザーが管理者またはLDAP同期によってブロックされているため承認できない場合です。- ユーザーが無効化されている場合は
409 Conflictです。
応答例:
{ "message": "Success" }{ "message": "404 User Not Found" }{ "message": "The user you are trying to approve is not pending approval" }ユーザーへのアクセスを拒否
承認待ちの指定されたユーザーアカウントへのアクセスを拒否します。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
POST /users/:id/rejectサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | ユーザーアカウントのID |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/42/reject"戻り値:
- 成功した場合は
200 OK。 - 管理者として認証されていない場合は
403 Forbidden。 - ユーザーが見つからない場合は
404 User Not Found。 - ユーザーが承認待ちでない場合は
409 Conflictです。
応答例:
{ "message": "Success" }{ "message": "404 User Not Found" }{ "message": "User does not have a pending request" }ユーザーを無効化
指定されたユーザーアカウントを無効化します。禁止されたユーザーの詳細については、ユーザーのアクティブ化と非アクティブ化を参照してください。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
POST /users/:id/deactivateサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | ユーザーアカウントのID |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/42/deactivate"戻り値:
- 成功した場合は
201 OK。 - ユーザーが見つからない場合は
404 User Not Found。 - 以下のユーザーを非アクティブ化しようとした場合は
403 Forbidden:- 管理者またはLDAP同期によってブロックされている。
- 休止状態ではない。
- 内部ユーザー。
ユーザーを再アクティブ化
以前に無効化された指定のユーザーアカウントを再アクティブ化します。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
POST /users/:id/activateサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | ユーザーアカウントのID |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/42/activate"戻り値:
- 成功した場合は
201 OK。 - ユーザーが見つからない場合は
404 User Not Foundです。 403 Forbiddenは、ユーザーが管理者またはLDAP同期によってブロックされているためアクティブ化できない場合です。
ユーザーへのアクセスをブロック
指定されたユーザーアカウントをブロックします。禁止されたユーザーの詳細については、ユーザーをブロックおよびブロック解除を参照してください。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
POST /users/:id/blockサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | ユーザーアカウントのID |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/42/block"戻り値:
- 成功した場合は
201 OK。 - ユーザーが見つからない場合は
404 User Not Found。 - 以下のユーザーをブロックしようとした場合は
403 Forbidden:- LDAP経由でブロックされているユーザー。
- 内部ユーザー。
ユーザーへのアクセスをブロック解除
以前にブロックされた指定のユーザーアカウントのブロックを解除します。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
POST /users/:id/unblockサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | ユーザーアカウントのID |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/42/unblock"戻り値:
- 成功した場合は
201 OK。 - ユーザーが見つからない場合は
404 User Not Found。 - LDAP同期によってブロックされたユーザーのブロック解除を試みた場合は
403 Forbiddenです。
ユーザーをBAN
指定されたユーザーアカウントをBANします。禁止されたユーザーの詳細については、ユーザーをBANおよびBAN解除を参照してください。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
POST /users/:id/banサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | ユーザーアカウントのID |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/42/ban"戻り値:
- 成功した場合は
201 OK。 - ユーザーが見つからない場合は
404 User Not Found。 - アクティブではないユーザーをBANしようとした場合は
403 Forbiddenです。
ユーザーのBANを解除
以前にBANされた指定のユーザーアカウントのBANを解除します。
前提条件:
- インスタンスへの管理者アクセス権が必要です。
POST /users/:id/unbanサポートされている属性は以下のとおりです:
| 属性 | 型 | 必須 | 説明 |
|---|---|---|---|
id | 整数 | はい | ユーザーアカウントのID |
curl --request POST \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/users/42/unban"戻り値:
- 成功した場合は
201 OK。 - ユーザーが見つからない場合は
404 User Not Foundです。 - BANされていないユーザーのBAN解除を試みた場合は
403 Forbiddenです。