Authentifier par custom ID

post/users/login/server_custom_id

Authentifie l'utilisateur à l'aide d'un custom ID spécifique. Si l'utilisateur n'existe pas, il est créé.

SecurityServer

Request

query Parameters

projectId	string <uuid> ID du projet de connexion issu du Compte éditeur. Si vous ne le spécifiez pas, la connexion fantôme est utilisée pour le paramètre `publisher_project_id` spécifié. Vous n'avez pas besoin de passer l'ID de connexion fantôme à cet appel.
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 de projet issu du Compte éditeur pour lequel vous faites une requête. Si vous le spécifiez, mais que vous ne spécifiez pas le paramètre `project_id`, le service sera lié à son propre `project_id`. Contactez votre responsable de la réussite client pour lier `project_id` à `publisher_project_id`.
with_logout	string Default: "0" Indique s'il faut désactiver les valeurs existantes du JWT utilisateur et activer celles générées par cet appel. Valeurs possibles : `1` : pour désactiver les valeurs existantes et en activer une nouvelle ; `0` : pour garder les valeurs existantes activées.

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_]+ Nom de l'attribut utilisé pour identifier l'attribut utilisateur. Il doit être unique pour chaque utilisateur.
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 Définition du niveau d'accès de l'utilisateur aux attributs des autres utilisateurs. Enum: "private" "public"
read_only	boolean

object

User social profile.

user_id required	string ID de l'utilisateur auprès d'un fournisseur de réseau social.
platform required	string Name of the social provider.

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

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