Obiecte

ApiKeyCreate

Câmpuri

• namestringobligatoriu

  length ≥ 1, length ≤ 64

• rolestring

  Implicit: "editor"

• data_profilestring | null

  Profilul de date al cheii. Fără el, cheia primește profilul implicit al organizației. Profilul de date nu se aplică rolului admin. O cheie de administrator vede toate datele organizației, iar un profil diferit de full returnează 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Momentul expirării cheii (ISO 8601, în viitor). null sau lipsa valorii înseamnă că cheia nu expiră.

• scopesarray of ApiKeyScope | null

  Domeniile de acces ale cheii. Dacă lipsesc, domeniile urmează rolul: admin primește read, write, admin; editor și verifier primesc read, write; viewer primește read. Domeniul system este emis doar de administratorul instalării. Sunt acceptate și domeniile detaliate resource:action (ApiKeyScope); domeniile anterioare read, write și admin se extind în seturi de domenii.

• collection_idsarray of integer | null

  Restrânge cheia la aceste colecții ale organizației. Fișele, căutarea, răspunsurile și evenimentele funcționează doar în ele, pe lângă rol și profilul de date. Lipsa valorii sau o listă goală înseamnă fără restricție. Dacă cheia care face cererea este ea însăși restrânsă la colecții, cheia nouă poate fi doar în colecțiile ei. Fără acest câmp, cheia nouă primește colecțiile cheii care face cererea. O listă goală sau o colecție din afara listei ei returnează 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Rețelele din care poate fi folosită cheia, de exemplu 10.0.0.0/8 sau 2001:db8::/32. O singură adresă este o rețea cu o singură adresă. O cerere de la altă adresă returnează 403 api_keys.ip_not_allowed. Lipsa valorii înseamnă fără restricție.

  items ≤ 50

Folosit de

• POST/v1/api-keysCreează o cheie API