فرایند تولید کد دسترسی را خودکارسازی کنید

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

وقتی از SAML با Edge API استفاده می‌کنید، فرایندی که برای دریافت دسترسی OAuth2 و کدهای بازآوری از ادعای SAML استفاده می‌کنید، جریان گذرکد نامیده می‌شود. با جریان گذرنویسه، از مرورگر برای دریافت گذرنویسه یک‌بارمصرف استفاده می‌کنید و سپس از آن برای دریافت نشان‌های OAuth2 استفاده می‌کنید.

بااین‌حال، محیط شما ممکن است از خودکارسازی برای تکالیف توسعه رایج، مثل خودکارسازی آزمایش یا «ادغام مداوم/استقرار مداوم» (CI/CD) پشتیبانی کند. برای خودکارسازی این وظایف وقتی SAML فعال است، باید راهی برای دریافت و بازآوری نشان‌های OAuth2 بدون نیاز به کپی/جای‌گذاری گذررمز از مرورگر داشته باشید.

درباره کاربران ماشین

‫Apigee Edge از کاربران ماشین در سازمان دارای SAML شما پشتیبانی می‌کند. از کاربران ماشین صرفاً برای خودکارسازی استفاده می‌شود و انسان‌ها مستقیماً به آن‌ها دسترسی ندارند.

کاربر ماشین می‌تواند بدون نیاز به تعیین رمز عبور، کدهای OAuth2 را دریافت کند. این یعنی می‌توانید فرایند دریافت و بازآوری کدهای OAuth2 را بااستفاده از Edge API کاملاً خودکارسازی کنید.

مراحل خودکارسازی فرایند تولید رمز

برای خودکارسازی کردن فرایند تولید کد:

مرحله شرح
1 ایجاد کاربر ماشین در منطقه هویت SAML
2 اختصاص دادن نقش‌های موردنیاز به کاربر ماشین در سازمان Edge
3 دریافت کدهای OAuth2 کاربران ماشین

ویدیو: ویدیو کوتاهی را تماشا کنید تا با نحوه خودکارسازی دسترسی به Apigee Edge APIs بااستفاده از اطلاعات اعتباری کاربر ماشین آشنا شوید.

مدیریت کاربران ماشین برای مناطق هویت SAML

‫Apigee میانای خط فرمان (CLI) مدیریت کاربر ماشین را برای ایجاد و مدیریت حساب‌های کاربر ماشین ارائه می‌دهد. مراحل استفاده از CLI مدیریت کاربر ماشین در بخش‌های زیر توضیح داده شده است.

استفاده از CLI

برای استفاده از CLI مدیریت کاربر ماشین، ابتدا فایل زیر را بارگیری و از حالت فشرده خارج کنید: usermgmt.tar.gz(۱)

قالب فراخوانی «واسط خط فرمان» به‌صورت زیر است:

usermgmt_platform [command] [flags]

جدول زیر پلاتفرم‌های پشتیبانی‌شده و فرمان مربوطه برای فراخوانی «خط فرمان مدیریت کاربر ماشین» را خلاصه می‌کند. (فایل‌های اجرایی در دایرکتوری usermgmt قرار دارند.)

پلاتفرم ‫۳۲ بیتی ‫۶۴ بیتی
Linux usermgmt_linux_386 usermgmt_linux_amd64
Mac usermgmt_darwin_386 usermgmt_darwin_amd64
Windows usermgmt_windows_386 usermgmt_windows_amd64

جدول زیر فرمان‌هایی را که می‌توان مشخص کرد خلاصه می‌کند.

فرمان اطلاعات بیشتر
create ایجاد کاربر ماشین در منطقه هویت
delete حذف کاربر ماشین در منطقه هویت
help دریافت راهنمایی برای استفاده از CLI
list فهرست کردن همه کاربران ماشین در منطقه هویت
reset بازنشانی گذرواژه کاربر ماشین در منطقه هویت

درصورت تمایل، می‌توانید یکی از پرچم‌های زیر را برای نمایش راهنمایی درباره فرمان مشخص‌شده ارسال کنید: -h یا --help

وارد شدن به سیستم CLI

