导入用户API

aki • 发表于：2019年10月29日 13:17:49 • 更新于：2023年04月28日 14:50:00

Index

导入用户API（JSON）

添加用户

用JSON格式添加用户信息。

HTTP 方法

POST

URI

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

请求头部

头部值和说明
X-Cybozu-Authorization值为“登录名:密码”通过BASE64编码之后的字符。
Authorization使用Basic验证时，值为“Basic”和“登录名:密码”通过BASE64编码之后的字符。
Content-Type指定为“application/json”。
※不指定时，无法解析JSON ，执行时将报错。
// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

请求正文

users数组中指定由如下属性组成的对象。users数组中一次最多可以指定100条。

参数值要指定的值必须说明
code字符串必须

登录名称

128个字符以内
不能为空或仅输入空格字符

valid布尔值
是否是可使用的用户，默认值为true
password字符串必须

密码

64个字符以内
不能为空

name字符串必须

显示名称

128个字符以内
不能为空或仅输入空格字符

surName字符串

姓

64个字符以内

givenName字符串

名

64个字符以内

surNameReading字符串

拼音（姓）

64个字符以内

givenNameReading字符串

拼音（名）

64个字符以内

localName字符串

其他语言下的显示名称

128个字符以内

localNameLocale字符串

显示语言

128个字符以内

timezone字符串

时区
指定为空时将报错

256个字符以内

locale字符串

语言

256个字符以内

※不指定，或者指定为"auto"时，根据Web浏览器的设置而定。

description字符串

用户说明

1000个字符以内

phone字符串

电话号码

100个字符以内

mobilePhone字符串

手机

100个字符以内

extensionNumber字符串

分机号

100个字符以内

email字符串

邮箱地址

256个字符以内

callto字符串

Skype用户名

遵循Skype用户名的规定

url字符串

URL

256个字符以内

employeeNumber字符串

员工编号

100个字符以内

birthDate日期

生日
“YYYY-MM-DD”格式的日期或空字符

joinDate日期

入职日期
“YYYY-MM-DD”格式的日期或空字符

sortOrder数值

显示优先度

0 〜 99999999

customItemValuescustomItemValue数组
自定义项目的项目代码和值的对应表

请求正文的范例

{    
    "users": [    
        {    
            "code": "Administrator",    
            "valid": true,    
            "password": "xxxyyyzzz",    
            "name": "Administrator",    
            "surName": "a",    
            "givenName": "",    
            "surNameReading": "",    
            "givenNameReading": "",    
            "localName": "",    
            "localNameLocale": "zh",    
            "timezone": "Asia/Shanghai",    
            "locale": "zh",    
            "description": "",    
            "phone": "",    
            "mobilePhone": "",    
            "extensionNumber": "",    
            "email": "",    
            "callto": "",    
            "url": "",    
            "employeeNumber": "123",    
            "birthDate": null,    
            "joinDate": null,    
            "sortOrder": 12,    
            "customItemValues": [    
                {    
                    "code": "userNameKey",    
                    "value": "jf"    
                }    
            ]    
        }    
    ]    
}

应答

成功时返回如下应答。

{}

代码范例

用curl发送请求的范例 ：

curl -X POST 'https://sample.cybozu.cn/v1/users.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
        "users": [
          {
            "code": "takahashi-kenta",
            "valid": true,
            "password": "password",
            "name": "陈",
            "surName": "飞",
            "givenName": "小陈",
            "surNameReading": "chen",
            "givenNameReading": "fei",
            "localName": "",
            "localNameLocale": "zh",
            "timezone": "Asia/Tokyo",
            "locale": "zh",
            "description": "",
            "phone": "0000-000-0000",
            "mobilePhone": "",
            "extensionNumber": "",
            "email": "fei-chen@example.com",
            "callto": "",
            "url": "",
            "employeeNumber": "k00531",
            "birthDate": "1995-05-05",
            "joinDate": "2023-04-01",
            "sortOrder": 12,
            "customItemValues": [
              {
                "code": "Boss",
                "value": 1
              }
            ]
          }
        ]
      }'

访问权限

仅cybozu.cn共通管理员可执行。

限制事项

  • 和通过CSV导入用户或在页面上手动对用户进行更改等处理发生冲突时，按照导入的顺序依次处理。

  • 本API不会上锁，因此不推荐同时进行：通过本API导入、通过CSV导入、在页面上手动添加用户等操作。

更新用户

更新通过JSON格式指定的用户信息。 

HTTP 方法

PUT

URI

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

请求头部

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

指定为“application/json”。

※不指定时，无法解析JSON ，执行时将报错。

// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

请求正文

users数组中指定由如下属性组成的对象。users数组中一次最多可以指定100条。

参数值要指定的值必须说明
code字符串必须

登录名称

128个字符以内

不能为空或仅输入空格字符

valid布尔值
是否是可使用的用户
password字符串

密码

64个字符以内

不能为空

name字符串

显示名称

128个字符以内
不能为空或仅输入空格字符

surName字符串

姓

64个字符以内

givenName字符串

名

64个字符以内

surNameReading字符串

拼音（姓）

64个字符以内

givenNameReading字符串

拼音（名）

64个字符以内

localName字符串

其他语言下的显示名称

128个字符以内

localNameLocale字符串

显示语言

128个字符以内

timezone字符串

时区
指定为空时将报错

256个字符以内

locale字符串

语言

256个字符以内

