Method: vdc.provisionCredential

Ein Endpunkt, um einen Berechtigungsnachweis bereitzustellen.

HTTP-Anfrage

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

Anfragetext

Der Anfragetext enthält Daten mit folgender Struktur:

JSON-Darstellung 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string,
  "proofingId": string,
  "deviceEncryptionKey": {
    object (DeviceEncryptionKey)
  }
}
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

Eine intransparente Kennung, die einen bestimmten Berechtigungsnachweis auf einem Gerät darstellt.

Wenn die Berechtigungsnachweis-ID bereits existiert, sollte diese Methode die bestehenden Berechtigungsnachweise zurückgeben, anstatt neue zu erstellen.

Beispiel: UUID
proofingId

string

Eine intransparente Kennung, die eine Prüfung mit einem speziellen Nachweisbündel für ein bestimmtes Gerät darstellt.

Das Proofing muss im Status „Genehmigt“ sein. Ansonsten sollte die ungültige Kennzeichnung ErrorResponse zurückgegeben werden.
deviceEncryptionKey

object (DeviceEncryptionKey)

Ein Objekt, das den sitzungsspezifischen Verschlüsselungsschlüssel und die zugehörigen Metadaten enthält. Dieser Schlüssel wird zur Verschlüsselung eines Werts auf dem Gerät verwendet. Das Objekt darf beim Einrichtungsprozess nicht in der Sandbox-Umgebung verwendet werden, um anzugeben, dass der Aussteller Klartextdaten zurückgeben sollte. Dies sollte immer in der Produktionsumgebung erfolgen.

Antworttext

Eine Antwort, die den bereitgestellten Berechtigungsnachweis enthält.

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

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

object (ResponseMetadata)

Die Metadaten zur Antwort, erforderlich in allen Antworten.
credential

object (Credential)

Der bereitgestellte Berechtigungsnachweis.
credentialVersionId

string

Die aktuelle Version des bereitgestellten Berechtigungsnachweises.

Anmeldedaten

Der mdoc-basierte Berechtigungsnachweis, gemäß der Definition im entsprechenden ISO-Standard für den Berechtigungsnachweistypen.

Bei einem Führerschein wäre das zum Beispiel der Standard ISO/IEC 18013-5. Hier finden Sie Informationen zum mDL-mDoc-Format.

JSON-Darstellung 
{

  // Union field presencetype can be only one of the following:
  "encryptedData": {
    object (EncryptedData)
  },
  "unencryptedValue": string
  // End of list of possible types for union field presencetype.
}
Felder
Union-Feld presencetype. Ein oneof, das angibt, wie der Berechtigungsnachweis vorgelegt wird. Für presencetype ist nur einer der folgenden Werte zulässig:
encryptedData

object (EncryptedData)

Der verschlüsselte Wert und die Verschlüsselungsmetadaten, die zum Entschlüsseln des Werts erforderlich sind.
unencryptedValue

string

Der base64-codierte Wert des Berechtigungsnachweises.