Share via

DeviceCodeInfo Class

  • Reference
Package:
com.azure.identity
Maven Artifact:
com.azure:azure-identity:1.13.1
  • java.lang.Object
    • com.azure.identity.DeviceCodeInfo

public class DeviceCodeInfo

Device Code Info represents the response returned from the device code endpoint containing information necessary for device code flow. By default, the information in Device code info is printed onto the console as instructions for the user to follow when authenticating via DeviceCodeCredential. But, in the event user would like to override that behaviour and handle the device code info response, they can do so by specifying a challengeConsumer(Consumer<DeviceCodeInfo> challengeConsumer) when instantiating the device code credential.

Constructor Summary

Constructor Description
DeviceCodeInfo(String userCode, String deviceCode, String verificationUrl, OffsetDateTime expiresOn, String message)

Creates an instance of a device code info.

Method Summary

Modifier and Type Method and Description
String getDeviceCode()

Gets the code which should be included in the request for the access token.
OffsetDateTime getExpiresOn()

Gets the expiration time of device code.
String getMessage()

Gets the message which should be displayed to the user.
String getUserCode()

Gets the code which user needs to provide when authenticating at the verification URL.
String getVerificationUrl()

Gets the URL where user can authenticate.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

DeviceCodeInfo

public DeviceCodeInfo(String userCode, String deviceCode, String verificationUrl, OffsetDateTime expiresOn, String message)

Creates an instance of a device code info.

Parameters:

userCode - code which user needs to provide when authenticating at the verification URL
deviceCode - code which should be included in the request for the access token
verificationUrl - URL where user can authenticate
expiresOn - expiration time of device code in seconds
message - message which should be displayed to the user

Method Details

getDeviceCode

public String getDeviceCode()

Gets the code which should be included in the request for the access token.

Returns:

code which should be included in the request for the access token.

getExpiresOn

public OffsetDateTime getExpiresOn()

Gets the expiration time of device code.

Returns:

expiration time of device code.

getMessage

public String getMessage()

Gets the message which should be displayed to the user.

Returns:

message which should be displayed to the user.

getUserCode

public String getUserCode()

Gets the code which user needs to provide when authenticating at the verification URL.

Returns:

code which user needs to provide when authenticating at the verification URL.

getVerificationUrl

public String getVerificationUrl()

Gets the URL where user can authenticate.

Returns:

URL where user can authenticate.

Applies to