Microsoft Entra-verifierat ID-nätverks-API

Med Microsoft Entra Verified ID Network API kan du söka efter publicerade autentiseringsuppgifter i Microsoft Entra-verifierat ID-nätverk.

Not

API:et är avsett för utvecklare som är bekväma med RESTful-API:er.

Bas-URL

Microsoft Entra ID Verified Network API hanteras via HTTPS. Alla URL:er som refereras i dokumentationen har följande bas: https://verifiedid.did.msidentity.com.

Autentisering

API:et skyddas via Microsoft Entra-ID och använder OAuth2-ägartoken. Appregistreringen måste ha API-behörighet för Verifiable Credentials Service Admin och när du hämtar åtkomsttoken ska appen använda omfånget 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access.

Söka efter utfärdare

Det här API:et används för att söka efter utfärdare som är tillgängliga i Microsoft Entra-verifierat ID-nätverk. Du kan söka efter utfärdare efter deras länkade domän namn. Värdet som anges för parametern filter används för att hitta utfärdare som registrerats i Microsoft Entra-verifierat ID och har en verifierad länkad domän. För närvarande kan du bara filtrera efter linkeddomainurls och med operatorn like. Det finns högst 15 utfärdare i svaret.

HTTP-begäran

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

Begärandehuvuden

Rubrik	Värde
Tillstånd	Bearer (token). Krävs
Innehållstyp	application/json

Parametrar för begäran

Parameter	värde
filter	linkeddomainurls som Woodgrove

Returmeddelande

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

Söka efter publicerade typer av autentiseringsuppgifter av en utfärdare

Det här API:et används för att söka efter publicerade typer av autentiseringsuppgifter efter en specifik utfärdare. Du måste känna till utfärdarna tenantId och issuerId. Returmeddelandet är en samling publicerade typer av autentiseringsuppgifter och deras respektive anspråk. Det finns högst 100 typer av autentiseringsuppgifter i svaret.

HTTP-begäran

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

Begärandehuvuden

Rubrik	Värde
Tillstånd	Bearer (token). Krävs
Innehållstyp	application/json

Parametrar för begäran

Parameter	värde
tenantId	TenantId hämtas från sökningen med länkat domännamn
issuerId	IssuerId hämtat från sökningen med länkat domännamn

Returmeddelande

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

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

Nästa steg

Läs mer om Microsoft Entra-verifierat ID-nätverk.