员工身份(EIAM)

获取应用账号列表

接口

# 权限

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

权限代码 描述
account_all 账户管理接口的读写权限
account_read 账户管理接口的读权限
all 全部接口读写权限
read 所有读接口的权限

# 请求说明

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

# 请求头

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

# 请求示例

# 请求参数

参数名 中文名称 必须 类型 描述
app_id 应用ID String 目标应用id
account_type 账号类型 String 固定值,合规账号(BASIC_ACCOUNT),孤儿账号(ORPHAN_ACCOUNT),公共账号(PUBLIC_ACCOUNT),不填查询所有
offset 分页页码 Int 从第0页开始
limit 每页数量 Int 每页数量在10-100之间

# 返回示例

正确示例:
HTTP/1.1 200 OK
{
    "total": 2,
    "accounts": [
        {
            "account_type": "BASIC_ACCOUNT",
            "extension": {},
            "org_id": null,
            "account_name": "zhangs",
            "name": "zs",
            "disabled": false,
            "attr_manager_id": "20230309180237515-A43K-CD390B5C8"
            "id": "20220414163425614-2FD6-CA9B208BE"
        },
        {
            "account_type": "ORPHAN_ACCOUNT",
            "extension": {},
            "org_id": null,
            "account_name": "example01",
            "name": "cq04130006",
            "disabled": false,
            "attr_manager_id": "20230309171558023-84A4-ED5C390B8"
            "id": "20220414103145123-C349-6B6D9C126"
        }
    ]
}


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

# 返回参数

参数名 中文名称 类型 描述
total 总数 Int
accounts 应用账号集合 List
-- id 应用账号ID String
--account_name 应用账号名 String
--name 名称 String
--org_id 应用组织ID String
--disabled 是否禁用 Boolean
--account_type 账号类型 String
--attr_manager_id 直属上级 String 应用账号id
--extension 扩展字段 Object

# 错误码

状态码 错误码 错误信息 处理措施
400 APP.ACCOUNT.0045 账号的账号类型错误 请检查应用账号的类型是否正确
The account type of the account is incorrect
500 COM.0002 系统错误 系统错误
System error, please contact the administrator