Interface DeviceAuthorizationResponse

The initial response from an OAuth 2.0 Device Authorization Grant request, containing the codes and URIs needed to complete device authentication.

interface DeviceAuthorizationResponse {
    device_code: string;
    expires_in: number;
    interval: number;
    user_code: string;
    verification_uri: string;
    verification_uri_complete: string;
}

Properties

device_code: string

Opaque code identifying this device authorization session. Pass this value when polling the token endpoint; do not display it to the user.

expires_in: number

Number of seconds until the device_code and user_code expire. After expiry the user must restart the authorization flow.

interval: number

Minimum number of seconds to wait between polling attempts on the token endpoint. Polling more frequently will result in a slow_down error.

user_code: string

Short alphanumeric code the user must enter at verification_uri to authorize the device.

verification_uri: string

URL the user visits to enter the user_code and approve the authorization request.

verification_uri_complete: string

Full verification URL with the user_code pre-filled as a query parameter. Display this as a QR code or deep link to reduce manual entry.