Refresh Connection Status For Platform Entitlements

POST 
/inventory/v2/user-entitlement:refresh-connection

Check the status of the user with the platform, and if they are able to request entitlements

Required Permissions:

• For any player (including themselves) any of: inv:*, inv:platform_entitlements:any

• For the player themselves : inv:platform_entitlements:self

Request

Query Parameters

platform_id Platform Idrequired

Platform this entitlement was purchased was made on

platform_user_id Platform User Idrequired

Platform this entitlement was purchased was made on

platform_token any

Platform token that can be used to verify the identity of the user

platform_environment any

Platform Environment to check for ownership

platform_region PlatformRegionrequired

Possible values: [Unknown, NA, EU]

region this purchase was made in

client_type ClientTyperequired

Possible values: [UNKNOWN, WIN, MAC, XBOXONE, PS4, SWITCH, ANDROID, IOS, PS5, LINUX, XSX]

client type this purchase was made on

Responses

200

Successful Response

application/json

Schema

Schema

error_code

object

anyOf

MOD1

string

Example (from schema)

{
  "error_code": "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"
}

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