Norme DeleteOAuthV2Info

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

icona delle norme

Cosa

Consente di eliminare il codice di autorizzazione o il token di accesso OAuth 2.0 specificato.

Questo criterio è un criterio estensibile e il suo utilizzo potrebbe comportare implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni per l'utilizzo, consulta Tipi di criteri.

Esempi

Eliminare il 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 denominata access_token.

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

Elimina codice di autenticazione

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

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

Riferimento elemento

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

Impostato su true per specificare che il criterio deve essere eseguito in un pool di thread diverso da quello che gestisce il flusso di richiesta/risposta. Il valore predefinito è 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. Se imposti questo attributo su true, l'esecuzione del flusso continua in caso di errore.

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

Il nome interno del criterio. A questo nome viene fatto riferimento negli elementi Passaggio per collegare il criterio a un flusso.

Nota: i caratteri che puoi utilizzare nel nome sono limitati a: A-Z0-9._\-$ %. L'interfaccia utente di Apigee applica ulteriori limitazioni, 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 è allegato 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, è possibile passare la stringa del token letterale (caso raro).

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

Attributi

Attributo Descrizione Predefinito Presenza
ref

Una variabile token di accesso. In genere, viene recuperato 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 è allegato al messaggio di richiesta come parametro di query denominato "code", specifica request.queryparam.code. Puoi utilizzare qualsiasi variabile valida che fa riferimento al token. In alternativa, è possibile passare la stringa del token letterale (caso raro).

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

Attributi

Attributo Descrizione Predefinito Presenza
ref

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

 N/D Facoltativo

Elemento <DisplayName>

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

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

Messaggi di errore

Questa sezione descrive i codici di errore e i messaggi di errore restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti se stai sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta Informazioni importanti sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi durante l'esecuzione del criterio.

Codice guasto Stato HTTP Causa
steps.oauth.v2.invalid_access_token 401 Il token di accesso inviato alla policy non è valido.
steps.oauth.v2.invalid_request-authorization_code_invalid 401 Il codice di autorizzazione inviato al criterio non è valido.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Consulta La verifica del token di accesso OAuth2.0 genera l'errore "Chiamata API non valida perché non è stata trovata alcuna corrispondenza per apiproduct" per informazioni sulla risoluzione di questo errore.

Errori di deployment

Per informazioni sugli errori di deployment, fai riferimento al messaggio riportato nell'interfaccia utente.

Variabili di errore

Queste variabili vengono impostate quando questo criterio attiva un errore in fase di runtime.

Variabili Dove Esempio
fault.name="fault_name" fault_name è il nome dell'errore, come indicato nella tabella Errori di runtime sopra. Il nome dell'errore è l'ultima parte del codice dell'errore. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name è il nome specificato dall'utente del criterio che ha generato l'errore. oauthV2.DeleteTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name è il nome specificato dall'utente del criterio che ha generato l'errore. oauthV2.DeleteTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name è il nome specificato dall'utente del criterio che ha generato l'errore. oauthV2.DeleteTokenInfo.cause = Invalid Access Token

Esempio di risposta di errore

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

Esempio di regola di errore

<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 norma è definito da uno schema XML (.xsd). Come riferimento, gli schemi delle norme sono disponibili su GitHub.

Argomenti correlati