Szabályok és megjelenítési definíció referenciája

Cikk
12/07/2023

A szabályok és a megjelenítési definíciók a hitelesítő adatok meghatározására szolgálnak. Erről a hitelesítő adatok testreszabása című témakörben olvashat bővebben.

rulesModel típus

Tulajdonság	Type	Description
`attestations`	idTokenAttestation and/or idTokenHintAttestation and/or verifiablePresentationAttestation and/or selfIssuedAttestation	meghatározza az igazolási folyamatot(ok) az ellenőrizhető hitelesítő adatokban kibocsátandó jogcímek gyűjtéséhez.
`validityInterval`	number	a hitelesítő adatok élettartamát jelöli másodpercekben
`vc`	vcType	a szerződés ellenőrizhető hitelesítő adatai

Az igazolás típusának példája a JSON-ban. Figyelje meg, hogy selfIssued ez egyetlen példány, míg a többi gyűjtemény. Az igazolási típus használatára példaként tekintse meg a JSON-mintaszabályok definícióit a útmutatókban.

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

idTokenAttestation type

Amikor bejelentkezik a felhasználóba az Authenticatoron belül, az OpenID Csatlakozás kompatibilis szolgáltatótól kapott azonosító jogkivonatot használhatja bemenetként.

Tulajdonság	Type	Description
`mapping`	claimMapping (nem kötelező)	szabályok a bemeneti jogcímek kimeneti jogcímekké való leképezéséhez az ellenőrizhető hitelesítő adatokban
`configuration`	sztring (URL)	az identitásszolgáltató konfigurációs dokumentumának helye
`clientId`	sztring	az azonosító jogkivonat beszerzésekor használandó ügyfélazonosító
`redirectUri`	sztring	átirányítási uri az azonosító jogkivonatának beszerzésekor; KELL `vcclient://openid/`
`scope`	sztring	az azonosító jogkivonat beszerzésekor használandó hatókörök szóközzel tagolt listája
`required`	logikai (alapértelmezett hamis)	annak jelzése, hogy szükséges-e ez az igazolás, vagy sem
`trustedIssuers`	opcionális sztring (tömb)	azon DID-k listája, amely lehetővé teszi a szerződés ellenőrizhető hitelesítő adatainak kiállítását. Ez a tulajdonság csak olyan helyzetekben használatos, ahol a `id_token_hint` tulajdonság egy másik kiállítótól származhat

idTokenHintAttestation típus

Ez a folyamat az ID Token Hintet használja, amely hasznos adatként van megadva a Rest API kérése révén. A megfeleltetés megegyezik az azonosító jogkivonat-igazoláséval.

Tulajdonság	Type	Description
`mapping`	claimMapping (nem kötelező)	szabályok a bemeneti jogcímek kimeneti jogcímekké való leképezéséhez az ellenőrizhető hitelesítő adatokban
`required`	logikai (alapértelmezett hamis)	jelzi, hogy szükséges-e ez az igazolás. A Request Service API sikertelen lesz, ha a szükséges jogcímek nincsenek beállítva a createPresentationRequest hasznos adatai között.
`trustedIssuers`	opcionális sztring (tömb)	azon DID-k listája, amely lehetővé teszi a szerződés ellenőrizhető hitelesítő adatainak kiállítását. Ez a tulajdonság csak olyan helyzetekben használatos, ahol a `id_token_hint` tulajdonság egy másik kiállítótól származhat

verifiablePresentationAttestation type

Ha azt szeretné, hogy a felhasználó egy új, ellenőrizhető hitelesítő adat bemeneteként adjon meg egy másik ellenőrizhető hitelesítő adatot. A tárca lehetővé teszi a felhasználó számára az ellenőrizhető hitelesítő adatok kiválasztását a kiállítás során.

