OAuth

Start the device-code flow.

Changed on

Send application/x-www-form-urlencoded. Show the returned user_code and verification_uri to the user, then poll POST /oauth/token with grant_type=urn:ietf:params:oauth:grant-type:device_code no faster than interval seconds. Polling answers authorization_pending until the user consents, slow_down if you poll too fast, and expired_token once the code lapses.

Authenticates the OAuth app itself, not a user: HTTP Basic with your client id as the username and client secret as the password. An account email and Personal Access Token do not work here.

post/oauth/device_authorization

Request

  • Base URL
    https://api.ownerrez.com
  • URL
    https://api.ownerrez.com/oauth/device_authorization
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

scopestring

Requested scope: read or full.

client_idstring

Optional. When present, must match the Basic-authenticated client.

Response

The device and user codes.

device_codestring

The code to poll the token endpoint with.

user_codestring

The code the user types, formatted XXXX-XXXX.

verification_uristring

Where the user enters the code.

verification_uri_completestring

The same page with the code prefilled.

expires_ininteger

Seconds until the device code expires.

expires_onstring

Expiry timestamp of the device code, ISO 8601 UTC.

intervalinteger

Minimum seconds between polls.

Changes