GetOAuthV2Info নীতি

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

কি

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

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

এই নীতিতে আপনি যে অ্যাক্সেস টোকেনটি পাস করবেন তা অবশ্যই বৈধ হতে হবে, নাহলে নীতিটি একটি invalid_access_token ত্রুটি দেখাবে।

নমুনা

নিম্নলিখিত নমুনাগুলি OAuth2 ওয়ার্কফ্লোর বিভিন্ন উপাদান সম্পর্কে তথ্য পুনরুদ্ধার করতে এবং তারপর কোডের মধ্যে সেই তথ্য অ্যাক্সেস করতে Get 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> উপাদান

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

<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-এ উপলব্ধ।

ত্রুটির উল্লেখ

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

রানটাইম ত্রুটি

নীতি কার্যকর করার সময় এই ত্রুটিগুলি ঘটতে পারে৷ নীচে দেখানো ত্রুটির নামগুলি হল সেই স্ট্রিংগুলি যা একটি ত্রুটি ঘটলে 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 হোম
• টোকেন এবং অনুমোদন কোড কাস্টমাইজ করা