b2x_user_flows_api_connector_configuration
Creates, updates, deletes, gets or lists a b2x_user_flows_api_connector_configuration resource.
Overview
| Name | b2x_user_flows_api_connector_configuration |
| Type | Resource |
| Id | entra_id.identity.b2x_user_flows_api_connector_configuration |
Fields
The following fields are returned by SELECT queries:
- get
Entity result.
| Name | Datatype | Description |
|---|---|---|
postAttributeCollection | object | (opaque JSON object) (x-ms-discriminator-value: #microsoft.graph.identityApiConnector, title: entity) |
postFederationSignup | object | (opaque JSON object) (x-ms-discriminator-value: #microsoft.graph.identityApiConnector, title: entity) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get | select | b2x_identity_user_flow_id | Get the apiConnectorConfiguration property in a b2xIdentityUserFlow to detail the API connectors enabled for the user flow. | |
get_post_attribute_collection | exec | b2x_identity_user_flow_id | ||
update_post_attribute_collection | exec | b2x_identity_user_flow_id | ||
delete_post_attribute_collection | exec | b2x_identity_user_flow_id | If-Match | |
get_post_federation_signup | exec | b2x_identity_user_flow_id | ||
update_post_federation_signup | exec | b2x_identity_user_flow_id | ||
delete_post_federation_signup | exec | b2x_identity_user_flow_id | If-Match |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
b2x_identity_user_flow_id | string | The unique identifier of b2xIdentityUserFlow |
If-Match | string | ETag |
SELECT examples
- get
Get the apiConnectorConfiguration property in a b2xIdentityUserFlow to detail the API connectors enabled for the user flow.
SELECT
postAttributeCollection,
postFederationSignup
FROM entra_id.identity.b2x_user_flows_api_connector_configuration
WHERE b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' -- required
;
Lifecycle Methods
- get_post_attribute_collection
- update_post_attribute_collection
- delete_post_attribute_collection
- get_post_federation_signup
- update_post_federation_signup
- delete_post_federation_signup
Retrieved navigation property
EXEC entra_id.identity.b2x_user_flows_api_connector_configuration.get_post_attribute_collection
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required,
@$select='{{ $select }}',
@$expand='{{ $expand }}'
;
Success
EXEC entra_id.identity.b2x_user_flows_api_connector_configuration.update_post_attribute_collection
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required
@@json=
'{
"id": "{{ id }}",
"authenticationConfiguration": "{{ authenticationConfiguration }}",
"displayName": "{{ displayName }}",
"targetUrl": "{{ targetUrl }}"
}'
;
Success
EXEC entra_id.identity.b2x_user_flows_api_connector_configuration.delete_post_attribute_collection
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required,
@If-Match='{{ If-Match }}'
;
Retrieved navigation property
EXEC entra_id.identity.b2x_user_flows_api_connector_configuration.get_post_federation_signup
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required,
@$select='{{ $select }}',
@$expand='{{ $expand }}'
;
Success
EXEC entra_id.identity.b2x_user_flows_api_connector_configuration.update_post_federation_signup
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required
@@json=
'{
"id": "{{ id }}",
"authenticationConfiguration": "{{ authenticationConfiguration }}",
"displayName": "{{ displayName }}",
"targetUrl": "{{ targetUrl }}"
}'
;
Success
EXEC entra_id.identity.b2x_user_flows_api_connector_configuration.delete_post_federation_signup
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required,
@If-Match='{{ If-Match }}'
;