Enable Cross Progression

POST 
/users/v1/cross-progression/enable

Enable Cross Progression for the player associated with the platform identity.
While cross progression is enabled, all linked users who login will receive a token for the player with cross progression enabled (instead of a token for their platform user's player).

If an identity is not provided, the identity in the token will be used.

If you are modifying a user outside of your person, Required Permissions:

• For any user (including themselves) any of: user:*, user:modify:any

NOTE: Whenever you change the link or cross progression status of a user, it is recommended to refresh their access token. Each token does container user information, which may be incorrect after a link or cross progression change. There is no guarantee that calling other endpoints will operate on the correct user until the token has been refreshed.

Request

application/json

Body

platform Platform (string)

Possible values: [Anon, Basic, XboxLive, PSN, NintendoNAID, NintendoSwitch, NintendoPPID, Google, GooglePlay, Apple, Epic, Steam, Amazon, Twitch, RallyHere, LegacyName]

Platform ID

platform_user_id Platform User Id (string)

Possible values: <= 2048 characters

Platform User ID

Responses

200

Successful Response

400

Request inputs are not valid

Error Codes:

• account_not_found - User Account not found

• already_cross_progression_player - Player is already the cross progression player

• cannot_modify_person - You have insufficient permissions to modify this person

• invalid_token_claims - Token has missing/invalid claims. Are you using a non-user token on a user endpoint?

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

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