Xsolla-logo

カスタムIDによる認証

post/users/login/server_custom_id

特定のカスタムIDによってユーザーを認証します。ユーザーが存在しない場合は、作成されます。

SecurityServer
Request
query Parameters
projectId
string <uuid>

パブリッシャーアカウントからのログインプロジェクトID。指定しない場合は、指定したpublisher_project_idパラメータにシャドウログインが使用されます。

このコールに渡す必要のないシャドウログインID。

payload
string

カスタムデータ。パラメータの値は、ユーザーJWTpayloadクレームで返されます。

publisher_project_id
integer

リクエストしたパブリッシャーアカウントのプロジェクトID。

このプロジェクトIDを指定してもproject_idパラメータを指定しない場合、サービスはそのproject_idにリンクされました。カスタマーサクセスマネージャーに連絡して、project_idpublisher_project_idにリンクしてください。

with_logout
string
Default: "0"

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

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

カスタムIDはサーバーによって生成されます(エクソラログインユーザーIDではありません)。 秘密鍵に含まれる必要があります。

Array of objects

任意のパラメータ。認証時に保存されるユーザーのカスタム属性が含まれています

Array
key
required
string
value
required
any
attr_type
required
string
Enum: "client" "server"
permission
required
string
Enum: "public" "private"
read_only
boolean
object

ユーザーとリンクするために必要なソーシャルプロファイル。

user_id
required
string

ソーシャルプロバイダーからのユーザーID。

platform
required
string

ソーシャルプロバイダー名。

Responses
200

OK

400

無効なリクエスト

401

未認証

404

見つかりません

422

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

429

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

Request samples
application/json
{
  • "attributes": [
    ],
  • "server_custom_id": "1234567890asdfghjkl",
  • "social_profile": {
    }
}
Response samples
application/json
{
  • "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IiIsImV4cCI6MTY1MzEyMzk5MCwiZ3JvdXBzIjpbXSwiaWF0IjoxNjUzMDM3NTkwLCJpc3MiOiJodHRwczovL2xvZ2luLnhzb2xsYS5jb20iLCJwdWJsaXNoZXJfaWQiOjMsInNlcnZlcl9jdXN0b21faWQiOiJteS1jdXN0b20taWQtbm90LWxpbmtlZCIsInN1YiI6IjI0MTBkNmMzLWFhZDEtNGY0OS04ODNlLTQ2Y2FkM2ZiMmJjMiIsInR5cGUiOiJzZXJ2ZXJfY3VzdG9tX2lkIiwidXNlcm5hbWUiOm51bGwsInhzb2xsYV9sb2dpbl9hY2Nlc3Nfa2V5IjoiSFhzTVZSWmRtd2tuZXNZMG1pNEpUMVhJUm43bVM4ZU5oc1FxaTU4bmtCayIsInhzb2xsYV9sb2dpbl9wcm9qZWN0X2lkIjoiMTM3NTkyM2ItODdmMy00YTIwLWFjMmItZDBhMjg3MzBlNDIwIn0.D8dFMN5Bmgnpejq1EhZUZQP_D5iFhpO_RXnVyE03qUI"
}