Objektumok

ApiKeyCreate

Mezők

• namestringkötelező

  length ≥ 1, length ≤ 64

• rolestring

  Alapértelmezett: "editor"

• data_profilestring | null

  A kulcs adatprofilja. Ha hiányzik, a kulcs a szervezet alapértelmezett profilját kapja. Az admin szerepkörre az adatprofil nem vonatkozik. Az adminisztrátori kulcs a szervezet összes adatát látja, és a full értéktől eltérő profil esetén a válasz 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  A kulcs lejárati ideje (ISO 8601, jövőbeli időpont). A null vagy a hiányzó érték azt jelenti, hogy a kulcs nem jár le.

• scopesarray of ApiKeyScope | null

  A kulcs hatókörei. Ha hiányzik, a hatókörök a szerepkört követik: az admin a read, write, admin hatókört kapja; az editor és a verifier a read, write hatókört; a viewer a read hatókört. A system hatókört csak a telepítés adminisztrátora adhatja ki. A részletes resource:action hatókörök (ApiKeyScope) is elfogadhatók; a korábbi read, write és admin hatókörök hatókörkészletekre bomlanak ki.

• collection_idsarray of integer | null

  A kulcsot a szervezet ezen gyűjteményeire korlátozza. A kártyák, a keresés, a válaszok és az események csak ezekben működnek, a szerepkörön és az adatprofilon felül. Hiányzó érték vagy üres lista esetén nincs korlátozás. Ha a hívó kulcs maga is gyűjteményekre korlátozott, az új kulcs csak a hívó gyűjteményeiben lehet. E mező nélkül az új kulcs a hívó kulcs gyűjteményeit kapja meg. Üres lista vagy a hívó kulcs listáján kívüli gyűjtemény esetén a válasz 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Hálózatok, amelyekből a kulcs használható, például 10.0.0.0/8 vagy 2001:db8::/32. Egyetlen cím egy egycímes hálózatnak számít. Más címről érkező kérésre 403 api_keys.ip_not_allowed a válasz. Hiányzó érték esetén nincs korlátozás.

  items ≤ 50

Használja

• POST/v1/api-keysAPI-kulcs létrehozása