正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

ユーザーモデレーション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" }

ユーザーを非アクティブ化

特定のユーザーアカウントを非アクティブ化します。BANされたユーザーの詳細については、ユーザーのアクティブ化と非アクティブ化を参照してください。

前提要件:

  • インスタンスへの管理者アクセス権が必要です。
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同期によってブロックされているため、ユーザーをアクティブ化できない場合。

ユーザーへのアクセスをブロック

特定のユーザーアカウントをブロックします。BANされたユーザーの詳細については、ブロックとブロックの解除を参照してください。

前提要件:

  • インスタンスへの管理者アクセス権が必要です。
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
  • 403 Forbidden LDAP同期によってブロックされたユーザーのブロックを解除しようとした場合。

ユーザーをBAN

特定のユーザーアカウントを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
  • 403 ForbiddenアクティブでないユーザーをBANしようとした場合。

ユーザーの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
  • 403 Forbidden BANされていないユーザーのBANを解除しようとした場合。