Chiavi API
Una chiave API appartiene a un solo progetto e fa ciò che i suoi scope indicano. Puoi restringerla ulteriormente a modelli e operazioni indicati, o confinarla a una organizzazione.
Chiavi pubbliche e segrete
Ci sono due tipi, distinti dal prefisso. Una chiave pubblica (pk_) si può includere in sicurezza in un browser. Da sola è in sola lettura e restituisce contenuti pubblicati, e un utente autenticato aggiunge gli scope del proprio ruolo. Una chiave segreta (sk_) è per un server, e l'API ne rifiuta una su qualsiasi richiesta che porti l'header Origin di un browser. Entrambi i tipi si creano dentro un progetto e servono solo quel progetto.
Scope
Gli scope stabiliscono il tipo di accesso di una chiave, come records:read o l'esecuzione di operazioni. Il controllo è una allow-list, quindi una chiamata il cui scope manca alla chiave viene rifiutata. Uno scope consente una chiamata e non allarga mai le righe che una query restituisce. Alcuni scope non possono essere posseduti affatto da una chiave pubblica, e chiederne uno viene rifiutato alla creazione della chiave.
Restringere a modelli e operazioni
Due selettori su una chiave stabiliscono quali risorse raggiunge: accesso ai modelli e accesso alle operazioni. Entrambi hanno come default tutto, cioè tutto ciò che gli scope della chiave coprono, quindi restringere è una scelta. Se scegli modelli specifici, i campi tipizzati di ogni altro modello scompaiono dallo schema che quella chiave vede, e le chiamate verso di essi vengono negate. Se scegli operazioni specifiche, la mutation di un'operazione non elencata è assente dallo schema della chiave, introspezione compresa.
Confinamento a una organizzazione
Una chiave può essere confinata a una organizzazione quando viene creata. Legge quell'organizzazione, tutto ciò che le sta sotto e le righe condivise nel progetto, e scrive solo le proprie. Deve indicare almeno uno scope, non può creare chiavi e viene eliminata insieme alla sua organizzazione.
Rotazione e modifiche successive
Ruotare una chiave mantiene funzionante il vecchio secret per 24 ore. Revocare termina subito ogni secret. Scope, modelli consentiti e nome si possono modificare su una chiave esistente e hanno effetto al salvataggio. Tipo di chiave, confinamento e scadenza sono fissati alla creazione.
Leggi il dettaglio
La guida alle chiavi API copre entrambi i tipi di chiave, i loro scope, come restringere la portata di una chiave e la rotazione.