خط‌مشی SetOAuthV2Info

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

چه

به شما امکان می‌دهد مشخصه‌های سفارشی مرتبط با یک کد دسترسی را اضافه یا به‌روز کنید. مشخصه‌های سفارشی ممکن است شامل مواردی مثل نام بخش، شناسه مشتری، یا شناسه جلسه باشد. همچنین سفارشی‌سازی نشان‌ها و کدهای مجوز را ببینید.

فقط می‌توانید مشخصه‌های سفارشی را اضافه یا اصلاح کنید. نمی‌توانید از این خط‌مشی برای تغییر فیلدهایی مثل محدوده، وضعیت، expires_in،‏ developer_email،‏ client_id،‏ org_name، یا refresh_count استفاده کنید. اگر صفت ازقبل وجود داشته باشد، این خط‌مشی آن را به‌روز می‌کند. اگر وجود نداشته باشد، خط‌مشی آن را اضافه می‌کند. توکن دسترسی ارجاع‌شده باید معتبر و در وضعیت تأییدشده باشد.

نمونه‌ها

<SetOAuthV2Info name="SetOAuthV2Info"> 
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
  </Attributes>
</SetOAuthV2Info>

مرجع عنصر

مرجع عنصر، عناصر و مشخصه‌های خط‌مشی SetOAuthV2 را توصیف می‌کند.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="SetOAuthV2Info-1">    
    <DisplayName>Set OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref={some-variable}></AccessToken>
    <Attributes/>
</SetOAuthV2Info>
</xml>

مشخصه‌های <SetOAuthV2Info>

<SetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Set-OAuth-v20-Info-1">

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

عنصر <DisplayName>

علاوه بر ویژگی name برای برچسب‌گذاری خط‌مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و به زبان طبیعی، از آن استفاده کنید.

<DisplayName>Policy Display Name</DisplayName>

عنصر <AccessToken>

متغیری را که کد دسترسی در آن قرار دارد شناسایی می‌کند. برای مثال، اگر کد دسترسی به‌عنوان پارامتر پُرسمان به پیام درخواست پیوست شده است، request.queryparam.access_token را مشخص کنید. می‌توانید از هر متغیر معتبری که به نشان ارجاع می‌دهد استفاده کنید. یا می‌تواند رشته نشانه تحت‌اللفظی را ارسال کند (مورد نادر).

 <AccessToken ref="request.queryparam.access_token"></AccessToken>

مشخصه‌ها

عنصر <Attributes>

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

عنصر <Attributes>/<Attribute>

مشخصه فردی برای به‌روزرسانی.

مشخصه نام، دارایی سفارشی نمایه کد دسترسی را که باید به‌روز شود شناسایی می‌کند. این مثال نشان می‌دهد که چگونه از مقدار متغیر مرجع و مقدار ثابت استفاده کنید.

  <Attributes>
    <Attribute name="department.id" ref="request.queryparam.department_id"></Attribute>
    <Attribute name="foo">bar</Attribute>
  </Attributes>

مشخصه‌ها

متغیرهای جریان

درصورت موفقیت، متغیرهای جریان زیر تنظیم خواهد شد:

• oauthv2accesstoken.{policyName}.access_token
• oauthv2accesstoken.{policyName}.client_id
• oauthv2accesstoken.{policyName}.refresh_count
• oauthv2accesstoken.{policyName}.organization_name
• oauthv2accesstoken.{policyName}.expires_in //--in seconds
• oauthv2accesstoken.{policyName}.refresh_token_expires_in //--in seconds
• oauthv2accesstoken.{policyName}.issued_at
• oauthv2accesstoken.{policyName}.status
• oauthv2accesstoken.{policyName}.api_product_list
• oauthv2accesstoken.{policyName}.token_type
• oauthv2accesstoken.{policyName}.{custom_attribute_name}

طرح

هر نوع خط‌مشی با یک طرحواره XML (.xsd) تعریف می‌شود. برای مرجع، طرحواره‌های خط‌مشی در GitHub دردسترس است.

مرجع خطا

این بخش کدهای خطا و پیام‌های خطایی را که برگردانده می‌شوند و متغیرهای خطایی را که Edge هنگام راه‌اندازی خطا در این خط‌مشی تنظیم می‌کند شرح می‌دهد. این اطلاعات برای دانستن اینکه آیا قوانین خطا را برای مدیریت خطاها توسعه می‌دهید یا نه مهم است. برای کسب اطلاعات بیشتر، آنچه باید درباره خطاهای خط‌مشی بدانیدو رسیدگی به اشکالات را ببینید.

خطاهای زمان اجرا

این خطاها ممکن است هنگام اجرای خط‌مشی رخ دهند.

خطاهای استقرار

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

متغیرهای خطا

این متغیرها زمانی تنظیم می‌شوند که این خط‌مشی در زمان اجرا باعث بروز خطا شود.

نمونه پاسخ خطا

{
  "fault": {
    "faultstring": "Invalid Access Token",
    "detail": {
      "errorcode": "keymanagement.service.invalid_access_token"
    }
  }
}

قانون خطای نمونه

<FaultRule name=SetOAuthV2Info Faults">
    <Step>
        <Name>AM-InvalidTokenResponse</Name>
        <Condition>(fault.name = "invalid_access_token")</Condition>
    </Step>
    <Condition>(oauthV2.failed = true) </Condition>
</FaultRule>

موضوعات مرتبط

• خط‌مشی OAuthV2
• صفحه اصلی OAuth
• سفارشی‌سازی نشان‌ها و کدهای مجوز