Naslaginformatie over regel- en weergavedefinities

Artikel
12/07/2023

Regel- en weergavedefinities worden gebruikt om aanmeldingsgegevens te definiëren. Meer informatie hierover vindt u in Uw aanmeldingsgegevens aanpassen.

Type rulesModel

Eigenschap	Type	Description
`attestations`	idTokenAttestation en/of idTokenHintAttestation en/of verifiablePresentationAttestation en/of selfIssuedAttestation	definieert de attestation-stroom(en) die moeten worden gebruikt voor het verzamelen van claims die moeten worden opgegeven in de verifieerbare referentie.
`validityInterval`	Nummer	vertegenwoordigt de levensduur van de referentie in seconden
`vc`	vcType	Controleerbare referentietypen voor dit contract

Het voorbeeld van het attestation-type in JSON. U ziet dat selfIssued dit één exemplaar is, terwijl de andere verzamelingen zijn. Voor voorbeelden van het gebruik van het attestation-type, raadpleegt u de voorbeelddefinities van JSON-regels in de handleidingen.

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

type idTokenAttestation

Wanneer u zich aanmeldt bij de gebruiker vanuit Authenticator, kunt u het geretourneerde id-token van de OpenID-Verbinding maken compatibele provider gebruiken als invoer.

Eigenschap	Type	Description
`mapping`	claimMapping (optioneel)	regels voor het toewijzen van invoerclaims aan uitvoerclaims in het controleerbaar legitimatiebewijs
`configuration`	tekenreeks (URL)	locatie van het configuratiedocument van de id-provider
`clientId`	tekenreeks	client-id die moet worden gebruikt bij het verkrijgen van het id-token
`redirectUri`	tekenreeks	omleidings-URI die moet worden gebruikt bij het verkrijgen van het id-token; MOET ZIJN `vcclient://openid/`
`scope`	tekenreeks	door spaties gescheiden lijst van bereiken die moeten worden gebruikt bij het verkrijgen van het id-token
`required`	Booleaanse waarde (standaard onwaar)	geeft aan of deze attestation vereist is of niet
`trustedIssuers`	optionele tekenreeks (matrix)	een lijst van DID's die het verifieerbare aanmeldingsgegeven mogen uitgeven voor dit contract. Deze eigenschap wordt alleen gebruikt voor specifieke scenario's waarbij de `id_token_hint` eigenschap afkomstig is van een andere verlener

Type idTokenHintAttestation

Deze stroom maakt gebruik van de id-tokenhint, die wordt geleverd als nettolading via de REST API van de aanvraag. De toewijzing is hetzelfde als voor de id-token-attestation.

Eigenschap	Type	Description
`mapping`	claimMapping (optioneel)	regels voor het toewijzen van invoerclaims aan uitvoerclaims in het controleerbaar legitimatiebewijs
`required`	Booleaanse waarde (standaard onwaar)	hiermee wordt aangegeven of deze attestation vereist is of niet. Aanvraagservice-API mislukt de aanroep als vereiste claims niet zijn ingesteld in de nettolading createPresentationRequest.
`trustedIssuers`	optionele tekenreeks (matrix)	een lijst van DID's die het verifieerbare aanmeldingsgegeven mogen uitgeven voor dit contract. Deze eigenschap wordt alleen gebruikt voor specifieke scenario's waarbij de `id_token_hint` eigenschap afkomstig is van een andere verlener

Type verifiablePresentationAttestation

Wanneer u wilt dat de gebruiker een andere verifieerbare referentie presenteert als invoer voor een nieuwe uitgegeven verifieerbare referentie. Met de portemonnee kan de gebruiker de verifieerbare referentie selecteren tijdens de uitgifte.

