Method: vdc.proofUser

נקודת קצה לאימות משתמש לקבלת פרטי כניסה דיגיטליים, באמצעות רשימה של הוכחות שצוינו על ידי המנפיק, ובמכשיר ספציפי.

בקשת HTTP

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "proofingId": string,
  "evidence": [
    {
      object (ProofingEvidence)
    }
  ],

  // Union field proofing_context can be only one of the following:
  "reverificationContext": {
    object (ReverificationContext)
  }
  // End of list of possible types for union field proofing_context.
}
שדות
requestMetadata

object (RequestMetadata)

חובה. המטא-נתונים לגבי הבקשה, שנדרשים בכל הבקשות.
deviceReferenceId

string

חובה. המזהה שמתאים למכשיר ולמפתח הזהות שמשויך למכשיר. זה לא מזהה מכשיר, כלומר אם למשתמש יש שני פרטי כניסה נפרדים באותו מכשיר, המזהה הזה יהיה שונה בשני המקרים.

המזהה הזה מסופק בכל הבקשות, ואפשר להשתמש בו כדי ליצור קורלציה בין הבקשות.
proofingId

string

חובה. מזהה אטום שמייצג הוכחה עם חבילה ספציפית של ראיות, למכשיר ספציפי.

לדוגמה: UUID
evidence[]

object (ProofingEvidence)

חובה. רשימת ההוכחות שנדרשות כדי לאמת משתמש לצורך קבלת תעודה דיגיטלית.
שדה איחוד proofing_context. ההקשר לאימות. השדה הזה ריק בשלב ההגהה הראשונית. הערך proofing_context יכול להיות רק אחד מהבאים:
reverificationContext

object (ReverificationContext)

ההקשר של הוכחת האימות מחדש.

גוף התשובה

אישור לבקשה לאימות משתמש לצורך הנפקת תעודה דיגיטלית, שמציין שהאימות נמצא כעת בתהליך.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:

ייצוג JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "proofingId": string
}
שדות
responseMetadata

object (ResponseMetadata)

חובה. המטא-נתונים לגבי התגובה, שנדרשים בכל התגובות.
proofingId

string

חובה. מזהה אטום שמייצג הוכחה עם חבילה ספציפית של ראיות, למכשיר ספציפי. זהו אותו מזהה הוכחה שנשלח בבקשה.

ProofingEvidence

אובייקט שמייצג פריט יחיד של ראיות.

ייצוג JSON 
{

  // Union field evidence_type can be only one of the following:
  "preAuthorizationCode": {
    object (Evidence)
  }
  // End of list of possible types for union field evidence_type.
}
שדות
שדה איחוד evidence_type. חובה. רכיב oneof שמציין איך ההוכחה מוצגת. הערך evidence_type יכול להיות רק אחד מהבאים:
preAuthorizationCode

object (Evidence)

קוד אישור מראש שנשלח מהמנפיק.

הוכחות

אובייקט שמייצג פריט יחיד של ראיות.

ייצוג JSON 
{

  // Union field presencetype can be only one of the following:
  "encryptedData": {
    object (EncryptedData)
  },
  "unencryptedValue": string,
  "unencryptedInteger": integer
  // End of list of possible types for union field presencetype.
}
שדות
שדה איחוד presencetype. חובה. רכיב oneof שמציין איך ההוכחה מוצגת. הערך presencetype יכול להיות רק אחד מהבאים:
encryptedData

object (EncryptedData)

הערך המוצפן ומטא-נתוני ההצפנה שנדרשים כדי לפענח את הערך.
unencryptedValue

string

הערך של הראיה בקידוד Base64.
unencryptedInteger

integer

ערך המספר השלם של הממצא.

ReverificationContext

ההקשר שנדרש להפעלת אימות מחדש של פרטי הכניסה.

ייצוג JSON 
{
  "credentialId": string
}
שדות
credentialId

string

חובה. מזהה פרטי הכניסה שעליו מתבצע האימות מחדש.