خط مشی SetOAuthV2Info

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

چی

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

شما فقط می توانید ویژگی های سفارشی را اضافه یا تغییر دهید. شما نمی توانید از این خط مشی برای تغییر فیلدهایی مانند scope، status، 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>

یک ویژگی فردی برای به روز رسانی.

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

  <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 در دسترس هستند.

مرجع خطا

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Deployment errors

Refer to the message reported in the UI for information about deployment errors.

Fault variables

These variables are set when this policy triggers an error at runtime.

Example error response

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

Example fault rule

<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
• سفارشی کردن توکن ها و کدهای مجوز