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

تمثّل هذه السمة الإصدار الحالي من بيانات الاعتماد. من المتوقّع أن يتغيّر ذلك عند توفّر إصدارات جديدة من المستند. من الأمثلة على الحالات التي يتغير فيها هذا المعرّف عندما يعدّل المستخدم عنوانه في مستند التعريف، ما يؤدي إلى انتهاء صلاحية مستند تعريف الجهاز الجوّال الأساسي.

CredentialStatus

كائن يمثّل الحالات المختلفة التي يمكن أن تتضمّنها بيانات الاعتماد.

تمثيل 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)

الإجراء المطلوب من المستخدم لتجنُّب انتقال بيانات الاعتماد إلى حالة أكثر تقييدًا (مثل ACTIVE -> REVOKED)
حقل الربط status حقل oneof يحتوي على الحالات المختلفة الممكنة لبيانات الاعتماد. يمكن أن يكون التعليق status إحدى القيم التالية فقط:
provisionPending

object (ProvisionPending)

تمثّل هذه السمة بيانات اعتماد يمكن استردادها، ولكن لم يتم تقديم ProofOfProvisioning بعد. يجب أن يتعذّر تنفيذ أي طلبات إلى vdc.provisionMobileSecurityObjects للحصول على بيانات اعتماد في هذه الحالة إذا لم يتضمّن الطلب ProofOfProvisioning معدَّلاً. يتم وضع بيانات الاعتماد في هذه الحالة عند إنشائها وعند توفّر نسخة جديدة منها. في حالة الإصدار الجديد، يجب أن تعيد المحفظة توفير بيانات الاعتماد وتقديم ProofOfProvisioning للعودة إلى الحالة ACTIVE.
active

object (Active)

تمثّل هذه السمة بيانات اعتماد نشطة وقابلة للاستخدام. لا يمكن استرداد MSO إلا لبيانات اعتماد في الحالة ACTIVE.
revoked

object (Revoked)

تمثّل هذه السمة بيانات اعتماد في حالة نهائية وغير قابلة للاستخدام. لا يمكن استخدام بيانات الاعتماد هذه في المستقبل. تشبه هذه الحالة الحالة "تم الحذف"، ولكن لا يمكن ضبطها إلا من قِبل جهة الإصدار.
deleted

object (Deleted)

تمثّل هذه السمة بيانات اعتماد تم توفيرها في السابق، ولكن تم حذفها من الجهاز. تشبه هذه الحالة الحالة REVOKED، ولكن لا يمكن ضبطها إلا من خلال المحفظة.

ProvisionPending

لا يتضمّن هذا النوع أي حقول.

تمثّل هذه السمة عنصرًا يمثّل حالة بيانات الاعتماد في انتظار التوفير. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.

نشطة

لا يتضمّن هذا النوع أي حقول.

تمثّل هذه السمة عنصرًا يوضّح حالة بيانات اعتماد نشطة. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.

تم إبطاله

لا يتضمّن هذا النوع أي حقول.

عنصر يمثّل حالة بيانات اعتماد تم إبطالها. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.

محذوفة

لا يتضمّن هذا النوع أي حقول.

كائن يمثّل حالة بيانات اعتماد محذوفة. هذه الرسالة فارغة عمدًا في الوقت الحالي. يمكن إضافة حقول جديدة في المستقبل.

UserActionRequired

كائن يمثّل مهمة أو إجراءً يجب أن يكمّله المستخدم.

تمثيل 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)

الوقت بنظام Epoch الذي تنتهي فيه صلاحية الإجراء ومن المتوقّع أن ينقل فيه جهة الإصدار بيانات الاعتماد إلى حالة أكثر تقييدًا يستخدمه العميل لتحذير المستخدم بشأن الموعد النهائي لإكمال الإجراء، ولكن يعود إلى الجهة المُصدرة فرض القيود.
deadlineEnforcementHint

object (EnforcementHint)

تلميح يصف كيف سيفرض الجهة المُصدرة الموعد النهائي للإجراء.
حقل الربط action الإجراء الذي يجب أن يكمل المستخدم تنفيذه يمكن أن يكون التعليق action إحدى القيم التالية فقط:
submitProofing

object (SubmitProofing)

أرسِل مستندات تثبت صحة بيانات الاعتماد.

EnforcementHint

تلميح يصف كيف سيفرض الجهة المصدرة الإجراء المطلوب.

تمثيل 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)

سيتم إبطال بيانات الاعتماد من قِبل الجهة المُصدرة.

RevocationHint

لا يتضمّن هذا النوع أي حقول.

سيتم إبطال بيانات الاعتماد من قِبل الجهة المُصدرة.

SubmitProofing

تفاصيل حالة إثبات الملكية

تمثيل 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)

يمكن للمستخدم تقديم مستندات إثبات الهوية عددًا غير محدود من المرات. ولا ننصح جهة الإصدار بذلك.

LimitedAttempts

لدى المستخدم عدد محدود من المحاولات لإرسال مستندات إثبات الهوية.

تمثيل JSON 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
الحقول
remainingAttempts

integer

عدد المحاولات المتبقية لإرسال مستندات إثبات الهوية هذا الإعداد مخصّص لعرض رسائل تجربة المستخدم فقط. لن تتخذ "محفظة Google" أي إجراء بشأن هذا الرقم.
maxAttempts

integer

الحد الأقصى لعدد محاولات إرسال مستندات إثبات الهوية هذا الإعداد مخصّص لعرض رسائل تجربة المستخدم فقط. لن تتخذ "محفظة Google" أي إجراء بشأن هذا الرقم.
maxAttemptsEnforcementHint

object (EnforcementHint)

تلميح يوضّح كيف سيفرض جهة الإصدار الحدّ الأقصى لعدد المحاولات

UnlimitedAttempts

لا يتضمّن هذا النوع أي حقول.

يمكن للمستخدم تقديم مستندات إثبات الهوية عددًا غير محدود من المرات. ولا ننصح جهة الإصدار بذلك.