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

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

ابزار get_token (1) به شما امکان می دهد اعتبارنامه Apigee خود را با یک توکن دسترسی و تازه سازی که می توانید برای دسترسی به API های Edge از آن استفاده کنید، مبادله کنید. توکن ها همچنین می توانند با پیاده سازی SAML و LDAP گردش کار OAuth2 استفاده شوند.

get_token شما را قادر می سازد:

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

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

پیش نیاز: قبل از اینکه بتوانید از 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 استفاده می کنید و MFA را فعال کرده اید، این کد مورد نیاز است. در صورت حذف از شما خواسته می شود (مگر اینکه در حالت رمز عبور). اگر MFA را فعال نکرده‌اید، یا یک جریان اسکریپتی دارید، می‌توانید -m "" را برای جلوگیری از درخواست‌ها مشخص کنید.
PASSCODE اختیاری. ترکیب نام کاربری و رمز عبور یا رمز عبور مورد نیاز است. یک رمز عبور یک بار مصرف که می توانید به جای رمز عبور استفاده کنید. هنگام احراز هویت با SAML IDP، یک رمز عبور لازم است، و ممکن است برای احراز هویت با یک IDP LDAP استفاده شود.

به عنوان مثال:

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

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

پس از اولین تماس موفقیت‌آمیز خود با 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 Google LLC
ابزار get_token تحت قراردادی که بر استفاده شما از پلتفرم Google Cloud حاکم است، به‌عنوان «نرم‌افزار» در دسترس است، از جمله شرایط خاص سرویس که در https://cloud.google.com/terms/service-terms موجود است.