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)

Wymagane. Metadane żądania wymagane we wszystkich żądaniach.

deviceReferenceId

string

Wymagane. Identyfikator odpowiadający urządzeniu i klucz tożsamości powiązany z urządzeniem. To NIE jest identyfikator urządzenia. 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 korelowania żądań.

credentialId

string

Wymagane. 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

Wymagane. Nieprzezroczysty identyfikator reprezentujący weryfikację z konkretnym pakietem dowodów na konkretnym urządzeniu.

Weryfikacja musi być w stanie Approved. W przeciwnym razie należy zwrócić komunikat ErrorResponse z nieprawidłowym identyfikatorem.

deviceEncryptionKey

object (DeviceEncryptionKey)

Wymagane. Obiekt zawierający efemeryczny klucz szyfrowania urządzenia i powiązane metadane. Ten klucz służy do szyfrowania wartości z powrotem na urządzeniu. Ten obiekt może nie być dostępny w środowisku piaskownicy podczas wdrażania, co oznacza, że wydawca powinien zwracać dane w postaci zwykłego tekstu. W środowisku produkcyjnym ten obiekt powinien być zawsze ustawiony.

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)

Wymagane. Metadane odpowiedzi wymagane we wszystkich odpowiedziach.

credential

object (Credential)

Wymagane. Udostępniony certyfikat.

credentialVersionId

string

Wymagane. Aktualna wersja udostępnionych danych logowania.

Certyfikat

Dane logowania oparte na mdoc, zgodnie z odpowiednią normą ISO dotyczącą typu danych logowania.

Na przykład w przypadku mobilnego prawa jazdy byłaby to norma ISO/IEC 18013-5. Format mDoc mDL 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. Wymagane. Pole oneof wskazujące, jak prezentowane są dane logowania. presencetype może mieć tylko jedną z tych wartości:
encryptedData

object (EncryptedData)

Zaszyfrowana wartość i metadane szyfrowania niezbędne do odszyfrowania wartości.

unencryptedValue

string

Wartość danych logowania zakodowana w formacie base64.