Method: vdc.provisionCredential

Punkt końcowy do udostępniania danych logowania.

Żądanie HTTP

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

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "requestMetadata": {
    object (RequestMetadata)
  },
  "deviceReferenceId": string,
  "credentialId": string,
  "proofingId": string,
  "deviceEncryptionKey": {
    object (DeviceEncryptionKey)
  }
}
Pola
requestMetadata

object (RequestMetadata)

Metadane dotyczące żądania, wymagane we wszystkich żądaniach.
deviceReferenceId

string

Identyfikator odpowiadający urządzeniu i klucz tożsamości powiązany z urządzeniem. NIE jest to identyfikator urządzenia, co oznacza, że jeśli użytkownik ma 2 osobne dane logowania na tym samym urządzeniu, ten identyfikator będzie się różnić.

Ten identyfikator jest podawany we wszystkich żądaniach i może służyć do ich korelowania.
credentialId

string

Nieprzezroczysty identyfikator reprezentujący konkretne dane logowania udostępnione na urządzeniu.

Jeśli identyfikator credentialId już istnieje, ta metoda powinna zwrócić istniejące dane logowania zamiast tworzyć nowe.

Przykład: UUID
proofingId

string

Nieprzejrzysty identyfikator reprezentujący weryfikację z określonym pakietem dowodów na konkretnym urządzeniu.

Korekta musi mieć stan Zatwierdzono. W przeciwnym razie należy zwrócić ErrorResponse z informacją o nieprawidłowym identyfikatorze.
deviceEncryptionKey

object (DeviceEncryptionKey)

Obiekt zawierający tymczasowy klucz szyfrowania urządzenia i powiązane z nim metadane. Ten klucz służy do ponownego zaszyfrowania wartości na urządzeniu. Podczas wdrażania w środowisku testowym ten obiekt może nie być dostępny, co oznacza, że wydawca powinien zwracać dane w formie zwykłego tekstu. W środowisku produkcyjnym to ustawienie powinno być zawsze włączone.

Treść odpowiedzi

Odpowiedź zawierająca udostępnione dane logowania.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "responseMetadata": {
    object (ResponseMetadata)
  },
  "credential": {
    object (Credential)
  },
  "credentialVersionId": string
}
Pola
responseMetadata

object (ResponseMetadata)

Metadane dotyczące odpowiedzi, wymagane we wszystkich odpowiedziach.
credential

object (Credential)

Udostępnione dane logowania.
credentialVersionId

string

Bieżąca wersja udostępnionych danych logowania.

Dane logowania

Dokument tożsamości w formacie mdoc, zgodnie z odpowiednią normą ISO dla danego typu dokumentu.

Na przykład w przypadku mobilnego prawa jazdy będzie to ISO/IEC 18013-5. Format mDL mDoc znajdziesz tutaj.

Zapis JSON 
{

  // 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.
}
Pola
Pole zbiorcze presencetype. Typ oneof wskazujący, w jaki sposób prezentowane są dane logowania. presencetype może mieć tylko jedną z tych wartości:
encryptedData

object (EncryptedData)

zaszyfrowaną wartość i metadane szyfrowania niezbędne do odszyfrowania wartości.
unencryptedValue

string

Wartość danych logowania zakodowana w formacie base64.