Edit

onVerifiedIdClaimValidationListener resource type

Namespace: microsoft.graph

Represents an event listener for the Verified ID claim validation step in the authentication flow. This listener allows organizations to validate claims from Verified ID credential presentations for specific applications by invoking custom logic that checks the claims against expected values.

When a user presents a Verified ID credential during sign-in, this listener evaluates the configured conditions to determine whether to invoke the handler for the authentication event.

Inherits from authenticationEventListener.

Methods

None.

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

Properties

Property Type Description
authenticationEventsFlowId String Identifier of the authentication events flow. Inherited from authenticationEventListener.
conditions authenticationConditions Conditions that determine when this listener is active, such as which applications trigger the event. Inherited from authenticationEventListener.
displayName String Display name for the authentication event listener. Inherited from authenticationEventListener.
handler onVerifiedIdClaimValidationHandler Configuration for the handler to invoke when this listener is triggered. For Verified ID claim validation scenarios, this is typically an onVerifiedIdClaimValidationCustomExtensionHandler.
id String Unique identifier for the authentication event listener. Inherited from authenticationEventListener.
priority Int32 Priority of this listener relative to other listeners for the same event. Lower values indicate higher priority. Inherited from authenticationEventListener.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.onVerifiedIdClaimValidationListener",
  "id": "String (identifier)",
  "displayName": "String",
  "priority": "Integer",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "authenticationEventsFlowId": "String",
  "handler": {
    "@odata.type": "microsoft.graph.onVerifiedIdClaimValidationHandler"
  }
}