ClientCredentialParameters Klasa

Pakiet:: com.microsoft.aad.msal4j

Artefakt Maven:: com.microsoft.azure:msal4j:1.26.0

java.lang.Object
- com.microsoft.aad.msal4j.ClientCredentialParameters

Implementuje

com.microsoft.aad.msal4j.IAcquireTokenParameters

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

Obiekt zawierający parametry przepływu poświadczeń klienta. Można użyć jako parametru do acquireToken(ClientCredentialParameters parameters)

Podsumowanie metody

Modyfikator i typ	Metoda i opis
static ClientCredentialParametersBuilder	builder(Set<String> scopes) Konstruktor dla ClientCredentialParameters
ClaimsRequest	claims() Pobiera parametr żądania oświadczeń, który zostanie wysłany za pomocą żądania uwierzytelniania.
java.lang.String	clientClaims() Oświadczenia pochodzące z klienta ustawione za pośrednictwem elementu ClientCredentialParametersBuilder#claimsFromClient(String).
IClientCredential	clientCredential()
java.lang.String	computeExtCacheKeyHash() Oblicza skrót klucza rozszerzonej pamięci podręcznej ze wszystkich kluczowych składników pamięci podręcznej.
java.util.Map<java.lang.String,java.lang.String>	extraHttpHeaders() Pobiera dodatkowe nagłówki HTTP, które mają zostać uwzględnione w żądaniu tokenu.
java.util.Map<java.lang.String,java.lang.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. Pobiera dodatkowe parametry zapytania, które mają zostać uwzględnione w żądaniu tokenu.
java.lang.String	fmiPath() Pobiera ścieżkę FMI (federacyjna tożsamość zarządzana) dla scenariuszy tożsamości agenta.
java.util.Set<java.lang.String>	scopes() Pobiera zestaw zakresów (uprawnień) żądanych dla tokenu dostępu.
java.lang.Boolean	skipCache()
java.lang.String	tenant() Pobiera identyfikator dzierżawy dla żądania tokenu.

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

builder

public static ClientCredentialParameters.ClientCredentialParametersBuilder builder(Set<String> scopes)

Konstruktor dla ClientCredentialParameters

Parametry:

scopes - aplikacja scopes żąda dostępu do

Zwraca:

konstruktor, który może służyć do konstruowania parametrów ClientCredentialParameters

claims

public ClaimsRequest claims()

Pobiera parametr żądania oświadczeń, który zostanie wysłany za pomocą żądania uwierzytelniania.

Parametr żądania oświadczeń może służyć do żądania zwrócenia określonych oświadczeń w tokenie, żądania uwierzytelniania wieloskładnikowego lub kontrolowania innych aspektów wystawiania tokenu.

clientClaims

public String clientClaims()

Oświadczenia pochodzące z klienta ustawione za pośrednictwem elementu ClientCredentialParametersBuilder#claimsFromClient(String). Przekazano do punktu końcowego tokenu jako parametr OAuth claims i użyto go jako części klucza rozszerzonej pamięci podręcznej, aby odrębne wartości oświadczeń były buforowane oddzielnie.

clientCredential

public IClientCredential clientCredential()

computeExtCacheKeyHash

public String computeExtCacheKeyHash()

Oblicza skrót klucza rozszerzonej pamięci podręcznej ze wszystkich kluczowych składników pamięci podręcznej. Zwraca pusty ciąg, jeśli nie ma żadnych składników.

Wynik jest zapamiętytywalny, ponieważ parametr ClientCredentialParameters jest niezmienny po konstrukcji. Używane przez zarówno operacje zapisu pamięci podręcznej (TokenCache) jak i odczyty pamięci podręcznej (wyszukiwanie dyskretne).

extraHttpHeaders

public Map<String,String> extraHttpHeaders()

Pobiera dodatkowe nagłówki HTTP, które mają zostać uwzględnione w żądaniu tokenu.

Te nagłówki zostaną dodane do żądań HTTP wysyłanych do punktu końcowego tokenu. Może to być przydatne w scenariuszach wymagających niestandardowych nagłówków dla serwerów proxy lub w celach diagnostycznych.

extraQueryParameters

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

Pobiera dodatkowe parametry zapytania, które mają zostać uwzględnione w żądaniu tokenu.

Te parametry zostaną dodane do ciągu zapytania w żądaniach do punktów końcowych autoryzacji i tokenu. Może to być przydatne w scenariuszach wymagających parametrów niestandardowych, które nie są jawnie obsługiwane w bibliotece.

fmiPath

public String fmiPath()

Pobiera ścieżkę FMI (federacyjna tożsamość zarządzana) dla scenariuszy tożsamości agenta. Po ustawieniu fmi_path jest wysyłany jako parametr treści w żądaniu tokenu poświadczeń klienta, który określa zakres wynikowego tokenu do określonej tożsamości agenta.

Zwraca:

ścieżka FMI lub wartość null, jeśli nie jest ustawiona

scopes

public Set<String> scopes()

Pobiera zestaw zakresów (uprawnień) żądanych dla tokenu dostępu.

Zakresy reprezentują uprawnienia, do których aplikacja żąda dostępu.

skipCache

public Boolean skipCache()

tenant

public String tenant()

Pobiera identyfikator dzierżawy dla żądania tokenu.

Po określeniu ta wartość zastępuje dzierżawę określoną w adresie URL urzędu aplikacji. Może to być identyfikator dzierżawy (GUID), nazwa domeny lub jedna z specjalnych wartości, takich jak "common" lub "organizations".