TokenRequestContext Klasse
- java.
lang. Object - com.
azure. core. credential. TokenRequestContext
- com.
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:
- 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.
- Ü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.
- 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 |
---|---|
Token |
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. |
Token |
setCaeEnabled(boolean enableCae)
Gibt an, ob Continuous Access Evaluation (CAE) für das angeforderte Token aktiviert werden soll. |
Token |
setClaims(String claims)
Legen Sie die zusätzlichen Ansprüche fest, die in das Token eingeschlossen werden sollen. |
Token |
setScopes(List<String> scopes)
Legt die bereiche fest, die für das Token erforderlich sind. |
Token |
setTenantId(String tenantId)
Legen Sie die Mandanten-ID fest, die für die Authentifizierungsanforderung verwendet werden soll. |
Geerbte Methoden von java.lang.Object
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:
Returns:
getClaims
public String getClaims()
Rufen Sie die zusätzlichen Ansprüche ab, die in das Token eingeschlossen werden sollen.
Returns:
getScopes
public List
Ruft die Bereiche ab, die für das Token erforderlich sind.
Returns:
getTenantId
public String getTenantId()
Rufen Sie die Mandanten-ID ab, die für die Authentifizierungsanforderung verwendet werden soll.
Returns:
isCaeEnabled
public boolean isCaeEnabled()
Rufen Sie die status ab, die angibt, ob continuous Access Evaluation (CAE) für das angeforderte Token aktiviert ist.
Returns:
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:
Returns:
setClaims
public TokenRequestContext setClaims(String claims)
Legen Sie die zusätzlichen Ansprüche fest, die in das Token eingeschlossen werden sollen.
Parameters:
Returns:
setScopes
public TokenRequestContext setScopes(List
Legt die bereiche fest, die für das Token erforderlich sind.
Parameters:
Returns:
setTenantId
public TokenRequestContext setTenantId(String tenantId)
Legen Sie die Mandanten-ID fest, die für die Authentifizierungsanforderung verwendet werden soll.
Parameters:
Returns:
Gilt für:
Azure SDK for Java