Get userFlowApiConnectorConfiguration
Namespace: microsoft.graph
Get the apiConnectorConfiguration property in a b2xIdentityUserFlow to detail the API connectors enabled for the user flow.
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
GET identity/b2xUserFlows/{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. |
Request body
Do not 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 is an example of the request.
GET https://graph.microsoft.com/v1.0/identity/b2xUserFlows/B2X_1_testuserflow/apiConnectorConfiguration?$expand=postFederationSignup,postAttributeCollection
Response
The following is an example of the response.
HTTP/1.1 200 OK
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#identity/b2xUserFlows('B2X_1_testuserflow')/apiConnectorConfiguration(postFederationSignup(),postAttributeCollection())",
"postFederationSignup": {
"id": "74d13179-2c02-4ae7-bff3-82842d4e2f1f",
"displayName": "Test API Connector 1",
"targetUrl": "https://someapi.com/api/endpoint",
"authenticationConfiguration": {
"@odata.type": "#microsoft.graph.basicAuthentication",
"username": "apiAccount",
"password": "******"
}
},
"postAttributeCollection": {
"id": "900bc92c-bcbf-4093-af8e-450a4a77635f",
"displayName": "Test API Connector 2",
"targetUrl": "https://someotherapi.com/api/endpoint",
"authenticationConfiguration": {
"@odata.type": "#microsoft.graph.basicAuthentication",
"username": "apiAccount",
"password": "******"
}
}
}
Feedback
Submit and view feedback for