InteractiveRequestParameters.InteractiveRequestParametersBuilder Klasa

Pakiet:
com.microsoft.aad.msal4j
Artefakt Maven:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

Podsumowanie metody

Modyfikator i typ Metoda i opis
InteractiveRequestParameters build()
InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Oświadczenia, które mają być żądane za pośrednictwem parametru żądania OIDC claims, zezwalając na żądania dla oświadczeń standardowych i niestandardowych
InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Używane, gdy żądanie tokenu kończy się niepowodzeniem, a odpowiedź ma ciąg wyzwania
InteractiveRequestParametersBuilder domainHint(String domainHint)

Zawiera wskazówkę dotyczącą dzierżawy lub domeny, za pomocą którego użytkownik powinien się zalogować.
InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Dodaje dodatkowe nagłówki do żądania tokenu
InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Przestarzałe

Niezalecane w scenariuszach produkcyjnych. Zostanie on usunięty w przyszłej wersji, a zachowanie może zostać zastąpione przez nowy interfejs API.

Dodaje dodatkowe parametry zapytania do żądania tokenu
InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

Ilość czasu w sekundach oczekiwania biblioteki na wynik uwierzytelniania.
InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Jeśli zostanie ustawiona wartość true, wynik autoryzacji będzie zawierać urząd dla chmury głównej użytkownika, a ten urząd będzie używany dla żądania tokenu zamiast urzędu ustawionego w aplikacji.
InteractiveRequestParametersBuilder loginHint(String loginHint)

Może służyć do wstępnego wypełniania pola nazwy użytkownika/adresu e-mail na stronie logowania użytkownika, jeśli znasz wcześniej nazwę użytkownika/adres e-mail.
InteractiveRequestParametersBuilder prompt(Prompt prompt)

Określ wymagany typ interakcji użytkownika.
InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Ustawia parametry popdla tego żądania, umożliwiając żądaniu pobranie tokenów dowodu posiadania, a nie tokenów elementu nośnego
InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

Identyfikator URI przekierowania, w którym biblioteka MSAL będzie nasłuchiwać kodu autoryzacji zwróconego przez usługę Azure AD.
InteractiveRequestParametersBuilder scopes(Set<String> scopes)

Zakresy, do których aplikacja żąda dostępu, a użytkownik wyrazi zgodę.
InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Zestawy SystemBrowserOptions do użycia przez publiczną aplikację kliencą
InteractiveRequestParametersBuilder tenant(String tenant)

Zastępuje wartość dzierżawy w adresie URL urzędu dla tego żądania
java.lang.String toString()
InteractiveRequestParametersBuilder windowHandle(long windowHandle)

Uchwyt okna nadrzędnego używany do otwierania elementów interfejsu użytkownika z poprawnym elementem nadrzędnym

Metody dziedziczone z 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

Szczegóły metody

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Oświadczenia, które mają być żądane za pośrednictwem parametru żądania OIDC claims, zezwalając na żądania dla oświadczeń standardowych i niestandardowych

Parametry:

claims

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Używane, gdy żądanie tokenu kończy się niepowodzeniem, a odpowiedź ma ciąg wyzwania

Parametry:

claimsChallenge

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

Zawiera wskazówkę dotyczącą dzierżawy lub domeny, za pomocą którego użytkownik powinien się zalogować. Wartość wskazówki dotyczącej domeny jest zarejestrowaną domeną dla dzierżawy.

Parametry:

domainHint

extraHttpHeaders

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

Dodaje dodatkowe nagłówki do żądania tokenu

Parametry:

extraHttpHeaders

extraQueryParameters


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

Przestarzałe

Niezalecane w scenariuszach produkcyjnych. Zostanie on usunięty w przyszłej wersji, a zachowanie może zostać zastąpione przez nowy interfejs API.

Dodaje dodatkowe parametry zapytania do żądania tokenu

Parametry:

extraQueryParameters

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

Ilość czasu w sekundach oczekiwania biblioteki na wynik uwierzytelniania. 120 sekund jest domyślnym limitem czasu.

Jeśli ten limit czasu zostanie ustawiony na 0 lub mniej, zostanie zignorowany, a biblioteka użyje limitu czasu 1 sekundy

Parametry:

httpPollingTimeoutInSeconds

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Jeśli zostanie ustawiona wartość true, wynik autoryzacji będzie zawierać urząd dla chmury głównej użytkownika, a ten urząd będzie używany dla żądania tokenu zamiast urzędu ustawionego w aplikacji.

Parametry:

instanceAware

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

Może służyć do wstępnego wypełniania pola nazwy użytkownika/adresu e-mail na stronie logowania użytkownika, jeśli znasz wcześniej nazwę użytkownika/adres e-mail. Często aplikacje używają tego parametru podczas ponownego uwierzytelniania, po wyodrębnieniu nazwy użytkownika z poprzedniego logowania przy użyciu oświadczenia preferred_username.

Parametry:

loginHint

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

Określ wymagany typ interakcji użytkownika.

Parametry:

prompt

proofOfPossession

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

Ustawia parametry PopParameters dla tego żądania, umożliwiając żądaniu pobranie tokenów dowodu posiadania, a nie tokenów elementu nośnego

Aby uzyskać więcej informacji, zobacz PopParameters i https://aka.ms/msal4j-pop

Parametry:

httpMethod - prawidłowa metoda HTTP, taka jak "GET" lub "POST"
uri - identyfikator URI w podrzędnym chronionym interfejsie API, do którego aplikacja próbuje uzyskać dostęp, np. https://graph.microsoft.com/beta/me/profile
nonce - ciąg uzyskany przez wywołanie zasobu (np. Microsoft Graph) nieuwierzytelnionego i przeanalizowanie nagłówka WWW-Authenticate skojarzonego ze schematem uwierzytelniania pop i wyodrębnienie parametru nonce lub w kolejnych wywołaniach przez przeanalizowanie nagłówka Autheticate-Info i wyodrębnienie parametru nextnonce.

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

Identyfikator URI przekierowania, w którym biblioteka MSAL będzie nasłuchiwać kodu autoryzacji zwróconego przez usługę Azure AD. Powinien być adresem sprzężenia zwrotnego z określonym portem (na przykład http://localhost:3671). Jeśli port nie zostanie określony, biblioteka MSAL znajdzie otwarty port. Aby uzyskać więcej informacji, zobacz https://aka.ms/msal4j-interactive-request.

Nie można mieć wartości null.

Parametry:

redirectUri

scopes

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

Zakresy, do których aplikacja żąda dostępu, a użytkownik wyrazi zgodę.

Parametry:

scopes

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Zestawy SystemBrowserOptions do użycia przez element PublicClientApplication

Parametry:

systemBrowserOptions

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

Zastępuje wartość dzierżawy w adresie URL urzędu dla tego żądania

Parametry:

tenant

toString

public String toString()

Przesłonięcia:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

Uchwyt okna nadrzędnego używany do otwierania elementów interfejsu użytkownika z poprawnym elementem nadrzędnym

W przypadku scenariuszy przeglądarki i aplikacji konsolowych Windows ta wartość nie powinna być ustawiona

W przypadku aplikacji konsoli Windows biblioteka MSAL Java podejmie próbę odnalezienia uchwytu okna konsoli, jeśli ten parametr nie jest ustawiony

W przypadku scenariuszy, w których Java biblioteki MSAL jest odpowiedzialna za otwieranie elementów interfejsu użytkownika (takich jak w przypadku korzystania z biblioteki MSALRuntime), ten parametr jest wymagany, a wyjątek zostanie zgłoszony, jeśli nie zostanie ustawiony

Parametry:

windowHandle

Dotyczy