Compartir vía

API de red de Verified ID de Microsoft Entra

  • Artículo

Nota:

Microsoft Entra Verified ID es ahora Microsoft Entra Verified ID y forma parte de la familia de productos Microsoft Entra. Obtenga más información sobre la familia de soluciones de identidad Microsoft Entra y empiece a trabajar en el centro de administración unificado de Microsoft Entra.

La API de red de Verified ID de Microsoft Entra le permite buscar credenciales publicadas en la red de Verified ID de Microsoft Entra.

Nota:

La API está diseñada para desarrolladores que se sientan cómodos con las API RESTful.

URL base

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

Autenticación

La API está protegida mediante Microsoft Entra ID 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 los emisores disponibles en la red de Verified ID de Microsoft Entra. Puede buscar emisores por su nombre de dominio vinculado. El valor proporcionado para el parámetro filter se usará para buscar emisores que se hayan incorporado a Verified ID de Microsoft Entra y que tengan un dominio vinculado comprobado. Actualmente, solo puede filtrar por linkeddomainurls y con el operador like. Habrá un máximo de 15 emisores en la respuesta.

Solicitud HTTP

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

Encabezados de solicitud

Encabezado Value
Authorization Bearer (token de portador). Requerido
Content-Type application/json

Parámetros de solicitud

Parámetro value
filter linkeddomainurls como Woodgrove

Mensaje devuelto

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

Búsqueda de los tipos de credenciales publicados por un emisor

Esta API se usa para buscar los tipos de credenciales publicados por un emisor específico. Debe conocer los valores de tenantId y issuerId del emisor. El mensaje devuelto es una colección de tipos de credenciales publicadas y sus notificaciones respectivas. Habrá 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 Value
Authorization Bearer (token de portador). Requerido
Content-Type application/json

Parámetros de solicitud

Parámetro value
tenantId Valor de TenantId obtenido en la búsqueda por nombre de dominio vinculado
issuerId Valor de issuerId obtenido en 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

Más información sobre la red de identificación verificada por Microsoft Entra.