Xsolla-logo

Über selbst definierte ID authentifizierenServer-side

post/users/login/server_custom_id

Authentifiziert einen Benutzer anhand einer bestimmten selbst definierten ID. Wenn der Benutzer nicht existiert, wird er erstellt.

SecurityServer
Request
query Parameters
projectId
string <uuid>

Login-Projekt-ID aus dem Kundenportal. Wenn Sie keine ID angeben, wird ein Schatten-Login für den angegebenen publisher_project_id-Parameter verwendet.

Sie müssen keine Schatten-Login-ID an diesen Anruf übermitteln.

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 des anzufragenden Kundenportal-Projekts.

Wenn Sie die ID angeben, aber nicht den Parameter project_id, wird der Dienst mit seiner project_id verknüpft. Wenden Sie sich an Ihren Customer Success Manager, um project_id mit publisher_project_id zu verknüpfen.

with_logout
string
Default: "0"

Zeigt an, ob die vorhandenen Benutzer-JWT-Werte deaktiviert und stattdessen der durch diesen Aufruf generierte Wert aktiviert werden sollen. Folgende Werte sind möglich:

  • 1, um die vorhandenen Werte zu deaktivieren und einen neuen Wert zu aktivieren,
  • 0, damit die vorhandenen Werte aktiviert bleiben.
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_]+

Name des Attributs, anhand dessen das Benutzerattribut identifiziert wird. Muss für jeden Benutzer eindeutig sein.

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

Festlegung der Zugriffsebene eines Benutzers für dessen Zugriff auf die Attribute anderer Benutzer.

Enum: "private" "public"
read_only
boolean
object

User social profile.

user_id
required
string

Benutzer-ID von einem Social-Media-Anbieter.

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

OK

400

Bad Request

401

Unauthorized

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

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