API Chiavi

API le chiavi utilizzano il controllo di accesso basato sul ruolo (RBAC). Una chiave può avere un ruolo organizzativo, vincoli di app, o entrambi. Ogni vincolo di app rimane associato all'app proprietaria dell'organizzazione. Per privilegi minimi, limita una chiave a selezionare app anziché assegnare un ruolo organizzativo.

Dove sono gestiti i API chiavi?

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

La pagina mostra due sezioni:

• Chiavi RBAC — Chiavi con assegnati ruoli (consigliato). Queste chiavi utilizzano il nuovo sistema di autorizzazione basato sui ruoli.
• Chiavi Legacy — Chiavi più vecchie che utilizzano il sistema di base su modalità (read, upload, write, all) senza assegnazioni di ruoli.

Come creare una nuova API chiave?

1. Clicca sul pulsante ”+” al vertice della tabella delle chiavi RBAC.

2. Riempi le Informazioni chiave:

   • Nome (obbligatorio) — Un etichetta descrittiva per la chiave (ad esempio, “CI/CD Deploy” o “Monitoring Read-Only”).
   • Crea chiave sicura (facoltativo) — Quando selezionato, la chiave viene crittografata server-side. La chiave in chiaro è visualizzata solo una volta dopo la creazione e non può essere recuperato in seguito.
   • Imposta la data di scadenza (facoltativo) — Scegli una data dopo la quale la chiave smette di funzionare. Alcune organizzazioni impongono la scadenza obbligatoria attraverso la politica.

3. Scegli lo scopo della chiave:

   • Accesso organizzativo di ampia portata — Seleziona un Ruolo dell'organizzazione per definire le autorizzazioni di base all'interno dell'organizzazione. I ruoli disponibili dipendono dal tuo livello di ruolo:
     • Nessuno — Nessun accesso organizzativo di ampia portata.
     • Membro --- Accesso di lettura base all'organizzazione.
     • Amministratore --- Accesso amministrativo completo all'organizzazione e a tutte le sue app.
   • Accesso solo app --- Abilita Limita questa chiave alle app selezionateOgni app binding rimane collegata all'app di proprietà dell'organizzazione; questo modo omette solo un ruolo RBAC organizzativo.

4. Se la chiave deve creare organizzazioni attraverso il pubblico API, abilita Consenti la creazione di organizzazioni.

   Questo aggiunge la possibilità globale. org.create La chiave ha anche bisogno di un ruolo RBAC organizzativo org_admin o org_super_admin inserisci. Nella dashboard, selezionando Amministratore crea il org_admin binding. Quando questa chiave crea una nuova organizzazione, Capgo assegna automaticamente la chiave come Super Amministratore su quella nuova organizzazione.

5. Per concedere l'accesso all'applicazione:

   • Quando Limita questa chiave agli app selezionati è abilitato, scegli un'organizzazione sotto Organizzazioni per filtrare le app per rivelare le sue app. Le associazioni degli app selezionati rimangono associate alle loro organizzazioni di proprietà; questo filtro non concede l'accesso organizzativo.
   • Clicca ”+ Aggiungi App”Scegli uno o più app, quindi assegna un ruolo a ciascuna:
     • Letture App  — Accesso di sola lettura all'app.
     • Caricatore App  — Può caricare nuovi bundle.
     • Sviluppatore App  — Può caricare bundle, gestire dispositivi, attivare costruzioni native e aggiornare impostazioni del canale.
     • Amministratore App  — Accesso completo all'app.
     • Anteprima App  — Anteprima ciclo di vita CI/CD: caricare un bundle e creare un canale di anteprima. Il canale riceve diritti di ciclo di vita automatici, limitati al canale, solo per questa chiave.

6. Clicca “Crea”.

7. Se hai verificato Crea chiave di sicurezza, una finestra di dialogo visualizza la chiave in testo piano. Copia immediatamente — non può essere recuperata dopo la chiusura della finestra di dialogo.

Usa una chiave di anteprima dell'app per flussi di lavoro di anteprima

Usa Anteprima dell'app per il CI che crea un canale di anteprima temporaneo e non pubblico, carica e promuove un pacchetto, quindi elimina sia il canale che il pacchetto. Non ha accesso alla vita ciclo di un canale predefinito o principale esistente.

1. Creare una chiave RBAC e abilitare Limitare questa chiave a solo alcune app.
2. Sotto Aiutare a filtrare le app, selezionare l'organizzazione per rivelare le sue app; ogni app selezionata rimane associata all'organizzazione di appartenenza.
3. Aggiungere solo l'app o le app utilizzate per le preview deployment.
4. Scegliere Vista app per ogni app selezionata.
5. Creare una chiave sicura, impostare una data di scadenza quando appropriato e memorizzarla nel tuo gestore dei segreti CI.

