导入用户所使用的服务的API

aki发表于:2019年11月07日 10:52:16更新于:2023年04月28日 15:05:48

导入用户所使用的服务的API(JSON)

批量更新用户所使用的服务

此API用于通过JSON格式更新用户所使用的服务信息。

HTTP 方法

PUT

URI

https://(子域名).cybozu.cn/v1/users/services.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个字符或以下

禁止仅输入空或空白字符

services数组必须

服务代码

空数组时,删除code中指定的用户的使用服务。

可指定的值如下。

  • kintone

  • garoon

  • office

  • mailwise

  • secure_access

请求范例

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


应答

成功时返回以下应答。

{}

代码范例

用curl发送请求的范例 :

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

访问权限

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

限制事项

  • 与通过CSV导入用户所使用服务的处理或与在页面上手动添加用户所使用服务的处理发生冲突时,按照导入的顺序依次处理。

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