Règle GetOAuthV2Info

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

Quoi

Récupère les attributs des jetons d'accès, des jetons d'actualisation, des codes d'autorisation et des attributs de l'application cliente, et renseigne les variables avec les valeurs de ces attributs.

Cette règle est utile lorsque vous devez configurer un comportement conditionnel dynamique en fonction d'une valeur figurant dans un jeton ou un code d'authentification. Chaque fois que des validations de jeton sont effectuées, les variables sont automatiquement renseignées avec les valeurs d'attributs de jeton. Toutefois, dans le cas où la validation des jetons n'a pas eu lieu, vous pouvez utiliser cette fonctionnalité pour renseigner explicitement les variables avec les valeurs d'attribut d'un jeton. Voir également Personnaliser des jetons et des codes d'autorisation.

Le jeton d'accès que vous transmettez à cette règle doit être valide, sinon la règle renverra une erreur invalid_access_token.

Exemples

Les exemples suivants utilisent la règle GetOAuthV2 pour récupérer des informations sur différents composants du workflow OAuth2, puis accéder à ces informations dans le code.

<GetOAuthV2Info name="MyTokenAttrsPolicy">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
</GetOAuthV2Info>

var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope');

<GetOAuthV2Info name="MyAuthCodeAttrsPolicy">
  <AuthorizationCode ref="request.formparam.code"></AuthorizationCode>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name’);

<GetOAuthV2Info name="MyRefreshTokenAttrsPolicy">
  <RefreshToken ref="request.queryparam.refresh_token"/>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name’);

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken>shTUmeI1geSKin0TODcGLXBNe9vp</AccessToken>
</GetOAuthV2Info>

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId ref="request.queryparam.client_id"></ClientId>
</GetOAuthV2Info>

context.getVariable("oauthv2client.GetClientAttributes.developer.email");
context.getVariable("oauthv2client.GetClientAttributes.developer.app.name");

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="GetOAuthV2Info-1"
    <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref="variable"></AccessToken>
    <AuthorizationCode ref="variable"></AuthorizationCode>
    <ClientId ref="variable"></ClientId>
    <RefreshToken ref="variable"></RefreshToken>
</GetOAuthV2Info>

Attributs <GetOAuthV2Info>

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v20-Info-1">

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

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

Élément <AccessToken>

Récupère le profil pour un jeton d'accès. Vous transmettez une variable contenant une chaîne de jeton d'accès ou une chaîne de jeton littérale (cas rare). Dans cet exemple, le jeton d'accès est extrait d'un paramètre de requête transmis dans une requête. Utilisez l'élément <IgnoreAccessTokenStatus> si vous souhaitez renvoyer des informations pour un jeton révoqué ou expiré.

<AccessToken ref="request.queryparam.access_token"></AccessToken>

Élément <AuthorizationCode>

Récupère le profil pour un code d'autorisation. Vous transmettez une variable contenant la chaîne de code d'authentification ou une chaîne de jeton littérale (cas rare). Dans cet exemple, le code d'authentification est extrait d'un paramètre de requête transmis dans une requête. Pour obtenir la liste des variables renseignées par cette opération, consultez la section Variables de flux.

<AuthorizationCode ref="request.queryparam.authorization_code"></AuthorizationCode>

Élément <ClientId>

Récupère des informations sur un ID client. Dans cet exemple, l'ID client est extrait d'un paramètre de requête transmis dans une requête. Pour obtenir la liste des variables renseignées par cette opération, consultez la section Variables de flux.

<ClientId ref="request.queryparam.client_id"></ClientId>

Élément <IgnoreAccessTokenStatus>

Renvoie les informations du jeton même si celui-ci est expiré ou révoqué. Cet élément ne peut être utilisé qu'avec des jetons d'accès. Les informations sur d'autres entités telles que les jetons d'actualisation et les codes d'autorisation sont renvoyées par défaut, quel que soit leur statut.

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

Élément <RefreshToken>

