导出用户API

aki发表于:2019年11月07日 12:34:24更新于:2022年05月07日 14:45:13

导出用户API(JSON)

此API用于通过JSON格式导出用户信息。

HTTP 方法

GET

URI

https://(子域名).cybozu.cn/v1/users.json

请求头部

头部值和说明
X-Cybozu-Authorization值为“登录名:密码”通过BASE64编码之后的字符。
Authorization使用Basic验证时,值为“Basic”和“登录名:密码”通过BASE64编码之后的字符。
// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=

请求参数

参数名称要指定的值必须说明
ids数组可省略(省略时最大100)。要获取的用户的ID列表。
codes数组可省略(省略时最大100)。要获取的code列表。
offset数值

可省略(省略时0)。

偏移量。
size数值可省略(省略时最大100)。获取条数。

请求范例

※ids和codes都指定时,将报错。

查询字符串
ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100
包含请求头部的字符串
GET /v1/users.json?ids[0]=1&ids[1]=2&ids[2]=3&offset=0&size=100 HTTP/1.1
Host: example.cybozu.com:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Type头不需要。

应答

key类型说明
useruser型用户信息

 

{    
    "users": [    
        {    
            "birthDate": "2011-05-01",    
            "callto": "",    
            "code": "a",    
            "ctime": "2013-07-22T08:12:18Z",    
            "customItemValues": [    
                {    
                    "code": "item1",    
                    "value": "aitem1"    
                },    
                {    
                    "code": "secret",    
                    "value": "aitem2"    
                }    
            ],    
            "description": "",    
            "email": "",    
            "employeeNumber": "",    
            "extensionNumber": "",    
            "givenName": "",    
            "givenNameReading": "",    
            "id": "1",    
            "joinDate": "2013-01-01",    
            "localName": "",    
            "localNameLocale": "zh",    
            "locale": "",    
            "mobilePhone": "",    
            "mtime": "2013-07-22T09:00:00Z",    
            "name": "a",    
            "phone": "",    
            "primaryOrganization": null,    
            "sortOrder": 2147483647,    
            "surName": "a",    
            "surNameReading": "",    
            "timezone": "Asia/Shanghai",    
            "url": "",    
            "valid": true    
        },    
        {    
            "birthDate": null,    
            "callto": "",    
            "code": "Administrator",    
            "ctime": "2013-07-19T08:16:00Z",    
            "customItemValues": [    
                {    
                    "code": "item1",    
                    "value": "adminitem1"    
                },    
                {    
                    "code": "secret",    
                    "value": "adminitem2"    
                }    
            ],    
            "description": "",    
            "email": "",    
            "employeeNumber": "",    
            "extensionNumber": "",    
            "givenName": "",    
            "givenNameReading": "",    
            "id": "7532782697181632512",    
            "joinDate": null,    
            "localName": "",    
            "localNameLocale": "zh",    
            "locale": "",    
            "mobilePhone": "",    
            "mtime": "2013-07-22T08:13:00Z",    
            "name": "Administrator",    
            "phone": "",    
            "primaryOrganization": null,    
            "sortOrder": 2147483647,    
            "surName": "",    
            "surNameReading": "",    
            "timezone": "Asia/Shanghai",    
            "url": "",    
            "valid": true    
        }    
    ]    
}

访问权限

所有用户均可访问。

※kintone的来宾用户不可访问。

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