Delen via

Microsoft Entra geverifieerde ID netwerk-API

  • Artikel

Met de Microsoft Entra geverifieerde ID Network-API kunt u zoeken naar gepubliceerde referenties in het Microsoft Entra geverifieerde ID Network.

Notitie

De API is bedoeld voor ontwikkelaars die vertrouwd zijn met RESTful API's.

Basis-URL

De geverifieerde netwerk-API van Microsoft Entra-id wordt geleverd via HTTPS. Alle URL's waarnaar in de documentatie wordt verwezen, hebben de volgende basis: https://verifiedid.did.msidentity.com.

Verificatie

De API wordt beveiligd via Microsoft Entra-id en gebruikt OAuth2 bearer-tokens. De app-registratie moet beschikken over de API-machtiging voor Verifiable Credentials Service Admin en moet vervolgens bij het verkrijgen van het toegangstoken het bereik 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access gebruiken.

Zoeken naar verleners

Deze API wordt gebruikt om te zoeken naar verleners die beschikbaar zijn in het Microsoft Entra geverifieerde ID Network. U kunt zoeken naar verleners op basis van hun gekoppelde domeinnaam. De opgegeven waarde voor de filter parameter wordt gebruikt om verleners te vinden die zijn toegevoegd aan Microsoft Entra geverifieerde ID en een geverifieerd gekoppeld domein hebben. Op dit moment kunt u alleen filteren op linkeddomainurls en met operator like. Het antwoord bevat maximaal 15 verleners.

HTTP-aanvraag

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

Aanvraagheaders

Kop Waarde
Autorisatie Bearer (token). Vereist
Content-Type application/json

Aanvraagparameters

Parameter waarde
filter linkeddomainurls zoals Woodgrove

Retourbericht

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

Zoeken naar gepubliceerde referentietypen door een verlener

Deze API wordt gebruikt om te zoeken naar gepubliceerde referentietypen voor een specifieke verlener. U moet de verleners tenantId en issuerId kennen. Het retourbericht is een verzameling gepubliceerde referentietypen en hun respectieve claims. Er zijn maximaal 100 referentietypen in het antwoord.

HTTP-aanvraag

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

Aanvraagheaders

Kop Waarde
Autorisatie Bearer (token). Vereist
Content-Type application/json

Aanvraagparameters

Parameter waarde
tenantId TenantId verkregen door de zoekopdracht op gekoppelde domeinnaam
issuerId IssuerId verkregen door de zoekopdracht op gekoppelde domeinnaam

Retourbericht

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

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

Volgende stappen

Meer informatie over Microsoft Entra geverifieerde ID Network.