aVenture APIAuth

Acknowledge CLI credential delivery

View as Markdown
Confirms the CLI stored the delivered API key in its credential store and clears transient delivery material.

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

OK
clientLabelstring

User-supplied label for the requesting CLI installation

clientPlatformenum

Coarse client operating-system family

Allowed values:
comparisonCodestring
Human comparison code shown by both the CLI and browser
createdAtdatetime
Authorization request creation timestamp
expiresAtdatetime
Time after which an unfinished request cannot be approved
idstringformat: "uuid"
Public authorization request identifier
intervalSecondslong>=1

Minimum server-directed poll interval in seconds

statusenum
Current broker lifecycle state
updatedAtdatetime
Most recent lifecycle update timestamp
approvedAtdatetime or nullOptional
Time the authenticated user approved this request
consumedAtdatetime or nullOptional
Time the CLI acknowledged durable local storage
keyReadyAtdatetime or nullOptional
Time encrypted key delivery became available
terminalAtdatetime or nullOptional
Time this request entered its terminal state
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