Skip to content

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

Authorizations

Parameters

Query Parameters

platform
required

Platform to search

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch

Platform to search

platform_user_id
required

Platform user ID to search for

string
<= 2048 characters

Platform user ID to search for

Responses

200

Platform user was found successfully

Response for successfully creating a platform user

object
platform
required

Platform to search/create with

string
Allowed values: Anon Basic XboxLive PSN NintendoNAID NintendoSwitch NintendoPPID Google GooglePlay Apple Epic Steam Amazon Twitch
platform_user_id
required

Platform user ID to search/create with

string
<= 2048 characters
display_name

Platform Display name

string
player_id
required

Player ID DEPRECATED use player_uuid instead

integer
player_uuid
required

Player UUID

string format: uuid
person_id
required

Person ID

string format: uuid
active_player_id

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

integer
active_player_uuid

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

string format: uuid

403

Error Codes:

  • insufficient_permissions - Insufficient Permissions
  • auth_malformed_access - Invalid Authorization - malformed access token
  • auth_invalid_key_id - Invalid Authorization - Invalid Key ID in Access Token
  • auth_token_format - Invalid Authorization - {}
  • auth_not_jwt - Invalid Authorization
  • auth_invalid_version - Invalid Authorization - version
  • auth_token_expired - Token is expired
  • auth_token_sig_invalid - Token Signature is invalid
  • auth_token_unknown - Failed to parse token
  • auth_token_invalid_claim - Token contained invalid claim value: {}
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

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

Error Codes:

  • user_not_found - User not found
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string