用户

最后更新于：2021-11-29 00:19:46

Users

结构

结构定义了用户数据中存在的所有字段。除非使用“_filter”查询参数或结构字段仅出现在特定上下文中，否则来自这些端点的任何响应都可以包含以下字段。

`id` integer	用户的唯一标识符。只读 Context: `embed`, `view`, `edit`
`username` string	用户的登录名。 Context: `edit`
`name` string	显示用户的名称。 Context: `embed`, `view`, `edit`
`first_name` string	用户的名字。 Context: `edit`
`last_name` string	用户的姓氏。 Context: `edit`
`email` string, email	用户的电子邮件。 Context: `edit`
`url` string, uri	用户的URL。 Context: `embed`, `view`, `edit`
`description` string	用户描述。 Context: `embed`, `view`, `edit`
`link` string, uri	用户的作者URL。只读 Context: `embed`, `view`, `edit`
`locale` string	用户区域设置。 Context: `edit` 唯一: , `en_US`
`nickname` string	用户的昵称。 Context: `edit`
`slug` string	用户的字母数字标识符。 Context: `embed`, `view`, `edit`
`registered_date` string, datetime (details)	用户的注册日期。只读 Context: `edit`
`roles` array	分配给用户的角色。 Context: `edit`
`password` string	用户的密码 (不可见). Context:
`capabilities` object	分配给用户的所有功能。只读 Context: `edit`
`extra_capabilities` object	分配给用户的任何额外功能。只读 Context: `edit`
`avatar_urls` object	用户的头像URL。只读 Context: `embed`, `view`, `edit`
`meta` object	元字段。 Context: `view`, `edit`

用户列表

查询此端点以检索用户集合。您可以使用下面的URL查询参数来控制和过滤您收到的响应。

定义

GET /gc/v2/users

请求示例

$ curl https://example.com/gc-json/gc/v2/users

参数

`context`	提出请求的范围；确定响应字段。默认:`view` 唯一: `view`, `embed`, `edit`
`page`	分页页码。默认: `1`
`per_page`	结果集中要返回的最大项目数量。默认: `10`
`search`	将结果限制在匹配字符串的结果。
`exclude`	确保结果集排除了特定的ID。
`include`	将结果集限制为特定ID。
`offset`	将结果集偏移特定数量的项。
`order`	排序属性升序或降序。默认: `asc` 唯一: `asc`, `desc`
`orderby`	按对象属性对集合进行排序。默认: `name` 唯一: `id`, `include`, `name`, `registered_date`, `slug`, `include_slugs`, `email`, `url`
`slug`	将结果集限制为具有一个或多个特定slug的用户。
`roles`	将结果集限制为与提供的至少一个特定角色匹配的用户。接受csv列表或单个角色。
`who`	将结果集限制在被视为作者的用户。唯一: `authors`

创建新用户

参数

`username`	用户的登录名。必填：是
`name`	显示用户的名称。
`first_name`	用户的名字。
`last_name`	用户的姓氏。
`email`	用户的电子邮件地址。必填：是
`url`	用户的URL。
`description`	用户描述。
`locale`	用户语言设置。唯一: , `en_US`
`nickname`	用户的昵称。
`slug`	用户的字母数字标识符。
`roles`	分配给用户的角色。
`password`	用户的密码（从未包含）。必填: 是
`meta`	元字段。

定义

POST /gc/v2/users

检索单个用户

定义和示例请求

GET /gc/v2/users/<id>

查询此端点以检索特定用户数据。

$ curl https://example.com/gc-json/gc/v2/users/<id>

参数

`id`	用户的唯一标识符。
`context`	提出请求的范围；确定响应字段。默认: `view` 唯一: `view`, `embed`, `edit`

更新用户

参数

`id`	用户的唯一标识符。
`username`	用户的登录名。
`name`	显示用户的名称。
`first_name`	用户的名字。
`last_name`	用户的姓氏。
`email`	用户的电子邮件地址。
`url`	用户的URL。
`description`	用户描述。
`locale`	用户语言设置。唯一: , `en_US`
`nickname`	用户的昵称。
`slug`	用户的字母数字标识符。
`roles`	分配给用户的角色。
`password`	用户的密码（不可见）。
`meta`	元字段。

定义

POST /gc/v2/users/<id>

删除单个用户

参数

`id`	用户的唯一标识符。
`force`	需要真实，因为用户不支持垃圾。
`reassign`	将已删除用户的文章和链接重新分配给此用户ID。必填：是

定义

DELETE /gc/v2/users/<id>

请求示例

$ curl -X DELETE https://example.com/gc-json/gc/v2/users/<id>

检索单个用户

定义和示例请求

GET /gc/v2/users/me

查询此端点以检索特定用户数据。

$ curl https://example.com/gc-json/gc/v2/users/me

参数

context 提出请求的范围；确定响应字段。
默认: view
唯一: view, embed, edit

更新单个用户

参数

`username`	用户的登录名。
`name`	显示用户的名称。
`first_name`	用户的名字。
`last_name`	用户的姓氏。
`email`	用户的电子邮件
`url`	用户的URL。
`description`	用户描述。
`locale`	用户语言设置。唯一: , `en_US`
`nickname`	用户的昵称。
`slug`	用户的字母数字标识符。
`roles`	分配给用户的角色。
`password`	用户的密码（不可见）。
`meta`	元字段。

定义

POST /gc/v2/users/me

删除单个用户

参数

`force`	需要真实，因为用户不支持垃圾。
`reassign`	将已删除用户的文章和链接重新分配给此用户ID。必填: 是

定义

DELETE /gc/v2/users/me

请求示例

$ curl -X DELETE https://example.com/gc-json/gc/v2/users/me