Saltare al contenuto

API Chiavi

I 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, fornendo un controllo fine-granulare su cosa ogni chiave può accedere.

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

La pagina mostra due sezioni:

  • Chiavi RBAC — Le chiavi con ruoli assegnati (consigliato). Queste chiavi utilizzano il nuovo sistema di autorizzazione basato sui ruoli.
  • Chiavi Obsolette — Chiave più vecchie che utilizzano il sistema basato sulla modalità ("read, upload, write, allsenza assegnazione di ruoli.
Pagine delle chiavi di API mostrando le sezioni RBAC e Legacy
  1. Clicca il ”+” bottoncino in alto della tabella delle chiavi RBAC.

  2. Compilare il Informazioni sulla chiave:

    • Nome (obbligatorio) — Una descrizione etichetta per la chiave (ad esempio "CI/CD Deploy", "Monitoring Read-Only").
    • Crea chiave sicura (facoltativo) — Se selezionato, la chiave verrà crittografata server-side. La chiave in chiaro viene visualizzata solo una volta dopo la creazione. Non potrai recuperarla in seguito.
    • Imposta data di scadenza (facoltativo) — Scegli una data dopo la quale la chiave smetterà di funzionare. Alcune organizzazioni impongono la scadenza obbligatoria tramite politica.
form di creazione della chiave API con nome, opzione chiave sicura e scadenza
  1. Scegli un Ruolo di organizzazione — Questo definisce le autorizzazioni di base della chiave per l'intera organizzazione. I ruoli disponibili (a seconda del tuo 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 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.
Selezione del ruolo RBAC con ruoli di livello di organizzazione e per-app.
  1. Clicca “Crea”.

  2. Se hai selezionato “Crea chiave sicura”, verrà visualizzato un modulo che mostra la chiave in testo normale. Copia immediatamente — non può essere recuperata dopo la chiusura del 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 dei dettagli della chiave in cui puoi:

  • Modifica la chiave nome.
  • Aggiorna ruolo dell'organizzazione.
  • Aggiungi, rimuovi o modifica ruoli per app.

Clicca “Salva modifiche” quando hai finito.

pagina di modifica del API con impostazioni ruoli correnti

Per regenerare il valore segreto di un API key, clicca il icon di aggiornamento (Rigenera) su qualsiasi chiave della lista.

Comparirà un dialogo di conferma. Dopo aver confermato:

  • Per chiavi sicure (hashate): Si genera e si visualizza una nuova chiave di testo piana in una finestra modale. Copiala immediatamente.
  • Per chiavi piane: La chiave viene rigenerata server-side.

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

Conferma di rigenerazione della chiave API

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

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

finestra di dialogo di conferma della cancellazione della chiave API

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

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

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