Microsoft Entra 驗證識別碼網路 API

Microsoft Entra 驗證識別碼網路 API 可讓您在 Microsoft Entra 驗證識別碼網路中搜尋已發佈的認證。

注意

API 適用於熟悉 RESTful API 的開發人員。

基礎 URL

Microsoft Entra ID 已驗證的網路 API 會透過 HTTPS 提供服務。 文件中參考的所有 URL 都有下列基礎：https://verifiedid.did.msidentity.com。

驗證

API 會透過 Microsoft Entra ID 來保護，並使用 OAuth2 持有人權杖。 應用程式註冊需要具有 Verifiable Credentials Service Admin 的 API 權限，然後在取得存取權杖時，應用程式應該使用範圍 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access。

搜尋簽發者

此 API 用來搜尋 Microsoft Entra 驗證識別碼網路中可用的簽發者。 您可以依簽發者的「已連結網域」名稱來搜尋簽發者。 為 filter 參數所提供的值將用來尋找已上線至 Microsoft Entra 驗證識別碼且具有已驗證連結網域的簽發者。 目前，您只能依 linkeddomainurls 和使用 like 運算子進行篩選。 回應中最多會有 15 個簽發者。

HTTP 要求

GET /v1.0/verifiableCredentialsNetwork/authorities?filter=linkeddomainurls%20like%20Woodgrove

要求標頭

標頭	數值
授權	持有人 (權杖)。 必要
內容-類型	application/json

要求參數

參數	value
篩選器	linkeddomainurls，如 Woodgrove

傳回訊息

HTTP/1.1 200 OK
Content-type: application/json

[
  {
    "id": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "tenantId": "aaaabbbb-0000-cccc-1111-dddd2222eeee",
    "did": "did:web:bank.woodgrove.com...<SNIP>...",
    "name": "WoodgroveBank",
    "linkedDomainUrls": [
      "https://bank.woodgrove.com/"
    ]
  },
  {
    "id": "00aa00aa-bb11-cc22-dd33-44ee44ee44ee",
    "tenantId": "bbbbcccc-1111-dddd-2222-eeee3333ffff",
    "did": "did:web:woodgrove.com...<SNIP>...",
    "name": "Woodgrove",
    "linkedDomainUrls": [
      "https://woodgrove.com/"
    ]
  }
]

依簽發者搜尋已發佈的認證類型

此 API 用來搜尋特定簽發者的已發佈認證類型。 您需要知道簽發者 tenantId 和 issuerId。 傳回訊息是已發佈認證類型的集合和其各自的宣告。 回應中最多會有 100 個認證類型。

HTTP 要求

GET /v1.0/tenants/:tenantId/verifiableCredentialsNetwork/authorities/:issuerId/contracts/

要求標頭

標頭	數值
授權	持有人 (權杖)。 必要
內容-類型	application/json

要求參數

參數	value
tenantId	依已連結網域名稱進行搜尋所取得的 TenantId
issuerId	依已連結網域名稱進行搜尋所取得的 IssuerId

傳回訊息

HTTP/1.1 200 OK
Content-type: application/json

[
  {
    "name": "Verified employee 1",
    "types": [
      "VerifiedEmployee"
    ],
    "claims": [
      "displayName",
      "givenName",
      "jobTitle",
      "preferredLanguage",
      "surname",
      "mail",
      "revocationId",
      "photo"
    ]
  }
]

下一步

深入了解 Microsoft Entra 驗證識別碼網路。