Saltare al contenuto

API Chiavi

API le 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, consentendo un controllo fine-grano su cosa ogni chiave può accedere.

Naviga a Impostazioni > Organizzazione > API Chiavi a console.capgo.app/impostazioni/organizzazione/api-chiavi.

La pagina mostra 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 (read, upload, write, all) senza assegnazione di ruoli.
Pagina delle chiavi API mostrante le sezioni RBAC e Legacy
  1. Cliccare sul ”+” tasto alla sommità della tabella delle chiavi RBAC

  2. Compilare il Informazioni chiave:

    • Nome (obbligatorio) — Un etichetta descrittiva per la chiave (ad esempio “Deploy CI/CD”, “Leggi solo di monitoraggio”).
    • Creare chiave sicura (facoltativo) — Se selezionato, la chiave verrà crittografata server-side. La chiave testuale viene visualizzata solamente dopo la creazione. Non sarà possibile recuperarla in seguito.
    • Impostare data di scadenza (facoltativo) — Scegliere una data dopo la quale la chiave non funzionerà più. Alcune organizzazioni impongono la scadenza obbligatoria tramite politica.
API form di creazione della chiave con nome, opzione chiave sicura e scadenza
  1. Scegliere un Ruolo dell'organizzazione — Questo definisce le autorizzazioni di base della chiave per l'intera organizzazione. Ruoli disponibili (a seconda del proprio livello di ruolo):

    • Nessuno — Nessun accesso organizzativo; la chiave ha accesso solo agli app assegnati individualmente.
    • Membro — Accesso di lettura base all'organizzazione.
    • Amministratore — Accesso amministrativo completo all'organizzazione (eredita l'accesso a tutti gli app).
  2. Se il ruolo dell'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:
      • App Lettore — Accesso di sola lettura all'app.
      • App Caricatore — Può caricare nuovi bundle.
      • App Sviluppatore — Può gestire la configurazione e le distribuzioni dell'app.
      • App Amministratore — Accesso completo all'app.
Selezione del ruolo RBAC con ruoli a livello di organizzazione e per app
  1. Clicca “Crea”.

  2. Se hai selezionato “Crea chiave sicura”, verrà visualizzato un modulo con la chiave in testo piano. Copiala immediatamente — non potrai recuperarla dopo aver chiuso il modulo.

One-time API key secret modal with copy button

Clicca sul icona di chiave inglese su qualsiasi chiave RBAC nella lista. Ciò apre la pagina dettagli della chiave dove puoi:

  • Cambia il nome della chiave Cambia il nome della chiave.
  • Aggiorna il ruolo dell'organizzazione Aggiungi, rimuovi o modifica i ruoli per applicazione.
  • Clicca “Salva modifiche”.

quando hai finito. Pagina di modifica dei ruoli attuali con la chiave __CAPGO_KEEP_0__ Come regenerare una chiave __CAPGO_KEEP_0__?

Sezione intitolata “Come regenerare una chiave API?”

Per regenerare il valore segreto di una chiave API, clicca sull'icona di aggiornamento

Per regenerare il valore segreto di una chiave API, clicca sull'icona di aggiornamento

Per regenerare il valore segreto di una chiave API, clicca sull'icona di aggiornamento Per regenerare il valore segreto di una chiave __CAPGO_KEEP_0__, clicca sull'icona di aggiornamento (Rigenera) su qualsiasi tasto della lista.

Una finestra di conferma apparirà. Dopo aver confermato:

  • Per chiavi sicure (hashate): Una nuova chiave di testo piano viene generata e visualizzata una volta in una finestra modale. Copiala immediatamente.
  • Per chiavi di testo: Il valore della chiave viene rigenerato server-side.

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

API conferma della rigenerazione della chiave

Clicca sull'icona del cestino icona del cestino (Elimina) su qualsiasi chiave nella lista. Conferma la cancellazione nella finestra di dialogo.

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

API conferma di cancellazione della chiave di dialogo

Se vedi chiavi nella sezione Chiavi obsolete di "Chiavi obsolete" (chiavi senza assegnazioni di ruolo), queste utilizzano il sistema di autorizzazione basato sul ruolo (read, upload, write, all) più vecchio. Funzionano ancora, ma non beneficiano delle autorizzazioni RBAC fine-granulari.

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

Se hai bisogno di gestire le chiavi legacy direttamente, puoi ancora accedervi a console.capgo.app/dashboard/apikeysQuesta pagina è deprecata e verrà rimossa in un aggiornamento futuro.