Referenz zur Regel- und Anzeigedefinition

  • Artikel

Hinweis

Microsoft Entra Verified ID ist jetzt Teil der Microsoft Entra-Produktfamilie. Erfahren Sie mehr über die Microsoft Entra-Familie mit Lösungen für die Identitätsverwaltung, und beginnen Sie im einheitlichen Microsoft Entra Admin Center.

Regel- und Anzeigedefinitionen werden verwendet, um Anmeldeinformationen zu definieren. Weitere Informationen dazu finden Sie unter Anpassen Ihrer Anmeldeinformationen.

rulesModel-Typ

Eigenschaft Type BESCHREIBUNG
attestations idTokenAttestation und/oder idTokenHintAttestation und/oder verifiablePresentationAttestation und/oder selfIssuedAttestation Definiert die Nachweisflüsse zum Sammeln von Ansprüchen, die im Nachweis ausgestellt werden sollen.
validityInterval number Stellt die Lebensdauer der Anmeldeinformationen in Sekunden dar
vc vcType Nachweistypen für diesen Vertrag

Das Beispiel für den Nachweistyp in JSON. Beachten Sie, dass selfIssued eine einzelne Instanz ist, während die anderen Nachweistypen Sammlungen sind. Beispiele für die Verwendung des Nachweistyps finden Sie in den Anleitungen unter Beispiel-JSON-Regeldefinitionen.

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

idTokenAttestation-Typ

Wenn Sie den Benutzer über Authenticator anmelden, können Sie das zurückgegebene ID-Token vom kompatiblen OpenID Connect-Anbieter als Eingabe verwenden.

Eigenschaft Type BESCHREIBUNG
mapping claimMapping (optional) Regeln zum Zuordnen von Eingabeansprüchen zu Ausgabeansprüchen im Nachweis
configuration string (url) Speicherort des Konfigurationsdokuments des Identitätsanbieters
clientId Zeichenfolge Client-ID, die beim Abrufen des ID-Tokens verwendet werden soll
redirectUri Zeichenfolge Umleitungs-URI zum Abrufen des ID-Tokens. MUSS vcclient://openid/ lauten.
scope Zeichenfolge Liste der Bereiche mit Leerzeichen als Trennzeichen für das Abrufen des ID-Tokens
required Boolescher Wert (Standardwert FALSE) Gibt an, ob dieser Nachweis erforderlich ist
trustedIssuers Optionale Zeichenfolge (Array) Liste der DIDs, die Nachweise für diesen Vertrag ausstellen dürfen. Diese Eigenschaft wird nur in bestimmten Szenarien verwendet, in denen id_token_hint von einem anderen Aussteller stammen kann.

idTokenHintAttestation-Typ

Dieser Flow verwendet den ID-Tokenhinweis, der über die Anforderungs-REST-API als Nutzdaten bereitgestellt wird. Die Zuordnung entspricht der für den ID-Token-Nachweis.

Eigenschaft Type BESCHREIBUNG
mapping claimMapping (optional) Regeln zum Zuordnen von Eingabeansprüchen zu Ausgabeansprüchen im Nachweis
required Boolescher Wert (Standardwert FALSE) Gibt an, ob dieser Nachweis erforderlich ist
trustedIssuers Optionale Zeichenfolge (Array) Liste der DIDs, die Nachweise für diesen Vertrag ausstellen dürfen. Diese Eigenschaft wird nur in bestimmten Szenarien verwendet, in denen id_token_hint von einem anderen Aussteller stammen kann.

verifiablePresentationAttestation-Typ

Wenn Sie möchten, dass der Benutzer einen weiteren Nachweis als Eingabe für einen neuen ausgestellten Nachweis präsentieren soll. Über die Wallet können Benutzer während der Ausstellung den Nachweis auswählen.

