导入用户所属组API

aki发表于:2019年11月05日 12:37:00更新于:2021年09月16日 10:19:13

Index

导入用户所属组API(CSV)

此API用于导入通过文件上传API上传的CSV文件里的用户所属组信息。

HTTP 方法

POST

URI

https://{sub-domain}.cybozu.cn/v1/csv/userGroups.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

请求正文

参数值要指定的值必须说明
fileKey字符串必须指定用文件上传API上传文件时返回的“fileKey”。
{    
    "fileKey": "c15b3870-7505-4ab6-9d8d-b9bdbc74f5d6"    
}

应答

应答中含有用确认结果API确认相应处理所需的处理结果ID 。

{    
    "id": 1    
}

CSV文件的格式

请参考用户的所属组信息CSV

访问权限

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

注意事项

  • CSV仅更新文件中记载的且跟系统中不一样的数据。 CSV中没有记载登录名的用户,不会进行更新或删除处理。

  • 如需要删除所有记载了登录名的用户的所属组,仅需要指定登录名。


导入用户所属组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"
 ]
}

应答

成功时,返回以下应答。

{ }

访问权限

只有  cybozu.cn 共通管理员 才能执行。

限制事项

  • CSV 对用户的所属组织更新和处理重叠时,应按写入顺序进行操作。

  • 如果此 API 与 CSV 加载或用户编辑页面中的修改顺序重叠,则 CSV 加载可能会覆盖 API 中的数据,并可能导致死锁错误。

  • 由于此 API 不锁定,因此不建议并行执行此 API 更新、CSV 导入和从通用页面处更新用户的操作。


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