Règle DeleteOAuthV2Info

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

icône de la règle

Événement

Supprime le code d'autorisation ou le jeton d'accès OAuth V2 spécifié.

Cette règle est une règle extensible et son utilisation peut avoir des conséquences sur le coût ou l'utilisation, en fonction de votre licence Apigee. Pour en savoir plus sur les types de règles et les implications en termes d'utilisation, consultez la section Types de règles.

Exemples

Supprimer le jeton d'accès

Voici un exemple de règle permettant de supprimer un jeton d'accès OAuth 2.0. Cet exemple localise le jeton d'accès à supprimer dans le message de requête en recherchant un en-tête appelé access_token.

<DeleteOAuthV2Info name="DeleteAccessToken">
     <AccessToken ref="request.header.access_token"></AccessToken>
</DeleteOAuthV2Info>

Supprimer le code d'autorisation

Vous trouverez ci-dessous un exemple de règle utilisée pour supprimer un code d'autorisation OAuth 2.0. L'exemple ci-dessous localise le code d'autorisation à supprimer dans le message de requête en recherchant un paramètre de requête appelé code.

<DeleteOAuthV2Info name="DeleteAuthCode">
     <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
</DeleteOAuthV2Info>

Documentation de référence des éléments

La documentation de référence des éléments décrit les éléments et les attributs de la règle de suppression des informations OAuth V2.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="DeleteOAuthV2Info-1">
    <DisplayName>Delete OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <!--<AuthorizationCode ref={some-variable}></AuthorizationCode>-->
    <Attributes/>
</DeleteOAuthV2Info

Attributs <DeleteOAuthV2Info>

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Attribut Description Par défaut Présence
async

Défini sur true pour spécifier que la règle doit être exécutée dans un pool de threads différent du pool qui traite le flux de requête/réponse. La valeur par défaut est false.

Ce paramètre est utilisé uniquement pour l'optimisation interne.

 false Facultatif
continueOnError

La plupart des règles sont susceptibles de renvoyer une erreur lorsqu'un échec se produit. En définissant cet attribut sur true, l'exécution du flux se poursuit en cas d'échec.

 faux Facultatif
activé Détermine si une règle est appliquée ou non. Si défini sur false, une règle est "désactivée" et n'est pas appliquée (même si la règle reste associée à un flux). vrai Facultatif
nom

Nom interne de la règle. Ce nom est référencé dans les éléments d'étape pour associer la règle à un flux.

Remarque : Les caractères que vous pouvez utiliser dans le nom se limitent à : A-Z0-9._\-$ %. L'interface utilisateur Apigee applique des restrictions supplémentaires, telles que la suppression automatique des caractères qui ne sont pas alphanumériques.

 ND Valeur

Élément <AccessToken>

Identifie la variable où se trouve le jeton d'accès à supprimer. Par exemple, si le jeton d'accès est associé au message de la requête en tant que paramètre de requête appelé "access_token", spécifiez request.queryparam.access_token. Vous pouvez utiliser n'importe quelle variable valide faisant référence au jeton. Il est également possible de transmettre la chaîne de jeton littérale (cas rare).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Valeur par défaut : ND
Présence : <AccessToken> ou <AuthorizationCode> est obligatoire.
Type : Chaîne

Attributs

Attribut Description Par défaut Présence
ref

Une variable de jeton d'accès. Généralement récupérée à partir d'une variable de flux. Par exemple : request.header.token ou request.queryparam.token.

 ND Facultatif

Élément <AuthorizationCode>

Identifie la variable où se trouve le code d'autorisation à supprimer. Par exemple, si le code d'autorisation est associé au message de la requête en tant que paramètre de requête appelé "code", spécifiez request.queryparam.code. Vous pouvez utiliser n'importe quelle variable valide faisant référence au jeton. Il est également possible de transmettre la chaîne de jeton littérale (cas rare).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Valeur par défaut : ND
Présence : <AccessToken> ou <AuthorizationCode> est obligatoire.
Type : Chaîne

Attributs

Attribut Description Par défaut Présence
ref

Une variable de jeton d'accès. Généralement récupérée à partir d'une variable de flux. Par exemple : request.header.code ou request.queryparam.code.

 ND Facultatif

Élément <DisplayName>

Nom en langage naturel qui ajoute un libellé à cette règle dans l'éditeur de proxy de l'interface utilisateur Apigee. S'il est omis, l'attribut du nom de la règle est utilisé.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Valeur par défaut : Valeur de l'attribut name de la règle.
Présence : Facultatif
Type : Chaîne

Informations de référence sur les erreurs

Cette section décrit les codes d'erreur et les messages d'erreur renvoyés et les variables d'erreur définies par Apigee lorsque cette règle déclenche une erreur. Ces informations sont importantes si vous développez des règles de défaillance afin de gérer les pannes. Pour en savoir plus, consultez les pages Ce que vous devez savoir à propos des erreurs liées aux règles et Gérer les pannes.

Erreurs d'exécution

Ces erreurs peuvent se produire lors de l'exécution de la règle.

Code d'erreur État HTTP Cause
steps.oauth.v2.invalid_access_token 401 Le jeton d'accès envoyé à la règle n'est pas valide.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 Le code d'autorisation envoyé à la règle n'est pas valide.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Pour plus d'informations sur la résolution de cette erreur, consultez l'article Lors de la vérification d'un jeton d'accès, l'erreur "Invalid API call as no apiproduct match found" (Appel API non valide car aucune correspondance apiproduct trouvée) apparaît.

Erreurs de déploiement

Reportez-vous au message indiqué dans l'interface utilisateur pour en savoir plus sur les erreurs de déploiement.

Variables de panne

Ces variables sont définies lorsque cette règle déclenche une erreur au moment de l'exécution.

Variables Lieu Exemple
fault.name="fault_name" fault_name est le nom de l'erreur, tel qu'indiqué dans le tableau Erreurs d'exécution ci-dessus. Le nom d'erreur est la dernière partie du code d'erreur. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name est le nom spécifié par l'utilisateur de la règle qui a provoqué l'erreur. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name est le nom spécifié par l'utilisateur de la règle qui a provoqué l'erreur. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name est le nom spécifié par l'utilisateur de la règle qui a provoqué l'erreur. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

Exemple de réponse d'erreur

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Exemple de règle de défaillance

<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="DeleteOAuthV2Info_Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_access_token")</Condition>
</FaultRule>

Schéma

Chaque type de règle est défini par un schéma XML (.xsd). Pour référence, des schémas de règles sont disponibles sur GitHub.

Articles associés