Edit

Update verifiableCredentialsAuthenticationMethodConfiguration

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 verifiableCredentialsAuthenticationMethodConfiguration object.

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) Policy.ReadWrite.AuthenticationMethod Not available.
Delegated (personal Microsoft account) Not supported. Not supported.
Application Policy.ReadWrite.AuthenticationMethod Not available.

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 /policies/authenticationMethodsPolicy/authenticationMethodConfigurations/verifiableCredentials

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
excludeTargets excludeTarget collection Groups of users that are excluded from the policy. Inherited from authenticationMethodConfiguration. Optional.
identityVerificationEventsConfiguration identityVerificationEventsConfiguration The tenant-level configuration that controls whether identity verification events and credential provenance information are collected and exposed for Verified ID verification. Optional.
state authenticationMethodState Inherited from authenticationMethodConfiguration. The possible values are: enabled, disabled. Optional.

Omitting identityVerificationEventsConfiguration from a PATCH request leaves its existing value unchanged. If no configuration is stored, the setting defaults to disabled. When the stored configuration is null or has isEnabled set to false, no new identity verification events or credential provenance information are collected and requests to access retained events return 403 Forbidden with the inner error code IdentityVerificationEventsExposureDisabled. Disabling the setting doesn't delete retained events. Retained events become readable again after the setting is re-enabled, subject to the retention policy.

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/beta/policies/authenticationMethodsPolicy/authenticationMethodConfigurations/verifiableCredentials
Content-Type: application/json

{
  "identityVerificationEventsConfiguration": {
    "isEnabled": true
  }
}

Response

The following example shows the response.

HTTP/1.1 204 No Content
  • Last updated on