Edit

onVerifiedIdClaimValidationCustomExtension resource type

Namespace: microsoft.graph

Represents a custom authentication extension for the onVerifiedIdClaimValidation event. This extension allows organizations to validate claims from Verified ID credential presentations during authentication flows by calling an external API endpoint.

When a user presents a Verified ID credential during authentication, this extension calls a customer-provided API endpoint with the Verified ID claims context, including the user's Entra account information and the claims dictionary from the credential presentation. The external API evaluates the claims and returns a validation result that indicates success or failure.

Inherits from customAuthenticationExtension.

Methods

None.

For the list of API operations for managing this resource type, see the customAuthenticationExtension resource type.

Properties

Property Type Description
authenticationConfiguration customExtensionAuthenticationConfiguration Configuration for securing the API call to the external system. Inherited from customCalloutExtension.
behaviorOnError customExtensionBehaviorOnError Error handling behavior when the external API fails or is unreachable. Inherited from customAuthenticationExtension.
clientConfiguration customExtensionClientConfiguration HTTP client configuration including timeout and retry settings. Inherited from customCalloutExtension.
description String Description of the custom authentication extension. Inherited from customCalloutExtension.
displayName String Display name for the custom authentication extension. Inherited from customCalloutExtension.
endpointConfiguration customExtensionEndpointConfiguration HTTP endpoint configuration for the external API. Inherited from customCalloutExtension.
id String Unique identifier for the custom authentication extension. Inherited from entity.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationCustomExtension",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "endpointConfiguration": {
    "@odata.type": "microsoft.graph.httpRequestEndpoint"
  },
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.azureAdTokenAuthentication"
  },
  "clientConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionClientConfiguration"
  },
  "behaviorOnError": {
    "@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
  }
}