InteractiveRequestParameters Klasa
- java.
lang. Object - com.
microsoft. aad. msal4j. InteractiveRequestParameters
- com.
Implementuje
public class InteractiveRequestParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters
Obiekt zawierający parametry dla żądań interakcyjnych. Można użyć jako parametru do acquireToken(InteractiveRequestParameters parameters).
Aby uzyskać więcej informacji, zobacz https://aka.ms/msal4j-interactive-request.
Podsumowanie metody
| Modyfikator i typ | Metoda i opis |
|---|---|
|
static
Interactive |
builder(URI redirectUri) |
|
Claims |
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 |
| java.lang.String | claimsChallenge() |
| java.lang.String |
domainHint()
Zawiera wskazówkę dotyczącą dzierżawy lub domeny, za pomocą którego użytkownik powinien się zalogować. |
| java.util.Map<java.lang.String,java.lang.String> |
extraHttpHeaders()
Dodaje dodatkowe nagłówki do żądania tokenu |
| java.util.Map<java.lang.String,java.lang.String> |
extraQueryParameters()
Dodaje dodatkowe parametry zapytania do żądania tokenu |
| int |
httpPollingTimeoutInSeconds()
Ilość czasu w sekundach oczekiwania biblioteki na wynik uwierzytelniania. |
| 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. |
| java.lang.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. |
| Prompt |
prompt()
Określ wymagany typ interakcji użytkownika. |
|
Pop |
proofOfPossession() |
| @lombok.NonNull java.net.URI |
redirectUri()
Identyfikator URI przekierowania, w którym biblioteka MSAL będzie nasłuchiwać kodu autoryzacji zwróconego przez usługę Azure AD. |
| java.util.Set<java.lang.String> |
scopes()
Zakresy, do których aplikacja żąda dostępu, a użytkownik wyrazi zgodę. |
|
System |
systemBrowserOptions()
Zestawy SystemBrowserOptions do użycia przez publiczną aplikację kliencą |
| java.lang.String |
tenant()
Zastępuje wartość dzierżawy w adresie URL urzędu dla tego żądania |
| long |
windowHandle()
Dojście okna nadrzędnego używane do otwierania elementów interfejsu użytkownika z poprawnym elementem nadrzędnym W przypadku scenariuszy przeglądarki i aplikacji konsoli Windows nie należy ustawiać tej wartości dla aplikacji konsoli Windows, Java MSAL spróbuje odnaleźć uchwyt okna konsoli, jeśli ten parametr nie jest ustawiony dla scenariuszy, w których biblioteka MSAL Java jest odpowiedzialny 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 |
Metody dziedziczone z java.lang.Object
Szczegóły metody
builder
public static InteractiveRequestParameters.InteractiveRequestParametersBuilder builder(URI redirectUri)
Parametry:
claims
public 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
claimsChallenge
public String claimsChallenge()
domainHint
public 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.
extraHttpHeaders
public Map<String,String> extraHttpHeaders()
Dodaje dodatkowe nagłówki do żądania tokenu
extraQueryParameters
public Map<String,String> extraQueryParameters()
Dodaje dodatkowe parametry zapytania do żądania tokenu
httpPollingTimeoutInSeconds
public int httpPollingTimeoutInSeconds()
Ilość czasu w sekundach oczekiwania biblioteki na wynik uwierzytelniania. 120 sekund jest domyślnym limitem czasu, chyba że zastąpimy w tym miejscu inną dodatnią liczbą całkowitą, jeśli ten limit czasu zostanie ustawiony na 0 lub mniej, zostanie zignorowany, a biblioteka użyje 1 sekundowego limitu czasu
instanceAware
public 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.
loginHint
public 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.
prompt
public Prompt prompt()
Określ wymagany typ interakcji użytkownika.
proofOfPossession
public PopParameters proofOfPossession()
redirectUri
public @NonNull 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.
scopes
public Set<String> scopes()
Zakresy, do których aplikacja żąda dostępu, a użytkownik wyrazi zgodę.
systemBrowserOptions
public SystemBrowserOptions systemBrowserOptions()
Zestawy SystemBrowserOptions do użycia przez element PublicClientApplication
tenant
public String tenant()
Zastępuje wartość dzierżawy w adresie URL urzędu dla tego żądania
windowHandle
public long windowHandle()
Dojście okna nadrzędnego używane do otwierania elementów interfejsu użytkownika z poprawnym elementem nadrzędnym W przypadku scenariuszy przeglądarki i aplikacji konsoli Windows nie należy ustawiać tej wartości dla aplikacji konsoli Windows, Java MSAL spróbuje odnaleźć uchwyt okna konsoli, jeśli ten parametr nie jest ustawiony dla scenariuszy, w których biblioteka MSAL Java jest odpowiedzialny 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