IDaaS Open Platform
Employee Identity (EIAM)

Get Application Account List

Interface

# Permissions

The Identity Management API is authorized at the application level. Before calling an interface, you need to set interface permissions for different applications. For details, please refer to API Permissions.

Permission Code Description
account_all Read and write permissions for account management interfaces
account_read Read permission for account management interfaces
all Read and write permissions for all interfaces
read Permission for all read interfaces

# Request Specification

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

# Request Headers

Parameter Name Chinese Name Required Type Description
Authorization Authorization Yes String Format: Bearer {access_token}
Content-Type Content Type Yes String Fixed value: application/json; charset=utf-8

# Request Example

None

# Request Parameters

Parameter Name Chinese Name Required Type Description
app_id Application ID Yes String Target application id
account_type Account Type No String Fixed value: Basic Account (BASIC_ACCOUNT), Orphan Account (ORPHAN_ACCOUNT), Public Account (PUBLIC_ACCOUNT). Leave blank to query all.
offset Page Offset Yes Int Starting from page 0
limit Page Size Yes Int Page size between 10-100

# Return Example

Success Example:
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"
        }
    ]
}


Error Example:
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

# Return Parameters

Parameter Name Chinese Name Type Description
total Total Count Int
accounts Application Account Collection List
-- id Application Account ID String
--account_name Application Account Name String
--name Name String
--org_id Application Organization ID String
--disabled Disabled or Not Boolean
--account_type Account Type String
--attr_manager_id Direct Superior String Application Account ID
--extension Extension Field Object

# Error Codes

Status Code Error Code Error Message Handling Measures
400 APP.ACCOUNT.0045 The account type of the account is incorrect Please check if the type of the application account is correct
The account type of the account is incorrect
500 COM.0002 System error System error
System error, please contact the administrator

Get Application Account Info