导出用户的使用服务API

cybozu发表于:2021年04月14日 14:26:57更新于:2022年04月06日 17:17:46

导出用户的使用服务 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数组使用中的服务名称
仅用以下字符串构成。
  • kintone

如该用户没有使用任何服务,则返回空的数组。
kitone的服务代码是 ki 。

应答的范例

{
  "users": [
    {
      "code": "user1",
      "services": ["kintone"]
    },
    {
      "code": "user2",
      "services": ["kintone"]
    }
  ]
}

权限

所有用户都可以使用。

    注意:贴代码时请注意格式并使用"代码语言",与本文无关的问题请至“讨论社区”提问。