GetOAuthV2Info নীতি

আপনি Apigee Edge ডকুমেন্টেশন দেখছেন।
Apigee X ডকুমেন্টেশনে যান । তথ্য

কি

অ্যাক্সেস টোকেন, রিফ্রেশ টোকেন, অনুমোদন কোড এবং ক্লায়েন্ট অ্যাপ অ্যাট্রিবিউটের অ্যাট্রিবিউটগুলি পায় এবং সেই অ্যাট্রিবিউটগুলির মানগুলির সাথে ভেরিয়েবলগুলিকে পপুলেট করে৷

এই নীতিটি উপযোগী যখন আপনি একটি টোকেন বা প্রমাণীকরণ কোডের একটি মানের উপর ভিত্তি করে গতিশীল, শর্তসাপেক্ষ আচরণ কনফিগার করতে হবে৷ যখনই টোকেন বৈধতা ঘটবে, ভেরিয়েবলগুলি স্বয়ংক্রিয়ভাবে টোকেন বৈশিষ্ট্যের মানগুলির সাথে পপুলেট হয়। যাইহোক, যে ক্ষেত্রে টোকেন বৈধতা ঘটেনি, আপনি এই বৈশিষ্ট্যটি ব্যবহার করতে পারেন স্পষ্টভাবে একটি টোকেনের বৈশিষ্ট্য মান সহ ভেরিয়েবলগুলিকে পপুলেট করতে। এছাড়াও টোকেন এবং অনুমোদন কোড কাস্টমাইজ করা দেখুন।

একটি অ্যাক্সেস টোকেন যা আপনি এই নীতিতে পাস করবেন তা অবশ্যই বৈধ হতে হবে বা নীতিটি একটি invalid_access_token ত্রুটি নিক্ষেপ করবে৷

নমুনা

নিম্নলিখিত নমুনাগুলি OAuth2 কর্মপ্রবাহের বিভিন্ন উপাদান সম্পর্কে তথ্য পুনরুদ্ধার করতে এবং তারপর কোডের মধ্যে সেই তথ্য অ্যাক্সেস করতে OAuth V2 তথ্য পান নীতি ব্যবহার করে৷

<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> উপাদান

ম্যানেজমেন্ট UI প্রক্সি এডিটরে নীতিটিকে একটি ভিন্ন, প্রাকৃতিক-ভাষা নামের সাথে লেবেল করতে 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>

<EgnoreAccessTokenStatus> উপাদান

টোকেনের মেয়াদ শেষ বা প্রত্যাহার করা হলেও টোকেন তথ্য ফেরত দেয়। এই উপাদান শুধুমাত্র অ্যাক্সেস টোকেন ব্যবহার করা যেতে পারে. রিফ্রেশ টোকেন এবং অনুমোদন কোডের মতো অন্যান্য সত্তার জন্য তথ্য ডিফল্টরূপে তাদের অবস্থা নির্বিশেষে ফেরত দেওয়া হয়।

<IgnoreAccessTokenStatus>true</IgnoreAccessTokenStatus>

<রিফ্রেশটোকেন> উপাদান

একটি রিফ্রেশ টোকেনের জন্য প্রোফাইল পুনরুদ্ধার করে৷ আপনি একটি পরিবর্তনশীল যা রিফ্রেশ টোকেন স্ট্রিং বা একটি আক্ষরিক টোকেন স্ট্রিং (বিরল ক্ষেত্রে) ধারণ করে পাস করুন। এই উদাহরণে, রিফ্রেশ টোকেন একটি অনুরোধে পাস করা একটি ক্যোয়ারী প্যারামিটার থেকে পুনরুদ্ধার করা হয়। এই ক্রিয়াকলাপ দ্বারা জনবহুল ভেরিয়েবলের তালিকার জন্য, " ফ্লো ভেরিয়েবল " দেখুন৷

<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 হোম
• টোকেন এবং অনুমোদন কোড কাস্টমাইজ করা