GetOAuthV2Info নীতি

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

কী

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

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

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

নমুনা

নিচের নমুনাগুলি OAuth2 ওয়ার্কফ্লোর বিভিন্ন কম্পোনেন্ট সম্পর্কে তথ্য পেতে Get OAuth V2 Info নীতি ব্যবহার করে এবং তারপরে কোডের মধ্যে সেই তথ্য অ্যাক্সেস করে।

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

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