Xsolla-logo

ユーザー名とパスワードによる認証Client-side

post/login

指定されたユーザー名/メールアドレスおよびパスワードによってユーザーを認証します。

Request
query Parameters
projectId
required
string <uuid>

パブリッシャーアカウントからのログインプロジェクトID。

login_url
string

URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. Required if there are several Callback URLs.

payload
string

Your custom data. The value of the parameter will be returned in the payload claim of the user JWT. Recommended maximum length less than 500 characters. Note, that this parameter is only available if you use a custom user data storage.

with_logout
string
Default: "0"

既存のユーザーJWT値を非アクティブ化し、このコールによって生成されたものをアクティブ化するかどうかを示します。次の値を指定できます。

  • 1 は、既存の値を非アクティブ化し、新しい値をアクティブ化します。
  • 0 は、既存の値をアクティブ化したままにします。
Request Body schema: application/json
username
required
string

ユーザー名またはメールアドレス。

password
required
string

ユーザーパスワード。

remember_me
boolean

認証データの保存にユーザーが同意するか否か。デフォルトはfalseです。

Responses
200

OK

400

無効なリクエスト

401

未認証

404

未認証

422

処理不可能なエンティティー

429

リクエストの回数が多すぎます

Request samples
application/json
{
  • "password": "password123",
  • "remember_me": false,
  • "username": "John"
}
Response samples
application/json