InteractiveBrowserCredentialBuilder Classe

Pacote:

com.azure.identity

Artefato Maven:

com.azure:azure-identity:1.10.4

• java.lang.Object
• • com.azure.identity.CredentialBuilderBase<T>
  • • com.azure.identity.AadCredentialBuilderBase<T>
    • • com.azure.identity.InteractiveBrowserCredentialBuilder

public class InteractiveBrowserCredentialBuilder
extends AadCredentialBuilderBase<InteractiveBrowserCredentialBuilder>

Construtor de credenciais fluente para instanciar um InteractiveBrowserCredential.

A autenticação interativa do navegador é um tipo de fluxo de autenticação oferecido pelo Azure Active Directory (Azure AD) que permite que os usuários entrem em aplicativos e serviços usando um navegador da Web. Esse método de autenticação é comumente usado para aplicativos Web, em que os usuários inserem suas credenciais diretamente em uma página da Web. Com a autenticação interativa do navegador, o usuário navega até um aplicativo Web e é solicitado a inserir suas credenciais de nome de usuário e senha. Em seguida, o aplicativo redireciona o usuário para a página de entrada do Azure AD, na qual será solicitado que ele insira suas credenciais novamente. Depois que o usuário é autenticado com êxito, Azure AD emite um token de segurança que o aplicativo pode usar para autorizar o acesso do usuário aos seus recursos. O InteractiveBrowserCredential autentica interativamente um usuário e adquire um token com o navegador do sistema padrão e oferece uma experiência de autenticação suave, permitindo que um usuário use suas próprias credenciais para autenticar o aplicativo. Quando autenticado, o fluxo oauth2 notifica a credencial do código de autenticação por meio da URL de resposta. Para obter mais informações, consulte os detalhes conceituais de conhecimento e configuração.

Exemplo: Construir InteractiveBrowserCredential

O exemplo de código a seguir demonstra a criação de um InteractiveBrowserCredential, usando o InteractiveBrowserCredentialBuilder para configurá-lo. Por padrão, a credencial tem como destino uma URL de redirecionamento de localhost para substituir esse comportamento que um redirectUrl(String redirectUrl) pode ser especificado opcionalmente. Depois que essa credencial é criada, ela pode ser passada para o construtor de muitos dos construtores de cliente do SDK do Azure para Java como o parâmetro 'credential'.

TokenCredential interactiveBrowserCredential = new InteractiveBrowserCredentialBuilder()
     .redirectUrl("http://localhost:8765")
     .build();

Resumo do Construtor

Construtor	Description
InteractiveBrowserCredentialBuilder()

Resumo do método

Modificador e tipo	Método e descrição
InteractiveBrowserCredentialBuilder	additionallyAllowedTenants(String[] additionallyAllowedTenants) Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens.
InteractiveBrowserCredentialBuilder	additionallyAllowedTenants(List<String> additionallyAllowedTenants) Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens.
InteractiveBrowserCredentialBuilder	authenticationRecord(AuthenticationRecord authenticationRecord) Define o AuthenticationRecord capturado de uma autenticação anterior.
InteractiveBrowserCredentialBuilder	browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions) Configura as opções para personalizar o navegador para autenticação interativa.
InteractiveBrowserCredential	build() Cria um novo InteractiveBrowserCredential com as configurações atuais.
InteractiveBrowserCredentialBuilder	disableAutomaticAuthentication() Desabilita a autenticação automática e impede que o InteractiveBrowserCredential solicite automaticamente o usuário.
InteractiveBrowserCredentialBuilder	loginHint(String loginHint) Define a sugestão de nome de usuário para preencher previamente o campo nome de usuário/endereço de email da página de logon.
InteractiveBrowserCredentialBuilder	port(int port) Preterido Configure a URL de redirecionamento como http://localhost:{port} por meio redirectUrl(String redirectUrl) de . Define a porta para o servidor HTTP local, para a qual http://localhost:{port} deve ser registrada como uma URL de resposta válida no aplicativo.
InteractiveBrowserCredentialBuilder	redirectUrl(String redirectUrl) Define a URL de Redirecionamento em que o STS fará o retorno de chamada do aplicativo com o código de segurança.
InteractiveBrowserCredentialBuilder	tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions) Configura as opções persistentes de cache de token compartilhado e habilita o cache de token persistente que está desabilitado por padrão.

Métodos herdados de AadCredentialBuilderBase

additionallyAllowedTenants additionallyAllowedTenants authorityHost clientId disableInstanceDiscovery enableUnsafeSupportLogging executorService tenantId

Métodos herdados de CredentialBuilderBase

addPolicy clientOptions configuration enableAccountIdentifierLogging httpClient httpLogOptions httpPipeline maxRetry pipeline proxyOptions retryOptions retryPolicy retryTimeout

Métodos herdados de java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Detalhes do construtor

InteractiveBrowserCredentialBuilder

public InteractiveBrowserCredentialBuilder()

Detalhes do método

additionallyAllowedTenants