اولین‌باری که در یک دوره ۲۴ ساعته «خط فرمان» را اجرا می‌کنید، از شما خواسته می‌شود اطلاعات اعتباری حساب zoneadmin خود را وارد کنید.

Enter your Apigee credentials
Username: zoneadmin-username
Password: zoneadmin-password
If your user is opted with MFA, enter MFA code. Otherwise press enter to skip.
MFA: mfa-code_or_enter_to_skip

«میانای خط فرمان مدیریت کاربر ماشین» یک کد دسترسی را در ماشین محلی شما ذخیره می‌کند تا فقط یک‌بار در هر دوره ۲۴ ساعته به سیستم وارد شوید.

دریافت راهنمایی برای استفاده از CLI

بااستفاده از فرمان usermgmt_platform help، اطلاعات استفاده از CLI را نمایش دهید. برای فهرست پلاتفرم‌های پشتیبانی‌شده، استفاده از CLI را ببینید.

usermgmt_platform help

اطلاعات راهنمایی زیر نمایش داده می‌شود:

A command-line interface (CLI) to manage machine user accounts to automate
Apigee identity zone management. Use the CLI to create, list, delete,
and reset the password for machine users.

Usage:
  usermgmt [flags]
  usermgmt [command]

Available Commands:
  create  Creates a machine users in an identity zone.
  delete  Deletes a machine users in an identity zone.
  help    Help about any command
  list    Lists the machine users in an identity zone.
  reset   Resets the password for a machine user in an identity zone.

Flags:
  -h, --help               help for usermgmt

Use "usermgmt [command] --help" for more information about a command.

با ارسال هم فرمان و هم پرچم -h یا --help در خط فرمان، راهنمایی درباره فرمان خاصی نمایش داده می‌شود.

برای مثال، برای دریافت راهنمایی درباره فرمان فهرست:

usermgmt_platform list -h

اطلاعات راهنمایی زیر نمایش داده می‌شود:

Lists the machine users in an identity zone.

Usage:
  usermgmt list [flags]

Flags:
  -h, --help   help for list

ایجاد کاربر ماشین در منطقه هویت

کاربر ماشینی را در منطقه هویت بااستفاده از دستور usermgmt_platform create ایجاد کنید. برای فهرست پلاتفرم‌های پشتیبانی‌شده، استفاده از CLI را ببینید.

  1. فرمان زیر را وارد کنید:
    usermgmt_platform create

    فهرست مناطق هویت نمایش داده می‌شود:

    myzone1
    myzone2
  2. نام منطقه‌ای را در پیام‌واره وارد کنید:
    Enter a zone name: myzone1
  3. نام کاربری برای کاربر ماشین وارد کنید:
    Create a Machine User
    Username: machineuser1@mycompany.com
  4. گذرواژه‌ای برای کاربر ماشین وارد کنید. وقتی درخواست شد، گذرواژه را دوباره وارد کنید.
    Password: password
    Re-enter password: password 

    کاربر ایجاد می‌شود.

    Created machine user machineuser1@mycompany.com

فهرست کردن همه کاربران ماشین در یک منطقه هویت

بااستفاده از دستور usermgmt_platform list، همه کاربران ماشین را در منطقه هویت فهرست کنید. برای فهرست پلاتفرم‌های پشتیبانی‌شده، استفاده از CLI را ببینید.

  1. فرمان زیر را وارد کنید:
    usermgmt_platform list
    فهرست مناطق هویت نمایش داده می‌شود:
    myzone1
    myzone2
  2. نام منطقه‌ای را در پیام‌واره وارد کنید:
    Enter a zone name: myzone1

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

    Machine users in the zone:
    machineuser1@mycompany.com
        

بازنشانی گذرواژه کاربر ماشین در منطقه هویت

