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

与设备对应的 ID 以及与设备关联的身份密钥。此 ID 不是设备 ID，也就是说，如果用户在同一设备上拥有两个不同的凭据，则此 ID 会有所不同。

此 ID 会在所有请求中提供，可用于关联请求。
credentialId

string

调用者请求状态的凭据的 ID。

响应正文

包含凭据当前状态的响应。

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credentialStatus": {
    object (CredentialStatus)
  },
  "credentialVersionId": string
}
字段
responseMetadata

object (ResponseMetadata)

有关响应的元数据，所有响应中都需要包含此元数据。
credentialStatus

object (CredentialStatus)

凭据的当前状态。
credentialVersionId

string

凭据的当前版本。当新版本的凭据可用时，此值预计会发生变化。例如，当用户更新其凭据上的地址时，基础 mdoc 会过时，此时此值会发生变化。

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)

用户需要采取行动，以避免其凭据进入更受限的状态（例如从“有效”变为“已撤消”）。
联合字段 status。一个 oneof，包含凭据可能具有的不同状态。status 只能是下列其中一项：
provisionPending

object (ProvisionPending)

表示可检索但尚未提供 ProofOfProvisioning 的凭据。如果对处于此状态的凭据的 vdc.provisionMobileSecurityObjects 调用不包含更新后的 ProofOfProvisioning，则应失败。凭据在创建时以及有新版本的凭据可用时会进入此状态。对于新版本，钱包必须重新配置凭据并提供 ProofOfProvisioning，才能恢复到 ACTIVE 状态。
active

object (Active)

表示有效且可用的凭据。只能检索处于有效状态的凭据的 MSO。
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)

相应操作的过期时间（以纪元时间表示），以及预期发放者将凭据移至更受限状态的时间。供客户端使用，用于向用户发出有关需要在何时之前完成操作的警告，但是否强制执行限制由签发者决定。
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 钱包不会对该号码执行任何操作。
maxAttempts

integer

提交校样尝试次数上限。这仅用于显示用户体验消息。Google 钱包不会对该号码执行任何操作。
maxAttemptsEnforcementHint

object (EnforcementHint)

提示，用于说明发卡机构将如何强制执行最大尝试次数。

UnlimitedAttempts

此类型没有字段。

用户可以无限次提交验证信息。我们不建议发卡机构这样做。