Objek

ApiKeyCreate

Field

• namestringwajib

  length ≥ 1, length ≤ 64

• rolestring

  Default: "editor"

• data_profilestring | null

  Profil data kunci. Tanpa field ini, kunci mendapatkan profil default organisasi. Profil data tidak berlaku untuk peran admin. Kunci administrator melihat semua data organisasi, dan profil selain full mengembalikan 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  Waktu kedaluwarsa kunci (ISO 8601, di masa depan). null atau tanpa nilai berarti kunci tidak kedaluwarsa.

• scopesarray of ApiKeyScope | null

  Cakupan kunci. Jika tidak ada, cakupan mengikuti peran: admin mendapat read, write, admin; editor dan verifier mendapat read, write; viewer mendapat read. Cakupan system hanya diterbitkan oleh administrator instalasi. Cakupan terperinci resource:action (ApiKeyScope) juga diterima; cakupan lama read, write, dan admin diperluas menjadi set cakupan.

• collection_idsarray of integer | null

  Membatasi kunci pada koleksi organisasi ini. Kartu, pencarian, jawaban, dan peristiwa hanya berfungsi di koleksi tersebut, sebagai tambahan atas peran dan profil data. Tanpa nilai atau daftar kosong berarti tanpa pembatasan. Jika kunci pemanggil sendiri dibatasi pada koleksi, kunci baru hanya dapat berada di koleksinya. Tanpa field ini, kunci baru mendapatkan koleksi kunci pemanggil. Daftar kosong atau koleksi di luar daftarnya mengembalikan 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  Jaringan tempat kunci boleh dipakai, misalnya 10.0.0.0/8 atau 2001:db8::/32. Satu alamat adalah jaringan dengan satu alamat. Permintaan dari alamat lain mengembalikan 403 api_keys.ip_not_allowed. Tanpa nilai berarti tanpa pembatasan.

  items ≤ 50

Digunakan oleh

• POST/v1/api-keysBuat kunci API