سياسة GetOAuthV2Info

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

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

تعرض هذه السياسة سمات رموز الدخول ورموز التحديث ورموز التفويض وسمات تطبيق العميل، وتملأ المتغيرات بقيم هذه السمات.

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

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

نماذج

تستخدِم النماذج التالية سياسة Get OAuth V2 Info لاسترداد معلومات حول مكوّنات مختلفة من سير عمل 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">

The following table describes attributes that are common to all policy parent elements:

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>

العنصر <AccessToken>

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

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

العنصر <AuthorizationCode>

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

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

العنصر <ClientId>

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

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

عنصر <IgnoreAccessTokenStatus>

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

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

العنصر <RefreshToken>

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

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

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

يتم ملء هذه المتغيّرات عند ضبط العنصر 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). وللحصول على مرجع، تتوفّر مخطّطات السياسات على 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. The error names shown below are the strings that are assigned to the fault.name variable when an error occurs. See the Fault variables section below for more details.

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.

Example error response

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

Example fault rule

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

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

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