ऑब्जेक्ट
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