Get 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.
Get the apiConnectorConfiguration property in a b2cIdentityUserFlow to detail the API connectors enabled for the user flow.
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. |
In delegated scenarios with work or school accounts, the signed-in user must be assigned a supported Microsoft Entra role or a custom role with a supported role permission. External ID User Flow Administrator is the least privileged role supported for this operation.
HTTP request
GET identity/b2cUserFlows/{id}/apiConnectorConfiguration
Optional query parameters
This method supports the $expand
OData query parameter to help customize the response. For example, to retrieve the API connector for the postFederationSignup
and postAttributeCollection
steps, add $expand=postFederationSignup,postAttributeCollection
. For general information, see OData query parameters.
Request headers
Name | Description |
---|---|
Authorization | Bearer {token}. Required. Learn more about authentication and authorization. |
Request body
Don't supply a request body for this method.
Response
If successful, this method returns a 200 OK
response code and an apiConnectorConfiguration object.
Examples
Request
The following example shows a request.
GET https://graph.microsoft.com/beta/identity/b2cUserFlows/B2C_1_testuserflow/apiConnectorConfiguration?$expand=postFederationSignup,postAttributeCollection
Response
The following example shows the response.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#identity/b2cUserFlows('B2C_1_testuserflow')/apiConnectorConfiguration(postFederationSignup(),postAttributeCollection())",
"postFederationSignup": {
"id": "<guid1>",
"displayName": "Test API Connector 1",
"targetUrl": "https://someapi.com/api/endpoint",
"authenticationConfiguration": {
"@odata.type": "#microsoft.graph.basicAuthentication",
"username": "<USERNAME>",
"password": "******"
}
},
"postAttributeCollection": {
"id": "<guid2>",
"displayName": "Test API Connector 2",
"targetUrl": "https://someotherapi.com/api/endpoint",
"authenticationConfiguration": {
"@odata.type": "#microsoft.graph.basicAuthentication",
"username": "<USERNAME2>",
"password": "******"
}
}
}