Edge के साथ संपर्क करने के लिए, एसएएमएल का इस्तेमाल करने के लिए डेवलपर सेवाओं के पोर्टल को कॉन्फ़िगर करना

Edge for Private Cloud v4.18.01

डेवलपर सेवाओं का पोर्टल, Apigee Edge के क्लाइंट के तौर पर काम करता है. इसका मतलब है कि पोर्टल, स्टैंड-अलोन सिस्टम के तौर पर काम नहीं करता. इसके बजाय, पोर्टल पर इस्तेमाल की जाने वाली ज़्यादातर जानकारी, Edge पर सेव की जाती है. ज़रूरत पड़ने पर, पोर्टल Edge से जानकारी पाने या Edge को जानकारी भेजने का अनुरोध करता है.

पोर्टल हमेशा किसी एक Edge संगठन से जुड़ा होता है. पोर्टल को कॉन्फ़िगर करते समय, संगठन के किसी खाते के लिए पुष्टि करने वाले बुनियादी क्रेडेंशियल (उपयोगकर्ता नाम और पासवर्ड) तय किए जा सकते हैं. पोर्टल, Edge के साथ कम्यूनिकेट करने के लिए इन क्रेडेंशियल का इस्तेमाल करता है.

अगर आपने Edge की पुष्टि के लिए एसएएमएल को चालू करने का विकल्प चुना है, तो पोर्टल को Edge से अनुरोध करते समय एसएएमएल की पुष्टि का इस्तेमाल करने के लिए कॉन्फ़िगर किया जा सकता है. एसएएमएल का इस्तेमाल करने के लिए पोर्टल को कॉन्फ़िगर करने पर, Edge संगठन में अपने-आप एक नया मशीन उपयोगकर्ता खाता बन जाता है. इसके बाद, पोर्टल इसका इस्तेमाल Edge को अनुरोध भेजने के लिए करता है. मशीन यूज़र के बारे में ज़्यादा जानने के लिए, अपने-आप होने वाले टास्क के लिए एसएएमएल का इस्तेमाल करना लेख पढ़ें.

पोर्टल के लिए एसएएमएल की सुविधा का इस्तेमाल करने के लिए, यह ज़रूरी है कि आपने Edge मैनेजमेंट सर्वर नोड पर, Edge एसएसओ मॉड्यूल को पहले से इंस्टॉल और कॉन्फ़िगर किया हो. पोर्टल के लिए एसएएमएल को चालू करने की सामान्य प्रोसेस इस तरह है:

1. Edge के लिए एसएएमएल को इंस्टॉल और कॉन्फ़िगर करना लेख में बताए गए तरीके से, Edge पर एसएएमएल को कॉन्फ़िगर करें. ध्यान दें: पोर्टल इंस्टॉल करने के लिए, Edge पर बेसिक ऑथेंटिकेशन की सुविधा अब भी चालू होनी चाहिए. Edge पर बेसिक ऑथेंटिकेशन को तब तक बंद न करें, जब तक आपने एसएएमएल का इस्तेमाल करने के लिए पोर्टल को कॉन्फ़िगर न कर लिया हो.
2. पोर्टल इंस्टॉल करें और पक्का करें कि आपका इंस्टॉलेशन ठीक से काम कर रहा हो. Edge for Private Cloud Developer Services पोर्टल इंस्टॉल करना देखें.
3. पोर्टल पर एसएएमएल को कॉन्फ़िगर करें.
4. अब Edge पर बेसिक ऑथेंटिकेशन को बंद किया जा सकता है.

पोर्टल के लिए मशीन यूज़र बनाना

SAML चालू होने पर, Edge मशीन यूज़र का इस्तेमाल करके, OAuth2 टोकन अपने-आप जनरेट होने की सुविधा देता है. मशीन उपयोगकर्ता, पासकोड डाले बिना OAuth2 टोकन हासिल कर सकता है. इसका मतलब है कि OAuth2 टोकन पाने और रीफ़्रेश करने की प्रोसेस को पूरी तरह से ऑटोमेट किया जा सकता है.

