Skip to content

Latest commit

 

History

History
116 lines (87 loc) · 3.82 KB

authenticationeventspolicy-post-onsignupstart.md

File metadata and controls

116 lines (87 loc) · 3.82 KB
Raw
title description author ms.localizationpriority ms.subservice doc_type
Create authenticationListener
Create a new authenticationListener object for the onSignUpStart event.
nanguil
medium
entra-sign-in
apiPageType

Create authenticationListener

Namespace: microsoft.graph

[!INCLUDE beta-disclaimer]

Create a new authenticationListener object for the onSignUpStart event.

Permissions

Choose the permission or permissions marked as least privileged for this API. Use a higher privileged permission or permissions only if your app requires it. For details about delegated and application permissions, see Permission types. To learn more about these permissions, see the permissions reference.

[!INCLUDE permissions-table]

HTTP request

POST /identity/events/onSignupStart

Request headers

Name Description
Authorization Bearer {token}. Required. Learn more about authentication and authorization.
Content-Type application/json. Required.

Request body

In the request body, supply a JSON representation of the authenticationListener object.

The following table lists the properties that are required when you create the invokeUserFlowListener authenticationListener.

Property Type Description
priority Int32 The priority of the listener. Determines the order of evaluation when an event has multiple listeners. The priority is evaluated from low to high.
sourceFilter authenticationSourceFilter Filter based on the source of the authentication that is used to determine whether the listener is evaluated. This is currently limited to evaluations based on application the user is authenticating to.
userFlow b2xIdentityUserFlow The b2xIdentityUserFlow object that will be invoked when this action is evaluated.

Response

If successful, this method returns a 201 Created response code and an authenticationListener object in the response body.

Examples

Request

The following example shows a request.

POST https://graph.microsoft.com/beta/identity/events/onSignupStart
Content-Type: application/json

{
    "@odata.type": "#microsoft.graph.invokeUserFlowListener",
    "priority": 101,
    "sourceFilter": {
        "includeApplications": [
            "1fc41a76-3050-4529-8095-9af8897cf63d"
        ]
    },
    "userFlow": {
        "id": "B2X_1_Partner"
    }
}

Response

The following example shows the response.

Note: The response object shown here might be shortened for readability.

HTTP/1.1 201 Created
Content-Type: application/json

{
    "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/events/onSignupStart/Microsoft.Graph.InvokeUserFlowListener/$entity",
    "@odata.type": "#microsoft.graph.invokeUserFlowListener",
    "id": "2be3336b-e3b4-44f3-9128-b6fd9ad39bb8",
    "priority": 101,
    "sourceFilter": {
        "includeApplications": [
            "1fc41a76-3050-4529-8095-9af8897cf63d"
        ]
    }
}