跳到主要内容

查询企业角色列表

1. 接口描述​

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

查询企业角色列表

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeIntegrationRoles。
Version是String公共参数，本接口取值：2020-11-11。
Region否String公共参数，本接口不需要传递此参数。
Operator是UserInfo操作人信息
Limit是Integer返回最大数量，最大为200
Agent否Agent代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
Filters.N否Array of Filter查询的关键字段:
Key:"RoleType",Values:["1"]查询系统角色，Values:["2"]查询自定义角色
Key:"RoleStatus",Values:["1"]查询启用角色，Values:["2"]查询禁用角色
Key:"IsGroupRole"，Values:["0"],查询非集团角色，Values:["1"]表示查询集团角色
Offset否Integer偏移量，默认为0，最大为2000

3. 输出参数​

参数名称类型描述
OffsetInteger偏移量，默认为0，最大为2000
LimitInteger返回最大数量，最大为200
TotalCountInteger符合查询条件的总的角色数
IntegrateRolesArray of IntegrateRole企业角色信息列表
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 示例-主代子查询​

示例-主代子查询

输入示例​

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

{
    "Filters": [
        {
            "Key": "RoleType",
            "Values": [
                "1"
            ]
        }
    ],
    "Agent": {
        "ProxyOrganizationId": "y**********************J"
    },
    "Operator": {
        "ClientIp": "0.0.0.1",
        "UserId": "y******************5",
        "Channel": "YUFU"
    },
    "Limit": 1,
    "Offset": 0
}

输出示例​

{
    "Response": {
        "IntegrateRoles": [
            {
                "IsGroupRole": false,
                "RoleId": "c*************************b",
                "RoleName": "超级管理员",
                "RoleStatus": 1,
                "SubOrgIdList": []
            }
        ],
        "Limit": 1,
        "Offset": 0,
        "RequestId": "s************************1",
        "TotalCount": 8
    }
}

示例2 示例-普通企业查询​

示例-普通企业查询

输入示例​

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

{
    "Filters": [
        {
            "Key": "RoleType",
            "Values": [
                "1"
            ]
        }
    ],
    "Operator": {
        "ClientIp": "0.0.0.1",
        "UserId": "y******************5",
        "Channel": "YUFU"
    },
    "Limit": 5,
    "Offset": 0
}

输出示例​

{
    "Response": {
        "IntegrateRoles": [
            {
                "IsGroupRole": false,
                "RoleId": "b4******************bf",
                "RoleName": "超级管理员",
                "RoleStatus": 1,
                "SubOrgIdList": []
            },
            {
                "IsGroupRole": false,
                "RoleId": "1**********************1",
                "RoleName": "企业印章管理员",
                "RoleStatus": 1,
                "SubOrgIdList": []
            },
            {
                "IsGroupRole": false,
                "RoleId": "2*********************0",
                "RoleName": "部门业务管理员",
                "RoleStatus": 1,
                "SubOrgIdList": []
            },
            {
                "IsGroupRole": false,
                "RoleId": "3**************************c",
                "RoleName": "业务员",
                "RoleStatus": 1,
                "SubOrgIdList": []
            },
            {
                "IsGroupRole": false,
                "RoleId": "a******************************9",
                "RoleName": "企业合同管理员",
                "RoleStatus": 1,
                "SubOrgIdList": []
            }
        ],
        "Limit": 5,
        "Offset": 0,
        "RequestId": "s*******************",
        "TotalCount": 13
    }
}

5. 开发者资源​

腾讯云 API 平台​

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

API Inspector​

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

SDK​

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

命令行工具​

6. 错误码​

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

错误码描述
InternalError内部错误。
InternalError.Db数据库异常。
InvalidParameter参数错误。
InvalidParameter.LimitLimit参数超出最大限制
InvalidParameter.Offset参数Offset不正确
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。