API Keys

API keys /v1 Public API के अनुरोधों को प्रमाणित करती हैं। प्रत्येक key एक service account से संबद्ध होती है और उसी account के विवरण पृष्ठ से Developer Hub में बनाई जाती है। जब किसी निजी बैकएंड इंटीग्रेशन के लिए secret को सुरक्षित रूप से संग्रहीत और रोटेट करना आपकी आवश्यकताओं को पूरा करता हो, तब scoped API key का उपयोग करें। इसके लिए किसी OAuth client या token एक्सचेंज की आवश्यकता नहीं है। यदि आपके संगठन को इसके स्थान पर अल्पकालिक OAuth access tokens की आवश्यकता है, तो Authentication देखें।

​

key की संरचना

• Identifier — ak_ से प्रारंभ होता है। इसे टिकट, लॉग और कॉन्फ़िगरेशन में संदर्भित करना सुरक्षित है; यह स्वयं कोई अधिकार प्रदान नहीं करता।
• Secret — lsk_live_ से प्रारंभ होता है। यही वह क्रेडेंशियल है जिसे आपका इंटीग्रेशन प्रस्तुत करता है। यह निर्माण या रोटेशन के समय केवल एक बार दिखाया जाता है और बाद में पुनः प्राप्त नहीं किया जा सकता। key सूची में केवल अंतिम चार वर्ण (उदाहरण के लिए lsk_live_…xQc4) दिखाए जाते हैं, ताकि आप किसी पंक्ति का मिलान कॉलर के पास मौजूद क्रेडेंशियल से कर सकें।
• Permissions — स्वामी service account की permissions का एक उपसमूह, जिसे निर्माण के समय चुना जाता है। कोई key कभी भी अपने account की अनुमति से अधिक कार्य नहीं कर सकती।
• Expiration — अनिवार्य। प्रत्येक key की एक समाप्ति तिथि होती है।

​

key बनाएँ

service account के विवरण पृष्ठ पर चार चरणों में key बनाएँ: उसे नाम दें, इस विशिष्ट key के लिए आवश्यक permissions चुनें, समाप्ति अवधि चुनें — 30, 90 या 365 दिन, अथवा अधिकतम एक वर्ष तक की कस्टम अवधि — और समीक्षा करें। पूर्ण होने पर secret केवल एक बार प्रदर्शित किया जाता है। प्रत्येक key को उसके कॉलर के लिए आवश्यक न्यूनतम permission सेट तक सीमित रखें, भले ही account अधिक की अनुमति देता हो। यदि कोई key लीक हो जाती है, तो उसकी permissions ही प्रभाव का दायरा होती हैं।

​

बिना डाउनटाइम के रोटेट करें

रोटेशन एक नया secret जारी करता है और एक ओवरलैप विंडो — 1 घंटा, 24 घंटे या 7 दिन — प्रारंभ करता है, जिसके दौरान पुराना secret काम करता रहता है। इससे आप नए secret को अपनी सुविधा के अनुसार अपनी डिप्लॉयमेंट में लागू कर सकते हैं: समाप्ति से पहले भी रोटेट करें: अपनी समाप्ति तिथि के निकट पहुँच रही keys को key सूची में expiring के रूप में चिह्नित किया जाता है। समाप्त हो चुकी key प्रमाणित करना बंद कर देती है — उससे किए गए अनुरोध कोड credential_expired के साथ 401 लौटाते हैं।

​

तुरंत रद्द करें

रद्दीकरण तुरंत प्रभावी होता है और स्थायी है — इसमें कोई ओवरलैप विंडो नहीं होती और इसे पूर्ववत नहीं किया जा सकता। जैसे ही आपको संदेह हो कि किसी key का secret उजागर हो गया है, उसे रद्द कर दें; जब आप किसी सुरक्षित क्रेडेंशियल को बदल रहे हों, तब इसके स्थान पर रोटेट करें। रद्द की गई key से किए गए अनुरोध कोड credential_revoked के साथ 401 लौटाते हैं। यदि आपको किसी इंटीग्रेशन की सभी keys को एक साथ रोकना हो, तो इसके बजाय उसके service account को अक्षम करें।