Lookup Player By Portal

GET 
/users/v1/player

Lookup players by various parameters.

Results will include the active player, if possible, otherwise will return the associated player directly.

Request

Query Parameters

display_name string[]

Possible values: <= 256 characters

Lookup players by display names

identity_platform anydeprecated

Lookup players by their portal identity for this platform

platform any

Lookup players by their platform identity. Will override identity_platform if set.

identities string[]

Possible values: <= 2048 characters

Lookup players by their Portal Identity

Responses

200

Successful Response

application/json

Schema

Schema

display_names object[]

Default value: ``

List of display names and the players that match that display name

identity_platforms

object

deprecated

DEPRECATED Use identity_platforms_by_platform instead. List of platforms and the players that match that platform user id

property name*

object[]

Array [

identity

object

List of platform user ids and the players that match that platform user id

property name*

PlayerResponse

Response for getting a player's info

player_id Player Id (integer)requireddeprecated

Player ID DEPRECATED use player_uuid instead

player_uuid uuidrequired

Player UUID

]

identity_platforms_by_platform

object

List of platforms and the players that match that platform user id

property name*

object[]

Array [

identity

object

List of platform user ids and the players that match that platform user id

property name*

PlayerResponse

Response for getting a player's info

player_id Player Id (integer)requireddeprecated

Player ID DEPRECATED use player_uuid instead

player_uuid uuidrequired

Player UUID

]

Example (from schema)

{
  "display_names": [
    {}
  ],
  "identity_platforms_by_platform": {}
}

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"
}

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...