Sign in
Authentication

Start a QuickConnect pairing request

No authentication: a device with no session yet asks for a short code, shows it to the person signing in, then polls /quickconnect/status with the returned secret until it comes back authorized. Off unless the quickconnect_enable preference is on.

post/quickconnect/initiate

Query parameters

device_idstring

An id the caller makes up and keeps, so its own initiate rate limit applies.

device_namestring

Shown to the approving user alongside the code.

clientstring

Client/agent name recorded with the request.

versionstring

The app version, shown to the approving user.

Request body

device_idstring

An id the caller makes up and keeps, so its own initiate rate limit applies.

device_namestring

Shown to the approving user alongside the code.

clientstring

Client/agent name recorded with the request.

versionstring

The app version, shown to the approving user.

Response

Pairing request created

secretstring required
codestring required
device_idstring required
device_namestring required
app_namestring required
app_versionstring required
date_addedinteger required
authorizedboolean required

Changes

Changed in 1 of the 51 revisions of this API.1