दो प्रकार की एपीआई कुंजियों के लिए अलग-अलग CMA पृष्ठ हैं।
- API कुंजियाँ - व्यक्तिगत व्यवस्थापक के व्यक्तिगत उपयोग के लिए
- सेवा कुंजियाँ - विभिन्न सेवा प्रमुखों के बीच साझा उपयोग के लिए
Cato आपको Cato प्रबंधन एप्लिकेशन (CMA) में API कुंजियाँ उत्पन्न करने देता है जो Cato API सर्वर पर API कॉल्स को प्रमाणीकरण के लिए उपयोग की जाती हैं। API क्लाइंट, कोड, स्क्रिप्ट, Terraform, SIEM एकीकरण, MCP, और अधिक के लिए API कुंजी दर्ज करें ताकि Cato सेवाओं के साथ सुरक्षित रूप से इंटरैक्ट कर सकें।
ये API कुंजियों के प्रकार हैं:
- प्रशासक एपीआई कुंजियाँ आपके प्रशासक खाते से जुड़ी व्यक्तिगत कुंजियाँ हैं, जिन्हें आप अपने एपीआई कार्यप्रवाहों के लिए उपयोग करते हैं। आप केवल अपने लिए प्रशासक एपीआई कुंजियाँ बना सकते हैं। अधिक जानकारी के लिए, नीचे देखें प्रशासक एपीआई कुंजियाँ.
- सेवा एपीआई कुंजियाँ सिस्टम प्रक्रियाएँ, स्वचालन, या तृतीय-पक्ष एकीकरण द्वारा उपयोग की जाती साझा कुंजियाँ हैं। ये कुंजियाँ व्यक्तिगत प्रशासक लॉगिन से नहीं जुड़ी होती हैं और परिचालन उपयोग मामलों के लिए सबसे उपयुक्त होती हैं। अधिक जानकारी के लिए, नीचे देखें सेवा प्रमुख एपीआई कुंजियाँ.
Cato दो स्तरों की API कॉल्स के लिए गहन समर्थन प्रदान करता है:
-
पूछताछ API - आपके खाते के लिए डेटा प्राप्त करने के लिए केवल पढ़ने वाली API कॉल्स चलाएँ
दर्शक अनुमतियां आपको केवल पूछताछ API कॉल्स चलाने की अनुमति देती हैं। यह लागू होता है चाहे अनुमतियां भूमिका से दी गई हों या निर्दिष्ट CMA पृष्ठों तक सीमित हों।
-
विन्यास API - आपके खाते में विन्यास परिवर्तन करने के लिए लिखने वाली API कॉल्स चलाएँ
संपादन अनुमतियां आपको केवल विन्यास या पूछताछ API कॉल चलाने देती हैं। यह लागू होता है चाहे अनुमतियां भूमिका से दी गई हों या निर्दिष्ट CMA पृष्ठों तक सीमित हों।
Cato API के लिए अनुरोधों को प्रमाणित करने के लिए, अपने API ग्राहक में x-api-key नामक एक HTTP शीर्षलेख शामिल करें। अपने Cato API कुंजी के लिए इस हेडर का मूल्य इस प्रारूप का उपयोग करते हुए सेट करें: x-api-key: <api-key>. उदाहरण के लिए: x-api-key: abcdef12345. यह शीर्षलेख आपके अनुरोध को प्राधिकृत करता है और आपके कुंजी से संबंधित अनुमतियों के आधार पर प्रासंगिक Cato API एंडप्वाइंट्स तक पहुंच प्रदान करता है।
एक सेवा प्रिंसिपल प्रशासक एक विशेष प्रकार का CMA प्रशासक है जो विशेष रूप से API-आधारित वर्कफ़्लो के लिए बनाया गया है। सिस्टम एकीकरण और स्वचालन प्रक्रियाओं को सुरक्षित रूप से समर्थन देने के लिए, अपने खाते के लिए सेवा प्रिंसिपल प्रशासक बनाएं। यह आपको API कुंजियाँ उत्पन्न करने की अनुमति देता है जो व्यक्तिगत लॉगिन प्रमाण पत्र से निष्क्रिय होती हैं और CMA तक पहुँचने के लिए उपयोग नहीं की जा सकतीं।
सेवा प्रिंसिपल प्रशासक प्रमाणपत्र विशेष रूप से संबंधित सेवा API कुंजी के साथ API प्रमाणीकरण के लिए उपयोग किए जाते हैं। यह सेटअप सुरक्षा को बढ़ाता है और स्वचालित संचालन के लिए कर्तव्यों के पृथक्करण को लागू करता है।
नोट: सेवा प्रधान एपीआई कुंजी को मौजूदा खातों में जोड़ने के हिस्से के रूप में ऑटोमेशन सेवा प्रधान (संपादक) नाम का एक नया CMA प्रशासक स्वचालित रूप से बनाया जाता है।
सर्विस प्रिंसिपल प्रशासक बनाने के लिए:
- नेविगेशन मेनू से, क्लिक करें खाता > व्यवस्थापक.
-
नया पर क्लिक करें।
प्रशासक बनाएं पैनल खुलता है।
- नया बनाएं, और सेवा प्रिंसिपल के रूप में बनाएं चुनें।
- प्रशासक के लिए सामान्य सेटिंग्स दर्ज करें।
-
इस प्रशासक के लिए अनुमतियों को परिभाषित करने वाले कोई विशेष साइटें और उपयोगकर्ता और भूमिका चुनें। भूमिकाओं के बारे में जानने के लिए, देखें RBAC का उपयोग करके प्रशासक भूमिकाओं का प्रबंधन.
ये अनुमतियाँ सेवा प्रिंसिपल API कुंजी पर लागू की जाएंगी।
- लागू करें पर क्लिक करें। प्रशासक व्यवस्थापक पृष्ठ में जोड़ा गया है, और सेवा प्रिंसिपल प्रशासक स्वचालित रूप से सक्रिय हो जाता है।
API कुंजियाँ और सेवा API कुंजी पृष्ठ API कुंजी उत्पन्न और रद्द करने की अनुमति देते हैं। API कुंजी के लिए नाम केवल प्रत्येक कुंजी को पहचानने के लिए उपयोग किया जाता है और प्रमाणीकरण प्रक्रिया का हिस्सा नहीं होता।
अतिरिक्त सुरक्षा के लिए, आप API और सेवा API कुंजियों के लिए स्रोत IPs या IP रेंज (CIDR) को सीमित कर सकते हैं।
नोट: सुनिश्चित करें कि आप पॉप-अप विंडो से API कुंजी मान की प्रतिलिपि बनाते हैं। एक बार जब आप पॉप-अप विंडो को बंद कर देते हैं, तो आप फिर से कुंजी मान तक पहुँच नहीं सकते।
जब आपको व्यक्तिगत प्रशासक के रूप में अपने स्वचालन वर्कफ़्लो का समर्थन करने की आवश्यकता होती है, तो अपने CMA प्रशासक प्रमाण को बंधी एक प्रशासक API कुंजी बनाएं। आप केवल अपने उपयोग के लिए प्रशासक API कुंजियाँ बना सकते हैं, अन्य प्रशासकों के लिए नहीं, और केवल CMA के माध्यम से।
जब एक प्रशासक हटाया जाता है, तो संबंधित API कुंजी स्वतः निष्क्रिय हो जाती है। यदि एक प्रशासक निष्क्रिय होता है, तो कुंजी के रूप में Disabled संकेतित होगी, और इसका उपयोग करने वाली API कॉल्स त्रुटि लौटाएंगी।
प्रशासक API कुंजियों के लिए RBAC अनुमतियाँ
- प्रत्येक प्रशासक API कुंजी उस प्रशासक की RBAC अनुमतियों और भूमिकाओं को विरासत में मिलती है जिसने इसे बनाया। अगर प्रशासक की RBAC भूमिकाएँ बदलती हैं तो अनुमति गतिशील रूप से अपडेट हो जाती है, जिसमें विशेष साइटों, उपयोगकर्ता समूहों, समूहों इत्यादि के लिए अनुमतियाँ शामिल हैं...
- दर्शक भूमिका वाले प्रशासक सभी API कुंजी जानकारी देख सकते हैं (वास्तविक कुंजी मान नहीं)
- जिसके पास API कुंजियाँ पृष्ठ शामिल होती है, उसके संपादनकर्ता RBAC भूमिका वाले प्रशासक खाते में API कुंजियाँ देख सकते हैं और उन्हें रद्द (हटाना) कर सकते हैं
प्रशासक API कुंजी उत्पन्न करने के लिए:
- नेविगेशन मेनू में, संसाधन > प्रशासक एपीआई कुंजियाँ पर क्लिक करें।
- क्लिक करें नया. API कुंजी बनाएँ पैनल खुलता है।
- एक कुंजी नाम दर्ज करें।
- इस कुंजी के लिए केवल-दृश्य अनुमतियाँ लागू करने के लिए, दृश्य पर अवनत करें चुनें।
-
(वैकल्पिक) अतिरिक्त सुरक्षा के लिए, IPs से एक्सेस की अनुमति में, विशिष्ट IP सूची चुनें, और उन IP पतों या IP रेंज को परिभाषित करें जिन्हें इस API कुंजी का उपयोग करने की अनुमति है।
डिफ़ॉल्ट सेटिंग इस API कुंजी को किसी भी IP पते के लिए अनुमति देने की है।
-
(वैकल्पिक) API कुंजी समाप्त होती है की तिथि चुनें।
संपादन अनुमतियों के साथ API कुंजियों के लिए, हम अनुशंसा करते हैं कि आप API कुंजी समाप्त होगी एक तिथि सेट करें।
- क्लिक करें लागू करें. API कुंजी पृष्ठ में जोड़ी गई है, और नई API कुंजी के मूल्य वाली पॉप-अप विंडो प्रदर्शित की जाती है।
-
API कुंजी की प्रतिलिपि बनाने के लिए बटन क्लिक करें जो CMA द्वारा उत्पन्न की गई है और इसे सुरक्षित स्थान पर सहेजें।
एक बार जब आप इस विंडो को बंद कर देते हैं, तब आप API कुंजी के मान को एक्सेस नहीं कर सकते।
- पॉप-अप विंडो को बंद करने के लिए OK पर क्लिक करें।
जब आपको साझा परिचालन या एकीकरण वर्कफ़्लो का समर्थन करने की आवश्यकता होती है, तो सेवा API कुंजियों पृष्ठ से एक सेवा API कुँजी बनाएँ। ये कुंजियाँ स्वचालन सेवाओं और स्क्रिप्ट्स द्वारा उपयोग के लिए डिज़ाइन की गई हैं जिन्हें CMA तक पहुँच की आवश्यकता नहीं होती है। वे कुंजी बनाने वाले सेवा प्रधान प्रशासक से जुड़े हुए हैं।
सेवा API कुंजियाँ प्रणाली और टीम्स के माध्यम से उपयोग की जा सकती हैं, बाहरी उपकरणों और सेवाओं के साथ विस्तारशील एकीकरण को सक्षम बनाती हैं। ये प्रकार की कुंजियाँ CMA प्रशासक से बंधी नहीं होती हैं और बैकेंड ऑपरेशनों या निरंतर डिलिवरी पाइपलाइनों के लिए अभिप्रेत होती हैं।
सेवा API कुंजियों के लिए RBAC अनुमतियाँ
- केवल प्रशासक जिन्हें संपादनकर्ता भूमिका प्राप्त होती है सेवा प्रमुख API कुंजियाँ बना या प्रबंधित कर सकते हैं
- प्रत्येक सेवा API कुंजी उस सेवा प्रिंसिपल प्रशासक की RBAC अनुमतियों और भूमिकाओं को विरासत में मिलती है जो कुंजी के साथ जुड़ा होता है। यदि प्रशासक के लिए RBAC अनुमतियाँ बदलती हैं, तो सेवा प्रमुख API कुंजी नई अनुमतियों के साथ स्वतः अपडेट होती है।
सेवा एपीआई कुंजी उत्पन्न करने के लिए:
- नेविगेशन मेनू में, संसाधन > सेवा एपीआई कुंजियाँ पर क्लिक करें।
- नया पर क्लिक करें। API कुंजी बनाएँ पैनल खुलता है।
- उस सेवा प्रधान को चुनें जो इस कुंजी के साथ जुड़ा हुआ है।
- कुंजी नाम दर्ज करें।
- इस कुंजी के लिए केवल-दृश्य अनुमतियाँ लागू करने के लिए, दृश्य पर अवनत करें चुनें।
-
(वैकल्पिक) अतिरिक्त सुरक्षा के लिए, IPs से पहुँच की अनुमति दें में विशिष्ट IP सूची चुनें, और IP पतों या IP रेंज को परिभाषित करें जो इस एपीआई कुंजी का उपयोग करने के लिए अनुमत हैं।
डिफ़ॉल्ट सेटिंग किसी भी IP पते के लिए इस एपीआई कुंजी की अनुमति देना है।
-
(वैकल्पिक) एक तारीख चुनें जिस पर एपीआई कुंजी समाप्त हो गई हो।
संपादित अनुमतियों वाली एपीआई कुंजियों के लिए, हम अनुशंसा करते हैं कि एपीआई कुंजी समाप्त हो गई की तारीख निर्धारित करें।
- लागू करें पर क्लिक करें। एपीआई कुंजी पृष्ठ पर जोड़ दी जाती है, और एक पॉप-अप विंडो प्रदर्शित होती है जो नई एपीआई कुंजी के मान को दिखाती है।
-
API कुंजी जो CMA द्वारा उत्पन्न की गई है उसे कॉपी करने के लिए बटन पर क्लिक करें और इसे सुरक्षित स्थान पर सहेजें।
एक बार जब आप इस विंडो को बंद कर देते हैं, तो आप एपीआई कुंजी के लिए मान तक पहुँच नहीं कर सकते।
- पॉप-अप विंडो बंद करने के लिए स्वीकृत करें पर क्लिक करें।
आप API कुंजी को निरस्त कर सकते हैं और इसे CMA से हटा सकते हैं। एक बार रद्द कर दिए जाने के बाद, कुंजी को API सर्वर के लिए प्रमाणित करने के लिए उपयोग नहीं किया जा सकता।
0 टिप्पणियां
कृपया टिप्पणी करने के लिए साइन इन करें करें.