Creare applicazioni OAuth2 per Workfront integrazioni
Come un Adobe Workfront amministratore, puoi creare applicazioni OAuth2 per la tua istanza di Workfront, che consentono l'accesso ad altre applicazioni Workfront. Gli utenti possono quindi concedere a tali altre applicazioni l'autorizzazione ad accedere ai propri Workfront dati. In questo modo, è possibile eseguire l'integrazione con le applicazioni di propria scelta, incluse quelle interne.
Quando crei un’ OAuth2 , si generano un ID client e un Segreto client. Gli utenti possono quindi utilizzare l’ID client nelle chiamate API per l’integrazione con l’applicazione creata.
- Per istruzioni sulla configurazione e l’utilizzo dell’applicazione OAuth2 con le credenziali utente (flusso del codice di autorizzazione), consulta Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso del codice di autorizzazione.
- Per istruzioni sulla configurazione e l’utilizzo dell’applicazione OAuth2 tramite l’autenticazione del server (flusso JWT), consulta Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso JWT.
- Per istruzioni sulla configurazione e l’utilizzo dell’applicazione OAuth2 tramite PKCE, consulta Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso PKCE.
Requisiti di accesso
Per eseguire i passaggi descritti in questo articolo, è necessario disporre dei seguenti diritti di accesso:
| table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header | |
|---|---|
| Adobe Workfront piano* | Qualsiasi |
| Adobe Workfront licenza* |
Nuovo: Standard Oppure Corrente:Plan |
| Configurazioni del livello di accesso* | Devi essere un Workfront amministratore. |
*Per conoscere il piano, il tipo di licenza o l'accesso di cui si dispone, contattare Workfront amministratore.
Panoramica di OAuth2
Immagina che un’applicazione debba richiamare alcune informazioni specifiche da Workfront. Un'applicazione che richiede informazioni viene definita client. In questo esempio, il nome del client è ClientApp. ClientApp ha bisogno di accedere alle informazioni di un particolare utente e quindi deve accedere Workfront come tale utente. Se l’utente assegna a ClientApp il nome utente e la password, ClientApp potrebbe accedere a tutti i dati a cui l’utente può accedere. Si tratta di un rischio per la sicurezza, perché ClientApp richiede solo un set di informazioni piccolo e specifico.
Quando crei un’app OAuth2 per ClientApp, in pratica stai dicendo Workfront a cui ClientApp è consentito accedere Workfront, ma solo se l’utente con l’account a cui accede ClientApp concede l’autorizzazione per l’accesso.
Creare un’applicazione OAuth2
Quando crei un’applicazione OAuth2, scegli il tipo di applicazione che meglio soddisfa le esigenze della tua integrazione.
Consigliato per CLI, daemon o script in esecuzione sul server
Esempi:
-
Shell
-
Python
Consigliato per applicazioni per dispositivi mobili o applicazioni web a pagina singola
Esempi:
-
Javascript
-
Angular
-
React
-
Vue
Consigliato per applicazioni lato server che gestiscono credenziali e token sul server
Esempi:
-
Go
-
Java
-
ASP.Net
-
Node.js
-
PHP
Creare un’applicazione OAuth2 utilizzando l’autenticazione del server (flusso JWT) create-an-oauth2-application-using-server-authentication-jwt-flow
-
Fai clic su Menu principale icona
-
Nel pannello di navigazione a sinistra, fai clic su Sistema, quindi seleziona Applicazioni OAuth2.
-
Clic Creare l’integrazione delle app.
Il Nuova applicazione OAuth2 viene visualizzata la casella. -
In Nuova applicazione OAuth2 , seleziona Applicazione machine-to-machine.
-
Immetti un nome per la nuova applicazione, ad esempio "Workfront per ClientApp."
-
Fai clic su Crea.
-
Compila i campi per la nuova app.
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 layout-auto html-authored no-header ID client Questo campo viene generato automaticamente. Segreto client Questo campo viene generato automaticamente
IMPORTANTE:
Copiare il contenuto di questo campo in un altro file protetto prima di chiudere la pagina. La chiave segreta non sarà più visibile.
Se perdi questa chiave, eliminala e crea un Segreto client.
-
Fai clic su Elimina icona
-
Clic Aggiungi segreto client per generare un nuovo Segreto client.
Public Keys Le app server-to-server utilizzano chiavi pubbliche e private per l'autenticazione. Esegui una delle operazioni seguenti:
-
Clic Aggiungi una chiave pubblica e immettere la chiave pubblica dell'altra applicazione.
-
Clic Genera una coppia di chiavi pubblica/privata, quindi condividi la chiave pubblica con l’altra applicazione.
Name Questo è lo stesso nome che hai assegnato all’app. Questo campo non può essere vuoto. Descrizione Immetti una descrizione per l’integrazione. -
-
Fai clic su Salva.
Per istruzioni sulla configurazione e l’utilizzo dell’applicazione OAuth2 con le credenziali utente (flusso del codice di autorizzazione), consulta Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso JWT.
Creare un'applicazione OAuth2 utilizzando le credenziali utente (flusso del codice di autorizzazione) create-an-oauth2-application-using-user-credentials-authorization-code-flow
-
Fai clic su Menu principale icona
-
Nel pannello di navigazione a sinistra, fai clic su Sistema, quindi seleziona Applicazioni OAuth2.
-
Clic Creare l’integrazione delle app.
Il Nuova applicazione OAuth2 visualizzazioni.
-
In Nuova applicazione OAuth2 , seleziona Applicazione web.
-
Immettete un nome per la nuova applicazione OAuth2, ad esempio "Workfront per ClientApp."
-
Fai clic su Crea.
-
Compila i campi per la nuova app.
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 client Questo campo viene generato automaticamente. Segreto client Questo campo viene generato automaticamente
IMPORTANTE:
Copiare il contenuto di questo campo in un altro file protetto prima di chiudere la pagina. La chiave segreta non sarà più visibile.
Se perdi questa chiave, eliminala e crea un Segreto client.
-
Fai clic su Elimina icona
-
Clic Aggiungi segreto client per generare un nuovo Segreto client.
URL di reindirizzamento Gli utenti verranno reindirizzati a questo percorso dopo l’autenticazione con Workfront. Aggiorna rotazione token Abilita questa opzione affinché, ogni volta che viene utilizzato il token di aggiornamento, ne venga emesso uno nuovo. L’applicazione deve archiviare il nuovo token di aggiornamento dopo ogni aggiornamento. Scadenza token di aggiornamento assoluto di Seleziona il periodo di tempo per il quale desideri che esista un token di aggiornamento prima della scadenza. Quando scade, gli utenti devono accedere di nuovo all’integrazione. Seleziona "Nessuna scadenza" se non desideri che il token di aggiornamento scada. Scadenza token di aggiornamento inattività Seleziona il periodo di tempo dopo il quale, se l’utente non è stato attivo nel sistema, il token di aggiornamento scade.
Ad esempio, se la scadenza del token di aggiornamento per inattività è di 6 mesi e l’utente non effettua l’accesso per 6 mesi, il token di aggiornamento scade anche se la scadenza del token di aggiornamento assoluto può essere impostata per un periodo più lungo.
Logo Puoi aggiungere un logo per rendere questa app più identificabile. Name Questo è lo stesso nome che hai assegnato all’app. Questo campo non può essere vuoto. Descrizione Immetti una descrizione per l’integrazione. URL descrizione app Può trattarsi di un collegamento a una pagina "Chi siamo" o di una pagina con ulteriori informazioni sull’integrazione. -
-
Fai clic su Salva.
Per istruzioni sulla configurazione e l’utilizzo dell’applicazione OAuth2 con le credenziali utente (flusso del codice di autorizzazione), consulta Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso del codice di autorizzazione.
Creare un’applicazione web OAuth2 a pagina singola utilizzando PKCE create-an-oauth2-single-page-web-application-using-pkce
-
Fai clic su Menu principale icona
-
Nel pannello di navigazione a sinistra, fai clic su Sistema, quindi seleziona Applicazioni OAuth2.
-
Clic Creare l’integrazione delle app.
Il Nuova applicazione OAuth2 viene visualizzata la casella.
-
In Nuova applicazione OAuth2 , seleziona Applicazione Web a pagina singola.
-
Immetti un nome per il nuovo OAuth2 , ad esempio "Workfront per ClientApp."
-
Fai clic su Crea.
-
Compila i campi per la nuova app.
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 client Questo campo viene generato automaticamente. URL di reindirizzamento Gli utenti verranno reindirizzati a questo percorso dopo l’autenticazione con Workfront. Ruota token di aggiornamento ogni volta che viene utilizzato Abilita questa opzione affinché, ogni volta che viene utilizzato il token di aggiornamento, ne venga emesso uno nuovo. L’applicazione deve archiviare il nuovo token di aggiornamento dopo ogni aggiornamento. scadenza assoluta Seleziona il periodo di tempo per il quale desideri che esista un token di aggiornamento prima della scadenza. Quando scade, gli utenti devono accedere di nuovo all’integrazione. Seleziona "Nessuna scadenza" se non desideri che il token di aggiornamento scada. scadenza inattività Seleziona il periodo di tempo dopo il quale, se l’utente non è stato attivo nel sistema, il token di aggiornamento scade.
Ad esempio, se la scadenza del token di aggiornamento per inattività è di 6 mesi e l’utente non effettua l’accesso per 6 mesi, il token di aggiornamento scade anche se la scadenza del token di aggiornamento assoluto può essere impostata per un periodo più lungo.
Logo Puoi aggiungere un logo per rendere questa app più identificabile. Name Questo è lo stesso nome che hai assegnato all’app. Questo campo non può essere vuoto. Descrizione Immetti una descrizione per l’integrazione. Nome sviluppatore Questo è il nome dello sviluppatore che sta configurando l’applicazione OAuth2. Indirizzo e-mail sviluppatore Questo è l’indirizzo e-mail dello sviluppatore che sta configurando l’applicazione OAuth2. URL criteri di privacy Questo è il collegamento in cui l’organizzazione memorizza l’informativa sulla privacy. -
Fai clic su Salva.
Configurare e utilizzare l’applicazione OAuth2 creata
L’ulteriore configurazione e utilizzo dell’applicazione OAuth2 creata richiede alcune conoscenze tecniche, tra cui le chiamate API.
- Per istruzioni sulla configurazione e l’utilizzo dell’applicazione OAuth2 con le credenziali utente (flusso del codice di autorizzazione), consulta Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso del codice di autorizzazione.
- Per istruzioni sulla configurazione e l’utilizzo dell’applicazione OAuth2 tramite l’autenticazione del server (flusso JWT), consulta Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso JWT.
- Per istruzioni sulla configurazione e l’utilizzo dell’applicazione OAuth2 tramite PKCE, consulta Configurare e utilizzare le applicazioni OAuth 2 personalizzate della tua organizzazione utilizzando il flusso PKCE.
Processi OAuth2 per il flusso del codice di autorizzazione
Autorizzazione con codice di autorizzazione e token di accesso authorizing-with-an-authorization-code-and-access-token
-
ClientApp richiede alcune informazioni da Workfront, quindi invia una richiesta al Workfront API
/authorizeendpoint. La richiesta include response_typecode, che indica che la richiesta deve restituire un codice di autorizzazione. -
Questo trigger Workfront per inviare una richiesta di autenticazione all'utente. L’utente può immettere le proprie credenziali nel prompt, che da Workfront autorizzazione per comunicare con ClientApp. Se l’utente ha già effettuato l’accesso a Workfront, questo passaggio può essere saltato.
-
Il Workfront L’API invia un codice di autorizzazione a ClientApp.
-
ClientApp invia le seguenti informazioni in una richiesta a Workfront API
/tokenendpoint:- Il codice di autorizzazione inviato a ClientApp nel passaggio 3. Questo identifica l’istanza specifica dell’autorizzazione utente.
- Segreto client generato durante la configurazione dell'app ClientApp OAuth2 in Workfront. Ciò consente Workfront per sapere che la richiesta proviene da ClientApp.
-
Se il codice di autorizzazione e il segreto client sono corretti, Workfront invia un token di accesso a ClientApp. Questo token di accesso viene inviato direttamente da Workfront su ClientApp e non possono essere visualizzate, copiate o utilizzate da altri utenti o applicazioni client.
-
ClientApp invia il token di accesso a Workfront insieme alla richiesta specifica di informazioni.
-
Poiché il token di accesso è corretto, Workfront invia le informazioni a ClientApp.
Aggiornamento dei token di accesso
Per motivi di sicurezza, i token di accesso scadono dopo un breve periodo di tempo. Per ottenere nuovi token di accesso senza dover immettere ogni volta le credenziali, OAuth2 utilizza i token di aggiornamento. I token di aggiornamento vengono memorizzati dal client.
Il processo di acquisizione di un token di aggiornamento è lo stesso descritto nella sezione Autorizzazione con codice di autorizzazione e token di accesso. La richiesta del codice di autorizzazione include l'ambito offline_access, che indica che la richiesta deve restituire un token di richiesta insieme al codice di autorizzazione.