एसएएमएल के साथ Edge एपीआई ऐक्सेस करें

आपको Apigee Edge दस्तावेज़ दिख रहा है.
अभी तक किसी भी व्यक्ति ने चेक इन नहीं किया है इस पेज पर जाएं Apigee X दस्तावेज़.
जानकारी

एसएएमएल सिंगल साइन-ऑन (एसएसओ) एनवायरमेंट के साथ काम करता है. Edge के साथ एसएएमएल का इस्तेमाल करके, एसएसओ की सुविधा का इस्तेमाल किया जा सकता है का इस्तेमाल किया जा सकता है. एसएएमएल.

ज़रूरी शर्त: आपको कम से कम के लिए एसएएमएल को चालू करना होगा पहले एक संगठन में ही इस्तेमाल कर सकते हैं. एज एपीआई को ऐक्सेस करने के लिए इसका इस्तेमाल किया जा सकता है.

एसएएमएल और OAuth2 में अंतर

एसएएमएल सेट अप हो जाने के बाद, इसे ऐक्सेस करने के लिए OAuth2 का इस्तेमाल करने जैसा ही है Edge API इस्तेमाल कर सकते हैं. Edge API को कॉल करने पर, आपके पास OAuth2 ऐक्सेस टोकन को शामिल करने का विकल्प होता है आपका अनुरोध.

Edge API ऐक्सेस करने के दौरान, एसएएमएल और OAuth2 में एक अहम अंतर है तो आपको टोकन मिलते हैं. एसएएमएल का इस्तेमाल करते समय, आपको नीचे दी गई जानकारी को शामिल करना होगा टोकन पेयर:

  1. ज़ोन: टोकन पाते समय, सार्वजनिक क्लाउड प्लैटफ़ॉर्म का इस्तेमाल करने वाले लोगों के लिए, एजुकेटर को अपने ज़ोन का नाम बताना होगा.
  2. पासकोड: ऐक्सेस/रीफ़्रेश करने का अनुरोध करते समय, एक बार इस्तेमाल होने वाला पासवर्ड शामिल करें टोकन पेयर.

एसएएमएल, Edge OAuth2 सेवा के लिए एक ही एंडपॉइंट का इस्तेमाल करता है. इसके लिए, सही ज़ोन का नाम भी जोड़ा जाता है.

एसएएमएल का इस्तेमाल करके ऐक्सेस टोकन पाने के लिए, इस सेक्शन में बताए गए तरीकों में से किसी एक का इस्तेमाल करें:

इसके अलावा, मशीन उपयोगकर्ताओं के लिए टोकन जनरेट करने की प्रोसेस को ऑटोमेट किया जा सकता है. इसका तरीका टोकन जनरेट करने की प्रोसेस को ऑटोमेट करना में बताया गया है.

get_token के साथ ऐक्सेस टोकन पाएं

आप get_token यूटिलिटी का इस्तेमाल करके OAuth2 ऐक्सेस के लिए अपने क्रेडेंशियल बदल सकते हैं और उन टोकन को रीफ़्रेश करें जिन्हें एसएएमएल के साथ इस्तेमाल किया जाता है.

