Find Platform User By Id
GET /users/v1/platform-user
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
Platform to search
platform_user_id
required
Platform user ID to search for
string
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
platform_user_id
required
Platform user ID to search/create with
string
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:
auth_invalid_key_id
- Invalid Authorization - Invalid Key ID in Access Tokenauth_invalid_version
- Invalid Authorization - versionauth_malformed_access
- Invalid Authorization - malformed access tokenauth_not_jwt
- Invalid Authorizationauth_token_expired
- Token is expiredauth_token_format
- Invalid Authorization - {}auth_token_invalid_claim
- Token contained invalid claim value: {}auth_token_sig_invalid
- Token Signature is invalidauth_token_unknown
- Failed to parse tokeninsufficient_permissions
- Insufficient Permissions
object
auth_success
boolean
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
error_code
required
string
desc
required
string
422
Validation Error
object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string