TokenRequestContext Classe
- java.
lang. Object - com.
azure. core. credential. TokenRequestContext
- com.
public class TokenRequestContext
est TokenRequestContext une classe utilisée pour fournir des informations et un contexte supplémentaires lors de la demande d’un jeton d’accès à partir d’une source d’authentification. Il vous permet de personnaliser la demande de jeton et de spécifier des paramètres supplémentaires, tels que des étendues, des revendications ou des options d’authentification.
Le TokenRequestContext est généralement utilisé avec des mécanismes d’authentification qui nécessitent des configurations ou des options plus avancées, telles que l’authentification Azure Active Directory (Azure AD).
Voici une vue d’ensemble générale de la façon dont vous pouvez utiliser :TokenRequestContext
- Créez un instance de la TokenRequestContext classe et configurez les propriétés requises. La TokenRequestContext classe vous permet de spécifier les étendues ou les ressources pour lesquelles vous souhaitez demander un jeton d’accès, ainsi que toutes les revendications ou options supplémentaires.
- Transmettez le instance TokenRequestContext au client ou au mécanisme d’authentification approprié lors de la demande d’un jeton d’accès. La méthode ou l’API spécifique pour effectuer cette opération dépend du mécanisme d’authentification que vous utilisez. Par exemple, si vous utilisez Azure Identity pour l’authentification AAD, vous passez l’instance TokenRequestContext à la méthode getToken de l’implémentationTokenCredential.
- Le client ou le mécanisme d’authentification gère la demande de jeton et retourne un jeton d’accès qui peut être utilisé pour authentifier et autoriser les demandes adressées aux services Azure.
Récapitulatif du constructeur
Constructeur | Description |
---|---|
TokenRequestContext() |
Crée une demande de jeton instance. |
Résumé de la méthode
Modificateur et type | Méthode et description |
---|---|
Token |
addScopes(String[] scopes)
Ajoute une ou plusieurs étendues aux étendues de requête. |
String |
getClaims()
Obtenez les revendications supplémentaires à inclure dans le jeton. |
List<String> |
getScopes()
Obtient les étendues requises pour le jeton. |
String |
getTenantId()
Obtenez l’ID de locataire à utiliser pour la demande d’authentification. |
boolean |
isCaeEnabled()
Obtenez le status indiquant si l’évaluation continue de l’accès (CAE) est activée pour le jeton demandé. |
Token |
setCaeEnabled(boolean enableCae)
Indique s’il faut activer l’évaluation continue de l’accès (CAE) pour le jeton demandé. |
Token |
setClaims(String claims)
Définissez les revendications supplémentaires à inclure dans le jeton. |
Token |
setScopes(List<String> scopes)
Définit les étendues requises pour le jeton. |
Token |
setTenantId(String tenantId)
Définissez l’ID de locataire à utiliser pour la demande d’authentification. |
Méthodes héritées de java.lang.Object
Détails du constructeur
TokenRequestContext
public TokenRequestContext()
Crée une demande de jeton instance.
Détails de la méthode
addScopes
public TokenRequestContext addScopes(String[] scopes)
Ajoute une ou plusieurs étendues aux étendues de requête.
Parameters:
Returns:
getClaims
public String getClaims()
Obtenez les revendications supplémentaires à inclure dans le jeton.
Returns:
getScopes
public List
Obtient les étendues requises pour le jeton.
Returns:
getTenantId
public String getTenantId()
Obtenez l’ID de locataire à utiliser pour la demande d’authentification.
Returns:
isCaeEnabled
public boolean isCaeEnabled()
Obtenez le status indiquant si l’évaluation continue de l’accès (CAE) est activée pour le jeton demandé.
Returns:
setCaeEnabled
public TokenRequestContext setCaeEnabled(boolean enableCae)
Indique s’il faut activer l’évaluation continue de l’accès (CAE) pour le jeton demandé.
Si une API de ressource implémente l’évaluation CAE et que votre application déclare qu’elle peut gérer la fonctionnalité CAE, votre application obtient des jetons CAE pour cette ressource. Pour cette raison, si vous déclarez que votre application est prête à utiliser l’évaluation continue de l’accès, votre application doit traiter le défi de revendications d’évaluation continue de l’accès pour toutes les API de ressources qui acceptent les jetons d’accès Microsoft Identity. Si vous ne gérez pas les réponses CAE dans ces appels d’API, votre application peut se retrouver à réessayer en boucle un appel d’API, avec un jeton qui est toujours dans la durée de vie retournée du jeton, mais qui a été révoqué en raison de l’évaluation CAE.
Parameters:
Returns:
setClaims
public TokenRequestContext setClaims(String claims)
Définissez les revendications supplémentaires à inclure dans le jeton.
Parameters:
Returns:
setScopes
public TokenRequestContext setScopes(List
Définit les étendues requises pour le jeton.
Parameters:
Returns:
setTenantId
public TokenRequestContext setTenantId(String tenantId)
Définissez l’ID de locataire à utiliser pour la demande d’authentification.
Parameters:
Returns:
S’applique à
Azure SDK for Java