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.