Skip to main content
POST
Request a device code

Body

application/json
client_id
string
required

The identifier of the bridge asking to pair.

Example:

"relay-cli"

scope
string

Space-separated scopes, when the bridge asks for any.

Response

Codes issued; show the user code and start polling.

device_code
string
required

The bridge's secret half. Never show it to the person.

user_code
string
required

The short code the person types into the Relay app.

Example:

"ABCD-EFGH"

verification_uri
string<uri>
required
verification_uri_complete
string<uri>
required

The same URI with the user code embedded, for a QR or a deep link.

expires_in
integer
required

Seconds until the codes stop being claimable.

Example:

600

interval
integer
required

Minimum seconds between token polls.

Example:

5