Kick / Logout User

API Documentation

API Route

{{apiBase}}/users/kick

Authentication Required

Yes

Send the API key as (APIKEY) in the headers.

Request

• Method: POST

Parameters

• userid: Required. Specify the user ID.

Optional:

• sso: Specify the Single Sign-On (SSO) value.

Success Response

{
    "status": 200,
    "timestamp": 1684420659,
    "time": 0.62,
    "ip": "127.0.0.1",
    "message": "User kicked successfully",
    "data": []
}

Error Response

{
    "status": 400,
    "timestamp": 1684420668,
    "time": 0.321,
    "ip": "127.0.0.1",
    "message": "Something went wrong",
    "error_code": "resource_not_found",
    "data": []
}