¶ 获取用户角色列表
更新时间: 2024-10-10 07:28:40
通过用户 ID，获取用户角色列表，可以选择所属权限分组 code、选择指定用户 ID 类型等。
¶ 请求参数
| 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 |
|---|---|---|---|---|---|
| userId | string | 是 | - | 用户 ID。 | 6229ffaxxxxxxxxcade3e3d9 |
| userIdType | string | 否 | user_id | 用户 ID 类型，可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值：user_id,external_id,phone,email,username | user_id |
| namespace | string | 否 | - | 所属权限分组的 code。 | default |
¶ 示例代码
package main
import (
"github.com/Authing/authing-golang-sdk/management"
"github.com/Authing/authing-golang-sdk/dto"
"fmt"
)
func main() {
options := management.ClientOptions {
AccessKeyId: "AUTHING_USERPOOL_ID",
AccessKeySecret: "AUTHING_USERPOOL_SECRET",
}
client, err := management.NewClient(&options)
if err != nil {
// The exception needs to be handled by the developer.
}
response := client.getUserRoles(
userId: "6229ffaxxxxxxxxcade3e3d9" ,
userIdType: "user_id" ,
namespace: "default"
)
}
¶ 请求响应
类型： RolePaginatedRespDto
| 名称 | 类型 | 描述 |
|---|---|---|
| statusCode | number | 业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。 |
| message | string | 描述信息 |
| apiCode | number | 细分错误码，可通过此错误码得到具体的错误类型。 |
| data | RolePagingDto | 响应数据 |
示例结果：
{
"statusCode": 200,
"message": "操作成功",
"apiCode": 20001,
"data": {
"list": {
"code": "role1",
"description": "this is description",
"namespace": "default"
}
}
}
¶ 数据结构
¶ RolePagingDto
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| totalCount | number | 是 | 记录总数。 |
| list | array | 是 | 响应数据。嵌套类型：RoleDto。 |
¶ RoleDto
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | string | 是 | 权限分组内角色的唯一标识符。 示例值： role1 |
| description | string | 是 | 角色描述。 示例值： this is description |
| namespace | string | 是 | 所属权限分组的 code。 示例值： default |