集团账号管理获取企业组织成员列表-API 文档-文档中心-腾讯云

1. 接口描述

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

获取企业组织成员列表

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeOrganizationMembers。
Version	是	String	公共参数，本接口取值：2021-03-31。
Region	否	String	公共参数，本接口不需要传递此参数。
Offset	是	Integer	偏移量。取值是limit的整数倍，默认值 : 0 示例值：0
Limit	是	Integer	限制数目。取值范围：1~50，默认值：10 示例值：10
Lang	否	String	国际站：en，国内站：zh 示例值：zh
SearchKey	否	String	成员名称或者成员ID搜索。示例值：member_name
AuthName	否	String	主体名称搜索。示例值：auth_name
Product	否	String	可信服务产品简称。可信服务管理员查询时必须指定示例值：config
Tags.N	否	Array of Tag	成员标签搜索列表，最大10个示例值：[{"TagKey":"key"}]

3. 输出参数

参数名称	类型	描述
Items	Array of OrgMember	成员列表。示例值：[{"CreateTime":"2021-04-17 12:19:07","MemberType":"Invite","MemberUin":111111111111,"Name":"member_name","NodeId":101,"NodeName":"node_name","IsAllowQuit":"Denied","OrgPermission":[{"Id":1,"Name":"允许主账号查看子账号的消费信息"},{"Id":2,"Name":"允许主账号查看子账号的财务信息"}],"OrgPolicyName":"财务管理","OrgPolicyType":"Financial","Remark":"member1","PayUin":"","PayName":"","OrgIdentity":[],"BindStatus":"Unbound","PermissionStatus":"Confirmed","UpdateTime":"2021-04-17 12:19:07"}]
Total	Integer	总数目。示例值：2
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取成员列表

获取成员列表

输入示例

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

{
    "Lang": "zh",
    "Limit": 10,
    "Offset": 0
}

输出示例

{
    "Response": {
        "Items": [
            {
                "CreateTime": "2021-04-17 12:19:07",
                "MemberType": "Invite",
                "MemberUin": 111111111111,
                "Name": "member_name",
                "NodeId": 101,
                "NodeName": "node_name",
                "IsAllowQuit": "Denied",
                "OrgPermission": [
                    {
                        "Id": 1,
                        "Name": "允许主账号查看子账号的消费信息"
                    },
                    {
                        "Id": 2,
                        "Name": "允许主账号查看子账号的财务信息"
                    }
                ],
                "OrgPolicyName": "财务管理",
                "OrgPolicyType": "Financial",
                "Remark": "member1",
                "PayUin": "",
                "PayName": "",
                "OrgIdentity": [],
                "BindStatus": "Unbound",
                "PermissionStatus": "Confirmed",
                "UpdateTime": "2021-04-17 12:19:07"
            }
        ],
        "RequestId": "a0fe0702-5757-4aa4-8872-74b70a4c1b7a",
        "Total": 1
    }
}

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.OrganizationNodeNotExist	组织节点不在。
ResourceNotFound.OrganizationNotExist	企业组织不存在。
ResourceNotFound.OrganizationServiceNotExist	集团服务不存在。