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

Inherits from authenticationEventsFlow.

Methods

Method	Return type	Description
List	authenticationEventsFlow collection	Retrieve a list of the authenticationEventsFlow objects and their properties.
Create	externalUsersSelfServiceSignUpEventsFlow	Create an external identities self-service sign-up user flow.
Get	externalUsersSelfServiceSignUpEventsFlow	Retrieve the properties and relationships of an external identities self-service sign-up user flow.
Update	None	Update the properties of an external identities self-service sign-up user flow
Delete	None	Delete an external identities self-service sign-up user flow.
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.
List identity providers	identityProvider collection	List identity provider selections associated with an external identities self-service sign-up user flow.
Add identity providers	None	Add an identity provider to an external identities self-service sign-up user flow.
Remove identity providers	None	Remove an identity provider from an external identities self-service sign-up user flow.
List attributes	identityUserFlowAttribute collection	Retrieve all user attributes associated with an external identities self-service sign-up user flow.
Add an attribute	None	Retrieve all user attributes associated with an external identities self-service sign-up user flow.
Delete an attribute	None	Remove a user flow attribute from 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.
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.
onUserCreateStart	onUserCreateStartHandler	The configuration for what to invoke during user creation.

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"
  }
}