{{< details >}}

  • Tier: 基础版, 专业版, 旗舰版
  • Offering: 私有化部署

{{< /details >}}

使用此 API 来管理用户账户。有关更多信息，请参阅 模拟用户。

批准用户访问

批准待批准的用户账户的访问。

前提条件：

  • 您必须拥有实例的管理员访问权限。
POST /users/:id/approve

支持的属性：

属性 类型 必需 描述
id integer 是 用户账户的 ID 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "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 是 用户账户的 ID 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "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 是 用户账户的 ID

返回：

  • 成功时返回 201 OK。
  • 如果找不到用户，则返回 404 User Not Found。
  • 当尝试停用被以下原因阻止的用户时，返回 403 Forbidden：
    • 被管理员或 LDAP 同步阻止。
    • 不是 休眠状态。
    • 内部用户。

激活用户

重新激活之前停用的用户账户。

前提条件：

  • 您必须拥有实例的管理员访问权限。
POST /users/:id/activate

支持的属性：

属性 类型 必需 描述
id integer 是 用户账户的 ID

返回：

  • 成功时返回 201 OK。
  • 如果找不到用户，则返回 404 User Not Found。
  • 如果用户因为被管理员或 LDAP 同步阻止而无法被激活，则返回 403 Forbidden。

阻止用户访问

阻止指定的用户账户。有关被禁用户的更多信息，请参阅阻塞和取消阻塞用户。

前提条件：

  • 您必须拥有实例的管理员访问权限。
POST /users/:id/block

支持的属性：

属性 类型 必需 描述
id integer 是 用户账户的 ID

返回：

  • 成功时返回 201 OK。
  • 如果找不到用户，则返回 404 User Not Found。
  • 当尝试阻止以下用户时，返回 403 Forbidden：
    • 通过 LDAP 阻止的用户。
    • 内部用户。

解除对用户的阻止

解除对之前被阻止的用户账户的阻止。

前提条件：

  • 您必须拥有实例的管理员访问权限。
POST /users/:id/unblock

支持的属性：

属性 类型 必需 描述
id integer 是 用户账户的 ID

返回：

  • 成功时返回 201 OK。
  • 如果找不到用户，则返回 404 User Not Found。
  • 当尝试解除通过 LDAP 同步阻止的用户时，返回 403 Forbidden。

禁止用户

禁止指定的用户账户。有关被禁用户的更多信息，请参阅禁用和解禁用户。

前提条件：

  • 您必须拥有实例的管理员访问权限。
POST /users/:id/ban

支持的属性：

属性 类型 必需 描述
id integer 是 用户账户的 ID

返回：

  • 成功时返回 201 OK。
  • 如果找不到用户，则返回 404 User Not Found。
  • 当尝试禁止非活跃用户时，返回 403 Forbidden。

解除用户禁止

解除对之前被禁止的用户账户的禁止。

前提条件：

  • 您必须拥有实例的管理员访问权限。
POST /users/:id/unban

支持的属性：

属性 类型 必需 描述
id integer 是 用户账户的 ID

返回：

  • 成功时返回 201 OK。
  • 如果找不到用户，则返回 404 User Not Found。
  • 当尝试解除对未被禁止的用户的禁止时，返回 403 Forbidden。

相关主题