पोर्टल के लिए एसएएमएल कॉन्फ़िगरेशन की प्रोसेस, पोर्टल से जुड़े संगठन में अपने-आप एक मशीन उपयोगकर्ता बना देती है. इसके बाद, पोर्टल इस मशीन उपयोगकर्ता खाते का इस्तेमाल करके, Edge से कनेक्ट करता है. मशीन यूज़र के बारे में ज़्यादा जानने के लिए, अपने-आप होने वाले टास्क के लिए एसएएमएल का इस्तेमाल करना लेख पढ़ें.

पोर्टल डेवलपर खातों के लिए पुष्टि करने की प्रक्रिया के बारे में जानकारी

पोर्टल को एसएएमएल का इस्तेमाल करने के लिए कॉन्फ़िगर करने पर, पोर्टल को Edge के साथ पुष्टि करने के लिए एसएएमएल का इस्तेमाल करने की अनुमति मिलती है. इससे पोर्टल, Edge को अनुरोध भेज सकता है. हालांकि, पोर्टल पर डेवलपर नाम के उपयोगकर्ता भी काम कर सकते हैं.

डेवलपर, उपयोगकर्ताओं की ऐसी कम्यूनिटी बनाते हैं जो आपके एपीआई का इस्तेमाल करके ऐप्लिकेशन बनाती है. ऐप्लिकेशन डेवलपर, पोर्टल का इस्तेमाल करके आपके एपीआई के बारे में जानकारी हासिल करते हैं. साथ ही, आपके एपीआई का इस्तेमाल करने वाले ऐप्लिकेशन रजिस्टर करते हैं, डेवलपर कम्यूनिटी से इंटरैक्ट करते हैं, और डैशबोर्ड पर अपने ऐप्लिकेशन के इस्तेमाल से जुड़े आंकड़ों की जानकारी देखते हैं.

जब कोई डेवलपर पोर्टल में लॉग इन करता है, तो पोर्टल की ज़िम्मेदारी होती है कि वह डेवलपर की पहचान की पुष्टि करे और भूमिका के हिसाब से अनुमतियां लागू करे. पोर्टल और Edge के बीच एसएएमएल चालू करने के बाद भी, पोर्टल डेवलपर के साथ पुष्टि करने के लिए बुनियादी तरीके का इस्तेमाल करता रहता है. ज़्यादा जानकारी के लिए, पोर्टल और Edge के बीच कम्यूनिकेशन देखें.

डेवलपर की पुष्टि करने के लिए, एसएएमएल का इस्तेमाल करने के लिए पोर्टल को कॉन्फ़िगर भी किया जा सकता है. तीसरे पक्ष के Drupal मॉड्यूल का इस्तेमाल करके, एसएएमएल को चालू करने का उदाहरण देखने के लिए, https://community.apigee.com/articles/29201/sso-integration-via-saml-with-developer-portal.html पर जाएं.

Edge के साथ कम्यूनिकेट करने के लिए, पोर्टल पर एसएएमएल को कॉन्फ़िगर करें

पोर्टल के लिए एसएएमएल को कॉन्फ़िगर करने के लिए, आपको एक कॉन्फ़िगरेशन फ़ाइल बनानी होगी:

# IP address of Edge Management Server and apigee-sso node.
IP1=22.222.22.222

# URL of Edge management API.
MGMT_URL=http://$IP1:8080/v1

# Org associated with the portal.
EDGE_ORG=myorg

# Information about apigee-sso.
# Externally accessible IP or DNS of apigee-sso.
SSO_PUBLIC_URL_HOSTNAME=$IP1
SSO_PUBLIC_URL_PORT=9099
# Default is http. Set to https if you enabled TLS on apigee-sso.
SSO_PUBLIC_URL_SCHEME=http

# SSO admin credentials as set when you installed apigee-sso.
SSO_ADMIN_NAME=ssoadmin
SSO_ADMIN_SECRET=Secret123

# Default is "n" to disable SAML support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth client used to connect to apigee-sso. 
# The default client name is portalcli.
PORTALCLI_SSO_CLIENT_NAME=portalcli
# Oauth client password using uppercase, lowercase, number, and special chars. 
PORTALCLI_SSO_CLIENT_SECRET=Abcdefg@1

