- HTTP অনুরোধ
- অনুরোধের মূল অংশ
- প্রতিক্রিয়া মূল অংশ
- শংসাপত্রের অবস্থা
- প্রভিশন পেন্ডিং
- সক্রিয়
- প্রত্যাহার করা হয়েছে
- মুছে ফেলা হয়েছে
- ব্যবহারকারীর অ্যাকশন আবশ্যক
- প্রয়োগ ইঙ্গিত
- প্রত্যাহারইঙ্গিত
- প্রমাণ জমা দিন
- সীমিত প্রচেষ্টা
- সীমাহীন প্রচেষ্টা
একটি শংসাপত্রের বর্তমান অবস্থা পুনরুদ্ধারের জন্য একটি শেষ বিন্দু।
HTTP অনুরোধ
POST https://example.issuer.com/api/v1/vdc/getCredentialStatus
অনুরোধের মূল অংশ
অনুরোধের মূল অংশে নিম্নলিখিত কাঠামো সহ ডেটা রয়েছে:
| JSON উপস্থাপনা |
|---|
{
"requestMetadata": {
object ( |
| ক্ষেত্র | |
|---|---|
requestMetadata | সমস্ত অনুরোধের ক্ষেত্রে প্রয়োজনীয় অনুরোধ সম্পর্কে মেটাডেটা। |
deviceReferenceId | ডিভাইসের সাথে সম্পর্কিত আইডি এবং ডিভাইসের সাথে সম্পর্কিত পরিচয় কী। এটি কোনও ডিভাইস আইডি নয়, অর্থাৎ যদি ব্যবহারকারীর একই ডিভাইসে দুটি পৃথক শংসাপত্র থাকে, তবে এই আইডি তাদের মধ্যে আলাদা হবে। এই আইডিটি সমস্ত অনুরোধে সরবরাহ করা হয় এবং অনুরোধগুলির সাথে সম্পর্ক স্থাপন করতে ব্যবহার করা যেতে পারে। |
credentialId | কলকারী যে শংসাপত্রের স্ট্যাটাস অনুরোধ করছেন তার আইডি। |
প্রতিক্রিয়া মূল অংশ
একটি শংসাপত্রের বর্তমান অবস্থা সম্বলিত একটি প্রতিক্রিয়া।
যদি সফল হয়, তাহলে রেসপন্স বডিতে নিম্নলিখিত কাঠামো সহ ডেটা থাকবে:
| JSON উপস্থাপনা |
|---|
{ "responseMetadata": { object ( |
| ক্ষেত্র | |
|---|---|
responseMetadata | সমস্ত প্রতিক্রিয়ার জন্য প্রয়োজনীয় প্রতিক্রিয়া সম্পর্কে মেটাডেটা। |
credentialStatus | শংসাপত্রের বর্তমান অবস্থা। |
credentialVersionId | শংসাপত্রের বর্তমান সংস্করণ। শংসাপত্রের নতুন সংস্করণ উপলব্ধ হলে এটি পরিবর্তিত হবে বলে আশা করা হচ্ছে। এটি কখন পরিবর্তিত হবে তার একটি উদাহরণ হল যখন ব্যবহারকারী তাদের শংসাপত্রে তাদের ঠিকানা আপডেট করে, যার ফলে অন্তর্নিহিত mdoc পুরানো হয়ে যায়। |
শংসাপত্রের অবস্থা
একটি বস্তু যা একটি শংসাপত্রের বিভিন্ন অবস্থা উপস্থাপন করে।
| JSON উপস্থাপনা |
|---|
{ "userActionRequired": { object ( |
| ক্ষেত্র | |
|---|---|
userActionRequired | ব্যবহারকারীর শংসাপত্র আরও সীমাবদ্ধ অবস্থায় স্থানান্তরিত হওয়া এড়াতে প্রয়োজনীয় পদক্ষেপ (যেমন সক্রিয় -> প্রত্যাহার করা)। |
ইউনিয়ন ফিল্ড status । একটি ক্রেডেনশিয়ালের জন্য সম্ভাব্য বিভিন্ন স্ট্যাটাস ধারণকারী একটি status নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে: | |
provisionPending | এমন একটি শংসাপত্র উপস্থাপন করে যা পুনরুদ্ধার করা যেতে পারে, কিন্তু এখনও ProofOfProvisioning প্রদান করেনি। এই অবস্থায় থাকা একটি শংসাপত্রের জন্য vdc.provisionMobileSecurityObjects-এ করা যেকোনো কল ব্যর্থ হবে যদি অনুরোধে একটি আপডেট করা ProofOfProvisioning না থাকে। একটি শংসাপত্র তৈরি করার সময় এবং যখন একটি শংসাপত্রের একটি নতুন সংস্করণ উপলব্ধ থাকে তখন এটি এই অবস্থায় রাখা হয়। নতুন সংস্করণের ক্ষেত্রে, ওয়ালেটকে শংসাপত্রটি পুনরায় সরবরাহ করতে হবে এবং একটি ACTIVE অবস্থায় ফিরে যেতে ProofOfProvisioning প্রদান করতে হবে। |
active | একটি সক্রিয় এবং ব্যবহারযোগ্য শংসাপত্র উপস্থাপন করে। MSO গুলি শুধুমাত্র ACTIVE অবস্থায় একটি শংসাপত্রের জন্য পুনরুদ্ধার করা যেতে পারে। |
revoked | এমন একটি শংসাপত্রের প্রতিনিধিত্ব করে যা চূড়ান্ত, অব্যবহারযোগ্য অবস্থায় রয়েছে। এই শংসাপত্র ভবিষ্যতে ব্যবহারযোগ্য হতে পারে না। এই অবস্থাটি ডিলিটেডের সাথে তুলনীয়, তবে কেবল ইস্যুকারী দ্বারা সেট করা যেতে পারে। |
deleted | এমন একটি শংসাপত্র উপস্থাপন করে যা একবার প্রভিশন করা হয়েছিল, কিন্তু ডিভাইস থেকে মুছে ফেলা হয়েছে। এই অবস্থাটি REVOKED এর সাথে তুলনীয়, তবে শুধুমাত্র ওয়ালেট দ্বারা সেট করা যেতে পারে। |
প্রভিশন পেন্ডিং
এই ধরণের কোনও ক্ষেত্র নেই।
একটি বস্তু যা প্রমাণপত্রের স্থিতির জন্য অপেক্ষারত একটি প্রভিশনকে প্রতিনিধিত্ব করছে। এই বার্তাটি এখন ইচ্ছাকৃতভাবে খালি। ভবিষ্যতে নতুন ক্ষেত্র যোগ করা হতে পারে।
সক্রিয়
এই ধরণের কোনও ক্ষেত্র নেই।
একটি বস্তু যা একটি সক্রিয় শংসাপত্রের অবস্থা উপস্থাপন করছে। এই বার্তাটি ইচ্ছাকৃতভাবে এখন খালি। ভবিষ্যতে নতুন ক্ষেত্র যোগ করা হতে পারে।
প্রত্যাহার করা হয়েছে
এই ধরণের কোনও ক্ষেত্র নেই।
একটি অবজেক্ট যা প্রত্যাহার করা শংসাপত্রের অবস্থা উপস্থাপন করছে। এই বার্তাটি এখন ইচ্ছাকৃতভাবে খালি। ভবিষ্যতে নতুন ক্ষেত্র যোগ করা হতে পারে।
মুছে ফেলা হয়েছে
এই ধরণের কোনও ক্ষেত্র নেই।
একটি অবজেক্ট যা মুছে ফেলা শংসাপত্রের অবস্থা উপস্থাপন করছে। এই বার্তাটি ইচ্ছাকৃতভাবে এখন খালি। ভবিষ্যতে নতুন ক্ষেত্র যোগ করা হতে পারে।
ব্যবহারকারীর অ্যাকশন আবশ্যক
একটি বস্তু যা ব্যবহারকারীর সম্পূর্ণ করতে হবে এমন একটি কাজ / ক্রিয়াকে প্রতিনিধিত্ব করে।
| JSON উপস্থাপনা |
|---|
{ "deadlineTimeMillis": string, "deadlineEnforcementHint": { object ( |
| ক্ষেত্র | |
|---|---|
deadlineTimeMillis | যখন অ্যাকশনের মেয়াদ শেষ হয়ে যায় এবং ইস্যুকারীর কাছ থেকে ক্রেডেনশিয়ালটিকে আরও সীমাবদ্ধ অবস্থায় স্থানান্তরিত করার আশা করা হয়, তখনকার যুগের সময়। ক্লায়েন্ট ব্যবহারকারীকে কখন অ্যাকশনটি সম্পন্ন করতে হবে সে সম্পর্কে সতর্ক করার জন্য এটি ব্যবহার করে, তবে সীমাবদ্ধতা প্রয়োগের দায়িত্ব ইস্যুকারীর উপর। |
deadlineEnforcementHint | ইস্যুকারী কীভাবে পদক্ষেপের সময়সীমা কার্যকর করবে তা বর্ণনা করে ইঙ্গিত। |
ইউনিয়ন ফিল্ড action । ব্যবহারকারীকে যে অ্যাকশনটি সম্পূর্ণ করতে হবে। action নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে: | |
submitProofing | শংসাপত্রের প্রমাণপত্র জমা দিন। |
প্রয়োগ ইঙ্গিত
ইস্যুকারী কীভাবে প্রয়োজনীয় পদক্ষেপ কার্যকর করবেন তা বর্ণনা করে ইঙ্গিত।
| JSON উপস্থাপনা |
|---|
{ // Union field |
| ক্ষেত্র | |
|---|---|
ইউনিয়ন ক্ষেত্রের hint । প্রয়োগের ইঙ্গিতের ধরণ। hint নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে: | |
revocationHint | ইস্যুকারী কর্তৃক শংসাপত্র বাতিল করা হবে। |
প্রত্যাহারইঙ্গিত
এই ধরণের কোনও ক্ষেত্র নেই।
ইস্যুকারী কর্তৃক শংসাপত্র বাতিল করা হবে।
প্রমাণ জমা দিন
প্রুফিং স্ট্যাটাসের বিবরণ।
| JSON উপস্থাপনা |
|---|
{ // Union field |
| ক্ষেত্র | |
|---|---|
ইউনিয়ন ফিল্ড ProofingAllowance । বর্তমান শংসাপত্রের প্রুফিং প্রচেষ্টা। ProofingAllowance নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে: | |
limitedAttempts | ব্যবহারকারীর কাছে প্রমাণপত্র জমা দেওয়ার জন্য সীমিত প্রচেষ্টা রয়েছে। |
unlimitedAttempts | ব্যবহারকারীর কাছে প্রমাণপত্র জমা দেওয়ার জন্য সীমাহীন প্রচেষ্টা রয়েছে। এটি ইস্যুকারীর কাছে সুপারিশ করা হয় না। |
সীমিত প্রচেষ্টা
ব্যবহারকারীর কাছে প্রমাণপত্র জমা দেওয়ার জন্য সীমিত প্রচেষ্টা রয়েছে।
| JSON উপস্থাপনা |
|---|
{
"remainingAttempts": integer,
"maxAttempts": integer,
"maxAttemptsEnforcementHint": {
object ( |
| ক্ষেত্র | |
|---|---|
remainingAttempts | প্রুফিং জমা দেওয়ার বাকি প্রচেষ্টার সংখ্যা। এটি শুধুমাত্র UX বার্তা প্রদর্শনের জন্য। Google Wallet এই নম্বরে কোনও পদক্ষেপ নেবে না। |
maxAttempts | প্রুফিং জমা দেওয়ার সর্বোচ্চ সংখ্যক প্রচেষ্টা। এটি শুধুমাত্র UX বার্তা প্রদর্শনের জন্য। Google Wallet এই নম্বরে কোনও পদক্ষেপ নেবে না। |
maxAttemptsEnforcementHint | ইস্যুকারী কীভাবে সর্বোচ্চ প্রচেষ্টা কার্যকর করবে তা বর্ণনা করার ইঙ্গিত। |
সীমাহীন প্রচেষ্টা
এই ধরণের কোনও ক্ষেত্র নেই।
ব্যবহারকারীর কাছে প্রমাণপত্র জমা দেওয়ার জন্য সীমাহীন প্রচেষ্টা রয়েছে। এটি ইস্যুকারীর কাছে সুপারিশ করা হয় না।