get_token के साथ ऐक्सेस टोकन पाने के लिए:

  1. अपने लॉगिन यूआरएल पर, SSO_LOGIN_URL एनवायरमेंट वैरिएबल सेट करें. लॉगिन यूआरएल में यह है यह फ़ॉर्म:
    https://zoneName.login.apigee.com

    उदाहरण के लिए, "acme" नाम के ज़ोन के लिए, SSO_LOGIN_URL को "https://acme.login.apigee.com" पर सेट करें, जैसा कि नीचे दिए गए उदाहरण में बताया गया है:

    export SSO_LOGIN_URL=https://acme.login.apigee.com
  2. OAuth2 ऐक्सेस टोकन पाने के लिए, get_token पर कॉल करें:
    get_token -u me@example.com

    आपको एक बार इस्तेमाल होने वाला पासवर्ड पाने के लिए, दिखाए गए यूआरएल पर जाने के लिए कहा जाएगा:

    Get passcode from https://acme.login.apigee.com/passcode
    [Note:  Passcode can be used only time time and expires] Input passcode (no spaces) and then press ENTER:

    अगर आपने हाल ही में अपने आइडेंटिटी प्रोवाइडर से साइन इन नहीं किया है, तो आपको साइन इन करने के लिए कहा जाएगा इंच

    यह यूआरएल, एक बार इस्तेमाल होने वाला पासवर्ड दिखाता है. यह तब तक मान्य रहता है, जब तक उस यूआरएल को रीफ़्रेश नहीं किया जाता नया पासवर्ड पाएं या आप पासवर्ड जनरेट करने के लिए get_token के साथ पासवर्ड का इस्तेमाल करें ऐक्सेस टोकन. उदाहरण के लिए:

  3. पासवर्ड डालें. get_token यूटिलिटी OAuth2 टोकन हासिल करती है, यह ऐक्सेस टोकन को stdout पर प्रिंट करता है. साथ ही, ऐक्सेस और रीफ़्रेश टोकन को लिखता है ~/.sso-cli के लिए.

  4. Edge API को कॉल करें और Authorization: Bearer में ऐक्सेस टोकन पास करें हेडर, जैसा कि नीचे दिया गया उदाहरण दिखाता है:
    curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval \
      -H "Authorization: Bearer ACCESS_TOKEN"

    ऐक्सेस टोकन की वैल्यू stdout से कॉपी की जा सकती है.

    इस उदाहरण में, दिए गए संगठन के बारे में जानकारी दी गई है. मैनेजमेंट की पूरी सूची देखने के लिए एपीआई एंडपॉइंट, Apigee Edge API का संदर्भ देखें.

ऐक्सेस टोकन की समयसीमा खत्म होने के बाद, नया ऐक्सेस पाने के लिए, get_token पर फिर से कॉल करें टोकन. उदाहरण के लिए:

get_token -u me@example.com

रीफ़्रेश टोकन की समयसीमा खत्म होने तक, आपको नया पासवर्ड डालने के लिए नहीं कहा जाएगा.

रीफ़्रेश टोकन की समयसीमा खत्म होने पर, get_token आपसे नए पासवर्ड के लिए अनुरोध करता है. आपको ऐसा ज़रूर करना चाहिए नया OAuth2 ऐक्सेस टोकन जनरेट करने से पहले, नया पासवर्ड जनरेट करें.

Edge OAuth2 सेवा की मदद से ऐक्सेस टोकन पाएं

एसएएमएल के साथ इस्तेमाल किए जाने वाले ऐक्सेस टोकन पाने के लिए, Edge OAuth2 सेवा का इस्तेमाल किया जा सकता है. पुष्टि करने के लिए साइन अप करते समय, ऐक्सेस/रीफ़्रेश करने के लिए अपने शुरुआती अनुरोध पर पासवर्ड का इस्तेमाल करें. नया टोकन पेयर पाने के लिए फिर से साइन इन करें.

Edge API के साथ टोकन पेयर पाने के लिए:

  1. ब्राउज़र में, एक बार इस्तेमाल होने वाला पासवर्ड पाने के लिए इस यूआरएल पर जाएं:
    https://zoneName.login.apigee.com/passcode

    उदाहरण के लिए, "acme" नाम के ज़ोन के लिए, इस यूआरएल पर जाएं:

    https://acme.login.apigee.com/passcode

    अगर आपने हाल ही में अपने आइडेंटिटी प्रोवाइडर से साइन इन नहीं किया है, तो आपको साइन इन करने के लिए कहा जाएगा इंच

    यह यूआरएल, एक बार इस्तेमाल होने वाला पासवर्ड दिखाता है. यह टोकन पाने के लिए आपके क्रेडेंशियल की तरह काम करता है. साथ ही, यह तब तक मान्य रहता है, जब तक कि आप यूआरएल को नया पासवर्ड पाएं या get_token के साथ पासवर्ड का इस्तेमाल करके ऐक्सेस टोकन. उदाहरण के लिए:

  2. Edge API को अनुरोध भेजें, जैसा कि नीचे दिया गया है:
    curl https://zoneName.login.apigee.com/oauth/token \
          -s \
          -H "Accept: application/json" \
          -d 'grant_type=password&response_type=token&passcode=passcode'

    अनुमति देने के लिए, passcode आपके क्रेडेंशियल के तौर पर काम करता है.

    कहां:

    • Authorization हेडर "Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" है (इसका उपयोग करें सटीक वैल्यू).
    • अनुरोध का टाइप POST है.
    • अनुरोध में ये चीज़ें शामिल हैं:
      • grant_type, "password" है.
      • response_type एक "टोकन" है.
      • passcode जहां passcode पिछले चरण में मिला पासवर्ड है.

    कॉल, ऐक्सेस को प्रिंट करता है और स्क्रीन पर टोकन रीफ़्रेश करता है.

