集团账号管理获取企业组织信息-组织设置相关接口-API 中心-腾讯云

1. 接口描述

接口请求域名： organization.tencentcloudapi.com 。

获取企业组织信息

默认接口请求频率限制：40次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeOrganization。
Version	是	String	公共参数，本接口取值：2021-03-31。
Region	否	String	公共参数，本接口不需要传递此参数。
Lang	否	String	国际站：en，国内站：zh 示例值：en
Product	否	String	可信服务产品简称。查询是否该可信服务管理员时必须指定示例值：test

3. 输出参数

参数名称	类型	描述
OrgId	Integer	企业组织ID。注意：此字段可能返回 null，表示取不到有效值。示例值：1234
HostUin	Integer	创建者UIN。注意：此字段可能返回 null，表示取不到有效值。示例值：10001
NickName	String	创建者昵称。注意：此字段可能返回 null，表示取不到有效值。示例值：test
OrgType	Integer	企业组织类型。注意：此字段可能返回 null，表示取不到有效值。示例值：1
IsManager	Boolean	是否组织管理员。是：true ，否：false 注意：此字段可能返回 null，表示取不到有效值。示例值：true
OrgPolicyType	String	策略类型。财务管理：Financial 注意：此字段可能返回 null，表示取不到有效值。示例值：Finical
OrgPolicyName	String	策略名。注意：此字段可能返回 null，表示取不到有效值。示例值：财务策略
OrgPermission	Array of OrgPermission	成员财务权限列表。注意：此字段可能返回 null，表示取不到有效值。
RootNodeId	Integer	组织根节点ID。注意：此字段可能返回 null，表示取不到有效值。示例值：100
CreateTime	String	组织创建时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2021-03-12 12:00:00
JoinTime	String	成员加入时间。注意：此字段可能返回 null，表示取不到有效值。示例值：2021-03-12 12:00:00
IsAllowQuit	String	成员是否允许退出。允许：Allow，不允许：Denied 注意：此字段可能返回 null，表示取不到有效值。示例值：Allow
PayUin	String	代付者Uin。注意：此字段可能返回 null，表示取不到有效值。示例值：""
PayName	String	代付者名称。注意：此字段可能返回 null，表示取不到有效值。示例值：""
IsAssignManager	Boolean	是否可信服务管理员。是：true，否：false 注意：此字段可能返回 null，表示取不到有效值。示例值：false
IsAuthManager	Boolean	是否实名主体管理员。是：true，否：false 注意：此字段可能返回 null，表示取不到有效值。示例值：false
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取组织详情

输入示例

POST / HTTP/1.1
Host: organization.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganization
<公共请求参数>

{}

输出示例

{
    "Response": {
        "CreateTime": "2021-04-15 21:07:54",
        "JoinTime": "2021-04-15 21:07:54",
        "HostUin": 100000546922,
        "IsManager": true,
        "NickName": "",
        "OrgId": 13,
        "OrgPermission": [
            {
                "Id": 1,
                "Name": "允许主账号查看子账号的消费信息"
            },
            {
                "Id": 2,
                "Name": "允许主账号查看子账号的财务信息"
            },
            {
                "Id": 3,
                "Name": "允许主账号划拨资金给子账号"
            },
            {
                "Id": 4,
                "Name": "允许主账号对子账号的账单合并出账"
            },
            {
                "Id": 5,
                "Name": "允许主账号代子账号开票"
            }
        ],
        "OrgPolicyName": "财务管理",
        "OrgPolicyType": "Financial",
        "OrgType": 1,
        "RootNodeId": 1001,
        "IsAllowQuit": "Allow",
        "PayUin": "",
        "PayName": "",
        "IsAssignManager": false,
        "IsAuthManager": false,
        "RequestId": "e5c09721-236b-4a55-a5d1-0513ac506245"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.OperateBillingPermissionErr	操作计费侧成员权限错误。
InternalError	内部错误。
InvalidParameter	参数错误。
ResourceNotFound.OrganizationNotExist	企业组织不存在。