Employee Identity (EIAM)
Get Application Organization List
Interface
# Permissions
The Identity Management API is authorized at the application level. Before calling the interface, you need to set interface permissions for different applications. For details, please refer to API Permissions.
| Permission Code | Description |
|---|---|
| app_org_all | Read and write permissions for the application organization management interface |
| app_org_read | Read permissions for the application organization management interface |
| all | Read and write permissions for all interfaces |
| read | Permissions for all read interfaces |
# Request Specification
GET https://{your_domain}/api/v2/tenant/applications/{app_id}/organizations?&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 |
# Response Example
Success Example:
HTTP/1.1 201 Created
Content-Type: application/json
{
"total": 1,
"organizations": [
{
"org_id": "20220414151855146-A153-62C1A994C",
"org_code": "xnjg",
"name": "Virtual Organization 1",
"parent_id": null,
"disabled": false,
"extension": {
"uid": "123"
}
}
]
}
Error Example:
HTTP/1.1 400 Bad Request
{
"error_code": " OAP.PAGE.0003",
"error_msg": "Pagination page number does not meet validation rules"
}
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
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
# Response Parameters
| Parameter Name | Chinese Name | Type | Description |
|---|---|---|---|
| total | Total Count | Int | |
| organizations | Application Organization Collection | List | |
| -- org_id | Application Organization ID | String | |
| -- org_code | Application Organization Code | String | |
| -- name | Application Organization Name | String | |
| --parent_id | Parent Node ID | String | |
| --disabled | Whether Disabled | Boolean | |
| --extension | Extension Properties | Map |
# Error Codes
| Status Code | Error Code | Error Message | Handling Measures |
|---|---|---|---|
| 400 | OAP.PAGE.0003 | 分页页码不符合校验规则 | 请检查分页参数是否正确 |
| The pagination page number does not meet the verification rules |
