通过 OpenAPI 查询组织部门信息。-云效(Alibaba Cloud DevOps)-阿里云帮助中心

通过 OpenAPI 查询组织部门信息。

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
组织管理	组织部门	只读

请求语法

中心版

GET https://{domain}/oapi/v1/platform/organizations/{organizationId}/departments/{id}

Region版

GET https://{domain}/oapi/v1/platform/departments/{id}

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是：中心版否：Region版	组织 ID。
id	string	path	是	部门 ID。

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/organizations/{organizationId}/departments/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/platform/departments/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数	类型	描述	示例值
-	object
creatorId	string	创建人 ID。	99d1****6124
hasSub	boolean	是否有子部门。	true
id	string	部门 ID。	99d1****6124
name	string	部门名称。	示例
organizationId	string	组织 ID。	99d1****6124
parentId	string	父部门 ID。	99d1****6124

返回示例

{
    "creatorId": "99d1****6124",
    "hasSub": true,
    "id": "99d1****6124",
    "name": "示例",
    "organizationId": "99d1****6124",
    "parentId": "99d1****6124"
}

错误码

访问错误码中心查看 API 相关错误码。