ضبط سياسة OAuthV2Info

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X. info

الأدوات المستخدمة

تسمح لك هذه السياسة بإضافة سمات مخصّصة مرتبطة برمز دخول أو تعديلها. قد تتضمّن السمات المخصّصة عناصر مثل اسم القسم أو رقم تعريف العميل أو معرّف الجلسة. راجِع أيضًا تخصيص الرموز المميّزة و رموز التفويض.

يمكنك فقط إضافة سمات مخصّصة أو تعديلها. لا يمكنك استخدام هذه السياسة لتغيير حقول مثل النطاق أو الحالة أو 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">

يصف الجدول التالي السمات المشتركة بين جميع العناصر الرئيسية للسياسة:

&lt;DisplayName&gt; عنصر

استخدِمه مع السمة 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
• تخصيص الرموز المميّزة ورموز التفويض