导入组API

aki发表于:2019年11月05日 11:03:30更新于:2021年12月03日 16:42:16

Index

导入组 API(CSV)

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

HTTP 方法

POST

URI

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

应答

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

{
    "id": 1
}

CSV文件的格式

请参考组信息 CSV

访问权限

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

注意事项

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

  • 项目数量必须一致。多了或少了导入时都将报错。


导入组 API(JSON)

添加组

添加以 JSON 格式指定的组。

HTTP 方法

POST

URI

https://(子域名).cybozu.cn/v1/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

请求正文

groups数组一次最多可以指定100个。

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

组代

128个字符或以下

禁止仅输入空或空白字符

name字符串必须

128个字符或以下

禁止仅输入空或空白字符

type
字符串必须

可以指定的值如下
  •  static

  •  dynamic

description字符串

说明

1000个字符或以下

若省略,则为空字符。

请求正文范例

{
    "groups": [
        {
            "code": "group1",
            "name": "group1",
            "type": "static",
            "description": "test group"
        },
        {
            "code": "group2",
            "name": "group2",
            "type": "dynamic",
            "description": ""
        }
    ]
}

应答

成功时,将返回以下应答。

{ }

访问权限

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

注意事项

  • 当加载 CSV 、添加处理组重叠时,应按写入顺序进行添加。

  • 由于此 API 未锁定,因此不建议从此 API / CSV 加载 / 通用页面执行组操作。


更新组

更新以 JSON 格式指定的组。

HTTP 方法

PUT

URI

https://(子域名).cybozu.cn/v1/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

请求正文

groups数组一次最多可以指定100个。

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

组代码

128个字符或以下

禁止仅输入空或空白字符

name字符串

组名

128个字符或以下

禁止仅输入空或空白字符

description字符串

说明

1000个字符或以下

若省略或指定 null,则不会更新。

请求正文范例

{
    "groups": [
        {
            "code": "group1",
            "description": "group description update"
        },
        {
            "code": "group2",
            "name": "group2_update"
        },
        {
            "code": "group3",
            "name": "group3_update",
            "description": "group description update"
        }
    ]
}

应答

成功时,将返回以下应答。

{ }

访问权限

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

注意事项

  • 当加载 CSV 、添加处理组重叠时,应按写入顺序进行添加。

  • 由于此 API 未锁定,因此不建议从此 API / CSV 加载 / 通用页面执行组操作。

  • 无法更改现有组的组类型。


删除组

刪除以 JSON 格式指定的组。

HTTP 方法

DELETE

URI

https://(子域名).cybozu.cn/v1/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

请求正文

参数名称要指定的值必须说明
codes数组(字符串)必须

想要删除的组代码列表

可以指定1~100条。

值的前后不会被 trim() 。

请求正文范例

{    
    "codes": [    
        "group1",    
        "group2"    
    ]    
}

应答

成功时,将返回以下应答。

{ }

访问权限

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

注意事项

  • 内置组(“Everyone”“Administrators”)不能被删除。

  • 当加载 CSV 、添加处理组重叠时,应按写入顺序进行添加。

  • 由于此 API 未锁定,因此不建议从此 API / CSV 加载 / 通用页面执行组操作。



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