Vai al contenuto principale

Gestione delle chiavi API

Una chiave API è un identificatore unico per l'autenticazione di un utente, sviluppatore o programma di chiamata in un'API. Le chiavi API sono spesso utilizzate per il tracciamento e il controllo delle modalità di utilizzo dell'interfaccia, o per prevenire un abuso dell'API.

Panoramica sulle chiavi API

Per impostazione predefinita le chiavi API sono disabilitate nella Console di gestione. Per abilitare le chiavi API, passare alla sezione Impostazioni. Un amministratore tenant può revocare le chiavi API e modificare le impostazioni delle chiavi API , ma per generare o eliminare chiavi API è richiesto il ruolo di sviluppatore. Un amministratore tenant assegna il ruolo sviluppatore a un utente. Se si è un amministratore tenant, è possibile assegnare il ruolo di sviluppatore a se stessi.

La tabella con le chiavi API mostra le seguenti informazioni sulle chiavi API : nome, ID, proprietario, ultimo aggiornamento, data di creazione, data di scadenza e stato. Utilizzare il campo di ricerca per ricercare nei primi tre campi: Nome chiave, ID chiave e Proprietario.

Stati delle chiavi API 

Le chiavi API possono presentare i seguenti stati:

  • Attiva: la chiave API è in uso.
  • Scaduta: è stata raggiunta la data di scadenza.
  • Revocata: la chiave API è stata revocata e non può più essere utilizzata.

Come amministratore, è possibile esaminare le attività delle chiavi API registrate nella sezione Eventi nella Console di gestione. Se vengono rilevate attività sospette, come l'ampio uso di una determinata chiave API, è possibile revocare tale chiave API. Aprire l'elenco dettagliato facendo clic sulla freccia all'estrema destra nella tabella e copiare l'ID della chiave API . È quindi possibile ricercare l'ID nella sezione Chiavi API per trovare la chiave API da revocare.

Per revocare un'unica chiave API, fare clic sul pulsante ... all'estrema destra e selezionare Revoca. È possibile revocare soltanto le chiavi con lo stato Attivo. Per revocare più chiavi, selezionare le caselle di controllo a sinistra delle chiavi da revocare e fare clic su Revoca nell'angolo in alto a destra. La revoca è irreversibile, pertanto una chiave API revocata non può essere riattivata.

Oltre alla revoca è presente l'opzione di eliminazione. È possibile eliminare una chiave API dall'hub, ma non all'interno della Console di gestione.

Abilitazione delle chiavi API nel tenant

L'impostazione Abilita chiavi API viene attivata nella Console di gestione sulla pagina Impostazioni. Per impostazione predefinita le chiavi API sono disabilitate nella Console di gestione.

Proprietà per le chiavi API
Proprietà Descrizione
Abilita chiavi API

Questo interruttore abilita o disabilita tutte le chiavi API nel tenant. Solo l'amministratore del tenant può abilitare le chiavi API .

Modifica scadenza massima token

Modificando il valore di scadenza del token, tutti i nuovi token avranno il nuovo valore di scadenza. Le API già esistenti non verranno interessate dalla modifica e avranno lo stesso valore di scadenza precedente.

Modifica numero massimo di chiavi API per utente

Questa impostazione interessa solo le nuove chiavi API . Se una nuova chiave API fa sì che il numero totale superi quello massimo, la creazione verrà negata.

Procedere come indicato di seguito:

  1. Nella Console di gestione, passare alla pagina Impostazioni.
  2. Sotto la sezione Chiavi API, attivare il pulsante Abilita chiavi API.
  3. Se applicabile, modificare le impostazioni Modifica scadenza massima token e Modifica numero massimo di chiavi per utente.

Generazione di una chiave API dall'hub

È possibile generare chiavi API dall'hub. Prima di iniziare, assicurarsi che siano soddisfatti i tre requisiti seguenti:

  • Si sta utilizzando una licenza. Per generare una chiave API è necessaria una licenza.

  • L'impostazione Abilita API chiavi viene attivata nella Console di gestione.
  • L'amministratore tenant ha assegnato all'utente il ruolo di sviluppatore.

Procedere come indicato di seguito:

  1. Accedere al proprio tenant, ad esempio https://<tenantname>.com.

  2. Fare clic sul proprio profilo nell'angolo in alto a destra e selezionare Impostazioni profilo.

  3. Selezionare le chiavi API .

  4. Fare clic su Genera nuova chiave.

  5. Inserire una descrizione per la chiave API e selezionare la scadenza della chiave API.

  6. Fare clic su Genera.

    Viene generata una chiave API .

  7. Copiare la chiave API e conservarla in un luogo sicuro.

Dopo la creazione, sarà possibile modificare il nome della chiave API . Sarà anche possibile eliminarla.