Secretos en la API de Reactor

En la API de Reactor, un secreto es un recurso que representa una credencial de autenticación. Los secretos se utilizan en el reenvío de eventos para autenticarse en otro sistema y asegurar el intercambio de datos. Por lo tanto, los secretos solo se pueden crear dentro de propiedades de reenvío de eventos (propiedades cuya propiedad platform el atributo se establece en edge).

Actualmente hay tres tipos de secretos admitidos indicados en la variable type_of atributo:

Esta guía proporciona información general de alto nivel sobre cómo configurar secretos para usarlos en el reenvío de eventos. Para obtener instrucciones detalladas sobre cómo administrar secretos en la API de Reactor, incluido el ejemplo JSON de la estructura de un secreto, consulte la guía de extremo de secretos.

Credenciales

Cada secreto contiene un credentials que contiene sus respectivos valores de credencial. Cuándo creación de un secreto en la APISin embargo, cada tipo de secreto tiene diferentes atributos requeridos, como se muestra en las secciones siguientes:

token token

Secretos con un type_of valor de token solo requiere un único atributo en credentials:

El token se almacena como un valor estático y, por lo tanto, el secreto expires_at y refresh_at Las propiedades se establecen en null cuando se crea el secreto.

simple-http simple-http

Secretos con un type_of valor de simple-http requiere los siguientes atributos en credentials:

Cuando se crea el secreto, los dos atributos se intercambian con una codificación BASE64 de username:password. Después del intercambio, el secreto es expires_at y refresh_at Las propiedades se establecen en null.

oauth2-client_credentials oauth2-client_credentials

Secretos con un type_of valor de oauth2-client_credentials requiere los siguientes atributos en credentials:

Cuando un oauth2-client_credentials se crea o actualiza el secreto, el client_id y client_secret (y posiblemente options) se intercambian en una solicitud de POST a token_url, según el flujo de Credenciales del cliente del protocolo de OAuth.

Si el servicio de autorización responde con 200 OK y un cuerpo de respuesta JSON, se analiza el cuerpo y se access_token se inserta en el entorno de edge de y expires_in se utiliza para calcular la expires_at y refresh_at atributos para el secreto. Si no hay ninguna asociación de entorno en el secreto, access_token se descarta.

Un intercambio de credenciales se considera exitoso bajo las siguientes condiciones:

Si el intercambio se realiza correctamente, el atributo de estado del secreto se establece en succeeded y valores para expires_at y refresh_at están configuradas:

Si el intercambio falla por cualquier motivo, la variable status_details en el meta actualizaciones de objetos con información relevante.

Actualización de un oauth2-client_credentials secreto

Si un oauth2-client_credentials se ha asignado un secreto a un entorno y su estado es succeeded (las credenciales se han intercambiado correctamente), se realiza un nuevo intercambio automáticamente el refresh_at.

Si el intercambio se realiza correctamente, la variable refresh_status en el meta el objeto está establecido en succeeded while expires_at, refresh_at, y activated_at se actualizan en consecuencia.

Si el intercambio falla, la operación se intenta tres veces más, con el último intento no más de dos horas antes de que caduque el token de acceso. Si todos los intentos fallan, la variable refresh_status_details atributo del meta actualizaciones de objetos con detalles relevantes.

oauth2-google oauth2-google

Secretos con un type_of valor de oauth2-google requiere el atributo siguiente en credentials:

Después de crear la variable oauth2-google secreto, la respuesta incluye una meta.authorization_url propiedad. Debe copiar y pegar esta dirección URL en un explorador para completar el flujo de autenticación de Google.

Volver a autorizar un oauth2-google secreto

La URL de autorización de un oauth2-google secret caduca una hora después de crearse el secreto (tal y como indica meta.authorization_url_expires_at). Después de este tiempo, el secreto debe volver a autorizarse para renovar el proceso de autenticación.

Consulte la guía de extremo de secretos para obtener más información sobre cómo volver a autorizar un oauth2-google secreto realizando una solicitud de PATCH a la API de Reactor.

Relación del entorno

Cuando cree un secreto, debe especificar el entorno en el que existirá. Los secretos se implementan inmediatamente en el entorno en el que se crean.

Un secreto solo se puede asociar a un entorno. Una vez establecida la relación entre un secreto y un entorno, el secreto no se puede borrar del entorno y no se puede asociar con un entorno diferente.

Después de intercambiar correctamente las credenciales de un secreto, para que un secreto se asocie a un entorno, el artefacto de intercambio (la cadena de token para token, la cadena codificada en Base64 para simple-httpo el token de acceso de oauth2-client_credentials) se guarda de forma segura en el entorno.

Una vez guardado correctamente el artefacto de intercambio en el entorno, el secreto activated_at está establecido en la hora UTC actual y ahora se puede hacer referencia a él mediante un elemento de datos. Consulte la sección siguiente para obtener más información sobre las referencias a secretos.

Secretos de referencia referencing-secrets

Para hacer referencia a un secreto, debe crear un elemento de datos de tipo "Secreto" (proporcionado por el Núcleo extensión) en una propiedad de reenvío de eventos. Al configurar este elemento de datos, se le pedirá que indique qué secreto utilizar para cada entorno. A continuación, puede crear reglas que hagan referencia a un elemento de datos secreto, como dentro del encabezado de una llamada HTTP.

Durante el tiempo de ejecución, el elemento de datos secreto se reemplaza por el artefacto de intercambio secreto correspondiente guardado en el entorno.

Pasos siguientes

Esta guía abarcaba los aspectos básicos del trabajo con secretos en la API de Reactor. Para obtener más información sobre cómo administrar secretos mediante llamadas a la API, consulte la guía de extremo de secretos.