UserFederatedIdentityCredentialParameters Classe

  • java.lang.Object
    • com.microsoft.aad.msal4j.UserFederatedIdentityCredentialParameters

Implementações

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Objeto contendo parâmetros para o fluxo de Credenciais de Identidade Federada (user_fic) do Utilizador. Isto é usado para a Leg 3 do protocolo de identidade do agente, onde uma credencial de identidade federada (obtida a partir da Leg 2) é trocada por um token com âmbito do utilizador.

Pode ser usado como parâmetro para acquireToken(UserFederatedIdentityCredentialParameters parameters)

Resumo do Método

Modificador e Tipo Método e Descrição
java.lang.String assertion()
static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

Construtor para UserFederatedIdentityCredentialParameters usar um UPN (Nome Principal de Utilizador).

static UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

Construtor para UserFederatedIdentityCredentialParameters usar um ID de Objeto de utilizador.

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 UserFederatedIdentityCredentialParametersBuilder#claimsFromClient(String).

java.lang.String computeExtCacheKeyHash()

Calcula o hash da chave de cache estendida a partir de todos os componentes da chave de cache, ou uma string vazia quando não houver nenhuma.

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

Presente apenas para cumprir o contrato de IAcquireTokenParameters interface. Não recomendado para uso — esta API está agendada para remoção em todas as classes de parâmetros e será substituída por um novo mecanismo numa versão futura.

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

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

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

java.lang.String tenant()

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

java.lang.String username()
java.util.UUID userObjectId()

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

assertion

public String assertion()

Devoluções:

a Afirmação Federada de Credenciais de Identidade (JWT)

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, String username, String assertion)

Construtor para UserFederatedIdentityCredentialParameters usar um UPN (Nome Principal de Utilizador).

Parâmetros:

scopes - A aplicação Scopes está a solicitar acesso a
username - o UPN do utilizador alvo (por exemplo, "user@contoso.com")
assertion - a confirmação federada de credenciais de identidade (JWT) obtida na Leg 2

Devoluções:

builder que pode ser usado para construir UserFederatedIdentityCredentialParameters

builder

public static UserFederatedIdentityCredentialParameters.UserFederatedIdentityCredentialParametersBuilder builder(Set<String> scopes, UUID userObjectId, String assertion)

Construtor para UserFederatedIdentityCredentialParameters usar um ID de Objeto de utilizador.

Parâmetros:

scopes - A aplicação Scopes está a solicitar acesso a
userObjectId - o ID do Objeto (OID) do utilizador alvo
assertion - a confirmação federada de credenciais de identidade (JWT) obtida na Leg 2

Devoluções:

builder que pode ser usado para construir UserFederatedIdentityCredentialParameters

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 UserFederatedIdentityCredentialParametersBuilder#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.

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Calcula o hash da chave de cache estendida a partir de todos os componentes da chave de cache, ou uma string vazia quando não houver nenhuma. O resultado é memoizado, pois os parâmetros são imutáveis após a construção.

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

Presente apenas para cumprir o contrato de IAcquireTokenParameters interface. Não recomendado para uso — esta API está agendada para remoção em todas as classes de parâmetros e será substituída por um novo mecanismo numa versão futura.

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.

forceRefresh

public boolean forceRefresh()

Devoluções:

se deve contornar a cache do token e forçar um novo pedido de token

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.

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

username

public String username()

Devoluções:

o UPN do utilizador alvo, ou nulo se o utilizador foi identificado pelo ID do Objeto

userObjectId

public UUID userObjectId()

Devoluções:

o ID do objeto do utilizador alvo, ou nulo se o utilizador foi identificado por UPN

Aplica-se a