API Chiavi

API chiavi utilizzano il controllo degli accessi basato sul ruolo (RBAC). Una chiave può avere un ruolo valido per l'intera organizzazione, vincoli di app, o entrambi. Ogni vincolo di app rimane associato all'app proprietaria dell'organizzazione di appartenenza. Per il principio di minima autorità, limitare una chiave a selezionate app anziché assegnare un ruolo valido per l'intera organizzazione.

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 — Le chiavi più vecchie che utilizzano il sistema basato sulla modalità semplice (read, upload, write, all) senza assegnazioni di ruoli.

Come creare una nuova API chiave?

1. Cliccare sul ”+” tasto

2. al vertice della tabella delle chiavi RBAC. Compilare il :

   • informazioni sulla chiave Nome
   • (obbligatorio) — Un etichetta descrittiva per la chiave (ad esempio, “CI/CD Deploy” o “Monitoring Read-Only”). (facoltativo) — Quando selezionato, la chiave viene crittografata server-side. La chiave in chiaro viene visualizzata solo una volta dopo la creazione e non può essere recuperata in seguito.
   • Immettere data di scadenza (facoltativo) — Scegliere 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 — Selezionare un ruolo di organizzazione per definire i permessi di base all'interno dell'organizzazione. I ruoli disponibili dipendono dal proprio livello di ruolo:
     • Nessuno — Nessuna accesso organizzativa.
     • 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 selezionate. 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.

   Questo aggiunge il globale org.create La chiave richiede anche un'organizzazione-scopata org_admin o org_super_admin La chiave crea un legame. Nella dashboard, selezionando Admin crea il org_admin legame. Quando questa chiave crea una nuova organizzazione, Capgo assegna automaticamente la chiave come Super Admin su quella nuova organizzazione.

5. Per concedere l'accesso all'app:

   • Quando Limita questa chiave agli app selezionati è abilitato, scegli un'organizzazione sotto Organizzazioni per filtrare gli app per rivelare i suoi app. Le associazioni degli app selezionati rimangono associate alle loro organizzazioni di proprietà; questo filtro non concede l'accesso organizzativo di tipo generale.
   • Click Clicca su "Aggiungi App"Clicca su "Aggiungi App", seleziona uno o più app e assegna un ruolo a ciascuna:
     • Letture App — Accesso di sola lettura all'app.
     • Caricatore di App — Può caricare nuovi bundle.
     • Developer di App — Può caricare bundle, gestire dispositivi, attivare costruzioni native e modificare impostazioni del canale.
     • Amministratore di App — Accesso completo all'app.
     • Anteprima di 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. Click “Crea”.

7. Se hai selezionato Crea una chiave sicura, un modulo a schermo intero visualizza la chiave in testo normale. Copia immediatamente — non può essere recuperata dopo la chiusura del modulo.

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

Usa Anteprima App per 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 dispone di accesso alla vita ciclo di un canale predefinito o principale esistente.

1. Crea una chiave RBAC e abilita Limita questa chiave ai soli app selezionate.
2. Sotto Per filtrare le app, seleziona l'organizzazione, 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. Scegli Anteprima App per ogni app selezionata.
5. Crea una chiave sicura, imposta una data di scadenza quando opportuno e memorizzala nel tuo gestore dei segreti del CI.

Modalità di sola applicazione selezionata che omette un ruolo organizzativo; non rimuove l'associazione dell'organizzazione. Ogni legame rimane limitato all'applicazione selezionata e all'organizzazione proprietaria di quella applicazione. app_preview Concedi

Permessi e limiti	sull'applicazione selezionata
app_preview , e	app.read, app.read_bundles, app.upload_bundleLegame automatico app.create_channel.
context: Pagina/Area: Pagina di marketing delle soluzioni Capgo. Ruolo: Etichetta breve UI o elemento di navigazione. Visualizzato in: pagina soluzioni/pr-preview.astro. Chiave di messaggio `solutions_pr_step1_time` (Solutions Pr Step1 Time). channel_preview legame	Quando questa chiave crea un canale, Capgo dà automaticamente la chiave channel.read, channel.promote_bundle, e channel.delete per quel canale solo.

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

Capgo registra anche quale chiave di anteprima App 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 una binding 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 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'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 e non condiviso. Anteprima dell'app non dispone ancora di generali bundle.deletequindi non può eliminare un bundle arbitrario.

Attenzione

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

Vedi il Riferimento al Controllo dell'Accesso per il confine completo.

Come gestire (modificare) una chiave API?

Cliccare sul icona del chiavistello (Gestisci) su qualsiasi chiave RBAC nella lista. Ciò apre la pagina dettagli della chiave dove puoi:

• Cambiare il nome della chiave modificare il.
• ruolo dell'organizzazione abilitare o disabilitare.
• Consenti la creazione di organizzazioni icona del chiavistello quando la chiave ha un ruolo di organizzazione di amministratore.
• Aggiungi, rimuovi o modifica ruoli per app.

Clicca “Salva modifiche” quando hai finito.

Come regenerare una chiave API?

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

A 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 piane: Il valore della chiave viene rigenerato server-side.

Tutte le integrazioni che utilizzano il vecchio valore della chiave smetteranno di funzionare immediatamente.

Come eliminare una chiave API?

Clicca il icona della spazzatura (Cancella) 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 Chiavi obsolete (chiavi senza assegnamenti di ruolo), queste utilizzano il sistema di autorizzazione basato sul vecchio modo ( 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.read, upload, write, allSe hai bisogno di gestire le chiavi obsolete direttamente, puoi ancora accedervi a

Sottosezione intitolata Chiavi obsolete

Sottosezione intitolata Chiavi obsolete console.capgo.app/dashboard/apikeysQuesta pagina è stata deprecata e verrà eliminata in una futura versione.

Continua con le API Chiavi

Se stai utilizzando le __CAPGO_KEEP_0__ Chiavi API Chiavi per pianificare dashboard e API operazioni, connettile 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.