用户

/api/user端点。

DELETE /api/user/:id

禁用一个用户。这并不会从数据库中删除该用户，而是禁用他们的账户。

您必须是超级用户才能执行此操作。

参数

• id值必须是一个大于零的整数。

GET /api/user/

为管理员或群组管理员获取用户列表。默认情况下，管理员只返回活跃用户，群组管理员只返回他们管理的群组中的活跃用户。

• 如果status是deactivated，则只包括已停用的用户。
• 如果status是all，则包括所有用户（活跃和停用）。
• 还支持include_deactivated，如果为true，则等同于status=all；如果为false，则等同于status=active。 status和include_deactivated需要超级用户权限。
• include_deactivated是status的旧别名，将在未来版本中删除。建议用户使用status以获得更好的支持和灵活性。如果两个参数都传递，则status优先。

对于具有分段权限的用户，仅返回自身。

接受limit和offset进行分页。接受query用于按名字、姓氏、电子邮件进行过滤。还接受group_id，用于按群组ID过滤。

参数

• status 可空字符串。

• query 可空字符串。

• group_id 可空值必须是大于零的整数。

• include_deactivated 可空值必须是有效的布尔字符串（“true”或“false”）。

GET /api/user/:id

获取一个用户。您必须获取自己 或 是超级用户 或 群组管理员。

参数

• id值必须是一个大于零的整数。

GET /api/user/current

获取当前用户。

GET /api/user/recipients

获取一个用户列表。仅返回活跃用户。与GET /api/user不同，此操作面向非管理员。

• 如果用户可见性为:all或用户是管理员，则包括所有用户。
• 如果用户可见性为:group，则仅包括同一群组中的用户（不包括所有用户组）。
• 如果用户可见性为:none或用户处于沙箱状态，则仅包括自身。

POST /api/user/

创建一个新的用户，如果电子邮件地址已被占用，则返回400。

您必须是超级用户才能执行此操作。

参数

• first_name 可空值必须是非空字符串。

• last_name 可空值必须是非空字符串。

• email 值必须是有效的电子邮件地址。

• user_group_memberships 可空序列为映射，其中 {:id ->, :is_group_manager (可选) ->}.

• login_attributes 可空登录属性键必须是关键字或字符串。

POST /api/user/:id/send_invite

重新发送给定用户的用户邀请电子邮件。

您必须是超级用户才能执行此操作。

参数

• id值必须是一个大于零的整数。

PUT /api/user/:id

更新现有的、活跃的 用户。普通用户或超级用户可以更新用户信息和用户组。组管理员只能添加/删除他们管理的用户组中的用户。

参数

• email 可空值必须是一个有效的电子邮件地址。

• first_name 可空值必须是非空字符串。

• is_group_manager 可空布尔值。

• locale 可空字符串，必须是有效的两位字母ISO语言或语言-国家代码，例如 en 或 en_US。

• user_group_memberships 可空序列为映射，其中 {:id ->, :is_group_manager (可选) ->}.

• id值必须是一个大于零的整数。

• is_superuser 可空布尔值。

• login_attributes 可空登录属性键必须是关键字或字符串。

• last_name 可空值必须是非空字符串。

PUT /api/user/:id/modal/:modal

表明用户已经了解了‘查询构建器’的复杂性和细节。

参数

• id值必须是一个大于零的整数。

• modal

PUT /api/user/:id/password

更新用户的密码。

参数

• id值必须是一个大于零的整数。

• password 密码过于常见。

• old_password

• request

PUT /api/user/:id/reactivate

在 :id 上重新激活用户。

您必须是超级用户才能执行此操作。

参数

• id值必须是一个大于零的整数。

---

« 返回API索引