Identification 🚧

A Client has to identify before sending any other requests to the gateway.

Request model

The following Identify request returns a response with the Opcode Identify, visualized in the identification examples below.

{ "op": "Identify", "d": {} }

Identification example

Success example (authenticated)

The following response is sent when the connecting client has the Cookie header set and a valid JWT token, which in this example authenticates the client as StarToLeft.

{
    "response": {
        "d": {
            "client_id": Uuid,
            "is_authenticated": true,
            "nickname": "StarToLeft"
        },
        "op": "Identify"
    },
    "status": true
}

Success example (not authenticated)

If the JWT token cookie is not set then the is_authenticated field is false, the user is provided an auto generated nickname.

{
    "response": {
        "d": {
            "client_id": Uuid,
            "is_authenticated": false,
            "nickname": "Blueberry Starburst"
        },
        "op": "Identify"
    },
    "status": true
}

Error example

The following error occurs when the client identifies more than once.

{
    "status": false,
    "error": {
        "code": "AlreadyIdentified",
        "reason": "Client is already identified"
    }
}