Employee Identity (EIAM)
Query Public Account Users
Interface
# Permissions {/permissions/}
The Identity Management API is authorized at the application dimension. Before calling the 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 permissions for account management interfaces |
| all | Read and write permissions for all interfaces |
| read | Permissions for all read interfaces |
# Request Specification {/request-specification/}
GET https://{your_domain}/api/v2/tenant/applications/{app_id}/accounts/public-account/{app_user_id}/users?offset=0&limit=10
# Request Headers {/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 {/request-example/}
None
# Request Parameters {/request-parameters/}
| Parameter Name | Chinese Name | Required | Type | Description |
|---|---|---|---|---|
| app_id | Application ID | Yes | String | Target application id |
| app_user_id | Application Account ID | Yes | String | |
| offset | Page Number | Yes | Int | Starts from page 0 |
| limit | Items Per Page | Yes | Int | Items per page should be between 10 and 100 |
# Response Example
Correct Example:
HTTP/1.1 200 OK
{
"total": 1,
"associated_users": [
{
"id": "20220331164602949-904C-D475B60AE",
"userName": "zhangsan",
"disabled": false
}
]
}
Error Example:
HTTP/1.1 400 Bad Request
{
"error_code": " APP.ACCOUNT.0038",
"error_msg": "Public account does not exist"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
# Response Parameters
| Parameter Name | Chinese Name | Type | Description |
|---|---|---|---|
| total | Total Count | Int | |
| associated_users | User Collection | List | |
| -- id | User ID | String | |
| -- userName | Username | String | |
| -- disabled | Disabled Status | Boolean |
# Error Codes
| Status Code | Error Code | Error Message | Handling Action |
|---|---|---|---|
| 400 | APP.ACCOUNT.0038 | 公共账号不存在 | 请检查公共账号是否存在 |
| Public account does not exist | |||
| 400 | OAP.PAGE.0002 | 分页参数超过限制 | 请检查分页参数是否正确 |
| Pagination parameter exceeds limit |
