¶ 强制下线用户
更新时间: 2024-10-10 07:28:40
通过用户 ID、App ID 列表,强制让用户下线,可以选择指定用户 ID 类型等。
¶ 请求参数
名称 | 类型 | 必填 | 默认值 | 描述 | 示例值 |
---|---|---|---|---|---|
appIds | string[] | 是 | - | APP ID 列表。 | ["62188e71cxxxx3075289c580"] |
userId | string | 是 | - | 用户 ID。 | |
options | KickUsersOptionsDto | 否 | - | 可选参数。 | {"userIdType":"user_id"} |
¶ 示例代码
using Authing.CSharp.SDK.Models;
using Authing.CSharp.SDK.Services;
using Authing.CSharp.SDK.Utils;
using Authing.CSharp.SDK.UtilsImpl;
using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
namespace Example
{
class Program
{
private static ManagementClientOptions options;
private static string ACCESS_Key_ID = "AUTHING_USERPOOL_ID";
private static string ACCESS_KEY_SECRET = "AUTHING_USERPOOL_SECRET";
static void Main(string[] args)
{
MainAsync().GetAwaiter().GetResult();
}
private static async Task MainAsync()
{
options = new ManagementClientOptions()
{
AccessKeyId = ACCESS_Key_ID,
AccessKeySecret = ACCESS_KEY_SECRET,
};
ManagementClient managementClient = new ManagementClient(options);
IsSuccessRespDto result = await managementClient.KickUsers
( new KickUsersDto{ UserId= "undefined" ,
AppIds= new List<string>{"62188e71cxxxx3075289c580",} ,
Options= new KickUsersOptionsDto
{
UserIdType= KickUsersOptionsDto.userIdType.USER_ID ,
},
}
);
}
}
}
¶ 请求响应
类型: IsSuccessRespDto
名称 | 类型 | 描述 |
---|---|---|
statusCode | number | 业务状态码,可以通过此状态码判断操作是否成功,200 表示成功。 |
message | string | 描述信息 |
apiCode | number | 细分错误码,可通过此错误码得到具体的错误类型。 |
data | IsSuccessDto | 操作是否成功 |
示例结果:
{
"statusCode": 200,
"message": "操作成功",
"apiCode": 20001,
"data": {
"success": true
}
}
¶ 数据结构
¶ KickUsersOptionsDto
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
userIdType | string | 否 | 用户 ID 类型,可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值:user_id ,external_id ,phone ,email ,username |
¶ IsSuccessDto
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
success | boolean | 是 | 操作是否成功。 示例值: true |