API jaringan ID Terverifikasi Microsoft Entra

Ikhtisar

API Jaringan ID Terverifikasi Microsoft Entra memungkinkan Anda mencari kredensial yang diterbitkan di Jaringan ID Terverifikasi Microsoft Entra.

Nota

API ini ditujukan untuk pengembang yang nyaman dengan API RESTful.

URL Dasar

API Jaringan ID Terverifikasi Microsoft Entra disajikan melalui HTTPS. Semua URL yang dirujuk dalam dokumentasi memiliki basis berikut: https://verifiedid.did.msidentity.com.

Otentikasi

API dilindungi melalui ID Microsoft Entra dan menggunakan token pembawa OAuth2. Berikan pendaftaran aplikasi Izin API untuk Verifiable Credentials Service Admin dan gunakan cakupan 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access saat memperoleh token akses.

Mencari pengeluar sertifikat

Gunakan API ini untuk mencari penerbit yang tersedia di Microsoft Entra Verified ID Network. Anda dapat mencari penerbit dengan nama domain tertaut mereka. Nilai yang disediakan untuk parameter filter digunakan untuk menemukan penerbit yang melakukan onboarding ke ID Terverifikasi Microsoft Entra dan memiliki domain tertaut terverifikasi. Saat ini Anda hanya dapat memfilter menurut linkeddomainurls dan dengan operator like. Ada maksimal 15 penerbit dalam respons.

Permintaan HTTP

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

Header permintaan

Kepala Halaman	Nilai
Otorisasi	Pembawa (token). Diperlukan
Tipe Isi	application/json

Parameter permintaan

Pengaturan	Nilai
filter	linkeddomainurls seperti Woodgrove

Mengembalikan pesan

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

Mencari jenis kredensial yang diterbitkan oleh pengeluar sertifikat

API ini digunakan untuk mencari jenis kredensial yang diterbitkan untuk pengeluar sertifikat tertentu. Anda perlu mengetahui pengeluar tenantId sertifikat dan issuerId. Pesan pengembalian adalah kumpulan jenis kredensial yang diterbitkan dan klaim masing-masing. Ada maksimum 100 jenis kredensial dalam respons.

Permintaan HTTP

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

Header permintaan

Kepala Halaman	Nilai
Otorisasi	Pembawa (token). Diperlukan
Tipe Isi	application/json

Parameter permintaan

Pengaturan	Nilai
ID Penyewa	TenantId diperoleh dari pencarian dengan nama domain tertaut
issuerId	IssuerId diperoleh dari pencarian dengan nama domain tertaut

Mengembalikan pesan

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

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

Langkah berikutnya

Pelajari selengkapnya tentang Microsoft Entra Verified ID Network.