接口调用说明
此页面上的所有端点都以BaseUrl为首拼接,您的baseUrl如下所示:
https://${yourXAuthDomain}
SSWS Token:
请求以下的API需要包含api_token, 通过管理员登录XAuth的控制台,【API】-【Token】-【创建token】来创建调用管理API的Token
查看指定组织的的所有成员列表
GET ${baseUrl}/api/v1/account/org/:orgId/member
查看指定组织的的所有成员信息。
请求示例
curl -X 'GET' \
'http://${yourXAuthDomain}/api/v1/account/org/:orgId/member' \
-H 'accept: application/json' \
-H 'Authorization: SSWS ${api_token}' \
-d 'orgId:string'\
参数 | 描述 | 是否必填 | 类型 |
---|---|---|---|
orgId | 组织ID | 是 | String |
响应示例
{
"count": 2,
"members": [
{
"id": "Aba9StQ6",
"account": "6218",
"displayName": "金娟",
"wayToAdd": {
"fromRule": []
},
"status": 7,
"depIds": [
"33rprD4b"
],
"lastUpdated": "2022-07-19T07:33:36.361717",
"created": "2022-07-19T07:33:36.361750"
},
{
"id": "Suojdvnc",
"account": "9232",
"displayName": "杜磊",
"wayToAdd": {
"fromRule": []
},
"status": 7,
"depIds": [
"33rprD4b"
],
"lastUpdated": "2022-07-19T07:33:36.361717",
"created": "2022-07-19T07:33:36.361750"
}
]
}
查看组织下的部门树
GET ${baseUrl}/api/v1/account/org/{orgId}/tree
获取指定组织树(未包含成员), 仅包含部门的信息,不包含部门人员信息
请求示例
curl -X 'GET' \
'https://${yourXAuthDomain}/api/v1/account/org/:orgId/tree' \
-H 'accept: application/json' \
-H 'Authorization: SSWS ${api_token}' \
-d 'orgId:string'
参数 | 描述 | 是否必填 | 类型 |
---|---|---|---|
orgId | 组织ID | 是 | String |
响应示例
{
"levelCount": 5,
"treeStruct": [
{
"parentId": "",
"name": "财务部",
"depId": "n5BMXigF",
"originId": ""
},
{
"parentId": "",
"name": "测试部门2",
"depId": "4ZQLCppB",
"originId": ""
},
{
"parentId": "",
"name": "测试部门",
"depId": "XfTdfEYT",
"originId": ""
},
{
"parentId": "",
"name": "798978789456",
"depId": "ZtaHtEQz",
"originId": ""
},
{
"parentId": "4ZQLCppB",
"name": "1",
"depId": "mmWJaVUC",
"originId": ""
}
]
}
参数 | 描述 | 类型 |
---|---|---|
levelCount | 部门数量 | String |
name | 部门的名字 | String |
originId | 外部Id | Sting |
parentId | 父部门节点的部门Id | String |
depId | 部门名称 | String |