Objecten
ApiKeyUpdate
Wijzigingen aan de sleutel. Velden die niet worden meegegeven, blijven ongewijzigd, en data_profile is optioneel. Een lege lijst scopes betekent scopes volgens de rol, lege collection_ids en allowed_cidrs betekenen geen beperking, en expires_at op null betekent dat de sleutel niet verloopt. Een sleutel die zelf tot collecties is beperkt, kan een beperking tot collecties (collection_ids) niet verwijderen of verruimen.
Velden
data_profilestringNieuw dataprofiel van de sleutel. Een dataprofiel geldt niet voor de rol
admin, dus een ander profiel danfullgeeft bij een sleutel met die rol400 api_keys.data_profile_not_applicable.scopesarray of ApiKeyScopeScopes van de sleutel. De scope
systemwordt niet via de API uitgegeven.collection_idsarray of integerBeperkt de sleutel tot deze collecties. Een lege lijst betekent geen beperking. Een aanroepende sleutel die zelf tot collecties is beperkt, ziet en wijzigt alleen sleutels in zijn collecties (andere sleutels geven
404 api_keys.not_found) en kan alleen een niet-lege lijst van zijn eigen collecties instellen. Een lege lijst of een collectie buiten zijn lijst geeft400 api_keys.invalid_collections. Zonder dit veld blijven de collecties van de sleutel ongewijzigd.items ≤ 100
allowed_cidrsarray of stringNetwerken van waaruit de sleutel mag worden gebruikt.
items ≤ 50
expires_atstring (date-time) | nullVerlooptijdstip (in de toekomst).
nullbetekent dat de sleutel niet verloopt.