InteractiveRequestParameters.InteractiveRequestParametersBuilder Klas

Pakket:
com.microsoft.aad.msal4j
Maven-artefact:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.InteractiveRequestParameters.InteractiveRequestParametersBuilder

public static class InteractiveRequestParameters.InteractiveRequestParametersBuilder

Methodesamenvatting

Modifier en type Methode en beschrijving
InteractiveRequestParameters build()
InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Claims die moeten worden aangevraagd via de OIDC-claimaanvraagparameter, waardoor aanvragen voor standaard- en aangepaste claims worden toegestaan
InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Wordt gebruikt wanneer een tokenaanvraag mislukt en het antwoord een uitdagingstekenreeks heeft
InteractiveRequestParametersBuilder domainHint(String domainHint)

Biedt een hint over de tenant of het domein dat de gebruiker moet gebruiken om zich aan te melden.
InteractiveRequestParametersBuilder extraHttpHeaders(Map<String,String> extraHttpHeaders)

Voegt extra headers toe aan de tokenaanvraag
InteractiveRequestParametersBuilder extraQueryParameters(Map<String,String> extraQueryParameters)

Afgeschaft

Niet aanbevolen voor productiescenario's. Deze wordt verwijderd in een toekomstige release en het gedrag wordt mogelijk vervangen door een nieuwe API.

Voegt extra queryparameters toe aan de tokenaanvraag
InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

De hoeveelheid tijd in seconden waarop de bibliotheek wacht op een verificatieresultaat.
InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Als dit is ingesteld op true, bevat het autorisatieresultaat de instantie voor de thuiscloud van de gebruiker en wordt deze instantie gebruikt voor de tokenaanvraag in plaats van de instantie die is ingesteld in de toepassing.
InteractiveRequestParametersBuilder loginHint(String loginHint)

Kan worden gebruikt om het veld gebruikersnaam/e-mailadres van de aanmeldingspagina voor de gebruiker vooraf in te vullen, als u de gebruikersnaam/het e-mailadres van tevoren kent.
InteractiveRequestParametersBuilder prompt(Prompt prompt)

Geef het type gebruikersinteractie aan dat vereist is.
InteractiveRequestParametersBuilder proofOfPossession(HttpMethod httpMethod, URI uri, String nonce)

Hiermee stelt u de Pop-parametersvoor deze aanvraag in, zodat de aanvraag tokens voor bewijs van bezit kan ophalen in plaats van bearertokens
InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

Omleidings-URI waar MSAL naar luistert voor de autorisatiecode die wordt geretourneerd door Azure AD.
InteractiveRequestParametersBuilder scopes(Set<String> scopes)

Bereiken waartoe de toepassing toegang aanvraagt en de gebruiker toestemming geeft.
InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Sets SystemBrowserOptions die moeten worden gebruikt door de openbareclienttoepassing
InteractiveRequestParametersBuilder tenant(String tenant)

Overschrijft de tenantwaarde in de instantie-URL voor deze aanvraag
java.lang.String toString()
InteractiveRequestParametersBuilder windowHandle(long windowHandle)

De bovenliggende venstergreep die wordt gebruikt om UI-elementen te openen met het juiste bovenliggende item

Methoden overgenomen van 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

Methodedetails

build

public InteractiveRequestParameters build()

claims

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claims(ClaimsRequest claims)

Claims die moeten worden aangevraagd via de OIDC-claimaanvraagparameter, waardoor aanvragen voor standaard- en aangepaste claims worden toegestaan

Parameters:

claims

claimsChallenge

public InteractiveRequestParameters.InteractiveRequestParametersBuilder claimsChallenge(String claimsChallenge)

Wordt gebruikt wanneer een tokenaanvraag mislukt en het antwoord een uitdagingstekenreeks heeft

Parameters:

claimsChallenge

domainHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder domainHint(String domainHint)

Biedt een hint over de tenant of het domein dat de gebruiker moet gebruiken om zich aan te melden. De waarde van de domeinhint is een geregistreerd domein voor de tenant.

Parameters:

domainHint

extraHttpHeaders

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

Voegt extra headers toe aan de tokenaanvraag

Parameters:

extraHttpHeaders

extraQueryParameters


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

Afgeschaft

Niet aanbevolen voor productiescenario's. Deze wordt verwijderd in een toekomstige release en het gedrag wordt mogelijk vervangen door een nieuwe API.

Voegt extra queryparameters toe aan de tokenaanvraag

Parameters:

extraQueryParameters

httpPollingTimeoutInSeconds

