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 que contém parâmetros para o fluxo de Credencial de Identidade Federada do Usuário (user_fic). Isso é usado para a Etapa 3 do protocolo de identidade do agente, em que uma credencial de identidade federada (obtida da Leg 2) é trocada por um token com escopo de usuário.

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 da Entidade de Segurança do Usuário).

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

Construtor para UserFederatedIdentityCredentialParameters usar uma ID de objeto de usuário.

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

java.lang.String computeExtCacheKeyHash()

Calcula o hash de chave de cache estendido de todos os componentes de chave de cache ou uma cadeia de caracteres vazia quando não há nenhum.

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

Apresentar somente para satisfazer o contrato de IAcquireTokenParameters interface. Não recomendado para uso — essa API está agendada para remoção em todas as classes de parâmetro e será substituída por um novo mecanismo em uma versão futura.

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

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

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

java.lang.String tenant()

Obtém o identificador de locatário para a solicitação 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 do método

assertion

public String assertion()

Retornos:

a declaração de credencial de identidade federada (JWT)

builder

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

Construtor para UserFederatedIdentityCredentialParameters usar um UPN (Nome da Entidade de Segurança do Usuário).

Parâmetros:

scopes - o aplicativo scopes está solicitando acesso a
username - o UPN do usuário de destino (por exemplo, "user@contoso.com")
assertion - a declaração de credencial de identidade federada (JWT) obtida da Perna 2

Retornos:

construtor que pode ser usado para construir UserFederatedIdentityCredentialParameters

builder

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

Construtor para UserFederatedIdentityCredentialParameters usar uma ID de objeto de usuário.

Parâmetros:

scopes - o aplicativo scopes está solicitando acesso a
userObjectId - a ID do objeto (OID) do usuário de destino
assertion - a declaração de credencial de identidade federada (JWT) obtida da Perna 2

Retornos:

construtor que pode ser usado para construir UserFederatedIdentityCredentialParameters

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

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Calcula o hash de chave de cache estendido de todos os componentes de chave de cache ou uma cadeia de caracteres vazia quando não há nenhum. O resultado é memorando, pois os parâmetros são imutáveis após a construção.

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

Apresentar somente para satisfazer o contrato de IAcquireTokenParameters interface. Não recomendado para uso — essa API está agendada para remoção em todas as classes de parâmetro e será substituída por um novo mecanismo em uma versão futura.

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.

forceRefresh

public boolean forceRefresh()

Retornos:

se deseja ignorar o cache de token e forçar uma nova solicitação de token

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.

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

username

public String username()

Retornos:

o UPN do usuário de destino ou nulo se o usuário foi identificado pela ID do objeto

userObjectId

public UUID userObjectId()

Retornos:

a ID do objeto do usuário de destino ou nulo se o usuário foi identificado pelo UPN

Aplica-se a