authentication_events_flows

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

Overview

Name	authentication_events_flows
Type	Resource
Id	entra_id.identity.authentication_events_flows

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.
conditions		The conditions representing the context of the authentication request that's used to decide whether the events policy is invoked. Supports $filter (eq). See support for filtering on user flows for syntax information.
description	string	The description of the events policy.
displayName	string	Required. The display name for the events policy.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
conditions		The conditions representing the context of the authentication request that's used to decide whether the events policy is invoked. Supports $filter (eq). See support for filtering on user flows for syntax information.
description	string	The description of the events policy.
displayName	string	Required. The display name for the events policy.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	authentication_events_flow_id		Retrieve the properties and relationships of a specific authenticationEventsFlow object by ID. The @odata.type property in the response object indicates the type of the object, which can be one of the following derived subtypes: - externalUsersSelfServiceSignupEventsFlow
list	select			Get a collection of authentication events policies that are derived from authenticationEventsFlow. The following derived subtypes are supported: - externalUsersSelfServiceSignupEventsFlow
insert	insert			Create a new authenticationEventsFlow object that is of the type specified in the request body. The following derived subtypes are supported: - externalUsersSelfServiceSignupEventsFlow object type.
update	update	authentication_events_flow_id		Update the properties of an authenticationEventsFlow object by ID. You must specify the @odata.type property and the value of the authenticationEventsFlow object type to update. The following derived subtypes are supported: - externalUsersSelfServiceSignupEventsFlow
delete	delete	authentication_events_flow_id	If-Match	Delete a specific authenticationEventsFlow resource by ID. This operation also removes or unlinks all applications from the flow, which disables the customized authentication experience defined for the application. The following derived subtypes are supported: - externalUsersSelfServiceSignupEventsFlow

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_events_flow_id	string	The unique identifier of authenticationEventsFlow
If-Match	string	ETag

SELECT examples

get

Retrieve the properties and relationships of a specific authenticationEventsFlow object by ID. The @odata.type property in the response object indicates the type of the object, which can be one of the following derived subtypes:
- externalUsersSelfServiceSignupEventsFlow

SELECT
id,
conditions,
description,
displayName
FROM entra_id.identity.authentication_events_flows
WHERE authentication_events_flow_id = '{{ authentication_events_flow_id }}' -- required
;

list

Get a collection of authentication events policies that are derived from authenticationEventsFlow. The following derived subtypes are supported:
- externalUsersSelfServiceSignupEventsFlow

SELECT
id,
conditions,
description,
displayName
FROM entra_id.identity.authentication_events_flows
;

INSERT examples

insert

Create a new authenticationEventsFlow object that is of the type specified in the request body. The following derived subtypes are supported:
- externalUsersSelfServiceSignupEventsFlow object type.

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

Manifest

# Description fields are for documentation purposes
- name: authentication_events_flows
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: conditions
    value: "{{ conditions }}"
    description: |
      The conditions representing the context of the authentication request that's used to decide whether the events policy is invoked.  Supports $filter (eq). See support for filtering on user flows for syntax information.
  - name: description
    value: "{{ description }}"
    description: |
      The description of the events policy.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Required. The display name for the events policy.

UPDATE examples

update

Update the properties of an authenticationEventsFlow object by ID. You must specify the @odata.type property and the value of the authenticationEventsFlow object type to update. The following derived subtypes are supported:
- externalUsersSelfServiceSignupEventsFlow

UPDATE entra_id.identity.authentication_events_flows
SET 
id = '{{ id }}',
conditions = '{{ conditions }}',
description = '{{ description }}',
displayName = '{{ displayName }}'
WHERE 
authentication_events_flow_id = '{{ authentication_events_flow_id }}' --required
RETURNING
id,
conditions,
description,
displayName;

DELETE examples

delete

Delete a specific authenticationEventsFlow resource by ID. This operation also removes or unlinks all applications from the flow, which disables the customized authentication experience defined for the application. The following derived subtypes are supported:
- externalUsersSelfServiceSignupEventsFlow

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