با استفاده از get_token

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

ابزار get_token (1) به شما امکان می‌دهد اعتبارنامه‌های Apigee خود را با یک توکن دسترسی و به‌روزرسانی که می‌توانید برای دسترسی به APIهای Edge استفاده کنید، مبادله کنید. این توکن‌ها همچنین می‌توانند با پیاده‌سازی‌های 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 و در هر فراخوانی بعدی بدون توکن refresh معتبر، از شما خواسته می‌شود که آن را وارد کنید. اگر نمی‌خواهید رمز عبور خود را مستقیماً در دستور استفاده کنید، می‌توانید به جای رمز عبور خود از یک کد عبور یکبار مصرف استفاده کنید.
MFACODE اختیاری یک کد احراز هویت چند عاملی (MFA) شش رقمی موقت. اگر -u استفاده کنید و MFA را فعال کرده باشید، این کد مورد نیاز است. در صورت حذف (مگر در حالت رمز عبور) از شما سوال پرسیده می‌شود. اگر MFA را فعال نکرده‌اید یا جریان اسکریپتی دارید، می‌توانید برای جلوگیری از سوالات -m "" را وارد کنید.
PASSCODE اختیاری. ترکیبی از نام کاربری و رمز عبور یا کد عبور لازم است. یک کد عبور یکبار مصرف که می‌توانید به جای رمز عبور از آن استفاده کنید. هنگام احراز هویت با SAML IDP، کد عبور لازم است و می‌توان از آن برای احراز هویت با LDAP IDP نیز استفاده کرد.

برای مثال:

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).
  • نام کاربری، رمز عبور و یک کد موقت MFA، در غیر این صورت.

مثال زیر برای اولین بار get_token فراخوانی می‌کند و از ترکیب نام کاربری/رمز عبور با یک کد MFA اختیاری برای احراز هویت استفاده می‌کند:

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 Reference مراجعه کنید.

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

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

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

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

  • --clear-sso-cache

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

  • --clear-all-sso-cache

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

(1) حق نشر 2023 گوگل LLC
ابزار get_token به عنوان "نرم‌افزار" تحت توافق‌نامه‌ی حاکم بر استفاده‌ی شما از پلتفرم ابری گوگل، از جمله شرایط خاص سرویس که در https://cloud.google.com/terms/service-terms موجود است، در دسترس قرار می‌گیرد.