Règle DeleteOAuthV2Info

<ph type="x-smartling-placeholder"></ph> Vous consultez la documentation Apigee Edge.
Accédez à la page Documentation sur Apigee X. En savoir plus

Quoi

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

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">

É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>

Attributs

É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>

Attributs

Élément <DisplayName>

Nom en langage naturel qui étiquette la stratégie dans l'éditeur de proxy de l'UI de gestion. S'il est omis, l'attribut du nom de la règle est utilisé.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>

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

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.

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

• Règle OAuthV2
• Accueil OAuth
• Personnaliser des jetons et des codes d'autorisation