Method: vdc.getCredentialStatus

Es un extremo para recuperar el estado actual de una credencial.

Solicitud HTTP

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

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
Campos
requestMetadata

object (RequestMetadata)

Son los metadatos sobre la solicitud, que se requieren en todas las solicitudes.
deviceReferenceId

string

Es el ID que corresponde al dispositivo y la clave de identidad asociada a él. NO es un ID de dispositivo, lo que significa que, si el usuario tuviera dos credenciales separadas en el mismo dispositivo, este ID sería diferente entre ellas.

Este ID se proporciona en todas las solicitudes y se puede usar para correlacionarlas.
credentialId

string

Es el ID de la credencial cuyo estado solicita el llamador.

Cuerpo de la respuesta

Es una respuesta que contiene el estado actual de una credencial.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credentialStatus": {
    object (CredentialStatus)
  },
  "credentialVersionId": string
}
Campos
responseMetadata

object (ResponseMetadata)

Son los metadatos sobre la respuesta, que se requieren en todas las respuestas.
credentialStatus

object (CredentialStatus)

Es el estado actual de la credencial.
credentialVersionId

string

Es la versión actual de la credencial. Se espera que esto cambie cuando estén disponibles las versiones nuevas de la credencial. Un ejemplo de cuándo cambiaría esto es cuando el usuario actualiza su dirección en la credencial, lo que hace que el mdoc subyacente quede obsoleto.

CredentialStatus

Es un objeto que representa los diferentes estados que puede tener una credencial.

Representación 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.
}
Campos
userActionRequired

object (UserActionRequired)

Acción que debe realizar el usuario para evitar que su credencial pase a un estado más restringido (p.ej., ACTIVA -> REVOCADA).
Campo de unión status. Es un oneof que contiene los diferentes estados posibles para una credencial. status puede ser solo uno de los parámetros siguientes:
provisionPending

object (ProvisionPending)

Representa una credencial que se puede recuperar, pero que aún no proporcionó ProofOfProvisioning. Cualquier llamada a vdc.provisionMobileSecurityObjects para una credencial en este estado debería fallar si la solicitud no contiene un ProofOfProvisioning actualizado. Una credencial se coloca en este estado cuando se crea y cuando hay una versión nueva disponible. En el caso de la versión nueva, la billetera debe volver a aprovisionar la credencial y proporcionar ProofOfProvisioning para volver a un estado ACTIVE.
active

object (Active)

Representa una credencial activa y utilizable. Los MSO solo se pueden recuperar para una credencial en estado ACTIVE.
revoked

object (Revoked)

Representa una credencial que se encuentra en un estado final y no utilizable. Esta credencial no se podrá usar en el futuro. Este estado es comparable a DELETED, pero solo lo puede establecer el emisor.
deleted

object (Deleted)

Representa una credencial que se aprovisionó en algún momento, pero que se borró del dispositivo. Este estado es comparable a REVOKED, pero solo lo puede establecer la billetera.

ProvisionPending

Este tipo no tiene campos.

Es un objeto que representa un estado de credencial pendiente de aprovisionamiento. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

Activo

Este tipo no tiene campos.

Es un objeto que representa un estado de credencial activo. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

Revocado

Este tipo no tiene campos.

Es un objeto que representa el estado de una credencial revocada. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

Borrado

Este tipo no tiene campos.

Es un objeto que representa el estado de una credencial borrada. Este mensaje está vacío a propósito en este momento. Es posible que se agreguen campos nuevos en el futuro.

UserActionRequired

Es un objeto que representa una tarea o acción que el usuario debe completar.

Representación 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.
}
Campos
deadlineTimeMillis

string (int64 format)

Fecha y hora de vencimiento de la acción, en formato de época, y en la que se espera que el emisor mueva la credencial a un estado más restringido. El cliente lo usa para advertir al usuario sobre la fecha límite para completar la acción, pero depende del emisor aplicar las restricciones.
deadlineEnforcementHint

object (EnforcementHint)

Es una sugerencia que describe cómo el emisor aplicaría el plazo de la acción.
Campo de unión action. Es la acción que el usuario debe completar. action puede ser solo uno de los parámetros siguientes:
submitProofing

object (SubmitProofing)

Envía una prueba de la credencial.

EnforcementHint

Es una sugerencia que describe cómo el emisor aplicaría la acción requerida.

Representación JSON 
{

  // Union field hint can be only one of the following:
  "revocationHint": {
    object (RevocationHint)
  }
  // End of list of possible types for union field hint.
}
Campos
Campo de unión hint. Es el tipo de sugerencia de aplicación. hint puede ser solo uno de los parámetros siguientes:
revocationHint

object (RevocationHint)

La entidad emisora revocará la credencial.

RevocationHint

Este tipo no tiene campos.

La entidad emisora revocará la credencial.

SubmitProofing

Son los detalles del estado de la prueba.

Representación 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.
}
Campos
Campo de unión ProofingAllowance. Es el intento de prueba de la credencial actual. ProofingAllowance puede ser solo uno de los parámetros siguientes:
limitedAttempts

object (LimitedAttempts)

El usuario tiene una cantidad limitada de intentos para enviar pruebas.
unlimitedAttempts

object (UnlimitedAttempts)

El usuario tiene intentos ilimitados para enviar pruebas. No se recomienda al emisor.

LimitedAttempts

El usuario tiene una cantidad limitada de intentos para enviar pruebas.

Representación JSON 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
Campos
remainingAttempts

integer

Es la cantidad de intentos restantes para enviar la prueba. Esto es solo para la visualización de mensajes de UX. La Billetera de Google no actuará sobre este número.
maxAttempts

integer

Es la cantidad máxima de intentos para enviar pruebas. Esto es solo para la visualización de mensajes de UX. La Billetera de Google no actuará sobre este número.
maxAttemptsEnforcementHint

object (EnforcementHint)

Es una sugerencia que describe cómo el emisor aplicaría la cantidad máxima de intentos.

UnlimitedAttempts

Este tipo no tiene campos.

El usuario tiene intentos ilimitados para enviar pruebas. No se recomienda al emisor.