Microsoft Entra 验证 ID 网络 API

注意

Microsoft Entra 验证 ID 现在是 Microsoft Entra 验证 ID 和 Microsoft Entra 产品系列的一部分。 详细了解标识解决方案 Microsoft Entra 系列,并开始使用统一 Microsoft Entra 管理中心

借助 Microsoft Entra 验证 ID 网络 API,可以在 Microsoft Entra 验证 ID 网络中搜索已发布的凭据。

注意

此 API 适用于熟悉 RESTful API 的开发人员。

基 URL

Microsoft Entra ID 验证网络 API 通过 HTTPS 提供。 文档中引用的所有 URL 都具有以下基 URL:https://verifiedid.did.msidentity.com

身份验证

可通过 Microsoft Entra ID 对该 API 进行保护,该 API 使用 OAuth2 持有者令牌。 应用注册需要具有 Verifiable Credentials Service Admin 的 API 权限,随后在获取访问令牌时,应用应使用范围 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access

搜索颁发者

此 API 用于搜索 Microsoft Entra 验证 ID 网络中的颁发者。 可以按颁发者的链接域名对其进行搜索。 为 filter 参数提供的值将用于查找已加入 Microsoft Entra 验证 ID 并具有验证链接域的颁发者。 目前,只能按 linkeddomainurls 以及使用运算符 like 进行筛选。 响应中最多可有 15 个颁发者。

HTTP 请求

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

请求标头

标头
授权 持有者(令牌)。 必需
Content-Type application/json

请求参数

参数
filter linkeddomainurls like Woodgrove

返回消息

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

[
  {
    "id": "0459a193-1111-2222-3333-444455556666",
    "tenantId": "55eafede-1111-2222-3333-444455556666",
    "did": "did:web:bank.woodgrove.com...<SNIP>...",
    "name": "WoodgroveBank",
    "linkedDomainUrls": [
      "https://bank.woodgrove.com/"
    ]
  },
  {
    "id": "6e0e41cb-1111-2222-3333-444455556666",
    "tenantId": "7f448f57-1111-2222-3333-444455556666",
    "did": "did:web:woodgrove.com...<SNIP>...",
    "name": "Woodgrove",
    "linkedDomainUrls": [
      "https://woodgrove.com/"
    ]
  }
]

按颁发者搜索已发布的凭据类型

此 API 用于搜索特定颁发者已发布的凭据类型。 需要知道颁发者的 tenantIdissuerId。 返回消息是一个包含已发布的凭据类型及其各自声明的集合。 响应中最多可有 100 种凭据类型。

HTTP 请求

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

请求标头

标头
授权 持有者(令牌)。 必需
Content-Type application/json

请求参数

参数
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 验证 ID 网络