Pravidla a referenční dokumentace k definici zobrazení

Článek
11/13/2024

Definice pravidel a zobrazení slouží k definování přihlašovacích údajů. Další informace o něm najdete v tématu Postup přizpůsobení přihlašovacích údajů.

typ rulesModel

Vlastnost	Type	Popis
`attestations`	idTokenAttestation a/nebo idTokenHintAttestation a/nebo ověřitelnéPresentationAttestation a/nebo selfIssuedAttestation	definuje toky ověření identity, které se mají použít ke shromažďování deklarací identity, které se vydávají v ověřitelných přihlašovacích údajích.
`validityInterval`	Číslo	představuje životnost přihlašovacích údajů v sekundách.
`vc`	vcType	ověřitelné typy přihlašovacích údajů pro tento kontrakt

Příklad typu ověření identity ve formátu JSON. Všimněte si, že selfIssued je to jedna instance, zatímco ostatní jsou kolekce. Příklady použití typu ověření identity najdete v tématu Ukázkové definice pravidel JSON v průvodcích postupy.

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

idTokenAttestation – typ

Když se přihlásíte uživatele ze služby Authenticator, můžete jako vstup použít vrácený token ID od zprostředkovatele kompatibilního s OpenID Connect.

Vlastnost	Type	Popis
`mapping`	deklarace identity ( volitelné)	pravidla pro mapování vstupních deklarací na výstupní deklarace identity v ověřitelných přihlašovacích údajích
`configuration`	řetězec (adresa URL)	umístění konfiguračního dokumentu zprostředkovatele identity
`clientId`	string	ID klienta, které se má použít při získávání tokenu ID
`redirectUri`	string	přesměrování identifikátoru URI, který se použije při získání tokenu ID; MUSÍ BÝT `vcclient://openid/`
`scope`	string	seznam oborů oddělených mezerami, které se mají použít při získání tokenu ID
`required`	logická hodnota (výchozí false)	označující, zda je toto ověření povinné, nebo ne
`trustedIssuers`	volitelný řetězec (pole)	seznam identifikátorů DID, které umožňují vydat ověřitelné přihlašovací údaje pro tuto smlouvu. Tato vlastnost se používá pouze pro konkrétní scénáře, kdy `id_token_hint` může pocházet od jiného vystavitele.

idTokenHintAttestation – typ

Tento tok používá nápovědu tokenu ID, která se poskytuje jako datová část prostřednictvím rozhraní REST API požadavku. Mapování je stejné jako pro ověření tokenu ID.

Vlastnost	Type	Popis
`mapping`	deklarace identity ( volitelné)	pravidla pro mapování vstupních deklarací na výstupní deklarace identity v ověřitelných přihlašovacích údajích
`required`	logická hodnota (výchozí false)	označující, zda je toto ověření povinné, nebo ne. Rozhraní API služby požadavku selže, pokud nejsou v datové části createPresentationRequest nastaveny požadované deklarace identity.
`trustedIssuers`	volitelný řetězec (pole)	seznam identifikátorů DID, které umožňují vydat ověřitelné přihlašovací údaje pro tuto smlouvu. Tato vlastnost se používá pouze pro konkrétní scénáře, kdy `id_token_hint` může pocházet od jiného vystavitele.

ověřitelný typPresentationAttestation

Pokud chcete, aby uživatel předložil další ověřitelné přihlašovací údaje jako vstup pro nové vystavené ověřitelné přihlašovací údaje. Peněženka umožňuje uživateli vybrat ověřitelné přihlašovací údaje během vystavování.

Vlastnost	Type	Popis
`mapping`	deklarace identity ( volitelné)	pravidla pro mapování vstupních deklarací na výstupní deklarace identity v ověřitelných přihlašovacích údajích
`credentialType`	řetězec (volitelné)	požadovaný typ přihlašovacích údajů vstupu
`required`	logická hodnota (výchozí false)	označující, zda je toto ověření povinné, nebo ne
`trustedIssuers`	řetězec (pole)	seznam identifikátorů DID, které umožňují vydat ověřitelné přihlašovací údaje pro tuto smlouvu. Služba ve výchozím nastavení odkazuje na vašeho vystavitele v rámci krytů, takže tuto hodnotu nemusíte zadávat sami.

selfIssuedAttestation – typ

Pokud chcete, aby uživatel zadal informace sám. Tento typ se také nazývá samotestovaný vstup.

Vlastnost	Type	Popis
`mapping`	deklarace identity ( volitelné)	pravidla pro mapování vstupních deklarací na výstupní deklarace identity v ověřitelných přihlašovacích údajích
`required`	logická hodnota (výchozí false)	označující, zda je toto ověření povinné, nebo ne

typ claimMapping

Vlastnost	Type	Description
`inputClaim`	string	název deklarace identity, která se má použít ze vstupu
`outputClaim`	string	název deklarace identity v ověřitelných přihlašovacích údajích
`indexed`	logická hodnota (výchozí false)	označující, zda se hodnota této deklarace identity používá k vyhledávání; Pro daný kontrakt je indexovatelný pouze jeden objekt clientMapping.
`required`	logická hodnota (výchozí false)	označující, zda je toto mapování povinné, nebo ne
`type`	řetězec (volitelné)	typ deklarace identity

Typ vcType

Vlastnost	Type	Popis
`type`	řetězec (pole)	Seznam ověřitelných typů přihlašovacích údajů, které může tento kontrakt vydat

Příklad definice pravidel:

{
  "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

Vlastnost	Type	Description
`locale`	string	národní prostředí tohoto zobrazení
`credential`	displayCredential	vlastnosti zobrazení ověřitelných přihlašovacích údajů
`consent`	displayConsent	doplňující data při vydání ověřitelných přihlašovacích údajů
`claims`	displayClaims array	popisky deklarací identity zahrnuté do ověřitelných přihlašovacích údajů

displayCredential type

Vlastnost	Type	Description
`title`	string	název přihlašovacích údajů
`issuedBy`	string	název vystavitele přihlašovacích údajů
`backgroundColor`	číslo (šestnáctkové)	barva pozadí přihlašovacích údajů v šestnáctkovém formátu, například #FFAABB
`textColor`	číslo (šestnáctkové)	barva textu přihlašovacích údajů v šestnáctkovém formátu, například #FFAABB
`description`	string	doplňkový text zobrazený společně s jednotlivými přihlašovacími údaji
`logo`	displayCredentialLogo	logo, které se má použít pro přihlašovací údaje

displayCredentialLogo – typ

Vlastnost	Type	Popis
`uri`	řetězec (adresa URL)	url loga.
`description`	string	popis loga

Poznámka:

Microsoft doporučuje používat široce podporované formáty obrázků, jako jsou .PNG, .JPG nebo .BMP, aby se snížily chyby formátu souboru.

displayConsent – typ

Vlastnost	Type	Description
`title`	string	název souhlasu
`instructions`	string	doplňkový text, který se má použít při zobrazení souhlasu

displayClaims – typ

Vlastnost	Type	Description
`label`	string	popisek deklarace identity v zobrazení
`claim`	string	název deklarace identity, na kterou se popisek vztahuje. Pro formát JWT-VC musí mít hodnota předponu `vc.credentialSubject.` .
`type`	string	typ deklarace identity
`description`	řetězec (volitelné)	popis deklarace identity

Příklad definice zobrazení:

{
  "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"
    }
  ]
}

Další kroky

Další informace o přizpůsobení přihlašovacích údajů

Sdílet prostřednictvím