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.
Atualize as propriedades de um 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
PATCH /identity/verifiedId/profiles/{verifiedIdProfileId}
| 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 apenas os valores das propriedades a serem atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação mantêm seus valores anteriores ou são recalculadas com base nas alterações de outros valores de propriedade.
A tabela a seguir especifica as propriedades que podem ser atualizadas.
| Propriedade |
Tipo |
Descrição |
| description |
Cadeia de caracteres |
Descrição do perfil de ID verificada. |
| faceCheckConfiguration |
faceCheckConfiguration |
Conjunto de propriedades que configuram ID Verificada do Microsoft Entra comportamento da Face Check. |
| lastModifiedDateTime |
DateTimeOffset |
Data e hora em que o perfil foi modificado pela última vez. |
| mobileDriversLicenseConfiguration |
mobileDriversLicenseConfiguration |
Configuração para aceitar carteiras de motorista móveis. |
| nome |
Cadeia de caracteres |
Nome de exibição do perfil de ID verificada. |
| prioridade |
Int32 |
Define a prioridade de processamento de perfil se vários perfis estiverem configurados. |
| selfServiceIssuing |
verifiedIdSelfServiceIssuance |
Configuração para emissão de autoatendimento. |
| state |
verifiedIdProfileState |
Estado de habilitação do perfil. Os valores possíveis são: enabled, disabled, unknownFutureValue. |
| verifiedIdProfileConfiguration |
verifiedIdProfileConfiguration |
Conjunto de propriedades que expressam o emissor aceito, a vinculação de declarações e o tipo de credencial. |
| 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. |
| verifierDid |
Cadeia de caracteres |
Cadeia de caracteres de identificador descentralizado (DID) que representa o verificador na troca de credenciais verificável. |
Resposta
Se tiver êxito, este método retornará um código de resposta 204 No Content.
Exemplos
Solicitação
O exemplo a seguir mostra uma solicitação.
PATCH https://graph.microsoft.com/beta/identity/verifiedId/profiles/ca15ec56-7adf-42ee-847b-00c3008264fb
Content-Type: application/json
{
"verifiedIdProfileConfiguration": {
"methodType": "tenantCustomCredential",
"manifestUrl": "https://verifiedid.contoso.com/manifest"
},
"mobileDriversLicenseConfiguration": {
"acceptedRegions": [
"region-code"
],
"documentStandard": "document-standard"
},
"selfServiceIssuance": {
"isEnabled": true,
"issuanceUrl": "https://verifiedid.contoso.com/issue"
},
"verifiedIdUsageConfigurations": [
{
"isEnabledForTestOnly": false,
"purpose": "verification"
}
]
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new VerifiedIdProfile
{
VerifiedIdProfileConfiguration = new VerifiedIdProfileConfiguration
{
MethodType = VerifiedIdMethodType.TenantCustomCredential,
ManifestUrl = "https://verifiedid.contoso.com/manifest",
},
MobileDriversLicenseConfiguration = new MobileDriversLicenseConfiguration
{
AcceptedRegions = new List<string>
{
"region-code",
},
DocumentStandard = "document-standard",
},
SelfServiceIssuance = new VerifiedIdSelfServiceIssuance
{
IsEnabled = true,
IssuanceUrl = "https://verifiedid.contoso.com/issue",
},
VerifiedIdUsageConfigurations = new List<VerifiedIdUsageConfiguration>
{
new VerifiedIdUsageConfiguration
{
IsEnabledForTestOnly = false,
Purpose = VerifiedIdUsageConfigurationPurpose.Verification,
},
},
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Identity.VerifiedId.Profiles["{verifiedIdProfile-id}"].PatchAsync(requestBody);
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewVerifiedIdProfile()
verifiedIdProfileConfiguration := graphmodels.NewVerifiedIdProfileConfiguration()
methodType := graphmodels.TENANTCUSTOMCREDENTIAL_VERIFIEDIDMETHODTYPE
verifiedIdProfileConfiguration.SetMethodType(&methodType)
manifestUrl := "https://verifiedid.contoso.com/manifest"
verifiedIdProfileConfiguration.SetManifestUrl(&manifestUrl)
requestBody.SetVerifiedIdProfileConfiguration(verifiedIdProfileConfiguration)
mobileDriversLicenseConfiguration := graphmodels.NewMobileDriversLicenseConfiguration()
acceptedRegions := []string {
"region-code",
}
mobileDriversLicenseConfiguration.SetAcceptedRegions(acceptedRegions)
documentStandard := "document-standard"
mobileDriversLicenseConfiguration.SetDocumentStandard(&documentStandard)
requestBody.SetMobileDriversLicenseConfiguration(mobileDriversLicenseConfiguration)
selfServiceIssuance := graphmodels.NewVerifiedIdSelfServiceIssuance()
isEnabled := true
selfServiceIssuance.SetIsEnabled(&isEnabled)
issuanceUrl := "https://verifiedid.contoso.com/issue"
selfServiceIssuance.SetIssuanceUrl(&issuanceUrl)
requestBody.SetSelfServiceIssuance(selfServiceIssuance)
verifiedIdUsageConfiguration := graphmodels.NewVerifiedIdUsageConfiguration()
isEnabledForTestOnly := false
verifiedIdUsageConfiguration.SetIsEnabledForTestOnly(&isEnabledForTestOnly)
purpose := graphmodels.VERIFICATION_VERIFIEDIDUSAGECONFIGURATIONPURPOSE
verifiedIdUsageConfiguration.SetPurpose(&purpose)
verifiedIdUsageConfigurations := []graphmodels.VerifiedIdUsageConfigurationable {
verifiedIdUsageConfiguration,
}
requestBody.SetVerifiedIdUsageConfigurations(verifiedIdUsageConfigurations)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
profiles, err := graphClient.Identity().VerifiedId().Profiles().ByVerifiedIdProfileId("verifiedIdProfile-id").Patch(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
VerifiedIdProfile verifiedIdProfile = new VerifiedIdProfile();
VerifiedIdProfileConfiguration verifiedIdProfileConfiguration = new VerifiedIdProfileConfiguration();
verifiedIdProfileConfiguration.setMethodType(VerifiedIdMethodType.TenantCustomCredential);
verifiedIdProfileConfiguration.setManifestUrl("https://verifiedid.contoso.com/manifest");
verifiedIdProfile.setVerifiedIdProfileConfiguration(verifiedIdProfileConfiguration);
MobileDriversLicenseConfiguration mobileDriversLicenseConfiguration = new MobileDriversLicenseConfiguration();
LinkedList<String> acceptedRegions = new LinkedList<String>();
acceptedRegions.add("region-code");
mobileDriversLicenseConfiguration.setAcceptedRegions(acceptedRegions);
mobileDriversLicenseConfiguration.setDocumentStandard("document-standard");
verifiedIdProfile.setMobileDriversLicenseConfiguration(mobileDriversLicenseConfiguration);
VerifiedIdSelfServiceIssuance selfServiceIssuance = new VerifiedIdSelfServiceIssuance();
selfServiceIssuance.setIsEnabled(true);
selfServiceIssuance.setIssuanceUrl("https://verifiedid.contoso.com/issue");
verifiedIdProfile.setSelfServiceIssuance(selfServiceIssuance);
LinkedList<VerifiedIdUsageConfiguration> verifiedIdUsageConfigurations = new LinkedList<VerifiedIdUsageConfiguration>();
VerifiedIdUsageConfiguration verifiedIdUsageConfiguration = new VerifiedIdUsageConfiguration();
verifiedIdUsageConfiguration.setIsEnabledForTestOnly(false);
verifiedIdUsageConfiguration.setPurpose(VerifiedIdUsageConfigurationPurpose.Verification);
verifiedIdUsageConfigurations.add(verifiedIdUsageConfiguration);
verifiedIdProfile.setVerifiedIdUsageConfigurations(verifiedIdUsageConfigurations);
VerifiedIdProfile result = graphClient.identity().verifiedId().profiles().byVerifiedIdProfileId("{verifiedIdProfile-id}").patch(verifiedIdProfile);
const options = {
authProvider,
};
const client = Client.init(options);
const verifiedIdProfile = {
verifiedIdProfileConfiguration: {
methodType: 'tenantCustomCredential',
manifestUrl: 'https://verifiedid.contoso.com/manifest'
},
mobileDriversLicenseConfiguration: {
acceptedRegions: [
'region-code'
],
documentStandard: 'document-standard'
},
selfServiceIssuance: {
isEnabled: true,
issuanceUrl: 'https://verifiedid.contoso.com/issue'
},
verifiedIdUsageConfigurations: [
{
isEnabledForTestOnly: false,
purpose: 'verification'
}
]
};
await client.api('/identity/verifiedId/profiles/ca15ec56-7adf-42ee-847b-00c3008264fb')
.version('beta')
.update(verifiedIdProfile);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdProfile;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdProfileConfiguration;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdMethodType;
use Microsoft\Graph\Beta\Generated\Models\MobileDriversLicenseConfiguration;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdSelfServiceIssuance;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdUsageConfiguration;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdUsageConfigurationPurpose;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new VerifiedIdProfile();
$verifiedIdProfileConfiguration = new VerifiedIdProfileConfiguration();
$verifiedIdProfileConfiguration->setMethodType(new VerifiedIdMethodType('tenantCustomCredential'));
$verifiedIdProfileConfiguration->setManifestUrl('https://verifiedid.contoso.com/manifest');
$requestBody->setVerifiedIdProfileConfiguration($verifiedIdProfileConfiguration);
$mobileDriversLicenseConfiguration = new MobileDriversLicenseConfiguration();
$mobileDriversLicenseConfiguration->setAcceptedRegions(['region-code', ]);
$mobileDriversLicenseConfiguration->setDocumentStandard('document-standard');
$requestBody->setMobileDriversLicenseConfiguration($mobileDriversLicenseConfiguration);
$selfServiceIssuance = new VerifiedIdSelfServiceIssuance();
$selfServiceIssuance->setIsEnabled(true);
$selfServiceIssuance->setIssuanceUrl('https://verifiedid.contoso.com/issue');
$requestBody->setSelfServiceIssuance($selfServiceIssuance);
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1 = new VerifiedIdUsageConfiguration();
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1->setIsEnabledForTestOnly(false);
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1->setPurpose(new VerifiedIdUsageConfigurationPurpose('verification'));
$verifiedIdUsageConfigurationsArray []= $verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1;
$requestBody->setVerifiedIdUsageConfigurations($verifiedIdUsageConfigurationsArray);
$result = $graphServiceClient->identity()->verifiedId()->profiles()->byVerifiedIdProfileId('verifiedIdProfile-id')->patch($requestBody)->wait();
Import-Module Microsoft.Graph.Beta.Identity.SignIns
$params = @{
verifiedIdProfileConfiguration = @{
methodType = "tenantCustomCredential"
manifestUrl = "https://verifiedid.contoso.com/manifest"
}
mobileDriversLicenseConfiguration = @{
acceptedRegions = @(
"region-code"
)
documentStandard = "document-standard"
}
selfServiceIssuance = @{
isEnabled = $true
issuanceUrl = "https://verifiedid.contoso.com/issue"
}
verifiedIdUsageConfigurations = @(
@{
isEnabledForTestOnly = $false
purpose = "verification"
}
)
}
Update-MgBetaIdentityVerifiedIdProfile -VerifiedIdProfileId $verifiedIdProfileId -BodyParameter $params
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.verified_id_profile import VerifiedIdProfile
from msgraph_beta.generated.models.verified_id_profile_configuration import VerifiedIdProfileConfiguration
from msgraph_beta.generated.models.verified_id_method_type import VerifiedIdMethodType
from msgraph_beta.generated.models.mobile_drivers_license_configuration import MobileDriversLicenseConfiguration
from msgraph_beta.generated.models.verified_id_self_service_issuance import VerifiedIdSelfServiceIssuance
from msgraph_beta.generated.models.verified_id_usage_configuration import VerifiedIdUsageConfiguration
from msgraph_beta.generated.models.verified_id_usage_configuration_purpose import VerifiedIdUsageConfigurationPurpose
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = VerifiedIdProfile(
verified_id_profile_configuration = VerifiedIdProfileConfiguration(
method_type = VerifiedIdMethodType.TenantCustomCredential,
manifest_url = "https://verifiedid.contoso.com/manifest",
),
mobile_drivers_license_configuration = MobileDriversLicenseConfiguration(
accepted_regions = [
"region-code",
],
document_standard = "document-standard",
),
self_service_issuance = VerifiedIdSelfServiceIssuance(
is_enabled = True,
issuance_url = "https://verifiedid.contoso.com/issue",
),
verified_id_usage_configurations = [
VerifiedIdUsageConfiguration(
is_enabled_for_test_only = False,
purpose = VerifiedIdUsageConfigurationPurpose.Verification,
),
],
)
result = await graph_client.identity.verified_id.profiles.by_verified_id_profile_id('verifiedIdProfile-id').patch(request_body)
Resposta
O exemplo a seguir mostra a resposta.
HTTP/1.1 204 No Content