Partilhar via

API de rede de ID Verificada do Microsoft Entra

  • Artigo

A API de Rede de ID Verificada do Microsoft Entra permite pesquisar credenciais publicadas na Rede de ID Verificada do Microsoft Entra.

Nota

A API destina-se a desenvolvedores confortáveis com APIs RESTful.

URL Base

A API de Rede Verificada do Microsoft Entra ID é servida por HTTPS. Todos os URLs referenciados na documentação têm a seguinte base: https://verifiedid.did.msidentity.com.

Autenticação

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

Pesquisa de emissores

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

Pedido HTTP

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

Cabeçalhos do pedido

Cabeçalho Valor
Autorização Portador (token). Necessário
Tipo de Conteúdo application/json

Parâmetros de solicitação

Parâmetro valor
filtrar linkeddomainurls como Woodgrove

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 credenciais publicados por um emissor

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

Pedido HTTP

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

Cabeçalhos do pedido

Cabeçalho Valor
Autorização Portador (token). Necessário
Tipo de Conteúdo application/json

Parâmetros de solicitação

Parâmetro valor
tenantId TenantId obtido a partir da pesquisa por nome de domínio vinculado
issuerId IssuerId obtido a partir da pesquisa por nome de domínio vinculado

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óximos passos

Saiba mais sobre o Microsoft Entra Verified ID Network.