ایجاد نقش‌ها با API

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

این موضوع درباره نحوه ایجاد نقش‌های سفارشی و اختصاص دادن نقش‌ها به کاربران ازطریق میانای برنامه‌سازی کاربردی مدیریت بحث می‌کند. همچنین نحوه آزمایش واگذاری نقش‌ها ازطریق میانای برنامه‌سازی کاربردی را نشان می‌دهیم. (برای نمای کلی نقش‌های سفارشی، ایجاد نقش‌های سفارشی در واسط کاربر را ببینید.)

درباره تنظیم اجازه

اجازه‌های نقش در URIهای میانای برنامه‌سازی کاربردی مدیریت (نه URIهای واسط کاربری مدیریت) تنظیم می‌شوند. برای مثال، اگر می‌خواهید اجازه‌های PUT،‏ GET، و/یا DELETE را برای نهادهای توسعه‌دهنده نرم‌افزار در سازمان Edge خود تنظیم کنید، اجازه‌ها را در منبع /developers تنظیم می‌کنید، زیرا مسیر Management API برای توسعه‌دهندگان https://api.enterprise.apigee.com/v1/organizations/{org_name}/developers است. (هنگام تعریف اجازه‌ها، نیازی نیست بخش سازمان را در مسیر اضافه کنید، زیرا اجازه‌ها به سازمان خاصی محدود می‌شوند، همان‌طور که فراخوانی‌های Management API در این موضوع نشان می‌دهند.)

