נקודת קצה לאימות משתמש לקבלת אישור דיגיטלי, באמצעות רשימה של הוכחות שצוינו על ידי המנפיק, ולמכשיר ספציפי.
בקשת HTTP
POST https://example.issuer.com/api/v1/vdc/proofUser
גוף הבקשה
גוף הבקשה מכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{ "requestMetadata": { object ( |
| שדות | |
|---|---|
requestMetadata |
המטא-נתונים לגבי הבקשה, שנדרשים בכל הבקשות. |
deviceReferenceId |
המזהה שמתאים למכשיר ולמפתח הזהות שמשויך למכשיר. זה לא מזהה מכשיר, כלומר אם למשתמש יש שני פרטי כניסה נפרדים באותו מכשיר, המזהה הזה יהיה שונה בשני המקרים. המזהה הזה מסופק בכל הבקשות, ואפשר להשתמש בו כדי ליצור קורלציה בין בקשות. |
proofingId |
מזהה אטום שמייצג הוכחה עם חבילה ספציפית של ראיות, למכשיר ספציפי. לדוגמה: מזהה ייחודי אוניברסלי (UUID) |
evidence[] |
רשימת ההוכחות שנדרשות כדי לאמת משתמש לצורך קבלת פרטי כניסה דיגיטליים. |
שדה איחוד proofing_context. ההקשר של ההגהה. השדה הזה ריק בשלב ההגהה הראשונית. הערך proofing_context יכול להיות רק אחד מהבאים: |
|
reverificationContext |
ההקשר של ההגהה לאימות מחדש. |
גוף התשובה
אישור לבקשה לאימות משתמש לצורך הנפקת תעודה דיגיטלית, שמעיד שהאימות נמצא כעת בתהליך.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג ב-JSON |
|---|
{
"responseMetadata": {
object ( |
| שדות | |
|---|---|
responseMetadata |
המטא-נתונים לגבי התשובה, שנדרשים בכל התשובות. |
proofingId |
מזהה אטום שמייצג הוכחה עם חבילה ספציפית של ראיות, למכשיר ספציפי. זהו אותו מזהה הוכחה שנשלח בבקשה. |
ProofingEvidence
אובייקט שמייצג פריט יחיד של ראיות.
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד evidence_type. רכיב oneof שמציין איך ההוכחה מוצגת. הערך evidence_type יכול להיות רק אחד מהבאים: |
|
preAuthorizationCode |
קוד הרשאה מראש שנשלח מהמנפיק. |
הוכחות
אובייקט שמייצג פריט יחיד של ראיות.
| ייצוג ב-JSON |
|---|
{ // Union field |
| שדות | |
|---|---|
שדה איחוד presencetype. רכיב oneof שמציין איך ההוכחה מוצגת. הערך presencetype יכול להיות רק אחד מהבאים: |
|
encryptedData |
הערך המוצפן ומטא-נתוני ההצפנה שנדרשים כדי לפענח את הערך. |
unencryptedValue |
הערך של הראיה בקידוד Base64. |
unencryptedInteger |
ערך המספר השלם של הראיה. |
ReverificationContext
ההקשר שנדרש כדי להפעיל אימות מחדש של פרטי הכניסה.
| ייצוג ב-JSON |
|---|
{ "credentialId": string } |
| שדות | |
|---|---|
credentialId |
מזהה האישורים שעליהם מתבצע האימות מחדש. |