Questa pagina si applica a Apigee e Apigee ibrido.
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, ad esempio, 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,expiry_in, developer_email, client_id, org_name o refresh_count. Se un attributo esiste già, questo criterio lo aggiorna. Se non esiste, viene aggiunto dal criterio. Il token di accesso a cui viene fatto riferimento deve essere valido e in stato approvato.
Questo criterio è un criterio estendibile e il suo utilizzo potrebbe avere 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 la pagina 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 in basso consente di individuare 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, il criterio riportato di seguito consente di individuarlo nel parametro di query. Successivamente, aggiornerà il profilo
del token di accesso. Aggiunge al profilo una proprietà personalizzata denominata department.id
.
<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>
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 della norma. Il valore dell'attributo Facoltativamente, utilizza l'elemento |
N/A | Obbligatorio |
continueOnError |
Impostalo su Imposta su |
false | Facoltativo |
enabled |
Imposta il criterio su Impostala su |
true | Facoltativo |
async |
Questo attributo è obsoleto. |
false | Deprecata |
Elemento <DisplayName>
Utilizzalo in aggiunta 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/A Se ometti questo elemento, viene utilizzato il valore dell'attributo |
---|---|
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 a un messaggio di richiesta come parametro di query, specifica request.queryparam.access_token
. Puoi utilizzare qualsiasi variabile valida che faccia riferimento al token. In alternativa, potrebbe passare la stringa del token letterale (caso raro).
<AccessToken ref="request.queryparam.access_token"></AccessToken>
Predefinita: | N/A |
Presenza: | Obbligatorio |
Tipo: | String |
Attributi
Attributo | Descrizione | Predefinita | Presenza |
---|---|---|---|
riferimento |
Una variabile del token di accesso. In genere, recuperato da una variabile di flusso. |
N/A | Facoltativo |
Elemento <Attributes>
Un insieme di attributi nel profilo del token di accesso che verranno modificati o ampliati.
Predefinita: | N/A |
Presenza: | Obbligatorio |
Tipo: | N/A |
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 di riferimento e un valore statico.
<Attributes> <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute> <Attribute name="foo">bar</Attribute> </Attributes>
Predefinita: | N/A |
Presenza: | Facoltativo |
Tipo: | N/A |
Attributi
Attributo | Descrizione | Predefinita | Presenza |
---|---|---|---|
nome | Il nome dell'attributo del profilo da aggiungere o modificare. | N/A | |
riferimento |
Il valore da assegnare all'attributo del profilo. |
N/A | Facoltativo |
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, su GitHub sono disponibili gli schemi dei criteri.
Messaggi di errore
Questa sezione descrive i codici e i messaggi di errore che vengono restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.
Errori di runtime
Questi errori possono verificarsi quando il criterio viene eseguito.
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 al criterio 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 apiproduct" per informazioni sulla risoluzione di questo errore. |
Errori di deployment
Per informazioni sugli errori di deployment, consulta il 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 riportata sopra. Il nome del guasto è l'ultima parte del codice di 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>