یک نقطه پایانی برای اثبات اعتبار دیجیتال کاربر، با استفاده از فهرستی از شواهد مشخصشده توسط صادرکننده و برای یک دستگاه خاص.
درخواست HTTP
POST https://example.issuer.com/api/v1/vdc/proofUser
درخواست بدنه
بدنه درخواست شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{ "requestMetadata": { object ( |
| فیلدها | |
|---|---|
requestMetadata | الزامی. فراداده مربوط به درخواست، که در همه درخواستها الزامی است. |
deviceReferenceId | الزامی. شناسهای که مربوط به دستگاه و کلید هویت مرتبط با آن است. این شناسه دستگاه نیست، به این معنی که اگر کاربر دو اعتبارنامه جداگانه در یک دستگاه داشته باشد، این شناسه بین آنها متفاوت خواهد بود. این شناسه در تمام درخواستها ارائه میشود و میتواند برای مرتبط کردن درخواستها مورد استفاده قرار گیرد. |
proofingId | الزامی. یک شناسهی مبهم که نشاندهندهی اثبات با مجموعهای خاص از شواهد، برای یک دستگاه خاص است. مثال: شناسه کاربری |
evidence[] | الزامی. فهرست مدارک مورد نیاز برای اثبات کاربر برای دریافت اعتبارنامه دیجیتال. |
فیلد union proofing_context . زمینه برای اثبات. برای اثبات اولیه خالی است. proofing_context فقط میتواند یکی از موارد زیر باشد: | |
reverificationContext | زمینه برای اثبات تأیید مجدد. |
بدنه پاسخ
تأییدیه درخواست برای تأیید اعتبار دیجیتال کاربر، که نشان میدهد تأیید اعتبار اکنون در حال انجام است.
در صورت موفقیت، بدنه پاسخ شامل دادههایی با ساختار زیر است:
| نمایش JSON |
|---|
{
"responseMetadata": {
object ( |
| فیلدها | |
|---|---|
responseMetadata | الزامی. فراداده مربوط به پاسخ، که در همه پاسخها الزامی است. |
proofingId | الزامی. شناسهی مبهمی که نشاندهندهی یک اثبات با مجموعهای خاص از شواهد، برای یک دستگاه خاص است. این همان شناسهی اثباتی است که در درخواست ارسال شده است. |
اثبات شواهد
شیئی که نمایانگر یک مدرک واحد است.
| نمایش JSON |
|---|
{ // Union field |
| فیلدها | |
|---|---|
فیلد متحد evidence_type . الزامی. یکی از مواردی که نحوه ارائه شواهد را نشان میدهد. evidence_type فقط میتواند یکی از موارد زیر باشد: | |
preAuthorizationCode | کد پیشمجوز از صادرکننده ارسال شده است. |
شواهد
شیئی که نمایانگر یک مدرک واحد است.
| نمایش JSON |
|---|
{ // Union field |
| فیلدها | |
|---|---|
فیلد Union presencetype . الزامی. یکی از مواردی که نحوه ارائه شواهد را نشان میدهد. presencetype فقط میتواند یکی از موارد زیر باشد: | |
encryptedData | مقدار رمزگذاری شده و فراداده رمزگذاری لازم برای رمزگشایی مقدار. |
unencryptedValue | مقدار کدگذاری شدهی base64 شواهد. |
unencryptedInteger | مقدار صحیح شواهد. |
تأیید مجددزمینه
زمینه مورد نیاز برای شروع تأیید مجدد اعتبارنامه.
| نمایش JSON |
|---|
{ "credentialId": string } |
| فیلدها | |
|---|---|
credentialId | الزامی. شناسهی اعتباری که تأیید مجدد روی آن انجام میشود. |