استفاده از get_token

درحال مشاهده اسناد Apigee Edge هستید.
به اسناد Apigee X بروید. اطلاعات

ابزار get_token(۱) به شما امکان می‌دهد اطلاعات اعتباری Apigee خود را با یک ژتون دسترسی و بازآوری که می‌توانید برای دسترسی به Edge APIs استفاده کنید، مبادله کنید. از این نشان‌ها می‌توان با پیاده‌سازی‌های SAML و LDAP از گردش‌های کار OAuth2 نیز استفاده کرد.

‫get_token به شما امکان می‌دهد:

  • کد دسترسی یا کد بازآوری دریافت کنید.
  • نشان‌های چاپ را به stdout برای استفاده در متغیرها و فرمان‌ها ارسال کنید.
  • نشان‌ها را در دیسک خود ذخیره کنید.

سپس می‌توانید یک کد معتبر به درخواست‌هایتان به Edge API اضافه کنید و وقتی کدتان منقضی شد کد جدیدی دریافت کنید.

پیش‌نیاز: قبل‌از اینکه بتوانید از get_token استفاده کنید، باید آن را نصب کنید.

نحو get_token

برنامه کمکی get_token از نحو زیر استفاده می‌کند:

get_token -u USERNAME:PASSWORD [-m MFACODE]

یا

get_token -p passcode

مکان:

عنصر الزامی است؟ شرح
USERNAME اختیاری. ترکیبی از نام کاربری و گذرواژه یا گذرنویسه لازم است. نام کاربری Apigee شما که معمولاً نشانی ایمیل منسوب به حساب Apigee شما است. اولین‌باری که با get_token تماس می‌گیرید، باید نام کاربری یا گذرنویسه‌تان را وارد کنید. تا زمانی که نشان‌های دسترسی و بازآوری منقضی نشده‌اند، دیگر لازم نیست نشانی ایمیلتان را وارد کنید. اگر نشانه‌ها را برای بیش از یک کاربر ذخیره می‌کنید، باید نام کاربری خود را در هر تماس مشخص کنید.
PASSWORD اختیاری. ترکیبی از نام کاربری و گذرواژه یا گذرنویسه لازم است. گذرواژه حساب Apigee شما. اگر گذرواژه را حذف کنید، در اولین استفاده از get_token و در تماس‌های بعدی بدون رمز بازآوری معتبر، از شما خواسته می‌شود آن را وارد کنید. اگر نمی‌خواهید مستقیماً از گذرواژه خود در فرمان استفاده کنید، می‌توانید به‌جای گذرواژه از گذرنویسه کد یکبارمصرف استفاده کنید.
MFACODE اختیاری کد موقت شش‌رقمی اصالت‌سنجی چندعاملی (MFA). اگر از -u استفاده می‌کنید و «احراز هویت چند مرحله‌ای» را فعال کرده‌اید، این کد لازم است. اگر آن را وارد نکنید، از شما خواسته می‌شود آن را وارد کنید (مگر اینکه در حالت گذرنویسه باشید). اگر «احراز هویت چندعاملی» را فعال نکرده‌اید، یا اگر جاری‌سازی برنامه‌ریزی‌شده‌ای دارید، می‌توانید -m "" را مشخص کنید تا از پیام‌واره‌ها جلوگیری کنید.
PASSCODE اختیاری. ترکیبی از نام کاربری و گذرواژه یا گذرنویسه لازم است. گذرنویسه یکبار مصرف که می‌توانید به‌جای گذرواژه از آن استفاده کنید. هنگام اصالت‌سنجی با «ارائه‌دهنده هویت» SAML، گذرنویسه لازم است و ممکن است برای اصالت‌سنجی با «ارائه‌دهنده هویت» LDAP استفاده شود.

برای مثال:

get_token
get_token -u ahamilton@apigee.com:mypassw0rd -m 424242
get_token -p mypass

تماس موفق یک کد دسترسی معتبر را در stdout چاپ می‌کند و هر دو کد دسترسی و کد بازآوری را در ~/.sso-cli ذخیره می‌کند. تا زمانی که این نشان‌ها منقضی شوند می‌توانید از آن‌ها استفاده کنید، همان‌طور که در انقضای نشان توضیح داده شده است.

