سياسة GetOAuthV2Info

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

المزايا

الحصول على سمات رموز الدخول والرموز المميّزة لإعادة التحميل ورموز التفويض وتطبيق العميل وتملأ المتغيرات بقيم تلك السمات.

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

يجب أن يكون رمز الدخول الذي تسمح به لهذه السياسة صالحًا وإلا ستعرض السياسة خطأ واحد (invalid_access_token).

نماذج

تستخدم النماذج التالية سياسة الحصول على معلومات OAuth V2 لاسترداد معلومات حول لسير عمل OAuth2 ثم الوصول إلى تلك المعلومات من خلال التعليمات البرمجية.

<GetOAuthV2Info name="MyTokenAttrsPolicy">
  <AccessToken ref="request.queryparam.access_token"></AccessToken>
</GetOAuthV2Info>

var scope = context.getVariable('oauthv2accesstoken.MyTokenAttrsPolicy.scope');

<GetOAuthV2Info name="MyAuthCodeAttrsPolicy">
  <AuthorizationCode ref="request.formparam.code"></AuthorizationCode>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2authcode.MyAuthCodeAttrsPolicy.custom_attribute_name’);

<GetOAuthV2Info name="MyRefreshTokenAttrsPolicy">
  <RefreshToken ref="request.queryparam.refresh_token"/>
</GetOAuthV2Info>

var attr = context.getVariable(‘oauthv2refreshtoken.MyRefreshTokenAttrsPolicy.accesstoken.custom_attribute_name’);

<GetOAuthV2Info name="GetTokenAttributes">
  <AccessToken>shTUmeI1geSKin0TODcGLXBNe9vp</AccessToken>
</GetOAuthV2Info>

<GetOAuthV2Info name="GetClientAttributes">
  <ClientId ref="request.queryparam.client_id"></ClientId>
</GetOAuthV2Info>

context.getVariable("oauthv2client.GetClientAttributes.developer.email");
context.getVariable("oauthv2client.GetClientAttributes.developer.app.name");

مرجع العنصر

يصف مرجع العنصر عناصر سياسة GetOAuthV2Info وسماتها.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="GetOAuthV2Info-1"
    <DisplayName>Get OAuth v2.0 Info 1</DisplayName>
    <AccessToken ref="variable"></AccessToken>
    <AuthorizationCode ref="variable"></AuthorizationCode>
    <ClientId ref="variable"></ClientId>
    <RefreshToken ref="variable"></RefreshToken>
</GetOAuthV2Info>

<GetOAuthV2Info> السمات

<GetOAuthV2Info async="false" continueOnError="false" enabled="true" name="Get-OAuth-v20-Info-1">

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

&lt;DisplayName&gt; عنصر

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

<DisplayName>Policy Display Name</DisplayName>

&lt;AccessToken&gt; عنصر

يسترد الملف الشخصي لرمز الدخول. أنت تمرر إما متغير يحتوي على سلسلة رمز الدخول أو سلسلة رمز مميز حرفي (حالة نادرة). في هذا المثال، رمز الدخول هو من معلَمة طلب بحث تم تمريرها في طلب. استخدام <ignoreAccessTokenStatus> إذا كنت تريد عرض معلومات لرمز مميز تم إبطاله أو منتهي الصلاحية.

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

&lt;AuthorizationCode&gt; عنصر

يسترجع الملف الشخصي لرمز تفويض. أنت تمرر إما متغير يحتوي على سلسلة رمز المصادقة أو سلسلة رمز مميز حرفي (حالة نادرة). في هذا المثال، يكون رمز المصادقة من معلَمة طلب بحث تم تمريرها في طلب. بالنسبة إلى قائمة المتغيّرات التي تمت تعبئتها بواسطة يُرجى الاطّلاع على متغيّرات التدفق.

<AuthorizationCode ref="request.queryparam.authorization_code"></AuthorizationCode>

&lt;ClientId&gt; عنصر

يسترد المعلومات ذات الصلة بمعرّف عميل. في هذا المثال، يتم استرداد معرّف العميل من معلَمة طلب بحث تم تمريرها في الطلب. بالنسبة إلى قائمة المتغيرات التي تم ملؤها بهذه العملية، اطّلِع على متغيّرات التدفق.

<ClientId ref="request.queryparam.client_id"></ClientId>

&lt;IgnoreAccessTokenStatus&gt; عنصر

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

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

&lt;RefreshToken&gt; عنصر

يسترد الملف الشخصي للحصول على رمز مميز لإعادة التحميل. أنت تمرر إما متغير يحتوي على سلسلة الرمز المميز للتحديث أو سلسلة رمز مميز حرفي (حالة نادرة). في هذا المثال، الرمز المميز للتحديث هو من معلَمة طلب بحث تم تمريرها في طلب. بالنسبة إلى قائمة المتغيّرات التي تمت تعبئتها بواسطة يُرجى الاطّلاع على متغيّرات التدفق.

<RefreshToken ref="request.queryparam.refresh_token"></RefreshToken>

متغيّرات التدفق

تعمل سياسة GetOAuthV2Info على تعبئة هذه المتغيرات، وتُستخدم عادةً في الحالات التي إلى بيانات الملف الشخصي، ولكن في الحالات التي لم تحصل فيها بعد على منح أو التحقق من الصحة. .

متغيّرات معرِّف العميل

تتم تعبئة هذه المتغيّرات عند ضبط عنصر ClientId:

