InteractiveRequestParameters.InteractiveRequestParametersBuilder Clase

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

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

Resumen del método

Modificador y tipo Método y descripción
InteractiveRequestParameters build()
InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Las notificaciones que se solicitarán a través del parámetro de solicitud de OIDC, lo que permite solicitudes de notificaciones estándar y personalizadas
InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Se usa cuando se produce un error en una solicitud de token y la respuesta tiene una cadena de desafío
InteractiveRequestParametersBuilder domainHint(String domainHint)

Proporciona una sugerencia sobre el inquilino o dominio que el usuario debe usar para iniciar sesión.
InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Agrega encabezados adicionales a la solicitud de token
InteractiveRequestParametersBuilder extraQueryParameters(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.

Agrega parámetros de consulta adicionales a la solicitud de token
InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

Cantidad de tiempo en segundos en que la biblioteca esperará un resultado de autenticación.
InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Si se establece en true, el resultado de la autorización contendrá la autoridad de la nube principal del usuario y esta autoridad se usará para la solicitud de token en lugar de la autoridad establecida en la aplicación.
InteractiveRequestParametersBuilder loginHint(String loginHint)

Se puede usar para rellenar previamente el campo nombre de usuario o dirección de correo electrónico de la página de inicio de sesión del usuario, si conoce la dirección de nombre de usuario o correo electrónico con antelación.
InteractiveRequestParametersBuilder prompt(Prompt prompt)

Indique el tipo de interacción del usuario necesaria.
InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Establece los parámetros poppara esta solicitud, lo que permite que la solicitud recupere tokens de prueba de posesión en lugar de tokens de portador.
InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

URI de redirección donde MSAL escuchará el código de autorización devuelto por Azure AD.
InteractiveRequestParametersBuilder scopes(Set<String> scopes)

Ámbitos a los que la aplicación solicita acceso y el usuario dará su consentimiento.
InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Conjuntos SystemBrowserOptions que se van a usar en la aplicación clientepública
InteractiveRequestParametersBuilder tenant(String tenant)

Invalida el valor de inquilino en la dirección URL de autoridad de esta solicitud.
java.lang.String toString()
InteractiveRequestParametersBuilder windowHandle(long windowHandle)

Identificador de ventana principal que se usa para abrir elementos de la interfaz de usuario con el elemento primario correcto

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

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Las notificaciones que se solicitarán a través del parámetro de solicitud de OIDC, lo que permite solicitudes de notificaciones estándar y personalizadas

Parámetros:

claims

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Se usa cuando se produce un error en una solicitud de token y la respuesta tiene una cadena de desafío

Parámetros:

claimsChallenge

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

Proporciona una sugerencia sobre el inquilino o dominio que el usuario debe usar para iniciar sesión. El valor de la sugerencia de dominio es un dominio registrado para el inquilino.

Parámetros:

domainHint

extraHttpHeaders

public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Agrega encabezados adicionales a la solicitud de token

Parámetros:

extraHttpHeaders

extraQueryParameters


public InteractiveRequestParameters.InteractiveRequestParametersBuilder extraQueryParameters(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.

Agrega parámetros de consulta adicionales a la solicitud de token

Parámetros:

extraQueryParameters

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

Cantidad de tiempo en segundos en que la biblioteca esperará un resultado de autenticación. 120 segundos es el tiempo de espera predeterminado.

Si este tiempo de espera se establece en 0 o menos, se omitirá y la biblioteca usará un tiempo de espera de 1 segundo en su lugar.

Parámetros:

httpPollingTimeoutInSeconds

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Si se establece en true, el resultado de la autorización contendrá la autoridad de la nube principal del usuario y esta autoridad se usará para la solicitud de token en lugar de la autoridad establecida en la aplicación.

Parámetros:

instanceAware

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

Se puede usar para rellenar previamente el campo nombre de usuario o dirección de correo electrónico de la página de inicio de sesión del usuario, si conoce la dirección de nombre de usuario o correo electrónico con antelación. A menudo, las aplicaciones usan este parámetro durante la re-autenticación, ya ha extraído el nombre de usuario de un inicio de sesión anterior mediante la notificación de preferred_username.

Parámetros:

loginHint

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

Indique el tipo de interacción del usuario necesaria.

Parámetros:

prompt

proofOfPossession

public InteractiveRequestParameters.InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Establece popParameters para esta solicitud, lo que permite que la solicitud recupere tokens de prueba de posesión en lugar de tokens de portador.

Para obtener más información, consulte PopParameters y https://aka.ms/msal4j-pop

Parámetros:

httpMethod - un método HTTP válido, como "GET" o "POST"
uri - el URI de la API protegida de bajada a la que la aplicación está intentando acceder, por ejemplo, https://graph.microsoft.com/beta/me/profile
nonce - una cadena obtenida llamando al recurso (por ejemplo, Microsoft Graph) sin autenticar y analizar el encabezado WWW-Authenticate asociado al esquema de autenticación pop y extraer el parámetro nonce o, en llamadas posteriores, mediante el análisis del encabezado Autheticate-Info y la extracción del parámetro nextnonce.

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

URI de redirección donde MSAL escuchará el código de autorización devuelto por Azure AD. Debe ser una dirección de bucle invertido con un puerto especificado (por ejemplo, http://localhost:3671). Si no se especifica ningún puerto, MSAL encontrará un puerto abierto. Para obtener más información, consulte https://aka.ms/msal4j-interactive-request.

No puede ser NULL.

Parámetros:

redirectUri

scopes

public InteractiveRequestParameters.InteractiveRequestParametersBuilder scopes(Set<String> scopes)

Ámbitos a los que la aplicación solicita acceso y el usuario dará su consentimiento.

Parámetros:

scopes

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Conjuntos SystemBrowserOptions que se van a usar en PublicClientApplication

Parámetros:

systemBrowserOptions

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

Invalida el valor de inquilino en la dirección URL de autoridad de esta solicitud.

Parámetros:

tenant

toString

public String toString()

Invalidaciones:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

Identificador de ventana principal que se usa para abrir elementos de la interfaz de usuario con el elemento primario correcto

Para escenarios de explorador y aplicaciones de consola de Windows, este valor no debe establecerse.

En Windows aplicaciones de consola, MSAL Java intentará detectar el identificador de ventana de la consola si este parámetro no está establecido.

En escenarios en los que MSAL Java es responsable de abrir elementos de la interfaz de usuario (como cuando se usa MSALRuntime), este parámetro es necesario y se producirá una excepción si no se establece.

Parámetros:

windowHandle

Se aplica a