TokenRequestContext Klasse

Paket:

com.azure.core.credential

Maven-Artefakt:

com.azure:azure-core:1.46.0

• java.lang.Object
• • com.azure.core.credential.TokenRequestContext

public class TokenRequestContext

Die TokenRequestContext ist eine Klasse, die verwendet wird, um zusätzliche Informationen und kontext beim Anfordern eines Zugriffstokens von einer Authentifizierungsquelle bereitzustellen. Sie können die Tokenanforderung anpassen und zusätzliche Parameter angeben, z. B. Bereiche, Ansprüche oder Authentifizierungsoptionen.

Die TokenRequestContext wird in der Regel mit Authentifizierungsmechanismen verwendet, die erweiterte Konfigurationen oder Optionen erfordern, z. B. die Azure Active Directory-Authentifizierung (Azure AD).

Im Folgenden finden Sie eine allgemeine Übersicht über die Verwendung von TokenRequestContext:

1. Erstellen Sie eine instance der TokenRequestContext -Klasse, und konfigurieren Sie die erforderlichen Eigenschaften. Mit TokenRequestContext der -Klasse können Sie die Bereiche oder Ressourcen angeben, für die Sie ein Zugriffstoken anfordern möchten, sowie alle zusätzlichen Ansprüche oder Optionen.
2. Übergeben Sie die TokenRequestContext-instance an den entsprechenden Authentifizierungsclient oder -mechanismus, wenn Sie ein Zugriffstoken anfordern. Welche Methode oder API dafür verwendet wird, hängt vom verwendeten Authentifizierungsmechanismus ab. Wenn Sie beispielsweise die Azure Identity for AAD-Authentifizierung verwenden, übergeben Sie die TokenRequestContext-instance an die getToken-Methode der TokenCredential Implementierung.
3. Der Authentifizierungsclient oder -mechanismus verarbeitet die Tokenanforderung und gibt ein Zugriffstoken zurück, das zum Authentifizieren und Autorisieren von Anforderungen an Azure-Dienste verwendet werden kann.

Zusammenfassung zum Konstruktor

Konstruktor	Beschreibung
TokenRequestContext()	Erstellt eine Tokenanforderung instance.

Methodenzusammenfassung

Modifizierer und Typ	Methode und Beschreibung
TokenRequestContext	addScopes(String[] scopes) Fügt den Anforderungsbereichen mindestens einen Bereich hinzu.
String	getClaims() Rufen Sie die zusätzlichen Ansprüche ab, die in das Token eingeschlossen werden sollen.
List<String>	getScopes() Ruft die Bereiche ab, die für das Token erforderlich sind.
String	getTenantId() Rufen Sie die Mandanten-ID ab, die für die Authentifizierungsanforderung verwendet werden soll.
boolean	isCaeEnabled() Rufen Sie die status ab, die angibt, ob continuous Access Evaluation (CAE) für das angeforderte Token aktiviert ist.
TokenRequestContext	setCaeEnabled(boolean enableCae) Gibt an, ob Continuous Access Evaluation (CAE) für das angeforderte Token aktiviert werden soll.
TokenRequestContext	setClaims(String claims) Legen Sie die zusätzlichen Ansprüche fest, die in das Token eingeschlossen werden sollen.
TokenRequestContext	setScopes(List<String> scopes) Legt die bereiche fest, die für das Token erforderlich sind.
TokenRequestContext	setTenantId(String tenantId) Legen Sie die Mandanten-ID fest, die für die Authentifizierungsanforderung verwendet werden soll.

Geerbte Methoden von java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Details zum Konstruktor

TokenRequestContext

public TokenRequestContext()

Erstellt eine Tokenanforderung instance.

Details zur Methode

addScopes

public TokenRequestContext addScopes(String[] scopes)

Fügt den Anforderungsbereichen mindestens einen Bereich hinzu.

Parameters:

scopes - mindestens einen Bereich, der hinzugefügt werden soll

Returns:

TokenRequestContext selbst

getClaims

public String getClaims()

Rufen Sie die zusätzlichen Ansprüche ab, die in das Token eingeschlossen werden sollen.

Returns:

die zusätzlichen Ansprüche, die im Token enthalten sein sollen.

getScopes

public List getScopes()

Ruft die Bereiche ab, die für das Token erforderlich sind.

Returns:

die bereiche, die für das Token erforderlich sind

getTenantId

public String getTenantId()

Rufen Sie die Mandanten-ID ab, die für die Authentifizierungsanforderung verwendet werden soll.

Returns:

die konfigurierte Mandanten-ID.

isCaeEnabled

public boolean isCaeEnabled()

Rufen Sie die status ab, die angibt, ob continuous Access Evaluation (CAE) für das angeforderte Token aktiviert ist.

Returns:

das Flag, das angibt, ob die CAE-Authentifizierung verwendet werden soll oder nicht.

setCaeEnabled

public TokenRequestContext setCaeEnabled(boolean enableCae)

Gibt an, ob Continuous Access Evaluation (CAE) für das angeforderte Token aktiviert werden soll.

Wenn eine Ressourcen-API CAE implementiert und in Ihrer App deklariert wurde, dass sie das Feature verarbeiten kann, erhält die App CAE-Token für diese Ressource. Aus diesem Grund gilt Folgendes: Wenn Sie Ihre App als CAE-fähig deklarieren, muss die App die CAE-Anspruchsabfrage für alle Ressourcen-APIs verarbeiten, die Microsoft Identity-Zugriffstoken akzeptieren. Wenn Sie CAE-Antworten in diesen API-Aufrufen nicht verarbeiten, könnte Ihre App in einer Schleife enden, in der sie einen API-Aufruf mit einem Token wiederholt, das sich noch in der zurückgegebenen Lebensdauer des Tokens befindet, aber aufgrund von CAE widerrufen wurde.

Parameters:

enableCae - das Flag, das angibt, ob continuous Access Evaluation (CAE) für das angeforderte Token aktiviert werden soll.

Returns:

der aktualisierte TokenRequestContext.

setClaims

public TokenRequestContext setClaims(String claims)

Legen Sie die zusätzlichen Ansprüche fest, die in das Token eingeschlossen werden sollen.

Parameters:

claims - die zusätzlichen Ansprüche, die im Token enthalten sein sollen.

Returns:

der aktualisierte TokenRequestContext selbst

setScopes

public TokenRequestContext setScopes(List scopes)

Legt die bereiche fest, die für das Token erforderlich sind.

Parameters:

scopes - die bereiche, die für das Token erforderlich sind

Returns:

TokenRequestContext selbst

setTenantId

public TokenRequestContext setTenantId(String tenantId)

Legen Sie die Mandanten-ID fest, die für die Authentifizierungsanforderung verwendet werden soll.

Parameters:

tenantId - der Mandant, der beim Anfordern des Tokens verwendet werden soll.

Returns:

der aktualisierte TokenRequestContext selbst