Récupère le profil pour un jeton d'actualisation Vous transmettez une variable contenant la chaîne de jeton d'actualisation ou une chaîne de jeton littérale (cas rare). Dans cet exemple, le jeton d'actualisation est récupéré à partir d'un paramètre de requête transmis dans une requête. Pour obtenir la liste des variables renseignées par cette opération, consultez la section Variables de flux.

<RefreshToken ref="request.queryparam.refresh_token"></RefreshToken>

Variables de flux

La règle GetOAuthV2Info renseigne ces variables. Elle est généralement utilisée lorsque des données de profil sont nécessaires et qu'une autorisation ou une validation n'a pas encore eu lieu. .

Variables d'ID client

Ces variables sont renseignées lorsque l'élément ClientId est défini :

oauthv2client.{policy_name}.client_id
oauthv2client.{policy_name}.client_secret
oauthv2client.{policy_name}.redirection_uris // Note the spelling -- 'redirection_uris'
oauthv2client.{policy_name}.developer.email
oauthv2client.{policy_name}.developer.app.name
oauthv2client.{policy_name}.developer.id
oauthv2client.{policy_name}.{developer_app_custom_attribute_name}

Variables de jeton d'accès

Ces variables sont renseignées lorsque l'élément AccessToken est défini :

oauthv2accesstoken.{policy_name}.developer.id
oauthv2accesstoken.{policy_name}.developer.app.name
oauthv2accesstoken.{policy_name}.developer.app.id
oauthv2accesstoken.{policy_name}.developer.email

oauthv2accesstoken.{policy_name}.organization_name
oauthv2accesstoken.{policy_name}.api_product_list

oauthv2accesstoken.{policy_name}.access_token
oauthv2accesstoken.{policy_name}.scope
oauthv2accesstoken.{policy_name}.expires_in //in seconds
oauthv2accesstoken.{policy_name}.status
oauthv2accesstoken.{policy_name}.client_id
oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2accesstoken.{policy_name}.refresh_token
oauthv2accesstoken.{policy_name}.refresh_token_status
oauthv2accesstoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2accesstoken.{policy_name}.refresh_count
oauthv2accesstoken.{policy_name}.refresh_token_issued_at
oauthv2accesstoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

Variables de code d'autorisation

Ces variables sont renseignées lorsque l'élément AuthorizationCode est défini :

oauthv2authcode.{policy_name}.code
oauthv2authcode.{policy_name}.scope       
oauthv2authcode.{policy_name}.redirect_uri 
oauthv2authcode.{policy_name}.client_id
oauthv2authcode.{policy_name}.{auth_code_custom_attribute_name}

Variables de jeton d'actualisation

Ces variables sont renseignées lorsque l'élément RefreshToken est défini :

oauthv2refreshtoken.{policy_name}.developer.id
oauthv2refreshtoken.{policy_name}.developer.app.name
oauthv2refreshtoken.{policy_name}.developer.app.id
oauthv2refreshtoken.{policy_name}.developer.email
oauthv2refreshtoken.{policy_name}.organization_name
oauthv2refreshtoken.{policy_name}.api_product_list

oauthv2refreshtoken.{policy_name}.access_token
oauthv2refreshtoken.{policy_name}.scope
oauthv2refreshtoken.{policy_name}.expires_in //in seconds

oauthv2refreshtoken.{policy_name}.status
oauthv2refreshtoken.{policy_name}.client_id
oauthv2refreshtoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2refreshtoken.{policy_name}.refresh_token
oauthv2refreshtoken.{policy_name}.refresh_token_status
oauthv2refreshtoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2refreshtoken.{policy_name}.refresh_count
oauthv2refreshtoken.{policy_name}.refresh_token_issued_at
oauthv2refreshtoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

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, ainsi que les variables d'erreur définies par Edge lorsque cette stratégie 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. Les noms d'erreur indiqués ci-dessous sont les chaînes attribuées à la variable fault.name en cas d'erreur. Pour plus d'informations, consultez la section des variables de codes d'erreur ci-dessous.

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.

Exemple de réponse d'erreur

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

Exemple de règle de défaillance

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

Articles associés

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