Auth pair request claim

Request of pair claim auth

Endpoint

POST /api/auth/pair/request/

Body

Content-Type: application/json
Json
{
    "code": ""
}

Response

Json
[
    {
        "kind": "status",
        "payload": {
            "code": 0,
            "message": ""
        }
    },
    {
        "kind": "entity:requested",
        "payload": {
            "lifetime": ""
        }
    },
    {
        "kind": "entity",
        "payload": {
            "expires_at": 0,
            "permissions": [
                ""
            ],
            "token": ""
        }
    }
]

Notes

  • Rate Limited
  • Open to unauthenticated clients, which is how a browser signs in without a private key
  • code accepts either case and optional dashes
  • Emits the requested entity once the code is accepted, then holds the connection until the engine side approves or rejects
  • A rejected, unknown, expired, or already-claimed code answers 401
  • The decision window is 30 seconds, starting when the code is claimed