همچنین می‌توانید برای نهادهای خاصی اجازه تنظیم کنید. برای مثال:

  • اگر می‌خواستید اجازه‌ها را برای یک توسعه‌دهنده تنظیم کنید، آن‌ها را برای /developers/steve@example.com تنظیم کنید
  • برای محصول API خاصی، مثل free-api-product، آن‌ها را در /apiproducts/free-api-product تنظیم کنید
  • برای نگاشت مقدار کلید در محیطی خاص، اجازه را روی چیزی مثل /environments/test/keyvaluemaps/fooMap، یا /environments/test/keyvaluemaps/* برای همه نگاشت‌های مقدار کلید در محیط آزمایش تنظیم می‌کنید.

اجازه‌هایی که بااستفاده از API تنظیم می‌کنید:

  • به کاربران دارای نقش سفارشی اجازه می‌دهد براساس اجازه‌هایشان، فراخوانی‌های API مدیریت انجام دهند. برای مثال، اگر نقشی اجازه دسترسی فقط خواندنی به همه پراکسی‌های API را بدهد، کاربری که آن نقش را دارد می‌تواند از API فهرست کردن پراکسی‌های API استفاده کند اما نمی‌تواند از API ایجاد کردن پراکسی API استفاده کند.
  • تعیین کنید که کاربران در نقش سفارشی چه چیزهایی را می‌توانند در واسط کاربر مدیریت ببینند و انجام دهند. برای مثال، دسترسی فقط خواندنی به پراکسی‌های میانای برنامه‌سازی کاربردی، دسترسی به دکمه‌های «+پراکسی میانای برنامه‌سازی کاربردی» و «حذف» را در صفحه «پراکسی‌های میانای برنامه‌سازی کاربردی» غیرفعال می‌کند.

برای دیدن منابع و مسیرهایی که می‌توانید برای آن‌ها اجازه تنظیم کنید، مرجع میانای برنامه‌سازی کاربردی مدیریت را در نشانی‌های وب منابع مختلف بررسی کنید.

برای اطلاعات مرجع کامل درباره مدیریت نقش، به میانای برنامه‌سازی کاربردی نقش‌های کاربر مراجعه کنید.

نحو و تقدم

می‌توانید از نویسه عام ستاره (*) برای نشان دادن «همه موارد بعداز» در تنظیمات اجازه استفاده کنید. بااین‌حال، اگر اجازه‌ها را فقط در منبع اصلی (مثلاً در /developers) تنظیم کنید و اجازه‌های خاص‌تری (مثلاً /developers/*) تنظیم نکنید، این اجازه برای همه موارد از /developers و بعداز آن اعمال می‌شود.

PUT همچنین به‌عنوان POST در اجازه‌ها عمل می‌کند.

می‌توانید اجازه‌های کلی را با اجازه‌های جزئی‌تر در منابع ترکیب کنید. تنظیمات جزئی‌تر در مواردی که هم‌پوشانی اجازه‌ها وجود دارد، اولویت دارند. برای مثال، فرض کنید اجازه‌های زیر برای نقش «developeradmin» تنظیم شده است:

  • PUT on /developers
  • GET on /developers/*

این یعنی توسعه‌دهنده/سرپرست می‌تواند:

  • توسعه‌دهنده ایجاد کند، اما هیچ توسعه‌دهنده خاص یا نهاد فرعی را به‌روز نکند (به‌دلیل اجازه GET خاص‌تر در آن مسیر).
  • دریافت هر توسعه‌دهنده یا نهاد فرعی، اما نه دریافت فهرست همه توسعه‌دهندگان.

برای مشاهده فهرست کامل اجازه‌هایی که می‌توانید با API تنظیم کنید، مرجع اجازه‌ها را ببینید.

ایجاد نقش سفارشی جدیدی به‌نام «توسعه»

نقش «توسعه» ایجاد کنید تا توسعه‌دهندگان بتوانند پراکسی‌های میانای برنامه‌سازی کاربردی را مشاهده، ایجاد، و به‌روزرسانی کنند.

$ curl -u email:password https://api.enterprise.apigee.com/v1/o/{org_name}/userroles -H "Content-type:application/json" -X POST -d'{ "role" : [ { "name" : "development" } ] }'

افزودن اجازه‌ها به نقش توسعه

اجازه‌هایی که می‌توان برای کل گروهی از مصنوعات Edge (مانند همه /apps،‏ /apis،‏ /apiproducts، و غیره) و همچنین برای مصنوعات جداگانه (مانند یک برنامه خاص، پراکسی میانای برنامه‌سازی کاربردی، یا محصول میانای برنامه‌سازی کاربردی) تنظیم کرد عبارت‌اند از GET،‏ PUT، و DELETE.

GET به کاربران امکان می‌دهد هر میانای برنامه‌سازی کاربردی‌ای را مشاهده کنند، ازجمله فایل‌های پیکربندی میانای برنامه‌سازی کاربردی پراکسی، خط‌مشی‌های مرتبط، جاوا اسکریپت، فایل‌های XSLT، و غیره. اجازه PUT در میاناهای برنامه‌سازی کاربردی به توسعه‌دهندگان امکان می‌دهد پروکسی‌های میانای برنامه‌سازی کاربردی را ایجاد، اصلاح، وارد، صادر، مستقر، و لغو استقرار کنند.

ویژگی مسیر، مصنوعاتی را که اجازه‌ها را برایشان تنظیم می‌کنید مشخص می‌کند. برای مثال، ‎/applications،‏ ‎/apps،‏ ‎/apiproducts،‏ ‎/developers، یا ‎/reports.

curl -u email:password https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/development/permissions -H "Content-type:application/json" -X POST -d'{"path" : "/applications","permissions" : [ "put", "get" ]}'

Create a role: testing

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

$ curl -u email:password https://api.enterprise.apigee.com/v1/o/{org_name}/userroles -H "Content-type:application/json" -X POST -d'{ "role" : [ { "name" : "testing" } ] }'

افزودن اجازه‌ها به نقش آزمایشی

GET به کاربران امکان می‌دهد هر میانای برنامه‌سازی کاربردی‌ای را، ازجمله فایل‌های پیکربندی آن، و همچنین هرگونه خط‌مشی مرتبط، جاوا اسکریپت، فایل‌های XSLT، و غیره را مشاهده کنند. با افزودن این اجازه به نقش «آزمایش»، به مهندسان کیفیت امکان می‌دهیم محتوای میاناهای برنامه‌سازی کاربردی را که آزمایش می‌کنند مشاهده کنند. بااین‌حال، کاربران دارای این نقش نمی‌توانند پراکسی‌های میانای برنامه‌سازی کاربردی را ایجاد، اصلاح، وارد، صادر، مستقر، و لغو استقرار کنند.

$ curl -u email:password https://api.enterprise.apigee.com/v1/o/{org_name}/userroles/testing/permissions -H "Content-type:application/json" -X POST -d'{"path" : "/applications","permissions" : [ "get" ]}'

برای نصب Edge در محل، حداقل مجموعه اجازه‌هایی که باید تنظیم شود تا کاربر بتواند به میانای کاربری Edge وارد شود عبارتند از:

{"path" : "/","permissions" : [ "get" ]}
{"path" : "/*","permissions" : [ ]}
{"path" : "/environments","permissions" : [ "get" ]}
{"path" : "/userroles","permissions" : [ "get" ]}

برای تنظیم این اجازه‌ها، از فرمان cURL زیر استفاده کنید:

curl -H "Content-Type:application/json" -u email:password \
-X POST \
http://<ms-IP>:8080/v1/organizations/{org_name}/userroles/testing/resourcepermissions  \
-d '{
 "resourcePermission" : [ 
   {
    "path" : "/",
    "permissions" : [ "get" ]
   }, 
{
    "path" : "/*",
    "permissions" : []
   },
{
    "path" : "/environments",
    "permissions" : [ "get" ]
   },
   {
    "path" : "/userroles",
    "permissions" : [ "get"]
   }
  ]
}'

که <ms-IP> نشانی IP یا نام DNS مربوط به Edge Management Server است.

افزودن کاربر به نقش آزمایشی

برای تأمین کاربر با نقش کاربر:

$ curl -u email:password https://api.enterprise.apigee.com/v1/o/{org_name}/users/justauser@apigee.com/userroles -H "Content-type:application/json" -X POST -d'{"role" : [ {"name" : "testing"} ] }'

مشاهده میاناهای برنامه‌سازی کاربردی به‌عنوان کاربر

جعل هویت کاربر و درخواست از سرویس‌های API برای مشاهده پراکسی‌های API. کاربر باید بتواند میاناهای برنامه‌سازی کاربردی را به‌همراه محتوایشان مشاهده کند.
$ curl -u justauser@apigee.com:secret https://api.enterprise.apigee.com/v1/o/{org_name}/apis
$ curl -u justauser@apigee.com:secret https://api.enterprise.apigee.com/v1/o/{org_name}/apis/{api_name}/policies

ایجاد میانای برنامه‌سازی کاربردی به‌عنوان کاربر در نقش آزمایشی

جعل هویت کاربر و درخواست از «سرویس‌های میانای برنامه‌سازی کاربردی» برای ایجاد پراکسی میانای برنامه‌سازی کاربردی. درخواست توسط «سرویس‌های میانای برنامه‌سازی کاربردی» رد خواهد شد، زیرا نقش «آزمایش» به کاربر اجازه نمی‌دهد «میانای برنامه‌سازی کاربردی» ایجاد کند.

$ curl -u justauser@apigee.com:secret -H "Content-Type: application/json" https://api.enterprise.apigee.com/v1/o/{org_name}/apis -X POST -d'{"name" : "rbacTestApi"}'

افزودن کاربر به نقش توسعه‌دهنده

اکنون کاربر را با نقش «توسعه» تأمین کنید.

$ curl -u email:password https://api.enterprise.apigee.com/v1/o/{org_name}/users/justauser@apigee.com/userroles -H "Content-type:application/json" -X POST -d'{"role" : [ {"name" : "development"} ] }'

ایجاد میانای برنامه‌سازی کاربردی به‌عنوان کاربر در نقش توسعه‌دهنده

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

$ curl -u justauser@apigee.com:secret -H "Content-Type: application/json" https://api.enterprise.apigee.com/v1/o/{org_name}/apis -X POST -d'{"name" : "rbacTestApi"}'

دریافت نقش‌های کاربر برای یک کاربر

به‌عنوان سرپرست سازمان، می‌توانید فهرست نقش‌های کاربری را برای کاربر (در همه سازمان‌ها) در هرزمانی بررسی کنید:

$ curl -u email:password -X GET https://api.enterprise.apigee.com/v1/users/justauser@apigee.com/userroles