Skip to main content

Create Platform User By Id

POST 
/users/v1/platform-user

Create a new platform user from a platform identity.

WARNING: This endpoint does not validate that the provided user ID is valid, and should only be used after validating a user's identity.

Required Permissions:

  • For any player (including themselves) any of: user:*, user:platform:create

Request​

Body

required

    platform Platform (string)required

    Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

    An enumeration.

    platform_user_id Platform User Id (string)required

    Possible values: non-empty and <= 2048 characters

    Platform user ID to create with

    display_name Display Name (string)

    Possible values: <= 256 characters

    Display name used when creating a new player

Responses​

Platform user was created successfully

Schema

    platform Platform (string)required

    Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

    An enumeration.

    platform_user_id Platform User Id (string)required

    Possible values: <= 2048 characters

    Platform user ID to search/create with

    display_name Display Name (string)

    Platform Display name

    player_id Player Id (integer)requireddeprecated

    Player ID DEPRECATED use player_uuid instead

    player_uuid uuidrequired

    Player UUID

    person_id uuidrequired

    Person ID

    active_player_id Active Player Id (integer)deprecated

    DEPRECATED use active_player_uuid instead. Active player ID, if the player has an active player.

    active_player_uuid uuid

    Active player UUID, if the player has an active player.

Loading...