device

Start a device authorization

Starts a device-code login (RFC 8628). The client shows the user code and verification URI to the user, then polls /api/users/device/token until the user approves.

post/api/users/device/authorize

Request

  • Base URL: https://api.hostim.dev
  • URL: https://api.hostim.dev/api/users/device/authorize
  • Auth: none required

Request body

clientNamestring

Human-readable name of the client requesting access.

Response

Authorization started

deviceCodestring required

Secret held by the client; poll /api/users/device/token with it.

userCodestring required

Short code the user types on the approval page.

verificationUristring required

Page where the user approves the request.

verificationUriCompletestring

Same page with the user code pre-filled.

expiresIninteger required

Seconds until the authorization expires.

intervalinteger required

Minimum seconds between polls.

Changes

No recorded changes to this operation across all 1 revision of this API.