گذرواژه کاربر ماشین را در منطقه هویت بااستفاده از فرمان usermgmt_platform reset بازنشانی کنید. برای فهرست پلاتفرم‌های پشتیبانی‌شده، استفاده از CLI را ببینید.

  1. فرمان زیر را وارد کنید:
    usermgmt_platform reset

    فهرست مناطق هویت نمایش داده می‌شود:

    myzone1
    myzone2
  2. نام منطقه‌ای را در پیام‌واره وارد کنید:
    Enter a zone name: myzone1
  3. نام کاربری کاربر ماشین را که می‌خواهید گذرواژه آن را بازنشانی کنید وارد کنید:
    Reset User Password
    Enter the username for the machine user
    Username: machineuser1@mycompany.com
  4. گذرواژه جدیدی برای کاربر ماشین وارد کنید. وقتی درخواست شد، گذرواژه را دوباره وارد کنید.
    Enter the new password: password
    Re-enter password: password

    گذرواژه بازنشانی می‌شود.

    Reset password for machine user machineuser1@mycompany.com

حذف کاربر ماشین در منطقه هویت

کاربر ماشین را در منطقه هویت بااستفاده از فرمان usermgmt_platform delete حذف کنید. برای فهرست پلاتفرم‌های پشتیبانی‌شده، استفاده از CLI را ببینید.

  1. فرمان زیر را وارد کنید:
    usermgmt_platform delete
    فهرست مناطق هویت نمایش داده می‌شود:
    myzone1
    myzone2
  2. نام منطقه‌ای را در پیام‌واره وارد کنید:
    Enter a zone name: myzone1
  3. نام کاربری کاربر ماشین را که می‌خواهید حذف کنید وارد کنید:
    Delete User
    Enter the username for the machine user
    Username: machineuser1@mycompany.com 

    کاربر ماشین حذف می‌شود.

    Deleted user machineuser1@mycompany.com

نقش‌های موردنیاز را به کاربر ماشین در سازمان Edge خود اختصاص دهید

بااستفاده از واسط کاربر، کاربر ماشین را به سازمان Edge دارای SAML اضافه کنید و نقش‌های موردنیاز (مثل سرپرست سازمان) را به آن اختصاص دهید، همان‌طور که در افزودن کاربران توضیح داده شده است.

دریافت کدهای OAuth2 کاربر ماشین

می‌توانید فرایند تولید کد دسترسی را خودکارسازی کنید و با acurl(۱) و get_token(۱) ابزارهای کمکی، همان‌طور که در OAuth2 برای کاربران ماشین و کاربران ماشین در مناطق SAML توضیح داده شده است، ذخیره کد دسترسی برای کاربران ماشین را مدیریت کنید.

برای دریافت دستی کدهای OAuth2 کاربر ماشین با curl:

  1. از ابزار کدبندی نشانی وب ترجیحی خود برای کدبندی نام کاربری و گذرواژه کاربر ماشین استفاده کنید.

    هشدار: از ابزار کدبندی نشانی وب داخلی استفاده کنید تا مطمئن شوید اعتبارنامه‌های کاربر ماشین به‌خطر نمی‌افتد.

  2. با فراخوانی نقطه پایان کد SAML، که در مثال زیر نشان داده شده است، کدهای دسترسی و بازآوری اولیه را تولید کنید:
    curl -H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" \
      -H "accept: application/json;charset=utf-8" \
      -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \
      https://zoneName.login.apigee.com/oauth/token -s \
      -d 'grant_type=password&username=machineusername&password=machineuserpassword'

    برای صدور مجوز، اعتبارنامه کارخواه OAuth2 رزروشده، ZWRnZWNsaTplZGdlY2xpc2VjcmV0، را در سرصفحه Authorization ارسال کنید. این فراخوانی کدهای دسترسی و بازآوری را در stdout چاپ می‌کند.

  3. گذراندن کد دسترسی به تماس با Edge management API به‌عنوان سرصفحه حامل:
    curl -H "Authorization: Bearer ACCESS_TOKEN" \
      https://api.enterprise.apigee.com/v1/organizations/orgName
  4. وقتی کد دسترسی منقضی می‌شود، می‌توانید آن را با ارسال کد بازآوری به نقطه پایان کد SAML بازآوری کنید، همان‌طور که در مثال زیر نشان داده شده است:
    curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" \
      -H "Accept: application/json;charset=utf-8" \
      -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \
      https://zoneName.login.apigee.com/oauth/token \
      -d 'grant_type=refresh_token&refresh_token=REFRESH_TOKEN'

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