Vai al contenuto principale

Gestione delle chiavi API

IN QUESTA PAGINA

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 Management Console. 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 Management Console. 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 Management Console.

Abilitazione delle chiavi API nel tenant

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

Properties for API keys
Property Description
Enable API keys

This switch enables or disables all the API keys in the tenant. Only the tenant admin can enable the API keys.
Change maximum token expiration

By changing the token expiration value, all new tokens will have the new expiration value. Already existing APIs will not be affected by the change, they will have the same expiration value as before.
Change maximum of API keys per user

This setting only affects new API keys. If a new API key makes the total number exceed the maximum number, creation is denied.

Procedere come indicato di seguito:

  1. Nella Management Console, 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 i due requisiti seguenti siano stati rispettati:

  • L'impostazione Abilita API chiavi viene attivata nella Management Console.
  • 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.

  3. Selezionare le chiavi API .

  4. Fare clic su Genera ora chiavi API .

  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.