API Chiavi

API chiavi sono gestite a livello di organizzazione con controllo di accesso basato sul ruolo (RBAC). Ogni chiave può essere assegnata un ruolo organizzativo e ruoli facoltativi per applicazione, dando così un controllo fine-granulare su cosa ogni chiave può accedere.

Dove sono gestite le API chiavi?

Naviga a Impostazioni > Organizzazione > API Chiavi a console.capgo.app/settings/organization/api-chiavi.

La pagina visualizza due sezioni:

• Chiavi RBAC — Chiavi con ruoli assegnati (consigliato). Queste chiavi utilizzano il nuovo sistema di autorizzazione basato sui ruoli.
• Chiavi Legacy — Chiavi più vecchie che utilizzano il sistema di base semplice (read, upload, write, allSenza assegnazione di ruoli.

Come creare una nuova API chiave?

1. Clicca sul ”+” tasto alla sommità della tabella delle chiavi RBAC.

2. Compila il informazioni della chiave:

   • Nome (obbligatorio) — Un etichetta descrittiva per la chiave (ad esempio “CI/CD Deploy”, “Monitoring Read-Only”).
   • Creare una chiave sicura (facoltativo) — Se selezionato, la chiave verrà crittografata server-side. La chiave in chiaro non viene visualizzata una volta sola dopo la creazione. Non potrai recuperarlo in seguito.
   • Imposta la data di scadenza (facoltativo) — Scegli una data dopo la quale la chiave non funzionerà più. Alcune organizzazioni impongono la scadenza obbligatoria tramite politica.

3. Seleziona un Ruolo dell'organizzazione — Questo definisce i permessi di base della chiave all'interno dell'intera organizzazione. Ruoli disponibili (a seconda del proprio livello di ruolo):

   • Nessuno — Nessun accesso organizzativo; la chiave ha accesso solo agli app individuati singolarmente.
   • Membro — Accesso di lettura base all'organizzazione.
   • Amministratore — Accesso amministrativo completo all'organizzazione (eredita l'accesso a tutti gli app).

4. Se il ruolo di org selezionato non è Amministratore, puoi aggiungere accesso per app:

   • Clicca ”+ Aggiungi App” per aprire il picker delle app.
   • Seleziona una o più app, quindi assegna un ruolo a ciascuna:
     • Lettore di App — Accesso di sola lettura all'app.
     • Caricatore di App — Può caricare nuovi bundle.
     • Sviluppatore di App — Può gestire la configurazione e le distribuzioni dell'app.
     • Amministratore di App — Accesso completo all'app.

5. Clicca “Crea”.

6. Se hai selezionato “Crea chiave sicura”, si visualizzerà un modulo con la chiave in chiaro. Copiala immediatamente — non può essere recuperata dopo la chiusura del modulo.

Come gestire (modificare) una chiave API?

Cliccare il icona del chiave in qualsiasi lista RBAC. Ciò apre la pagina dettagli della chiave dove puoi:

• Modificare il nome della Aggiornare il.
• ruolo dell'organizzazione Aggiungere, eliminare o modificare.
• ruoli per applicazione Cliccare su.

“Salva modifiche” Cliccare sul quando è pronto.

Come regenerare una API chiave?

Per regenerare il valore segreto di una API chiave, cliccare sul icona di aggiornamento (Regenera) su qualsiasi chiave nella lista.

Comparirà un dialogo di conferma. Dopo aver confermato:

• Per le chiavi sicure (hashate): Viene generata e visualizzata una nuova chiave di testo puro in una finestra modale. Copiatela immediatamente.
• Per chiavi normali: Il valore della chiave viene rigenerato server-side.

Qualsiasi integrazione utilizzando il vecchio valore della chiave smetterà di funzionare immediatamente.

Come cancellare una chiave API?

Clicca sul icona della spazzatura (Elimina) su qualsiasi chiave nella lista. Conferma la cancellazione nella finestra di dialogo.

La chiave viene revocata immediatamente — qualsiasi richiesta che la utilizza fallirà.

Chiavi legacy

Se vedete chiavi nella Chiavi legacy sezione (chiavi senza assegnazioni di ruolo), queste utilizzano il sistema di autorizzazione basato sulle modalità (read, upload, write, all). Funzionano ancora, ma non beneficiano delle autorizzazioni RBAC fine-granulari.

Le chiavi legacy possono essere regenerate e eliminate dalla lista, ma non possono essere modificate per aggiungere ruoli RBAC. Consigliamo di creare nuove chiavi RBAC e eliminare le chiavi legacy quando possibile.

Se avete bisogno di gestire le chiavi legacy direttamente, potete ancora accedervi a console.capgo.app/dashboard/apikeys. Questa pagina è deprecata e verrà eliminata in una futura aggiornamento.