Retrieve OAuth device code

POST 
/api/oauth/:OAuthAppName/device

Initiates the OAuth 2.0 Device Authorization Grant per RFC 8628. Returns a device_code and user_code that the client displays to the end-user for out-of-band authorization on a secondary device. The client then polls the token endpoint with the device_code until the user completes authorization.

Request

Responses

200

OK: The request was successful.

400

Status Bad Request: The request could not be understood by the server due to malformed syntax.

401

Status Unauthorized: The client must authenticate itself to get the requested response.

403

Status Forbidden: The client does not have permission to access the resource.

429

Too Many Requests: The client has sent too many requests in a given amount of time.

Response Headers

X-RateLimit-Limit
Refill rate of the bucket that rejected this request: requests per second for the tenant bucket, or requests per refill window (60 seconds by default) for the per-IP bucket.
Example: 100
X-RateLimit-Remaining
Tokens left in that bucket.
Example: 0
X-RateLimit-Reset
Unix timestamp, in seconds, at which the next token becomes available. This is the earliest time a retry can succeed.
Example: 1757942400