Le attività in Apigee Integration potrebbero richiedere la connessione a un'applicazione esterna, un servizio o un'origine dati. Un profilo di autenticazione ti consente di configurare e archiviare dettagli di autenticazione per la connessione in Apigee Integration. Puoi configurare l'attività in modo che utilizzi le risorse archiviate del profilo di autenticazione. La creazione di un profilo di autenticazione è un'attività una tantum e puoi riutilizzare lo stesso profilo in più integrazioni.
Crea ID client OAuth 2.0
L'ID client viene utilizzato per identificare una singola applicazione nei server OAuth di Google. Se la tua applicazione viene eseguita su più piattaforme, ognuna avrà bisogno del proprio ID client. Per utilizzare OAuth 2.0 nella tua applicazione, è necessario un ID client OAuth 2.0, che l'applicazione utilizza per richiedere un token di accesso OAuth 2.0.
Per creare un ID client OAuth 2.0, segui questi passaggi:
- Nella console Google Cloud, vai ad API e Servizi > Credenziali.
- Fai clic su + Crea credenziali e seleziona ID client OAuth dall'elenco di opzioni disponibili.
Viene visualizzata la pagina Crea ID client OAuth.
- Tipo di applicazione:seleziona Applicazione web dall'elenco a discesa.
- Nome:inserisci un nome per il client OAuth 2.0 per identificare il client nella console Cloud.
- In URI di reindirizzamento autorizzati, fai clic su +Aggiungi URI e inserisci quanto segue:
https://apigee.google.com/organizations/GOOGLE_CLOUD_PROJECT_NAME/integrations/callback/locations/AUTH_PROFILE_REGION
- Fai clic su Crea.
È stato creato un ID client OAuth 2.0.
Crea un nuovo profilo di autenticazione
Per creare un nuovo profilo di autenticazione, seleziona una delle seguenti opzioni:
Console
- Nell'UI di Apigee, seleziona la tua organizzazione Apigee.
- Fai clic su Sviluppo > Integrazioni.
- Seleziona un'integrazione esistente per la quale vuoi creare il profilo di autenticazione.
L'integrazione viene aperta nell'editor dell'integrazione.
- Nella barra degli strumenti dell'editor di integrazione, fai clic su
Viene visualizzata la pagina Profili di autenticazione.
(Gestisci i profili di autenticazione).
- Fai clic su Crea e inserisci i seguenti dettagli:
- Nel campo Nome profilo, inserisci il nome del profilo di autenticazione da visualizzare nell'editor delle integrazioni.
- Dall'elenco Regione, seleziona una regione per il profilo di autenticazione.
- Nel campo Descrizione, inserisci una descrizione per il profilo di autenticazione.
- Fai clic su Continua.
- Nell'elenco Tipo di autenticazione, seleziona il tipo di autenticazione e inserisci i dettagli richiesti. In base alla selezione, la finestra di dialogo mostra altri campi obbligatori per credenziali di autenticazione. Puoi selezionare uno dei seguenti tipi di autenticazione:
- Facoltativamente, puoi aggiungere certificati client SSL/TLS utilizzati dal server per convalidare l'identità di un client. Puoi inserire il seguente campo:
- Certificato SSL
- Chiave privata
- Passphrase della chiave privata
- Fai clic su Crea.
Terraform
Usa google_integrations_client
risorsa.
Puoi utilizzare Terraform per creare i seguenti profili di autenticazione:
- Token di autorizzazione
- Solo certificazione client SSL/TLS
- JWT (JSON Web Token)
- Codice di autorizzazione OAuth 2.0
- Credenziali client OAuth 2.0
- Token ID OIDC
- Account di servizio
Token di autorizzazione
Nell'esempio seguente viene creato un tipo di autenticazione token di autenticazione nella regione us-central1
:
Certificazione client SSL/TLS
Nell'esempio seguente viene creato un tipo di autenticazione per la certificazione client SSL/TLS nella regione us-central1
:
JWT (JSON Web Token)
Nell'esempio seguente viene creato un tipo di autenticazione JWT (JSON Web Token) nella regione us-central1
:
Codice di autorizzazione OAuth 2.0
Nell'esempio seguente viene creato un tipo di autenticazione per la certificazione client SSL/TLS nella regione us-central1
:
Credenziali client OAuth 2.0
Nell'esempio seguente viene creato un tipo di autenticazione delle credenziali client OAuth 2.0 nella regione us-central1
:
Token ID OIDC Google
L'esempio seguente crea un tipo di autenticazione token ID OIDC Google nella regione us-central1
:
resource "random_id" "default" { byte_length = 8 } resource "google_service_account" "service_account" { account_id = "sa-${random_id.default.hex}" display_name = "Service Account" } resource "google_integrations_auth_config" "auth_config_oidc_token" { location = "us-central1" display_name = "tf-oidc-token" description = "Test auth config created via terraform" decrypted_credential { credential_type = "OIDC_TOKEN" oidc_token { service_account_email = google_service_account.service_account.email audience = "https://us-central1-project.cloudfunctions.net/functionA 1234987819200.apps.googleusercontent.com" } } depends_on = [google_service_account.service_account, google_integrations_client.client] }
Account di servizio
Nell'esempio seguente viene creato un tipo di autenticazione dell'account di servizio nella regione us-central1
:
resource "random_id" "default" { byte_length = 8 } resource "google_service_account" "service_account" { account_id = "sa-${random_id.default.hex}" display_name = "Service Account" } resource "google_integrations_auth_config" "auth_config_service_account" { location = "us-central1" display_name = "tf-service-account" description = "Test auth config created via terraform" decrypted_credential { credential_type = "SERVICE_ACCOUNT" service_account_credentials { service_account = google_service_account.service_account.email scope = "https://www.googleapis.com/auth/cloud-platform https://www.googleapis.com/auth/adexchange.buyer https://www.googleapis.com/auth/admob.readonly" } } depends_on = [google_service_account.service_account, google_integrations_client.client] }
Dopo il salvataggio, il nuovo profilo di autenticazione sarà disponibile come nel menu a discesa Authorization profile to use di qualsiasi attività che richieda l'autenticazione.
(Facoltativo) Se non hai creato un profilo di autenticazione prima di configurare un'attività di integrazione, puoi accedere la finestra di dialogo di creazione del profilo selezionando + Aggiungi nuovo profilo di autenticazione dal Menu a discesa Profilo di autorizzazione da utilizzare nel riquadro di configurazione dell'attività. Segui le passaggi precedenti per creare un nuovo profilo di autenticazione.
Modifica profili di autenticazione
Per modificare un profilo di autenticazione, segui questi passaggi:
- Nell'UI di Apigee, seleziona la tua organizzazione Apigee.
- Fai clic su Sviluppo > Integrazioni.
- Seleziona un'integrazione esistente per la quale vuoi creare il profilo di autenticazione.
L'integrazione viene aperta nell'editor dell'integrazione.
- Nella barra degli strumenti dell'editor di integrazione, fai clic su
Viene visualizzata la pagina Profili di autenticazione.
(Gestisci i profili di autenticazione).
- Seleziona una regione per il profilo di autenticazione utilizzando il menu a discesa nella pagina Profili di autenticazione.
- Fai clic su
Viene visualizzata la finestra di dialogo Profili di autenticazione.
(menu Azioni) e poi su Modifica.
- Modifica i dettagli e fai clic su Salva.
Elimina profili di autenticazione
Per eliminare un profilo di autenticazione, segui questi passaggi:
- Nell'UI di Apigee, seleziona la tua organizzazione Apigee.
- Fai clic su Sviluppo > Integrazioni.
- Seleziona un'integrazione esistente per la quale vuoi creare il profilo di autenticazione.
L'integrazione viene aperta nell'editor dell'integrazione.
- Nella barra degli strumenti dell'editor di integrazione, fai clic su
Viene visualizzata la pagina Profili di autenticazione.
(Gestisci i profili di autenticazione).
- Seleziona una regione per il profilo di autenticazione utilizzando il menu a discesa nella pagina Profili di autenticazione.
- Fai clic su Elimina.
Tipi di autenticazione
Il tipo di autenticazione necessario per completare un'attività di integrazione dipende dall'autenticazione configurata nel server di autorizzazione. Il server di autorizzazione può essere un server autonomo o un'API che invia le credenziali al server chiamata al cliente. Apigee Integration supporta i seguenti tipi di autenticazione:
- Token di autorizzazione
- Token ID OIDC Google
- JWT (JSON Web Token)
- Codice di autorizzazione OAuth 2.0
- Credenziali client OAuth 2.0
- Credenziali della password del proprietario della risorsa OAuth 2.0
- Solo certificazione client SSL/TLS
- Account di servizio
Le seguenti sezioni descrivono le proprietà di configurazione dei tipi di autenticazione.
Token di autenticazione
Il tipo di autenticazione Token di autenticazione utilizza un token (credenziali) per l'autenticazione. Le credenziali vengono inviate al server nell'intestazione della richiesta HTTPAuthorization
nella sezione
Authorization: TYPE CREDENTIALS
. Per configurare
di autenticazione, imposta le proprietà seguenti:
- Tipo: tipo di autenticazione, come
Basic
,Bearer
, oMAC
. - Token: credenziali per il tipo di autenticazione.
Se il server di autenticazione richiede un certificato SSL/TLS, carica il certificato e chiave privata.
Per scoprire quali attività supportano questo tipo di autenticazione, vedi Compatibilità dei tipi di autenticazione con le attività.Token ID OIDC Google
Il tipo di autenticazione Token ID OIDC Google utilizza token web JSON (JWT) per l'autenticazione. Il provider OIDC (Google OpenID Connect), accounts.google.com, firma questi JWT per l'autenticazione mediante un account di servizio e lo emette. Per configurare questo tipo di autenticazione, imposta le seguenti proprietà:- Account di servizio: account di servizio (entità) nel progetto Google Cloud che dispone dell'autorizzazione ad accedere all'API.
- Pubblico: il pubblico del token OIDC (identifica i destinatari a cui è destinato il JWT). Ad esempio, URL trigger è il segmento di pubblico per l'attività Cloud Functions.
JSON Web Token (JWT)
Il tipo di autenticazione JWT utilizza il token web JSON (JWT) per l'autenticazione. Per ulteriori informazioni JWT, consulta RFC7519. Per configurare di autenticazione, imposta le proprietà seguenti:- Intestazione JWT: algoritmo utilizzato per generare la firma.
Nota: puoi specificare solo l'algoritmo HS256.
- Payload JWT: una serie di rivendicazioni. Puoi utilizzare rivendicazioni registrate, pubbliche o personalizzate.
- Secret: chiave condivisa tra il client e il server di autenticazione.
Se il server di autenticazione richiede un certificato SSL, carica il certificato e privata chiave con il selettore file. Inserisci la passphrase della chiave privata .
Per scoprire quali attività supportano questo tipo di autenticazione, vedi Compatibilità dei tipi di autenticazione con le attività.Codice di autorizzazione OAuth 2.0
Il tipo di autenticazione Codice di autorizzazione OAuth 2.0 utilizza un OAuth 2.0
di autorizzazione per l'autenticazione. Per configurare
di autenticazione, imposta le proprietà seguenti:
- Endpoint di autenticazione: endpoint dell'endpoint di autenticazione dell'applicazione. Tu verrà reindirizzato a questo URL per esaminare le autorizzazioni di accesso per l'applicazione. Il token possono essere generati solo dopo aver concesso l'accesso.
- Endpoint del token: endpoint che concede o aggiorna il token di accesso.
- Client ID: una stringa univoca fornita dal server di autenticazione al client registrato. Il Client ID non è un secret ed è esposto al proprietario della risorsa. Utilizza questo campo insieme a un client secret.
- Secret: chiave segreta condivisa tra il client (integrazione) e il server di autenticazione,
- Ambiti: l'ambito del token di accesso. Gli ambiti consentono di specificare le autorizzazioni di accesso per gli utenti. Puoi specificare più ambiti separati da un singolo spazio (" "). Per ulteriori informazioni, vedi Ambiti OAuth 2.0 per le API di Google.
Se il server di autenticazione richiede un certificato SSL, carica il certificato e chiave privata con il selettore file. Inserisci la passphrase della chiave privata nel campo disponibile, se necessario.
Per scoprire quali attività supportano questo tipo di autenticazione, vedi Compatibilità dei tipi di autenticazione con le attività.Credenziali client OAuth 2.0
Il tipo di autenticazione Credenziali client OAuth 2.0 utilizza un OAuth 2.0
di autorizzazione per l'autenticazione. Questa autenticazione richiede prima un token di accesso utilizzando
le credenziali del client e usa il token per accedere alle risorse protette. Per configurare
di autenticazione, imposta le proprietà seguenti:
- Endpoint del token: endpoint che concede o aggiorna il token di accesso.
- Client ID: una stringa univoca fornita dal server di autenticazione al client registrato. Il Client ID non è un secret ed è esposto al proprietario della risorsa. Utilizza le funzionalità di questo campo insieme a un client secret.
- Secret: chiave segreta condivisa tra il client (integrazione) e il server di autenticazione,
- Ambiti: l'ambito del token di accesso. Gli ambiti consentono di specificare le autorizzazioni di accesso per gli utenti. Puoi specificare più ambiti separati da un singolo spazio (" "). Per ulteriori informazioni, vedi Ambiti OAuth 2.0 per le API di Google.
- Tipi di richiesta: meccanismi per inviare i parametri di richiesta al
server di autenticazione per il recupero del token di accesso. Puoi specificare uno dei seguenti
tipi di richiesta:
- Intestazione codificatore: codifica i campi
CLIENT ID
eCLIENT SECRET
in formatoBase64
e invia la stringa codificata nel Intestazione di autorizzazione HTTP. I restanti parametri vengono inviati nel corpo della richiesta HTTP. - Parametri di query: invia i parametri della richiesta in una stringa di query.
- Corpo della richiesta: invia i parametri della richiesta utilizzando
application/x-www-form-urlencoded
tipo di contenuti eUTF-8
nel valoreentity-body
della richiesta HTTP. - Non specificato
- Intestazione codificatore: codifica i campi
- Parametri token: parametri di richiesta necessari per ottenere il token. Specifica
i valori nel formato chiave-valore in cui
Key
è il nome del parametro eValue
è il valore parametro corrispondente.
Se il server di autenticazione richiede un certificato SSL, carica il certificato e privata chiave con il selettore file. Inserisci la passphrase della chiave privata nel campo disponibile, se richiesto.
Per scoprire quali attività supportano questo tipo di autenticazione, vedi Compatibilità dei tipi di autenticazione con le attività.Credenziali della password del proprietario delle risorse OAuth 2.0
Il tipo di autenticazione Credenziali della password del proprietario della risorsa OAuth 2.0 utilizza un OAuth 2.0
di autorizzazione per l'autenticazione. Questa autenticazione richiede prima un token di accesso utilizzando
le credenziali del proprietario della risorsa (nome utente e password), quindi utilizza il token per accedere alle risorse protette. Per configurare
di autenticazione, imposta le proprietà seguenti in base al tipo di istanza a cui ti connetti:
- Endpoint del token: endpoint che concede o aggiorna il token di accesso.
- Client ID: una stringa univoca fornita dal server di autenticazione al client registrato. Il Client ID non è un secret ed è esposto al proprietario della risorsa. Utilizza le funzionalità di questo campo insieme a un client secret.
- Secret: chiave segreta condivisa tra il client (integrazione) e il server di autenticazione,
- Ambiti: l'ambito del token di accesso. Gli ambiti consentono di specificare le autorizzazioni di accesso per gli utenti. Puoi specificare più ambiti separati da un singolo spazio (" "). Per ulteriori informazioni, vedi Ambiti OAuth 2.0 per le API di Google.
- Nome utente: nome utente del proprietario della risorsa.
- Password: password utente.
- Tipi di richiesta: meccanismi per inviare i parametri di richiesta al
server di autenticazione per il recupero del token di accesso. Puoi specificare uno dei seguenti
tipi di richiesta:
- Intestazione codificatore: codifica i campi
CLIENT ID
eCLIENT SECRET
in formatoBase64
e invia la stringa codificata nel Intestazione di autorizzazione HTTP. Invia i parametri rimanenti della richiesta nel corpo della richiesta HTTP. - Parametri di query: invia i parametri della richiesta in una stringa di query.
- Corpo della richiesta: invia i parametri della richiesta utilizzando
application/x-www-form-urlencoded
tipo di contenuti eUTF-8
nel valoreentity-body
della richiesta HTTP.
- Intestazione codificatore: codifica i campi
- Parametri token: parametri di richiesta necessari per ottenere il token. Specifica
i valori nel formato chiave-valore in cui
Key
è il nome del parametro eValue
è il valore parametro corrispondente.
Se il server di autenticazione richiede un certificato SSL, carica il certificato e privata chiave con il selettore file. Inserisci la passphrase della chiave privata nel campo disponibile, se richiesto.
Per scoprire quali attività supportano questo tipo di autenticazione, vedi Compatibilità dei tipi di autenticazione con le attività.Solo certificato client SSL/TLS
Il tipo di autenticazione Solo certificato client SSL/TLS utilizza solo il certificato SSL/TLS per l'autenticazione. Carica il certificato richiesto e la chiave privata. Per configurare di autenticazione, carica i seguenti file:- Certificato SSL: certificato codificato in formato PEM.
- Chiave privata: il file della chiave privata del certificato codificato in formato PEM.
Se la chiave privata richiede un
passphrase
, inserisci la passphrase della chiave privata.
Service account
Il tipo di autenticazione Account di servizio utilizza le credenziali di un Account di servizio del progetto Google Cloud per l'autenticazione. Per configurare di autenticazione, imposta le proprietà seguenti:
- Account di servizio: account di servizio (entità) nel progetto Google Cloud con autorizzazione di accesso l'API.
- Ambiti: ambito delle autorizzazioni di accesso concesse agli utenti. Puoi specificare più ambiti separate da uno spazio (" "). Per ulteriori informazioni, vedi Ambiti OAuth 2.0 per le API di Google.
Per conoscere le best practice per la creazione e la gestione degli account di servizio, consulta la documentazione sulle best practice per l'utilizzo degli account di servizio.
Se il server di autenticazione richiede un certificato SSL, carica il certificato e privata chiave con il selettore file. Inserisci la passphrase della chiave privata nel campo disponibile, se richiesto.
Per scoprire quali attività supportano questo tipo di autenticazione, vedi Compatibilità dei tipi di autenticazione con le attività.Compatibilità dei tipi di autenticazione con le attività
Nella tabella seguente sono elencati i tipi di autenticazione e le attività compatibili corrispondenti. Tu possono usare queste informazioni per decidere quale tipo di autenticazione usare per un'attività.
Tipo di autenticazione | Attività e trigger compatibili |
---|---|
Token di autorizzazione | |
Token ID OIDC Google | |
JWT (JSON Web Token) | |
Codice di autorizzazione OAuth 2.0 | |
Credenziali client OAuth 2.0 | |
Credenziali della password del proprietario della risorsa OAuth 2.0 | |
Solo certificato client SSL/TLS | |
Account di servizio |
Regola di autenticazione
Se per l'integrazione sono stati configurati sia un profilo OAuth 2.0 sia un account di servizio gestito dall'utente, per impostazione predefinita verrà utilizzato il profilo OAuth 2.0 per l'autenticazione. Se non è configurato né il profilo OAuth 2.0 né l'account di servizio gestito dall'utente, viene utilizzato l'account di servizio predefinito (service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com
). Se l'attività non utilizza l'account di servizio predefinito, l'esecuzione non riesce.