यह लेख Cato के SCIM API का उपयोगकर्ता और उपयोगकर्ता समूह के प्रोविजनिंग के लिए पहचान प्रदाता (IdP) के साथ कैसे उपयोग करें, इसका वर्णन करता है।
IdP किरायेदार में कस्टम SCIM ऐप्स के बारे में अधिक जानकारी के लिए, IdP के लिए एक कस्टम SCIM ऐप बनाना देखें।
अपने Cato खाते के लिए उपयोगकर्ता और उपयोगकर्ता समूहों को प्रोवाइड करने के लिए कस्टम SCIM ऐप का उपयोग करने के लिए, Cato प्रबंधन एप्लिकेशन (CMA) में ऐप बनाएं। इसके अलावा, आपको Cato SCIM विशेषताओं को अपने IdP के विशेषताओं के लिए मैप करना होगा।
SCIM API का उपयोग करने के लिए, आपको पहले CMA में एक कस्टम SCIM ऐप बनाना होगा। यह ऐप आपको अपने पहचान प्रदाता (IdP) को Cato प्लेटफ़ॉर्म के साथ एकीकृत करने की अनुमति देता है।
CMA में कस्टम SCIM ऐप बनाने के लिए:
-
नेविगेशन मेनू से Access > Directory Services चुनें।
-
SCIM टैब के अंतर्गत, New पर क्लिक करें।
- ऐप के लिए एक नाम दर्ज करें।
- Provider के अंतर्गत, Custom चुनें।
- Generate Token पर क्लिक करें और मान प्रतिलिपि करें; यह संचित करने के बाद उपलब्ध नहीं होगा और आपको एक नया टोकन बनाना होगा।
-
Save पर क्लिक करें।
-
नीचे दिए गए SCIM API एन्डपॉइंट्स को कॉल करते समय, आपको प्रमाणीकरण के लिए निम्नलिखित मानों की आवश्यकता होगी:
-
SCIM Base URL: API अनुरोधों के लिए आधार पथ के रूप में उपयोग किया जाता है
-
Bearer Token: API अनुरोधों का प्रमाणीकरण करने के लिए उपयोग किया जाता है
-
ये Cato उपयोगकर्ताओं और उपयोगकर्ता समूहों के लिए SCIM विशेषताएँ हैं जिन्हें IdP विशेषताओं के लिए मैप करने की आवश्यकता है।
|
Cato उपयोगकर्ता विशेषता |
विवरण |
|---|---|
|
userName |
प्रमाणीकरण के लिए उपयोगकर्ता नाम |
|
user.firstName |
उपयोगकर्ता का पहला नाम |
|
user.lastName |
उपयोगकर्ता का अंतिम नाम |
|
user.email |
ईमेल पता |
|
user.displayName |
उपयोगकर्ता के लिए प्रदर्शन नाम |
|
phoneNumbers[type eq "work"].value |
उपयोगकर्ता के लिए कार्य फोन नंबर (प्रिफिक्स सहित) |
|
externalId |
उपयोगकर्ता के लिए ID (घटनाओं में उपयोग की गई) |
|
Cato उपयोगकर्ता समूह विशेषता |
विवरण |
|---|---|
|
active |
उपयोगकर्ता SCIM ऐप में नियुक्त और सक्रिय है |
|
displayName |
उपयोगकर्ता समूह का नाम |
|
members |
उपयोगकर्ता जो उपयोगकर्ता समूह से संबंधित हैं |
|
externalId |
उपयोगकर्ता समूह के लिए ID (घटनाओं में उपयोग की गई) |
क्लाइंट RFC 6750 द्वारा परिभाषित बेयर टोकन प्रमाणीकरण का उपयोग करके SCIM API के लिए प्रमाणीकरण करते हैं। सभी API अनुरोधों में निम्नलिखित HTTP हेडर शामिल होना चाहिए:
Authorization: Bearer <access_token> Content-Type: application/json
आप Cato प्रबंधन एप्लिकेशन से पहुंच टोकन प्राप्त कर सकते हैं।
सभी SCIM API एंडपॉइंट्स निम्नलिखित आधार पथ का उपयोग करते हैं:
/scim/v2/{accountId}/{sourceId}
पथ पैरामीटर:
-
accountId(string): आपके Cato किरायेदार खाते की अद्वितीय पहचानकर्ता -
sourceId(integer): Cato द्वारा ऐसे विशिष्ट IdP एकीकरण का अनन्य रूप से प्रतिनिधित्व करने के लिए असाइन किया गया पहचानकर्ता
ये पैरामीटर सभी अनुरोधों में आवश्यक हैं लेकिन इस लेख के व्यक्तिगत एंडपॉइंट पथ में संक्षिप्तता के लिए छोड़े गए हैं।
यह अनुभाग Cato SCIM API का उपयोग करके SCIM उपयोगकर्ता संस्थाओं को बनाने, अपडेट करने, हटाने और पुनः प्राप्त करने का वर्णन करता है।
HTTP विधि: POST /Users
आवश्यक फ़ील्ड:
-
userName(string): अद्वितीय उपयोगकर्ता नाम (जैसे, ईमेल पता) -
externalId(string): IdP से बाहरी पहचानकर्ता -
active(boolean): उपयोगकर्ता को सक्रिय करने के लिएtrueहोना चाहिए
नोट: id SCIM सेवा द्वारा लौटाया जाता है और बाद के API कॉल में उपयोग किया जाना चाहिए। externalId वैकल्पिक है और API पथों में उपयोग नहीं किया जा सकता।
प्रतिक्रिया:
-
स्थिति:
201 Created
त्रुटियाँ:
-
400 Bad Request: अमान्य स्कीमा -
401 Unauthorized -
409 Conflict: डुप्लिकेटuserNameयाexternalId
HTTP विधि: PUT /Users/{id}
आवश्यक फ़ील्ड:
-
id: Cato से आंतरिक SCIM ID
प्रतिक्रिया:
-
स्थिति:
200 OK
त्रुटियाँ:
-
401 Unauthorized -
404 Not Found -
409 Conflict: डुप्लिकेटuserNameयाexternalId
HTTP विधि:DELETE /Users/{id}
प्रतिक्रिया:
-
स्थिति:
204 No Content
यह एक सॉफ़्ट डिलीट है। उपयोगकर्ता सिस्टम में रहता है लेकिन खोजों में लौटाया नहीं जाता।
HTTP विधि:GET /Users/{id}
प्रतिक्रिया:
-
स्थिति:
200 OK
त्रुटियाँ:
-
401 Unauthorized -
404 Not Found
HTTP विधि:GET /Users
प्रश्न पैरामीटर:
-
filter: उपयोगकर्ताओं को फ़िल्टर करने के लिए प्रश्न (जैसे,userName eq "user@domain.com") -
count(वैकल्पिक) -
startIndex(वैकल्पिक)
समर्थित फ़िल्टर:
-
केवल
eqसमर्थित है -
समर्थित विशेषताएँ:
userName,email,givenName,familyName -
सम्मिलित फ़िल्टर केवल इस प्रारूप में समर्थित हैं:
filter=emails[type eq "work"] and email eq "bob@cato.com"
प्रतिक्रिया:
-
स्थिति:
200 OK
त्रुटियाँ:
-
401 अनधिकृत
यह अनुभाग बताता है कि आपके Cato वातावरण में समूह संस्थाओं को बनाने, अद्यतन करने, हटाने और प्राप्त करने के लिए SCIM API का उपयोग कैसे करें।
HTTP विधि:POST /Groups
प्रतिक्रिया:
-
स्थिति:
201 निर्मित
त्रुटियां:
-
401 अनधिकृत -
409 संघर्ष: डुप्लिकेटdisplayNameया ऑब्जेक्ट आईडी
HTTP विधि:PUT /Groups/{id}
प्रतिक्रिया:
-
स्थिति:
200 ठीक है
त्रुटियां:
-
401 अनधिकृत -
404 नहीं मिला -
409 संघर्ष
HTTP विधि:DELETE /Groups/{id}
प्रतिक्रिया:
-
स्थिति:
204 कोई सामग्री नहीं
नोट
महत्वपूर्ण: यह एक कठोर हटाना है। समूह स्थायी रूप से हटा दिया गया है।
HTTP विधि:GET /Groups/{id}
विकल्प क्वेरी मापदंड:
-
exludeAttributes(उदा.,सदस्य)
प्रतिक्रिया:
-
स्थिति:
200 ठीक है
त्रुटियां:
-
401 अनधिकृत -
404 नहीं मिला
-
उपयोगकर्ता और समूह निर्माण अनुरोधों में
आईडीफ़ील्ड वैकल्पिक है। -
यदि छोड़ा गया है, तो SCIM सेवा एक अद्वितीय
आईडीउत्पन्न करती है। -
समी API कॉल में हमेशा लौटाई गई
आईडीमान का उपयोग करें।
नोट
महत्वपूर्ण: क्लाइंट-जनित IDs का उपयोग करने से बचें जब तक आवश्यक न हो। SCIM आईडी अधिकारिक पहचानकर्ता है।
-
उपयोगकर्ता हटाना
DELETE /Users/{id}के माध्यम से मृदु हटाना करता है,सक्रियफ़ील्ड कोगलतपर सेट करता है।GET /Users/{id}के माध्यम से उपयोगकर्ता पुनः प्राप्त किया जा सकता है लेकिनGET /Usersपरिणामों से बाहर रखा गया है। -
समूह हटाना
DELETE /Groups/{id}के माध्यम से कठोर हटाना करता है। समूह स्थायी रूप से हटा दिया गया है।
0 टिप्पणियां
कृपया टिप्पणी करने के लिए साइन इन करें करें.