Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Namespace: microsoft.graph
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 |
|---|---|---|
| name | String | Display name for the verified Id profile. Required. |
| description | String | Description for the verified Id profile. Required. |
| lastModifiedDateTime | DateTimeOffset | DateTime the profile was last modified. Optional. |
| state | verifiedIdProfileState | Enablement state for the profile. The possible values are: enabled, disabled, unknownFutureValue. Required. |
| verifierDid | String | Decentralized Identifier (DID) string that represents the verifier in the verifiable credential exchange. Required. |
| priority | Int32 | Defines profile processing priority if multiple profiles are configured. Optional. |
| verifiedIdProfileConfiguration | verifiedIdProfileConfiguration | Set of properties expressing the accepted issuer, claims binding, and credential type. Required. |
| faceCheckConfiguration | faceCheckConfiguration | Set of properties configuring Entra Verified ID Face Check behavior. Required. |
| verifiedIdUsageConfigurations | verifiedIdUsageConfiguration collection | Collection defining the usage purpose for the profile. The possible values are: recovery, onboarding, all, unknownFutureValue. Required. |
Response
If successful, this method returns a 204 No Content response code.
Examples
Request
The following example shows a request.
PATCH https://graph.microsoft.com/v1.0/identity/verifiedId/profiles/ca15ec56-7adf-42ee-847b-00c3008264fb
Content-Type: application/json
{
"verifiedIdUsageConfigurations": [
{
"isEnabledForTestOnly": false,
"purpose": "recovery"
}
]
}
Response
The following example shows the response.
HTTP/1.1 204 No Content