ClientAssertionCredentialBuilder 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.ClientAssertionCredentialBuilder

public class ClientAssertionCredentialBuilder
extends AadCredentialBuilderBase<ClientAssertionCredentialBuilder>

Construtor de credenciais fluente para instanciar um ClientAssertionCredential.

O ClientAssertionCredential adquire um token por meio da asserção do cliente e da autenticação da entidade de serviço. Esse método de autenticação fornece uma maneira segura e escalonável para que os aplicativos cliente acessem recursos do Azure sem a necessidade de os usuários fornecerem suas credenciais. Geralmente, ele é usado em cenários em que um aplicativo cliente precisa acessar recursos do Azure em nome de um usuário, como em uma arquitetura de aplicativo de várias camadas. Nesse método de autenticação, o aplicativo cliente cria um JWT (Token Web JSON) que inclui informações sobre a entidade de serviço (como sua ID de cliente e ID de locatário) e o assina usando um segredo do cliente. Em seguida, o cliente envia esse token para o Azure Active Directory (Azure AD) como prova de sua identidade. Azure AD verifica a assinatura do token e verifica se a entidade de serviço tem as permissões necessárias para acessar o recurso do Azure solicitado. Se o token for válido e a entidade de serviço estiver autorizada, Azure AD emitirá um token de acesso que o aplicativo cliente pode usar para acessar o recurso solicitado. O ClientAssertionCredential adquire um token de acesso com uma declaração de cliente cliente para uma entidade de serviço/aplicativo AAD registrado. A tenantId, clientId e clientAssertion da entidade de serviço são necessárias para que essa credencial adquira um token de acesso. Ele pode ser usado em ambientes de desenvolvimento hospedados no Azure e locais para autenticação.

Exemplo: Construir um ClientAssertionCredential simples

O exemplo de código a seguir demonstra a criação de um ClientAssertionCredential, usando o ClientAssertionCredentialBuilder para configurá-lo. Os tenantIdparâmetros , clientId e certificate são necessários para criar ClientAssertionCredential. Depois que essa credencial for criada, ela poderá ser passada para o construtor de muitos dos construtores de clientes do SDK do Azure para Java como o parâmetro "credencial".

TokenCredential clientAssertionCredential = new ClientAssertionCredentialBuilder()
     .tenantId(tenantId)
     .clientId(clientId)
     .clientAssertion(() -> "<Client-Assertion>")
     .build();

Exemplo: Construir um ClientAssertionCredential por trás de um proxy

O exemplo de código a seguir demonstra a criação de um ClientAssertionCredential, usando o ClientAssertionCredentialBuilder para configurá-lo. Os tenantIdparâmetros , clientId e clientAssertion são necessários para criar ClientAssertionCredential. Opcionalmente, o THe proxyOptions pode ser configurado para direcionar um proxy. Depois que essa credencial for criada, ela poderá ser passada para o construtor de muitos dos construtores de clientes do SDK do Azure para Java como o parâmetro "credencial".

TokenCredential assertionCredential = new ClientAssertionCredentialBuilder()
     .tenantId(tenantId)
     .clientId(clientId)
     .clientAssertion(() -> "<Client-Assertion>")
     .proxyOptions(new ProxyOptions(Type.HTTP, new InetSocketAddress("10.21.32.43", 5465)))
     .build();

Resumo do Construtor

Construtor	Description
ClientAssertionCredentialBuilder()

Resumo do método

Modificador e tipo	Método e descrição
ClientAssertionCredential	build() Cria um novo ClientAssertionCredential com as configurações atuais.
ClientAssertionCredentialBuilder	clientAssertion(Supplier<String> clientAssertionSupplier) Define o fornecedor que contém a lógica para fornecer a declaração do cliente quando invocado.
ClientAssertionCredentialBuilder	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

ClientAssertionCredentialBuilder

public ClientAssertionCredentialBuilder()

Detalhes do método

build

public ClientAssertionCredential build()

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

Returns:

um ClientAssertionCredential com as configurações atuais.

clientAssertion

public ClientAssertionCredentialBuilder clientAssertion(Supplier clientAssertionSupplier)

Define o fornecedor que contém a lógica para fornecer a declaração do cliente quando invocado.

Parameters:

clientAssertionSupplier - o fornecedor que fornece declaração de cliente.

Returns:

Uma instância atualizada desse construtor.

tokenCachePersistenceOptions

public ClientAssertionCredentialBuilder 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, protegido para o usuário atual, que pode ser compartilhado 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.