Update authenticationEventListener

Article
05/19/2023

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 an authenticationEventListener object. You must specify the @odata.type property and the value of the authenticationEventListener object type to update.

Permissions

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)	EventListener.ReadWrite.All
Delegated (personal Microsoft account)	Not supported.
Application	EventListener.ReadWrite.All

HTTP request

PATCH /identity/authenticationEventListeners/{authenticationEventListenerId}

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 and the value of the authenticationEventListener object type to update. For example, "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener".

Property	Type	Description
authenticationEventsFlowId	String	The identifier of the authentication events flow. Optional.
conditions	authenticationConditions	The conditions on which this authenticationEventListener should trigger. Optional.
handler	onAttributeCollectionHandler	The handler to invoke when conditions are met. Can be updated for the onAttributeCollectionListener listener type.
handler	onAuthenticationMethodLoadStartHandler	The handler to invoke when conditions are met. Can be updated for the onAuthenticationMethodLoadStartListener listener type.
handler	onInteractiveAuthFlowStartHandler	The handler to invoke when conditions are met. Can be updated for the onInteractiveAuthFlowStartListener listener type.
handler	onTokenIssuanceStartHandler	The handler to invoke when conditions are met. Can be updated for the onTokenIssuanceStartListener listener type.
handler	onUserCreateStartHandler	The handler to invoke when conditions are met. Can be updated for the onUserCreateStartListener listener type.
priority	Int32	The priority of this handler. Between 0 (lower priority) and 1000 (higher priority). Required.

Response

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

Examples

Request

The following is an example of a request to update an authentication event listener's trigger conditions or priority:

PATCH https://graph.microsoft.com/beta/identity/authenticationEventListeners/990d94e5-cc8f-4c4b-97b4-27e2678aac28
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.onTokenIssuanceStartListener",
    "conditions": {
        "applications": {
            "includeAllApplications": false
        }
    },
    "priority": 500
}


// Code snippets are only available for the latest version. Current version is 5.x

var graphClient = new GraphServiceClient(requestAdapter);

var requestBody = new AuthenticationEventListener
{
	OdataType = "#microsoft.graph.onTokenIssuanceStartListener",
	Conditions = new AuthenticationConditions
	{
		Applications = new AuthenticationConditionsApplications
		{
			IncludeAllApplications = false,
		},
	},
	Priority = 500,
};
var result = await graphClient.Identity.AuthenticationEventListeners["{authenticationEventListener-id}"].PatchAsync(requestBody);

Important

Microsoft Graph SDKs use the v1.0 version of the API by default, and do not support all the types, properties, and APIs available in the beta version. For details about accessing the beta API with the SDK, see Use the Microsoft Graph SDKs with the beta API.

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewAuthenticationEventListener()
conditions := graphmodels.NewAuthenticationConditions()
applications := graphmodels.NewAuthenticationConditionsApplications()
includeAllApplications := false
applications.SetIncludeAllApplications(&includeAllApplications) 
conditions.SetApplications(applications)
requestBody.SetConditions(conditions)
priority := int32(500)
requestBody.SetPriority(&priority) 

result, err := graphClient.Identity().AuthenticationEventListeners().ByAuthenticationEventListenerId("authenticationEventListener-id").Patch(context.Background(), requestBody, nil)

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


GraphServiceClient graphClient = GraphServiceClient.builder().authenticationProvider( authProvider ).buildClient();

OnTokenIssuanceStartListener authenticationEventListener = new OnTokenIssuanceStartListener();
AuthenticationConditions conditions = new AuthenticationConditions();
AuthenticationConditionsApplications applications = new AuthenticationConditionsApplications();
applications.includeAllApplications = false;
conditions.applications = applications;
authenticationEventListener.conditions = conditions;
authenticationEventListener.priority = 500;

graphClient.identity().authenticationEventListeners("990d94e5-cc8f-4c4b-97b4-27e2678aac28")
	.buildRequest()
	.patch(authenticationEventListener);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


const options = {
	authProvider,
};

const client = Client.init(options);

const authenticationEventListener = {
    '@odata.type': '#microsoft.graph.onTokenIssuanceStartListener',
    conditions: {
        applications: {
            includeAllApplications: false
        }
    },
    priority: 500
};

await client.api('/identity/authenticationEventListeners/990d94e5-cc8f-4c4b-97b4-27e2678aac28')
	.version('beta')
	.update(authenticationEventListener);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


<?php

// THIS SNIPPET IS A PREVIEW FOR THE KIOTA BASED SDK. NON-PRODUCTION USE ONLY
$graphServiceClient = new GraphServiceClient($requestAdapter);

$requestBody = new AuthenticationEventListener();
$requestBody->set@odatatype('#microsoft.graph.onTokenIssuanceStartListener');

$conditions = new AuthenticationConditions();
$conditionsApplications = new AuthenticationConditionsApplications();
$conditionsApplications->setIncludeAllApplications(false);


$conditions->setApplications($conditionsApplications);

$requestBody->setConditions($conditions);
$requestBody->setPriority(500);



$result = $graphServiceClient->identity()->authenticationEventListeners()->byAuthenticationEventListenerId('authenticationEventListener-id')->patch($requestBody);

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.


Import-Module Microsoft.Graph.Identity.SignIns

$params = @{
	"@odata.type" = "#microsoft.graph.onTokenIssuanceStartListener"
	conditions = @{
		applications = @{
			includeAllApplications = $false
		}
	}
	priority = 500
}

Update-MgIdentityAuthenticationEventListener -AuthenticationEventListenerId $authenticationEventListenerId -BodyParameter $params

Important

For details about how to add the SDK to your project and create an authProvider instance, see the SDK documentation.

Response

The following is an example of the response

HTTP/1.1 204 No Content

Update authenticationEventListener

Permissions

HTTP request

Request headers

Request body

Response

Examples

Request

Response

Feedback

Additional resources

Additional resources