Edit

authenticationEventsFlow resource type

  • Article

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.

Entity that represents a multi-event policy, that is, a user flow, and holds the handler configuration for multiple events. Each property of name eventType is optional and corresponds to the handler configuration on the event listener. This is a management level for the atomic authenticationEventListener that allows for managing of multiple listeners under the same priority and condition set. This provides a better managed view of checking which event listeners will be executed under a certain circumstance.

If no handler is set for an event, then this policy won't effect that event in any authentication, and no listener is created for that event.

Additionally, this entity works as an orchestration step for the various event listeners it manages. For each event listener managed by the entity, it creates, modify, or delete the event listener accordingly. This means on creation time, it creates multiple event listeners and handles any rollback scenarios for any failing requests.

This is an abstract type from which the externalUsersSelfServiceSignUpEventsFlow object type is derived.

Inherits from entity.

Methods

Method Return type Description
List authenticationEventsFlow collection Retrieve a list of the authenticationEventsFlow objects and their properties. Only objects of the externalUserSelfServiceSignupEventsFlow subtype are available.
Create authenticationEventsFlow Create a new authenticationEventsFlow object. Only objects of the externalUserSelfServiceSignupEventsFlow subtype are supported.
Get authenticationEventsFlow Read the properties and relationships of an authenticationEventsFlow object. Only objects of the externalUserSelfServiceSignupEventsFlow subtype are available.
Update None Update the properties of an authenticationEventsFlow object. Only objects of the externalUserSelfServiceSignupEventsFlow subtype are available.
Delete None Delete an authenticationEventsFlow object. Only objects of the externalUserSelfServiceSignupEventsFlow subtype are supported.
List linked applications authenticationConditionApplication collection List listeners associated with an external identities self-service sign-up user flow.
Add linked application None List listeners associated with an external identities self-service sign-up user flow.
Remove linked application None List listeners associated with an external identities self-service sign-up user flow.

Properties

Property Type Description
id String The unique identifier for the entity. Read-only. Inherited from entity. Auto-generated.
displayName String Required. The display name for the events policy.
description String The description of the events policy.
conditions authenticationConditions The conditions representing the context of the authentication request that will be used to decide whether the events policy will be invoked.
priority Int32 The priority to use for each individual event of the events policy. If multiple competing listeners for an event have the same priority, one is chosen and an error is silently logged. Defaults to 500.

Relationships

None.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.authenticationEventsFlow",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "priority": "Integer"
}