ضبط سياسة OAuthV2Info

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

الموضوع

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

يمكنك فقط إضافة السمات المخصّصة أو تعديلها. لا يمكنك استخدام هذه السياسة لتغيير حقول مثل النطاق أو الحالة أوexpiration_in أو developer_email أو client_id أو org_name أو rename_count. في حال توفُّر سمة من قبل، تعدِّلها هذه السياسة. وإذا لم يكن متوفّرًا، تضيفه السياسة. ويجب أن يكون رمز الدخول المشار إليه صالحًا ومتوفّرًا في حالة الموافقة عليه.

عيّنات

مثال أساسي

في ما يلي مثال على سياسة يتم استخدامها لتعديل رمز دخول OAuth 2.0. يحدّد المثال أدناه موقع رمز الدخول في رسالة الطلب من خلال البحث عن مَعلمة طلب بحث تُسمى access_token. عندما يقدّم تطبيق عميل رمز الدخول، ستحدّد السياسة أدناه رمز الدخول في مَعلمة طلب البحث. وسيتم بعد ذلك تعديل الملف الشخصي الخاص برمز الدخول. ويعمل هذا الربط على إضافة سمة مخصّصة باسم department.id إلى الملف الشخصي.

<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">

يوضِّح الجدول التالي السمات الشائعة لجميع العناصر الرئيسية للسياسة:

السمة الوصف تلقائي التواجد في المنزل
name

الاسم الداخلي للسياسة وقد تحتوي قيمة السمة name على أحرف وأرقام ومسافات وواصلات وشرطات سفلية ونقاط. لا يمكن أن تتجاوز هذه القيمة 255 حرفًا.

ويمكنك اختياريًا استخدام العنصر <DisplayName> لتصنيف السياسة في محرِّر الخادم الوكيل لواجهة المستخدم الإدارية باستخدام اسم مختلف للغة طبيعية.

لا ينطبق مطلوبة
continueOnError

اضبط القيمة على false لعرض رسالة خطأ عند تعذُّر تنفيذ السياسة. وهو سلوك متوقّع لمعظم السياسات.

اضبط القيمة على true لمواصلة تنفيذ التدفق حتى بعد تعذُّر تنفيذ السياسة.

false إجراء اختياري
enabled

اضبط القيمة على true لفرض السياسة.

اضبط القيمة على false من أجل إيقاف السياسة. ولن يتم فرض السياسة حتى إذا ظلت مرتبطة بمسار.

صحيح إجراء اختياري
async

تم إيقاف هذه السمة نهائيًا.

false منهي العمل به

العنصر <DisplayName>

استخدِم هذه السمة بالإضافة إلى السمة name لتصنيف السياسة في محرِّر الخادم الوكيل لواجهة المستخدم الإدارية باستخدام اسم مختلف بلغة طبيعية.

<DisplayName>Policy Display Name</DisplayName>
تلقائي

لا ينطبق

إذا لم تستخدم هذا العنصر، سيتم استخدام قيمة السمة name الخاصة بالسياسة.

التواجد في المنزل إجراء اختياري
Type سلسلة

عنصر <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.

مرجع الخطأ

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.

Fault code HTTP status Cause
steps.oauth.v2.access_token_expired 500 The access token sent to the policy is expired.
steps.oauth.v2.invalid_access_token 500 The access token sent to the policy is invalid.
steps.oauth.v2.InvalidAPICallAsNoApiProductMatchFound 401 Please see this Apigee Community post for information about troubleshooting this error.

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.

Variables Where Example
fault.name="fault_name" fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code. fault.name = "invalid_access_token"
oauthV2.policy_name.failed policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.failed = true
oauthV2.policy_name.fault.name policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.fault.name = invalid_access_token
oauthv2.policy_name.fault.cause policy_name is the user-specified name of the policy that threw the fault. oauthV2.SetTokenInfo.cause = Invalid Access Token

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>

مواضيع ذات صلة