ClientCredentialParameters Clase

Paquete:
com.microsoft.aad.msal4j
Artefacto Maven:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.ClientCredentialParameters

Implementaciones

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Objeto que contiene parámetros para el flujo de credenciales de cliente. Se puede usar como parámetro para acquireToken(ClientCredentialParameters parameters)

Resumen del método

Modificador y tipo Método y descripción
static ClientCredentialParametersBuilder builder(Set<String> scopes)

Generador para ClientCredentialParameters
ClaimsRequest claims()

Obtiene el parámetro de solicitud de notificaciones que se enviará con la solicitud de autenticación.
java.lang.String clientClaims()

Notificaciones originadas por el cliente establecidas a través de ClientCredentialParametersBuilder#claimsFromClient(String).
IClientCredential clientCredential()
java.lang.String computeExtCacheKeyHash()

Calcula el hash de clave de caché extendida de todos los componentes de clave de caché.
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Obtiene encabezados HTTP adicionales que se van a incluir en la solicitud de token.
java.util.Map<java.lang.String,java.lang.String> extraQueryParameters()

Obsoleto

No se recomienda para escenarios de producción. Se quitará en una versión futura y el comportamiento puede reemplazarse por una nueva API.

Obtiene parámetros de consulta adicionales que se van a incluir en la solicitud de token.
java.lang.String fmiPath()

Obtiene la ruta de acceso fmi (identidad administrada federada) para escenarios de identidad del agente.
java.util.Set<java.lang.String> scopes()

Obtiene el conjunto de ámbitos (permisos) solicitados para el token de acceso.
java.lang.Boolean skipCache()
java.lang.String tenant()

Obtiene el identificador de inquilino de la solicitud de token.

Métodos heredados 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

Detalles del método

builder

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

Generador para ClientCredentialParameters

Parámetros:

scopes - la aplicación scopes solicita acceso a

Devoluciones:

generador que se puede usar para construir ClientCredentialParameters

claims

public ClaimsRequest claims()

Obtiene el parámetro de solicitud de notificaciones que se enviará con la solicitud de autenticación.

El parámetro de solicitud de notificaciones se puede usar para solicitar notificaciones específicas que se devuelvan en el token, para solicitar la autenticación de MFA o para controlar otros aspectos de la emisión de tokens.

clientClaims

public String clientClaims()

Notificaciones originadas por el cliente establecidas a través de ClientCredentialParametersBuilder#claimsFromClient(String). Se reenvía al punto de conexión del token como parámetro OAuth claims y se usa como parte de la clave de caché extendida para que los valores de notificación distintos se almacenen en caché por separado.

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Calcula el hash de clave de caché extendida de todos los componentes de clave de caché. Devuelve una cadena vacía si no hay ningún componente presente.

El resultado se memoiza porque ClientCredentialParameters es inmutable después de la construcción. Se usa tanto en las escrituras de caché (TokenCache) como en las lecturas de caché (búsqueda silenciosa).

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Obtiene encabezados HTTP adicionales que se van a incluir en la solicitud de token.

Estos encabezados se agregarán a las solicitudes HTTP enviadas al punto de conexión del token. Esto puede ser útil para escenarios que requieren encabezados personalizados para servidores proxy o para fines de diagnóstico.

extraQueryParameters


public Map<String,String> extraQueryParameters()

Obsoleto

No se recomienda para escenarios de producción. Se quitará en una versión futura y el comportamiento puede reemplazarse por una nueva API.

Obtiene parámetros de consulta adicionales que se van a incluir en la solicitud de token.

Estos parámetros se agregarán a la cadena de consulta en las solicitudes a los puntos de conexión de autorización y token. Esto puede ser útil para escenarios que requieren parámetros personalizados que no se admiten explícitamente en la biblioteca.

fmiPath

public String fmiPath()

Obtiene la ruta de acceso fmi (identidad administrada federada) para escenarios de identidad del agente. Cuando se establece, fmi_path se envía como parámetro body en la solicitud de token de credenciales de cliente, que limita el token resultante a una identidad de agente específica.

Devoluciones:

la ruta de acceso fmi, o null si no se establece

scopes

public Set<String> scopes()

Obtiene el conjunto de ámbitos (permisos) solicitados para el token de acceso.

Los ámbitos representan los permisos a los que la aplicación solicita acceso.

skipCache

public Boolean skipCache()

tenant

public String tenant()

Obtiene el identificador de inquilino de la solicitud de token.

Cuando se especifica, este valor invalida el inquilino especificado en la dirección URL de autoridad de la aplicación. Puede ser un identificador de inquilino (GUID), un nombre de dominio o uno de los valores especiales, como "común" o "organizaciones".

Se aplica a