Objekte
ApiKeyUpdate
Änderungen am Schlüssel. Nicht übergebene Felder bleiben unverändert, und data_profile ist optional. Eine leere Liste scopes bedeutet Scopes nach Rolle, leere collection_ids und allowed_cidrs bedeuten keine Beschränkung, und expires_at mit null bedeutet, dass der Schlüssel nicht abläuft. Ein Schlüssel, der selbst auf Sammlungen beschränkt ist, kann eine Beschränkung auf Sammlungen (collection_ids) weder aufheben noch erweitern.
Felder
data_profilestringNeues Datenprofil des Schlüssels. Ein Datenprofil gilt nicht für die Rolle
admin, daher ergibt ein anderes Profil alsfullbei einem Schlüssel mit dieser Rolle400 api_keys.data_profile_not_applicable.scopesarray of ApiKeyScopeScopes des Schlüssels. Der Scope
systemwird nicht über die API vergeben.collection_idsarray of integerBeschränkt den Schlüssel auf diese Sammlungen. Eine leere Liste bedeutet keine Beschränkung. Ein aufrufender Schlüssel, der selbst auf Sammlungen beschränkt ist, sieht und ändert nur Schlüssel in seinen Sammlungen (andere Schlüssel ergeben
404 api_keys.not_found) und kann nur eine nicht leere Liste seiner eigenen Sammlungen setzen. Eine leere Liste oder eine Sammlung außerhalb seiner Liste ergibt400 api_keys.invalid_collections. Ohne dieses Feld bleiben die Sammlungen des Schlüssels unverändert.items ≤ 100
allowed_cidrsarray of stringNetzwerke, aus denen der Schlüssel verwendet werden darf.
items ≤ 50
expires_atstring (date-time) | nullAblaufzeitpunkt (in der Zukunft).
nullbedeutet, dass der Schlüssel nicht abläuft.