public InteractiveBrowserCredentialBuilder additionallyAllowedTenants(String[] additionallyAllowedTenants)

Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário no qual o aplicativo está instalado. Se nenhum valor for especificado para TenantId, essa opção não terá efeito e a credencial adquirirá tokens para qualquer locatário solicitado.

Overrides:

InteractiveBrowserCredentialBuilder.additionallyAllowedTenants(String[] additionallyAllowedTenants)

Parameters:

additionallyAllowedTenants - os locatários permitidos adicionalmente.

Returns:

Uma instância atualizada desse construtor com os locatários adicionais configurados.

additionallyAllowedTenants

public InteractiveBrowserCredentialBuilder additionallyAllowedTenants(List additionallyAllowedTenants)

Para aplicativos multilocatário, especifica locatários adicionais para os quais a credencial pode adquirir tokens. Adicione o valor curinga "*" para permitir que a credencial adquira tokens para qualquer locatário no qual o aplicativo está instalado. Se nenhum valor for especificado para TenantId, essa opção não terá efeito e a credencial adquirirá tokens para qualquer locatário solicitado.

Overrides:

InteractiveBrowserCredentialBuilder.additionallyAllowedTenants(List<String> additionallyAllowedTenants)

Parameters:

additionallyAllowedTenants - os locatários permitidos adicionalmente.

Returns:

Uma instância atualizada desse construtor com os locatários adicionais configurados.

authenticationRecord

public InteractiveBrowserCredentialBuilder authenticationRecord(AuthenticationRecord authenticationRecord)

Define o AuthenticationRecord capturado de uma autenticação anterior.

Parameters:

authenticationRecord - O registro de autenticação a ser configurado.

Returns:

Uma instância atualizada desse construtor com o registro de autenticação configurado.

browserCustomizationOptions

public InteractiveBrowserCredentialBuilder browserCustomizationOptions(BrowserCustomizationOptions browserCustomizationOptions)

Configura as opções para personalizar o navegador para autenticação interativa.

Parameters:

browserCustomizationOptions - as opções de personalização do navegador

Returns:

Uma instância atualizada desse construtor com as opções de personalização do navegador configuradas.

build

public InteractiveBrowserCredential build()

Cria um novo InteractiveBrowserCredential com as configurações atuais.

Returns:

um InteractiveBrowserCredential com as configurações atuais.

disableAutomaticAuthentication

public InteractiveBrowserCredentialBuilder disableAutomaticAuthentication()

Desabilita a autenticação automática e impede que o InteractiveBrowserCredential solicite automaticamente o usuário. Se a autenticação automática estiver desabilitada, um AuthenticationRequiredException será gerado no caso de a interação do getToken(TokenRequestContext request) usuário ser necessária. O aplicativo é responsável por lidar com essa exceção e chamar authenticate() ou authenticate(TokenRequestContext request) autenticar o usuário interativamente.

Returns:

Uma instância atualizada desse construtor com a autenticação automática desabilitada.

loginHint

public InteractiveBrowserCredentialBuilder loginHint(String loginHint)

Define a sugestão de nome de usuário para preencher previamente o campo nome de usuário/endereço de email da página de logon. Um usuário ainda pode fazer logon com um nome de usuário diferente.

Parameters:

loginHint - a sugestão de nome de usuário para preencher previamente o campo nome de usuário/endereço de email da página de logon.

Returns:

Uma instância atualizada desse construtor com a dica de logon configurada.

port

@Deprecated
public InteractiveBrowserCredentialBuilder port(int port)

Preterido

Configure a URL de redirecionamento como http://localhost:{port} por meio redirectUrl(String redirectUrl) de .

Define a porta para o servidor HTTP local, para a qual http://localhost:{port} deve ser registrada como uma URL de resposta válida no aplicativo.

Parameters:

port - a porta na qual a credencial escutará o resultado da autenticação do navegador

Returns:

o InteractiveBrowserCredentialBuilder propriamente dito

redirectUrl

public InteractiveBrowserCredentialBuilder redirectUrl(String redirectUrl)

Define a URL de Redirecionamento em que o STS fará o retorno de chamada do aplicativo com o código de segurança. Ele será necessário se uma ID de cliente personalizada for especificada por meio InteractiveBrowserCredentialBuilder#clientId(String) de e precisar corresponder à URL de redirecionamento especificada durante o registro do aplicativo.

Parameters:

redirectUrl - a URL de redirecionamento para escutar e receber o código de segurança.

Returns:

Uma instância atualizada desse construtor com a URL de redirecionamento configurada.

tokenCachePersistenceOptions

public InteractiveBrowserCredentialBuilder tokenCachePersistenceOptions(TokenCachePersistenceOptions tokenCachePersistenceOptions)

Configura as opções persistentes de cache de token compartilhado e habilita o cache de token persistente que está desabilitado por padrão. Se configurada, a credencial armazenará tokens em um cache persistido no computador, protegidos para o usuário atual, que podem ser compartilhados por outras credenciais e processos.

Parameters:

tokenCachePersistenceOptions - as opções de configuração de cache de token

Returns:

Uma instância atualizada desse construtor com as opções de cache de token configuradas.