1. 开发集成
  2. /
  3. 标准 Web 应用
  4. /
  5. Go
  6. /

  7. 管理模块

  8. /

  9. 用户管理

  10. /
  11. 强制下线用户

强制下线用户

更新时间: 2024-10-10 07:28:40
编辑

通过用户 ID、App ID 列表，强制让用户下线，可以选择指定用户 ID 类型等。

请求参数

名称类型必填默认值描述示例值
appIdsstring[]是-APP ID 列表。["62188e71cxxxx3075289c580"]
userIdstring是-用户 ID。
optionsKickUsersOptionsDto否-可选参数。{"userIdType":"user_id"}

示例代码

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.kickUsers(
      dto.KickUsersDto {
          UserId: "undefined",
          AppIds: []string{"62188e71cxxxx3075289c580",},
        Options: dto.KickUsersOptionsDto {
                          UserIdType: KickUsersOptionsDto.userIdType.USER_ID,
        },
    }
  )
}

请求响应

类型： IsSuccessRespDto

名称类型描述
statusCodenumber业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
messagestring描述信息
apiCodenumber细分错误码，可通过此错误码得到具体的错误类型。
dataIsSuccessDto操作是否成功

示例结果：

{
  "statusCode": 200,
  "message": "操作成功",
  "apiCode": 20001,
  "data": {
    "success": true
  }
}

数据结构

KickUsersOptionsDto

名称类型必填描述
userIdTypestring否用户 ID 类型，可以指定为用户 ID、手机号、邮箱、用户名和 externalId。。 枚举值：user_id,external_id,phone,email,username

IsSuccessDto

名称类型必填描述
successboolean是操作是否成功。 示例值： true