员工身份(EIAM)
根据组织code查询组织信息
接口
# 权限
身份管理API是以应用维度授权的,在调用接口前需为不同的应用设置接口权限,详情请参考API权限。
权限代码 | 描述 |
---|---|
org_read | 组织管理接口的读权限 |
all | 全部接口读写权限 |
read | 所有读接口的权限 |
# 请求说明
GET https://{your_domain}/api/v2/tenant/organizations/org-codes/{org_code}
# 请求头
参数名 | 中文名称 | 必须 | 类型 | 描述 |
---|---|---|---|---|
Authorization | 授权 | 是 | String | 格式:Bearer {access_token} |
Content-Type | 内容类型 | 是 | String | 固定值:application/json; charset=utf-8 |
# 请求示例
无
# 请求参数
参数名 | 中文名称 | 必须 | 类型 | 描述 |
---|---|---|---|---|
org_code | 组织code | 是 | String | 组织code |
# 返回示例
成功示例:
HTTP/1.1 200 OK
{
"org_id": "20220412142914549-1E50-B49C521A4",
"parent_id": "20220412105608948-3B83-D566C6D94",
"name": "测试机构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"
}
}
错误示例:
HTTP/1.1 400 Bad Request
{
"error_code": "ORG.0001",
"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
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
# 返回参数
参数名 | 中文名称 | 类型 | 描述 |
---|---|---|---|
org_id | 组织id | String | 组织id |
org_code | 组织code | String | 组织code |
name | 组织名称 | String | 组织名称 |
parent_id | 父节点id | String | 父节点id |
category | 组织类型 | String | 组织类型 |
sequence | 显示顺序 | int | 显示顺序 |
disabled | 是否已禁用 | Boolean | 是否已禁用 |
created_at | 组织创建时间 | String | 组织创建时间 |
updated_at | 组织修改时间 | String | 组织修改时间 |
extension | 扩展属性 | Map | 扩展属性,扩展的属性需要在企业中定义 |
# 错误码
状态码 | 错误码 | 错误信息 | 处理措施 |
---|---|---|---|
400 | ORG.0001 | 组织不存在 | 请检查对应组织是否存在 |
Organization does not exist |