Criar verifiedIdProfile

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.

Crie um novo objeto verifiedIdProfile .

Essa API está disponível nas seguintes implantações de nuvem nacional.

Serviço global Governo dos EUA L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ❌ ❌ ❌

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões com privilégios mais elevados
Delegado (conta corporativa ou de estudante) VerifiedId-Profile.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Aplicativo Sem suporte. Sem suporte.

Importante

Para acesso delegado usando contas corporativas ou de estudante, o usuário conectado deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. O Administrador de Política de Autenticação é a função com menos privilégios com suporte para essa operação.

Solicitação HTTP

POST /identity/verifiedId/profiles

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça uma representação JSON do objeto verifiedIdProfile .

Você pode especificar as propriedades a seguir ao criar um verifiedIdProfile.

Propriedade Tipo Descrição
description Cadeia de caracteres Descrição do perfil de ID verificada. Obrigatório.
faceCheckConfiguration faceCheckConfiguration Conjunto de propriedades que configuram Entra ID verificada comportamento da Face Check. Obrigatório.
lastModifiedDateTime DateTimeOffset Data/hora em que o perfil foi modificado pela última vez. Opcional.
mobileDriversLicenseConfiguration mobileDriversLicenseConfiguration Configuração para aceitar carteiras de motorista móveis. Opcional.
nome Cadeia de caracteres Nome de exibição para o perfil de ID verificada. Obrigatório.
prioridade Int32 Define a prioridade de processamento de perfil se vários perfis estiverem configurados. Opcional.
selfServiceIssuing verifiedIdSelfServiceIssuance Configuração para emissão de autoatendimento. Opcional.
state verifiedIdProfileState Estado de habilitação do perfil. Os valores possíveis são: enabled, disabled, unknownFutureValue. Obrigatório.
verifiedIdProfileConfiguration verifiedIdProfileConfiguration Conjunto de propriedades que expressam o emissor aceito, a vinculação de declarações e o tipo de credencial. Obrigatório.
verifiedIdUsageConfigurations Coleção verifiedIdUsageConfiguration Coleção que define a finalidade de uso do perfil. Os valores possíveis são: recovery, onboarding, all, unknownFutureValue, verification. Use o Prefer: include-unknown-enum-members cabeçalho da solicitação para obter o seguinte valor dessa enumeração evolutiva: verification. Obrigatório.
verifierDid Cadeia de caracteres Cadeia de caracteres de identificador descentralizado (DID) que representa o verificador na troca de credenciais verificável. Obrigatório.

Resposta

Se for bem-sucedido, esse método retornará um código de 201 Created resposta e um objeto verifiedIdProfile no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/identity/verifiedId/profiles
Content-Type: application/json

{
  "name": "Contoso Verified ID",
  "description": "Contoso Verified Identity",
  "lastModifiedDateTime": null,
  "state": "enabled",
  "verifierDid": "did:web:eu.did-dev.contoso.io",
  "priority": 0,
  "verifiedIdProfileConfiguration": {
      "methodType": "tenantCustomCredential",
      "type": "verifiedIdentity",
      "manifestUrl": "https://verifiedid.contoso.com/manifest",
      "acceptedIssuer": "did:web:eu.did-dev.contoso.io",
      "claimBindingSource": "directory",
      "claimBindings": [
          {
              "sourceAttribute": "First name",
              "verifiedIdClaim": "vc.credentialSubject.firstName"
          },
          {
              "sourceAttribute": "Last name",
              "verifiedIdClaim": "vc.credentialSubject.lastName"
          }
      ]
  },
  "faceCheckConfiguration": {
      "isEnabled": true,
      "sourcePhotoClaimName": "portrait"
  },
  "mobileDriversLicenseConfiguration": {
      "acceptedRegions": [
          "region-code"
      ],
      "documentStandard": "document-standard"
  },
  "verifiedIdUsageConfigurations": [
      {
          "isEnabledForTestOnly": true,
          "purpose": "verification"
      }
  ],
  "selfServiceIssuance": {
      "isEnabled": true,
      "issuanceUrl": "https://verifiedid.contoso.com/issue"
  }
}

Resposta

O exemplo a seguir mostra a resposta.

Observação: o objeto de resposta mostrado aqui pode ser encurtado para legibilidade.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/verifiedId/profiles/$entity",
    "id": "ca15ec56-7adf-42ee-847b-00c3008264fb",
    "name": "Contoso Verified ID",
    "description": "Contoso Verified ID",
    "lastModifiedDateTime": null,
    "state": "enabled",
    "verifierDid": "did:web:eu.did-dev.contoso.io",
    "priority": 0,
    "verifiedIdProfileConfiguration": {
        "methodType": "tenantCustomCredential",
        "type": "verifiedIdentity",
        "manifestUrl": "https://verifiedid.contoso.com/manifest",
        "acceptedIssuer": "did:web:eu.did-dev.contoso.io",
        "claimBindingSource": "directory",
        "claimBindings": [
            {
                "sourceAttribute": "First name",
                "verifiedIdClaim": "vc.credentialSubject.firstName"
            },
            {
                "sourceAttribute": "Last name",
                "verifiedIdClaim": "vc.credentialSubject.lastName"
            }
        ]
    },
    "faceCheckConfiguration": {
        "isEnabled": true,
        "sourcePhotoClaimName": "portrait"
    },
    "mobileDriversLicenseConfiguration": {
        "acceptedRegions": [
            "region-code"
        ],
        "documentStandard": "document-standard"
    },
    "verifiedIdUsageConfigurations": [
        {
            "isEnabledForTestOnly": true,
            "purpose": "verification"
        }
    ],
    "selfServiceIssuance": {
        "isEnabled": true,
        "issuanceUrl": "https://verifiedid.contoso.com/issue"
    }
}