Update verifiedIdProfile

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Update the properties of a verifiedIdProfile object.

This API is available in the following national cloud deployments.

Global service	US Government L4	US Government L5 (DOD)	China operated by 21Vianet
✅	❌	❌	❌

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

Permission type	Least privileged permissions	Higher privileged permissions
Delegated (work or school account)	VerifiedId-Profile.ReadWrite.All	Not available.
Delegated (personal Microsoft account)	Not supported.	Not supported.
Application	Not supported.	Not supported.

Important

For delegated access using work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role that grants the permissions required for this operation. Authentication Policy Administrator is the least privileged role supported for this operation.

HTTP request

PATCH /identity/verifiedId/profiles/{verifiedIdProfileId}

Request headers

Name	Description
Authorization	Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type	application/json. Required.

Request body

In the request body, supply only the values for properties to update. Existing properties that aren't included in the request body maintain their previous values or are recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

Property	Type	Description
description	String	Description for the verified ID profile.
faceCheckConfiguration	faceCheckConfiguration	Set of properties configuring Microsoft Entra Verified ID Face Check behavior.
lastModifiedDateTime	DateTimeOffset	Date and time when the profile was last modified.
mobileDriversLicenseConfiguration	mobileDriversLicenseConfiguration	Configuration for accepting mobile driver's licenses.
name	String	Display name for the verified ID profile.
priority	Int32	Defines profile processing priority if multiple profiles are configured.
selfServiceIssuance	verifiedIdSelfServiceIssuance	Configuration for self-service issuance.
state	verifiedIdProfileState	Enablement state for the profile. The possible values are: enabled, disabled, unknownFutureValue.
verifiedIdProfileConfiguration	verifiedIdProfileConfiguration	Set of properties expressing the accepted issuer, claims binding, and credential type.
verifiedIdUsageConfigurations	verifiedIdUsageConfiguration collection	Collection defining the usage purpose for the profile. The possible values are: recovery, onboarding, all, unknownFutureValue, verification. Use the Prefer: include-unknown-enum-members request header to get the following value from this evolvable enum: verification.
verifierDid	String	Decentralized identifier (DID) string that represents the verifier in the verifiable credential exchange.

Response

If successful, this method returns a 204 No Content response code.

Examples

Request

The following example shows a request.

HTTP

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

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;
using Microsoft.Kiota.Abstractions.Serialization;

var requestBody = new VerifiedIdProfile
{
	VerifiedIdProfileConfiguration = new VerifiedIdProfileConfiguration
	{
		AdditionalData = new Dictionary<string, object>
		{
			{
				"methodType" , "tenantCustomCredential"
			},
			{
				"manifestUrl" , "https://verifiedid.contoso.com/manifest"
			},
		},
	},
	VerifiedIdUsageConfigurations = new List<VerifiedIdUsageConfiguration>
	{
		new VerifiedIdUsageConfiguration
		{
			IsEnabledForTestOnly = false,
			Purpose = VerifiedIdUsageConfigurationPurpose.Recovery,
		},
	},
	AdditionalData = new Dictionary<string, object>
	{
		{
			"mobileDriversLicenseConfiguration" , new UntypedObject(new Dictionary<string, UntypedNode>
			{
				{
					"acceptedRegions", new UntypedArray(new List<UntypedNode>
					{
						new UntypedString("region-code"),
					})
				},
				{
					"documentStandard", new UntypedString("document-standard")
				},
			})
		},
		{
			"selfServiceIssuance" , new UntypedObject(new Dictionary<string, UntypedNode>
			{
				{
					"isEnabled", new UntypedBoolean(true)
				},
				{
					"issuanceUrl", new UntypedString("https://verifiedid.contoso.com/issue")
				},
			})
		},
	},
};

// 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);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Go

// 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()
additionalData := map[string]interface{}{
	"methodType" : "tenantCustomCredential", 
	"manifestUrl" : "https://verifiedid.contoso.com/manifest", 
}
verifiedIdProfileConfiguration.SetAdditionalData(additionalData)
requestBody.SetVerifiedIdProfileConfiguration(verifiedIdProfileConfiguration)


verifiedIdUsageConfiguration := graphmodels.NewVerifiedIdUsageConfiguration()
isEnabledForTestOnly := false
verifiedIdUsageConfiguration.SetIsEnabledForTestOnly(&isEnabledForTestOnly) 
purpose := graphmodels.VERIFICATION_VERIFIEDIDUSAGECONFIGURATIONPURPOSE 
verifiedIdUsageConfiguration.SetPurpose(&purpose) 

verifiedIdUsageConfigurations := []graphmodels.VerifiedIdUsageConfigurationable {
	verifiedIdUsageConfiguration,
}
requestBody.SetVerifiedIdUsageConfigurations(verifiedIdUsageConfigurations)
additionalData := map[string]interface{}{
mobileDriversLicenseConfiguration := graph.New()
	acceptedRegions := []string {
		"region-code",
	}
	mobileDriversLicenseConfiguration.SetAcceptedRegions(acceptedRegions)
documentStandard := "document-standard"
mobileDriversLicenseConfiguration.SetDocumentStandard(&documentStandard) 
	requestBody.SetMobileDriversLicenseConfiguration(mobileDriversLicenseConfiguration)
selfServiceIssuance := graph.New()
	isEnabled := true
selfServiceIssuance.SetIsEnabled(&isEnabled) 
issuanceUrl := "https://verifiedid.contoso.com/issue"
selfServiceIssuance.SetIssuanceUrl(&issuanceUrl) 
	requestBody.SetSelfServiceIssuance(selfServiceIssuance)
}
requestBody.SetAdditionalData(additionalData)

