Update customAuthenticationExtension

Namespace: microsoft.graph


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


One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.

Permission type Permissions (from least to most privileged)
Delegated (work or school account) CustomAuthenticationExtension.ReadWrite.All, Policy.ReadWrite.AuthenticationFlows, Application.ReadWrite.All
Delegated (personal Microsoft account) Not supported.
Application CustomAuthenticationExtension.ReadWrite.All, Policy.ReadWrite.AuthenticationFlows, Application.ReadWrite.All

HTTP request

PATCH /identity/customAuthenticationExtensions/{customAuthenticationExtensionId}

Request headers

Name Description
Authorization Bearer {token}. Required.
Content-Type application/json. Required.

Request body

In the request body, supply only the values for properties that should be updated. Existing properties that are not included in the request body will maintain their previous values or be recalculated based on changes to other property values.

The following table specifies the properties that can be updated.

You must specify the @odata.type property when updating a customAuthenticationExtension object. For example, to update an onTokenIssuanceStartCustomExtension object type, set the @odata.type property to #microsoft.graph.onTokenIssuanceStartCustomExtension.

Property Type Description
authenticationConfiguration customExtensionAuthenticationConfiguration The authentication configuration for this custom extension. Inherited from customCalloutExtension. Optional.
description String Description for the custom extension. Inherited from customCalloutExtension. Optional.
displayName String Display name for the custom extension. Inherited from customCalloutExtension. Optional.
endpointConfiguration customExtensionEndpointConfiguration Configuration for the API endpoint that the custom extension will call. Inherited from customCalloutExtension. Optional.


If successful, this method returns a 204 No Content response code.



The following is an example of a request.

PATCH hhttps://graph.microsoft.com/beta/identity/customAuthenticationExtensions/6fc5012e-7665-43d6-9708-4370863f4e6e
Content-Type: application/json
Content-length: 468

    "@odata.type": "#microsoft.graph.onTokenIssuanceStartCustomExtension",
    "displayName": "onTokenIssuanceStartCustomExtension",
    "description": "Fetch additional claims from custom user store",
    "endpointConfiguration": {
        "@odata.type": "#microsoft.graph.httpRequestEndpoint",
        "targetUrl": "https://authenticationeventsAPI.contoso.com"
    "authenticationConfiguration": {
        "@odata.type": "#microsoft.graph.azureAdTokenAuthentication",
        "resourceId": "api://authenticationeventsAPI.contoso.com/a13d0fc1-04ab-4ede-b215-63de0174cbb4"
    "claimsForTokenConfiguration": [
            "claimIdInApiResponse": "DateOfBirth"
            "claimIdInApiResponse": "CustomRoles"


The following is an example of the response

HTTP/1.1 204 No Content