Find Platform User By Id

GET 
/users/v1/platform-user

Find an existing platform user with their platform identity.

Required Permissions:

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

Request

Query Parameters

platform anyrequired

Platform to search

platform_user_id Platform User Idrequired

Possible values: <= 2048 characters

Platform user ID to search for

Responses

200

Platform user was found successfully

application/json

Schema

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.

Example (from schema)

{
  "platform": "Anon",
  "platform_user_id": "string",
  "display_name": "string",
  "player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "person_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "active_player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

403

Error Codes:

• auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token

• auth_invalid_version - Invalid Authorization - version

• auth_malformed_access - Invalid Authorization - malformed access token

• auth_not_jwt - Invalid Authorization

• auth_token_expired - Token is expired

• auth_token_format - Invalid Authorization - {}

• auth_token_invalid_claim - Token contained invalid claim value: {}

• auth_token_invalid_type - Invalid Authorization - Invalid Token Type

• auth_token_sig_invalid - Token Signature is invalid

• auth_token_unknown - Failed to parse token

• insufficient_permissions - Insufficient Permissions

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

404

Failed to find platform user. See error code and description for further details.

Error Codes:

• user_not_found - User not found

application/json

Schema

Schema

auth_success Auth Success (boolean)

Default value: true

error_code Error Code (string)required
desc Desc (string)required

Example (from schema)

{
  "auth_success": true,
  "error_code": "string",
  "desc": "string"
}

422

Validation Error

application/json

Schema

Schema

detail

object[]

Array [

loc

object[]

required

Array [

anyOf

MOD1

string

MOD2

integer

]

msg Message (string)required

type Error Type (string)required

]

Example (from schema)

{
  "detail": [
    {
      "loc": [
        "string",
        0
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}

Loading...