Preskočiť na obsah
Sursa Developers

Objekty

ApiKeyCreate

Polia

  • namestringpovinné

    length ≥ 1, length ≤ 64

  • rolestring

    Predvolené: "editor"

  • data_profilestring | null

    Dátový profil kľúča. Bez neho kľúč dostane predvolený profil organizácie. Dátový profil sa na rolu admin nevzťahuje. Kľúč s rolou administrátora vidí všetky údaje organizácie a iný profil ako full vráti 400 api_keys.data_profile_not_applicable.

  • expires_atstring (date-time) | null

    Čas vypršania platnosti kľúča (ISO 8601, v budúcnosti). null alebo chýbajúca hodnota znamená, že platnosť kľúča nevyprší.

  • scopesarray of ApiKeyScope | null

    Rozsahy kľúča. Ak chýbajú, rozsahy sa riadia rolou: admin dostane read, write, admin; editor a verifier dostanú read, write; viewer dostane read. Rozsah system vydáva len administrátor inštalácie. Prijímajú sa aj podrobné rozsahy resource:action (ApiKeyScope); staršie read, write a admin sa rozvinú na sady rozsahov.

  • collection_idsarray of integer | null

    Obmedzí kľúč na tieto kolekcie organizácie. Karty, vyhľadávanie, odpovede a udalosti fungujú len v nich, a to navyše k obmedzeniam roly a dátového profilu. Chýbajúca hodnota alebo prázdny zoznam znamená bez obmedzenia. Ak je volajúci kľúč sám obmedzený na kolekcie, nový kľúč môže byť len v jeho kolekciách. Bez tohto poľa dostane nový kľúč kolekcie volajúceho kľúča. Prázdny zoznam alebo kolekcia mimo jeho zoznamu vráti 400 api_keys.invalid_collections.

    items ≤ 100

  • allowed_cidrsarray of string | null

    Siete, z ktorých možno kľúč používať, napr. 10.0.0.0/8 alebo 2001:db8::/32. Jedna adresa je sieť s jednou adresou. Požiadavka z inej adresy vráti 403 api_keys.ip_not_allowed. Chýbajúca hodnota znamená bez obmedzenia.

    items ≤ 50

Používa