# Email address and user info for the machine user created in 
# the Edge org specified above by EDGE_ORG. 
# This account is used by the portal to make requests to Edge.
# Add this email as an org admin before configuring the portal to use SAML. 
DEVPORTAL_ADMIN_EMAIL=DevPortal_SAML@google.com
DEVPORTAL_ADMIN_FIRSTNAME=DevPortal
DEVPORTAL_ADMIN_LASTNAME=SAMLAdmin
DEVPORTAL_ADMIN_PWD=Abcdefg@1

# If set, the existing portal OAuth client is deleted and new one is created.
# The default value is "n".
# Set to "y" when you configure SAML and change the value of 
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

पोर्टल पर एसएएमएल की सुविधा चालू करने के लिए:

1. Edge के यूज़र इंटरफ़ेस (यूआई) में, DEVPORTAL_ADMIN_EMAIL से तय किए गए मशीन उपयोगकर्ता को पोर्टल से जुड़े संगठन में संगठन के एडमिन के तौर पर जोड़ें.
   ध्यान दें: मशीन उपयोगकर्ता अभी मौजूद नहीं है, लेकिन अगले चरण में यह अपने-आप बन जाता है.
2. पोर्टल पर एसएएमएल को कॉन्फ़िगर करने के लिए, यह कमांड चलाएं:
   > /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f samlConfigFile
   
   जहां samlConfigFile, एसएएमएल की कॉन्फ़िगरेशन फ़ाइल है.
3. पोर्टल एडमिन के तौर पर पोर्टल में लॉग इन करें.
4. Drupal के मुख्य मेन्यू में, Configuration > Dev Portal को चुनें. इसके बाद, पोर्टल कॉन्फ़िगरेशन स्क्रीन दिखेगी. इसमें एसएएमएल सेटिंग भी शामिल होंगी:
   

   ध्यान दें कि इस संगठन के लिए SAML की सुविधा चालू है बॉक्स पर सही का निशान लगा हो. साथ ही, Edge एसएसओ मॉड्यूल के लिए एंडपॉइंट भरा हो. इसके अलावा, पोर्टल OAuth क्लाइंट के लिए एपीआई पासकोड और उपभोक्ता का सीक्रेट फ़ील्ड भरे हों. साथ ही, कनेक्शन की जांच करें बटन के नीचे कनेक्शन हो गया मैसेज दिख रहा हो.

5. कनेक्शन की फिर से जांच करने के लिए, किसी भी समय कनेक्शन की जांच करें बटन को दबाएं.

इन वैल्यू को बाद में बदलने के लिए, कॉन्फ़िगरेशन फ़ाइल को अपडेट करें और कमांड को फिर से चलाएं.

पोर्टल पर एसएएमएल की सुविधा बंद करना

अगर आपने पोर्टल और Edge के बीच कम्यूनिकेशन के लिए SAML को बंद करने का विकल्प चुना है, तो पोर्टल अब Edge को अनुरोध नहीं भेज पाएगा. डेवलपर, पोर्टल में लॉग इन कर सकते हैं. हालांकि, वे प्रॉडक्ट नहीं देख पाएंगे या ऐप्लिकेशन नहीं बना पाएंगे.

चेतावनी: अगर एसएएमएल को बंद किया जाता है, तो आपको पोर्टल को फिर से कॉन्फ़िगर करना चाहिए, ताकि एसएएमएल का इस्तेमाल किया जा सके. इसके अलावा, अगर Edge को अब भी बुनियादी पुष्टि के साथ काम करने के लिए कॉन्फ़िगर किया गया है, तो पोर्टल को कॉन्फ़िगर करें, ताकि बुनियादी पुष्टि का इस्तेमाल करके Edge के साथ कम्यूनिकेट किया जा सके. बेसिक ऑथ का इस्तेमाल करने के बारे में ज़्यादा जानने के लिए, पोर्टल और Edge के बीच कम्यूनिकेशन देखें.

पोर्टल पर एसएएमएल को बंद करने के लिए:

1. उस कॉन्फ़िगरेशन फ़ाइल में बदलाव करें जिसका इस्तेमाल आपने SAM को कॉन्फ़िगर करने के लिए किया था, ताकि इसे सेट किया जा सके:
   DEVPORTAL_SSO_ENABLED=n
2. पोर्टल को कॉन्फ़िगर करें:
   > /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile