درباره acurl و get_token

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

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

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

هر دوی این ابزارها اعتبارنامه‌های حساب Apigee شما (نام کاربری و گذرواژه، یا گذرنویسه) را با کدهای OAuth2 معاوضه می‌کنند.

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

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

نصب acurl و get_token

‫Apigee فایل ZIP حاوی acurl^(۱)، get_token^(۱)، و دستورگان نصب ارائه می‌دهد.

برای نصب 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 مکان فایل‌های اجرایی را مشخص می‌کند. اگر این گزینه را مشخص نکنید، نوشتار نصب ابزارها را در /usr/local/bin نصب می‌کند.

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

       acurl -h
       get_token -h

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

انقضای کد

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

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

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

تنظیم نقطه پایان 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

• مشتریان «ابر خصوصی»، برای دریافت نقطه پایانی SSO مناسب با سرپرستتان تماس بگیرید.

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

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

برای دریافت گذرنویسه یک‌بارمصرف:

1. نشانی وب زیر را در مرورگر وارد کنید:
   • برای مشتریان Cloud بدون منطقه:

     https://login.apigee.com/passcode

   • برای مشتریان Cloud با منطقه:

     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

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