Referência de Definição de Regras e Exibição

  • Artigo

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.

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

tipo rulesModel

Propriedade Type Descrição
attestations idTokenAttestation e/ou idTokenHintAttestation e/ou verifiablePresentationAttestation e/ou selfIssuedAttestation define os fluxos de atestado a serem usados para coletar declarações a serem emitidas na credencial verificável.
validityInterval número representa o tempo de vida da credencial em segundos
vc vcType tipos de credencial verificáveis para este contrato

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, confira as Amostras de definições de regras de JSON nos guias de instruções.

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

Tipo de idTokenAttestation

Ao entrar com o usuário a partir do Authenticator, você pode usar o token de ID retornado do provedor compatível com o OpenID Connect como entrada.

Propriedade Type Descrição
mapping claimMapping (opcional) regras para mapear declarações de entrada em declarações de saída na credencial verificável
configuration string (url) localização do documento de configuração do provedor de identidade
clientId string ID do cliente a ser usada ao obter o token de ID
redirectUri string uri de redirecionamento a ser usado 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 (padrão falso) indicando se esse atestado é necessário ou não
trustedIssuers cadeia de caracteres opcional (matriz) uma lista de DIDs permitidos para emitir a credencial verificável para este contrato. Essa propriedade é usada apenas para cenários específicos em que a id_token_hint pode vir de outro emissor

Tipo de idTokenHintAttestation

Esse fluxo usa o a ID da Dica de Token, que é fornecida como conteúdo por meio da API REST de Solicitação. O mapeamento é o mesmo que para o atestado do Token de ID.

Propriedade Type Descrição
mapping claimMapping (opcional) regras para mapear declarações de entrada em declarações de saída na credencial verificável
required booleano (padrão falso) indicando se esse atestado é necessário ou não
trustedIssuers cadeia de caracteres opcional (matriz) uma lista de DIDs permitidos para emitir a credencial verificável para este contrato. Essa propriedade é usada apenas para cenários específicos em que a id_token_hint pode vir de outro emissor

tipo de verifiablePresentationAttestation

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

Propriedade Type Descrição
mapping claimMapping (opcional) regras para mapear declarações de entrada em declarações de saída na credencial verificável
credentialType cadeia de caracteres (opcional) tipo de credencial necessário da entrada
required booleano (padrão falso) indicando se esse atestado é necessário ou não
trustedIssuers cadeia de caracteres (matriz) uma lista de DIDs permitidos para emitir a credencial verificável para este contrato. O serviço será padrão para o emissor sob as coberturas, portanto, não é necessário fornecer esse valor por conta própria.

tipo de selfIssuedAttestation

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

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

tipo de claimMapping

Propriedade Type Descrição
inputClaim string o nome da declaração a ser usada da entrada
outputClaim string o nome da declaração na credencial verificável
indexed booleano (padrão falso) indicando se o valor dessa declaração é usado para pesquisa, apenas um objeto clientMapping é indexável para um determinado contrato
required booleano (padrão falso) indicando se esse mapeamento é necessário ou não
type cadeia de caracteres (opcional) tipo de declaração

tipo vcType

Propriedade Type Descrição
type cadeia de caracteres (matriz) uma lista de tipos de credenciais verificáveis que esse contrato pode emitir

Definição de regras de exemplo:

{
  "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 de displayModel

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

tipo de displayCredential

Propriedade Type Descrição
title string título da credencial
issuedBy string o nome do emissor da credencial
backgroundColor número (hexa) cor da tela de fundo da credencial no formato hexa, por exemplo, #FFAABB
textColor número (hexa) cor do texto da credencial no formato hexa, por exemplo, #FFAABB
description string texto complementar exibido junto com cada credencial
logo displayCredentialLogo o logotipo a ser usado para a credencial

tipo de displayCredentialLogo

Propriedade Type Descrição
uri string (url) URL do logotipo.
description string a descrição do logotipo

tipo de displayConsent

Propriedade Type Descrição
title string título do consentimento
instructions string texto complementar a ser usado ao exibir consentimento

tipo de displayClaims

Propriedade Type Descrição
label string o rótulo da declaração em exibição
claim string o nome da declaração à qual o rótulo se aplica. Para o formato JWT-VC, o valor precisa ter o prefixo de vc.credentialSubject..
type string o tipo da declaração
description cadeia de caracteres (opcional) a descrição da declaração

Definição de exibição de exemplo:

{
  "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.blob.core.windows.net/public/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óximas etapas