Interfejs API sieci zweryfikowanego identyfikatora firmy Microsoft

Interfejs API sieci zweryfikowanego identyfikatora firmy Microsoft umożliwia wyszukiwanie opublikowanych poświadczeń w usłudze Microsoft Entra Verified ID Network.

Nuta

Interfejs API jest przeznaczony dla deweloperów korzystających z interfejsów API RESTful.

Podstawowy adres URL

Interfejs API sieci zweryfikowanego identyfikatora firmy Microsoft jest obsługiwany za pośrednictwem protokołu HTTPS. Wszystkie adresy URL, do których odwołuje się dokumentacja, mają następującą bazę: https://verifiedid.did.msidentity.com.

Uwierzytelnianie

Interfejs API jest chroniony za pomocą identyfikatora Entra firmy Microsoft i używa tokenów elementu nośnego OAuth2. Rejestracja aplikacji musi mieć uprawnienie interfejsu API dla Verifiable Credentials Service Admin, a następnie podczas uzyskiwania tokenu dostępu aplikacja powinna używać zakresu 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access.

Wyszukiwanie wystawców

Ten interfejs API służy do wyszukiwania wystawców dostępnych w sieci zweryfikowanego identyfikatora firmy Microsoft. Możesz wyszukać wystawców według ich połączonej domeny nazwy. Wartość podana dla parametru filter służy do znajdowania wystawców dołączonych do identyfikatora zweryfikowanego przez firmę Microsoft Entra i zweryfikowanej domeny połączonej. Obecnie można filtrować tylko według linkeddomainurls i za pomocą operatora like. W odpowiedzi jest maksymalnie 15 wystawców.

Żądanie HTTP

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

Nagłówki żądań

Nagłówek	Wartość
Autoryzacja	Elementu nośnego (token). Wymagane
Typ zawartości	application/json

Parametry żądania

Parametr	wartość
filtr	linkeddomainurls, takie jak Woodgrove

Komunikat zwrotny

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

Wyszukiwanie opublikowanych typów poświadczeń przez wystawcę

Ten interfejs API służy do wyszukiwania opublikowanych typów poświadczeń dla określonego wystawcy. Musisz znać wystawców tenantId i issuerId. Komunikat zwracany jest kolekcją opublikowanych typów poświadczeń i ich odpowiednich oświadczeń. W odpowiedzi istnieje maksymalnie 100 typów poświadczeń.

Żądanie HTTP

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

Nagłówki żądań

Nagłówek	Wartość
Autoryzacja	Elementu nośnego (token). Wymagane
Typ zawartości	application/json

Parametry żądania

Parametr	wartość
tenantId	TenantId uzyskany z wyszukiwania według połączonej nazwy domeny
issuerId	IssuerId uzyskany z wyszukiwania według połączonej nazwy domeny

Komunikat zwrotny

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

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

Następne kroki

Dowiedz się więcej o zweryfikowanych identyfikatorów firmy Microsoft firmy Microsoft.