※不指定，或者指定为"auto"时，根据Web浏览器的设置而定。

description字符串

用户说明

1000个字符以内

phone字符串

电话号码

100个字符以内

mobilePhone字符串

手机

100个字符以内

extensionNumber字符串

分机号

100个字符以内

email字符串

邮箱地址

256个字符以内

callto字符串

Skype用户名

遵循Skype用户名的规定

url字符串

URL

256个字符以内

employeeNumber字符串

员工编号

100个字符以内

birthDate日期
生日
joinDate日期
入职日期
primaryOrganization数值

优先组织的ID

执行此API前，需要先设置用户的所属组织。
使用更新用户所属组织 API可以更新用户的所属组织。

sortOrder数值

显示优先度

0 〜 99999999

customItemValuescustomItemValue数组
自定义项目的项目代码和值的对应表

请求正文的范例

{    
    "users": [    
        {    
            "code": "Administrator",    
            "valid": true,    
            "password": "xxxyyyzzz",    
            "name": "Administrator",    
            "surName": "a",    
            "givenName": "",    
            "surNameReading": "",    
            "givenNameReading": "",    
            "localName": "",    
            "localNameLocale": "zh",    
            "timezone": "Asia/Shanghai",    
            "locale": "zh",    
            "description": "",    
            "phone": "",    
            "mobilePhone": "",    
            "extensionNumber": "",    
            "email": "",    
            "callto": "",    
            "url": "",    
            "employeeNumber": "123",    
            "birthDate": null,    
            "joinDate": null,    
            "sortOrder": 12,    
            "customItemValues": [    
                {    
                    "code": "userNameKey",    
                    "value": "jf"    
                }    
            ]    
        }    
    ]    
}

应答

成功时返回以下应答。

{}

代码范例

用curl发送请求的范例 ：

curl -X PUT 'https://sample.cybozu.cn/v1/users.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "users": [
      {
        "code": "kato-misaki",
        "valid": true,
        "password": "password",
        "name": "陈",
        "surName": "飞",
        "givenName": "小陈",
        "surNameReading": "chen",
        "givenNameReading": "fei",
        "localName": "",
        "localNameLocale": "zh",
        "timezone": "Asia/Beijing",
        "locale": "zh",
        "description": "",
        "phone": "0000-00-0000",
        "mobilePhone": "",
        "extensionNumber": "",
        "email": "fei-chen@example.com",
        "callto": "",
        "url": "",
        "employeeNumber": "m00312",
        "birthDate": "1991-04-17",
        "joinDate": "2022-04-01",
        "sortOrder": null,
        "customItemValues": [
          {
            "code": "boss",
            "value": "1"
          }
        ]
      }
    ]
  }'

访问权限

仅cybozu.cn共通管理员可执行。

限制事项

  • 和通过CSV导入用户或在页面上手动更改用户等处理发生冲突时，按照导入的顺序依次处理。

  • 本API不会上锁，因此不推荐同时进行：通过本API导入、通过CSV导入、在页面上手动添加用户等操作。

删除用户

删除用JSON格式指定的用户。 

HTTP 方法

DELETE

URI

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

请求头部

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

指定为“application/json”。

※不指定时，无法解析JSON ，执行时将报错。

// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

请求正文

参数值要指定的值必须说明
codes数值必须

要删除的用户的code一览表

最大100

请求正文的范例

{    
    "codes": [    
        "user1",    
        "user2",    
        "user3"    
    ]    
}

应答

成功时返回如下应答。

{}

代码范例

用curl发送请求的范例 ：

curl -X DELETE 'https://sample.cybozu.cn/v1/users.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "codes": ["fei-chen", "shijie-zhou"]
  }'

访问权限

仅cybozu.cn共通管理员可执行。

限制事项

  • 和通过CSV导入用户或手动添加用户等处理发生冲突时，按照导入的顺序依次处理。

  • 本API不会上锁，因此不推荐同时进行：通过本API导入、通过CSV导入、在页面上手动添加用户等操作。

更新登录名

更新用JSON格式指定的用户登录名。 

HTTP 方法

PUT

URI

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

请求头部

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

指定为“application/json”。

※不指定时，无法解析JSON ，执行时将报错。

// Sample
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
Content-Type: application/json

请求正文

codes数组中指定由如下属性组成的对象。codes数组中一次最多可以指定100条。

参数值要指定的值必须说明
currentCode字符串必须

登录名称

128个字符以内

不能为空或仅输入空格字符

newCode字符串必须

登录名称

128个字符以内

不能为空或仅输入空格字符

请求正文的范例

{    
    "codes": [    
        {    
             "currentCode": "user1",    
             "newCode": "user1-new"    
        },    
        {    
             "currentCode": "user2",    
             "newCode": "user2-new"    
        }    
    ]    
}

应答

成功时返回如下应答。

{}

代码范例

用curl发送请求的范例 ：

curl -X DELETE 'https://sample.cybozu.cn/v1/users.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
       "codes": [
         { 
           "currentCode": "fei-chen", 
           "newCode": "chen-fei"
         }
       ]
  }'

访问权限

仅cybozu.cn共通管理员可执行。

限制事项

  • 和通过CSV导入用户或在页面上手动更改用户等处理发生冲突时，按照导入的顺序依次处理。

  • 本API不会上锁，因此不推荐同时进行：通过本API导入、通过CSV导入、在页面上手动添加用户等操作。

    最多浏览的文档