Política SetOAuthV2Info

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Qué

Te permite agregar o actualizar atributos personalizados asociados con un token de acceso. Los atributos personalizados pueden incluir elementos como el nombre del departamento, un ID de cliente o un identificador de sesión. Consulta también Personaliza tokens y códigos de autorización.

Solo puedes agregar o modificar atributos personalizados. No puedes usar esta política para cambiar campos como scope, status, expires_in, developer_email, client_id, org_name, o refresh_count. Si ya existe un atributo, esta política lo actualiza. Si no existe, la política lo agrega. El token de acceso al que se hace referencia debe ser válido y debe tener un estado de aprobado.

Esta política es una política extensible, y el uso de esta política puede tener implicaciones de costo o uso, según tu licencia de Apigee. Para obtener información sobre los tipos de políticas y sus implicaciones de uso, consulta Tipos de políticas.

Muestras

Ejemplo básico

A continuación, se muestra una política de ejemplo que se usa para actualizar un token de acceso de OAuth 2.0. En el siguiente ejemplo, se encuentra el token de acceso en el mensaje de solicitud mediante la búsqueda de un parámetro de búsqueda llamado access_token. Cuando una app cliente presente un token de acceso, la siguiente política localizará el token de acceso en el parámetro de búsqueda. Luego, actualizará el perfil del token de acceso. Agrega una propiedad personalizada llamada department.id al perfil.

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

Referencia de elementos

En la referencia del elemento, se describen los elementos y los atributos de la política 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>

Atributos <SetOAuthV2Info>

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

En la siguiente tabla se describen los atributos que son comunes a todos los elementos superiores de la política:

Atributo	Descripción	Predeterminado	Presencia
`name`	El nombre interno de la política. El valor del atributo `name` puede contener letras, números, espacios, guiones, guiones bajos y puntos. Este valor no puede superar los 255 caracteres. Opcionalmente, usa el elemento `<DisplayName>` para etiquetar la política en el editor de proxy de la interfaz de gestión con un nombre diferente en lenguaje natural.	N/A	Obligatorio
`continueOnError`	Asigna el valor `false` para devolver un error cuando falle una política. Este es el comportamiento esperado de la mayoría de las políticas. Asigna el valor `true` para que la ejecución del flujo continúe incluso después de que falle una política. Consulta también: Las reglas de errores solo se activan cuando hay un error (sobre continueOnError) Gestionar fallos en el flujo actual	falso	Opcional
`enabled`	Asigna el valor `true` para aplicar la política. Selecciona `false` para desactivar la política. La política no se aplicará aunque siga adjunta a un flujo.	true	Opcional
`async`	Este atributo está obsoleto.	falso	Obsoleto

Elemento <DisplayName>

Úsalo junto con el atributo name para etiquetar la política en el editor de proxy de la interfaz de gestión con un nombre diferente en lenguaje natural.

<DisplayName>Policy Display Name</DisplayName>

Predeterminado

Predeterminado	N/A Si omite este elemento, se usará el valor del atributo `name` de la política.
Presencia	Opcional
Tipo	Cadena

N/A

Si omite este elemento, se usará el valor del atributo name de la política.

Presencia Opcional

Tipo Cadena

Elemento <AccessToken>

Identifica la variable en la que se encuentra el token de acceso. Por ejemplo, si el token de acceso se adjunta a un mensaje de solicitud como parámetro de búsqueda, especifica request.queryparam.access_token. Puedes usar cualquier variable válida que haga referencia al token. O bien, puedes pasar la string del token literal (este es un caso raro).

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

Predeterminado:	N/A
Presencia:	Obligatorio
Tipo:	String

Atributos

Atributo	Descripción	Predeterminado	Presence
ref	Una variable de token de acceso. Por lo general, se recupera de una variable de flujo.	N/A	Opcional

Elemento <Attributes>

Es un conjunto de atributos en el perfil del token de acceso que se modificará o mejorará.

Predeterminado:	N/A
Presencia:	Obligatorio
Tipo:	N/A

Elemento <Attributes>/<Attribute>

Es un atributo individual que se debe actualizar.

El atributo de nombre identifica la propiedad personalizada del perfil del token de acceso que se debe actualizar. En este ejemplo, se muestra cómo usar un valor de variable referenciado y un valor estático.

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

Predeterminado:	N/A
Presencia:	Opcional
Tipo:	N/A

Atributos

Atributo	Descripción	Predeterminado	Presence
name	Es el nombre del atributo del perfil que se debe agregar o cambiar.	N/A
ref	Es el valor que se debe asignar al atributo de perfil.	N/A	Opcional

Variables de flujo

Si tiene éxito, se establecerán las siguientes variables de flujo:

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}

Esquema

Un esquema XML (.xsd) define cada tipo de política. Como referencia, los esquemas de políticas están disponibles en GitHub.

Referencia de errores

En esta sección se describen los códigos de error y los mensajes de error que devuelve Apigee, así como las variables de error que define, cuando esta política activa un error. Es importante que conozcas esta información si vas a desarrollar reglas de errores para gestionarlos. Para obtener más información, consulta Qué debes saber sobre los errores de políticas y Cómo gestionar los fallos.

Errores de tiempo de ejecución

Estos errores pueden producirse cuando se ejecuta la política.

Código de fallo	Estado de HTTP	Causa
`steps.oauth.v2.access_token_expired`	`500`	El token de acceso enviado a la política ha caducado.
`steps.oauth.v2.invalid_access_token`	`500`	El token de acceso enviado a la política no es válido.
`steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound`	`401`	Consulte el artículo La verificación del token de acceso de OAuth 2.0 devuelve el error "Invalid API call as no apiproduct match found" (Llamada a la API no válida porque no se ha encontrado ningún producto de API coincidente) para obtener información sobre cómo solucionar este error.

Errores de implementación

Consulta el mensaje que se muestra en la interfaz de usuario para obtener información sobre los errores de implementación.

Variables de error

Estas variables se definen cuando esta política activa un error en el tiempo de ejecución.

Variables	Dónde	Ejemplo
`fault.name="fault_name"`	`fault_name` es el nombre del fallo, tal como se indica en la tabla Errores de tiempo de ejecución de arriba. El nombre del error es la última parte del código de error.	`fault.name = "invalid_access_token"`
`oauthV2.policy_name.failed`	`policy_name` es el nombre de la política especificado por el usuario que ha provocado el error.	`oauthV2.SetTokenInfo.failed = true`
`oauthV2.policy_name.fault.name`	`policy_name` es el nombre de la política especificado por el usuario que ha provocado el error.	`oauthV2.SetTokenInfo.fault.name = invalid_access_token`
`oauthv2.policy_name.fault.cause`	`policy_name` es el nombre de la política especificado por el usuario que ha provocado el error.	`oauthV2.SetTokenInfo.cause = Invalid Access Token`

Ejemplo de respuesta de error

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

Regla de error de ejemplo

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

Política SetOAuthV2Info Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Qué

Muestras

Ejemplo básico

Referencia de elementos

Atributos <SetOAuthV2Info>

Elemento <DisplayName>

Elemento <AccessToken>

Atributos

Elemento <Attributes>

Elemento <Attributes>/<Attribute>

Atributos

Variables de flujo

Esquema

Referencia de errores

Errores de tiempo de ejecución

Errores de implementación

Variables de error

Ejemplo de respuesta de error

Regla de error de ejemplo

Temas relacionados

Política SetOAuthV2Info