ضبط سياسة OAuthV2Info

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

المزايا

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

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

&lt;AccessToken&gt; عنصر

تحدد المتغير الذي يوجد فيه رمز الدخول. على سبيل المثال، إذا كان رمز الدخول هو مرفقًا بطلب الرسالة كمعلمة طلب البحث، حدد request.queryparam.access_token يمكنك استخدام أي متغير صالح يشير إلى الرمز المميز. أو، قد يمر في سلسلة الرمز المميز الحرفي (حالة نادرة).

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

السمات

&lt;Attributes&gt; عنصر

مجموعة من السمات في الملف الشخصي لرمز الدخول سيتم تعديلها أو زيادتها.

&lt;Attributes&gt;/&lt;Attribute&gt; عنصر

سمة فردية مطلوب تعديلها.

تحدد سمة الاسم السمة المخصصة للملف الشخصي لرمز الدخول الذي سيتم تحديده تحديث. يوضّح هذا المثال كيفية استخدام قيمة متغيّر مُشار إليها وقيمة ثابتة.

  <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). يمكنك الرجوع إلى مخططات السياسات المتوفرة على جيت هب.

مرجع الخطأ

يصف هذا القسم رموز الخطأ ورسائل الخطأ التي يتم عرضها ومتغيرات الأخطاء التي تم ضبطها من خلال 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 الرئيسية
• تخصيص الرموز المميّزة ورموز التفويض