درباره acurl و get_token

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

Apigee ابزارهای کاربردی زیر را برای تولید و ارسال توکن‌های دسترسی و به‌روزرسانی OAuth2 ارائه می‌دهد. شما از این توکن‌ها برای احراز هویت خود در فراخوانی‌های Edge API خود با OAuth (از جمله گردش‌های کاری SAML و LDAP) استفاده می‌کنید:

  • acurl (1) : یک پوشش راحت پیرامون دستور استاندارد curl ارائه می‌دهد. درخواست‌های HTTP به Edge API را می‌سازد، توکن‌های دسترسی و به‌روزرسانی را از get_token دریافت می‌کند و توکن دسترسی را به Edge API ارسال می‌کند.
  • get_token (1) : اعتبارنامه‌های Apigee شما را در ازای توکن‌های دسترسی و به‌روزرسانی که می‌توانید برای فراخوانی Edge API از آنها استفاده کنید، مبادله می‌کند.

هر دوی این ابزارها، اطلاعات حساب کاربری Apigee شما (نام کاربری و رمز عبور یا کد عبور) را با توکن‌های OAuth2 مبادله می‌کنند.

توکن‌های ایجاد شده توسط ابزارهای Apigee با مشخصات چارچوب مجوز OAuth 2.0 مطابقت دارند.

استفاده از ابزارهای Apigee برای دریافت توکن‌ها یا دسترسی به سرور احراز هویت برای Edge APIها اختیاری است. می‌توانید طرح‌های خودتان را برای تولید توکن‌های دسترسی OAuth2 پیاده‌سازی کنید و آنها را در درخواست‌های خود به Edge API ارسال کنید.

نصب acurl و get_token

Apigee یک فایل ZIP حاوی acurl (1) ، get_token (1) و یک اسکریپت نصب ارائه می‌دهد.

برای نصب acurl و get_token :

  1. یک دایرکتوری نصب روی دستگاه خود ایجاد کنید یا از دایرکتوری پیش‌فرض usr/local/bin استفاده کنید.
  2. فایل زیپ نصب را از Apigee دانلود کنید: 
    curl https://login.apigee.com/resources/scripts/sso-cli/ssocli-bundle.zip -O
  3. فایل دانلود شده را از حالت فشرده خارج کنید.
  4. اسکریپت نصب را اجرا کنید:
    sudo ./install -b /usr/local/bin

    گزینه -b محل فایل‌های اجرایی را مشخص می‌کند. اگر این گزینه را مشخص نکنید، اسکریپت نصب، ابزارها را در /usr/local/bin نصب می‌کند.

  5. نصب‌ها را آزمایش کنید:
        acurl -h
    get_token -h

    اگر نصب موفقیت‌آمیز باشد، این دستورات متن راهنما را برای ابزارها برمی‌گردانند.

انقضای توکن

acurl و get_token توکن‌هایی با مدت زمان‌های زیر تولید می‌کنند:

  • توکن‌های دسترسی ظرف ۱۲ ساعت منقضی می‌شوند.
  • توکن‌های به‌روزرسانی ظرف 30 روز منقضی می‌شوند.

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

نقطه پایانی SSO را تنظیم کنید

قبل از اولین فراخوانی، باید نقطه پایانی سرور احراز هویت را برای Edge API که می‌خواهید با acurl و get_token استفاده کنید، تنظیم کنید.

از طریق ترمینال، متغیر محیطی SSO_LOGIN_URL را روی نقطه پایانی سرور احراز هویت خود تنظیم کنید. برای مثال:

  • برای مشتریان ابری بدون منطقه: 
    export SSO_LOGIN_URL=https://login.apigee.com
  • برای مشتریان ابری با منطقه: 
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • برای مشتریان ابر خصوصی، برای دریافت نقطه پایانی SSO مناسب با مدیر خود تماس بگیرید.

از یک رمز عبور یکبار مصرف استفاده کنید (برای SAML لازم است)

وقتی با acurl یا get_token یک فراخوانی API انجام می‌دهید، باید برای دریافت یک جفت توکن، خودتان را به این ابزار احراز هویت کنید. می‌توانید این کار را با وارد کردن نام کاربری، رمز عبور و کد MFA حساب Apigee خود انجام دهید. با این حال، اگر از یک IDP SAML استفاده می‌کنید یا نمی‌خواهید از رمز عبور خود استفاده کنید، می‌توانید به جای آن یک کد عبور یکبار مصرف دریافت کنید.

برای دریافت رمز یکبار مصرف:

  1. آدرس اینترنتی زیر را در مرورگر وارد کنید:
    • برای مشتریان ابری بدون منطقه: 
      https://login.apigee.com/passcode
    • برای مشتریان ابری با منطقه: 
      https://zone_name.login.apigee.com/passcode
    • برای مشتریان ابر خصوصی، برای دریافت نقطه پایانی SSO مناسب با مدیر خود تماس بگیرید.
  2. وارد حساب کاربری Apigee خود شوید.
  3. رمز عبور ۶ کاراکتری را کپی کنید.
  4. acurl یا get_token به همراه گزینه -p استفاده کنید و کد عبور را مانند مثال زیر وارد کنید: 
    get_token -p 1a2b3c

توکن‌های خود را مشاهده کنید

وقتی acurl یا get_token با موفقیت اجرا می‌کنید، این ابزارها یک فایل داده در ~/.sso-cli ایجاد می‌کنند که شامل توکن‌ها و سایر فراداده‌ها است.

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

get_token -v

این دستور، توکن‌های رمزگشایی شده را نمایش می‌دهد، برای مثال: 

Decoded token claims:
 {
  "jti": "8018507e-9f34-4a90-bf97-ff226a06b19b",
  "sub": "858217a9-01a1-4111-8525-75ca555f5d5c",
  "scope": [
    "scim.emails.read",
    "scim.me",
    "openid",
    "password.write",
    "approvals.me",
    "scim.ids.read",
    "oauth.approvals"
          ],
  "client_id": "edgecli",
  "cid": "edgecli",
  "azp": "edgecli",
  "grant_type": "password",
  "user_id": "858217a9-01a1-4111-8525-75ca555f5d5c",
  "origin": "usergrid",
  "user_name": "myusername@google.com",
  "email": "myusername@google.com",
  "auth_time": 1597444772,
  "al": 0,
  "rev_sig": "6271c527",
  "iat": 1597444772,
  "exp": 1597487972,
  "iss": "https://login.apigee.com",
  "zid": "uaa",
  "aud": [
    "edgecli",
    "scim.emails",
    "scim",
    "openid",
    "password",
    "approvals",
    "scim.ids",
    "oauth"
        ]
    }
Current timestamp: 1597444983
Existing access token is still valid

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