سياسة GetOAuthV2Info

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

الموضوع

الحصول على سمات رموز الدخول والرموز المميزة لإعادة التحميل ورموز التفويض وسمات تطبيق العميل وتعبئة المتغيرات بقيم هذه السمات

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

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

عيّنات

تستخدم النماذج التالية سياسة "الحصول على معلومات الإصدار 2 من OAuth" لاسترداد معلومات حول المكونات المختلفة لسير عمل 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">

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

العنصر <DisplayName>

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

<DisplayName>Policy Display Name</DisplayName>

عنصر <AccessToken>

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

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

العنصر <تفويضCode>

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

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

عنصر <ClientId>

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

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

العنصر <تجاهلAccessTokenStatus>

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

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

العنصر <DELETEToken>

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

<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

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

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

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}

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

تتم تعبئة هذه المتغيرات عند تعيين العنصر DELETEToken:

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). وتتوفّر مخطّطات السياسات كمرجع على GitHub.

مرجع الخطأ

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