Leave Session By Platform Session By Uuid

DELETE 
/session/v1/platform/:platform/platform-session/:platform_session_id_base64/player/:player_uuid

Leave a platform session by platform ID and parent platform session id

Required Permissions:

• For any player (including themselves) any of: session:*, session:update-player:any

• For the player themselves : session:update-player:self

Required Session Permissions: None

Request

Path Parameters

platform_session_id_base64 Platform Session Id Base64required

Possible values: non-empty and <= 4096 characters

platform Platformrequired

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

player_uuid uuidrequired

Responses

204

Successful Response

403

User is not authenticated, or does not have sufficient role access to perform request

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

Platform Session or Platform Player doesn't exist. See error code for more info

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

503

Service was unable to fulfill the request at this time and should be retried after the Retry-After wait time

Response Headers

• Retry-After

  integer

  Number of seconds after which to retry the request

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

Loading...