b2x_user_flows

Creates, updates, deletes, gets or lists a b2x_user_flows resource.

Overview

Name	b2x_user_flows
Type	Resource
Id	entra_id.identity.b2x_user_flows

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
apiConnectorConfiguration		Configuration for enabling an API connector for use as part of the self-service sign-up user flow. You can only obtain the value of this object using Get userFlowApiConnectorConfiguration.
identityProviders	array	The identity providers included in the user flow.
languages	array	The languages supported for customization within the user flow. Language customization is enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up user flows.
userAttributeAssignments	array	The user attribute assignments included in the user flow.
userFlowIdentityProviders	array
userFlowType	string	(signUp, signIn, signUpOrSignIn, passwordReset, profileUpdate, resourceOwner, unknownFutureValue) (title: userFlowType)
userFlowTypeVersion

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
apiConnectorConfiguration		Configuration for enabling an API connector for use as part of the self-service sign-up user flow. You can only obtain the value of this object using Get userFlowApiConnectorConfiguration.
identityProviders	array	The identity providers included in the user flow.
languages	array	The languages supported for customization within the user flow. Language customization is enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up user flows.
userAttributeAssignments	array	The user attribute assignments included in the user flow.
userFlowIdentityProviders	array
userFlowType	string	(signUp, signIn, signUpOrSignIn, passwordReset, profileUpdate, resourceOwner, unknownFutureValue) (title: userFlowType)
userFlowTypeVersion

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	b2x_identity_user_flow_id		Retrieve the properties and relationships of a b2xIdentityUserFlow object.
list	select			Retrieve a list of b2xIdentityUserFlow objects.
insert	insert			Create a new b2xIdentityUserFlow object.
update	update	b2x_identity_user_flow_id
delete	delete	b2x_identity_user_flow_id	If-Match	Delete a b2xIdentityUserFlow object.
api_connector_configuration_post_attribute_collection_add_ref	exec	b2x_identity_user_flow_id
api_connector_configuration_post_attribute_collection_remove_ref	exec	b2x_identity_user_flow_id	If-Match
api_connector_configuration_post_attribute_collection_upload_client_certificate	exec	b2x_identity_user_flow_id		Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.
api_connector_configuration_post_federation_signup_add_ref	exec	b2x_identity_user_flow_id
api_connector_configuration_post_federation_signup_remove_ref	exec	b2x_identity_user_flow_id	If-Match
api_connector_configuration_post_federation_signup_upload_client_certificate	exec	b2x_identity_user_flow_id		Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.

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

Retrieve the properties and relationships of a b2xIdentityUserFlow object.

SELECT
id,
apiConnectorConfiguration,
identityProviders,
languages,
userAttributeAssignments,
userFlowIdentityProviders,
userFlowType,
userFlowTypeVersion
FROM entra_id.identity.b2x_user_flows
WHERE b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' -- required
;

list

Retrieve a list of b2xIdentityUserFlow objects.

SELECT
id,
apiConnectorConfiguration,
identityProviders,
languages,
userAttributeAssignments,
userFlowIdentityProviders,
userFlowType,
userFlowTypeVersion
FROM entra_id.identity.b2x_user_flows
;

INSERT examples

insert

Create a new b2xIdentityUserFlow object.

INSERT INTO entra_id.identity.b2x_user_flows (
id,
userFlowType,
userFlowTypeVersion,
apiConnectorConfiguration,
identityProviders,
languages,
userAttributeAssignments,
userFlowIdentityProviders
)
SELECT 
'{{ id }}',
'{{ userFlowType }}',
'{{ userFlowTypeVersion }}',
'{{ apiConnectorConfiguration }}',
'{{ identityProviders }}',
'{{ languages }}',
'{{ userAttributeAssignments }}',
'{{ userFlowIdentityProviders }}'
RETURNING
id,
apiConnectorConfiguration,
identityProviders,
languages,
userAttributeAssignments,
userFlowIdentityProviders,
userFlowType,
userFlowTypeVersion
;

Manifest

