Microsoft Entra Verified ID ネットワーク API

概要

Microsoft Entra Verified ID Network API を使用すると、Microsoft Entra Verified ID Networkで公開された資格情報を検索できます。

手記

この API は、RESTful API に慣れた開発者を対象としています。

ベース URL

Microsoft Entra Verified ID Network 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 Verified ID Network で使用可能な発行者を検索します。 発行者は、リンクされたドメイン 名で検索できます。 filter パラメーターに指定された値は、Microsoft Entra 検証済み ID にオンボードされ、検証済みのリンク ドメインを持つ発行者を検索するために使用されます。 現時点では、linkeddomainurls と演算子 likeでのみフィルター処理できます。 応答には最大 15 個の発行者があります。

HTTP 要求

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

要求ヘッダー

ヘッダ 価値
認可 ベアラー (トークン)。 必須
コンテンツタイプ application/json

要求パラメーター

パラメーター 価値
フィルタ Linkeddomainurls like 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 は、特定の発行者の公開された資格情報の種類を検索するために使用されます。 発行者の tenantIdissuerIdを知っている必要があります。 返されるメッセージは、発行された資格情報の種類とそれぞれの要求のコレクションです。 応答には、最大 100 種類の資格情報があります。

HTTP 要求

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

要求ヘッダー

ヘッダ 価値
認可 ベアラー (トークン)。 必須
コンテンツタイプ application/json

要求パラメーター

パラメーター 価値
テナントID リンク されたドメイン名で検索から取得された 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 Verified ID Network の詳細を確認します。