درباره acurl و get_token

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

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

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

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

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

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

acurl و get_token را نصب کنید

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

برای نصب acurl و get_token :

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

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

  5. تست نصب:
        acurl -h
    get_token -h

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

انقضای توکن

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

  • توکن های دسترسی 12 ساعت دیگر منقضی می شوند.
  • توکن‌های Refresh در 30 روز منقضی می‌شوند.

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

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

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

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

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

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

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

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

  1. آدرس زیر را در مرورگر وارد کنید:
    • برای مشتریان Cloud بدون منطقه: 
      https://login.apigee.com/passcode
    • برای مشتریان Cloud با منطقه: 
      https://zone_name.login.apigee.com/passcode
    • برای مشتریان Private Cloud، برای دریافت نقطه پایانی SSO مناسب با سرپرست خود تماس بگیرید.
  2. به حساب Apigee خود وارد شوید.
  3. رمز عبور 6 کاراکتری را کپی کنید.
  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 Google LLC
ابزارهای acurl و get_token به‌عنوان «نرم‌افزار» تحت توافقنامه حاکم بر استفاده شما از پلتفرم Google Cloud، از جمله شرایط خاص سرویس موجود در https://cloud.google.com/terms/service-terms ، در دسترس هستند.