الكائنات

ApiKeyCreate

الحقول

• namestringمطلوب

  length ≥ 1, length ≤ 64

• rolestring

  القيمة الافتراضية: "editor"

• data_profilestring | null

  ملف تعريف البيانات للمفتاح. بدونه يحصل المفتاح على ملف التعريف الافتراضي للمؤسسة. لا ينطبق ملف تعريف البيانات على الدور admin. يرى مفتاح المشرف كل بيانات المؤسسة، وأي ملف تعريف غير full يعيد 400 api_keys.data_profile_not_applicable.

• expires_atstring (date-time) | null

  وقت انتهاء صلاحية المفتاح (ISO 8601، في المستقبل). القيمة null أو غياب القيمة يعني أن صلاحية المفتاح لا تنتهي.

• scopesarray of ApiKeyScope | null

  نطاقات صلاحيات المفتاح. إن غابت، تتبع النطاقات الدور: يحصل admin على read وwrite وadmin؛ ويحصل editor وverifier على read وwrite؛ ويحصل viewer على read. لا يصدر النطاق system إلا مشرف التثبيت. تُقبل أيضًا النطاقات الدقيقة resource:action (ApiKeyScope)؛ أما النطاقات السابقة read وwrite وadmin فتتوسع إلى حزم من النطاقات.

• collection_idsarray of integer | null

  يقصر المفتاح على هذه المجموعات من المؤسسة. تعمل البطاقات والبحث والإجابات والأحداث فيها فقط، إضافة إلى قيود الدور وملف تعريف البيانات. غياب القيمة أو القائمة الفارغة يعني عدم التقييد. وإذا كان المفتاح المستدعي نفسه مقصورًا على مجموعات، فلا يمكن أن يكون المفتاح الجديد إلا في مجموعاته. وبدون هذا الحقل يحصل المفتاح الجديد على مجموعات المفتاح المستدعي. والقائمة الفارغة أو مجموعة خارج قائمته تعيد 400 api_keys.invalid_collections.

  items ≤ 100

• allowed_cidrsarray of string | null

  الشبكات التي يجوز استخدام المفتاح منها، مثل 10.0.0.0/8 أو 2001:db8::/32. العنوان المفرد شبكة من عنوان واحد. الطلب من عنوان آخر يعيد 403 api_keys.ip_not_allowed. غياب القيمة يعني عدم التقييد.

  items ≤ 50

يُستخدم في

• POST/v1/api-keysإنشاء مفتاح API