Přejít na obsah
Sursa Developers

Objekty

ApiKeyCreate

Pole

  • namestringpovinné

    length ≥ 1, length ≤ 64

  • rolestring

    Výchozí: "editor"

  • data_profilestring | null

    Datový profil klíče. Bez něj dostane klíč výchozí profil organizace. Datový profil se na roli admin nevztahuje. Klíč administrátora vidí všechna data organizace a profil jiný než full vrací 400 api_keys.data_profile_not_applicable.

  • expires_atstring (date-time) | null

    Čas vypršení platnosti klíče (ISO 8601, v budoucnosti). null nebo chybějící hodnota znamená, že platnost klíče nevyprší.

  • scopesarray of ApiKeyScope | null

    Rozsahy klíče. Pokud chybějí, řídí se rozsahy rolí: admin dostane read, write, admin; editor a verifier dostanou read, write; viewer dostane read. Rozsah system vydává jen administrátor instalace. Přijímají se i podrobné rozsahy resource:action (ApiKeyScope); dřívější read, write a admin se rozvinou do sad rozsahů.

  • collection_idsarray of integer | null

    Omezí klíč na tyto kolekce organizace. Karty, vyhledávání, odpovědi a události fungují jen v nich, a to navíc k omezení rolí a datovým profilem. Chybějící hodnota nebo prázdný seznam znamená bez omezení. Pokud je volající klíč sám omezen na kolekce, nový klíč může být jen v jeho kolekcích. Bez tohoto pole dostane nový klíč kolekce volajícího klíče. Prázdný seznam nebo kolekce mimo jeho seznam vrací 400 api_keys.invalid_collections.

    items ≤ 100

  • allowed_cidrsarray of string | null

    Sítě, ze kterých lze klíč používat, například 10.0.0.0/8 nebo 2001:db8::/32. Jednotlivá adresa je síť o jedné adrese. Požadavek z jiné adresy vrací 403 api_keys.ip_not_allowed. Chybějící hodnota znamená bez omezení.

    items ≤ 50

Používá