InteractiveRequestParameters.InteractiveRequestParametersBuilder Třída

Balíček:

com.microsoft.aad.msal4j

Artefakt Mavenu:

com.microsoft.azure:msal4j:1.26.0

• java.lang.Object
• • com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

Souhrn metod

Modifikátor a typ	Metoda a popis
InteractiveRequestParameters	build()
InteractiveRequestParametersBuilder	claims(ClaimsRequest claims) Deklarace identity, které se mají požadovat prostřednictvím parametru požadavku deklarací identity OIDC, což umožňuje požadavky na standardní a vlastní deklarace identity
InteractiveRequestParametersBuilder	claimsChallenge(String claimsChallenge) Používá se v případě selhání požadavku na token a odpověď má řetězec výzvy.
InteractiveRequestParametersBuilder	domainHint(String domainHint) Poskytuje nápovědu k tenantovi nebo doméně, kterou by měl uživatel použít k přihlášení.
InteractiveRequestParametersBuilder	extraHttpHeaders(Map<String,String> extraHttpHeaders) Přidá do žádosti o token další hlavičky.
InteractiveRequestParametersBuilder	extraQueryParameters(Map<String,String> extraQueryParameters) Zastaralé Nedoporučuje se pro produkční scénáře. V budoucí verzi se odebere a chování může být nahrazeno novým rozhraním API. Přidá do požadavku tokenu další parametry dotazu.
InteractiveRequestParametersBuilder	httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds) Doba v sekundách, po kterou bude knihovna čekat na výsledek ověřování.
InteractiveRequestParametersBuilder	instanceAware(boolean instanceAware) Pokud je hodnota true, výsledek autorizace bude obsahovat autoritu pro domácí cloud uživatele a tato autorita se použije pro žádost o token místo autority nastavené v aplikaci.
InteractiveRequestParametersBuilder	loginHint(String loginHint) Dá se použít k předběžnému vyplnění pole uživatelské jméno a e-mailová adresa přihlašovací stránky pro uživatele, pokud znáte uživatelské jméno nebo e-mailovou adresu předem.
InteractiveRequestParametersBuilder	prompt(Prompt prompt) Uveďte typ interakce uživatele, který se vyžaduje.
InteractiveRequestParametersBuilder	proofOfPossession(HttpMethod httpMethod, URI uri, String nonce) Nastaví parametry poppro tento požadavek, což umožní požadavku načíst tokeny pro ověření vlastnictví místo nosných tokenů.
InteractiveRequestParametersBuilder	redirectUri(URI redirectUri) Identifikátor URI přesměrování, kde MSAL naslouchá autorizačnímu kódu vrácenému službou Azure AD.
InteractiveRequestParametersBuilder	scopes(Set<String> scopes) Obory, ke kterým aplikace žádá o přístup, a uživatel souhlasí.
InteractiveRequestParametersBuilder	systemBrowserOptions(SystemBrowserOptions systemBrowserOptions) Sady SystemBrowserOptions používané veřejnouklientskouaplikací
InteractiveRequestParametersBuilder	tenant(String tenant) Přepíše hodnotu tenanta v adrese URL autority pro tento požadavek.
java.lang.String	toString()
InteractiveRequestParametersBuilder	windowHandle(long windowHandle) Nadřazený popisovač okna použitý k otevření prvků uživatelského rozhraní se správným nadřazeným objektem

Metody zděděné od 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

Podrobnosti metody

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Deklarace identity, které se mají požadovat prostřednictvím parametru požadavku deklarací identity OIDC, což umožňuje požadavky na standardní a vlastní deklarace identity

Parametry:

claims

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Používá se v případě selhání požadavku na token a odpověď má řetězec výzvy.

Parametry:

claimsChallenge

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

Poskytuje nápovědu k tenantovi nebo doméně, kterou by měl uživatel použít k přihlášení. Hodnota nápovědy k doméně je registrovaná doména pro tenanta.

Parametry:

domainHint

extraHttpHeaders

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

Přidá do žádosti o token další hlavičky.

Parametry:

extraHttpHeaders

extraQueryParameters

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

Zastaralé

Nedoporučuje se pro produkční scénáře. V budoucí verzi se odebere a chování může být nahrazeno novým rozhraním API.

Přidá do požadavku tokenu další parametry dotazu.

Parametry:

extraQueryParameters

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

Doba v sekundách, po kterou bude knihovna čekat na výsledek ověřování. Výchozí časový limit je 120 sekund.

Pokud je tento časový limit nastavený na hodnotu 0 nebo menší, bude ignorován a knihovna místo toho použije časový limit 1 sekundy.

Parametry:

httpPollingTimeoutInSeconds

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Pokud je hodnota true, výsledek autorizace bude obsahovat autoritu pro domácí cloud uživatele a tato autorita se použije pro žádost o token místo autority nastavené v aplikaci.

Parametry:

instanceAware

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

Dá se použít k předběžnému vyplnění pole uživatelské jméno a e-mailová adresa přihlašovací stránky pro uživatele, pokud znáte uživatelské jméno nebo e-mailovou adresu předem. Aplikace tento parametr často používají při opětovném ověřování a už extrahovali uživatelské jméno z předchozího přihlášení pomocí deklarace identity preferred_username.

Parametry:

loginHint

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

Uveďte typ interakce uživatele, který se vyžaduje.

Parametry:

prompt

proofOfPossession

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

Nastaví parametry PopParameters pro tento požadavek a umožní požadavku načíst tokeny pro ověření vlastnictví místo nosných tokenů.

Další informace najdete v tématu PopParameters a https://aka.ms/msal4j-pop

Parametry:

httpMethod - platnou metodu HTTP, například GET nebo POST.

uri - identifikátor URI podřízeného chráněného rozhraní API, ke kterému se aplikace pokouší získat přístup, například https://graph.microsoft.com/beta/me/profile

nonce - řetězec získaný voláním prostředku (např. Microsoft Graph) neověřený a parsující hlavičku WWW-Authenticate přidruženou k schématu ověřování pop a extrahování parametru nonce nebo při následných voláních parsováním hlavičky Autheticate-Info a extrahováním parametru nextnonce.

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

Identifikátor URI přesměrování, kde MSAL naslouchá autorizačnímu kódu vrácenému službou Azure AD. Měla by to být adresa zpětné smyčky se zadaným portem (například http://localhost:3671). Pokud není zadaný žádný port, msAL najde otevřený port. Další informace najdete na webu https://aka.ms/msal4j-interactive-request.

Nesmí být null.

Parametry:

redirectUri

scopes

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

Obory, ke kterým aplikace žádá o přístup, a uživatel souhlasí.

Parametry:

scopes

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Sady SystemBrowserOptions používané aplikací PublicClientApplication

Parametry:

systemBrowserOptions

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

Přepíše hodnotu tenanta v adrese URL autority pro tento požadavek.

Parametry:

tenant

toString

public String toString()

Přepsání:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

Nadřazený popisovač okna použitý k otevření prvků uživatelského rozhraní se správným nadřazeným objektem

V případě scénářů prohlížeče a konzolových aplikací Windows by tato hodnota neměla být nastavená.

U konzolových aplikací Windows se msAL Java pokusí zjistit popisovač okna konzoly, pokud tento parametr není nastavený.

Ve scénářích, kdy msAL Java zodpovídá za otevírání prvků uživatelského rozhraní (například při použití MSALRuntime), je tento parametr povinný a pokud není nastavená, vyvolá se výjimka.

Parametry:

windowHandle