Norme relative a DeleteOAuthV2Info

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Cosa

Elimina il codice di autorizzazione o il token di accesso OAuth V2 specificati.

Esempi

Elimina token di accesso

Di seguito è riportato un esempio di criterio utilizzato per eliminare un token di accesso OAuth 2.0. L'esempio seguente individua il token di accesso da eliminare nel messaggio di richiesta cercando un'intestazione access_token.

<DeleteOAuthV2Info name="DeleteAccessToken">
     <AccessToken ref="request.header.access_token"></AccessToken>
</DeleteOAuthV2Info>

Elimina codice di autorizzazione

Di seguito è riportato un esempio di criterio utilizzato per eliminare un codice di autorizzazione OAuth 2.0. Nell'esempio riportato di seguito individua il codice di autorizzazione da eliminare nel messaggio di richiesta cercando un parametro di query code.

<DeleteOAuthV2Info name="DeleteAuthCode">
     <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
</DeleteOAuthV2Info>

Riferimento elemento

Il riferimento all'elemento descrive gli elementi e gli attributi di DeleteOAuthV2Info .

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

<EliminaOAuthV2Info> attributi

<DeleteOAuthV2Info async="false" continueOnError="false" enabled="true" name="Delete-OAuth-v20-Info-1">
Attributo Descrizione Predefinito Presenza
asinc

Imposta il valore su true per specificare che il criterio deve essere eseguito in un thread diverso da quello che gestisce il flusso di richiesta/risposta. Predefinita è false.

Questa impostazione viene utilizzata solo per l'ottimizzazione interna.

 falso Facoltativo
continueOnError

La maggior parte dei criteri dovrebbe restituire un errore quando si verifica un errore. Impostando questo su true, l'esecuzione del flusso continua in caso di errore.

 falso Facoltativo
abilitata Determina se un criterio viene applicato o meno. Se impostato su false, viene viene "disattivato" e non applicato (anche se rimane associato a un flusso). true Facoltativo
nome

Il nome interno del criterio. Questo nome viene indicato negli elementi dei passaggi da collegare il criterio a un Flow.

Nota: i caratteri che puoi utilizzare nel nome sono limitati a: A-Z0-9._\-$ %. L'interfaccia utente di gestione applica restrizioni aggiuntive, rimuove automaticamente i caratteri non alfanumerici.

 N/D Obbligatorio

&lt;AccessToken&gt; elemento

Identifica la variabile in cui si trova il token di accesso da eliminare. Ad esempio, se Il token di accesso è allegato al messaggio di richiesta come parametro di query denominato "access_token". request.queryparam.access_token. Puoi utilizzare qualsiasi variabile valida che faccia riferimento alla di accesso. In alternativa, potrebbe passare la stringa del token letterale (caso raro).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Predefinita: N/D
Presenza: <AccessToken> o <AuthorizationCode> sono obbligatorio.
Tipo: Stringa

Attributi

Attributo Descrizione Predefinito Presenza
riferimento

Una variabile del token di accesso. In genere, recuperato da una variabile di flusso. Per esempio: request.header.token o request.queryparam.token.

 N/D Facoltativo

&lt;AuthorizationCode&gt; elemento

Identifica la variabile in cui si trova il codice di autorizzazione da eliminare. Ad esempio, se codice di autorizzazione è allegato al messaggio di richiesta come parametro di query chiamato "code". request.queryparam.code. Puoi utilizzare qualsiasi variabile valida che faccia riferimento al token. In alternativa, potrebbe passare la stringa del token letterale (caso raro).

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Predefinita: N/D
Presenza: <AccessToken> o <AuthorizationCode> sono obbligatorio.
Tipo: Stringa

Attributi

Attributo Descrizione Predefinito Presenza
riferimento

Una variabile del token di accesso. In genere, recuperato da una variabile di flusso. Per esempio: request.header.code o request.queryparam.code.

 N/D Facoltativo

&lt;DisplayName&gt; elemento

Un nome in linguaggio naturale che etichetta il criterio nell'editor proxy dell'interfaccia utente di gestione. Se omesso, viene utilizzato l'attributo del nome del criterio.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Predefinita: Il valore dell'attributo name del criterio.
Presenza: Facoltativo
Tipo: Stringa

Messaggi di errore

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.

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 this Apigee Community post 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>

Schema

Ogni tipo di criterio è definito da uno schema XML (.xsd). Come riferimento, consulta gli schemi dei criteri sono disponibili su GitHub.

Argomenti correlati