Method: vdc.getCredentialStatus

Ein Endpunkt, um den aktuellen Status eines Berechtigungsnachweises abzurufen.

HTTP-Anfrage

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

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string
}
Felder
requestMetadata

object (RequestMetadata)

Die Metadaten zur Anfrage, erforderlich in allen Anfragen.
deviceReferenceId

string

Die zum Gerät gehörende ID und der mit dem Gerät verknüpfte Identitätsschlüssel. Dabei handelt es sich NICHT um eine Geräte-ID. Wenn ein Nutzer zwei verschiedene Ausweisdokumente auf demselben Gerät verwendet, unterscheidet sich diese ID bei beiden voneinander.

Die ID wird bei allen Anfragen angegeben und kann dazu verwendet werden, Anfragen zu korrelieren.
credentialId

string

Die ID des Berechtigungsnachweises, für den der Status abgerufen wird.

Antworttext

Eine Antwort mit dem aktuellen Status eines Berechtigungsnachweises.

Bei Erfolg enthält der Antworttext Daten mit der folgenden Struktur:

JSON-Darstellung 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credentialStatus": {
    object (CredentialStatus)
  },
  "credentialVersionId": string
}
Felder
responseMetadata

object (ResponseMetadata)

Die Metadaten zur Antwort, erforderlich in allen Antworten.
credentialStatus

object (CredentialStatus)

Der aktuelle Status des Berechtigungsnachweises.
credentialVersionId

string

Die aktuelle Version des Berechtigungsnachweises. Dieser Wert ändert sich, wenn neue Versionen des Berechtigungsnachweises verfügbar werden. Dies ist beispielsweise der Fall, wenn der Nutzer die Adresse in seinem Berechtigungsnachweis ändert und damit die zugrunde liegende mdoc veraltet ist.

CredentialStatus

Ein Objekt, das die verschiedenen Status darstellt, die ein Berechtigungsnachweis haben kann.

JSON-Darstellung 
{
  "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.
}
Felder
userActionRequired

object (UserActionRequired)

Vom Nutzer erforderliche Maßnahmen, um zu verhindern, dass seine Anmeldedaten in einen eingeschränkteren Status übergehen (z.B. AKTIV –> WIDERRUFEN).
Union-Feld status. Ein „oneof“, das die verschiedenen möglichen Status für einen Berechtigungsnachweis enthält. Für status ist nur einer der folgenden Werte zulässig:
provisionPending

object (ProvisionPending)

Stellt einen Berechtigungsnachweis dar, der abgerufen werden kann, jedoch bislang noch keinen ProofOfProvisioning vorgelegt hat. Alle Aufrufe von „vdc.provisionMobileSecurityObjects“ für einen Berechtigungsnachweis mit diesem Status schlagen fehl, wenn die Anforderung keinen aktualisierten ProofOfProvisioning enthält. Ein Berechtigungsnachweis wird in diesen Status versetzt, wenn er erstellt wird und wenn eine neue Version des Berechtigungsnachweises verfügbar wird. Bei einer neuen Version muss das Wallet den Berechtigungsnachweis neu bereitstellen und ProofOfProvisioning vorlegen, um wieder in den Status AKTIV wechseln zu können.
active

object (Active)

Stellt einen aktiven und nutzbaren Berechtigungsnachweis dar. MSOs können nur für Berechtigungsnachweise mit dem Status AKTIV abgerufen werden.
revoked

object (Revoked)

Stellt einen Berechtigungsnachweis mit einem endgültigen Status als nicht nutzbar dar. Dieser Berechtigungsnachweis kann in der Zukunft nicht nutzbar werden. Dieser Status ist mit dem Status GELÖSCHT vergleichbar, kann aber nur vom Aussteller festgelegt werden.
deleted

object (Deleted)

Stellt einen Berechtigungsnachweis dar, der einmal bereitgestellt war, aber vom Gerät gelöscht wurde. Dieser Status ist mit dem Status WIDERRUFEN vergleichbar, kann aber nur vom Wallet festgelegt werden.

ProvisionPending

Dieser Typ hat keine Felder.

