API Chiavi

API chiavi utilizzano il controllo degli accessi 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, limitare una chiave a selezionate app anziché assegnare un ruolo organizzativo.

Dove sono gestite le API chiavi?

Naviga a Impostazioni > Organizzazione > API Chiavi a console.capgo.app/settings/organization/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 Obsoleti — Chiavi più vecchie che utilizzano il sistema di base basato sul modo (read, upload, write, all) senza assegnazioni di ruolo.

Come creare una nuova API chiave?

1. Cliccare sul ”+” bottoni alla sommità della tabella delle chiavi RBAC.

2. Inserire le informazioni Informazioni sulla chiave:

   • Nome (obbligatorio) — Un etichetta descrittiva per la chiave (ad esempio, “CI/CD Deploy” o “Monitoring Read-Only”).
   • Crea una chiave sicura (facoltativo) — Quando selezionato, la chiave viene crittografata sul server. La chiave in chiaro viene visualizzata solo una volta solo una volta dopo la creazione e non può essere recuperata 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 — Seleziona un ruolo dell'organizzazione per definire i permessi di base all'interno dell'organizzazione. I ruoli disponibili dipendono dal tuo livello di ruolo:
     • Nessuna — Nessuna accesso organizzativa.
     • Membro — Accesso di lettura base all'organizzazione.
     • Amministratore — Accesso amministrativo completo all'organizzazione e a tutti i suoi app.
   • Accesso solo app — Abilita Limita questa chiave agli app selezionati. Ogni app binding rimane collegato all'app di proprietà di quell'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.

   Aggiunge la possibilità globale org.create La chiave richiede anche una organizzazione org_admin o org_super_admin Aggiunge il legame globale La chiave crea anche il legame Admin org_admin binding. When this key creates a new organization, Capgo automatically assigns the key as Super Admin on that new organization.

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 applicazioni. Le associazioni delle app selezionate rimangono associate alle loro organizzazioni di appartenenza; questo filtro non concede accesso organizzativo su larga scala.
   • Clicca ”+ Aggiungi App”, seleziona una o più app, quindi assegna un ruolo a ciascuna:
     • Lettore di App — Accesso di sola lettura all'applicazione.
     • Caricatore di App — Può caricare nuovi pacchetti.
     • Sviluppatore di App — Può caricare pacchetti, gestire dispositivi, attivare costruzioni native e aggiornare impostazioni di canale.
     • Amministratore di App — Accesso completo all'applicazione.
     • Anteprima App — Visualizza il ciclo di vita CI/CD: carica un bundle e crea 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 selezionato Crea una chiave sicura, un modulo a schermo intero visualizza la chiave in chiaro. Copiala immediatamente — non può essere recuperata dopo aver chiuso il modulo.

Usa una chiave di anteprima per flussi di lavoro di anteprima

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

1. Crea una chiave RBAC e abilita Limita questa chiave solo agli app selezionate.
2. Sotto Organizzazioni per filtrare le app, seleziona l'organizzazione per rivelare le sue app; ogni app selezionata rimane associata alla sua organizzazione di proprietà.
3. Aggiungi solo l'app o le app utilizzate per le distribuzioni di anteprima.
4. Seleziona Anteprima dell'app per ogni app selezionata.
5. Creare una chiave sicura, impostare una data di scadenza quando opportuno e memorizzarla nel tuo gestore dei segreti del CI.

Questo modo seleziona-apps solo omette un ruolo organizzativo di base; non rimuove l'associazione dell'organizzazione. Ogni legame rimane limitato al suo app selezionato e a quella app di proprietà dell'organizzazione. app_preview Concedere

Permessi e limiti	sul app selezionato
app_preview , e	app.read, app.read_bundles, app.upload_bundleLegame automatico app.create_channel.
context channel_preview Pagina/area: Pagina di marketing delle soluzioni Capgo. Ruolo: Etichetta breve UI o elemento di navigazione. Visto in: pagina solutions/pr-preview.astro. Messaggio chiave `solutions_pr_step1_time` (Solutions Pr Step1 Time).	When this key creates a channel, Capgo automatically gives the key channel.read, channel.promote_bundlee channel.delete per quel canale solo.

app_preview conserva app.readcosì la chiave può enumerare i metadati del canale selezionato nell'applicazione. L'assegnazione automatica dei figli è un limite: non concede mutazioni di ciclo di vita per i canali che la chiave non ha creato. gestione un limite: non concede mutazioni di ciclo di vita per i canali che la chiave non ha creato.

Capgo registra anche quale chiave di anteprima di App ha caricato un bundle. La chiave può caricare solo il suo bundle su ogni canale di anteprima che crea e può pulire quella coppia assieme. Non riceve un'assegnazione di 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 lavoro di CI tipico, utilizza un nome di canale univoco 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'ultima riga utilizza una strada di pulizia atomica stretta: ha successo solo quando la chiave possiede il canale di anteprima e il suo bundle collegato e non condiviso. Anteprima App non ha ancora una versione generale bundle.delete, quindi non può eliminare un bundle arbitrario.

Attenzione

Utilizza un nuovo canale non pubblico. pr-<number> Non passare --default, --self-assign, opzioni di rilascio, o --delete-linked-bundle-on-upload a questo flusso di lavoro. Una Anteprima 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 anche rimuove l'accesso alla vita ciclo della chiave.

Vedi il Riferimento al Controllo dell'Accesso per l'intera fascia di confine.

Come gestire (modificare) una chiave API?

Clicca sul icona del cacciavite (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.
• Clicca sul simbolo del Consenti di creare organizzazioni quando la chiave ha il ruolo di organizzazione amministratore.
• Aggiungi, rimuovi o modifica ruoli per applicazione.

Clicca “Salva modifiche” pagina di modifica della chiave __CAPGO_KEEP_0__ con impostazioni attuali del ruolo

Sezione intitolata “Come regenerare una chiave API?”

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

Sarà visualizzato un dialogo di conferma. Dopo aver confermato:

• Per chiavi (crittografate) sicure: Una nuova chiave di testo non crittografata viene generata e visualizzata una volta in un modulo. Copiala immediatamente.
• Per chiavi non crittografate: Il valore della chiave viene rigenerato server-side.

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

Come eliminare una chiave API?

Click il 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 obsolete

Se vedi chiavi nella Sottosezione intitolata “Chiavi obsolete” sezioni (chiavi senza assegnazioni di ruolo), queste utilizzano il sistema di autorizzazione basato sulla modalità più vecchio (read, upload, write, allLe chiavi obsolete funzionano ancora, ma non beneficiano dei permessi 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/apikeys. Questa pagina è obsoleta e verrà rimossa in un aggiornamento futuro.

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 Pacchetti per i dettagli di implementazione in Pacchetti.