Method: vdc.getCredentialStatus

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

בקשת HTTP

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

גוף הבקשה

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

ייצוג JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
שדות
requestMetadata

object (RequestMetadata)

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

string

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

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

string

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

גוף התשובה

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

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

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

object (ResponseMetadata)

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

object (CredentialStatus)

חובה. הסטטוס הנוכחי של פרטי הכניסה.
credentialVersionId

string

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

CredentialStatus

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

ייצוג JSON 
{
  "userActionRequired": {
    object (UserActionRequired)
  },

  // Union field status can be only one of the following:
  "provisionPending": {
    object (ProvisionPending)
  },
  "active": {
    object (Active)
  },
  "revoked": {
    object (Revoked)
  },
  "deleted": {
    object (Deleted)
  }
  // End of list of possible types for union field status.
}
שדות
userActionRequired

object (UserActionRequired)

נדרשת פעולה מהמשתמש כדי שהאישורים שלו לא יעברו למצב מוגבל יותר (למשל, ACTIVE -> REVOKED).
שדה איחוד status. חובה. אובייקט oneof שמכיל את הסטטוסים השונים האפשריים של פרטי הכניסה. הערך status יכול להיות רק אחד מהבאים:
provisionPending

object (ProvisionPending)

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

object (Active)

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

object (Revoked)

מייצג אישור שאי אפשר להשתמש בו יותר. אי אפשר להשתמש בהרשאה הזו בעתיד. המצב הזה דומה למצב DELETED, אבל רק המנפיק יכול להגדיר אותו.
deleted

object (Deleted)

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

ProvisionPending

בסוג הזה אין שדות.

אובייקט שמייצג סטטוס של הרשאה בהמתנה להקצאה. ההודעה הזו ריקה בכוונה כרגע. יכול להיות שבעתיד נוסיף עוד שדות.

פעיל

בסוג הזה אין שדות.

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

בוטל

בסוג הזה אין שדות.

אובייקט שמייצג סטטוס של אישור שבוטל. ההודעה הזו ריקה בכוונה כרגע. יכול להיות שבעתיד נוסיף עוד שדות.

נמחק

בסוג הזה אין שדות.

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

UserActionRequired

אובייקט שמייצג משימה או פעולה שהמשתמש צריך להשלים.

ייצוג JSON 
{
  "deadlineTimeMillis": string,
  "deadlineEnforcementHint": {
    object (EnforcementHint)
  },

  // Union field action can be only one of the following:
  "submitProofing": {
    object (SubmitProofing)
  }
  // End of list of possible types for union field action.
}
שדות
deadlineTimeMillis

string (int64 format)

זמן ה-epoch שבו הפעולה מסתיימת והמנפיק צפוי להעביר את פרטי הכניסה למצב מוגבל יותר. הלקוח משתמש בפרמטר הזה כדי להזהיר את המשתמש לגבי המועד האחרון להשלמת הפעולה, אבל הסמכות לאכוף את ההגבלות נתונה למנפיק.
deadlineEnforcementHint

object (EnforcementHint)

רמז שמתאר איך הגורם המנפיק יאכוף את המועד האחרון לביצוע הפעולה.
שדה איחוד action. הפעולה שהמשתמש צריך להשלים. הערך action יכול להיות רק אחד מהבאים:
submitProofing

object (SubmitProofing)

שליחת הגהה של פרטי הכניסה.

EnforcementHint

רמז שמתאר איך הגורם שהנפיק את האישור יאכוף את הפעולה הנדרשת.

ייצוג JSON 
{

  // Union field hint can be only one of the following:
  "revocationHint": {
    object (RevocationHint)
  }
  // End of list of possible types for union field hint.
}
שדות
שדה איחוד hint. סוג רמז האכיפה. הערך hint יכול להיות רק אחד מהבאים:
revocationHint

object (RevocationHint)

הנפקן יבטל את פרטי הכניסה.

RevocationHint

בסוג הזה אין שדות.

הנפקן יבטל את פרטי הכניסה.

SubmitProofing

פרטים על סטטוס ההגהה.

ייצוג JSON 
{

  // Union field ProofingAllowance can be only one of the following:
  "limitedAttempts": {
    object (LimitedAttempts)
  },
  "unlimitedAttempts": {
    object (UnlimitedAttempts)
  }
  // End of list of possible types for union field ProofingAllowance.
}
שדות
שדה איחוד ProofingAllowance. ניסיון האימות של פרטי הכניסה הנוכחיים. הערך ProofingAllowance יכול להיות רק אחד מהבאים:
limitedAttempts

object (LimitedAttempts)

למשתמש יש מספר מוגבל של ניסיונות לשלוח הוכחה.
unlimitedAttempts

object (UnlimitedAttempts)

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

LimitedAttempts

למשתמש יש מספר מוגבל של ניסיונות לשלוח הוכחה.

ייצוג JSON 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
שדות
remainingAttempts

integer

מספר הניסיונות שנותרו לשליחת הוכחה. ההגדרה הזו משפיעה רק על הצגת ההודעות למשתמשים. ‫Google Wallet לא יפעל עם המספר הזה.
maxAttempts

integer

הגעת למספר המקסימלי של ניסיונות לשליחת הוכחות. ההגדרה הזו משפיעה רק על הצגת ההודעות למשתמשים. ‫Google Wallet לא יפעל עם המספר הזה.
maxAttemptsEnforcementHint

object (EnforcementHint)

הערה שמתארת איך הגורם המנפיק יאכוף את מספר הניסיונות המקסימלי.

UnlimitedAttempts

בסוג הזה אין שדות.

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