说明:
账户级接口属于仅账户管理员可以使用的接口,是重量级接口,查询的信息量比较大,访问限制:10次/min。
接口描述
描述:获取账户中的所有角色列表,目前暂不支持 OAuth2.0 鉴权访问。
支持的应用类型:自建应用。
请求方式:GET
自建应用权限点:查看企业角色,管理企业角色。
接口操作者权限点:用户管理 > 角色管理 > 查看权限、用户管理 > 角色管理 > 编辑权限,可登录 管理后台 查看。
接口请求域名:
https://api.meeting.qq.com/v1/corp/user-roles?page={page}&page_size={page_size}&operator_id={operator_id}&operator_id_type={operator_id_type}
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
page_size | 是 | Integer | 分页大小。 |
page | 是 | Integer | 当前页。 |
operator_id | 是 | String | 操作者 ID。 |
operator_id_type | 是 | Integer | 操作者 ID 类型。 1:userid |
输出参数
参数名称 | 参数类型 | 参数描述 |
current_page | Integer | 当前页。 |
current_size | Integer | 当前页实际大小。 |
total_count | Integer | 数据总条数。 |
total_page | Integer | 数据总页数。 |
user_role_list | UserRoleList 对象数组 | 角色对象列表。 |
UserRoleList 对象
参数名称 | 参数类型 | 参数描述 |
role_code | String | 角色 code。 |
role_name | String | 角色 name。 |
role_desc | String | 角色描述。 |
role_member_nu | String | 具备该角色的用户数。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
500 | 10 | 请求参数不合法。 |
示例
输入示例
GET /v1/corp/user-roles?page_size=20&page=1&operator_id=KM4Ss4Th09ogU*****&operator_id_type=1
输出示例
{"total_count":2,"total_page":1,"current_page":1,"current_size":2,"user_role_list":[{"role_code":"ADMIN_ROLE","role_name":"超级管理员","role_desc":"超级管理员拥有访问和管理企业账户的全部权限","role_member_nu":1},{"role_code":"MANAGER_ROLE","role_name":"管理员","role_desc":"管理员拥有访问和管理企业账户的广泛权限","role_member_nu":1}]}