Oggetti

ApiKeyCreate

Campi

• namestringobbligatorio

  length ≥ 1, length ≤ 64

• rolestring

  Predefinito: "editor"

• data_profilestring | null

  Profilo dati della chiave. Senza di esso, la chiave riceve il profilo predefinito dell’organizzazione. Un profilo dati non si applica al ruolo admin. Una chiave di amministratore vede tutti i dati dell’organizzazione e un profilo diverso da full restituisce 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Momento di scadenza della chiave (ISO 8601, nel futuro). null o nessun valore indica che la chiave non scade.

• scopesarray of ApiKeyScope | null

  Ambiti della chiave. Se assenti, gli ambiti seguono il ruolo: admin riceve read, write, admin; editor e verifier ricevono read, write; viewer riceve read. L’ambito system viene concesso solo dall’amministratore dell’installazione. Sono accettati anche ambiti granulari resource:action (ApiKeyScope); i precedenti read, write e admin si espandono in insiemi di ambiti.

• collection_idsarray of integer | null

  Limita la chiave a queste raccolte dell’organizzazione. Schede, ricerca, risposte ed eventi funzionano solo al loro interno, oltre al ruolo e al profilo dati. Nessun valore o un elenco vuoto indica nessuna limitazione. Se la chiave che effettua la chiamata è a sua volta limitata a determinate raccolte, la nuova chiave può stare solo nelle sue raccolte. Senza questo campo, la nuova chiave riceve le raccolte della chiave che effettua la chiamata. Un elenco vuoto o una raccolta fuori dal suo elenco restituiscono 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Reti da cui la chiave può essere usata, come 10.0.0.0/8 o 2001:db8::/32. Un singolo indirizzo è una rete di un solo indirizzo. Una richiesta da un altro indirizzo restituisce 403 api_keys.ip_not_allowed. Nessun valore indica nessuna limitazione.

  items ≤ 50

Usato da

• POST/v1/api-keysCreare una chiave API