Method StartAsync

StartAsync(string, string, IPAddress?, string?, CancellationToken)

Starts a link for a new device and returns what the new device needs, which the app returns to it as-is: the code to show, the ID and poll secret to check the link's status, and how long the link waits for approval (Lifetime).

Declaration

public Task<DeviceLinkStart> StartAsync(string codeChallenge, string device, IPAddress? ipAddress, string? location, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	codeChallenge	The new device's S256 code challenge (see PkceChallenge), which the sign-in code is bound to.
string	device	The new device, in the form of Device.
IPAddress	ipAddress	The new device's IP address, or null if it is not known.
string	location	The new device's approximate location to show to the approver, if the application can determine it.
CancellationToken	cancellationToken	A token to cancel the operation.

Returns

Type	Description
Task<DeviceLinkStart>

Exceptions

Type	Condition
BadRequestApiException	The code challenge is malformed (CodeChallengeInvalid).