v1

latestOpenAPI 3.1.0raw.githubusercontent.com2024-09-27192307552.2 KB
auth

Device Authorization

OAuth2 device authorization endpoint.

This endpoint implements the OAuth2 device authorization grant flow as defined in https://tools.ietf.org/html/rfc8628. It is called to initiate the device authorization flow by requesting a device and user code for a given client ID.

For a new client ID, a new OAuth device is created, stored in the DB and returned to the client along with a pair of newly generated device and user codes. If a device for the given client ID already exists, the existing DB entry is reused and new device and user codes are generated.

Args: request: The request object. client_id: The client ID.

Returns: The device authorization response.

post/api/v1/device_authorization

Response

Successful Response

device_codestring required
user_codestring required
verification_uristring required
verification_uri_completestring nullable
expires_ininteger required
intervalinteger required