externalUsersSelfServiceSignUpEventsFlow resource type

Article
08/07/2024

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 self-service user flow for external identities within a Microsoft Entra External ID in workforce or external tenants. A user flow is implemented as a multi-event policy executing the specific events at specific points of user interaction.

Inherits from authenticationEventsFlow.

Methods

None.

For the list of API operations for managing this resource type, see the authenticationEventsFlow resource type.

Properties

Property	Type	Description
id	String	The unique identifier for the entity. Read-only. Inherited from entity.
displayName	String	Required. The display name for the events policy. Must be unique. Inherited from authenticationEventsFlow.
description	String	Optional. The description of the events policy. Inherited from authenticationEventsFlow.
conditions	authenticationConditions	Optional. The conditions representing the context of the authentication request which is used to decide whether the events policy is invoked. Inherited from authenticationEventsFlow.
priority	Int32	Optional. 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. Default is 500. Inherited from authenticationEventsFlow.
onInteractiveAuthFlowStart	onInteractiveAuthFlowStartHandler	Required. The configuration for what to invoke when an authentication flow is ready to be initiated.
onAttributeCollection	onAttributeCollectionHandler	The configuration for what to invoke when attributes are ready to be collected from the user.
onAttributeCollectionStart	onAttributeCollectionStartHandler	The configuration for what to invoke when attribution collection has started.
onAttributeCollectionSubmit	onAttributeCollectionSubmitHandler	The configuration for what to invoke when attributes have been submitted at the end of attribution collection.
onAuthenticationMethodLoadStart	onAuthenticationMethodLoadStartHandler	Required. The configuration for what to invoke when authentication methods are ready to be presented to the user. Must have at least one identity provider linked. Supports `$filter` (`eq`). See support for filtering on user flows for syntax information.
onUserCreateStart	onUserCreateStartHandler	The configuration for what to invoke during user creation.

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.externalUsersSelfServiceSignUpEventsFlow",
  "id": "String (identifier)",
  "displayName": "String",
  "description": "String",
  "conditions": {
    "@odata.type": "microsoft.graph.authenticationConditions"
  },
  "priority": "Integer",
  "onInteractiveAuthFlowStart": {
    "@odata.type": "microsoft.graph.onInteractiveAuthFlowStartHandler"
  },
  "onAuthenticationMethodLoadStart": {
    "@odata.type": "microsoft.graph.onAuthenticationMethodLoadStartHandler"
  },
  "onAttributeCollection": {
    "@odata.type": "microsoft.graph.onAttributeCollectionHandler"
  },
  "onAttributeCollectionStart": {
    "@odata.type": "microsoft.graph.onAttributeCollectionStartHandler"
  },
  "onAttributeCollectionSubmit": {
    "@odata.type": "microsoft.graph.onAttributeCollectionSubmitHandler"
  },
  "onUserCreateStart": {
    "@odata.type": "microsoft.graph.onUserCreateStartHandler"
  }
}

Share via