درک نقاط پایانی OAuth

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

برای انجام وظیفه خود به عنوان یک سرور احراز هویت OAuth2، Apigee Edge باید نقاط پایانی را در دسترس قرار دهد که کلاینت‌ها بتوانند توکن‌ها و کدهای احراز هویت را درخواست کنند. این مبحث مقدمه‌ای سریع بر این نقاط پایانی ارائه می‌دهد و نحوه تنظیم آنها را در Edge به شما نشان می‌دهد.

نقطه پایانی OAuth2 چیست؟

یک نقطه پایانی OAuth2 یک URL است که کلاینت‌ها برای درخواست توکن‌های OAuth (یا کدهای احراز هویت) آن را فراخوانی می‌کنند. در اینجا یک نمونه درخواست برای یک توکن دسترسی آورده شده است:

$ curl -i -H 'ContentType: x-www-form-urlencoded' \
-X POST 'https://docs-test.apigee.net/oauth/client_credential/accesstoken' \
-d 'grant_type=client_credentials' \
-H 'Authorization: Basic c3FIOG9vSGV4VHo4QzAySVg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ'

در محیط Apigee Edge شما، برای مدیریت این نوع درخواست، به یک سیاست (Policy) نیاز است. همانطور که از درخواست می‌توان استنباط کرد، این سیاست باید از نوع اعطای "client credentials" پشتیبانی کند و این سیاست باید در مسیر /oauth/client_credentials/accesstoken اجرا شود.

سیاست صحیح در این مورد، سیاست OAuthV2 است که برای اجرا در جریانی مانند مثال زیر پیکربندی شده است (که در آن نام سیاست GenerateAccessTokenClient است):

        <Flow name="AccessTokenClientCredential">
            <Description/>
            <Request>
                <Step>
                    <FaultRules/>
                    <Name>GenerateAccessTokenClient</Name>
                </Step>
            </Request>
            <Response/>
            <Condition>(proxy.pathsuffix MatchesPath &quot;/accesstoken&quot;) and (request.verb = &quot;POST&quot;)</Condition>
        </Flow>

اگر کلاینت اطلاعات احراز هویت صحیح را ارائه دهد، این سیاست یک توکن تولید و برمی‌گرداند؛ در غیر این صورت، خطا برمی‌گرداند.

پیدا کردن نقاط پایانی پیش‌فرض

شرکت Apigee به طور پیش‌فرض، یک پروکسی نقطه پایانی OAuth2 نمونه را به هر سازمان جدیدی که ایجاد می‌کند اضافه می‌کند. اگر نگاه کنید، یک پروکسی به نام oauth در سازمان خود پیدا خواهید کرد.

برای پیدا کردن این پروکسی:

  1. همانطور که در زیر توضیح داده شده است، به صفحه API Proxies دسترسی پیدا کنید.

    لبه

    برای دسترسی به صفحه API Proxies با استفاده از رابط کاربری Edge:

    1. وارد apigee.com/edge شوید.
    2. در نوار ناوبری سمت چپ، گزینه‌ی Develop > API Proxies را انتخاب کنید.
    3. روی +پروکسی کلیک کنید

    لبه کلاسیک (ابر خصوصی)

    برای دسترسی به صفحه API Proxies با استفاده از رابط کاربری کلاسیک اج:

    1. وارد آدرس http:// ms-ip :9000 شوید، که در آن ms-ip آدرس IP یا نام DNS گره سرور مدیریت است.
    2. در نوار پیمایش بالا، APIها > API Proxies را انتخاب کنید.
  2. در لیست پروکسی‌ها، موردی به نام oauth را انتخاب کنید.
  3. در صفحه مرور پروکسی، برگه «توسعه» را انتخاب کنید تا ویرایشگر پروکسی نمایش داده شود و سیاست‌ها و جریان‌های موجود در پروکسی را بررسی کنید.

بهترین روش: پروکسی نقطه پایانی OAuth2 خودتان را ایجاد کنید

پروکسی پیش‌فرض oauth محدود است: فقط از نوع اعطای اعتبارنامه‌های کلاینت پشتیبانی می‌کند. این پروکسی فقط برای مثال در نظر گرفته شده است. برای محیط عملیاتی، شما باید یک پروکسی ایجاد کنید که نقاط پایانی OAuth2 را مطابق با نیازهای شما پیکربندی کند.

یک نکته مهم: پروکسی که نقاط پایانی OAuth2 را تعریف می‌کند، معمولاً یک پروکسی بدون هدف است. پروکسی به عنوان سرویسی عمل می‌کند که در ProxyEndpoint اجرا می‌شود و مستقیماً به کلاینت برمی‌گردد.

مباحث مرتبط

درخواست توکن‌های دسترسی و کدهای مجوز