Request OAuth2 device authorization

Issues a device code and user code for the device authorization flow per RFC 8628.

POST /oauth/device/code

Error

A valid request URL is required to generate request examples

200

{
  "device_code": "<string>",
  "expires_in": 123,
  "interval": 123,
  "user_code": "<string>",
  "verification_uri": "<string>",
  "verification_uri_complete": "<string>"
}

Authorizations

API KeyTenant IDBearer Auth

X-API-Key · string · header · required

Body

multipart/form-data

client_id · string · required

OAuth2 client ID

Response

200

application/json

OK

device_code · string

expires_in · integer

interval · integer

user_code · string

verification_uri · string

verification_uri_complete · string

The verification URI with the user code included, so the user confirms the code instead of typing it (RFC 8628 §3.3.1).