com.microsoft.aad.msal4j

Class DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder

java.lang.Object

com.microsoft.aad.msal4j.DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder

Enclosing class:

DeviceCodeFlowParameters

public static class DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
DeviceCodeFlowParameters	build()
DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder	claims(ClaimsRequest claims) Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims
DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder	deviceCodeConsumer(@NonNull Consumer<DeviceCode> deviceCodeConsumer) Receives the device code returned from the first step of Oauth2.0 device code flow.
DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder	extraHttpHeaders(Map<String,String> extraHttpHeaders) Adds additional headers to the token request
DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder	extraQueryParameters(Map<String,String> extraQueryParameters) Adds additional query parameters to the token request
DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder	scopes(@NonNull Set<String> scopes) Scopes to which the application is requesting access to.
DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder	tenant(String tenant) Overrides the tenant value in the authority URL for this request
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

scopes

public DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder scopes(@NonNull
                                                                       @NonNull Set<String> scopes)

Scopes to which the application is requesting access to.

Returns:

this.

deviceCodeConsumer

public DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder deviceCodeConsumer(@NonNull
                                                                                   @NonNull Consumer<DeviceCode> deviceCodeConsumer)

Receives the device code returned from the first step of Oauth2.0 device code flow. The DeviceCode.verificationUri and the DeviceCode.userCode should be shown to the end user.

For more details, see https://aka.ms/msal4j-device-code

Returns:

this.

claims

public DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder claims(ClaimsRequest claims)

Claims to be requested through the OIDC claims request parameter, allowing requests for standard and custom claims

Returns:

this.

extraHttpHeaders

public DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Adds additional headers to the token request

Returns:

this.

extraQueryParameters

public DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Adds additional query parameters to the token request

Returns:

this.

tenant

public DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder tenant(String tenant)

Overrides the tenant value in the authority URL for this request

Returns:

this.

build

public DeviceCodeFlowParameters build()

toString

public String toString()

Overrides:

toString in class Object