Skip to content

startDeviceAuthorization

startDeviceAuthorization(options): Promise<DeviceAuthorizationResponse>

Defined in: src/oauth/authorize.ts:194

Begin OAuth2 device authorization flow.

The device authorization parameters.

string

the client ID returned from client registration.

ValidatedAuthMetadata

the validated OAuth2 metadata for the Identity Provider.

string

the scope to request for authorization.

Promise<DeviceAuthorizationResponse>

a promise that resolves to a device access token response, or an error response if the user denies authorization or the device code expires.