अपने ऐक्सेस टोकन को रीफ़्रेश करने के लिए:

https://zoneName.login.apigee.com/oauth/token को अनुरोध सबमिट करें, जैसा कि नीचे दिए गए उदाहरण में बताया गया है:

curl https://zoneName.login.apigee.com/oauth/token \
      -d 'grant_type=refresh_token&refresh_token=REFRESH_TOKEN'

कहां:

  • अनुरोध में ये चीज़ें शामिल हैं:
    • grant_type "refresh_token" है.
    • refresh_token, रीफ़्रेश टोकन की वैल्यू है.
  • Authorization हेडर "Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" है (इसका उपयोग करें सटीक वैल्यू).
  • अनुरोध का टाइप POST है.

एसएएमएल से Edge एपीआई ऐक्सेस करें

इसके लिए, curl या Apigee सुविधा यूटिलिटी acurl जैसे टूल इस्तेमाल किए जा सकते हैं से Edge API ऐक्सेस करें.

curl के साथ, Edge API को कॉल किया जाता है और ऐक्सेस टोकन को Authorization: Bearer हेडर, जैसा कि नीचे दिया गया उदाहरण दिखाता है:

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval \
  -H "Authorization: Bearer ACCESS_TOKEN"

acurl के साथ, आपको Authorization हेडर देने की ज़रूरत नहीं है. उदाहरण के लिए:

acurl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

ये उदाहरण, Edge API के एंडपॉइंट को कॉल करते हैं, जिसे दिए गए संगठन के बारे में जानकारी मिलती है. Edge API के एंडपॉइंट की पूरी सूची देखने के लिए, Apigee Edge API का रेफ़रंस लेख पढ़ें.

एपीआई को कॉल करने के अन्य तरीकों के लिए, जिनमें यह पक्का करने के तरीके भी शामिल हों कि आपका टोकन मौजूद रहे इसके बाद, OAuth2 की मदद से Edge API को ऐक्सेस करना लेख पढ़ें.

एसएएमएल ज़ोन में मशीन उपयोगकर्ता

अपने-आप ऐक्सेस होने की सुविधा को स्क्रिप्ट करने के लिए, acurl और get_token यूटिलिटी का इस्तेमाल किया जा सकता है साथ ही, एसएएमएल ज़ोन में मशीन इस्तेमाल करने वालों के लिए Edge API जोड़ा जा सकता है. नीचे दिए गए उदाहरण में, इसके लिए get_token का इस्तेमाल करें ऐक्सेस टोकन का अनुरोध करें और फिर curl कॉल में टोकन वैल्यू जोड़ें:

  USER=me@example.com
  PASS=not-that-secret
  TOKEN=$(get_token -u $USER:$PASS -m '' --force-basic-auth)
  curl -H "Authorization: Bearer $TOKEN" 'https://api.enterprise.apigee.com/v1/organizations/...'

ऊपर दिए गए उदाहरण में, -m की वैल्यू को खाली स्ट्रिंग पर सेट करने से, मशीन का इस्तेमाल नहीं कर पाएगा को MFA कोड के लिए संकेत दिए जाने से रोका जा सकता है. --force-basic-auth फ़्लैग का इस्तेमाल करने से ओवरराइड हो जाएगा एसएएमएल ज़ोन के अनुरोधों से ट्रिगर हुए पासवर्ड के लिए स्टैंडर्ड प्रॉम्प्ट.

इसके अलावा, टोकन के लिए अनुरोध और curl कॉल को जोड़ने के लिए, acurl यूटिलिटी का इस्तेमाल किया जा सकता है. उदाहरण के लिए:

  USER=me@example.com
  PASS=not-that-secret
  acurl -u $USER:$PASS -m '' --force-basic-auth 'https://api.enterprise.apigee.com/v1/organizations/...'