Method: vdc.getCredentialStatus

কোনো ক্রেডেনশিয়ালের বর্তমান অবস্থা জানার জন্য একটি এন্ডপয়েন্ট।

HTTP অনুরোধ

POST https://example.issuer.com/api/v1/vdc/getCredentialStatus

অনুরোধকারী শরীর

অনুরোধের মূল অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
ক্ষেত্র
requestMetadata

object ( RequestMetadata )

আবশ্যক। অনুরোধ সম্পর্কিত মেটাডেটা, যা সকল অনুরোধের জন্য আবশ্যক।

deviceReferenceId

string

আবশ্যক। ডিভাইসটির সাথে সংশ্লিষ্ট আইডি এবং ডিভাইসটির সাথে যুক্ত আইডেন্টিটি কী। এটি কোনো ডিভাইস আইডি নয়, অর্থাৎ, যদি ব্যবহারকারীর একই ডিভাইসে দুটি আলাদা ক্রেডেনশিয়াল থাকে, তবে সেগুলোর মধ্যে এই আইডি ভিন্ন হবে।

এই আইডিটি সমস্ত অনুরোধে সরবরাহ করা হয় এবং অনুরোধগুলির মধ্যে সম্পর্ক স্থাপন করতে এটি ব্যবহার করা যেতে পারে।

credentialId

string

আবশ্যক। কলার যে ক্রেডেনশিয়ালের স্ট্যাটাস জানতে চাইছেন, তার আইডি।

প্রতিক্রিয়া সংস্থা

একটি প্রতিক্রিয়া, যাতে কোনো পরিচয়পত্রের বর্তমান অবস্থা উল্লেখ থাকে।

সফল হলে, প্রতিক্রিয়া অংশে নিম্নলিখিত কাঠামোসহ ডেটা থাকে:

JSON উপস্থাপনা 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credentialStatus": {
    object (CredentialStatus)
  },
  "credentialVersionId": string
}
ক্ষেত্র
responseMetadata

object ( ResponseMetadata )

আবশ্যক। প্রতিক্রিয়া সম্পর্কিত মেটাডেটা, যা সকল প্রতিক্রিয়ার জন্য আবশ্যক।

credentialStatus

object ( CredentialStatus )

আবশ্যক। শংসাপত্রটির বর্তমান অবস্থা।

credentialVersionId

string

প্রয়োজনীয়। ক্রেডেনশিয়ালের বর্তমান সংস্করণ। ক্রেডেনশিয়ালের নতুন সংস্করণ উপলব্ধ হলে এটি পরিবর্তিত হবে বলে আশা করা যায়। এটি কখন পরিবর্তিত হতে পারে তার একটি উদাহরণ হলো, যখন ব্যবহারকারী তার ক্রেডেনশিয়ালে ঠিকানা আপডেট করেন, যার ফলে অন্তর্নিহিত mdoc-টি পুরোনো হয়ে যায়।

ক্রেডেনশিয়াল স্ট্যাটাস

একটি অবজেক্ট যা একটি ক্রেডেনশিয়ালের বিভিন্ন স্ট্যাটাসকে উপস্থাপন করে।

JSON উপস্থাপনা 
{
  "userActionRequired": {
    object (UserActionRequired)
  },

  // Union field status can be only one of the following:
  "provisionPending": {
    object (ProvisionPending)
  },
  "active": {
    object (Active)
  },
  "revoked": {
    object (Revoked)
  },
  "deleted": {
    object (Deleted)
  }
  // End of list of possible types for union field status.
}
ক্ষেত্র
userActionRequired

object ( UserActionRequired )

ব্যবহারকারীর ক্রেডেনশিয়াল আরও সীমাবদ্ধ অবস্থায় (যেমন সক্রিয় -> বাতিল) চলে যাওয়া ঠেকাতে তার প্রয়োজনীয় পদক্ষেপ।

ইউনিয়ন ফিল্ড status । আবশ্যক। একটি ক্রেডেনশিয়ালের জন্য সম্ভাব্য বিভিন্ন স্ট্যাটাসের মধ্যে একটি। status নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে:
provisionPending

