Rozhraní API sítě Ověřené ID microsoftu Entra

Přehled

Rozhraní API sítě Ověřený identifikátor Microsoft Entra umožňuje vyhledávat publikované přihlašovací údaje v síti Microsoft Entra Verified ID Network.

Poznámka

Rozhraní API je určené pro vývojáře, kteří jsou obeznámeni s rozhraními RESTful API.

Základní adresa URL

Rozhraní API sítě Ověřené ID Microsoftu se obsluhuje přes protokol HTTPS. Všechny adresy URL odkazované v dokumentaci mají následující základ: https://verifiedid.did.msidentity.com.

Autentizace

Rozhraní API je chráněné prostřednictvím ID Microsoft Entra a používá nosné tokeny OAuth2. Při získání přístupového tokenu udělte registraci aplikace oprávnění rozhraní API pro Verifiable Credentials Service Admin obor 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access a použijte ho.

Hledání vystavitelů

Pomocí tohoto rozhraní API vyhledejte vystavitele dostupné v síti Microsoft Entra Verified ID Network. Vystavitele můžete vyhledat podle názvu propojené domény. Hodnota zadaná pro parametr filter slouží k vyhledání vystavitelů, které jsou připojené k ověřenému ID Microsoft Entra a mají ověřenou propojenou doménu. V současné době můžete filtrovat pouze podle linkeddomainurls a pomocí operátoru like. V odpovědi je maximálně 15 vystavitelů.

požadavek HTTP

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

Hlavičky požadavku

Záhlaví	Hodnota
Oprávnění	Nosný (token). Požadovaný
Typ obsahu	application/json

Parametry požadavku

Parametr	Hodnota
filtr	linkeddomainurls, jako je Woodgrove

Návratová zpráva

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

Hledání publikovaných typů přihlašovacích údajů vystavitelem

Toto rozhraní API slouží k vyhledání publikovaných typů přihlašovacích údajů pro konkrétního vystavitele. Potřebujete znát vystavitele tenantId a issuerId. Vrácená zpráva je kolekce publikovaných typů přihlašovacích údajů a jejich příslušných deklarací identity. V odpovědi je maximálně 100 typů přihlašovacích údajů.

požadavek HTTP

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

Hlavičky požadavku

Záhlaví	Hodnota
Oprávnění	Nosný (token). Požadovaný
Typ obsahu	application/json

Parametry požadavku

Parametr	Hodnota
ID nájemce	Id tenanta získané z vyhledávání podle propojeného názvu domény
issuerId	IssuerId získané z vyhledávání podle názvu propojené domény

Návratová zpráva

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

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

Další kroky

Přečtěte si další informace o síti Microsoft Entra Verified ID Network.