Referens för regler och visningsdefinition

Artikel
11/16/2024

Regler och visningsdefinitioner används för att definiera en autentiseringsuppgift. Du kan läsa mer om det i Anpassa dina autentiseringsuppgifter.

rulesModel-typ

Property	Type	Beskrivning
`attestations`	idTokenAttestation och/eller idTokenHintAttestation och/eller verifiablePresentationAttestation och/eller selfIssuedAttestation	definierar det attesteringsflöde som ska användas för att samla in anspråk som ska utfärdas i de verifierbara autentiseringsuppgifterna.
`validityInterval`	Nummer	representerar livslängden för autentiseringsuppgifterna i sekunder
`vc`	vcType	verifierbara typer av autentiseringsuppgifter för det här kontraktet

Exemplet på attesteringstyp i JSON. Observera att det selfIssued är en enda instans medan de andra är samlingar. Exempel på hur du använder attesteringstypen finns i Exempel på JSON-regeldefinitioner i instruktionsguiderna.

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

idTokenAttestation-typ

När du loggar in användaren inifrån Authenticator kan du använda den returnerade ID-token från den OpenID Connect-kompatibla providern som indata.

Property	Type	Beskrivning
`mapping`	claimMapping (valfritt)	regler för att mappa indataanspråk till utdataanspråk i den verifierbara autentiseringsuppgiften
`configuration`	sträng (url)	plats för identitetsproviderns konfigurationsdokument
`clientId`	sträng	klient-ID som ska användas när du hämtar ID-token
`redirectUri`	sträng	omdirigerings-URI som ska användas när du hämtar ID-token. MÅSTE VARA `vcclient://openid/`
`scope`	sträng	utrymmesavgränsad lista över omfång som ska användas när du hämtar ID-token
`required`	booleskt värde (standard falskt)	som anger om detta attestering krävs eller inte
`trustedIssuers`	valfri sträng (matris)	en lista över DID:er som tillåts utfärda verifierbara autentiseringsuppgifter för det här kontraktet. Den här egenskapen används endast för specifika scenarier där `id_token_hint` kan komma från en annan utfärdare

idTokenHintAttestation-typ

Det här flödet använder ID-tokentipset, som tillhandahålls som nyttolast via REST API för begäran. Mappningen är densamma som för ID-tokenattestering.

Property	Type	Beskrivning
`mapping`	claimMapping (valfritt)	regler för att mappa indataanspråk till utdataanspråk i den verifierbara autentiseringsuppgiften
`required`	booleskt värde (standard falskt)	som anger om detta attestering krävs eller inte. Api:et för begärandetjänsten misslyckas om nödvändiga anspråk inte anges i nyttolasten createPresentationRequest.
`trustedIssuers`	valfri sträng (matris)	en lista över DID:er som tillåts utfärda verifierbara autentiseringsuppgifter för det här kontraktet. Den här egenskapen används endast för specifika scenarier där `id_token_hint` kan komma från en annan utfärdare

verifiablePresentationAttestation-typ

När du vill att användaren ska presentera en annan verifierbar autentiseringsuppgift som indata för en ny utfärdad verifierbar autentiseringsuppgift. Med plånboken kan användaren välja verifierbara autentiseringsuppgifter under utfärdandet.

Property	Type	Beskrivning
`mapping`	claimMapping (valfritt)	regler för att mappa indataanspråk till utdataanspråk i den verifierbara autentiseringsuppgiften
`credentialType`	sträng (valfritt)	nödvändig typ av autentiseringsuppgifter för indata
`required`	booleskt värde (standard falskt)	som anger om detta attestering krävs eller inte
`trustedIssuers`	sträng (matris)	en lista över DID:er som tillåts utfärda verifierbara autentiseringsuppgifter för det här kontraktet. Tjänsten är som standard utfärdaren under täcket, så du behöver inte ange det här värdet själv.

selfIssuedAttestation-typ

När du vill att användaren ska ange information själva. Den här typen kallas även för självbetitlade indata.

Property	Type	Beskrivning
`mapping`	claimMapping (valfritt)	regler för att mappa indataanspråk till utdataanspråk i den verifierbara autentiseringsuppgiften
`required`	booleskt värde (standard falskt)	som anger om detta attestering krävs eller inte

claimMapping-typ

Property	Type	Description
`inputClaim`	sträng	namnet på anspråket som ska användas från indata
`outputClaim`	sträng	namnet på anspråket i den verifierbara autentiseringsuppgiften
`indexed`	booleskt värde (standard falskt)	som anger om värdet för det här anspråket används för sökning. endast ett clientMapping-objekt kan indexeras för ett visst kontrakt
`required`	booleskt värde (standard falskt)	som anger om den här mappningen krävs eller inte
`type`	sträng (valfritt)	typ av anspråk

Typ av vcType

Property	Type	Beskrivning
`type`	sträng (matris)	en lista över verifierbara typer av autentiseringsuppgifter som det här kontraktet kan utfärda

Exempel på regeldefinition:

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

Property	Type	Description
`locale`	sträng	språkvarianten för den här skärmen
`credential`	displayCredential	visningsegenskaperna för de verifierbara autentiseringsuppgifterna
`consent`	displayConsent	kompletterande data när de verifierbara autentiseringsuppgifterna utfärdas
`claims`	displayClaims-matris	etiketter för de anspråk som ingår i de verifierbara autentiseringsuppgifterna

displayCredential-typ

Property	Type	Description
`title`	sträng	rubrik för autentiseringsuppgifterna
`issuedBy`	sträng	namnet på utfärdaren av autentiseringsuppgifterna
`backgroundColor`	tal (hex)	bakgrundsfärg för autentiseringsuppgifterna i hexformat, till exempel #FFAABB
`textColor`	tal (hex)	textfärg för autentiseringsuppgifterna i hexformat, till exempel #FFAABB
`description`	sträng	kompletterande text som visas tillsammans med varje autentiseringsuppgift
`logo`	displayCredentialLogo	logotypen som ska användas för autentiseringsuppgifterna

displayCredentialLogo-typ

Property	Type	Beskrivning
`uri`	sträng (url)	url för logotypen.
`description`	sträng	beskrivningen av logotypen

Kommentar

Microsoft rekommenderar att du använder avbildningsformat som stöds i stor utsträckning, till exempel .PNG, .JPG eller .BMP, för att minska filformatfel.

displayConsent-typ

Property	Type	Description
`title`	sträng	medgivandets titel
`instructions`	sträng	kompletterande text som ska användas när medgivande visas

displayClaims-typ

Property	Type	Description
`label`	sträng	etiketten för anspråket som visas
`claim`	sträng	namnet på det anspråk som etiketten gäller för. För JWT-VC-formatet måste värdet ha prefixet `vc.credentialSubject.` .
`type`	sträng	anspråkets typ
`description`	sträng (valfritt)	beskrivningen av anspråket

Exempel på visningsdefinition:

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

Nästa steg

Läs mer om hur du anpassar dina autentiseringsuppgifter

Dela via