Objekti

ApiKeyCreate

Polja

• namestringobavezno

  length ≥ 1, length ≤ 64

• rolestring

  Zadano: "editor"

• data_profilestring | null

  Podatkovni profil ključa. Bez njega ključ dobiva zadani profil organizacije. Podatkovni profil ne primjenjuje se na ulogu admin. Administratorski ključ vidi sve podatke organizacije, a profil različit od full vraća 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Vrijeme isteka ključa (ISO 8601, u budućnosti). null ili izostanak vrijednosti znači da ključ ne istječe.

• scopesarray of ApiKeyScope | null

  Opsezi ključa. Ako ih nema, opsezi slijede ulogu: admin dobiva read, write, admin; editor i verifier dobivaju read, write; viewer dobiva read. Opseg system izdaje samo administrator instalacije. Prihvaćaju se i detaljni opsezi resource:action (ApiKeyScope); raniji read, write i admin proširuju se u skupove opsega.

• collection_idsarray of integer | null

  Ograničava ključ na ove zbirke organizacije. Kartice, pretraživanje, odgovori i događaji rade samo u njima, uz ograničenja uloge i podatkovnog profila. Izostanak vrijednosti ili prazan popis znači da ograničenja nema. Ako je ključ koji poziva i sam ograničen na zbirke, novi ključ može biti samo u njegovim zbirkama. Bez ovog polja novi ključ dobiva zbirke ključa koji poziva. Prazan popis ili zbirka izvan njegova popisa vraća 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Mreže iz kojih se ključ smije koristiti, npr. 10.0.0.0/8 ili 2001:db8::/32. Pojedinačna adresa je mreža od jedne adrese. Zahtjev s druge adrese vraća 403 api_keys.ip_not_allowed. Izostanak vrijednosti znači da ograničenja nema.

  items ≤ 50

Koristi se u

• POST/v1/api-keysStvaranje API ključa