Langsung ke konten
Sursa Developers

Objek

ApiKeyUpdate

Perubahan pada kunci. Field yang tidak dikirim tetap tidak berubah, dan data_profile bersifat opsional. Daftar scopes kosong berarti cakupan menurut peran, collection_ids dan allowed_cidrs kosong berarti tanpa pembatasan, dan expires_at yang diisi null berarti kunci tidak kedaluwarsa. Kunci yang sendiri dibatasi pada koleksi tidak dapat menghapus atau memperluas pembatasan koleksi (collection_ids).

Field

  • data_profilestring

    Profil data baru untuk kunci. Profil data tidak berlaku untuk peran admin, sehingga untuk kunci administrator profil selain full mengembalikan 400 api_keys.data_profile_not_applicable.

  • scopesarray of ApiKeyScope

    Cakupan kunci. Cakupan system tidak diterbitkan melalui API.

  • collection_idsarray of integer

    Membatasi kunci pada koleksi ini. Daftar kosong berarti tanpa pembatasan. Kunci pemanggil yang sendiri dibatasi pada koleksi hanya melihat dan mengubah kunci di koleksinya (kunci lain mengembalikan 404 api_keys.not_found) dan hanya dapat menetapkan daftar tidak kosong dari koleksinya sendiri. Daftar kosong atau koleksi di luar daftarnya mengembalikan 400 api_keys.invalid_collections. Tanpa field ini, koleksi kunci tetap tidak berubah.

    items ≤ 100

  • allowed_cidrsarray of string

    Jaringan tempat kunci boleh dipakai.

    items ≤ 50

  • expires_atstring (date-time) | null

    Waktu kedaluwarsa (di masa depan). null berarti kunci tidak kedaluwarsa.

Digunakan oleh