बाहरी आईडीपी (IdP) का इस्तेमाल करने के लिए पोर्टल को कॉन्फ़िगर करें

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

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

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

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

1. ज़्यादा उपलब्धता के लिए Apigee एसएसओ (SSO) इंस्टॉल करें के मुताबिक, Apigee एसएसओ (SSO) मॉड्यूल इंस्टॉल करें.
2. पोर्टल इंस्टॉल करें और पक्का करें कि आपकी इंस्टॉलेशन ठीक से काम कर रही हो. पोर्टल इंस्टॉल करें देखें.
3. इस सेक्शन में बताए गए तरीके के मुताबिक, पोर्टल पर एसएएमएल या एलडीएपी को कॉन्फ़िगर करें.
4. (ज़रूरी नहीं) Edge पर बुनियादी पुष्टि करने की सुविधा बंद करें में बताए गए तरीके से, Edge पर पुष्टि करने की सामान्य प्रक्रिया को बंद करें.

पोर्टल के लिए मशीन उपयोगकर्ता बनाएं

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

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

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

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

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

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

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

पोर्टल के लिए आईडीपी कॉन्फ़िगरेशन फ़ाइल

पोर्टल के लिए किसी बाहरी आईडीपी को कॉन्फ़िगर करने के लिए, आपको एक ऐसी कॉन्फ़िगरेशन फ़ाइल बनानी होगी जो पोर्टल की सेटिंग के बारे में बताए.

यहां दिए गए उदाहरण में, आईडीपी (IdP) की मदद से काम करने वाली पोर्टल कॉन्फ़िगरेशन फ़ाइल दिखाई गई है:

# IP address of Edge Management Server and the node on which the Apigee SSO module is installed.
IP1=22.222.22.222

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

# Organization associated with the portal.
EDGE_ORG=myorg

# Information about the Apigee SSO module (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

# Enables or disables external IDP support.
# Default is "n", which disables external IDP support.
# Change it to "y" to enable external IDs support.
DEVPORTAL_SSO_ENABLED=y

# The name of the OAuth2 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 characters.
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 an external IDP.
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 a new one is created.
# The default value is "n".
# Set to "y" when you configure the external IDP and change the value of
# any of the PORTALCLI_* properties.
PORTALCLI_SSO_CLIENT_OVERWRITE=y

पोर्टल पर बाहरी आईडीपी (IdP) सहायता चालू करने के लिए:

1. Edge यूज़र इंटरफ़ेस (यूआई) में, मशीन के जिस उपयोगकर्ता के बारे में DEVPORTAL_ADMIN_EMAIL ने बताया है उसे पोर्टल से जुड़े संगठन में संगठन एडमिन के तौर पर जोड़ें.
2. पोर्टल पर बाहरी आईडीपी को कॉन्फ़िगर करने के लिए, नीचे दिए गए कमांड का इस्तेमाल करें:

   /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile

   जहां configFile, ऊपर बताई गई कॉन्फ़िगरेशन फ़ाइल है.

3. पोर्टल एडमिन के तौर पर पोर्टल में लॉग इन करें.
4. मुख्य Drupal मेन्यू में, कॉन्फ़िगरेशन > डेव पोर्टल चुनें. पोर्टल को कॉन्फ़िगर करने की स्क्रीन दिखेगी. इसमें बाहरी आईडीपी (IdP) की सेटिंग भी शामिल होंगी:

   

   निम्न पर ध्यान दें:

   • यह संगठन एसएएमएल की सुविधा देता है वाला बॉक्स चुना गया है
   • Apigee एसएसओ (SSO) मॉड्यूल के लिए एंडपॉइंट का एंडपॉइंट भरा हुआ है
   • पोर्टल Oauth क्लाइंट के लिए एपीआई पासकोड और उपभोक्ता सीक्रेट फ़ील्ड भरे हुए हैं
   • कनेक्शन की जांच करें बटन के नीचे, कनेक्शन हो गया मैसेज दिखता है.
5. कनेक्शन की फिर से जांच करने के लिए, किसी भी समय कनेक्शन की जांच करें बटन पर क्लिक करें.

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

पोर्टल पर बाहरी आईडीपी (IdP) को बंद करना

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

पोर्टल पर बाहरी आईडीपी (IdP) की पुष्टि करने की सुविधा बंद करने के लिए:

1. वह कॉन्फ़िगरेशन फ़ाइल खोलें जिसका इस्तेमाल आपने बाहरी आईडीपी (IdP) को चालू करने के लिए पहले किया था.
2. DEVPORTAL_SSO_ENABLED प्रॉपर्टी की वैल्यू को n पर सेट करें, जैसा कि इस उदाहरण में दिखाया गया है:

   DEVPORTAL_SSO_ENABLED=n

3. यह निर्देश देकर पोर्टल को कॉन्फ़िगर करें:

   /opt/apigee/apigee-service/bin/apigee-service apigee-drupal-devportal configure-sso -f configFile