Help us learn about your current experience with the documentation. Take the survey.
用户审核 API
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed, GitLab Dedicated
使用此 API 来审核用户账户。更多信息请参阅审核用户。
批准用户访问权限
批准访问待批准的指定用户账户。
前置条件：
- 您必须拥有实例的管理员权限。
POST /users/:id/approve支持的属性：
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer | yes | 用户账户 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。 - 如果用户被管理员或 LDAP 同步阻止，无法批准，返回
403 Forbidden。 - 如果用户已被停用，返回
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 |
integer | yes | 用户账户 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 |
integer | yes | 用户账户 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 |
integer | yes | 用户账户 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。 - 如果用户被管理员或 LDAP 同步阻止，无法激活，返回
403 Forbidden。
阻止用户访问
阻止指定的用户账户。有关封禁用户的信息，请参阅阻止和解封用户。
前置条件：
- 您必须拥有实例的管理员权限。
POST /users/:id/block支持的属性：
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer | yes | 用户账户 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 |
integer | yes | 用户账户 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。
封禁用户
封禁指定的用户账户。有关封禁用户的信息，请参阅封禁和解封用户。
前置条件：
- 您必须拥有实例的管理员权限。
POST /users/:id/ban支持的属性：
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer | yes | 用户账户 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。
解除封禁
解除之前被封禁的指定用户账户的封禁状态。
前置条件：
- 您必须拥有实例的管理员权限。
POST /users/:id/unban支持的属性：
| 属性 | 类型 | 必需 | 描述 |
|---|---|---|---|
id |
integer | yes | 用户账户 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。