Objektumok
ApiKeyUpdate
A kulcs módosításai. A meg nem adott mezők változatlanok maradnak, a data_profile nem kötelező. Az üres scopes lista szerepkör szerinti hatóköröket jelent, az üres collection_ids és allowed_cidrs azt, hogy nincs korlátozás, a null értékű expires_at pedig azt, hogy a kulcs nem jár le. A maga is gyűjteményekre korlátozott kulcs nem szüntetheti meg és nem bővítheti a gyűjteményekre vonatkozó korlátozást (collection_ids).
Mezők
data_profilestringA kulcs új adatprofilja. Az
adminszerepkörre az adatprofil nem vonatkozik, ezért adminisztrátori kulcsnál afullértéktől eltérő profil esetén a válasz400 api_keys.data_profile_not_applicable.scopesarray of ApiKeyScopeA kulcs hatókörei. A
systemhatókör nem adható ki az API-n keresztül.collection_idsarray of integerA kulcsot ezekre a gyűjteményekre korlátozza. Az üres lista azt jelenti, hogy nincs korlátozás. A maga is gyűjteményekre korlátozott hívó kulcs csak a gyűjteményein belüli kulcsokat látja és módosítja (más kulcsokra a válasz
404 api_keys.not_found), és csak a saját gyűjteményeinek nem üres listáját állíthatja be. Üres lista vagy a listáján kívüli gyűjtemény esetén a válasz400 api_keys.invalid_collections. E mező nélkül a kulcs gyűjteményei változatlanok maradnak.items ≤ 100
allowed_cidrsarray of stringHálózatok, amelyekből a kulcs használható.
items ≤ 50
expires_atstring (date-time) | nullLejárati idő (jövőbeli időpont). A
nullazt jelenti, hogy a kulcs nem jár le.