Objekti

ApiKeyCreate

Lauki

• namestringobligāts

  length ≥ 1, length ≤ 64

• rolestring

  Noklusējums: "editor"

• data_profilestring | null

  Atslēgas datu profils. Bez šī lauka atslēga saņem organizācijas noklusējuma profilu. Datu profils neattiecas uz lomu admin. Atslēga ar administratora lomu redz visus organizācijas datus, un profils, kas nav full, atgriež 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Atslēgas derīguma termiņš (ISO 8601, nākotnē). null vai vērtības trūkums nozīmē, ka atslēgai nav derīguma termiņa.

• scopesarray of ApiKeyScope | null

  Atslēgas tvērumi. Ja tie nav norādīti, tvērumi atbilst lomai: admin saņem read, write, admin; editor un verifier saņem read, write; viewer saņem read. Tvērumu system piešķir tikai instalācijas administrators. Tiek pieņemti arī detalizēti tvērumi resource:action (ApiKeyScope); agrākie read, write un admin izvēršas tvērumu kopās.

• collection_idsarray of integer | null

  Ierobežo atslēgu ar šīm organizācijas kolekcijām. Kartītes, meklēšana, atbildes un notikumi darbojas tikai tajās, papildus lomai un datu profilam. Ja vērtības nav vai saraksts ir tukšs, ierobežojuma nav. Ja izsaucošā atslēga pati ir ierobežota ar kolekcijām, jaunā atslēga var būt tikai tās kolekcijās. Bez šī lauka jaunā atslēga saņem izsaucošās atslēgas kolekcijas. Tukšs saraksts vai kolekcija ārpus tās saraksta atgriež 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Tīkli, no kuriem atslēgu drīkst lietot, piemēram, 10.0.0.0/8 vai 2001:db8::/32. Viena adrese ir tīkls ar vienu adresi. Pieprasījums no citas adreses atgriež 403 api_keys.ip_not_allowed. Ja vērtības nav, ierobežojuma nav.

  items ≤ 50

Izmanto

• POST/v1/api-keysIzveidot API atslēgu