Configure userFlowApiConnectorConfiguration
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.
Update the apiConnectorConfiguration property in a b2cIdentityUserFlow to enable or disable an API connector in a user flow. Each relationship of the apiConnectorConfiguration corresponds to a specific step in the user flow that can be configured to call an API connector. You configure an API connector for a particular step one at a time as shown below.
Permissions
One of the following permissions is required to call this API. To learn more, including how to choose permissions, see Permissions.
Permission type | Permissions (from least to most privileged) |
---|---|
Delegated (work or school account) | IdentityUserFlow.ReadWrite.All |
Delegated (personal Microsoft account) | Not supported |
Application | IdentityUserFlow.ReadWrite.All |
The work or school account needs to belong to one of the following roles:
- Global administrator
- External Identity User Flow administrator
HTTP request
PUT /identity/b2cUserFlows/{b2cUserFlowId}/apiConnectorConfiguration/{step}/$ref
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. |
Content-Type | application/json. Required. |
Request body
In the request body, provide a JSON representation of the id
of the identityApiConnector you want to use the particular step. To disable an API connector, the value can be {}.
Response
If successful, this method returns a 204 No Content
response code.
Examples
Example 1: Enable API connector for Post IDP Federation on sign up
Request
The following is an example of the request.
PUT https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_testuserflow/apiConnectorConfiguration/postFederationSignup/$ref
Content-Type: application/json
{
"@odata.id": "https://graph.microsoft.com/beta/identity/apiConnectors/{id}"
}
Response
The following is an example of the response.
HTTP/1.1 204 No Content
Example 2: Enable API connector for Post Attribute Collection on sign up
Request
The following is an example of the request.
PUT https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_testuserflow/apiConnectorConfiguration/postAttributeCollection/$ref
Content-Type: application/json
{
"@odata.id": "https://graph.microsoft.com/beta/identity/apiConnectors/{id}"
}
Response
The following is an example of the response.
HTTP/1.1 204 No Content
Example 3: Disable an API connector for Post Attribute Collection on sign up
Request
The following is an example of the request.
PUT https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_testuserflow/apiConnectorConfiguration/postAttributeCollection/$ref
Content-Type: application/json
{ }
Response
The following is an example of the response.
HTTP/1.1 204 No Content
Feedback
Submit and view feedback for