カスタムIDによる認証

カスタムIDによる認証Server-side

post/users/login/server_custom_id

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

SecurityServer

Request

query Parameters

projectId	string <uuid> パブリッシャーアカウントからのログインプロジェクトID。指定しない場合は、指定した`publisher_project_id`パラメータにシャドウログインが使用されます。このコールに渡す必要のないシャドウログインID。
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.
publisher_project_id	integer リクエストしたパブリッシャーアカウントのプロジェクトID。このプロジェクトIDを指定しても`project_id`パラメータを指定しない場合、サービスはその`project_id`にリンクされました。カスタマーサクセスマネージャーに連絡して、`project_id`を`publisher_project_id`にリンクしてください。
with_logout	string Default: "0" 既存のユーザーJWT値を非アクティブ化し、このコールによって生成されたものをアクティブ化するかどうかを示します。次の値を指定できます。 `1` は、既存の値を非アクティブ化し、新しい値をアクティブ化します。 `0` は、既存の値をアクティブ化したままにします。

Request Body schema: application/json

server_custom_id

required

string <= 256 characters

Custom ID that already exists on your server. Note: It is not the same ID as the Xsolla Login user ID.

Array of objects

User attributes that are updated or created on authduring authentication.

Array

key required	string <= 256 characters [A-Za-z0-9_]+ ユーザーの属性を特定するために使用される属性名。ユーザーごとに一意である必要があります。
value required	any
attr_type required	string サービス属性に対するユーザーのアクセスレベルの定義： `client` - ユーザーが編集可能な属性。このタイプの属性の値は、ユーザーによって入力されるか、クライアント側のゲーム内ロジックに従って指定されます。例：名前とキャラクターのステータス、ゲームの難易度など。 `server` - 読み出し専用の属性。このタイプの属性の値は、アプリケーションのサーバー側で入力および編集されます。定期的に変更する必要のないゲームキャラクターの統計情報やユーザーパラメータの設定に使用することをお勧めします。例えば、ボーナス、ゲームキャラクターのキーパラメータ、ユーザーカテゴリなどを獲得するチャンス Enum: "client" "server"
permission required	string 他のユーザーの属性に対するユーザーのアクセスレベルの定義。 Enum: "private" "public"
read_only	boolean

object

User social profile.

user_id required	string ソーシャルプロバイダーからのユーザーID。
platform required	string Name of the social provider.

object

User profile. This fields describe the user data.

nickname

required

string <= 255 characters

User nickname. The value will be added to the nickname field in the user JWT. Can't be empty. Spaces are allowed, but will be trimmed before and after the nickname. Can be non-unique. You can change the user's nickname value in the Xsolla system using the same method.

Responses

200

400

無効なリクエスト

401

未認証

404

見つかりません

422

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

429

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

Request samples

application/json

{"attributes": [{"attr_type": "server",
"key": "company",
"permission": "private",
"value": "facebook-promo"
},
{"attr_type": "server",
"key": "custom-id",
"permission": "private",
"value": 48582
}
],
"server_custom_id": "1234567890asdfghjkl",
"social_profile": {"platform": "xbox",
"user_id": 4352354
},
"user_profile": {"nickname": "John_Doe_1337"
}
}

Response samples

application/json

{"token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJlbWFpbCI6IiIsImV4cCI6MTY1MzEyMzk5MCwiZ3JvdXBzIjpbXSwiaWF0IjoxNjUzMDM3NTkwLCJpc3MiOiJodHRwczovL2xvZ2luLnhzb2xsYS5jb20iLCJwdWJsaXNoZXJfaWQiOjMsInNlcnZlcl9jdXN0b21faWQiOiJteS1jdXN0b20taWQtbm90LWxpbmtlZCIsInN1YiI6IjI0MTBkNmMzLWFhZDEtNGY0OS04ODNlLTQ2Y2FkM2ZiMmJjMiIsInR5cGUiOiJzZXJ2ZXJfY3VzdG9tX2lkIiwidXNlcm5hbWUiOm51bGwsInhzb2xsYV9sb2dpbl9hY2Nlc3Nfa2V5IjoiSFhzTVZSWmRtd2tuZXNZMG1pNEpUMVhJUm43bVM4ZU5oc1FxaTU4bmtCayIsInhzb2xsYV9sb2dpbl9wcm9qZWN0X2lkIjoiMTM3NTkyM2ItODdmMy00YTIwLWFjMmItZDBhMjg3MzBlNDIwIn0.D8dFMN5Bmgnpejq1EhZUZQP_D5iFhpO_RXnVyE03qUI"
}