Xsolla-logo
  • 文档
  • 创建帐户

按昵称搜索用户Client-side

get/users/search/by_nickname

通过nickname参数搜索用户并获取他们的列表。用户开始输入搜索参数时,可以立即执行搜索。

此调用的使用流程:

  1. 用户输入昵称或标签,或昵称和标签。
  2. 艾克索拉登录管理器服务器在发起搜索的用户的登录管理器项目数据中搜索用户。

当前用户每秒只能执行一次此调用。

SecurityBearer
Request
query Parameters
nickname
required
string [ 3 .. 255 ] characters

可能包含以下内容的搜索字符串:

  • 仅昵称。搜索根据昵称开头的子字符串执行。
  • 仅标记,与“#”开头一起使用。搜索根据标签开头的子字符串执行。
  • 昵称和标签一起使用,与“#”一起使用,不带空格。搜索根据完整昵称和标签开头的子字符串执行。
offset
integer [ 0 .. 100 ]
Default: 0

生成列表的元素数。

limit
integer [ 1 .. 100 ]
Default: 100

一次返回的最大用户数。

Responses
200

确定

401

未授权

422

无法处理的实体

429

请求过多

Request samples
curl --request GET \
  --url 'https://login.xsolla.com/api/users/search/by_nickname?nickname=SOME_STRING_VALUE&offset=0&limit=100' \
  --header 'Authorization: Bearer BEARER_TOKEN'
Response samples
application/json
{
  • "offset": 3,
  • "total_count": 100,
  • "users": []
}