Compartir vía

Modelo de definición de reglas y visualización

  • Artículo

Las reglas y las definiciones de visualización se usan para definir una credencial. Para obtener más información sobre ello, consulteProcedimiento para personalizar las credenciales verificables.

tipo rulesModel

Propiedad Tipo Descripción
attestations idTokenAttestation y/o idTokenHintAttestation y/o verifiablePresentationAttestation y/o selfIssuedAttestation define los flujos de atestación que se usarán para recopilar notificaciones que se vayan a emitir en la credencial verificable.
validityInterval number representa la duración de la credencial en segundos
vc vcType tipos de credenciales verificables para este contrato

Ejemplo de tipo de atestación en JSON. Tenga en cuenta que selfIssued es una sola instancia mientras que las demás son colecciones. Para obtener ejemplos de cómo usar el tipo de atestación, consulte Definiciones de reglas JSON de ejemplo en las guías de instrucciones.

"attestations": {
  "idTokens": [],
  "idTokenHints": [],
  "presentations": [],
  "selfIssued": {}
}

Tipo idTokenAttestation

Cuando el usuario inicie sesión desde la aplicación Authenticator, podrá usar como entrada el token de identificador devuelto por el proveedor compatible OpenID Connect como entrada.

Propiedad Tipo Descripción
mapping claimMapping (opcional) reglas para asignar notificaciones de entrada a notificaciones de salida en la credencial verificable
configuration string (url) ubicación del documento de configuración del proveedor de identidades
clientId string identificador de cliente que se va a usar al obtener el token de identificador
redirectUri string URI de redireccionamiento que se usará al obtener el token de identificador. DEBE SER vcclient://openid/
scope string lista delimitada por espacios de ámbitos que se van a usar al obtener el token de identificador
required boleano (valor predeterminado falso) indica si esta atestación es necesaria o no
trustedIssuers cadena opcional (conjunto) lista de las DID que pueden emitir la credencial verificable para este contrato. Esta propiedad solo se usa en escenarios específicos en los que el indicador id_token_hint puede proceder de otro emisor

tipo idTokenHintAttestation

Este flujo usa una sugerencia de token de identificador, que se proporciona como carga útil a través de la API REST de solicitud. La asignación es la misma que para la atestación de token de identificador.

Propiedad Tipo Descripción
mapping claimMapping (opcional) reglas para asignar notificaciones de entrada a notificaciones de salida en la credencial verificable
required boleano (valor predeterminado falso) indica si esta atestación es necesaria o no. La API de servicio de solicitudes producirá un error en la llamada si no se establecen notificaciones necesarias en la carga createPresentationRequest.
trustedIssuers cadena opcional (conjunto) lista de las DID que pueden emitir la credencial verificable para este contrato. Esta propiedad solo se usa en escenarios específicos en los que el indicador id_token_hint puede proceder de otro emisor

tipo verifiablePresentationAttestation

Cuando desee que el usuario presente otra credencial verificable como entrada para una nueva credencial verificable emitida. La cartera permite al usuario seleccionar la credencial verificable durante la emisión.

Propiedad Tipo Descripción
mapping claimMapping (opcional) reglas para asignar notificaciones de entrada a notificaciones de salida en la credencial verificable
credentialType cadena (opcional) tipo de credencial necesario de la entrada
required boleano (valor predeterminado falso) indica si esta atestación es necesaria o no
trustedIssuers cadena (conjunto) lista de las DID que pueden emitir la credencial verificable para este contrato. El servicio tiene el emisor en segundo plano como valor predeterminado, por lo que no es necesario que proporcione este valor.

tipo selfIssuedAttestation

Cuando quiera que el usuario escriba la información. Este tipo también se denomina entrada autocertificada.

Propiedad Tipo Descripción
mapping claimMapping (opcional) reglas para asignar notificaciones de entrada a notificaciones de salida en la credencial verificable
required boleano (valor predeterminado falso) indica si esta atestación es necesaria o no

tipo claimMapping

Propiedad Tipo Description
inputClaim string nombre de la notificación que se va a usar desde la entrada
outputClaim string nombre de la notificación de la credencial verificable
indexed boleano (valor predeterminado falso) indica si el valor de esta solicitud se utiliza para la búsqueda; solo se puede indexar un objeto clientMapping para un contrato determinado
required boleano (valor predeterminado falso) indica si esta asignación es necesaria o no
type cadena (opcional) tipo de solicitud

tipo vcType

Propiedad Tipo Descripción
type cadena (conjunto) una lista de tipos de credenciales verificables que este contrato puede emitir

Ejemplo de definición de reglas:

{
  "attestations": {
    "idTokenHints": [
      {
        "mapping": [
          {
            "outputClaim": "givenName",
            "required": false,
            "inputClaim": "given_name",
            "indexed": false
          },
          {
            "outputClaim": "familyName",
            "required": false,
            "inputClaim": "family_name",
            "indexed": false
          }
        ],
        "required": false
      }
    ]
  },
  "validityInterval": 2592000,
  "vc": {
    "type": [
      "VerifiedCredentialExpert"
    ]
  }
}

tipo displayModel

Propiedad Tipo Description
locale string configuración regional de esta visualización
credential displayCredential las propiedades de visualización de la credencial verificable
consent displayConsent datos adicionales cuando se genera la credencial verificable
claims conjunto de displayClaims etiquetas para las notificaciones incluidas en la credencial verificable

tipo displayCredential

Propiedad Tipo Description
title string título de la credencial
issuedBy string nombre del emisor de la credencial
backgroundColor número (hexadecimal) color de fondo de la credencial en formato hexadecimal, por ejemplo, #FFAABB
textColor número (hexadecimal) color de texto de la credencial en formato hexadecimal, por ejemplo, #FFAABB
description string Texto adicional que se muestra con cada credencial
logo displayCredentialLogo logotipo que se va a usar para la credencial

tipo displayCredentialLogo

Propiedad Tipo Descripción
uri string (url) url del logotipo.
description string descripción de logotipo

Nota:

Microsoft recomienda usar formatos de imagen ampliamente compatibles, como .PNG, .JPG o .BMP, para reducir los errores de formato de archivo.

tipo displayConsent

Propiedad Tipo Description
title string título del consentimiento
instructions string texto adicional que se va a usar cuando se muestre el consentimiento

tipo displayClaims

Propiedad Tipo Description
label string etiqueta de la solicitud de visualización
claim string nombre de la solicitud a la que se aplica la etiqueta. Para el formato JWT-VC, el valor deberá tener el prefijo vc.credentialSubject..
type string tipo de solicitud
description cadena (opcional) descripción de solicitud

Ejemplo de definición de visualización:

{
  "locale": "en-US",
  "card": {
    "backgroundColor": "#FFA500",
    "description": "This is your Verifiable Credential",
    "issuedBy": "Contoso",
    "textColor": "#FFFF00",
    "title": "Verifiable Credential Expert",
    "logo": {
      "description": "Default VC logo",
      "uri": "https://didcustomerplayground.z13.web.core.windows.net/VerifiedCredentialExpert_icon.png"
    }
  },
  "consent": {
    "instructions": "Please click accept to add this credentials",
    "title": "Do you want to accept the verified credential expert dentity?"
  },
  "claims": [
    {
      "claim": "vc.credentialSubject.givenName",
      "label": "Name",
      "type": "String"
    },
    {
      "claim": "vc.credentialSubject.familyName",
      "label": "Surname",
      "type": "String"
    }
  ]
}

Pasos siguientes