更新用户所属组API(JSON)
以JSON格式更新用户所属组信息。
HTTP 方法
PUT
URI
https://{sub-domain}.cybozu.cn/v1/user/groups.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
请求正文
参数名称 | 要指定的值 | 必须 | 说明 |
---|---|---|---|
code | 字符串 | 必须 | 登录名 128个字符或以下 禁止仅输入空或空白字符 |
groups | 数组 | 必须 | 用户所属组信息列表 最多可指定 1000 个。 更新用户的所属组时,必须指定现有用户所属的所有 groups。 groups 中未指定的组织将从用户的所属组中删除。 指定为空数组时,用户的所属组变为未所属。 |
请求正文范例
{ "code": "user1", "groups": [ "group1", "group2" ] }
应答
成功时,返回以下应答。
{ }
代码范例
用curl发送请求的范例 :
curl -X PUT 'https://sample.cybozu.cn/v1/user/groups.json' \ -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \ -H 'Content-Type: application/json' \ -d '{ "code": "fei-chen", "groups": ["recruit2022", "recruit2023"] }'
访问权限
只有 cybozu.cn 共通管理员 才能执行。
限制事项
CSV 对用户的所属组织更新和处理重叠时,应按写入顺序进行操作。
如果此 API 与 CSV 加载或用户编辑页面中的修改顺序重叠,则 CSV 加载可能会覆盖 API 中的数据,并可能导致死锁错误。
由于此 API 不锁定,因此不建议并行执行此 API 更新、CSV 导入和从通用页面处更新用户的操作。