# Description fields are for documentation purposes
- name: b2x_user_flows
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: userFlowType
    value: "{{ userFlowType }}"
    valid_values: ['signUp', 'signIn', 'signUpOrSignIn', 'passwordReset', 'profileUpdate', 'resourceOwner', 'unknownFutureValue']
  - name: userFlowTypeVersion
    value: "{{ userFlowTypeVersion }}"
  - name: apiConnectorConfiguration
    value: "{{ apiConnectorConfiguration }}"
    description: |
      Configuration for enabling an API connector for use as part of the self-service sign-up user flow. You can only obtain the value of this object using Get userFlowApiConnectorConfiguration.
  - name: identityProviders
    description: |
      The identity providers included in the user flow.
    value:
      - id: "{{ id }}"
        clientId: "{{ clientId }}"
        clientSecret: "{{ clientSecret }}"
        name: "{{ name }}"
        type: "{{ type }}"
  - name: languages
    description: |
      The languages supported for customization within the user flow. Language customization is enabled by default in self-service sign-up user flow. You can't create custom languages in self-service sign-up user flows.
    value:
      - id: "{{ id }}"
        displayName: "{{ displayName }}"
        isEnabled: {{ isEnabled }}
        defaultPages: "{{ defaultPages }}"
        overridesPages: "{{ overridesPages }}"
  - name: userAttributeAssignments
    description: |
      The user attribute assignments included in the user flow.
    value:
      - id: "{{ id }}"
        displayName: "{{ displayName }}"
        isOptional: {{ isOptional }}
        requiresVerification: {{ requiresVerification }}
        userAttributeValues: "{{ userAttributeValues }}"
        userInputType: "{{ userInputType }}"
        userAttribute: "{{ userAttribute }}"
  - name: userFlowIdentityProviders
    value:
      - id: "{{ id }}"
        displayName: "{{ displayName }}"

UPDATE examples

update

No description available.

UPDATE entra_id.identity.b2x_user_flows
SET 
id = '{{ id }}',
userFlowType = '{{ userFlowType }}',
userFlowTypeVersion = '{{ userFlowTypeVersion }}',
apiConnectorConfiguration = '{{ apiConnectorConfiguration }}',
identityProviders = '{{ identityProviders }}',
languages = '{{ languages }}',
userAttributeAssignments = '{{ userAttributeAssignments }}',
userFlowIdentityProviders = '{{ userFlowIdentityProviders }}'
WHERE 
b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' --required
RETURNING
id,
apiConnectorConfiguration,
identityProviders,
languages,
userAttributeAssignments,
userFlowIdentityProviders,
userFlowType,
userFlowTypeVersion;

DELETE examples

delete

Delete a b2xIdentityUserFlow object.

DELETE FROM entra_id.identity.b2x_user_flows
WHERE b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods

api_connector_configuration_post_attribute_collection_add_ref

Success

EXEC entra_id.identity.b2x_user_flows.api_connector_configuration_post_attribute_collection_add_ref 
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required 
@@json=
'{
}'
;

api_connector_configuration_post_attribute_collection_remove_ref

Success

EXEC entra_id.identity.b2x_user_flows.api_connector_configuration_post_attribute_collection_remove_ref 
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required, 
@If-Match='{{ If-Match }}'
;

api_connector_configuration_post_attribute_collection_upload_client_certificate

Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.

EXEC entra_id.identity.b2x_user_flows.api_connector_configuration_post_attribute_collection_upload_client_certificate 
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required 
@@json=
'{
"pkcs12Value": "{{ pkcs12Value }}", 
"password": "{{ password }}"
}'
;

api_connector_configuration_post_federation_signup_add_ref

Success

EXEC entra_id.identity.b2x_user_flows.api_connector_configuration_post_federation_signup_add_ref 
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required 
@@json=
'{
}'
;

api_connector_configuration_post_federation_signup_remove_ref

Success

EXEC entra_id.identity.b2x_user_flows.api_connector_configuration_post_federation_signup_remove_ref 
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required, 
@If-Match='{{ If-Match }}'
;

api_connector_configuration_post_federation_signup_upload_client_certificate

Upload a PKCS 12 format key (.pfx) to an API connector's authentication configuration. The input is a base-64 encoded value of the PKCS 12 certificate contents. This method returns an apiConnector.

EXEC entra_id.identity.b2x_user_flows.api_connector_configuration_post_federation_signup_upload_client_certificate 
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required 
@@json=
'{
"pkcs12Value": "{{ pkcs12Value }}", 
"password": "{{ password }}"
}'
;