Criterio SetOAuthV2Info

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Cosa

Consente di aggiungere o aggiornare gli attributi personalizzati associati a un token di accesso. Attributi personalizzati potrebbero includere 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 usare questo criterio per modificare campi quali scope, status,expiry_in, developer_email, client_id, org_name o refresh_count. Se attributo già esistente, questo criterio lo aggiorna. Se non esiste, viene aggiunto dal criterio. La il token di accesso a cui viene fatto riferimento deve essere valido e in 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 agli elementi 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>

<ImpostaOAuthV2Info> attributi

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

&lt;AccessToken&gt; elemento

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 alla di accesso. In alternativa, potrebbe passare la stringa del token letterale (caso raro).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>

Attributi

&lt;Attributes&gt; elemento

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

&lt;Attributes&gt;/&lt;Attribute&gt; elemento

Un singolo attributo da aggiornare.

L'attributo name identifica la proprietà personalizzata del profilo del token di accesso da utilizzare aggiornato. Questo esempio mostra come utilizzare un valore della 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

Se l'operazione riesce, 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 criterio è definito da uno schema XML (.xsd). Come riferimento, consulta gli schemi dei criteri sono disponibili su GitHub.

Messaggi di errore

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

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

Example fault rule

<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

• Criterio OAuthV2
• Home page OAuth
• Personalizzazione dei token e i codici di autorizzazione