ClientCredentialParameters Classe

  • 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 contendo 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()

Recebe o parâmetro de pedido de reclamações que será enviado com o pedido de autenticação.

java.lang.String clientClaims()

Reivindicações originadas pelo cliente estabelecidas via ClientCredentialParametersBuilder#claimsFromClient(String).

IClientCredential clientCredential()
java.lang.String computeExtCacheKeyHash()

Calcula o hash da chave de cache estendida a partir de todos os componentes da chave de cache.

java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Inclui cabeçalhos HTTP adicionais no pedido de token.

java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Preterido

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

Obtém parâmetros adicionais de consulta para serem incluídos no pedido de token.

java.lang.String fmiPath()

Obtém o caminho FMI (Federated Managed Identity) para cenários de identidade de agente.

java.util.Set<java.lang.String> scopes()

Recebe o conjunto de escopos (permissões) solicitados para o token de acesso.

java.lang.Boolean skipCache()
java.lang.String tenant()

Obtém o identificador do inquilino para o pedido 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 de Método

builder

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

Construtor para ClientCredentialParameters

Parâmetros:

scopes - A aplicação Scopes está a solicitar acesso a

Devoluções:

builder que pode ser usado para construir ClientCredentialParameters

claims

public ClaimsRequest claims()

Recebe o parâmetro de pedido de reclamações que será enviado com o pedido de autenticação.

O parâmetro de pedido de reivindicações pode ser usado para solicitar reivindicações específicas a serem devolvidas no token, para solicitar autenticação MFA ou para controlar outros aspetos da emissão do token.

clientClaims

public String clientClaims()

Reivindicações originadas pelo cliente estabelecidas via ClientCredentialParametersBuilder#claimsFromClient(String). Encaminhado para o endpoint do token como parâmetro OAuth claims e usado como parte da chave de cache estendida, para que valores distintos das reivindicações sejam armazenados em cache separadamente.

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Calcula o hash da chave de cache estendida a partir de todos os componentes da chave de cache. Devolve uma cadeia vazia se não houver componentes presentes.

O resultado é memorizado porque o ClientCredentialParameters é imutável após a construção. Usado tanto por escritas de cache (TokenCache) como por leituras de cache (consulta silenciosa).

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Inclui cabeçalhos HTTP adicionais no pedido de token.

Estes cabeçalhos serão adicionados aos pedidos HTTP enviados para o endpoint do token. Isto pode ser útil para cenários que requerem 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. Será removido numa versão futura, e o comportamento poderá ser substituído por uma nova API.

Obtém parâmetros adicionais de consulta para serem incluídos no pedido de token.

Estes parâmetros serão adicionados à cadeia de consulta nos pedidos para os endpoints de autorização e token. Isto pode ser útil para cenários que requerem parâmetros personalizados que não são explicitamente suportados na biblioteca.

fmiPath

public String fmiPath()

Obtém o caminho FMI (Federated Managed Identity) para cenários de identidade de agente. Quando definido, fmi_path é enviado como um parâmetro de corpo no pedido de token de credenciais do cliente, que atribui o âmbito do token resultante a uma identidade de agente específica.

Devoluções:

o caminho FMI, ou nulo se não estiver definido

scopes

public Set<String> scopes()

Recebe o conjunto de escopos (permissões) solicitados para o token de acesso.

Os escopos representam as permissões a que a aplicação solicita acesso.

skipCache

public Boolean skipCache()

tenant

public String tenant()

Obtém o identificador do inquilino para o pedido de token.

Quando especificado, este valor sobrepõe-se ao inquilino especificado na URL de autoridade da aplicação. Pode ser um ID de inquilino (GUID), nome de domínio ou um dos valores especiais como "comum" ou "organizações".

Aplica-se a