员工身份(EIAM)

获取应用机构列表

接口

# 权限

身份管理API是以应用维度授权的,在调用接口前需为不同的应用设置接口权限,详情请参考API权限

权限代码 描述
app_org_all 应用机构管理接口的读写权限
app_org_read 应用机构管理接口的读权限
all 全部接口读写权限
read 所有读接口的权限

# 请求说明

GET https://{your_domain}/api/v2/tenant/applications/{app_id}/organizations?&offset=0&limit=10

# 请求头

参数名 中文名称 必须 类型 描述
Authorization 授权 String 格式:Bearer {access_token}
Content-Type 内容类型 String 固定值:application/json; charset=utf-8

# 请求示例

# 请求参数

参数名 中文名称 必须 类型 描述
app_id 应用ID String 目标应用ID

# 返回示例

成功示例:
HTTP/1.1 201 Created
Content-Type: application/json
{
    "total": 1,
    "organizations": [
        {
            "org_id": "20220414151855146-A153-62C1A994C",
            "org_code": "xnjg",
            "name": "虚拟机构1",
            "parent_id": null,
            "disabled": false,
            "extension": {
                "uid": "123"
            }
        }
    ]
}


错误示例:
HTTP/1.1 400 Bad Request
{
    "error_code": " OAP.PAGE.0003",
    "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

# 返回参数

参数名 中文名称 类型 描述
total 总数 Int
organizations 应用机构集合 List
-- org_id 应用机构ID String
-- org_code 应用机构code String
-- name 应用机构名称 String
--parent_id 父节点ID String
--disabled 是否已禁用 Boolean
--extension 扩展属性 Map

# 错误码

状态码 错误码 错误信息 处理措施
400 OAP.PAGE.0003 分页页码不符合校验规则 请检查分页参数是否正确
The pagination page number does not meet the verification rules