Method: vdc.provisionCredential

نقطة نهاية لتوفير بيانات اعتماد

طلب HTTP

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

نص الطلب

يتضمن نص الطلب بيانات بالبنية التالية:

تمثيل JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string,
  "proofingId": string,
  "deviceEncryptionKey": {
    object (DeviceEncryptionKey)
  }
}
الحقول
requestMetadata

object (RequestMetadata)

الحقل مطلوب. البيانات الوصفية المتعلّقة بالطلب، وهي مطلوبة في جميع الطلبات
deviceReferenceId

string

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

يتم تقديم رقم التعريف هذا في جميع الطلبات، ويمكن استخدامه لربط الطلبات.
credentialId

string

الحقل مطلوب. معرّف مبهم يمثّل بيانات اعتماد محدّدة تم توفيرها لجهاز.

إذا كان credentialId متوفّرًا من قبل، يجب أن تعرض هذه الطريقة بيانات الاعتماد الحالية بدلاً من إنشاء بيانات اعتماد جديدة.

مثال: UUID
proofingId

string

الحقل مطلوب. معرّف غير شفاف يمثّل عملية إثبات هوية باستخدام حزمة محدّدة من المستندات الثبوتية لجهاز معيّن.

يجب أن تكون عملية إثبات الملكية في حالة "موافَق عليها". وفي حال عدم توفّره، يجب عرض ErrorResponse بمعرّف غير صالح.
deviceEncryptionKey

object (DeviceEncryptionKey)

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

نص الاستجابة

ردّ يحتوي على بيانات الاعتماد المتوفّرة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
الحقول
responseMetadata

object (ResponseMetadata)

الحقل مطلوب. البيانات الوصفية المتعلّقة بالردّ، وهي مطلوبة في جميع الردود
credential

object (Credential)

الحقل مطلوب. بيانات الاعتماد التي تم توفيرها
credentialVersionId

string

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

بيانات الاعتماد

مستند التعريف الشخصي المستند إلى mdoc، كما هو محدّد بموجب معيار ISO ذي الصلة بنوع مستند التعريف الشخصي

على سبيل المثال، بالنسبة إلى رخصة القيادة على الأجهزة الجوّالة، سيكون هذا المعيار هو ISO/IEC 18013-5. يمكنك الاطّلاع على هذا للحصول على تنسيق mDL mDoc.

تمثيل JSON 
{

  // Union field presencetype can be only one of the following:
  "encryptedData": {
    object (EncryptedData)
  },
  "unencryptedValue": string
  // End of list of possible types for union field presencetype.
}
الحقول
حقل الربط presencetype الحقل مطلوب. حقل oneof يشير إلى طريقة عرض بيانات الاعتماد. يمكن أن يكون التعليق presencetype إحدى القيم التالية فقط:
encryptedData

object (EncryptedData)

القيمة المشفّرة وبيانات التشفير الوصفية اللازمة لفك تشفير القيمة
unencryptedValue

string

تمثّل هذه السمة قيمة بيانات الاعتماد المشفّرة باستخدام Base64.