Udostępnij za pośrednictwem


Reguły i odniesienie do definicji wyświetlania

Definicje reguł i sposobu wyświetlania służą do określania poświadczeń. Więcej informacji na ten temat można przeczytać w temacie Jak dostosować poświadczenia.

typ rulesModel

Właściwość Typ Opis
attestations idTokenAttestation i/lub idTokenHintAttestation i/lub weryfikowalnePresentationAttestation i/lub selfIssuedAttestation definiuje przepływy potwierdzania, które służą do gromadzenia oświadczeń do wystawienia w weryfikowalnym poświadczeniu.
validityInterval Liczba reprezentuje żywotność poświadczeń w sekundach
vc vcType weryfikowalne typy poświadczeń dla tego kontraktu

Przykład typu zaświadczania w formacie JSON. Zwróć uwagę, że selfIssued to pojedynczy element, podczas gdy pozostałe są kolekcjami. Przykłady użycia typu zaświadczania można znaleźć w temacie Sample JSON rules definitions (Przykładowe definicje reguł JSON) w przewodnikach z instrukcjami .

"attestations": {
  "idTokens": [],
  "idTokenHints": [],
  "presentations": [],
  "selfIssued": {}
}

typ idTokenAttestation

Po zalogowaniu użytkownika z poziomu aplikacji Authenticator możesz użyć zwróconego tokenu identyfikatora od dostawcy zgodnego z protokołem OpenID Connect jako danych wejściowych.

Właściwość Typ Opis
mapping claimMapping (opcjonalnie) reguły mapowania oświadczeń wejściowych na oświadczenia wyjściowe w poświadczeniach weryfikowalnych
configuration ciąg (adres URL) lokalizacja dokumentu konfiguracji dostawcy tożsamości
clientId string identyfikator klienta do użycia podczas uzyskiwania tokenu identyfikatora
redirectUri string Kod URI przekierowania do użycia podczas uzyskiwania tokenu identyfikatora; MUSI TO BYĆ vcclient://openid/
scope string rozdzielana spacją lista zakresów do użycia podczas uzyskiwania tokenu identyfikatora
required boolean (domyślnie fałsz) wskazuje, czy to zaświadczenie jest wymagane, czy nie
trustedIssuers ciąg opcjonalny (tablica) lista identyfikatorów DID, które mogą wystawiać weryfikowalne poświadczenia dla tego kontraktu. Ta właściwość jest używana tylko w określonych scenariuszach, w których id_token_hint może pochodzić z innego wystawcy

idTokenHintAttestation, typ

Ten przepływ używa ID Token Hint, który jest dostarczany jako ładunek za pośrednictwem REST API żądań. Mapowanie jest takie samo jak w przypadku zaświadczania tokenu identyfikatora.

Właściwość Typ Opis
mapping claimMapping (opcjonalnie) reguły mapowania oświadczeń wejściowych na oświadczenia wyjściowe w poświadczeniach weryfikowalnych
required wartość logiczna (wartość domyślna false) wskazuje, czy to zaświadczenie jest wymagane, czy nie. Żądanie usługi API nie powiedzie się, jeśli wymagane oświadczenia nie są ustawione w ładunku createPresentationRequest.
trustedIssuers ciąg opcjonalny (tablica) lista identyfikatorów DID, które mogą wystawiać weryfikowalne poświadczenia dla tej umowy. Ta właściwość jest używana tylko w określonych scenariuszach, w których id_token_hint może pochodzić z innego wystawcy

atestacja weryfikowalnej prezentacji, typ

Gdy chcesz, aby użytkownik przedstawił kolejne weryfikowalne poświadczenie jako dane wejściowe do nowo wystawionego weryfikowalnego poświadczenia. Portfel umożliwia użytkownikowi wybranie weryfikowalnego poświadczenia podczas jego wystawiania.

Właściwość Typ Opis
mapping claimMapping (opcjonalnie) reguły mapowania oświadczeń wejściowych na oświadczenia wyjściowe w poświadczeniach weryfikowalnych
credentialType ciąg (opcjonalnie) wymagany typ uwierzytelnienia wejściowych
required wartość logiczna (wartość domyślna false) wskazuje, czy to zaświadczenie jest wymagane, czy nie
trustedIssuers ciąg (tablica) lista DID-ów, które mogą wystawiać weryfikowalne poświadczenia dla tego kontraktu. Usługa domyślnie wybiera wystawcę automatycznie, więc nie musisz podawać tej wartości samodzielnie.

selfIssuedAttestation type (typ selfIssuedAttestation)

