Criterio SetOAuthV2Info

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

icona delle norme

Cosa

Consente di aggiungere o aggiornare gli attributi personalizzati associati a un token di accesso. Gli attributi personalizzati possono includere, ad esempio, il nome del reparto, un ID cliente o un identificatore di sessione. Consulta anche Personalizzare token e codici di autorizzazione.

Puoi solo aggiungere o modificare gli attributi personalizzati. Non puoi utilizzare questo criterio per modificare campi come scopo, stato, expires_in, developer_email, client_id, org_name o refresh_count. Se un attributo esiste già, questa norma lo aggiorna. Se non esiste, il criterio lo aggiunge. Il token di accesso a cui si fa riferimento deve essere valido e in uno stato approvato.

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

Esempio di base

Di seguito è riportato un esempio di criterio utilizzato per aggiornare un token di accesso OAuth 2.0. L'esempio seguente individua il token di accesso nel messaggio di richiesta cercando un parametro di query chiamato access_token. Quando un token di accesso viene presentato da un'app client, la norma riportata di seguito individua il token di accesso nel parametro di query. Aggiornerà quindi il profilo del token di accesso. Aggiunge una proprietà personalizzata denominata department.id al profilo. 

<SetOAuthV2Info name="SetOAuthV2Info"> 
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

Riferimento elemento

Il riferimento all'elemento descrive gli elementi e gli attributi del criterio SetOAuthV2.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="SetOAuthV2Info-1">    
    <DisplayName>Set OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <Attributes/>
</SetOAuthV2Info>
</xml>

Attributi <SetOAuthV2Info>

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:

Attributo Descrizione Predefinito Presenza
name

Il nome interno del criterio. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri.

Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

 N/D Obbligatorio
continueOnError

Imposta su false per restituire un errore quando un criterio non va a buon fine. Questo è un comportamento previsto per la maggior parte dei criteri.

Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche:

 falso Facoltativo
enabled

Imposta su true per applicare il criterio.

Imposta false per disattivare il criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso.

 true Facoltativo
async

Questo attributo è stato ritirato.

 falso Ritirato

Elemento <DisplayName>

Da utilizzare insieme all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>
Predefinito

N/D

Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
Presenza Facoltativo
Tipo Stringa

Elemento <AccessToken>

Identifica la variabile in cui si trova il token di accesso. Ad esempio, se il token di accesso è associato al messaggio di richiesta come parametro di query, 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
Tipo: Stringa

Attributi

Attributo Descrizione Predefinito Presenza
ref

Una variabile token di accesso. In genere, viene recuperato da una variabile di flusso.

 N/D Facoltativo

Elemento <Attributes>

Un insieme di attributi nel profilo del token di accesso che verranno modificati o aumentati.

Valore predefinito: N/D
Presenza: Obbligatorio
Tipo: N/D

Elemento <Attributes>/<Attribute>

Un singolo attributo da aggiornare.

L'attributo name identifica la proprietà personalizzata del profilo del token di accesso da aggiornare. Questo esempio mostra come utilizzare un valore della variabile a cui viene fatto riferimento e un valore statico. 

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>
Valore predefinito: N/D
Presenza: Facoltativo
Tipo: N/D

Attributi

Attributo Descrizione Predefinito Presenza
nome Il nome dell'attributo del profilo da aggiungere o modificare. N/D
ref

Il valore da assegnare all'attributo del profilo.

 N/D Facoltativo

Variabili di flusso

In caso di esito positivo, verranno impostate le seguenti variabili di flusso:

  • oauthv2accesstoken.{policyName}.access_token
  • oauthv2accesstoken.{policyName}.client_id
  • oauthv2accesstoken.{policyName}.refresh_count
  • oauthv2accesstoken.{policyName}.organization_name
  • oauthv2accesstoken.{policyName}.expires_in //--in seconds
  • oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
  • oauthv2accesstoken.{policyName}.issued_at
  • oauthv2accesstoken.{policyName}.status
  • oauthv2accesstoken.{policyName}.api_product_list
  • oauthv2accesstoken.{policyName}.token_type
  • oauthv2accesstoken.{policyName}.{custom_attribute_name}

Schema

Ogni tipo di norma è definito da uno schema XML (.xsd). Come riferimento, gli schemi delle norme sono disponibili su GitHub.

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.access_token_expired 500 Il token di accesso inviato al criterio è scaduto.
steps.oauth.v2.invalid_access_token 500 Il token di accesso inviato alla policy 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.SetTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name è il nome specificato dall'utente del criterio che ha generato l'errore. oauthV2.SetTokenInfo.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.SetTokenInfo.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=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Argomenti correlati