Eigenschap	Type	Description
`mapping`	claimMapping (optioneel)	regels voor het toewijzen van invoerclaims aan uitvoerclaims in het controleerbaar legitimatiebewijs
`credentialType`	tekenreeks (optioneel)	vereist type aanmeldingsgegeven van de invoer
`required`	Booleaanse waarde (standaard onwaar)	geeft aan of deze attestation vereist is of niet
`trustedIssuers`	tekenreeks (matrix)	een lijst van DID's die het verifieerbare aanmeldingsgegeven mogen uitgeven voor dit contract. De service is achter de schermen standaard ingesteld op uw uitgever, zodat u deze waarde niet zelf hoeft op te geven.

type selfIssuedAttestation

Wanneer u wilt dat de gebruiker zelf informatie invoert. Dit type wordt ook wel zelf-attestinvoer genoemd.

Eigenschap	Type	Description
`mapping`	claimMapping (optioneel)	regels voor het toewijzen van invoerclaims aan uitvoerclaims in het controleerbaar legitimatiebewijs
`required`	Booleaanse waarde (standaard onwaar)	geeft aan of deze attestation vereist is of niet

Type claimMapping

Eigenschap	Type	Omschrijving
`inputClaim`	tekenreeks	de naam van de claim uit de invoer die moet worden gebruikt
`outputClaim`	tekenreeks	de naam van de claim in het controleerbaar legitimatiebewijs
`indexed`	Booleaanse waarde (standaard onwaar)	geeft aan of de waarde van deze claim wordt gebruikt om te zoeken; slechts één clientMapping-object is indexeerbaar voor een bepaald contract
`required`	Booleaanse waarde (standaard onwaar)	geeft aan of deze toewijzing vereist is of niet
`type`	tekenreeks (optioneel)	type claim

type vcType

Eigenschap	Type	Description
`type`	tekenreeks (matrix)	een lijst met verifieerbare referentietypen die dit contract kan uitgeven

Voorbeeld van een regeldefinitie:

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

type displayModel

Eigenschap	Type	Omschrijving
`locale`	tekenreeks	de landinstelling van deze weergave
`credential`	displayCredential	de weergave-eigenschappen van het controleerbaar legitimatiebewijs
`consent`	displayConsent	aanvullende gegevens wanneer het controleerbaar legitimatiebewijs wordt uitgegeven
`claims`	displayClaims-matrix	labels voor de claims in het controleerbaar legitimatiebewijs

type displayCredential

Eigenschap	Type	Omschrijving
`title`	tekenreeks	titel van het aanmeldingsgegeven
`issuedBy`	tekenreeks	de naam van de uitgever van het aanmeldingsgegeven
`backgroundColor`	getal (hexadecimaal)	achtergrondkleur van het aanmeldingsgegeven in hexadecimale notatie, bijvoorbeeld #FFAABB
`textColor`	getal (hexadecimaal)	tekstkleur van het aanmeldingsgegeven in hexadecimale notatie, bijvoorbeeld #FFAABB
`description`	tekenreeks	aanvullende tekst die naast elk aanmeldingsgegeven wordt weergegeven
`logo`	displayCredentialLogo	het logo dat moet worden gebruikt voor het aanmeldingsgegeven

type displayCredentialLogo

Eigenschap	Type	Description
`uri`	tekenreeks (URL)	url van het logo.
`description`	tekenreeks	de beschrijving van het logo

type displayConsent

Eigenschap	Type	Omschrijving
`title`	tekenreeks	titel van de toestemming
`instructions`	tekenreeks	aanvullende tekst die moet worden gebruikt bij het weergeven van de toestemming

Type displayClaims

Eigenschap	Type	Omschrijving
`label`	tekenreeks	het label van de claim in de weergave
`claim`	tekenreeks	de naam van de claim waarop het label van toepassing is. Voor de JWT-VC-indeling moet de waarde het `vc.credentialSubject.` voorvoegsel hebben.
`type`	tekenreeks	het type claim
`description`	tekenreeks (optioneel)	de beschrijving van de claim

Voorbeeld van een weergavedefinitie:

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

Volgende stappen

Meer informatie over uw aanmeldingsgegevens aanpassen

Delen via