¶ 判断用户是否存在

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

根据条件判断用户是否存在，可以筛选用户名、邮箱、手机号、第三方外部 ID 等。

¶ 请求参数

名称	类型	必填	默认值	描述	示例值
username	string	否	-	用户名，用户池内唯一。	`bob`
email	string	否	-	邮箱。	`test@example.com`
phone	string	否	-	手机号。	`188xxxx8888`
externalId	string	否	-	第三方外部 ID。	`10010`

¶ 示例代码

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.isUserExists(
      dto.IsUserExistsReqDto {
          Username: "bob",
          Email: "test@example.com",
          Phone: "188xxxx8888",
          ExternalId: "10010",
    }
  )
}

¶ 请求响应

类型： IsUserExistsRespDto

名称	类型	描述
statusCode	number	业务状态码，可以通过此状态码判断操作是否成功，200 表示成功。
message	string	描述信息
apiCode	number	细分错误码，可通过此错误码得到具体的错误类型。
data	IsUserExistsDto	响应数据

示例结果：

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

¶ 数据结构

¶ IsUserExistsDto

名称	类型	必填	描述
exists	boolean	是	用户是否存在。示例值： `true`