Criterio SetOAuthV2Info

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

Cosa

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

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

Esempi

<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 elemento descrive gli elementi e gli attributi della policy 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 del criterio:

&lt;DisplayName&gt; elemento

Da utilizzare in aggiunta all'attributo name per etichettare il criterio in editor proxy della UI di gestione con un nome diverso e in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

Elemento <AccessToken>

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

Attributi

Elemento <Attributes>

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

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 di variabile di riferimento e un valore statico.

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>

Attributi

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 policy è definito da uno schema XML (.xsd). Per riferimento, gli schemi delle policy 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 Edge quando questo criterio genera un errore. Queste informazioni sono importanti se stai sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta Cosa devi sapere sugli errori relativi alle norme e Gestione dei guasti.

Errori di runtime

Questi errori possono verificarsi durante l'esecuzione del criterio.

Errori di deployment

Per informazioni sugli errori di deployment, consulta il messaggio segnalato nell'interfaccia utente.

Variabili di errore

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

Esempio di risposta di errore

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

Regola di errore di esempio

<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

• policy OAuthV2
• Home page di OAuth
• Personalizzare token e codici di autorizzazione