Questa pagina si applica a Apigee e Apigee ibrido.
Visualizza la documentazione di
Apigee Edge.
Cosa
Elimina il codice di autorizzazione o il token di accesso OAuth V2 specificati.
Questo criterio è un criterio estendibile e il suo utilizzo potrebbe avere 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 la pagina Tipi di criteri.
Esempi
Elimina token di accesso
Di seguito è riportato un esempio di criterio utilizzato per eliminare un token di accesso OAuth 2.0. L'esempio riportato di seguito consente di individuare 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 autorizzazione
Di seguito è riportato un esempio di criterio utilizzato per eliminare un codice di autorizzazione OAuth 2.0. L'esempio seguente consente di individuare 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 agli elementi 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 | Predefinita | Presenza |
---|---|---|---|
async |
Impostalo su Questa impostazione viene utilizzata solo per l'ottimizzazione interna. |
false | Facoltativo |
continueOnError |
La maggior parte dei criteri dovrebbe restituire un errore quando si verifica un errore. Se imposti questo attributo su |
false | Facoltativo |
abilitato | Determina se un criterio viene applicato o meno. Se viene impostato su false , un criterio viene "disattivato" e non viene applicato in modo forzato (anche se rimane collegato a un flusso). |
true | Facoltativo |
nome |
Il nome interno del criterio. Questo nome viene utilizzato come riferimento negli elementi Step per collegare il criterio a un flusso. Nota: i caratteri che puoi utilizzare nel nome sono limitati a:
|
N/A | Obbligatorio |
Elemento <AccessToken>
Identifica la variabile in cui si trova il token di accesso da eliminare. Ad esempio, se il
token di accesso è allegato a un messaggio di richiesta come parametro di query chiamato "access_token", specifica
request.queryparam.access_token
. Puoi utilizzare qualsiasi variabile valida che faccia riferimento al token. In alternativa, potrebbe passare la stringa del token letterale (caso raro).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
Predefinita: | N/A |
Presenza: | È obbligatorio specificare <AccessToken> o <AuthorizationCode> . |
Tipo: | String |
Attributi
Attributo | Descrizione | Predefinita | Presenza |
---|---|---|---|
riferimento |
Una variabile del token di accesso. In genere, recuperato da una variabile di flusso. Ad
esempio: |
N/A | 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 chiamato "code", specifica
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/A |
Presenza: | È obbligatorio specificare <AccessToken> o <AuthorizationCode> . |
Tipo: | String |
Attributi
Attributo | Descrizione | Predefinita | Presenza |
---|---|---|---|
riferimento |
Una variabile del token di accesso. In genere, recuperato da una variabile di flusso. Ad
esempio: |
N/A | Facoltativo |
Elemento<DisplayName>
Un nome in linguaggio naturale che etichetta il criterio nell'editor proxy della UI di Apigee. 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: | String |
Messaggi di errore
Questa sezione descrive i codici e i messaggi di errore che vengono restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.
Errori di runtime
Questi errori possono verificarsi quando il criterio viene eseguito.
Codice di errore | Stato HTTP | Causa |
---|---|---|
steps.oauth.v2.invalid_access_token |
401 |
Il token di accesso inviato al criterio 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 apiproduct" per informazioni sulla risoluzione di questo errore. |
Errori di deployment
Per informazioni sugli errori di deployment, consulta il 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 riportata sopra. Il nome del guasto è l'ultima parte del codice di 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 criterio è definito da uno schema XML (.xsd
). Come riferimento, su GitHub sono disponibili gli schemi dei criteri.