Règle SetOAuthV2Info

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

Consultez la documentation d'Apigee Edge.

icône de la règle

Événement

Vous permet d'ajouter ou de modifier des valeurs d'attributs personnalisés associés à un jeton d'accès. Les attributs personnalisés peuvent inclure des éléments tels que le nom du service, un numéro client ou un identifiant de session. Voir également Personnaliser des jetons et des codes d'autorisation.

Vous pouvez uniquement ajouter ou modifier des attributs personnalisés. Vous ne pouvez pas utiliser cette règle pour modifier des champs tels que champ d'application, état, expires_in, developer_email, client_id, org_name ou refresh_count. Si un attribut existe déjà, cette règle le modifie. S'il n'existe pas, elle l'ajoute. Le jeton d'accès référencé doit être valide et approuvé.

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

Exemple de base

Voici un exemple de règle permettant de modifier un jeton d'accès OAuth 2.0. Cet exemple localise le jeton d'accès dans le message de requête en recherchant un paramètre de requête appelé access_token. Lorsqu'un jeton d'accès est présenté par une application cliente, la règle ci-dessous localise le jeton d'accès dans le paramètre de requête. Elle met ensuite à jour le profil du jeton d'accès. Elle ajoute une propriété personnalisée appelée department.id au profil. 

<SetOAuthV2Info name="SetOAuthV2Info">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

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

La référence d'élément décrit les éléments et les attributs de la règle SetOAuthV2.

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

Attributs <SetOAuthV2Info>

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

Le tableau suivant décrit les attributs communs à tous les éléments parents des règles :

Attribut Description Par défaut Présence
name

Nom interne de la règle. La valeur de l'attribut name peut contenir des lettres, des chiffres, des espaces, des tirets, des traits de soulignement et des points. Cette valeur ne peut pas dépasser 255 caractères.

Vous pouvez également utiliser l'élément <DisplayName> pour ajouter un libellé à la règle dans l'éditeur de proxy de l'interface utilisateur de gestion, en utilisant un nom différent, en langage naturel.

 ND Valeur
continueOnError

Définissez sur false pour afficher une erreur en cas d'échec d'une règle. Il s'agit du comportement attendu pour la plupart des règles.

Définissez sur true pour que l'exécution du flux se poursuive même après l'échec d'une règle. Voir également :

 faux Facultatif
enabled

Définissez sur true pour appliquer la règle.

Définissez sur false pour désactiver la règle. La stratégie ne sera pas appliquée, même si elle reste associée à un flux.

 vrai Facultatif
async

Cet attribut est obsolète.

 faux Obsolète

Élément <DisplayName>

Utilisez-le, en plus de l'attribut name, pour appliquer un libellé à la règle dans l'éditeur de proxys de l'interface de gestion en utilisant un nom différent, en langage naturel.

<DisplayName>Policy Display Name</DisplayName>
Par défaut

ND

Si vous omettez cet élément, la valeur de l'attribut name de la règle est utilisée.
Présence Facultatif
Type Chaîne

Élément <AccessToken>

Identifie la variable où se trouve le jeton d'accès. Par exemple, si le jeton d'accès est associé au message de la requête en tant que paramètre de requête, 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 : Requis
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.

 ND Facultative

Élément <Attributes>

Ensemble d'attributs dans le profil de jeton d'accès qui seront modifiés ou augmentés.

Valeur par défaut : ND
Présence : Requis
Type : ND

Élément <Attributes>/<Attribute>

Attribut individuel à mettre à jour.

L'attribut de nom identifie la propriété personnalisée du profil de jeton d'accès à mettre à jour. Cet exemple montre comment utiliser une valeur de variable référencée et une valeur statique. 

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>
Valeur par défaut : ND
Présence : Facultatif
Type : ND

Attributs

Attribut Description Par défaut Présence
nom Nom de l'attribut de profil à ajouter ou à modifier. ND
ref

Valeur à attribuer à l'attribut de profil.

 ND Facultative

Variables de flux

En cas de réussite, les variables de flux suivantes seront définies :

  • oauthv2accesstoken.{policyName}.access_token
  • oauthv2accesstoken.{policyName}.client_id
  • oauthv2accesstoken.{policyName}.refresh_count
  • oauthv2accesstoken.{policyName}.organization_name
  • oauthv2accesstoken.{policyName}.expires_in //--in seconds
  • oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
  • oauthv2accesstoken.{policyName}.issued_at
  • oauthv2accesstoken.{policyName}.status
  • oauthv2accesstoken.{policyName}.api_product_list
  • oauthv2accesstoken.{policyName}.token_type
  • oauthv2accesstoken.{policyName}.{custom_attribute_name}

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.

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.access_token_expired 500 Le jeton d'accès envoyé à la règle a expiré.
steps.oauth.v2.invalid_access_token 500 Le jeton d'accès 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 Où : 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.SetTokenInfo.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.SetTokenInfo.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.SetTokenInfo.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=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Articles associés