خط مشی GetOAuthV2Info

شما در حال مشاهده اسناد Apigee Edge هستید.
به مستندات Apigee X بروید . اطلاعات

چی

ویژگی‌های نشانه‌های دسترسی، نشانه‌های تازه‌سازی، کدهای مجوز، و ویژگی‌های برنامه مشتری را دریافت می‌کند و متغیرها را با مقادیر آن ویژگی‌ها پر می‌کند.

این خط‌مشی زمانی مفید است که شما نیاز به پیکربندی رفتار مشروط و پویا بر اساس مقداری در یک رمز یا کد اعتبار دارید. هر زمان که اعتبار سنجی توکن رخ می دهد، متغیرها به طور خودکار با مقادیر ویژگی های نشانه پر می شوند. با این حال، در مواردی که اعتبار سنجی توکن رخ نداده است، می‌توانید از این ویژگی برای پر کردن صریح متغیرها با مقادیر ویژگی یک نشانه استفاده کنید. همچنین به سفارشی کردن رمزها و کدهای مجوز مراجعه کنید.

یک نشانه دسترسی که به این خط‌مشی ارسال می‌کنید باید معتبر باشد، در غیر این صورت خط‌مشی خطای 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">

جدول زیر ویژگی هایی را توصیف می کند که برای همه عناصر اصلی خط مشی مشترک هستند:

عنصر <DisplayName>

علاوه بر ویژگی name برای برچسب‌گذاری خط‌مشی در ویرایشگر پروکسی رابط کاربری مدیریت با نامی متفاوت و به زبان طبیعی، از آن استفاده کنید.

<DisplayName>Policy Display Name</DisplayName>

عنصر <AccessToken>

نمایه را برای یک نشانه دسترسی بازیابی می کند. شما متغیری را که شامل رشته نشانه دسترسی است یا یک رشته نشانه تحت اللفظی (مورد نادر) را وارد می کنید. در این مثال، نشانه دسترسی از یک پارامتر query ارسال شده در یک درخواست بازیابی می شود. اگر می‌خواهید اطلاعات یک توکن باطل شده یا منقضی شده را برگردانید، از عنصر <IgnoreAccessTokenStatus> استفاده کنید.

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

عنصر <AuthorizationCode>

نمایه یک کد مجوز را بازیابی می کند. شما متغیری را که شامل رشته کد auth یا یک رشته رمز واقعی (مورد نادر) است را وارد می کنید. در این مثال، کد auth از یک پارامتر query ارسال شده در یک درخواست بازیابی می شود. برای لیستی از متغیرهای پر شده توسط این عملیات، به " متغیرهای جریان " مراجعه کنید.

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

عنصر <ClientId>

اطلاعات مربوط به شناسه مشتری را بازیابی می کند. در این مثال، شناسه مشتری از یک پارامتر پرس و جو که در یک درخواست ارسال شده است، بازیابی می شود. برای لیستی از متغیرهای پر شده توسط این عملیات، به " متغیرهای جریان " مراجعه کنید.

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

عنصر <IgnoreAccessTokenStatus>

حتی اگر توکن منقضی یا باطل شده باشد، اطلاعات رمز را برمی‌گرداند. این عنصر فقط با توکن های دسترسی قابل استفاده است. اطلاعات سایر نهادها مانند نشانه‌های تازه‌سازی و کدهای مجوز بدون در نظر گرفتن وضعیت آنها، به طور پیش‌فرض بازگردانده می‌شوند.

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

عنصر <RefreshToken>

نمایه را برای یک نشانه تازه‌سازی بازیابی می‌کند. شما متغیری را که شامل رشته نشانه رفرش است یا یک رشته توکن تحت اللفظی (مورد نادر) را وارد می کنید. در این مثال، نشانه refresh از یک پارامتر query ارسال شده در یک درخواست بازیابی می شود. برای لیستی از متغیرهای پر شده توسط این عملیات، به " متغیرهای جریان " مراجعه کنید.

<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 در دسترس هستند.

مرجع خطا

این بخش کدهای خطا و پیام‌های خطایی را که برگردانده می‌شوند و متغیرهای خطا را که توسط Edge تنظیم می‌شوند، هنگامی که این خط‌مشی خطا را راه‌اندازی می‌کند، توضیح می‌دهد. این اطلاعات برای دانستن اینکه آیا در حال توسعه قوانین خطا برای رسیدگی به خطاها هستید، مهم است. برای کسب اطلاعات بیشتر، آنچه را که باید در مورد خطاهای خط مشی و مدیریت خطاها بدانید را ببینید.

خطاهای زمان اجرا

این خطاها ممکن است هنگام اجرای سیاست رخ دهند. نام خطاهای نشان داده شده در زیر رشته هایی هستند که در صورت بروز خطا به متغیر fault.name اختصاص داده می شوند. برای جزئیات بیشتر به بخش متغیرهای خطا در زیر مراجعه کنید.

خطاهای استقرار

برای اطلاعات در مورد خطاهای استقرار به پیام گزارش شده در UI مراجعه کنید.

متغیرهای خطا

این متغیرها زمانی تنظیم می شوند که این خط مشی خطایی را در زمان اجرا ایجاد کند.

نمونه پاسخ خطا

{  
   "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
• سفارشی کردن توکن ها و کدهای مجوز