Compartir a través de

API de red de identificadores comprobados de Microsoft Entra

  • Artículo

La API microsoft Entra Verified ID Network le permite buscar credenciales publicadas en el Microsoft Entra Verified ID Network.

Nota

La API está pensada para desarrolladores cómodos con las API de RESTful.

Base URL

La API de red comprobada de Microsoft Entra ID se proporciona a través de HTTPS. Todas las direcciones URL a las que se hace referencia en la documentación tienen la siguiente base: https://verifiedid.did.msidentity.com.

Autenticación

La API está protegida a través del identificador de Entra de Microsoft y usa tokens de portador de OAuth2. El registro de la aplicación debe tener el permiso de API para Verifiable Credentials Service Admin y, a continuación, al adquirir el token de acceso, la aplicación debe usar el ámbito 6a8b4b39-c021-437c-b060-5a14a3fd65f3/full_access.

Búsqueda de emisores

Esta API se usa para buscar emisores disponibles en microsoft Entra Verified ID Network. Puede buscar emisores por su nombre de dominio vinculado. El valor proporcionado para el parámetro filter se usa para buscar emisores que se incorporaron al identificador comprobado de Microsoft Entra y tener un dominio vinculado comprobado. Actualmente solo puede filtrar por linkeddomainurls y con el operador like. Hay un máximo de 15 emisores en la respuesta.

Solicitud HTTP

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

Encabezados de solicitud

Encabezado Valor
Autorización Portador (token). Obligatorio
Tipo de contenido application/json

Parámetros de solicitud

Parámetro valor
filtro linkeddomainurls como Woodgrove

Mensaje devuelto

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

Búsqueda de tipos de credenciales publicados por un emisor

Esta API se usa para buscar tipos de credenciales publicados para un emisor específico. Debe conocer los emisores tenantId y issuerId. El mensaje devuelto es una colección de tipos de credenciales publicados y sus notificaciones respectivas. Hay un máximo de 100 tipos de credenciales en la respuesta.

Solicitud HTTP

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

Encabezados de solicitud

Encabezado Valor
Autorización Portador (token). Obligatorio
Tipo de contenido application/json

Parámetros de solicitud

Parámetro valor
tenantId TenantId obtenido de la búsqueda por nombre de dominio vinculado
issuerId IssuerId obtenido de la búsqueda por nombre de dominio vinculado

Mensaje devuelto

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

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

Pasos siguientes

Obtenga más información sobre microsoft Entra Verified ID Network.