查询用户角色 - QueryUserRole

功能介绍

查询用户角色接口。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。

URI

GET /basic/mgmt/public/api/v1/sysmgr/roles

请求参数

表1 请求Header参数
参数	是否必选	参数类型	描述
Authorization	是	String	JWTToken

表2 路径参数
参数	是否必选	参数类型	描述
tenantId	是	String	租户ID
userName	是	String	用户名称
userId	否	String	用户ID

请求示例

GET basic/mgmt/public/api/v1/sysmgr/roles?userName=sysadmin&tenantId=9190086000001150600&userId=1008600000089987983

响应参数

状态码： 200

表3 响应Body参数
参数	参数类型	描述
error_code	String	返回码
error_msg	String	返回码描述
totalCount	Long	返回数据总条数
reserve	String	保留字段
datas	Array of UserRoleTeam	用户的角色及团队

表4 UserRoleTeam
参数	参数类型	描述
userRoles	Array of Role	角色数组
userTeams	Array of Team	团队数组

表5 Role
参数	参数类型	描述
id	Long	角色ID
description	String	中文描述
name	String	中文名称
descriptionEn	String	英文描述
nameEn	String	英文名称
roleType	String	角色类型

表6 Team
参数	参数类型	描述
teamId	Long	团队角色ID
teamName	String	团队角色名称
teamRoles	Arrays for TeamRole	团队角色集合

表7 TeamRole
参数	参数类型	描述
id	Long	团队角色ID
name	String	团队角色名称
description	String	描述
roleType	String	角色类型：teamRole
description_en	String	英文描述
name_en	String	团队角色英文名称

响应示例

{
    "reserve": null,
    "datas": {
        "userRoles": [
            {
                "id": -1,
                "description": "系统管理员",
                "name": "系统管理员",
                "roleType": "globalRole",
                "description_en": "",
                "name_en": "sysadmin"
            },
            {
                "id": -4,
                "description": "合作伙伴管理员",
                "name": "合作伙伴管理员",
                "roleType": "globalRole",
                "description_en": "",
                "name_en": "partneradmin"
            }

        ],
        "userTeams": [
            {
                "teamId": "662706318057934848",
                "teamName": "team001",
                "teamRoles": [
                    {
                        "id": 681912501788483584,
                        "description": "",
                        "name": "test0009",
                        "roleType": "teamRole",
                        "description_en": "",
                        "name_en": "test0009"
                    }
                ]
            },
            {
                "teamId": "681912555060338688",
                "teamName": "test0009",
                "teamRoles": [
                    {
                        "id": 681912501788483584,
                        "description": "",
                        "name": "test0009",
                        "roleType": "teamRole",
                        "description_en": "",
                        "name_en": "test0009"
                    }
                ]
            }
        ]
    },
    "totalCount": null,
    "error_code": "IPDC.01020000",
    "error_msg": "success"
}