ニックネームでユーザーを検索する

ニックネームでユーザーを検索するClient-side

get/users/search/by_nickname

nicknameパラメータでユーザーを検索し、リストを取得します。ユーザーが検索パラメータの入力を開始すると、検索を即座に実行できます。

このコールを使用するワークフロー：

ユーザーは、ニックネームやタグ、またはニックネームとタグを入力します。
エクソラログインサーバーは、検索を開始したユーザーのログインプロジェクトデータでユーザーを検索します。

現在のユーザーは、このコールを1秒間に1回だけ実行することができます。

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": [{"avatar": "https://pbs.twimg.com/profile_images/874276177757336672/kUuht00m_400x400.jpg",
"is_me": true,
"last_login": "2018-10-01T13:15:08+05:00",
"nickname": "Quana",
"registered": "2018-10-01T13:15:08+05:00",
"tag": "24234",
"user_id": "2a6e0079-d7a7-11e8-963b-82010aa80778"
},
{"avatar": "https://pbs.twimg.com/profile_images/874276177757336222/kUuht00m_400x400.jpg",
"is_me": false,
"last_login": "2018-10-01T13:15:08+05:00",
"nickname": "Quanare",
"registered": "2018-10-01T13:15:08+05:00",
"tag": "249078",
"user_id": "1e6e2979-d7f7-11e8-963b-42010aa80910"
},
{"is_me": false,
"last_login": "2018-10-01T13:15:08+05:00",
"nickname": "Quanare",
"registered": "2018-10-01T13:15:08+05:00",
"tag": "434535",
"user_id": "2e6e2979-d7f7-11e8-963b-42010aa80922"
}
]
}