Modifica

onPasswordUpdateCustomExtension resource type

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.

Represents a custom authentication extension for the onPasswordUpdate event. This extension allows organizations to notify an external system after a user completes a self-service password reset (SSPR), enabling the external system to synchronize the updated credential.

When a user completes SSPR, this extension calls a customer-provided API endpoint with an encrypted reference to the new password. The external system decrypts the reference and propagates the credential without changing the user-visible SSPR result.

The onPasswordUpdateCustomExtensionHandler references this resource through its customExtension relationship.

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.onPasswordUpdateCustomExtension",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionAuthenticationConfiguration"
  },
  "endpointConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionEndpointConfiguration"
  },
  "clientConfiguration": {
    "@odata.type": "microsoft.graph.customExtensionClientConfiguration"
  },
  "behaviorOnError": {
    "@odata.type": "microsoft.graph.customExtensionBehaviorOnError"
  }
}