Auth pair request

Request of pair auth

Endpoint

POST /api/auth/pair/

Auth

Authorization: Bearer ${token}

Body

Content-Type: application/json

Json

{
    "lifetime": "",
    "permissions": [
        ""
    ]
}

Response

Json

[
    {
        "kind": "status",
        "payload": {
            "code": 0,
            "message": ""
        }
    },
    {
        "kind": "entity:pairing",
        "payload": {
            "code": "",
            "identity": "",
            "lifetime": "",
            "permissions": [
                ""
            ]
        }
    },
    {
        "kind": "entity:request",
        "payload": {
            "address": "",
            "agent": "",
            "identity": ""
        }
    }
]

Notes

Requires the MASTER permission over TCP/IP, implied over the Unix socket
Emits the pairing entity immediately, then holds the connection until a console claims the code
permissions defaults to SHELL, ARTIFACT, RUNTIME, WORKFLOW, and AGENT; passing MASTER alone expands to MASTER plus those defaults
lifetime is optional (e.g. "1h"). Accepted range is 1 minute to 24 hours; out-of-range or omitted values fall back to the 1 hour default.
The code lasts 30 seconds. An unclaimed code answers 408.

Auth inspect request

Request of inspect auth

Auth pair request claim

Request of pair claim auth