object ( ProvisionPending )

এটি এমন একটি ক্রেডেনশিয়ালকে বোঝায় যা পুনরুদ্ধার করা যায়, কিন্তু এখনও ProofOfProvisioning প্রদান করেনি। এই অবস্থায় থাকা কোনো ক্রেডেনশিয়ালের জন্য vdc.provisionMobileSecurityObjects-এ করা যেকোনো কল ব্যর্থ হওয়া উচিত, যদি অনুরোধটিতে একটি আপডেট করা ProofOfProvisioning না থাকে। একটি ক্রেডেনশিয়াল তৈরি হলে এবং যখন সেটির কোনো নতুন সংস্করণ উপলব্ধ থাকে, তখন তা এই অবস্থায় আসে। নতুন সংস্করণের ক্ষেত্রে, ACTIVE অবস্থায় ফিরে যেতে ওয়ালেটটিকে অবশ্যই ক্রেডেনশিয়ালটি পুনরায় প্রোভিশন করতে হবে এবং ProofOfProvisioning প্রদান করতে হবে।

active

object ( Active )

এটি একটি সক্রিয় এবং ব্যবহারযোগ্য ক্রেডেনশিয়ালকে বোঝায়। শুধুমাত্র ACTIVE অবস্থায় থাকা ক্রেডেনশিয়ালের জন্যই MSO পুনরুদ্ধার করা যায়।

revoked

object ( Revoked )

এটি এমন একটি ক্রেডেনশিয়ালকে বোঝায় যা চূড়ান্ত ও অব্যবহারযোগ্য অবস্থায় রয়েছে। এই ক্রেডেনশিয়ালটি ভবিষ্যতে আর ব্যবহারযোগ্য হতে পারবে না। এই অবস্থাটি 'মুছে ফেলা হয়েছে' (DELETED) অবস্থার সমতুল্য, কিন্তু এটি শুধুমাত্র ইস্যুকারীই নির্ধারণ করতে পারে।

deleted

object ( Deleted )

এটি এমন একটি ক্রেডেনশিয়ালকে বোঝায় যা একসময় প্রদান করা হয়েছিল, কিন্তু ডিভাইস থেকে মুছে ফেলা হয়েছে। এই অবস্থাটি বাতিল (REVOKED) অবস্থার অনুরূপ, কিন্তু এটি শুধুমাত্র ওয়ালেট থেকেই সেট করা যায়।

বিধান বিচারাধীন

এই প্রকারে কোনো ক্ষেত্র নেই।

ক্রেডেনশিয়াল স্ট্যাটাসের অপেক্ষাধীন একটি প্রোভিশনের প্রতিনিধিত্বকারী একটি অবজেক্ট। এই বার্তাটি এই মুহূর্তে ইচ্ছাকৃতভাবে খালি রাখা হয়েছে। ভবিষ্যতে নতুন ফিল্ড যোগ করা হতে পারে।

সক্রিয়

এই প্রকারে কোনো ক্ষেত্র নেই।

একটি অবজেক্ট যা একটি সক্রিয় ক্রেডেনশিয়াল স্ট্যাটাসকে প্রতিনিধিত্ব করে। এই বার্তাটি এই মুহূর্তে ইচ্ছাকৃতভাবে খালি রাখা হয়েছে। ভবিষ্যতে নতুন ফিল্ড যোগ করা হতে পারে।

বাতিল করা হয়েছে

এই প্রকারে কোনো ক্ষেত্র নেই।

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

মুছে ফেলা হয়েছে

এই প্রকারে কোনো ক্ষেত্র নেই।

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

ব্যবহারকারীর প্রয়োজনীয় পদক্ষেপ

এমন একটি অবজেক্ট যা ব্যবহারকারীর সম্পন্ন করার জন্য প্রয়োজনীয় কোনো কাজ বা ক্রিয়াকে উপস্থাপন করে।

JSON উপস্থাপনা 
{
  "deadlineTimeMillis": string,
  "deadlineEnforcementHint": {
    object (EnforcementHint)
  },

  // Union field action can be only one of the following:
  "submitProofing": {
    object (SubmitProofing)
  }
  // End of list of possible types for union field action.
}
ক্ষেত্র
deadlineTimeMillis

