DeviceCodeFlowParameters Třída

Balíček:
com.microsoft.aad.msal4j
Artefakt Mavenu:
com.microsoft.azure:msal4j:1.26.0
  • java.lang.Object
    • com.microsoft.aad.msal4j.DeviceCodeFlowParameters

Implementuje

com.microsoft.aad.msal4j.IAcquireTokenParameters

public class DeviceCodeFlowParameters
implements com.microsoft.aad.msal4j.IAcquireTokenParameters

Objekt obsahující parametry pro tok kódu zařízení Lze použít jako parametr pro acquireToken(DeviceCodeFlowParameters parameters). Další podrobnosti najdete v článku https://aka.ms/msal4j-device-code.

Souhrn metod

Modifikátor a typ Metoda a popis
static DeviceCodeFlowParametersBuilder builder(Set<String> scopes, Consumer<DeviceCode> deviceCodeConsumer)

Tvůrce pro DeviceCodeFlowParameters
ClaimsRequest claims()

Získá parametr žádosti o deklarace identity, který se odešle s požadavkem na ověření.
java.util.function.Consumer<DeviceCode> deviceCodeConsumer()
java.util.Map<java.lang.String,java.lang.String> extraHttpHeaders()

Získá další hlavičky HTTP, které se zahrnou do požadavku tokenu.
java.util.Map<java.lang.String,java.lang.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.

Získá další parametry dotazu, které se mají zahrnout do požadavku tokenu.
java.util.Set<java.lang.String> scopes()

Získá sadu oborů (oprávnění) požadovaných pro přístupový token.
java.lang.String tenant()

Získá identifikátor tenanta pro požadavek tokenu.

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

builder

public static DeviceCodeFlowParameters.DeviceCodeFlowParametersBuilder builder(Set<String> scopes, Consumer<DeviceCode> deviceCodeConsumer)

Tvůrce pro DeviceCodeFlowParameters

Parametry:

scopes - Aplikace oborů požaduje přístup k
deviceCodeConsumer - Consumer z DeviceCode

Návraty:

tvůrce, který lze použít k vytvoření DeviceCodeFlowParameters

claims

public ClaimsRequest claims()

Získá parametr žádosti o deklarace identity, který se odešle s požadavkem na ověření.

Parametr žádosti o deklarace identity se dá použít k vyžádání konkrétních deklarací identity, které se mají v tokenu vrátit, k vyžádání vícefaktorového ověřování nebo k řízení dalších aspektů vystavování tokenů.

deviceCodeConsumer

public Consumer<DeviceCode> deviceCodeConsumer()

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Získá další hlavičky HTTP, které se zahrnou do požadavku tokenu.

Tyto hlavičky se přidají do požadavků HTTP odeslaných do koncového bodu tokenu. To může být užitečné pro scénáře vyžadující vlastní hlavičky pro proxy servery nebo pro účely diagnostiky.

extraQueryParameters


public 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.

Získá další parametry dotazu, které se mají zahrnout do požadavku tokenu.

Tyto parametry se přidají do řetězce dotazu v požadavcích na koncové body autorizace a tokenu. To může být užitečné pro scénáře vyžadující vlastní parametry, které nejsou explicitně podporovány v knihovně.

scopes

public Set<String> scopes()

Získá sadu oborů (oprávnění) požadovaných pro přístupový token.

Obory představují oprávnění, ke kterým aplikace žádá o přístup.

tenant

public String tenant()

Získá identifikátor tenanta pro požadavek tokenu.

Po zadání tato hodnota přepíše tenanta zadaného v adrese URL autority aplikace. Může to být ID tenanta (GUID), název domény nebo jedna ze speciálních hodnot, jako jsou "společné" nebo "organizace".

Platí pro