aVenture APIAuth

Start CLI authorization

View as Markdown

Creates a short-lived browser approval request and returns its poll credential once.

Request

This endpoint expects an object.
clientLabelstring or nullOptionalformat: ".*\S.*"1-120 characters
Label for this CLI installation
clientPlatformenum or nullOptional

Coarse operating-system family

Allowed values:
encryptionAlgorithmenum or nullOptional
Requested hybrid encryption suite
Allowed values:
encryptionPublicKeystring or nullOptional344-12000 characters

Base64-encoded DER SubjectPublicKeyInfo for an ephemeral RSA public key

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

Created
comparisonCodestring
Human comparison code shown by both the CLI and browser
expiresAtdatetime
Authorization request expiry timestamp
idstringformat: "uuid"
Public authorization request identifier
intervalSecondslong>=1
Minimum poll interval in seconds
pollSecretstringRead-only

One-time high-entropy credential required to poll and acknowledge delivery

verificationUrlstringformat: "uri"
Browser verification URL

Errors

400
Bad Request Error
406
Not Acceptable Error
409
Conflict Error
415
Unsupported Media Type Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error