// 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)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Java

// 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();
HashMap<String, Object> additionalData = new HashMap<String, Object>();
additionalData.put("methodType", "tenantCustomCredential");
additionalData.put("manifestUrl", "https://verifiedid.contoso.com/manifest");
verifiedIdProfileConfiguration.setAdditionalData(additionalData);
verifiedIdProfile.setVerifiedIdProfileConfiguration(verifiedIdProfileConfiguration);
LinkedList<VerifiedIdUsageConfiguration> verifiedIdUsageConfigurations = new LinkedList<VerifiedIdUsageConfiguration>();
VerifiedIdUsageConfiguration verifiedIdUsageConfiguration = new VerifiedIdUsageConfiguration();
verifiedIdUsageConfiguration.setIsEnabledForTestOnly(false);
verifiedIdUsageConfiguration.setPurpose(VerifiedIdUsageConfigurationPurpose.Recovery);
verifiedIdUsageConfigurations.add(verifiedIdUsageConfiguration);
verifiedIdProfile.setVerifiedIdUsageConfigurations(verifiedIdUsageConfigurations);
HashMap<String, Object> additionalData1 = new HashMap<String, Object>();
 mobileDriversLicenseConfiguration = new ();
LinkedList<String> acceptedRegions = new LinkedList<String>();
acceptedRegions.add("region-code");
mobileDriversLicenseConfiguration.setAcceptedRegions(acceptedRegions);
mobileDriversLicenseConfiguration.setDocumentStandard("document-standard");
additionalData1.put("mobileDriversLicenseConfiguration", mobileDriversLicenseConfiguration);
 selfServiceIssuance = new ();
selfServiceIssuance.setIsEnabled(true);
selfServiceIssuance.setIssuanceUrl("https://verifiedid.contoso.com/issue");
additionalData1.put("selfServiceIssuance", selfServiceIssuance);
verifiedIdProfile.setAdditionalData(additionalData1);
VerifiedIdProfile result = graphClient.identity().verifiedId().profiles().byVerifiedIdProfileId("{verifiedIdProfile-id}").patch(verifiedIdProfile);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

JavaScript

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);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PHP

<?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\VerifiedIdUsageConfiguration;
use Microsoft\Graph\Beta\Generated\Models\VerifiedIdUsageConfigurationPurpose;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new VerifiedIdProfile();
$verifiedIdProfileConfiguration = new VerifiedIdProfileConfiguration();
$additionalData = [
	'methodType' => 'tenantCustomCredential',
	'manifestUrl' => 'https://verifiedid.contoso.com/manifest',
];
$verifiedIdProfileConfiguration->setAdditionalData($additionalData);
$requestBody->setVerifiedIdProfileConfiguration($verifiedIdProfileConfiguration);
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1 = new VerifiedIdUsageConfiguration();
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1->setIsEnabledForTestOnly(false);
$verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1->setPurpose(new VerifiedIdUsageConfigurationPurpose('verification'));
$verifiedIdUsageConfigurationsArray []= $verifiedIdUsageConfigurationsVerifiedIdUsageConfiguration1;
$requestBody->setVerifiedIdUsageConfigurations($verifiedIdUsageConfigurationsArray);

$additionalData = [
'mobileDriversLicenseConfiguration' => [
	'acceptedRegions' => [
'region-code', ],
	'documentStandard' => 'document-standard',
],
'selfServiceIssuance' => [
	'isEnabled' => true,
	'issuanceUrl' => 'https://verifiedid.contoso.com/issue',
],
];
$requestBody->setAdditionalData($additionalData);

$result = $graphServiceClient->identity()->verifiedId()->profiles()->byVerifiedIdProfileId('verifiedIdProfile-id')->patch($requestBody)->wait();

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

PowerShell

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

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Python

# 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_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(
		additional_data = {
				"method_type" : "tenantCustomCredential",
				"manifest_url" : "https://verifiedid.contoso.com/manifest",
		}
	),
	verified_id_usage_configurations = [
		VerifiedIdUsageConfiguration(
			is_enabled_for_test_only = False,
			purpose = VerifiedIdUsageConfigurationPurpose.Recovery,
		),
	],
	additional_data = {
			"mobile_drivers_license_configuration" : {
					"accepted_regions" : [
						"region-code",
					],
					"document_standard" : "document-standard",
			},
			"self_service_issuance" : {
					"is_enabled" : True,
					"issuance_url" : "https://verifiedid.contoso.com/issue",
			},
	}
)

result = await graph_client.identity.verified_id.profiles.by_verified_id_profile_id('verifiedIdProfile-id').patch(request_body)

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following example shows the response.

HTTP/1.1 204 No Content