DeleteOAuthV2Info

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

Informazioni | Esempi | Riferimento elemento | Output | Schema | Argomenti correlati

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>

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

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
enabled 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
name

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
ref

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).

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

Attributi

Attributo Descrizione Predefinito Presenza
ref

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

Output

In caso di successo, la policy restituisce uno stato 200.

In caso di errore, la policy restituisce 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 policy è definito da uno schema XML (.xsd). Per riferimento, gli schemi delle policy sono disponibili su GitHub.

Argomenti correlati