Questo modalità seleziona-app solo omette un ruolo organizzativo; non è rimuovi l'associazione dell'organizzazione. Ogni app_preview legame rimane limitato all'applicazione selezionata e a quella appartenente all'organizzazione di proprietà.

Concedi	Permessi e limiti
app_preview sulla applicazione selezionata	app.read, app.read_bundles, app.upload_bundle, e app.create_channel.
Automatico channel_preview legame	Quando questa chiave crea un canale, Capgo automaticamente concede la chiave channel.read, channel.promote_bundle, e channel.delete per quel canale solo.

app_preview conserva app.readcosì la chiave può enumerare i metadati del canale nella selezionata app. L'auto-assegnazione del figlio è un limite: non concede mutazioni di ciclo di vita per i canali per cui la chiave non ha creato il canale. gestione limite: non concede mutazioni di ciclo di vita per i canali per cui la chiave non ha creato il canale.

Capgo registra anche quale chiave di anteprima ha caricato un bundle. La chiave può impostare solo il suo bundle su ogni canale di anteprima che crea e può pulire quella coppia assieme. Non riceve un'assegnazione del canale per un canale predefinito o principale esistente, un canale creato da un'altra chiave di anteprima o un bundle di un'altra chiave.

Per un tipico lavoro di CI, utilizzare un nome di canale unico per ogni richiesta di pull:

APP_ID="com.example.app"
PREVIEW_CHANNEL="pr-123"
BUNDLE_VERSION="1.2.3-pr.123"

npx @capgo/cli@latest bundle upload "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --path ./dist \
  --channel "$PREVIEW_CHANNEL" \
  --bundle "$BUNDLE_VERSION"

npx @capgo/cli@latest channel delete "$PREVIEW_CHANNEL" "$APP_ID" \
  --apikey "$CAPGO_API_KEY" \
  --delete-bundle \
  --success-if-not-found

Per un nuovo canale: bundle upload --channel crea il canale, carica il bundle e lo promuove in un flusso unico. L'ultimo comando utilizza una strada di pulizia atomica stretta: ha successo solo quando la chiave possiede il canale di anteprima e il suo bundle collegato, non condiviso. Anteprima dell'app ancora non ha funzionalità generali bundle.deletecosì non può eliminare un bundle arbitrario.

Attenzione

Usa un nuovo canale non pubblico. Non passare pr-<number> , le opzioni di rilascio, o --default, --self-assigna questo flusso di lavoro. Un --delete-linked-bundle-on-upload Anteprima dell'app chiave non può promuovere, eliminare o modificare un canale esistente predefinito/main, un altro canale di anteprima di una chiave o un altro bundle di una chiave. La revoca o la scadenza del binding dell'app rimuove anche l'accesso alla vita ciclo della chiave. Vedi il

Riferimento al Controllo dell'Accesso per i confini completi. Come gestire (modificare) una __CAPGO_KEEP_0__ chiave?

Come gestire (modificare) una API chiave?

Clicca sull'icona del chiave inglese (Gestisci) su qualsiasi chiave RBAC nella lista. Ciò apre la pagina dei dettagli della chiave dove puoi:

• Cambia il nome della chiave Aggiorna il ruolo dell'organizzazione.
• Abilita o disabilita Consenti la creazione di organizzazioni.
• quando la chiave ha un ruolo di amministratore dell'organizzazione. Aggiungi, rimuovi o modifica Modifica la chiave
• abilita o disabilita ruoli per-app.

Clicca “Salva modifiche” quando sei pronto.

Come regenerare una chiave API?

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

Comparirà un dialogo di conferma. Dopo aver confermato:

• Per chiavi sicure (hashate): Viene generata e visualizzata una volta in un modulo una nuova chiave di testo piana. Copiatela immediatamente.
• Per chiavi di testo piane: Il valore della chiave viene rigenerato server-side.

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

Come eliminare una API chiave?

Cliccare sull'icona del cestino (Elimina) su qualsiasi chiave nella lista. Confermare la cancellazione nel 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 sulla modalità (”,). Funzionano ancora ma non beneficiano delle autorizzazioni RBAC fine-granulari.read, upload, write, allLe chiavi legacy 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 legacy quando possibile.

Se avete bisogno di gestire le chiavi legacy direttamente, potete ancora accedervi a

console.__CAPGO_KEEP_0__.app/dashboard/apikeys console.capgo.app/dashboard/apikeysLegacy keys

Continua da API Chiavi

Se stai utilizzando API Chiavi per pianificare dashboard e API operazioni, connettilo con API Panoramica per i dettagli di implementazione in API Panoramica, Introduzione per i dettagli di implementazione in Introduzione, API Chiavi per i dettagli di implementazione in API Chiavi, Dispositivi per i dettagli di implementazione in dispositivi, e Bundle per i dettagli di implementazione in Bundle.