authentication_event_listeners

Creates, updates, deletes, gets or lists an authentication_event_listeners resource.

Overview

Name	authentication_event_listeners
Type	Resource
Id	entra_id.identity.authentication_event_listeners

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
authenticationEventsFlowId	string	The identifier of the authenticationEventsFlow object.
conditions		The conditions on which this authenticationEventListener should trigger.
displayName	string	The display name of the listener.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
authenticationEventsFlowId	string	The identifier of the authenticationEventsFlow object.
conditions		The conditions on which this authenticationEventListener should trigger.
displayName	string	The display name of the listener.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	authentication_event_listener_id		Read the properties and relationships of an authenticationEventListener object. The @odata.type property in the response object indicates the type of the authenticationEventListener object. The following derived types are currently supported.
list	select			Get a list of the authenticationEventListener objects and their properties. The following derived types are supported:
insert	insert			Create a new authenticationEventListener object. You can create one of the following subtypes that are derived from authenticationEventListener.
update	update	authentication_event_listener_id		Update the properties of an authenticationEventListener object. You must specify the @odata.type property and the value of the authenticationEventListener object type to update. The following derived types are currently supported.
delete	delete	authentication_event_listener_id	If-Match	Delete an authenticationEventListener object. The following derived types are currently supported.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
authentication_event_listener_id	string	The unique identifier of authenticationEventListener
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of an authenticationEventListener object. The @odata.type property in the response object indicates the type of the authenticationEventListener object. The following derived types are currently supported.

SELECT
id,
authenticationEventsFlowId,
conditions,
displayName
FROM entra_id.identity.authentication_event_listeners
WHERE authentication_event_listener_id = '{{ authentication_event_listener_id }}' -- required
;

list

Get a list of the authenticationEventListener objects and their properties. The following derived types are supported:

SELECT
id,
authenticationEventsFlowId,
conditions,
displayName
FROM entra_id.identity.authentication_event_listeners
;

INSERT examples

insert

Create a new authenticationEventListener object. You can create one of the following subtypes that are derived from authenticationEventListener.

INSERT INTO entra_id.identity.authentication_event_listeners (
id,
authenticationEventsFlowId,
conditions,
displayName
)
SELECT 
'{{ id }}',
'{{ authenticationEventsFlowId }}',
'{{ conditions }}',
'{{ displayName }}'
RETURNING
id,
authenticationEventsFlowId,
conditions,
displayName
;

Manifest

# Description fields are for documentation purposes
- name: authentication_event_listeners
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: authenticationEventsFlowId
    value: "{{ authenticationEventsFlowId }}"
    description: |
      The identifier of the authenticationEventsFlow object.
  - name: conditions
    value: "{{ conditions }}"
    description: |
      The conditions on which this authenticationEventListener should trigger.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the listener.

UPDATE examples

update

Update the properties of an authenticationEventListener object. You must specify the @odata.type property and the value of the authenticationEventListener object type to update. The following derived types are currently supported.

UPDATE entra_id.identity.authentication_event_listeners
SET 
id = '{{ id }}',
authenticationEventsFlowId = '{{ authenticationEventsFlowId }}',
conditions = '{{ conditions }}',
displayName = '{{ displayName }}'
WHERE 
authentication_event_listener_id = '{{ authentication_event_listener_id }}' --required
RETURNING
id,
authenticationEventsFlowId,
conditions,
displayName;

DELETE examples

delete

Delete an authenticationEventListener object. The following derived types are currently supported.

DELETE FROM entra_id.identity.authentication_event_listeners
WHERE authentication_event_listener_id = '{{ authentication_event_listener_id }}' --required
AND If-Match = '{{ If-Match }}'
;