Règle DeleteOAuthV2Info

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

Consultez la documentation d' Apigee Edge.

La règle DeleteOAuthv2Info 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.

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

 N/A Obligatoire

É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 : N/A
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.

 N/A 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 : N/A
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.

 N/A 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

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause
steps.oauth.v2.invalid_access_token 401 The access token sent to the policy is invalid.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 The authorization code sent to the policy is invalid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Please see Oauth2.0 Access Token Verification throws "Invalid API call as no apiproduct match found" error for information about troubleshooting this error.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name is the user-specified name of the policy that threw the fault. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

Example error response

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

Example fault rule

<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