Partilhar via

Referência de regras e definição de exibição

  • Artigo

Regras e definições de exibição são usadas para definir uma credencial. Você pode ler mais sobre isso em Como personalizar suas credenciais.

regrasTipo de modelo

Propriedade Type Description
attestations idTokenAttestation e/ou idTokenHintAttestation e/ou verifiablePresentationAttestation e/ou selfIssuedAttestation Define o(s) fluxo(s) de atestado a ser usado para coletar declarações a serem emitidas na credencial verificável.
validityInterval Número representa a vida útil da credencial em segundos
vc vcType Tipos de credenciais verificáveis para este contrato

O exemplo de tipo de atestado em JSON. Observe que selfIssued é uma única instância, enquanto as outras são coleções. Para obter exemplos de como usar o tipo de atestado, consulte Definições de regras JSON de exemplo nos guias de instruções.

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

Tipo idTokenAttestation

Quando inicia sessão no utilizador a partir do Authenticator, pode utilizar o token de ID devolvido do fornecedor compatível com OpenID Connect como entrada.

Propriedade Type Description
mapping claimMapping (opcional) regras para mapear declarações de entrada em declarações de saída na credencial verificável
configuration string (url) Local do documento de configuração do provedor de identidade
clientId string ID do cliente a ser usado ao obter o token de ID
redirectUri string redirecionar uri para usar ao obter o token de ID; DEVE SER vcclient://openid/
scope string lista delimitada por espaço de escopos a serem usados ao obter o token de ID
required Booleano (falso padrão) indicando se este atestado é ou não exigido
trustedIssuers string opcional (matriz) uma lista de DIDs autorizados a emitir a credencial verificável para este contrato. Esta propriedade é usada apenas para cenários específicos em que o id_token_hint pode vir de outro emissor

Tipo idTokenHintAttestation

Esse fluxo usa a dica de token de ID, que é fornecida como carga por meio da API REST de solicitação. O mapeamento é o mesmo do atestado de token de ID.

Propriedade Type Description
mapping claimMapping (opcional) regras para mapear declarações de entrada em declarações de saída na credencial verificável
required Booleano (falso padrão) indicando se este atestado é ou não necessário. A API do Serviço de Solicitação falhará na chamada se as declarações necessárias não estiverem definidas na carga createPresentationRequest.
trustedIssuers string opcional (matriz) uma lista de DIDs autorizados a emitir a credencial verificável para este contrato. Esta propriedade é usada apenas para cenários específicos em que o id_token_hint pode vir de outro emissor

verificablePresentationTipo de atestado

Quando você deseja que o usuário apresente outra credencial verificável como entrada para uma nova credencial verificável emitida. A carteira permite que o usuário selecione a credencial verificável durante a emissão.

Propriedade Type Description
mapping claimMapping (opcional) regras para mapear declarações de entrada em declarações de saída na credencial verificável
credentialType string (opcional) Tipo de credencial necessária da entrada
required Booleano (falso padrão) indicando se este atestado é ou não exigido
trustedIssuers string (matriz) uma lista de DIDs autorizados a emitir a credencial verificável para este contrato. O serviço é padronizado para o seu emissor sob as cobertas, portanto, não há necessidade de fornecer esse valor por conta própria.

selfIssuedAttestation type

Quando você deseja que o usuário insira informações por conta própria. Este tipo também é chamado de entrada auto-atestada.

Propriedade Type Description
mapping claimMapping (opcional) regras para mapear declarações de entrada em declarações de saída na credencial verificável
required Booleano (falso padrão) indicando se este atestado é ou não exigido

tipo claimMapping

Propriedade Type Description
inputClaim string O nome da declaração a ser usada a partir da entrada
outputClaim string o nome da declaração na credencial verificável
indexed Booleano (falso padrão) indicando se o valor desta reivindicação é utilizado para pesquisar; apenas um objeto clientMapping é indexável para um determinado contrato
required Booleano (falso padrão) indicando se esse mapeamento é necessário ou não
type string (opcional) Tipo de sinistro

tipo vcType

Propriedade Type Description
type string (matriz) Uma lista de tipos de credenciais verificáveis que este contrato pode emitir

Exemplo de definição de regras:

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

displayTipo de modelo

Propriedade Type Description
locale string A localidade desta exibição
credential displayCredential As propriedades de exibição da credencial verificável
consent displayConsentimento dados suplementares quando a credencial verificável é emitida
claims matriz displayClaims rótulos para as declarações incluídas na credencial verificável

displayTipo de credencial

Propriedade Type Description
title string Título da credencial
issuedBy string O nome do emissor da credencial
backgroundColor número (hex) cor de plano de fundo da credencial no formato hexadecimal, por exemplo, #FFAABB
textColor número (hex) cor do texto da credencial no formato hexadecimal, por exemplo, #FFAABB
description string texto suplementar exibido ao lado de cada credencial
logo displayCredentialLogo o logotipo a ser usado para a credencial

tipo displayCredentialLogo

Propriedade Type Description
uri string (url) URL do logótipo.
description string a descrição do logótipo

Nota

A Microsoft recomenda que você use formatos de imagem amplamente suportados, como .PNG, .JPG ou .BMP, para reduzir erros de formato de arquivo.

displayTipo de consentimento

Propriedade Type Description
title string Título do consentimento
instructions string texto suplementar a ser usado ao exibir o consentimento

tipo displayClaims

Propriedade Type Description
label string o rótulo da reivindicação em exibição
claim string o nome da alegação a que o rótulo se aplica. Para o formato JWT-VC, o valor precisa ter o prefixo vc.credentialSubject. .
type string o tipo de crédito
description string (opcional) a descrição do crédito

Exemplo de definição de exibição:

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

Próximos passos