Reguły i dokumentacja definicji wyświetlania

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

rulesModel, typ

Właściwość	Type	Opis
attestations	idTokenAttestation i/lub idTokenHintAttestation i/lub weryfikowalnePresentationAttestation i/lub selfIssuedAttestation	definiuje przepływy zaświadczania, które mają być używane do zbierania oświadczeń do wystawiania w poświadczeniach weryfikowalnych.
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 jest to pojedyncze wystąpienie, 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": {}
}

idTokenAttestation, typ

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ść	Type	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	identyfikator URI przekierowania do użycia podczas uzyskiwania tokenu identyfikatora; MUSI BYĆ vcclient://openid/
scope	string	rozdzielana spacją lista zakresów do użycia podczas uzyskiwania tokenu identyfikatora
required	wartość logiczna (wartość domyślna false)	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 wskazówki tokenu identyfikatora, która jest dostarczana jako ładunek za pośrednictwem interfejsu API REST żądania. Mapowanie jest takie samo jak w przypadku zaświadczania tokenu identyfikatora.

Właściwość	Type	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. Wywołanie interfejsu API usługi żądań zakończy się niepowodzeniem, 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 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

verifiablePresentationAttestation, typ

Gdy chcesz, aby użytkownik przedstawił kolejne weryfikowalne poświadczenia jako dane wejściowe dla nowego wystawionego poświadczenia weryfikowalnego. Portfel umożliwia użytkownikowi wybranie weryfikowalnych poświadczeń podczas wystawiania.

Właściwość	Type	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 poświadczeń danych wejściowych
required	wartość logiczna (wartość domyślna false)	wskazuje, czy to zaświadczenie jest wymagane, czy nie
trustedIssuers	ciąg (tablica)	lista identyfikatorów DID, które mogą wystawiać weryfikowalne poświadczenia dla tego kontraktu. Usługa jest domyślnie ustawiona na wystawcę w ramach okładek, więc nie trzeba samodzielnie podawać tej wartości.

selfIssuedAttestation type (typ selfIssuedAttestation)

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

Właściwość	Type	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

claimMapping, typ

Właściwość	Type	opis
inputClaim	string	nazwa oświadczenia do użycia z danych wejściowych
outputClaim	string	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ść	Type	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"
    ]
  }
}

displayModel, typ

Właściwość	Type	opis
locale	string	ustawienia regionalne tego ekranu
credential	displayCredential	właściwości 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

displayCredential, typ

Właściwość	Type	opis
title	string	tytuł poświadczeń
issuedBy	string	nazwa wystawcy poświadczeń
backgroundColor	liczba (szesnastkowy)	kolor tła poświadczeń w formacie szesnastkowym, na przykład #FFAABB
textColor	liczba (szesnastkowy)	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 dla poświadczeń

displayCredentialLogo, typ

Właściwość	Type	Opis
uri	ciąg (adres URL)	adres URL logo.
description	string	opis logo

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

Właściwość	Type	opis
title	string	tytuł zgody
instructions	string	tekst uzupełniający do użycia podczas wyświetlania zgody

displayClaims, typ

Właściwość	Type	opis
label	string	etykieta oświadczenia wyświetlana
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

• Dowiedz się więcej na temat dostosowywania poświadczeń