Class DeviceCodeResult

Namespace

Microsoft.Identity.Client

Assembly

Microsoft.Identity.Client.dll

This object is returned as part of the device code flow and has information intended to be shown to the user about where to navigate to login and what the device code needs to be entered on that device. See https://aka.ms/msal-device-code-flow.

public class DeviceCodeResult

Inheritance

object

DeviceCodeResult

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

ClientId

Identifier of the client requesting device code.

public string ClientId { get; }

Property Value

string

DeviceCode

Device code returned by the service

public string DeviceCode { get; }

Property Value

string

ExpiresOn

Time when the device code will expire.

public DateTimeOffset ExpiresOn { get; }

Property Value

DateTimeOffset

Interval

Polling interval time to check for completion of authentication flow.

public long Interval { get; }

Property Value

long

Message

User friendly text response that can be used for display purpose.

public string Message { get; }

Property Value

string

Scopes

List of the scopes that would be held by token.

public IReadOnlyCollection<string> Scopes { get; }

Property Value

IReadOnlyCollection<string>

UserCode

User code returned by the service

public string UserCode { get; }

Property Value

string

VerificationUrl

Verification URL where the user must navigate to authenticate using the device code and credentials.

public string VerificationUrl { get; }

Property Value

string

See Also

AcquireTokenWithDeviceCode(IEnumerable<string>, Func<DeviceCodeResult, Task>)