¶ 获取用户分组列表
更新时间: 2024-10-10 07:28:40
通过用户 ID，获取用户分组列表，可以选择指定用户 ID 类型等。
¶ 请求参数
| 名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 |
|---|---|---|---|---|---|
| userId | string | 是 | - | 用户 ID。 | 6229ffaxxxxxxxxcade3e3d9 |
| userIdType | string | 否 | user_id | 用户 ID 类型，可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值：user_id,external_id,phone,email,username | user_id |
¶ 示例代码
<?php
require 'vendor/autoload.php';
use Authing\ManagementClient;
$management = new ManagementClient(
"AUTHING_USERPOOL_ID",
"AUTHING_USERPOOL_SECRET"
);
$data = $management->getUserGroups(array(
"userId" => "6229ffaxxxxxxxxcade3e3d9",
"userIdType" => "user_id",
));
¶ 请求响应
类型： GroupPaginatedRespDto
| 名称 | 类型 | 描述 |
|---|---|---|
| statusCode | number | 业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。 |
| message | string | 描述信息 |
| apiCode | number | 细分错误码，可通过此错误码得到具体的错误类型。 |
| data | GroupPagingDto | 响应数据 |
示例结果：
{
"statusCode": 200,
"message": "操作成功",
"apiCode": 20001,
"data": {
"list": {
"code": "developer",
"name": "开发者",
"description": "描述内容"
}
}
}
¶ 数据结构
¶ GroupPagingDto
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| totalCount | number | 是 | 记录总数。 |
| list | array | 是 | 响应数据。嵌套类型：ResGroupDto。 |
¶ ResGroupDto
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | string | 是 | 分组 code。 示例值： developer |
| name | string | 是 | 分组名称。 示例值： 开发者 |
| description | string | 是 | 分组描述。 示例值： 描述内容 |