DeviceCode Class

Package:
com.microsoft.aad.msal4j
Maven Artifact:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.DeviceCode

Implements

JsonSerializable<DeviceCode>

public final class DeviceCode
implements JsonSerializable<DeviceCode>

Response returned from the STS device code endpoint containing information necessary for device code flow

Constructor Summary

Constructor Description
DeviceCode()

Method Summary

Modifier and Type Method and Description
protected java.lang.String clientId()
protected DeviceCode clientId(String clientId)
protected java.lang.String correlationId()
protected DeviceCode correlationId(String correlationId)
java.lang.String deviceCode()

code which should be included in the request for the access token
long expiresIn()

expiration time of device code in seconds.
static DeviceCode fromJson(JsonReader jsonReader)
long interval()

interval at which the STS should be polled at
java.lang.String message()

message which should be displayed to the user.
protected java.lang.String scopes()
protected DeviceCode scopes(String scopes)
JsonWriter toJson(JsonWriter jsonWriter)
java.lang.String userCode()

code which user needs to provide when authenticating at the verification URI
java.lang.String verificationUri()

URI where user can authenticate

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

DeviceCode

public DeviceCode()

Method Details

clientId

protected String clientId()

clientId

protected DeviceCode clientId(String clientId)

Parameters:

clientId

correlationId

protected String correlationId()

correlationId

protected DeviceCode correlationId(String correlationId)

Parameters:

correlationId

deviceCode

public String deviceCode()

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

expiresIn

public long expiresIn()

expiration time of device code in seconds.

fromJson

public static DeviceCode fromJson(JsonReader jsonReader)

Parameters:

jsonReader

Throws:

java.io.IOException

interval

public long interval()

interval at which the STS should be polled at

message

public String message()

message which should be displayed to the user.

scopes

protected String scopes()

scopes

protected DeviceCode scopes(String scopes)

Parameters:

scopes

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

java.io.IOException

userCode

public String userCode()

code which user needs to provide when authenticating at the verification URI

verificationUri

public String verificationUri()

URI where user can authenticate

Applies to