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.
Create a new userFlow object.
This API is available in the following national cloud deployments.
| Global service |
US Government L4 |
US Government L5 (DOD) |
China operated by 21Vianet |
| ✅ |
✅ |
✅ |
✅ |
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.
| Permission type |
Least privileged permissions |
Higher privileged permissions |
| Delegated (work or school account) |
IdentityUserFlow.ReadWrite.All |
Not available. |
| Delegated (personal Microsoft account) |
Not supported. |
Not supported. |
| Application |
IdentityUserFlow.ReadWrite.All |
Not available. |
HTTP request
POST /identity/userFlows
Request body
In the request body, supply a JSON representation of userFlow object.
Response
If successful, this method returns a 201 Created response code and a new userFlow object in the response body.
Examples
Request
The following example shows a request.
POST https://graph.microsoft.com/beta/identity/userFlows
Content-type: application/json
{
"id": "Pol1",
"userFlowType": "signUpOrSignIn",
"userFlowTypeVersion": 1
}
// Code snippets are only available for the latest version. Current version is 5.x
// Dependencies
using Microsoft.Graph.Beta.Models;
var requestBody = new IdentityUserFlow
{
Id = "Pol1",
UserFlowType = UserFlowType.SignUpOrSignIn,
UserFlowTypeVersion = 1f,
};
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Identity.UserFlows.PostAsync(requestBody);
mgc-beta identity user-flows create --body '{\
"id": "Pol1",\
"userFlowType": "signUpOrSignIn",\
"userFlowTypeVersion": 1\
}\
'
// Code snippets are only available for the latest major version. Current major version is $v0.*
// Dependencies
import (
"context"
msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
//other-imports
)
requestBody := graphmodels.NewIdentityUserFlow()
id := "Pol1"
requestBody.SetId(&id)
userFlowType := graphmodels.SIGNUPORSIGNIN_USERFLOWTYPE
requestBody.SetUserFlowType(&userFlowType)
userFlowTypeVersion := float32(1)
requestBody.SetUserFlowTypeVersion(&userFlowTypeVersion)
// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
userFlows, err := graphClient.Identity().UserFlows().Post(context.Background(), requestBody, nil)
// Code snippets are only available for the latest version. Current version is 6.x
GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);
IdentityUserFlow identityUserFlow = new IdentityUserFlow();
identityUserFlow.setId("Pol1");
identityUserFlow.setUserFlowType(UserFlowType.SignUpOrSignIn);
identityUserFlow.setUserFlowTypeVersion(1f);
IdentityUserFlow result = graphClient.identity().userFlows().post(identityUserFlow);
const options = {
authProvider,
};
const client = Client.init(options);
const identityUserFlow = {
id: 'Pol1',
userFlowType: 'signUpOrSignIn',
userFlowTypeVersion: 1
};
await client.api('/identity/userFlows')
.version('beta')
.post(identityUserFlow);
<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\IdentityUserFlow;
use Microsoft\Graph\Beta\Generated\Models\UserFlowType;
$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);
$requestBody = new IdentityUserFlow();
$requestBody->setId('Pol1');
$requestBody->setUserFlowType(new UserFlowType('signUpOrSignIn'));
$requestBody->setUserFlowTypeVersion(1);
$result = $graphServiceClient->identity()->userFlows()->post($requestBody)->wait();
# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.identity_user_flow import IdentityUserFlow
from msgraph_beta.generated.models.user_flow_type import UserFlowType
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = IdentityUserFlow(
id = "Pol1",
user_flow_type = UserFlowType.SignUpOrSignIn,
user_flow_type_version = 1,
)
result = await graph_client.identity.user_flows.post(request_body)
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
{
"id": "B2C_1_Pol1",
"userFlowType": "signUpOrSignIn",
"userFlowTypeVersion": 1
}