Eigenschaft Type BESCHREIBUNG
mapping claimMapping (optional) Regeln zum Zuordnen von Eingabeansprüchen zu Ausgabeansprüchen im Nachweis
credentialType Zeichenfolge (optional) Erforderlicher Anmeldeinformationentyp für die Eingabe
required Boolescher Wert (Standardwert FALSE) Gibt an, ob dieser Nachweis erforderlich ist
trustedIssuers Zeichenfolge (Array) Liste der DIDs, die Nachweise für diesen Vertrag ausstellen dürfen. Als Dienst wird standardmäßig im Hintergrund Ihr Aussteller verwendet, sodass Sie diesen Wert nicht selbst bereitstellen müssen.

selfIssuedAttestation-Typ

Wenn Sie möchten, dass Benutzer*innen die Informationen selbst eingeben sollen. Dieser Typ wird auch als selbst bestätigte Eingabe bezeichnet.

Eigenschaft Type BESCHREIBUNG
mapping claimMapping (optional) Regeln zum Zuordnen von Eingabeansprüchen zu Ausgabeansprüchen im Nachweis
required Boolescher Wert (Standardwert FALSE) Gibt an, ob dieser Nachweis erforderlich ist

claimMapping-Typ

Eigenschaft Type Beschreibung
inputClaim Zeichenfolge Name des Anspruchs, der von der Eingabe verwendet werden soll
outputClaim Zeichenfolge Name des Anspruchs im Nachweis
indexed Boolescher Wert (Standardwert FALSE) Gibt an, ob der Wert dieses Anspruchs für die Suche verwendet wird. Für einen bestimmten Vertrag ist jeweils nur ein clientMapping-Objekt indizierbar.
required Boolescher Wert (Standardwert FALSE) Gibt an, ob diese Zuordnung erforderlich ist
type Zeichenfolge (optional) Anspruchstyp

vcType-Typ

Eigenschaft Type Beschreibung
type Zeichenfolge (Array) Eine Liste der Nachweistypen, die dieser Vertrag ausstellen kann

Beispiel für eine 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

Eigenschaft Type Beschreibung
locale Zeichenfolge Gebietsschema dieser Anzeige
credential displayCredential Anzeigeeigenschaften des Nachweises
consent displayConsent Ergänzende Daten bei der Ausstellung des Nachweises
claims displayClaims-Array Bezeichnungen für die Ansprüche, die im Nachweis enthalten sind

displayCredential-Typ

Eigenschaft Type Beschreibung
title Zeichenfolge Titel der Anmeldeinformationen
issuedBy Zeichenfolge Name des Ausstellers der Anmeldeinformationen
backgroundColor Zahl (hexadezimal) Hintergrundfarbe der Anmeldeinformationen im Hexadezimalformat, z. B. #FFAABB
textColor Zahl (hexadezimal) Textfarbe der Anmeldeinformationen im Hexadezimalformat, z. B. #FFAABB
description Zeichenfolge Ergänzender Text, der neben jeder Anmeldeinformation angezeigt wird
logo displayCredentialLogo Logo, das für die Anmeldeinformationen verwendet werden soll

displayCredentialLogo-Typ

Eigenschaft Type BESCHREIBUNG
uri string (url) URL des Logos.
description Zeichenfolge Ziel des Logos

displayConsent-Typ

Eigenschaft Type Beschreibung
title Zeichenfolge Titel der Einwilligung
instructions Zeichenfolge Ergänzender Text, der beim Anzeigen der Einwilligung verwendet werden soll

displayClaims-Typ

Eigenschaft Type Beschreibung
label Zeichenfolge Bezeichnung des Anspruchs in der Anzeige
claim Zeichenfolge Name des Anspruchs, für den die Bezeichnung gilt. Beim Format „JWT-VC“ muss der Wert das Präfix vc.credentialSubject. haben.
type Zeichenfolge Typ des Anspruchs
description Zeichenfolge (optional) Beschreibung des Anspruchs

Beispiel für eine Anzeigedefinition:

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

Nächste Schritte