Crear aplicaciones OAuth2 para Workfront integraciones
Como un Adobe Workfront administrador, puede crear aplicaciones OAuth2 para la instancia de Workfront, que permiten a otras aplicaciones acceder a Workfront. Los usuarios pueden dar permiso a esas otras aplicaciones para acceder a su Workfront datos. De este modo, puede integrarse con las aplicaciones de su elección, incluidas las aplicaciones internas.
Cuando crea un OAuth2 La aplicación genera un ID de cliente y un Secreto de cliente. A continuación, los usuarios pueden utilizar el ID de cliente en las llamadas API para integrarse con la aplicación que ha creado.
- Para obtener instrucciones sobre la configuración y el uso de la aplicación OAuth2 con credenciales de usuario (flujo de código de autorización), consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo del código de autorización.
- Para obtener instrucciones sobre la configuración y el uso de la aplicación OAuth2 mediante la autenticación del servidor (flujo JWT), consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo JWT.
- Para obtener instrucciones sobre la configuración y el uso de la aplicación OAuth2 mediante PKCE, consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo PKCE.
Requisitos de acceso
Debe tener el siguiente acceso para realizar los pasos de este artículo:
| table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
|---|---|
| Adobe Workfront plan* | Cualquiera |
| Adobe Workfront licencia* |
Nuevo: Standard O Actual:plan |
| Configuraciones de nivel de acceso* | Debe ser un Workfront administrador. |
*Para saber qué plan, tipo de licencia o acceso tiene, póngase en contacto con su Workfront administrador.
Información general de OAuth2
Imagine que una aplicación debe extraer información específica de Workfront. Una aplicación que solicita información se denomina cliente. Para este ejemplo, el nombre de cliente es ClientApp. ClientApp necesita acceder a la información de un usuario en particular y, por lo tanto, debe acceder a Workfront como ese usuario. Si el usuario proporciona a ClientApp su nombre de usuario y contraseña, ClientApp podría acceder a todos los datos a los que el usuario puede acceder. Esto supone un riesgo para la seguridad, ya que ClientApp solo necesita un pequeño conjunto específico de información.
Al crear una aplicación OAuth2 para ClientApp, básicamente está diciendo Workfront que ClientApp puede acceder a Workfront, pero solo si el usuario a cuya cuenta accede ClientApp concede permiso para el acceso.
Creación de una aplicación OAuth2
Al crear una aplicación OAuth2, elija el tipo de aplicación que mejor se adapte a las necesidades de su integración.
Es ideal para CLI, daemons o scripts que se ejecutan en el servidor
Ejemplos:
-
Shell
-
Python
Ideal para aplicaciones móviles o de una sola página
Ejemplos:
-
Javascript
-
Angular
-
React
-
Vue
Ideal para aplicaciones del lado del servidor que administran credenciales y tokens en el servidor
Ejemplos:
-
Go
-
Java
-
ASP.Net
-
Node.js
-
PHP
Creación de una aplicación OAuth2 mediante autenticación de servidor (flujo JWT) create-an-oauth2-application-using-server-authentication-jwt-flow
-
Haga clic en Menú principal icono
-
En el panel de navegación izquierdo, haga clic en Sistema, luego seleccione Aplicaciones OAuth2.
-
Clic Crear integración de aplicaciones.
El Nueva aplicación OAuth2 aparece el cuadro. -
En el Nueva aplicación OAuth2 , seleccione Aplicación de máquina a máquina.
-
Introduzca un nombre para la nueva aplicación, como "Workfront para ClientApp."
-
Haga clic en Crear.
-
Rellene los campos de la nueva aplicación.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header ID de cliente Este campo se genera automáticamente. Secreto de cliente Este campo se genera automáticamente
IMPORTANTE:
Copie el contenido de este campo en otro archivo seguro antes de cerrar esta página. No podrá volver a ver esta clave secreta.
Si pierde esta clave, elimínela y cree un Secreto de cliente.
-
Haga clic en Eliminar icono
-
Clic Agregar secreto de cliente para generar un nuevo Secreto de cliente.
Claves públicas de Las aplicaciones de servidor a servidor utilizan claves públicas y privadas para la autenticación. Realice una de las siguientes acciones:
-
Clic Agregar una clave pública e introduzca la clave pública desde la otra aplicación.
-
Clic Generar un par de claves pública y privada, luego comparta la clave pública con la otra aplicación.
Nombre Es el mismo nombre que le dio a la aplicación. Este campo no puede estar vacío. Descripción Introduzca una descripción para la integración. -
-
Haga clic en Guardar.
Para obtener instrucciones sobre la configuración y el uso de la aplicación OAuth2 con credenciales de usuario (flujo de código de autorización), consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo JWT.
Crear una aplicación OAuth2 con credenciales de usuario (flujo de código de autorización) create-an-oauth2-application-using-user-credentials-authorization-code-flow
-
Haga clic en Menú principal icono
-
En el panel de navegación izquierdo, haga clic en Sistema, luego seleccione Aplicaciones OAuth2.
-
Clic Crear integración de aplicaciones.
El Nueva aplicación OAuth2 muestra.
-
En el Nueva aplicación OAuth2 , seleccione Aplicación web.
-
Introduzca un nombre para la nueva aplicación OAuth2, como "Workfront para ClientApp."
-
Haga clic en Crear.
-
Rellene los campos de la nueva aplicación.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 layout-auto html-authored no-header ID de cliente Este campo se genera automáticamente. Secreto de cliente Este campo se genera automáticamente
IMPORTANTE:
Copie el contenido de este campo en otro archivo seguro antes de cerrar esta página. No podrá volver a ver esta clave secreta.
Si pierde esta clave, elimínela y cree un Secreto de cliente.
-
Haga clic en Eliminar icono
-
Clic Agregar secreto de cliente para generar un nuevo Secreto de cliente.
URL de redireccionamiento Los usuarios serán redirigidos a esta ruta después de que se hayan autenticado con Workfront. Actualizar rotación del token Habilite esta opción para emitir un nuevo token de actualización cada vez que se use el token. Su aplicación debe almacenar el nuevo token de actualización después de cada actualización. Expiración absoluta del token de actualización Seleccione la cantidad de tiempo que desea que exista un token de actualización antes de que caduque. Cuando caduca, los usuarios deben volver a iniciar sesión en la integración. Seleccione "Sin caducidad" si no desea que caduque el token de actualización. vencimiento del token de actualización por inactividad Seleccione la cantidad de tiempo después de la cual, si el usuario no ha estado activo en el sistema, caduca su token de actualización.
Por ejemplo, si la caducidad del token de actualización por inactividad es de seis meses y el usuario no inicia sesión durante seis meses, el token de actualización caduca aunque la caducidad del token de actualización absoluta se pueda establecer para más tiempo.
Logotipo de Puede añadir un logotipo para hacer que esta aplicación sea más identificable. Nombre Es el mismo nombre que le dio a la aplicación. Este campo no puede estar vacío. Descripción Introduzca una descripción para la integración. App Description URL Puede ser un vínculo a una página "Acerca de nosotros" o una página con más información sobre la integración. -
-
Haga clic en Guardar.
Para obtener instrucciones sobre la configuración y el uso de la aplicación OAuth2 con credenciales de usuario (flujo de código de autorización), consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo del código de autorización.
Creación de una aplicación web de una sola página de OAuth2 mediante PKCE create-an-oauth2-single-page-web-application-using-pkce
-
Haga clic en Menú principal icono
-
En el panel de navegación izquierdo, haga clic en Sistema, luego seleccione Aplicaciones OAuth2.
-
Clic Crear integración de aplicaciones.
El Nueva aplicación OAuth2 aparece el cuadro.
-
En el Nueva aplicación OAuth2 , seleccione Aplicación web de una sola página.
-
Introduzca un nombre para el nuevo OAuth2 aplicación, como "Workfront para ClientApp."
-
Haga clic en Crear.
-
Rellene los campos de la nueva aplicación.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 layout-auto html-authored no-header ID de cliente Este campo se genera automáticamente. URL de redireccionamiento Los usuarios se redirigirán a esta ruta después de autenticarse en Workfront. Rotar token de actualización cada vez que se utilice Habilite esta opción para emitir un nuevo token de actualización cada vez que se use el token. Su aplicación debe almacenar el nuevo token de actualización después de cada actualización. Expiración absoluta Seleccione la cantidad de tiempo que desea que exista un token de actualización antes de que caduque. Cuando caduca, los usuarios deben volver a iniciar sesión en la integración. Seleccione "Sin caducidad" si no desea que caduque el token de actualización. Expiración por inactividad Seleccione la cantidad de tiempo después de la cual, si el usuario no ha estado activo en el sistema, caduca su token de actualización.
Por ejemplo, si la caducidad del token de actualización por inactividad es de seis meses y el usuario no inicia sesión durante seis meses, el token de actualización caduca aunque la caducidad del token de actualización absoluta se pueda establecer para más tiempo.
Logotipo de Puede añadir un logotipo para hacer que esta aplicación sea más identificable. Nombre Es el mismo nombre que le dio a la aplicación. Este campo no puede estar vacío. Descripción Introduzca una descripción para la integración. Nombre de desarrollador Es el nombre del desarrollador que configura la aplicación OAuth2. Dirección de correo electrónico del desarrollador Dirección de correo electrónico del desarrollador que configura la aplicación OAuth2. URL de directiva de privacidad Este es el vínculo a donde su organización almacena la política de privacidad. -
Haga clic en Guardar.
Configurar y utilizar la aplicación OAuth2 creada
Una configuración y un uso posteriores de la aplicación OAuth2 creada requieren algunos conocimientos técnicos, incluidas las llamadas de API.
- Para obtener instrucciones sobre la configuración y el uso de la aplicación OAuth2 con credenciales de usuario (flujo de código de autorización), consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo del código de autorización.
- Para obtener instrucciones sobre la configuración y el uso de la aplicación OAuth2 mediante la autenticación del servidor (flujo JWT), consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo JWT.
- Para obtener instrucciones sobre la configuración y el uso de la aplicación OAuth2 mediante PKCE, consulte Configure y utilice las aplicaciones OAuth 2 personalizadas de su organización mediante el flujo PKCE.
Procesos de OAuth2 para el flujo del código de autorización
Autorización con un código de autorización y un token de acceso authorizing-with-an-authorization-code-and-access-token
-
ClientApp necesita información de Workfront, por lo que envía una solicitud a Workfront API
/authorizepunto final. La solicitud incluye lo siguiente response_typecode, que indica que la solicitud debe devolver un código de autorización. -
Estos déclencheur Workfront para enviar una solicitud de autenticación al usuario. El usuario puede introducir sus credenciales en la solicitud, que proporciona lo siguiente Workfront para comunicarse con ClientApp. Si el usuario ya ha iniciado sesión en WorkfrontSin embargo, este paso se puede omitir.
-
El Workfront La API envía un código de autorización a ClientApp.
-
ClientApp envía la siguiente información en una solicitud a Workfront API
/tokenextremo:- El código de autorización enviado a ClientApp en el paso 3. Esto identifica la instancia específica del permiso de usuario.
- Secreto de cliente que se generó al configurar la aplicación ClientApp OAuth2 en Workfront. Esto permite Workfront para saber que la solicitud proviene de ClientApp.
-
Si el código de autorización y el secreto de cliente son correctos, Workfront envía un token de acceso a ClientApp. Este token de acceso se envía directamente desde Workfront a ClientApp y ningún otro usuario o aplicación cliente puede visualizarla, copiarla o utilizarla.
-
ClientApp envía el token de acceso a Workfront junto con la solicitud específica de información.
-
Como el token de acceso es correcto, Workfront envía la información a ClientApp.
Actualización de tokens de acceso
Por motivos de seguridad, los tokens de acceso caducan después de un corto período de tiempo. Para obtener nuevos tokens de acceso sin tener que escribir credenciales cada vez, OAuth2 utiliza tokens de actualización. El cliente almacena los tokens de actualización.
El proceso para adquirir un token de actualización es el mismo que el procedimiento descrito en la sección Autorización con un código de autorización y un token de acceso. La solicitud del código de autorización incluye el ámbito offline_access, que indica que la solicitud debe devolver un token de solicitud junto con el código de autorización.