员工身份(EIAM)
获取组织列表
接口
# 权限
身份管理API是以应用维度授权的，在调用接口前需为不同的应用设置接口权限，详情请参考API权限。
| 权限代码 | 描述 |
|---|---|
| org_read | 组织管理接口的读权限 |
| all | 全部接口读写权限 |
| read | 所有读接口的权限 |
# 请求说明
GET https://{your_domain}/api/v2/tenant/organizations?org_id=&all_child=false&offset=0&limit=10
# 请求头
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| Authorization | 授权 | 是 | String | 格式：Bearer {access_token} |
| Content-Type | 内容类型 | 是 | String | 固定值：application/json; charset=utf-8 |
# 请求示例
无
# 请求参数
| 参数名 | 中文名称 | 必须 | 类型 | 描述 |
|---|---|---|---|---|
| org_id | 组织id | 否 | String | 组织id |
| all_child | 是否获取子组织 | 否 | Boolean | 为true时只返回所有子组织；为false时只返回根组织 |
| updated_at_greater | 更新时间大于 | 否 | String | 根据更新时间过滤，更新时间在此之后的才会返回，格式为 yyyy-MM-dd HH:mm:ss |
| offset | 第几页 | 是 | Int | 第几页 |
| limit | 每页大小 | 是 | Int | 每页大小，10-100之间 |
# 返回示例
成功示例：
HTTP/1.1 200 OK
{
"total": 4,
"organizations": [
{
"org_id": "20220117125622909-9346-35755733F",
"parent_id": null,
"name": "sdk2e",
"category": "department",
"org_code": "10000",
"sequence": 5,
"disabled": false,
"created_at": "2022-08-01 10:00:00.111",
"updated_at": "2024-08-30 14:37:24.610",
"extension": {
"uid": "123"
}
},
{
"org_id": "20220412105608948-3B83-D566C6D94",
"parent_id": null,
"name": "测试机构1",
"category": "department",
"org_code": "TestOrg1",
"sequence": 5,
"disabled": false,
"created_at": "2022-08-01 10:00:00.111",
"updated_at": "2024-08-30 14:37:24.610",
"extension": {
"uid": "123"
}
},
{
"org_id": "20220412165706419-33A2-C80A351C1",
"parent_id": null,
"name": "测试机构2",
"category": "department",
"org_code": "TestOrg2",
"sequence": 5,
"disabled": false,
"created_at": "2022-08-01 10:00:00.111",
"updated_at": "2024-08-30 14:37:24.610",
"extension": {
"uid": "123"
}
},
{
"org_id": "20220331135144180-0FA5-EE3B69068",
"parent_id": null,
"name": "a",
"category": "department",
"org_code": "a",
"sequence": 5,
"disabled": false,
"created_at": "2022-08-01 10:00:00.111",
"updated_at": "2024-08-30 14:37:24.610",
"extension": {
"uid": "123"
}
}
]
}
错误示例：
HTTP/1.1 400 Bad Request
{
"error_code": "ORG.0001",
"error_msg": "组织不存在"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# 返回参数
| 参数名 | 中文名称 | 类型 | 描述 |
|---|---|---|---|
| total | 总数 | Int | 总数 |
| organizations | 组织集合 | List | 组织集合 |
| --org_id | 组织id | String | 组织id |
| --org_code | 组织code | String | 组织code |
| --name | 组织名称 | String | 组织名称 |
| --parent_id | 父节点id | String | 父节点id |
| --category | 组织类型 | String | 组织类型 |
| --sequence | 显示顺序 | int | 显示顺序 |
| --disabled | 是否已禁用 | Boolean | 是否已禁用 |
| --created_at | 组织创建时间 | String | 组织创建时间 |
| --updated_at | 组织修改时间 | String | 组织修改时间 |
| --extension | 扩展属性 | Map | 扩展属性，扩展的属性需要在企业中定义 |
# 错误码
| 状态码 | 错误码 | 错误信息 | 处理措施 |
|---|---|---|---|
| 400 | ORG.0001 | 组织不存在 | 请检查对应组织是否存在 |
| Organization does not exist | |||
| 400 | OAP.PAGE.0003 | 分页页码不符合校验规则 | 请检查入参分页页码是否正确 |
| The pagination page number does not meet the verification rules |