oauthv2client.{policy_name}.client_id
oauthv2client.{policy_name}.client_secret
oauthv2client.{policy_name}.redirection_uris // Note the spelling -- 'redirection_uris'
oauthv2client.{policy_name}.developer.email
oauthv2client.{policy_name}.developer.app.name
oauthv2client.{policy_name}.developer.id
oauthv2client.{policy_name}.{developer_app_custom_attribute_name}

متغيّرات رمز الوصول المميّز

تتم تعبئة هذه المتغيّرات عند ضبط عنصر AccessToken:

oauthv2accesstoken.{policy_name}.developer.id
oauthv2accesstoken.{policy_name}.developer.app.name
oauthv2accesstoken.{policy_name}.developer.app.id
oauthv2accesstoken.{policy_name}.developer.email

oauthv2accesstoken.{policy_name}.organization_name
oauthv2accesstoken.{policy_name}.api_product_list

oauthv2accesstoken.{policy_name}.access_token
oauthv2accesstoken.{policy_name}.scope
oauthv2accesstoken.{policy_name}.expires_in //in seconds
oauthv2accesstoken.{policy_name}.status
oauthv2accesstoken.{policy_name}.client_id
oauthv2accesstoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2accesstoken.{policy_name}.refresh_token
oauthv2accesstoken.{policy_name}.refresh_token_status
oauthv2accesstoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2accesstoken.{policy_name}.refresh_count
oauthv2accesstoken.{policy_name}.refresh_token_issued_at
oauthv2accesstoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

متغيّرات رمز التفويض

تتم تعبئة هذه المتغيّرات عند ضبط عنصر PermissionCode:

oauthv2authcode.{policy_name}.code
oauthv2authcode.{policy_name}.scope       
oauthv2authcode.{policy_name}.redirect_uri 
oauthv2authcode.{policy_name}.client_id
oauthv2authcode.{policy_name}.{auth_code_custom_attribute_name}

إعادة تحميل متغيّرات الرمز المميّز

تتم تعبئة هذه المتغيّرات عند ضبط العنصر RefreshToken:

oauthv2refreshtoken.{policy_name}.developer.id
oauthv2refreshtoken.{policy_name}.developer.app.name
oauthv2refreshtoken.{policy_name}.developer.app.id
oauthv2refreshtoken.{policy_name}.developer.email
oauthv2refreshtoken.{policy_name}.organization_name
oauthv2refreshtoken.{policy_name}.api_product_list

oauthv2refreshtoken.{policy_name}.access_token
oauthv2refreshtoken.{policy_name}.scope
oauthv2refreshtoken.{policy_name}.expires_in //in seconds

oauthv2refreshtoken.{policy_name}.status
oauthv2refreshtoken.{policy_name}.client_id
oauthv2refreshtoken.{policy_name}.accesstoken.{custom_attribute_name}

oauthv2refreshtoken.{policy_name}.refresh_token
oauthv2refreshtoken.{policy_name}.refresh_token_status
oauthv2refreshtoken.{policy_name}.refresh_token_expires_in //in seconds

oauthv2refreshtoken.{policy_name}.refresh_count
oauthv2refreshtoken.{policy_name}.refresh_token_issued_at
oauthv2refreshtoken.{policy_name}.revoke_reason //Apigee hybrid only with value of REVOKED_BY_APP, REVOKED_BY_ENDUSER, REVOKED_BY_APP_ENDUSER, or TOKEN_REVOKED

المخطط

يتم تحديد كل نوع سياسة من خلال مخطّط XML (.xsd). يمكنك الرجوع إلى مخططات السياسات المتوفرة على جيت هب.

مرجع الخطأ

يصف هذا القسم رموز الخطأ ورسائل الخطأ التي يتم عرضها ومتغيرات الأخطاء التي تم ضبطها من خلال Edge عندما تؤدي هذه السياسة إلى ظهور خطأ. من المهم معرفة هذه المعلومات إذا كنت تضع قواعد خطأ التعامل مع الأخطاء. للحصول على مزيد من المعلومات، يمكنك الاطّلاع على ما تحتاج إلى معرفته حول أخطاء السياسة والتعامل مع المعالجة والأخطاء.

أخطاء بيئة التشغيل

يمكن أن تحدث هذه الأخطاء عند تنفيذ السياسة. أسماء الخطأ الموضحة أدناه هي السلاسل التي يتم تخصيصها للمتغيّر fault.name عند حدوث خطأ. مشاهدة الخطأ قسم "المتغيرات" أدناه لمزيد من التفاصيل.

أخطاء النشر

يمكنك الرجوع إلى الرسالة التي تم الإبلاغ عنها في واجهة المستخدم للحصول على معلومات عن أخطاء النشر.

متغيّرات الأخطاء

يتم ضبط هذه المتغيّرات عندما تؤدي هذه السياسة إلى ظهور خطأ في وقت التشغيل.

مثال على استجابة الخطأ

{  
   "fault":{  
      "faultstring":"ClientId is Invalid",
      "detail":{  
         "errorcode":"keymanagement.service.invalid_client-invalid_client_id"
      }
   }
}

مثال على قاعدة الخطأ

<FaultRule name="OAuthV2 Faults">
    <Step>
        <Name>AM-InvalidClientIdResponse</Name>
    </Step>
    <Condition>(fault.name = "invalid_client-invalid_client_id")</Condition>
</FaultRule>

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

• سياسة OAuthV2
• صفحة OAuth الرئيسية
• تخصيص الرموز المميّزة ورموز التفويض