API de rede de ID verificada do Microsoft Entra

A API de Rede de ID Verificada do Microsoft Entra permite que você pesquise credenciais publicadas no da Rede de ID Verificada do Microsoft Entra.

Base URL

A API de Rede Verificada da ID do Microsoft Entra é fornecida por HTTPS. Todas as URLs referenciadas na documentação têm a seguinte base: https://verifiedid.did.msidentity.com.

Autenticação

A API é protegida por meio da ID do Microsoft Entra e usa tokens de portador OAuth2. O registro do aplicativo precisa ter a Permissão de API para Verifiable Credentials Service Admin e, ao adquirir o token de acesso, o aplicativo deve usar o escopo 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access.

Pesquisando emissores

Essa API é usada para pesquisar emissores disponíveis na Rede de ID Verificada do Microsoft Entra. Você pode procurar emissores pelo nome de domínio vinculado. O valor fornecido para o parâmetro filter é usado para localizar emissores que integraram a ID verificada do Microsoft Entra e têm um domínio vinculado verificado. Atualmente, você só pode filtrar por linkeddomainurls e com o operador like. Há um máximo de 15 emissores na resposta.

Solicitação HTTP

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

Cabeçalhos de solicitação

Parâmetros de solicitação

Mensagem de retorno

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

Pesquisando tipos de credencial publicados por um emissor

Essa API é usada para pesquisar tipos de credencial publicados para um emissor específico. Você precisa conhecer os emissores tenantId e issuerId. A mensagem de retorno é uma coleção de tipos de credencial publicados e suas respectivas declarações. Há um máximo de 100 tipos de credencial na resposta.

Solicitação HTTP

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

Cabeçalhos de solicitação

Parâmetros de solicitação

Mensagem de retorno

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

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

Próximas etapas

Saiba mais sobre de rede de ID verificada do Microsoft Entra .