Kick Player From Session By Id

DELETE 
/session/v1/session/:session_id/player/id/:player_id

deprecated

Kick or Remove a player from a session, or cancel an invite for a player to the session

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 for players operating on themselves. Required Session Permissions: kick for users that do not have the above permissions, and are not a session admin DEPRECATED - Use the player endpoint instead

Request

Path Parameters

session_id Session Idrequired

Possible values: non-empty and <= 128 characters

player_id Player Idrequired

Query Parameters

refresh_ttl Refresh Ttl

Default value: true

Responses

204

Successful Response

403

Forbidden

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

Session doesn't exist or Player is not a member of the session. 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"
    }
  ]
}

Loading...