Package com.azure.identity.broker

Class InteractiveBrowserBrokerCredentialBuilder

java.lang.Object

com.azure.identity.CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

com.azure.identity.AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

com.azure.identity.InteractiveBrowserCredentialBuilder

com.azure.identity.broker.InteractiveBrowserBrokerCredentialBuilder

All Implemented Interfaces:

com.azure.core.client.traits.HttpTrait<InteractiveBrowserCredentialBuilder>

public class InteractiveBrowserBrokerCredentialBuilder
extends InteractiveBrowserCredentialBuilder

Fluent credential builder for instantiating a InteractiveBrowserCredential configured to use a secure broker.

Sample: Construct a InteractiveBrowserCredential for brokered authentication

the following code sample shows to use this type:

 InteractiveBrowserBrokerCredentialBuilder builder = new InteractiveBrowserBrokerCredentialBuilder();
 InteractiveBrowserCredential credential = builder.build();
 

Constructor Summary

Constructors

Constructor	Description
InteractiveBrowserBrokerCredentialBuilder()	Creates a new instance of InteractiveBrowserBrokerCredentialBuilder.

Method Summary

Modifier and Type	Method	Description
InteractiveBrowserBrokerCredentialBuilder	additionallyAllowedTenants(String... additionallyAllowedTenants)
InteractiveBrowserBrokerCredentialBuilder	additionallyAllowedTenants(List<String> additionallyAllowedTenants)
InteractiveBrowserBrokerCredentialBuilder	addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)
InteractiveBrowserBrokerCredentialBuilder	authenticationRecord(AuthenticationRecord authenticationRecord)
InteractiveBrowserBrokerCredentialBuilder	authorityHost(String authorityHost)
InteractiveBrowserBrokerCredentialBuilder	browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions)
InteractiveBrowserBrokerCredentialBuilder	clientId(String clientId)
InteractiveBrowserBrokerCredentialBuilder	clientOptions(com.azure.core.util.ClientOptions clientOptions)
InteractiveBrowserBrokerCredentialBuilder	configuration(com.azure.core.util.Configuration configuration)
InteractiveBrowserBrokerCredentialBuilder	disableAutomaticAuthentication()
InteractiveBrowserBrokerCredentialBuilder	disableInstanceDiscovery()
InteractiveBrowserBrokerCredentialBuilder	enableAccountIdentifierLogging()
InteractiveBrowserBrokerCredentialBuilder	enableLegacyMsaPassthrough()	Enables Microsoft Account (MSA) pass-through.
InteractiveBrowserBrokerCredentialBuilder	enableUnsafeSupportLogging()
InteractiveBrowserBrokerCredentialBuilder	executorService(ExecutorService executorService)
InteractiveBrowserBrokerCredentialBuilder	httpClient(com.azure.core.http.HttpClient client)
InteractiveBrowserBrokerCredentialBuilder	httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)
InteractiveBrowserBrokerCredentialBuilder	httpPipeline(com.azure.core.http.HttpPipeline httpPipeline)
InteractiveBrowserBrokerCredentialBuilder	loginHint(String loginHint)
InteractiveBrowserBrokerCredentialBuilder	maxRetry(int maxRetry)
InteractiveBrowserBrokerCredentialBuilder	pipeline(com.azure.core.http.HttpPipeline pipeline)
InteractiveBrowserBrokerCredentialBuilder	port(int port)
InteractiveBrowserBrokerCredentialBuilder	proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)
InteractiveBrowserBrokerCredentialBuilder	redirectUrl(String redirectUrl)
InteractiveBrowserBrokerCredentialBuilder	retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)
InteractiveBrowserBrokerCredentialBuilder	retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)
InteractiveBrowserBrokerCredentialBuilder	retryTimeout(Function<Duration,Duration> retryTimeout)
InteractiveBrowserBrokerCredentialBuilder	setWindowHandle(long windowHandle)	Sets the parent window handle used by the broker.
InteractiveBrowserBrokerCredentialBuilder	tenantId(String tenantId)
InteractiveBrowserBrokerCredentialBuilder	tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)
InteractiveBrowserCredentialBuilder	useDefaultBrokerAccount()	Enables automatically using the default broker account for authentication instead of prompting the user with an account picker.

Methods inherited from class com.azure.identity.InteractiveBrowserCredentialBuilder

build

Methods inherited from class java.lang.Object

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

Constructor Details

InteractiveBrowserBrokerCredentialBuilder

public InteractiveBrowserBrokerCredentialBuilder()

Creates a new instance of InteractiveBrowserBrokerCredentialBuilder.

Method Details

setWindowHandle

public InteractiveBrowserBrokerCredentialBuilder setWindowHandle(long windowHandle)

Sets the parent window handle used by the broker. For use on Windows only.

Parameters:

windowHandle - The window handle of the current application, or 0 for a console application.

Returns:

An updated instance of this builder with the interactive browser broker configured.

enableLegacyMsaPassthrough

public InteractiveBrowserBrokerCredentialBuilder enableLegacyMsaPassthrough()

Enables Microsoft Account (MSA) pass-through. This allows the user to sign in with a Microsoft Account (MSA) instead of a work or school account.

Returns:

An updated instance of this builder with enable Legacy MSA Passthrough set to true.

useDefaultBrokerAccount

public InteractiveBrowserCredentialBuilder useDefaultBrokerAccount()

Enables automatically using the default broker account for authentication instead of prompting the user with an account picker.

Returns:

An updated instance of this builder with useDefaultBrokerAccount set.

clientOptions

public InteractiveBrowserBrokerCredentialBuilder clientOptions(com.azure.core.util.ClientOptions clientOptions)

Specified by:

clientOptions in interface com.azure.core.client.traits.HttpTrait<InteractiveBrowserCredentialBuilder>

Overrides:

clientOptions in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

addPolicy

public InteractiveBrowserBrokerCredentialBuilder addPolicy(com.azure.core.http.policy.HttpPipelinePolicy policy)

Specified by:

addPolicy in interface com.azure.core.client.traits.HttpTrait<InteractiveBrowserCredentialBuilder>

Overrides:

addPolicy in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

port

public InteractiveBrowserBrokerCredentialBuilder port(int port)

Overrides:

port in class InteractiveBrowserCredentialBuilder

additionallyAllowedTenants

public InteractiveBrowserBrokerCredentialBuilder additionallyAllowedTenants(String... additionallyAllowedTenants)

Overrides:

additionallyAllowedTenants in class InteractiveBrowserCredentialBuilder

authenticationRecord

public InteractiveBrowserBrokerCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)

Overrides:

authenticationRecord in class InteractiveBrowserCredentialBuilder

browserCustomizationOptions

public InteractiveBrowserBrokerCredentialBuilder browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions)

Overrides:

browserCustomizationOptions in class InteractiveBrowserCredentialBuilder

clientId

public InteractiveBrowserBrokerCredentialBuilder clientId(String clientId)

Overrides:

clientId in class InteractiveBrowserCredentialBuilder

configuration

public InteractiveBrowserBrokerCredentialBuilder configuration(com.azure.core.util.Configuration configuration)

Overrides:

configuration in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

authorityHost

public InteractiveBrowserBrokerCredentialBuilder authorityHost(String authorityHost)

Overrides:

authorityHost in class AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

disableAutomaticAuthentication

public InteractiveBrowserBrokerCredentialBuilder disableAutomaticAuthentication()

Overrides:

disableAutomaticAuthentication in class InteractiveBrowserCredentialBuilder

disableInstanceDiscovery

public InteractiveBrowserBrokerCredentialBuilder disableInstanceDiscovery()

Overrides:

disableInstanceDiscovery in class AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

enableAccountIdentifierLogging

public InteractiveBrowserBrokerCredentialBuilder enableAccountIdentifierLogging()

Overrides:

enableAccountIdentifierLogging in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

enableUnsafeSupportLogging

public InteractiveBrowserBrokerCredentialBuilder enableUnsafeSupportLogging()

Overrides:

enableUnsafeSupportLogging in class AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

executorService

public InteractiveBrowserBrokerCredentialBuilder executorService(ExecutorService executorService)

Overrides:

executorService in class AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

httpClient

public InteractiveBrowserBrokerCredentialBuilder httpClient(com.azure.core.http.HttpClient client)

Specified by:

httpClient in interface com.azure.core.client.traits.HttpTrait<InteractiveBrowserCredentialBuilder>

Overrides:

httpClient in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

httpLogOptions

public InteractiveBrowserBrokerCredentialBuilder httpLogOptions(com.azure.core.http.policy.HttpLogOptions logOptions)

Specified by:

httpLogOptions in interface com.azure.core.client.traits.HttpTrait<InteractiveBrowserCredentialBuilder>

Overrides:

httpLogOptions in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

loginHint

public InteractiveBrowserBrokerCredentialBuilder loginHint(String loginHint)

Overrides:

loginHint in class InteractiveBrowserCredentialBuilder

pipeline

public InteractiveBrowserBrokerCredentialBuilder pipeline(com.azure.core.http.HttpPipeline pipeline)

Specified by:

pipeline in interface com.azure.core.client.traits.HttpTrait<InteractiveBrowserCredentialBuilder>

Overrides:

pipeline in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

maxRetry

public InteractiveBrowserBrokerCredentialBuilder maxRetry(int maxRetry)

Overrides:

maxRetry in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

redirectUrl

public InteractiveBrowserBrokerCredentialBuilder redirectUrl(String redirectUrl)

Overrides:

redirectUrl in class InteractiveBrowserCredentialBuilder

additionallyAllowedTenants

public InteractiveBrowserBrokerCredentialBuilder additionallyAllowedTenants(List<String> additionallyAllowedTenants)

Overrides:

additionallyAllowedTenants in class InteractiveBrowserCredentialBuilder

retryOptions

public InteractiveBrowserBrokerCredentialBuilder retryOptions(com.azure.core.http.policy.RetryOptions retryOptions)

Specified by:

retryOptions in interface com.azure.core.client.traits.HttpTrait<InteractiveBrowserCredentialBuilder>

Overrides:

retryOptions in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

retryPolicy

public InteractiveBrowserBrokerCredentialBuilder retryPolicy(com.azure.core.http.policy.RetryPolicy retryPolicy)

Overrides:

retryPolicy in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

tenantId

public InteractiveBrowserBrokerCredentialBuilder tenantId(String tenantId)

Overrides:

tenantId in class AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

retryTimeout

public InteractiveBrowserBrokerCredentialBuilder retryTimeout(Function<Duration,Duration> retryTimeout)

Overrides:

retryTimeout in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

tokenCachePersistenceOptions

public InteractiveBrowserBrokerCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Overrides:

tokenCachePersistenceOptions in class InteractiveBrowserCredentialBuilder

httpPipeline

public InteractiveBrowserBrokerCredentialBuilder httpPipeline(com.azure.core.http.HttpPipeline httpPipeline)

Overrides:

httpPipeline in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>

proxyOptions

public InteractiveBrowserBrokerCredentialBuilder proxyOptions(com.azure.core.http.ProxyOptions proxyOptions)

Overrides:

proxyOptions in class CredentialBuilderBase<InteractiveBrowserCredentialBuilder>