Tulajdonság	Type	Description
`mapping`	claimMapping (nem kötelező)	szabályok a bemeneti jogcímek kimeneti jogcímekké való leképezéséhez az ellenőrizhető hitelesítő adatokban
`credentialType`	sztring (nem kötelező)	a bemenet szükséges hitelesítő adattípusa
`required`	logikai (alapértelmezett hamis)	annak jelzése, hogy szükséges-e ez az igazolás, vagy sem
`trustedIssuers`	sztring (tömb)	azon DID-k listája, amely lehetővé teszi a szerződés ellenőrizhető hitelesítő adatainak kiállítását. A szolgáltatás alapértelmezés szerint a kibocsátóra vonatkozik a fedezetek alatt, így önnek nem kell megadnia ezt az értéket.

selfIssuedAttestation típus

Ha azt szeretné, hogy a felhasználó saját maga adja meg az adatokat. Ezt a típust önigazolt bemenetnek is nevezik.

Tulajdonság	Type	Description
`mapping`	claimMapping (nem kötelező)	szabályok a bemeneti jogcímek kimeneti jogcímekké való leképezéséhez az ellenőrizhető hitelesítő adatokban
`required`	logikai (alapértelmezett hamis)	annak jelzése, hogy szükséges-e ez az igazolás, vagy sem

claimMapping típus

Tulajdonság	Type	Description
`inputClaim`	sztring	a bemenetből használandó jogcím neve
`outputClaim`	sztring	a jogcím neve az ellenőrizhető hitelesítő adatokban
`indexed`	logikai (alapértelmezett hamis)	annak jelzése, hogy a jogcím értéke keresésre van-e használva; egy adott szerződéshez csak egy clientMapping objektum indexelhető
`required`	logikai (alapértelmezett hamis)	annak jelzése, hogy szükséges-e ez a megfeleltetés
`type`	sztring (nem kötelező)	jogcím típusa

vcType típus

Tulajdonság	Type	Description
`type`	sztring (tömb)	a szerződés által kibocsátható ellenőrizhető hitelesítő adatok listája

Példa szabályok definíciója:

{
  "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 típus

Tulajdonság	Type	Description
`locale`	sztring	a kijelző területi beállítása
`credential`	displayCredential	az ellenőrizhető hitelesítő adatok megjelenítési tulajdonságai
`consent`	displayConsent	kiegészítő adatok az ellenőrizhető hitelesítő adatok kiadásakor
`claims`	displayClaims tömb	az ellenőrizhető hitelesítő adatokban szereplő jogcímek címkéi

displayCredential type

Tulajdonság	Type	Description
`title`	sztring	a hitelesítő adatok címe
`issuedBy`	sztring	a hitelesítő adatok kiállítójának neve
`backgroundColor`	szám (hexa)	a hitelesítő adatok háttérszíne hexa formátumban, például #FFAABB
`textColor`	szám (hexa)	a hitelesítő adatok szövegszíne hexa formátumban, például #FFAABB
`description`	sztring	kiegészítő szöveg jelenik meg az egyes hitelesítő adatok mellett
`logo`	displayCredentialLogo	a hitelesítő adatokhoz használandó embléma

displayCredentialLogo típus

Tulajdonság	Type	Description
`uri`	sztring (URL)	embléma URL-címe.
`description`	sztring	az embléma leírása

displayConsent típus

Tulajdonság	Type	Description
`title`	sztring	a hozzájárulás címe
`instructions`	sztring	a hozzájárulás megjelenítésekor használandó kiegészítő szöveg

displayClaims típus

Tulajdonság	Type	Description
`label`	sztring	a jogcím címkéje látható
`claim`	sztring	annak a jogcímnek a neve, amelyre a címke vonatkozik. A JWT-VC formátumhoz az értéknek rendelkeznie kell az `vc.credentialSubject.` előtaggal.
`type`	sztring	a jogcím típusa
`description`	sztring (nem kötelező)	a jogcím leírása

Példa megjelenítési definícióra:

{
  "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.blob.core.windows.net/public/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"
    }
  ]
}

További lépések

További információ a hitelesítő adatok testreszabásáról

Megosztás a következőn keresztül: