Get Login History

GET 
/users/v1/history/login

Get the Login history for a given user

Required Permissions:

• For any player, person or platform identity (including themselves) any of: user:*, user:audit:any

• For the player, person or platform identity themselves : user:audit:self

Request

Query Parameters

player_uuid uuid

The player UUID to audit

person_id uuid

The person ID to audit

platform any

The platform to audit

platform_user_id Platform User Id

Possible values: <= 2048 characters

The platform user ID to audit

continuation_token Continuation Token

Token to retrieve the next page of results

Responses

200

Successful Response

application/json

Schema

Schema

entries

object[]

required

The login history entries

Array [

player_uuid uuid

player UUID

platform Platform (string)

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)

Possible values: <= 2048 characters

platform user ID

person_id uuid

person ID

user_agent User Agent (string)

user agent string

ip Ip (string)

IP address

client_id Client Id (string)

client ID

timestamp date-time

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

]

continuation_token Continuation Token (string)

Token to retrieve the next page of results

Example (from schema)

{
  "entries": [
    {
      "player_uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "platform": "Anon",
      "platform_user_id": "string",
      "person_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "user_agent": "string",
      "ip": "string",
      "client_id": "string",
      "timestamp": "2024-07-29T15:51:28.071Z"
    }
  ],
  "continuation_token": "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_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

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