ClientCredentialParameters Classe

Pacote:
com.microsoft.aad.msal4j
Artefato Maven:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.ClientCredentialParameters

Implementações

com.microsoft.aad.msal4j.IAcquireTokenParameters

public class ClientCredentialParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

Objeto que contém parâmetros para o fluxo de credenciais do cliente. Pode ser usado como parâmetro para acquireToken(ClientCredentialParameters parameters)

Resumo do método

Modificador e tipo Método e descrição
static ClientCredentialParametersBuilder builder(Set<String> scopes)

Construtor para ClientCredentialParameters
ClaimsRequest claims()

Obtém o parâmetro de solicitação de declarações que será enviado com a solicitação de autenticação.
java.lang.String clientClaims()

Declarações originadas pelo cliente definidas por meio de ClientCredentialParametersBuilder#claimsFromClient(String).
IClientCredential clientCredential()
java.lang.String computeExtCacheKeyHash()

Calcula o hash de chave de cache estendido de todos os componentes de chave de cache.
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Obtém cabeçalhos HTTP adicionais a serem incluídos na solicitação de token.
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Preterido

Não recomendado para cenários de produção. Ele será removido em uma versão futura e o comportamento poderá ser substituído por uma nova API.

Obtém parâmetros de consulta adicionais a serem incluídos na solicitação de token.
java.lang.String fmiPath()

Obtém o caminho FMI (Identidade Gerenciada Federada) para cenários de identidade do agente.
java.util.Set<java.lang.String> scopes()

Obtém o conjunto de escopos (permissões) solicitados para o token de acesso.
java.lang.Boolean skipCache()
java.lang.String tenant()

Obtém o identificador de locatário para a solicitação de token.

Métodos herdados de java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Detalhes do método

builder

public static ClientCredentialParameters.ClientCredentialParametersBuilder builder(Set<String> scopes)

Construtor para ClientCredentialParameters

Parâmetros:

scopes - o aplicativo scopes está solicitando acesso a

Retornos:

construtor que pode ser usado para construir ClientCredentialParameters

claims

public ClaimsRequest claims()

Obtém o parâmetro de solicitação de declarações que será enviado com a solicitação de autenticação.

O parâmetro de solicitação de declarações pode ser usado para solicitar declarações específicas a serem retornadas no token, para solicitar autenticação de MFA ou para controlar outros aspectos da emissão de token.

clientClaims

public String clientClaims()

Declarações originadas pelo cliente definidas por meio de ClientCredentialParametersBuilder#claimsFromClient(String). Encaminhado para o ponto de extremidade do token como o parâmetro OAuth claims e usado como parte da chave de cache estendida para que valores de declaração distintos sejam armazenados em cache separadamente.

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Calcula o hash de chave de cache estendido de todos os componentes de chave de cache. Retorna uma cadeia de caracteres vazia se nenhum componente estiver presente.

O resultado é memorando, pois ClientCredentialParameters é imutável após a construção. Usado por gravações de cache (TokenCache) e leituras de cache (pesquisa silenciosa).

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Obtém cabeçalhos HTTP adicionais a serem incluídos na solicitação de token.

Esses cabeçalhos serão adicionados às solicitações HTTP enviadas ao ponto de extremidade do token. Isso pode ser útil para cenários que exigem cabeçalhos personalizados para proxies ou para fins de diagnóstico.

extraQueryParameters


public Map<String,String> extraQueryParameters()

Preterido

Não recomendado para cenários de produção. Ele será removido em uma versão futura e o comportamento poderá ser substituído por uma nova API.

Obtém parâmetros de consulta adicionais a serem incluídos na solicitação de token.

Esses parâmetros serão adicionados à cadeia de caracteres de consulta em solicitações aos pontos de extremidade de autorização e token. Isso pode ser útil para cenários que exigem parâmetros personalizados que não têm suporte explícito na biblioteca.

fmiPath

public String fmiPath()

Obtém o caminho FMI (Identidade Gerenciada Federada) para cenários de identidade do agente. Quando definido, fmi_path é enviado como um parâmetro de corpo na solicitação de token de credenciais do cliente, que define o escopo do token resultante para uma identidade de agente específica.

Retornos:

o caminho do FMI ou nulo se não for definido

scopes

public Set<String> scopes()

Obtém o conjunto de escopos (permissões) solicitados para o token de acesso.

Os escopos representam as permissões às quais o aplicativo está solicitando acesso.

skipCache

public Boolean skipCache()

tenant

public String tenant()

Obtém o identificador de locatário para a solicitação de token.

Quando especificado, esse valor substitui o locatário especificado na URL de autoridade do aplicativo. Pode ser uma ID de locatário (GUID), um nome de domínio ou um dos valores especiais, como "common" ou "organizations".

Aplica-se a