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

public class OnBehalfOfCredentialBuilder
extends AadCredentialBuilderBase<OnBehalfOfCredentialBuilder>

Construtor de credenciais fluente para instanciar um OnBehalfOfCredential.

Em nome da autenticação no Azure, é uma maneira de um usuário ou aplicativo se autenticar em um serviço ou recurso usando credenciais de outro provedor de identidade. Esse tipo de autenticação normalmente é usado quando um usuário ou aplicativo deseja acessar um recurso no Azure, mas suas credenciais são gerenciadas por um provedor de identidade diferente, como um Active Directory local ou um provedor de identidade de terceiros. Para usar a autenticação "Em Nome de" no Azure, o usuário deve primeiro autenticar-se no provedor de identidade usando suas credenciais. Em seguida, o provedor de identidade emite um token de segurança que contém informações sobre o usuário e suas permissões. Esse token de segurança é então passado para o Azure, que o usa para autenticar o usuário ou aplicativo e conceder-lhes acesso ao recurso solicitado. O OnBehalfOfCredential adquire um token com um segredo do cliente/certificado e declaração de usuário para um aplicativo AAD em nome de uma entidade de segurança de usuário.

O exemplo de código a seguir demonstra a criação de um OnBehalfOfCredential, usando o OnBehalfOfCredentialBuilder para configurá-lo. Os tenantIdparâmetros , clientId e clientSecret são necessários para criar OnBehalfOfCredential. Opcionalmente userAssertion , o pode ser especificado no OnBehalfOfCredentialBuilder. 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 onBehalfOfCredential = new OnBehalfOfCredentialBuilder()
     .clientId("<app-client-ID>")
     .clientSecret("<app-Client-Secret>")
     .tenantId("<app-tenant-ID>")
     .userAssertion("<user-assertion>")
     .build();

Resumo do Construtor

Construtor	Description
OnBehalfOfCredentialBuilder()

Resumo do método

Modificador e tipo	Método e descrição
OnBehalfOfCredential	build() Cria um novo OnBehalfOfCredential com as configurações atuais.
OnBehalfOfCredentialBuilder	clientCertificatePassword(String clientCertificatePassword) Define a senha do certificado do cliente para autenticação no AAD.
OnBehalfOfCredentialBuilder	clientSecret(String clientSecret) Define o segredo do cliente para a autenticação.
OnBehalfOfCredentialBuilder	pemCertificate(String pemCertificatePath) Define o caminho do certificado PEM para autenticação no AAD.
OnBehalfOfCredentialBuilder	pfxCertificate(String pfxCertificatePath) Define o caminho e a senha do certificado PFX para autenticação no AAD.
OnBehalfOfCredentialBuilder	sendCertificateChain(boolean sendCertificateChain) Especifica se a declaração x5c (chave pública do certificado) deve ser enviada como parte da solicitação de autenticação e habilitar a autenticação baseada em nome da entidade/emissor.
OnBehalfOfCredentialBuilder	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.
OnBehalfOfCredentialBuilder	userAssertion(String userAssertion) Configure o Escopo da Declaração de Usuário a ser usado para a solicitação EmNomeda Autenticaçã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

OnBehalfOfCredentialBuilder

public OnBehalfOfCredentialBuilder()

Detalhes do método

build

public OnBehalfOfCredential build()

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

Returns:

um OnBehalfOfCredential com as configurações atuais.

clientCertificatePassword

public OnBehalfOfCredentialBuilder clientCertificatePassword(String clientCertificatePassword)

Define a senha do certificado do cliente para autenticação no AAD.

Parameters:

clientCertificatePassword - a senha que protege o certificado

Returns:

Uma instância atualizada desse construtor.

clientSecret

public OnBehalfOfCredentialBuilder clientSecret(String clientSecret)

Define o segredo do cliente para a autenticação.

Parameters:

clientSecret - o valor secreto do aplicativo AAD.

Returns:

Uma instância atualizada desse construtor.

pemCertificate

public OnBehalfOfCredentialBuilder pemCertificate(String pemCertificatePath)

Define o caminho do certificado PEM para autenticação no AAD.

Parameters:

pemCertificatePath - o arquivo PEM que contém o certificado

Returns:

Uma instância atualizada desse construtor.

pfxCertificate

public OnBehalfOfCredentialBuilder pfxCertificate(String pfxCertificatePath)

Define o caminho e a senha do certificado PFX para autenticação no AAD.

Parameters:

pfxCertificatePath - o arquivo PFX protegido por senha que contém o certificado

Returns:

Uma instância atualizada desse construtor.

sendCertificateChain

public OnBehalfOfCredentialBuilder sendCertificateChain(boolean sendCertificateChain)

Especifica se a declaração x5c (chave pública do certificado) deve ser enviada como parte da solicitação de autenticação e habilitar a autenticação baseada em nome da entidade/emissor. O valor padrão é false.

Parameters:

sendCertificateChain - o sinalizador para indicar se a cadeia de certificados deve ser enviada como parte da solicitação de autenticação.

Returns:

Uma instância atualizada desse construtor.

tokenCachePersistenceOptions

public OnBehalfOfCredentialBuilder 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.

userAssertion

public OnBehalfOfCredentialBuilder userAssertion(String userAssertion)

Configure o Escopo da Declaração de Usuário a ser usado para a solicitação de Autenticação OnBehalfOf.

Parameters:

userAssertion - o token de acesso de declaração de usuário a ser usado para Em nome do fluxo de autenticação

Returns:

Uma instância atualizada desse construtor com o escopo de declaração do usuário configurado.