导出用户的所属组织API

aki发表于:2019年11月14日 10:00:18更新于:2023年04月28日 15:36:28

导出用户的所属组织API(JSON)

此API用于通过JSON格式获取用户的所属组织以及该组织下的用户的职务列表。

HTTP 方法

GET

URI

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

请求头部

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

请求参数

参数名称类型必须说明
code字符串必须用户代码

通过HTTP的查询字符串发送参数时

查询字符串
code=user1
包含请求头部的字符串
GET /v1/user/organizations.json?code=user1 HTTP/1.1
Host: example.cybozu.cn:443
X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=
Authorization: Basic QWRtaW5pc3RyYXRvcjpjeWJvenU=
  • Content-Type头部不需要。

应答

key类型内容
organizationTitlesorganizationTitle类型数组用户的所属组织及职务的列表
{    
    "organizationTitles":[    
        {    
            "organization":{    
                "code":"B",    
                "description":"组织B",    
                "id":"2",    
                "localName":"B总部",    
                "localNameLocale":"zh",    
                "name":"组织B",    
                "parentCode":"A"    
            },    
            "title":{    
                "code":"leader",    
                "description":"带领团队",    
                "id":"1",    
                "name":"领导"    
            }    
        }    
    ]    
}

代码范例

用curl发送请求的范例 :

curl -X PUT 'https://sample.cybozu.cn/v1/userOrganizations.json' \
  -H 'X-Cybozu-Authorization: QWRtaW5pc3RyYXRvcjpjeWJvenU=' \
  -H 'Content-Type: application/json' \
  -d '{
    "userOrganizations": [
      {
        "code": "fei-chen",
        "organizations": [
          {
            "orgCode": "Sales01",
            "titleCode": "TeamLeader"
          }
        ]
      }
    ]
  }'

访问权限

所有用户均可访问。

※kintone的来宾用户不可访问。