Xsolla-logo

Pesquisar usuários por apelidoClient-side

get/users/search/by_nickname

Pesquisa usuários pelo parâmetro nickname e obtém uma lista deles. A pesquisa pode ser realizada instantaneamente quando o usuário começa a inserir o parâmetro de pesquisa.

O fluxo de trabalho de uso desta chamada:

  1. O usuário insere um apelido ou tag, ou apelido e tag.
  2. O servidor Xsolla Login procura usuários nos dados do projeto Login do usuário que iniciou uma pesquisa.

O usuário atual pode executar essa chamada apenas uma vez por segundo.

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

A cadeia de caracteres de pesquisa que pode conter:

  • somente apelido. A pesquisa é realizada por substring no início do apelido.
  • apenas tag, é usado com "#" no início. A pesquisa é executada por substring no início da tag.
  • apelido e tag juntos, é usado com "#" e sem espaço. A pesquisa é realizada por apelido completo e substring no início da tag.
offset
integer [ 0 .. 100 ]
Default: 0

Número dos elementos a partir dos quais a lista é gerada.

limit
integer [ 1 .. 100 ]
Default: 100

Número máximo de usuários retornados por vez.

Responses
200

OK

401

Desautorizado

422

Entidade não processável

429

Pedidos demais

Request samples
Response samples
application/json
{
  • "offset": 0,
  • "total_count": 0,
  • "users": [
    ]
}