Ein Objekt, das den Status darstellt, dass die Bereitstellung für einen Berechtigungsnachweis aussteht. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

Aktiv

Dieser Typ hat keine Felder.

Ein Objekt, das den Status „Aktiv“ eines Berechtigungsnachweises darstellt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

Aufgehoben

Dieser Typ hat keine Felder.

Ein Objekt, das den Status „Widerrufen“ eines Berechtigungsnachweises darstellt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

Gelöscht

Dieser Typ hat keine Felder.

Ein Objekt, das den Status „Gelöscht“ eines Berechtigungsnachweises darstellt. Diese Nachricht ist derzeit absichtlich leer. Neue Felder können in Zukunft hinzugefügt werden.

UserActionRequired

Ein Objekt, das eine Aufgabe / Aktion darstellt, die der Nutzer ausführen muss.

JSON-Darstellung 
{
  "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.
}
Felder
deadlineTimeMillis

string (int64 format)

Die Unix-Zeit, zu der die Aktion abläuft und der Aussteller die Anmeldedaten in einen eingeschränkteren Status versetzen soll. Wird vom Client verwendet, um den Nutzer zu warnen, bis wann die Aktion abgeschlossen sein muss. Es liegt jedoch im Ermessen des Ausstellers, Einschränkungen durchzusetzen.
deadlineEnforcementHint

object (EnforcementHint)

Hinweis, der beschreibt, wie der Aussteller die Frist für die Maßnahme durchsetzen würde.
Union-Feld action. Die Aktion, die der Nutzer ausführen muss. Für action ist nur einer der folgenden Werte zulässig:
submitProofing

object (SubmitProofing)

Reichen Sie einen Nachweis für die Anmeldedaten ein.

EnforcementHint

Hinweis, der beschreibt, wie der Aussteller die erforderliche Maßnahme durchsetzen würde.

JSON-Darstellung 
{

  // Union field hint can be only one of the following:
  "revocationHint": {
    object (RevocationHint)
  }
  // End of list of possible types for union field hint.
}
Felder
Union-Feld hint. Art des Hinweises zur Durchsetzung. Für hint ist nur einer der folgenden Werte zulässig:
revocationHint

object (RevocationHint)

Die Anmeldedaten werden vom Aussteller widerrufen.

RevocationHint

Dieser Typ hat keine Felder.

Die Anmeldedaten werden vom Aussteller widerrufen.

SubmitProofing

Details zum Proofing-Status.

JSON-Darstellung 
{

  // 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.
}
Felder
Union-Feld ProofingAllowance. Der Proofing-Versuch für den aktuellen Berechtigungsnachweis. Für ProofingAllowance ist nur einer der folgenden Werte zulässig:
limitedAttempts

object (LimitedAttempts)

Der Nutzer hat nur eine begrenzte Anzahl von Versuchen, einen Nachweis einzureichen.
unlimitedAttempts

object (UnlimitedAttempts)

Der Nutzer kann den Nachweis beliebig oft einreichen. Dies wird dem Aussteller nicht empfohlen.

LimitedAttempts

Der Nutzer hat nur eine begrenzte Anzahl von Versuchen, einen Nachweis einzureichen.

JSON-Darstellung 
{
  "remainingAttempts": integer,
  "maxAttempts": integer,
  "maxAttemptsEnforcementHint": {
    object (EnforcementHint)
  }
}
Felder
remainingAttempts

integer

Die Anzahl der verbleibenden Versuche zum Einreichen des Nachweises. Dies dient nur zur Anzeige von UX-Meldungen. Google Wallet reagiert nicht auf diese Nummer.
maxAttempts

integer

Maximale Anzahl von Versuchen zum Einreichen von Nachweisen. Dies dient nur zur Anzeige von UX-Meldungen. Google Wallet reagiert nicht auf diese Nummer.
maxAttemptsEnforcementHint

object (EnforcementHint)

Hinweis, der beschreibt, wie der Aussteller die maximale Anzahl von Versuchen durchsetzen würde.

UnlimitedAttempts

Dieser Typ hat keine Felder.

Der Nutzer kann den Nachweis beliebig oft einreichen. Dies wird dem Aussteller nicht empfohlen.