Gdy chcesz, aby użytkownik wprowadzał informacje samodzielnie. Ten typ jest również nazywany danymi wejściowymi potwierdzonymi samodzielnie.

Właściwość Typ Opis
mapping claimMapping (opcjonalnie) reguły mapowania oświadczeń wejściowych na oświadczenia wyjściowe w poświadczeniach weryfikowalnych
required wartość logiczna (wartość domyślna false) wskazuje, czy to zaświadczenie jest wymagane, czy nie

typ claimMapping

Właściwość Rodzaj Opis
inputClaim string nazwa roszczenia do użycia z danych wejściowych
outputClaim ciąg / sznurek nazwa oświadczenia w weryfikowalnym poświadczeniu
indexed wartość logiczna (wartość domyślna false) wskazuje, czy wartość tego oświadczenia jest używana do wyszukiwania; tylko jeden obiekt clientMapping jest indeksowalny dla danego kontraktu
required wartość logiczna (wartość domyślna false) wskazuje, czy to mapowanie jest wymagane, czy nie
type ciąg (opcjonalnie) typ oświadczenia

Typ vcType

Właściwość (or Nieruchomość/Własność, depending on context) Rodzaj Opis
type ciąg (tablica) lista weryfikowalnych typów poświadczeń, które mogą być wystawiane przez ten kontrakt

Przykładowa definicja reguł:

{
  "attestations": {
    "idTokenHints": [
      {
        "mapping": [
          {
            "outputClaim": "givenName",
            "required": false,
            "inputClaim": "given_name",
            "indexed": false
          },
          {
            "outputClaim": "familyName",
            "required": false,
            "inputClaim": "family_name",
            "indexed": false
          }
        ],
        "required": false
      }
    ]
  },
  "validityInterval": 2592000,
  "vc": {
    "type": [
      "VerifiedCredentialExpert"
    ]
  }
}

typ modelu wyświetlania

Właściwość Typ Opis
locale string ustawienia regionalne tego ekranu
credential displayCredential parametry wyświetlania poświadczeń weryfikowalnych
consent displayConsent dane uzupełniające po wystawieniu weryfikowalnego poświadczenia
claims displayClaims array etykiety oświadczeń zawartych w poświadczeniach weryfikowalnych

typ poświadczenia wizualnego

Właściwość Typ Opis
title ciąg znaków tytuł poświadczenia
issuedBy ciąg znaków nazwa wystawcy poświadczeń
backgroundColor liczba szesnastkowa kolor tła poświadczenia w formacie szesnastkowym, na przykład #FFAABB
textColor liczba (heksadecymalna) kolor tekstu poświadczeń w formacie szesnastkowym, na przykład #FFAABB
description string tekst uzupełniający wyświetlany obok każdego poświadczenia
logo displayCredentialLogo logo do użycia przy poświadczeniu

displayCredentialLogo typ

Własność Rodzaj Opis
uri ciąg (adres URL) adres URL logo.
description ciąg znaków opisy loga

Uwaga

Firma Microsoft zaleca używanie powszechnie obsługiwanych formatów obrazów, takich jak .PNG, .JPG lub .BMP, w celu zmniejszenia błędów formatowania plików.

displayConsent typ

Nieruchomość Rodzaj Opis
title string tytuł zgody
instructions string tekst uzupełniający do użycia podczas wyświetlania zgody

typ wyświetlania roszczeń

Właściwość Typ Opis
label string etykieta roszczenia na wyświetlaczu
claim string nazwa oświadczenia, do którego ma zastosowanie etykieta. W przypadku formatu JWT-VC wartość musi mieć vc.credentialSubject. prefiks.
type string typ oświadczenia
description ciąg (opcjonalnie) opis oświadczenia

Przykładowa definicja wyświetlania:

{
  "locale": "en-US",
  "card": {
    "backgroundColor": "#FFA500",
    "description": "This is your Verifiable Credential",
    "issuedBy": "Contoso",
    "textColor": "#FFFF00",
    "title": "Verifiable Credential Expert",
    "logo": {
      "description": "Default VC logo",
      "uri": "https://didcustomerplayground.z13.web.core.windows.net/VerifiedCredentialExpert_icon.png"
    }
  },
  "consent": {
    "instructions": "Please click accept to add this credentials",
    "title": "Do you want to accept the verified credential expert dentity?"
  },
  "claims": [
    {
      "claim": "vc.credentialSubject.givenName",
      "label": "Name",
      "type": "String"
    },
    {
      "claim": "vc.credentialSubject.familyName",
      "label": "Surname",
      "type": "String"
    }
  ]
}

Następne kroki