Criterio SetOAuthV2Info

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

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 Personalizzazione di token e codici di autorizzazione.

Puoi solo aggiungere o modificare gli attributi personalizzati. Non puoi utilizzare questo criterio per modificare campi come scope, status, expires_in, developer_email, client_id, org_name o refresh_count. Se un attributo esiste già, queste norme lo aggiornano. Se non esiste, il criterio lo aggiunge. Il token di accesso a cui viene fatto riferimento deve essere valido e in uno stato approvato.

Queste norme sono estensibili e il loro utilizzo potrebbe avere implicazioni in termini di costi o di utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di policy e sulle implicazioni di utilizzo, consulta Tipi di policy.

Esempi

Esempio di base

Di seguito è riportato un esempio di policy utilizzata 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 policy di seguito individua il token di accesso nel parametro di query. Verrà quindi aggiornato il profilo del token di accesso. Viene aggiunta una proprietà personalizzata chiamata 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">

The following table describes attributes that are common to all policy parent elements:

Attribute Description Default Presence
name

The internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the <DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.

 N/A Required
continueOnError

Set to false to return an error when a policy fails. This is expected behavior for most policies.

Set to true to have flow execution continue even after a policy fails. See also:

 false Optional
enabled

Set to true to enforce the policy.

Set to false to turn off the policy. The policy will not be enforced even if it remains attached to a flow.

 true Optional
async

This attribute is deprecated.

 false Deprecated

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>
Default

N/A

If you omit this element, the value of the policy's name attribute is used.
Presence Optional
Type String

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 query, specifica request.queryparam.access_token. Puoi utilizzare qualsiasi variabile valida che faccia riferimento al token. oppure puoi passare la stringa del token letterale (caso raro).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>
Predefinito: N/D
Presenza: Obbligatorio
Tipo: Stringa

Attributi

Attributo Descrizione Predefinito Presenza
ref

Una variabile del token di accesso. In genere, 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.

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 di 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>
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 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 Apigee 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.

Codice di errore 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 con il prodotto API" per informazioni sulla risoluzione di questo errore.

Errori di deployment

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

Variabili di errore

Queste variabili vengono impostate quando questa norma genera un errore in fase di runtime.

Variabili Dove Esempio
fault.name="fault_name" fault_name è il nome dell'errore, come elencato nella tabella Errori di runtime riportata sopra. Il nome del guasto è l'ultima parte del codice di guasto. 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"
    }
  }
}

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