پس‌از اولین تماس موفقیت‌آمیز با get_token، تا زمانی که نشان‌ها منقضی نشده‌اند، نیازی به افزودن اعتبارنامه‌هایتان ندارید.

برای اولین‌بار get_token را فراخوانی کنید

اگر در اولین تماس خود هیچ گزینه‌ای را مشخص نکنید، get_token از شما موارد زیر را می‌پرسد:

  • گذرنویسه، درصورت اصالت‌سنجی با ارائه‌دهنده هویت SAML (IDP).
  • نام کاربری، گذرواژه، و کد موقت «احراز هویت چندعاملی»، درغیراین‌صورت.

مثال زیر برای اولین‌بار get_token را فرا می‌خواند و از ترکیب نام کاربری/گذرواژه با کد اختیاری «اصالت‌سنجی چندعاملی» برای اصالت‌سنجی استفاده می‌کند:

get_token
Enter username:
ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
123456

ey42bGciOiJSUzI1NiJ9.eyJqdGkiOiJhM2YwNjA5ZC1lZTIxLTQ1YjAtOGQyMi04MTQ0MTYxNjNhNTMiLCJzdWIiOiIyZDFl
  <snip>
VlLmNvbSIsInppZCI6InVhYSIsImF1ZCI6WyJlZGdlY2xpIiwic2NpbSIsIm9wZW5pZCIsInBhc3N3b3JkIiwiYXBwcm54242

افزودن کد دسترسی به درخواست

پس‌از اینکه باموفقیت با get_token تماس گرفتید، می‌توانید از کد دسترسی با ارسال آن در سرایند Authorization تماس‌هایتان با Edge API به روش‌های مختلف استفاده کنید. می‌توانید:

  • محتوای پاسخ get_token را کپی کنید و مستقیماً در سرایند خود درج کنید: 
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
  -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • فرمان‌ها را ترکیب کنید تا نشان را دریافت کنید و آن را به سرایند اضافه کنید: 
    token=$(get_token); curl -H "Authorization: Bearer $token" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    توجه داشته باشید که get_token از نحو جایگزینی فرمان $(...) استفاده می‌کند تا اجرا شود.

  • تماس با get_token در تماس curl: 
    curl -H "Authorization: Bearer $(get_token)" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    توجه داشته باشید که get_token از نحو جایگزینی فرمان $(...) استفاده می‌کند تا اجرا شود.

این درخواست‌های نمونه جزئیات مربوط به سازمان «ahamilton-eval» را دریافت می‌کنند. برای فهرست کامل نقطه‌های پایانی Edge API، به مرجع Apigee Edge API مراجعه کنید.

استفاده از get_token با SAML و LDAP

از ابزار get_token می‌توان با SAML،‏ LDAP، یا هر IDP زیربنایی دیگری استفاده کرد. ‫get_token از استفاده از چند نشانی وب ورود به سیستم SSO و چند حساب پشتیبانی می‌کند. از کاربر واحدی که چند حساب دارد خواسته می‌شود نام کاربری برای هر تماس get_token را مشخص کند.

پاک کردن حافظه نهان get_token

برای پاک کردن حافظه نهان get_token می‌توانید از پرچم‌های اختیاری زیر استفاده کنید:

  • --clear-sso-cache

    دایرکتوری حافظه نهان را برای SSO_LOGIN_URL در $HOME/.sso-cli پاک می‌کند و همه کدهای دسترسی و کدهای نوسازی ذخیره‌شده در حافظه نهان را برای سرور دور می‌اندازد.

  • --clear-all-sso-cache

    همه پوشه‌های زیر $HOME/.sso-cli را پاک می‌کند و همه کدهای ذخیره‌شده در حافظه نهان را دور می‌اندازد.

(۱) «حق نشر ۲۰۲۳ Google LLC»
ابزار get_token تحت قرارداد حاکم بر استفاده شما از Google Cloud Platform به‌عنوان «نرم‌افزار» دردسترس قرار می‌گیرد، ازجمله «شرایط ویژه خدمات» موجود در https://cloud.google.com/terms/service-terms.