导出用户的使用服务 API(JSON)
此API用于通过 JSON 格式导出用户所使用的服务信息。
无法输出管理员的信息。
HTTP 方法
GET
URI
https://{subdomain}.cybozu.cn/v1/users/services.json
请求头部
头部 | 值和说明 |
---|---|
X-Cybozu-Authorization | 请指定为对"登录名:密码"进行 BASE64 编码后的值。 |
Authorization | 使用 Basic 认证时,请指定为对字符串“Basic”和“登录名:密码”进行 BASE64 编码后的值。 |
// Sample X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
请求参数
参数名称 | 类型 | 必须 | 说明 |
---|---|---|---|
codes | 数组 | 可省略 | 想要获取的用户的 code 的列表 如省略,则以全用户为对象,最多获取100条记录。 |
offset | 数值 | 可省略 | 偏移量 如省略,则为0。 |
size | 数值 | 可省略 | 取得件数 如省略,则为100。 |
用 HTTP 的查询字符串发送参数
查询字符串
codes[0]=1&codes[1]=2&codes[2]=3&offset=0&size=100
包含在请求头部的字符串
GET /v1/users/services.json?codes[0]=1&codes[1]=2&codes[2]=3&offset=0&size=100 HTTP/1.1 Host: example.cybozu.cn:443 X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU= Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
不需要 Content-Type 头部
应答
参数
参数名称 | 值的类型 | 说明 |
---|---|---|
users | 数组 | 用户的使用服务信息列表 按用户ID升序排列。 |
users[].code | 字符串 | 用户的登录名称。 |
users[].services | 数组 | 使用中的服务名称 仅用以下字符串构成。
kitone的服务代码是 ki 。 |
应答的范例
{ "users": [ { "code": "user1", "services": ["kintone"] }, { "code": "user2", "services": ["kintone"] } ] }
代码范例
用curl发送请求的范例 :
curl -X GET 'https://sample.cybozu.com/v1/users/services.json?codes%5B0%5D=sato-noboru&codes%5B1%5D=kato-misaki' \ -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU='
权限
所有用户都可以使用。