الكائنات
ApiKeyUpdate
تغييرات المفتاح. الحقول غير المُمرَّرة تبقى كما هي، والحقل data_profile اختياري. القائمة الفارغة scopes تعني النطاقات حسب الدور، والقائمتان الفارغتان collection_ids وallowed_cidrs تعنيان عدم التقييد، والقيمة null في expires_at تعني أن صلاحية المفتاح لا تنتهي. والمفتاح المقصور هو نفسه على مجموعات لا يستطيع إزالة التقييد بالمجموعات أو توسيعه (collection_ids).
الحقول
data_profilestringملف تعريف البيانات الجديد للمفتاح. لا ينطبق ملف تعريف البيانات على الدور
admin، ولذلك فإن أي ملف تعريف غيرfullلمفتاح المشرف يعيد400 api_keys.data_profile_not_applicable.scopesarray of ApiKeyScopeنطاقات صلاحيات المفتاح. لا يصدر النطاق
systemعبر API.collection_idsarray of integerيقصر المفتاح على هذه المجموعات. القائمة الفارغة تعني عدم التقييد. والمفتاح المستدعي المقصور هو نفسه على مجموعات لا يرى ولا يغيّر إلا المفاتيح الموجودة في مجموعاته (المفاتيح الأخرى تعيد
404 api_keys.not_found)، ولا يستطيع أن يضبط إلا قائمة غير فارغة من مجموعاته. والقائمة الفارغة أو مجموعة خارج قائمته تعيد400 api_keys.invalid_collections. وبدون هذا الحقل تبقى مجموعات المفتاح بلا تغيير.items ≤ 100
allowed_cidrsarray of stringالشبكات التي يجوز استخدام المفتاح منها.
items ≤ 50
expires_atstring (date-time) | nullوقت انتهاء الصلاحية (في المستقبل). القيمة
nullتعني أن صلاحية المفتاح لا تنتهي.