authenticationEventsFlow resource type
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.
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 resource allows for managing multiple authenticationEventListener objects under the same priority and condition set. This resource provides a better-managed view of checking which event listeners are executed under a certain circumstance.
If no handler is set for an event, then this policy doesn'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 that it manages, it creates, modifies, or deletes the event listener accordingly. This means on creation time, it creates multiple event listeners and manages any rollback scenarios for any failing requests.
This resource 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. |
| Identity providers in a user flow | ||
| List | identityProviderBase collection | Get the identity providers that are defined for an external identities self-service sign-up user flow that's represented by an externalUsersSelfServiceSignupEventsFlow object type. |
| Add | None | Add an identity provider to an external identities self-service sign-up user flow that's represented by an externalUsersSelfServiceSignupEventsFlow object type. The identity provider must first be configured in the tenant. |
| Remove | None | Remove an identity provider from an external identities self-service sign-up user flow that's represented by an externalUsersSelfServiceSignupEventsFlow object type. |
| User flow attributes | ||
| List | identityUserFlowAttributes collection | Retrieve all built-in and custom user flow attributes. |
| Create | identityUserFlowAttribute | Create a new custom user flow attribute. |
| Get | identityUserFlowAttribute | Retrieve properties of a user flow attribute. |
| Update | None | Update a custom user flow attribute. |
| Delete | None | Delete a custom user flow attribute. |
| List attributes in a user flow | None | Get the collection of identityUserFlowAttribute objects associated with an external identities self-service sign-up user flow that's represented by an externalUsersSelfServiceSignupEventsFlow object. |
| Add attribute to a user flow | None | Add an identityUserFlowAttribute object associated with an external identities self-service sign-up user flow that's represented by an externalUsersSelfServiceSignupEventsFlow object. |
| Remove attribute from a user flow | None | Remove an identityUserFlowAttribute object associated with an external identities self-service sign-up user flow that's represented by an externalUsersSelfServiceSignupEventsFlow object. |
Properties
| Property | Type | Description |
|---|---|---|
| id | String | The unique identifier for the entity. Read-only. Inherited from entity. Autogenerated. |
| 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's used to decide whether the events policy is invoked. Supports $filter (eq). See support for filtering on user flows for syntax information. |
| 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. |
Support for filtering on user flows
- Filter on identityProviders:
?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAuthenticationMethodLoadStart/microsoft.graph.onAuthenticationMethodLoadStartExternalUsersSelfServiceSignUp/identityProviders/any(idp:idp/id eq '{identityProvider-id}') - Filter on attributes:
?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/onAttributeCollection/microsoft.graph.onAttributeCollectionExternalUsersSelfServiceSignUp/attributes/any(attribute:attribute/id eq '{attribute-ID}') - Filter on linked applications:
?$filter=microsoft.graph.externalUsersSelfServiceSignUpEventsFlow/conditions/applications/includeApplications/any(appId:appId/appId eq '{appId}')
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"
}