string ( int64 format)

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

deadlineEnforcementHint

object ( EnforcementHint )

ইস্যুকারী কীভাবে পদক্ষেপটির সময়সীমা কার্যকর করবে, তার একটি ইঙ্গিত।

ইউনিয়ন ফিল্ড action । যে কাজটি ব্যবহারকারীকে সম্পন্ন করতে হবে। action নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে:
submitProofing

object ( SubmitProofing )

শিক্ষাগত যোগ্যতার প্রমাণপত্র জমা দিন।

এনফোর্সমেন্টহিন্ট

ইস্যুকারী কীভাবে প্রয়োজনীয় পদক্ষেপটি কার্যকর করবে তার একটি ইঙ্গিত।

JSON উপস্থাপনা 
{

  // Union field hint can be only one of the following:
  "revocationHint": {
    object (RevocationHint)
  }
  // End of list of possible types for union field hint.
}
ক্ষেত্র
ইউনিয়ন ফিল্ড hint । এনফোর্সমেন্ট হিন্টের ধরণ। hint নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে:
revocationHint

object ( RevocationHint )

প্রদানকারী কর্তৃক পরিচয়পত্রটি বাতিল করা হবে।

প্রত্যাহার ইঙ্গিত

এই প্রকারে কোনো ক্ষেত্র নেই।

প্রদানকারী কর্তৃক পরিচয়পত্রটি বাতিল করা হবে।

সাবমিটপ্রুফিং

প্রুফিং স্থিতির বিবরণ।

JSON উপস্থাপনা 
{

  // Union field ProofingAllowance can be only one of the following:
  "limitedAttempts": {
    object (LimitedAttempts)
  },
  "unlimitedAttempts": {
    object (UnlimitedAttempts)
  }
  // End of list of possible types for union field ProofingAllowance.
}
ক্ষেত্র
ইউনিয়ন ফিল্ড ProofingAllowance । বর্তমান ক্রেডেনশিয়ালের প্রুফিং প্রচেষ্টা। ProofingAllowance নিম্নলিখিতগুলির মধ্যে কেবল একটি হতে পারে:
limitedAttempts

object ( LimitedAttempts )

ব্যবহারকারীর প্রুফ জমা দেওয়ার সুযোগ সীমিত।

unlimitedAttempts

object ( UnlimitedAttempts )

ব্যবহারকারী প্রুফিং জমা দেওয়ার জন্য সীমাহীন সুযোগ পাবেন। ইস্যুকারীর জন্য এটি সুপারিশ করা হয় না।

সীমিত প্রচেষ্টা

ব্যবহারকারীর প্রুফ জমা দেওয়ার সুযোগ সীমিত।

JSON উপস্থাপনা 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
ক্ষেত্র
remainingAttempts

integer

প্রুফিং জমা দেওয়ার জন্য অবশিষ্ট চেষ্টার সংখ্যা। এটি শুধুমাত্র ইউএক্স (UX) বার্তা প্রদর্শনের জন্য। গুগল ওয়ালেট এই সংখ্যার উপর ভিত্তি করে কোনো পদক্ষেপ নেবে না।

maxAttempts

integer

প্রুফিং জমা দেওয়ার সর্বোচ্চ সংখ্যক প্রচেষ্টা। এটি শুধুমাত্র ইউএক্স (UX) বার্তা প্রদর্শনের জন্য। গুগল ওয়ালেট এই সংখ্যার উপর ভিত্তি করে কোনো পদক্ষেপ নেবে না।

maxAttemptsEnforcementHint

object ( EnforcementHint )

ইস্যুকারী কীভাবে সর্বোচ্চ চেষ্টার সীমা কার্যকর করবে, তার একটি ইঙ্গিত।

সীমাহীন প্রচেষ্টা

এই প্রকারে কোনো ক্ষেত্র নেই।

ব্যবহারকারী প্রুফিং জমা দেওয়ার জন্য সীমাহীন সুযোগ পাবেন। ইস্যুকারীর জন্য এটি সুপারিশ করা হয় না।