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 فیلد Union. یکی از وضعیت‌های ممکن برای یک اعتبارنامه. status می‌تواند فقط یکی از موارد زیر باشد:
provisionPending

object ( ProvisionPending )

نشان‌دهنده‌ی یک اعتبارنامه است که قابل بازیابی است، اما هنوز ProofOfProvisioning را ارائه نکرده است. هرگونه فراخوانی vdc.provisionMobileSecurityObjects برای یک اعتبارنامه در این حالت، در صورتی که درخواست حاوی ProofOfProvisioning به‌روزرسانی‌شده نباشد، باید با شکست مواجه شود. یک اعتبارنامه هنگام ایجاد و زمانی که نسخه جدیدی از یک اعتبارنامه در دسترس باشد، در این حالت قرار می‌گیرد. برای حالت نسخه جدید، کیف پول باید اعتبارنامه را دوباره ارائه دهد و ProofOfProvisioning را ارائه دهد تا به حالت فعال برگردد.

active

object ( Active )

نشان دهنده یک اعتبارنامه فعال و قابل استفاده است. MSO ها فقط برای یک اعتبارنامه در حالت ACTIVE قابل بازیابی هستند.

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.
}
فیلدها
فیلد Unit ProofingAllowance . تلاش برای تصحیح اعتبارنامه فعلی. ProofingAllowance فقط می‌تواند یکی از موارد زیر باشد:
limitedAttempts

object ( LimitedAttempts )

کاربر تعداد دفعات محدودی برای ارسال نمونه دارد.

unlimitedAttempts

object ( UnlimitedAttempts )

کاربر می‌تواند تعداد دفعات نامحدودی برای ارسال مدرک تلاش کند. این مورد به صادرکننده توصیه نمی‌شود.

تلاش‌های محدود

کاربر تعداد دفعات محدودی برای ارسال نمونه دارد.

نمایش JSON 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
فیلدها
remainingAttempts

integer

تعداد تلاش‌های باقی‌مانده برای ارسال تأییدیه. این فقط برای نمایش پیام UX است. گوگل والت بر اساس این تعداد عمل نخواهد کرد.

maxAttempts

integer

حداکثر تعداد تلاش برای ارسال نمونه. این فقط برای نمایش پیام UX است. Google Wallet بر اساس این تعداد عمل نخواهد کرد.

maxAttemptsEnforcementHint

object ( EnforcementHint )

راهنمایی برای توضیح اینکه صادرکننده چگونه حداکثر تلاش‌ها را اعمال می‌کند.

تلاش‌های نامحدود

این نوع هیچ فیلدی ندارد.

کاربر می‌تواند تعداد دفعات نامحدودی برای ارسال مدرک تلاش کند. این مورد به صادرکننده توصیه نمی‌شود.