Method: vdc.getCredentialStatus

क्रेडेंशियल की मौजूदा स्थिति पाने के लिए एक एंडपॉइंट.

एचटीटीपी अनुरोध

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)

यह ऐसे क्रेडेंशियल को दिखाता है जिसे वापस पाया जा सकता है, लेकिन अब तक ProofOfProvisioning नहीं दिया गया है. इस स्थिति में, क्रेडेंशियल के लिए vdc.provisionMobileSecurityObjects को किए गए सभी कॉल फ़ेल होने चाहिए. ऐसा तब होगा, जब अनुरोध में अपडेट किया गया ProofOfProvisioning शामिल न हो. क्रेडेंशियल को इस स्थिति में तब रखा जाता है, जब उसे बनाया जाता है. साथ ही, जब क्रेडेंशियल का नया वर्शन उपलब्ध होता है. नए वर्शन के मामले में, वॉलेट को क्रेडेंशियल फिर से उपलब्ध कराना होगा. साथ ही, ACTIVE स्थिति में वापस जाने के लिए, ProofOfProvisioning उपलब्ध कराना होगा.
active

object (Active)

यह एक ऐसे क्रेडेंशियल को दिखाता है जिसका इस्तेमाल किया जा सकता है. एमएसओ सिर्फ़ ऐसे क्रेडेंशियल के लिए वापस पाए जा सकते हैं जो ACTIVE स्थिति में हो.
revoked

object (Revoked)

यह ऐसे क्रेडेंशियल को दिखाता है जो इस्तेमाल नहीं किया जा सकता. इस क्रेडेंशियल का इस्तेमाल आने वाले समय में नहीं किया जा सकेगा. यह स्थिति, मिटाए गए स्टेटस जैसी होती है. हालांकि, इसे सिर्फ़ जारी करने वाला व्यक्ति सेट कर सकता है.
deleted

object (Deleted)

यह ऐसे क्रेडेंशियल को दिखाता है जिसे पहले उपलब्ध कराया गया था, लेकिन डिवाइस से मिटा दिया गया है. यह स्थिति, REVOKED से मिलती-जुलती है. हालांकि, इसे सिर्फ़ Wallet सेट कर सकता है.

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)

वह इपॉक टाइम जब कार्रवाई की समयसीमा खत्म हो जाती है और जारी करने वाले व्यक्ति या कंपनी को क्रेडेंशियल को ज़्यादा प्रतिबंधित स्थिति में ले जाना होता है. क्लाइंट इस कुकी का इस्तेमाल, उपयोगकर्ता को यह चेतावनी देने के लिए करता है कि कार्रवाई कब तक पूरी करनी है. हालांकि, पाबंदियां लागू करने का फ़ैसला जारी करने वाले के पास होता है.
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

इस टाइप में कोई फ़ील्ड नहीं है.

उपयोगकर्ता के पास, पहचान की पुष्टि करने के लिए असीमित मौके होते हैं. हमारा सुझाव है कि पास जारी करने वाली कंपनी ऐसा न करे.