DeleteOAuthV2Info

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

À propos de | Exemples | Documentation de référence sur les éléments | Résultat | Schéma | Articles associés

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. L'exemple ci-dessous 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>

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.

 false 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). true Facultatif
name

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 de gestion 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).

 <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.code ou request.queryparam.code.

 N/A Facultatif

Élément <DisplayName>

Nom en langage naturel qui étiquette la stratégie dans l'éditeur de proxy de l'interface utilisateur de gestion. 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

Sortie

En cas de réussite, la règle renvoie un état 200.

En cas d'échec, la règle renvoie l'erreur 404 et génère un résultat semblable à celui-ci (selon que vous supprimez un jeton d'accès ou un code d'authentification) :

HTTP/1.1 404 Not Found
Content-Type: application/json
Content-Length: 144
Connection: keep-alive

{"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}

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