カスタムIDによる認証

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 Definition of user’s access level to service attributes: `client` - A user-editable attribute. The values for this type of attributes are entered by a user or specified according to the in-game logics on the client side. For example, the name and character stats, game difficulty level, etc. `server` - A read-only attribute. The values for this type of attributes are entered and edited on the server side of your application. We recommend that you use them for configuration of game character stats or user parameters that shouldn’t change regularly. For example, chance to get a bonus, game character key parameters, user categories, etc. 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.

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
}
}

Response samples

application/json

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