Nesneler

ApiKeyCreate

Alanlar

• namestringzorunlu

  length ≥ 1, length ≤ 64

• rolestring

  Varsayılan: "editor"

• data_profilestring | null

  Anahtarın veri profili. Belirtilmezse anahtar, kuruluşun varsayılan profilini alır. Veri profili admin rolüne uygulanmaz. Yönetici anahtarı kuruluşun tüm verilerini görür ve full dışındaki bir profil 400 api_keys.data_profile_not_applicable döndürür.

• expires_atstring (date-time) | null

  Anahtarın sona erme zamanı (ISO 8601, gelecekte). null ya da değer yoksa anahtarın süresi dolmaz.

• scopesarray of ApiKeyScope | null

  Anahtarın kapsamları. Belirtilmezse kapsamlar role göre belirlenir: admin için read, write, admin; editor ve verifier için read, write; viewer için read. system kapsamını yalnızca kurulum yöneticisi verir. Ayrıntılı resource:action kapsamları (ApiKeyScope) da kabul edilir; eski read, write ve admin kapsamları kapsam kümelerine genişletilir.

• collection_idsarray of integer | null

  Anahtarı kuruluşun bu koleksiyonlarıyla sınırlar. Kartlar, arama, yanıtlar ve olaylar, rol ve veri profiline ek olarak yalnızca bu koleksiyonlarda çalışır. Değerin olmaması ya da boş liste kısıtlama olmaması anlamına gelir. Çağıran anahtarın kendisi koleksiyonlarla sınırlıysa yeni anahtar yalnızca onun koleksiyonlarında olabilir. Bu alan olmadan yeni anahtar çağıran anahtarın koleksiyonlarını alır. Bu durumda boş bir liste ya da çağıran anahtarın listesi dışındaki bir koleksiyon 400 api_keys.invalid_collections döndürür.

  items ≤ 100

• allowed_cidrsarray of string | null

  Anahtarın kullanılabileceği ağlar, örneğin 10.0.0.0/8 ya da 2001:db8::/32. Tek bir adres, tek adreslik bir ağdır. Başka bir adresten gelen istek 403 api_keys.ip_not_allowed döndürür. Değer yoksa kısıtlama yoktur.

  items ≤ 50

Kullanıldığı yerler

• POST/v1/api-keysAPI anahtarı oluşturma