Stai visualizzando la documentazione di Apigee Edge.
Vai alla
documentazione di Apigee X. informazioni
Cosa
Elimina il codice di autorizzazione o il token di accesso OAuth V2 specificato.
Samples
Eliminazione token di accesso
Di seguito è riportato un criterio di esempio utilizzato per eliminare un token di accesso per 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>
Di seguito è riportato un criterio di esempio 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
denominato code
.
<DeleteOAuthV2Info name="DeleteAuthCode"> <AuthorizationCode ref="request.queryparam.code"></AuthorizationCode> </DeleteOAuthV2Info>
Riferimento elemento
Il riferimento 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 |
---|---|---|---|
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 |
abilitata | Determina se un criterio viene applicato o meno. Se viene impostato su false , un criterio viene "disattivato" e non viene applicato (anche se il criterio rimane associato a un flusso). |
true | Facoltativo |
nome |
Il nome interno della norma. Questo nome viene fatto riferimento negli elementi del passaggio per collegare il criterio a un flusso. Nota:i caratteri utilizzabili 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 è associato a un messaggio di richiesta come parametro di ricerca chiamato "access_token", specifica
request.queryparam.access_token
. Puoi utilizzare qualsiasi variabile valida che faccia riferimento al token. oppure passare nella stringa token letterale (caso raro).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
Predefinito: | N/A |
Presenza: | È obbligatorio specificare <AccessToken> o <AuthorizationCode> . |
Tipo: | Stringa |
Attributi
Attributo | Descrizione | Predefinito | Presenza |
---|---|---|---|
rif |
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 ricerca chiamato "codice", specifica
request.queryparam.code
. Puoi utilizzare qualsiasi variabile valida che faccia riferimento al token.
oppure passare nella stringa token letterale (caso raro).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
Predefinito: | N/A |
Presenza: | È obbligatorio specificare <AccessToken> o <AuthorizationCode> . |
Tipo: | Stringa |
Attributi
Attributo | Descrizione | Predefinito | Presenza |
---|---|---|---|
rif |
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 dell'interfaccia utente di gestione. Se omesso, viene utilizzato l'attributo del nome del criterio.
<DisplayName>DeleteOAuthV2Info 1</DisplayName>
Predefinito: | Il valore dell'attributo name del criterio. |
Presenza: | Facoltativo |
Tipo: | Stringa |
Output
Se l'operazione va a buon fine, il criterio restituisce lo stato 200.
In caso di errore, il criterio restituisce un errore 404 e un output simile al seguente (a seconda che tu stia eliminando un token di accesso o un codice di autorizzazione):
HTTP/1.1 404 Not Found Content-Type: application/json Content-Length: 144 Connection: keep-alive {"fault":{"faultstring":"Invalid Authorization Code","detail":{"errorcode":"keymanagement.service.invalid_request-authorization_code_invalid"}}}
Schema
Ogni tipo di criterio è definito da uno schema XML (.xsd
). Come riferimento, gli schemi dei criteri sono disponibili su GitHub.