Employee Identity (EIAM)
Query Organization Information by Organization ID
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 |
|---|---|
| org_read | Read permission for organization management interfaces |
| all | Read and write permissions for all interfaces |
| read | Permission for all read interfaces |
# Request Description
GET https://{your_domain}/api/v2/tenant/organizations/{org_id}
# 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 |
|---|---|---|---|---|
| org_id | Organization ID | Yes | String | Organization ID |
# Response Example
Success Example:
HTTP/1.1 200 OK
{
"org_id": "20220412142914549-1E50-B49C521A4",
"parent_id": "20220412105608948-3B83-D566C6D94",
"name": "Test Organization 333",
"category": "department",
"org_code": "TestOrg2",
"sequence": 5,
"disabled": false,
"created_at": "2022-08-01 10:00:00.111",
"updated_at": "2024-08-30 14:37:24.610",
"extension": {
"uid": "123"
}
}
Error Example:
HTTP/1.1 400 Bad Request
{
"error_code": "ORG.0001",
"error_msg": "Organization does not exist"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# Response Parameters
| Parameter Name | Chinese Name | Type | Description |
|---|---|---|---|
| org_id | Organization ID | String | Organization ID |
| org_code | Organization Code | String | Organization Code |
| name | Organization Name | String | Organization Name |
| parent_id | Parent Node ID | String | Parent Node ID |
| category | Organization Type | String | Organization Type |
| sequence | Display Order | int | Display Order |
| disabled | Disabled Status | Boolean | Whether it is disabled |
| created_at | Organization Creation Time | String | Organization Creation Time |
| updated_at | Organization Modification Time | String | Organization Modification Time |
| extension | Extended Properties | Map | Extended properties, which need to be defined within the enterprise |
# Error Codes
| Status Code | Error Code | Error Message | Action |
|---|---|---|---|
| 400 | ORG.0001 | 组织不存在 | 请检查对应组织是否存在 |
| Organization does not exist |