İçeriğe geç
Sursa Developers

Nesneler

ApiKeyUpdate

Anahtarda yapılacak değişiklikler. Gönderilmeyen alanlar değişmez, data_profile isteğe bağlıdır. Boş bir scopes listesi role göre kapsamlar, boş collection_ids ve allowed_cidrs kısıtlama olmaması, null değerli expires_at ise anahtarın süresinin dolmaması anlamına gelir. Kendisi koleksiyonlarla sınırlı olan bir anahtar, koleksiyon kısıtlamasını (collection_ids) kaldıramaz ya da genişletemez.

Alanlar

  • data_profilestring

    Anahtarın yeni veri profili. Veri profili admin rolüne uygulanmaz; bu nedenle yönetici anahtarında full dışındaki bir profil 400 api_keys.data_profile_not_applicable döndürür.

  • scopesarray of ApiKeyScope

    Anahtarın kapsamları. system kapsamı API üzerinden verilmez.

  • collection_idsarray of integer

    Anahtarı bu koleksiyonlarla sınırlar. Boş liste kısıtlama olmaması anlamına gelir. Kendisi koleksiyonlarla sınırlı olan çağıran bir anahtar yalnızca kendi koleksiyonlarındaki anahtarlara erişir ve onları değiştirir (diğer anahtarlar 404 api_keys.not_found döndürür) ve yalnızca kendi koleksiyonlarından oluşan boş olmayan bir liste ayarlayabilir. Boş bir liste ya da onun listesi dışındaki bir koleksiyon 400 api_keys.invalid_collections döndürür. Bu alan olmadan anahtarın koleksiyonları değişmez.

    items ≤ 100

  • allowed_cidrsarray of string

    Anahtarın kullanılabileceği ağlar.

    items ≤ 50

  • expires_atstring (date-time) | null

    Sona erme zamanı (gelecekte). null, anahtarın süresinin dolmayacağı anlamına gelir.

Kullanıldığı yerler