API da Rede de ID Verificada do Microsoft Entra

Observação

A ID Verificada do Microsoft Entra agora é ID Verificada do Microsoft Entra e faz parte da família de produtos Microsoft Entra. Saiba mais sobre a família Microsoft Entra de soluções de identidade e comece a usar o centro de administração unificado Microsoft Entra.

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

Observação

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. Todas as URLs referenciadas na documentação têm a seguinte base: https://verifiedid.did.msidentity.com.

Autenticação

A API é protegida por meio 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.

Como pesquisar emissores

Essa API é usada para pesquisar emissores disponíveis na Rede da ID Verificada do Microsoft Entra. Você pode pesquisar emissores pelo nome de domínio vinculado. O valor fornecido para o parâmetro filter será 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. Haverá, no máximo, 15 emissores na resposta.

Solicitação HTTP

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

Cabeçalhos da solicitação

Cabeçalho	Valor
Autorização	Token (de portador). Obrigatório
Tipo de conteúdo	aplicativo/json

Parâmetros da solicitação

Parâmetro	valor
filtro	linkeddomainurls como Woodgrove

Mensagem de retorno

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

[
  {
    "id": "0459a193-1111-2222-3333-444455556666",
    "tenantId": "55eafede-1111-2222-3333-444455556666",
    "did": "did:web:bank.woodgrove.com...<SNIP>...",
    "name": "WoodgroveBank",
    "linkedDomainUrls": [
      "https://bank.woodgrove.com/"
    ]
  },
  {
    "id": "6e0e41cb-1111-2222-3333-444455556666",
    "tenantId": "7f448f57-1111-2222-3333-444455556666",
    "did": "did:web:woodgrove.com...<SNIP>...",
    "name": "Woodgrove",
    "linkedDomainUrls": [
      "https://woodgrove.com/"
    ]
  }
]

Como procurar 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 as respectivas declarações. Haverá um máximo de 100 tipos de credenciais na resposta.

Solicitação HTTP

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

Cabeçalhos da solicitação

Cabeçalho	Valor
Autorização	Token (de portador). Obrigatório
Tipo de conteúdo	aplicativo/json

Parâmetros da solicitação

Parâmetro	valor
tenantId	TenantId obtida da pesquisa pelo nome de domínio vinculado
IssuerId	IssuerId obtida da pesquisa pelo 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óximas etapas

Saiba mais sobre a Rede da ID Verificada do Microsoft Entra.