Norme relative a DeleteOAuthV2Info

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Cosa

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

Esempi

Elimina token di accesso

Di seguito è riportato un esempio di policy utilizzata 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 denominata access_token.

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

Elimina codice di autenticazione

Di seguito è riportato un esempio di policy utilizzata per eliminare un codice di autorizzazione OAuth 2.0. L'esempio seguente individua il codice di autorizzazione da eliminare nel messaggio di richiesta cercando un parametro di query denominato code.

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

Riferimento elemento

Il riferimento all'elemento descrive gli elementi e gli attributi della policy 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

Attributi <DeleteOAuthV2Info>

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

Imposta su true per specificare che la policy deve essere eseguita in un pool di thread diverso dal pool che gestisce il flusso di richiesta/risposta. Il valore predefinito è false.

Questa impostazione viene utilizzata solo per l'ottimizzazione interna.

 false Facoltativo
continueOnError

La maggior parte delle policy dovrebbe restituire un errore in caso di errore. Se imposti questo attributo su true, l'esecuzione del flusso continua in caso di errore.

 false Facoltativo
attivato Determina se una policy viene applicata o meno. Se impostata su false, una policy viene "disattivata" e non applicata (anche se la policy rimane collegata a un flusso). true Facoltativo
nome

Il nome interno della policy. Questo nome viene fatto riferimento negli elementi Step per collegare la policy a un flusso.

Nota: i caratteri che puoi utilizzare nel nome sono limitati a: A-Z0-9._\-$ %. L'interfaccia utente di gestione applica ulteriori restrizioni, ad esempio la rimozione automatica dei caratteri non alfanumerici.

 N/D Obbligatorio

Elemento <AccessToken>

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

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Predefinito: N/D
Presenza: È obbligatorio specificare <AccessToken> o <AuthorizationCode> è richiesto.
Tipo: Stringa

Attributi

Attributo Descrizione Predefinito Presenza
rif

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

 N/D Facoltativo

Elemento <AuthorizationCode>

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

 <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode>
Predefinito: N/D
Presenza: È obbligatorio specificare <AccessToken> o <AuthorizationCode> è richiesto.
Tipo: Stringa

Attributi

Attributo Descrizione Predefinito Presenza
rif

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

 N/D Facoltativo

<DisplayName> elemento

Un nome in linguaggio naturale che etichetta la policy nell'editor proxy dell'interfaccia utente di gestione. Se omesso, viene utilizzato l'attributo name della policy.

<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Predefinito: Il valore dell'attributo name della policy.
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 policy è definito da uno schema XML (.xsd). Per riferimento, gli schemi delle policy sono disponibili su GitHub.

Argomenti correlati