aVenture APIAuth

Poll CLI authorization

View as Markdown

Returns pending state, a terminal state, or an encrypted one-time credential delivery.

Path parameters

cliAuthorizationIdstringRequiredformat: "uuid"
Public CLI authorization request identifier

Headers

X-Cli-Poll-SecretstringRequired

One-time poll credential returned by request creation

Response headers

X-RateLimit-Limitinteger

Requests allowed per client IP in the current rate-limit window.

X-RateLimit-Remaininginteger

Requests left before the tightest applicable rate-limit bucket rejects.

X-RateLimit-Resetinteger

Seconds until the exhausted rate-limit bucket admits another request; 0 when none is exhausted.

Response

Authorization is still pending or issuing
expiresAtdatetime
Authorization request expiry timestamp
statusenum
Current broker lifecycle state
deliveryobject or nullOptional

Encrypted one-time delivery, present only for KEY_READY

terminalReasonenum or nullOptional

Non-secret terminal-state explanation

Errors

400
Bad Request Error
404
Not Found Error
406
Not Acceptable Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error