規則和顯示定義參考

發行項
11/13/2024

規則和顯示定義可用來定義認證。您可以在如何自訂認證中深入了解。

rulesModel 類型

屬性	類型	描述
`attestations`	idTokenAttestation 和/或 idTokenHintAttestation 和/或 verifiablePresentationAttestation 和/或 selfIssuedAttestation	定義要用於收集宣告以在可驗認證中發出的證明流程。
`validityInterval`	數值	代表認證的存留期 (以秒計)
`vc`	vcType	此合約的可驗認證類型

JSON 中的證明類型範例。請注意，selfIssued 是單一執行個體，而其他執行個體是集合。如需如何使用證明類型的範例，請參閱操作指南中的範例 JSON 規則定義。

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

idTokenAttestation 類型

當您從 Authenticator 內登入使用者時，可以使用來自 OpenID Connect 相容提供者的傳回識別碼權杖做為輸入。

屬性	類型	描述
`mapping`	claimMapping (選擇性)	規則，將輸入宣告對應至可驗認證中的輸出宣告
`configuration`	字串 (url)	身分識別提供者設定文件的位置
`clientId`	字串	取得識別碼權杖時要使用的用戶端識別碼
`redirectUri`	字串	取得識別碼權杖時的重新導向 URI 必須是 `vcclient://openid/`
`scope`	字串	取得識別碼權杖時要使用的範圍空格分隔清單
`required`	布林值 (預設值 false)	指出是否需要此證明
`trustedIssuers`	選用字串 (陣列)	允許核發此合約可驗認證的 DID 清單。此屬性僅適用於 `id_token_hint` 可能來自另一個簽發者的特定案例

idTokenHintAttestation 類型

此流程會使用識別碼權杖提示，這是透過要求 REST API 提供做為承載。對應與識別碼權杖證明相同。

屬性	類型	描述
`mapping`	claimMapping (選擇性)	規則，將輸入宣告對應至可驗認證中的輸出宣告
`required`	布林值 (預設值 false)	指出是否需要此證明。如果 createPresentationRequest 承載中未設定必要的宣告，則要求服務 API 將會讓呼叫失敗。
`trustedIssuers`	選用字串 (陣列)	允許核發此合約可驗認證的 DID 清單。此屬性僅適用於 `id_token_hint` 可能來自另一個簽發者的特定案例

verifiablePresentationAttestation 類型

當您要讓使用者將另一個可驗認證呈現為新發行可驗認證的輸入時。錢包可讓用戶在發行期間選取可驗證的認證。

屬性	類型	描述
`mapping`	claimMapping (選擇性)	規則，將輸入宣告對應至可驗認證中的輸出宣告
`credentialType`	字串 (選擇性)	輸入的必要認證類型
`required`	布林值 (預設值 false)	指出是否需要此證明
`trustedIssuers`	字串 (陣列)	允許核發此合約可驗認證的 DID 清單。服務預設為您的簽發者，因此不需要自行提供此值。

selfIssuedAttestation 類型

當您希望使用者自行輸入資訊時。此類型也稱為自我證明輸入。

屬性	類型	描述
`mapping`	claimMapping (選擇性)	規則，將輸入宣告對應至可驗認證中的輸出宣告
`required`	布林值 (預設值 false)	指出是否需要此證明

claimMapping 類型

屬性	類型	描述
`inputClaim`	字串	要從輸入使用的宣告名稱
`outputClaim`	字串	可驗認證中宣告的名稱
`indexed`	布林值 (預設值 false)	指出這個宣告的值是否用於搜尋；指定的合約只能有一個 clientMapping 物件可編製索引
`required`	布林值 (預設值 false)	指出是否需要此對應
`type`	字串 (選擇性)	宣告的類型

vcType 類型

屬性	類型	描述
`type`	字串 (陣列)	此合約可發出的可驗認證類型清單

範例規則定義：

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

屬性	類型	描述
`locale`	字串	此顯示的地區設定
`credential`	displayCredential	可驗認證的顯示屬性
`consent`	displayConsent	核發可驗認證時的補充資料
`claims`	displayClaims 陣列	可驗認證中包含的宣告標籤

displayCredential 類型

屬性	類型	描述
`title`	字串	認證標題
`issuedBy`	字串	認證簽發者的名稱
`backgroundColor`	數字 (十六進位)	以十六進位格式顯示認證的背景色彩，例如，#FFAABB
`textColor`	數字 (十六進位)	以十六進位格式顯示認證的文字色彩，例如，#FFAABB
`description`	字串	每個認證顯示的補充文字
`logo`	displayCredentialLogo	要用於認證的標誌

displayCredentialLogo 類型

屬性	類型	描述
`uri`	字串 (url)	標誌的 URL。
`description`	字串	標誌的描述

注意

Microsoft建議您使用廣泛支援的影像格式，例如.PNG、.JPG或.BMP，以減少檔格式錯誤。

displayConsent 類型

屬性	類型	描述
`title`	字串	同意的標題
`instructions`	字串	顯示同意時要使用的補充文字

displayClaims 類型

屬性	類型	描述
`label`	字串	顯示中宣告的標籤
`claim`	字串	套用標籤的宣告名稱。針對 JWT-VC 格式，值需要具有 `vc.credentialSubject.` 前置詞。
`type`	字串	宣告的類型
`description`	字串 (選擇性)	宣告的描述

範例顯示定義：

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

下一步

深入了解如何自訂您的認證

共用方式為