用户
更新
用户资源表示从API检索的数据的最终用户。例如，如果某个应用使用API让人们访问iCloud Photo Library照片，那么最终用户就是该应用的用户。
始终如一地识别最终用户以确保最高级别的数据安全性并确保最佳用户体验非常重要。
属性
| 名称 | 类型 | 描述 |
|---|---|---|
id | 用户身份 | 资源标识符。 |
resource | 字符串，永远是user | 资源类型说明符。 |
organisation | 组织ID | 资源所属的组织。 |
key | 密钥ID | 资源与之关联的关键。 |
identifier | 串 | 自定义值有助于识别用户并避免重复。例如，可以将其设置为最终用户的电子邮件地址。 |
state | 串 | 其中之一： active ， deactivated ， blocked 。 |
date_created | 约会时间 | 资源创建时。 |
识别码
API不使用identifier属性，但应充当您的实现与API中存储的信息之间的桥梁。此属性的值应允许系统用户与API上的用户直接映射。这可以是系统中的用户ID，也可以是最终用户的电子邮件地址。
状态
-
active - 用户的标准状态。
-
deactivated - 拥有组织已禁用此用户的访问权限。
-
blocked - API管理员已禁用此用户的访问权限。
创建POST /users
参数
| 名称 | 类型 | 描述 |
|---|---|---|
organisation | 超 | 允许API管理员代表其他组织创建用户。 |
key | 默认值：当前密钥 | 将用户分配给单独的密钥。例如，可能是权限较少的权限。 |
identifier | 必需的，字符串 | 用于向系统中的最终用户标识此用户的一条信息。 |
使用cURL
curl https://ricloud-api.reincubate.com/users \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "identifier": "end-user@email.com" }'
使用ricloud-py
import ricloud user = ricloud.User.create(identifier='end-user@email.com')
检索GET /users/{user ID}
使用cURL
curl https://ricloud-api.reincubate.com/users/<user ID> \ -H 'Authorization: Token <your key_token>'
使用ricloud-py
import ricloud user = ricloud.User.retrieve(<user ID>)
列出GET /users
参数
| 名称 | 类型 | 描述 |
|---|---|---|
key | 密钥ID | 按用户关联的密钥过滤用户。 |
identifier | 串 | 按用户标识符过滤用户。 |
state | 串 | 按用户状态过滤用户。 |
date_created | 日期时间过滤器 | 按资源创建日期过滤。 |
使用cURL
curl https://ricloud-api.reincubate.com/users \ -H 'Authorization: Token <your key_token>'
使用ricloud-py
import ricloud users = ricloud.User.list()
更新POST /users/{user ID}
参数
| 名称 | 类型 | 描述 |
|---|---|---|
key | 密钥ID | 将用户移动到与其他键关联。例如，如果他们从试用版更新。 |
identifier | 串 | 更新用户标识符。 |
state | 串 | 更新用户的状态，要么deactivated ，要么deactivated恢复为active 。 |
使用cURL
curl https://ricloud-api.reincubate.com/users/<user ID> \ -X POST \ -H 'Authorization: Token <your key_token>' \ -H 'Content-Type: application/json' \ -d '{ "state": "deactivated" }'
使用ricloud-py
import ricloud user = ricloud.User.update_with_id(<user ID>, state='deactivated') # OR user = ricloud.User.retrieve(<user ID>) user.update(state='deactivated')