public InteractiveRequestParameters.InteractiveRequestParametersBuilder httpPollingTimeoutInSeconds(int httpPollingTimeoutInSeconds)

De hoeveelheid tijd in seconden waarop de bibliotheek wacht op een verificatieresultaat. 120 seconden is de standaardtime-out.

Als deze time-out is ingesteld op 0 of minder, wordt deze genegeerd en gebruikt de bibliotheek in plaats daarvan een time-out van 1 seconde

Parameters:

httpPollingTimeoutInSeconds

instanceAware

public InteractiveRequestParameters.InteractiveRequestParametersBuilder instanceAware(boolean instanceAware)

Als dit is ingesteld op true, bevat het autorisatieresultaat de instantie voor de thuiscloud van de gebruiker en wordt deze instantie gebruikt voor de tokenaanvraag in plaats van de instantie die is ingesteld in de toepassing.

Parameters:

instanceAware

loginHint

public InteractiveRequestParameters.InteractiveRequestParametersBuilder loginHint(String loginHint)

Kan worden gebruikt om het veld gebruikersnaam/e-mailadres van de aanmeldingspagina voor de gebruiker vooraf in te vullen, als u de gebruikersnaam/het e-mailadres van tevoren kent. Apps gebruiken deze parameter vaak tijdens opnieuw verificatie, nadat de gebruikersnaam al is geëxtraheerd uit een vorige aanmelding met behulp van de claim preferred_username.

Parameters:

loginHint

prompt

public InteractiveRequestParameters.InteractiveRequestParametersBuilder prompt(Prompt prompt)

Geef het type gebruikersinteractie aan dat vereist is.

Parameters:

prompt

proofOfPossession

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

Hiermee stelt u de PopParameters voor deze aanvraag in, zodat de aanvraag proof-of-possession tokens kan ophalen in plaats van bearertokens

Zie en voor PopParameters meer informatie https://aka.ms/msal4j-pop

Parameters:

httpMethod - een geldige HTTP-methode, zoals 'GET' of 'POST'
uri - de URI op de downstream beveiligde API waartoe de toepassing toegang probeert te krijgen, bijvoorbeeld https://graph.microsoft.com/beta/me/profile
nonce - een tekenreeks die is verkregen door het aanroepen van de resource (bijvoorbeeld Microsoft Graph) niet-geverifieerd en parseren van de WWW-Authenticate header die is gekoppeld aan pop-verificatieschema en het extraheren van de nonce-parameter, of, bij volgende aanroepen, door de Autheticate-Info header te parseren en de parameter volgende uit te pakken.

redirectUri

public InteractiveRequestParameters.InteractiveRequestParametersBuilder redirectUri(URI redirectUri)

Omleidings-URI waar MSAL naar luistert voor de autorisatiecode die wordt geretourneerd door Azure AD. Moet een loopback-adres zijn met een opgegeven poort (bijvoorbeeld http://localhost:3671). Als er geen poort is opgegeven, vindt MSAL een geopende poort. Zie https://aka.ms/msal4j-interactive-request voor meer informatie.

Kan niet null zijn.

Parameters:

redirectUri

scopes

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

Bereiken waartoe de toepassing toegang aanvraagt en de gebruiker toestemming geeft.

Parameters:

scopes

systemBrowserOptions

public InteractiveRequestParameters.InteractiveRequestParametersBuilder systemBrowserOptions(SystemBrowserOptions systemBrowserOptions)

Sets SystemBrowserOptions die moeten worden gebruikt door PublicClientApplication

Parameters:

systemBrowserOptions

tenant

public InteractiveRequestParameters.InteractiveRequestParametersBuilder tenant(String tenant)

Overschrijft de tenantwaarde in de instantie-URL voor deze aanvraag

Parameters:

tenant

toString

public String toString()

Overschrijvingen:

InteractiveRequestParameters.InteractiveRequestParametersBuilder.toString()

windowHandle

public InteractiveRequestParameters.InteractiveRequestParametersBuilder windowHandle(long windowHandle)

De bovenliggende venstergreep die wordt gebruikt om UI-elementen te openen met het juiste bovenliggende item

Voor browserscenario's en Windows consoletoepassingen hoeft deze waarde niet te worden ingesteld

Voor Windows consoletoepassingen probeert MSAL Java de venstergreep van de console te detecteren als deze parameter niet is ingesteld

Voor scenario's waarin MSAL Java verantwoordelijk is voor het openen van UI-elementen (zoals bij het gebruik van MSALRuntime), is deze parameter vereist en wordt er een uitzondering gegenereerd als deze niet is ingesteld

Parameters:

windowHandle

Van toepassing op