Skip to content

Get Login History

GET
/users/v1/history/login

Get the Login history for a given user

Authorizations

Parameters

Query Parameters

player_uuid

The player UUID to audit

string format: uuid

The player UUID to audit

person_id

The person ID to audit

string format: uuid

The person ID to audit

platform

The platform to audit

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

The platform to audit

platform_user_id

The platform user ID to audit

string
<= 2048 characters

The platform user ID to audit

continuation_token

Token to retrieve the next page of results

string

Token to retrieve the next page of results

Responses

200

Successful Response

object
entries
required

The login history entries

Array<object>

Entry in a users’s login history. Some fields may be missing if the data is not available.

object
player_uuid

Player UUID

string format: uuid
platform

Platform

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

Platform user ID

string
<= 2048 characters
person_id

Person ID

string format: uuid
user_agent

User agent string

string
ip

IP address

string
client_id

Client ID

string
timestamp

Datetime that enforces that a timezone is given. Unix timestamps are allowed and forced into the UTC time zone

string format: date-time
continuation_token

Token to retrieve the next page of results

string

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_sig_invalid - Token Signature is invalid
  • auth_token_unknown - Failed to parse token
  • insufficient_permissions - Insufficient Permissions
object
auth_success
boolean
default: true
error_code
required
string
desc
required
string

404

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