Account

Start a CLI device login (no auth)

Changed on

Starts the orl auth login device flow: returns a device code for the CLI to poll and a 6-digit user code for a signed-in person to confirm. No API key or session is required: this is how an unauthenticated CLI starts the flow that gets it one. The code expires in 10 minutes. deviceName is the requesting host's best-effort hostname, shown on the approval page so the signed-in user can recognize their own terminal before confirming the code.

Requires no authentication.

post/v1/cli-auth/device

Request

  • Base URL
    https://api.openrelay.inc
  • URL
    https://api.openrelay.inc/v1/cli-auth/device
  • Auth
    none required

Request body

deviceNamestring

Response

A fresh device/user code pair

deviceCodestring required

Opaque; the CLI polls POST /v1/cli-auth/token with this.

expiresIninteger required

Seconds until the code expires (600).

intervalinteger required

Minimum seconds between polls; a faster poll gets slow_down.

userCodestring required

The 6 digits the CLI prints for a human to enter.

verificationUristring uri required
verificationUriCompletestring uri required

verificationUri with ?code= pre-filled; the approval page still requires the user to confirm it matches their terminal.

Changes