b2x_user_flows_user_attribute_assignments

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

Overview

Name	b2x_user_flows_user_attribute_assignments
Type	Resource
Id	entra_id.identity.b2x_user_flows_user_attribute_assignments

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.
displayName	string	The display name of the identityUserFlowAttribute within a user flow.
isOptional	boolean	Determines whether the identityUserFlowAttribute is optional. true means the user doesn't have to provide a value. false means the user can't complete sign-up without providing a value.
requiresVerification	boolean	Determines whether the identityUserFlowAttribute requires verification, and is only used for verifying the user's phone number or email address.
userAttribute		The user attribute that you want to add to your user flow.
userAttributeValues	array	The input options for the user flow attribute. Only applicable when the userInputType is radioSingleSelect, dropdownSingleSelect, or checkboxMultiSelect.
userInputType	string	(textBox, dateTimeDropdown, radioSingleSelect, dropdownSingleSelect, emailBox, checkboxMultiSelect) (title: identityUserFlowAttributeInputType)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
displayName	string	The display name of the identityUserFlowAttribute within a user flow.
isOptional	boolean	Determines whether the identityUserFlowAttribute is optional. true means the user doesn't have to provide a value. false means the user can't complete sign-up without providing a value.
requiresVerification	boolean	Determines whether the identityUserFlowAttribute requires verification, and is only used for verifying the user's phone number or email address.
userAttribute		The user attribute that you want to add to your user flow.
userAttributeValues	array	The input options for the user flow attribute. Only applicable when the userInputType is radioSingleSelect, dropdownSingleSelect, or checkboxMultiSelect.
userInputType	string	(textBox, dateTimeDropdown, radioSingleSelect, dropdownSingleSelect, emailBox, checkboxMultiSelect) (title: identityUserFlowAttributeInputType)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	b2x_identity_user_flow_id, identity_user_flow_attribute_assignment_id		Read the properties and relationships of an identityUserFlowAttributeAssignment object.
list	select	b2x_identity_user_flow_id		Get the identityUserFlowAttributeAssignment resources from the userAttributeAssignments navigation property in a b2xIdentityUserFlow.
insert	insert	b2x_identity_user_flow_id		Create a new identityUserFlowAttributeAssignment object in a b2xIdentityUserFlow.
update	update	b2x_identity_user_flow_id, identity_user_flow_attribute_assignment_id		Update the properties of a identityUserFlowAttributeAssignment object.
delete	delete	b2x_identity_user_flow_id, identity_user_flow_attribute_assignment_id	If-Match	Delete an identityUserFlowAttributeAssignment object.
set_order	exec	b2x_identity_user_flow_id		Set the order of identityUserFlowAttributeAssignments being collected within a user flow.

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
identity_user_flow_attribute_assignment_id	string	The unique identifier of identityUserFlowAttributeAssignment
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of an identityUserFlowAttributeAssignment object.

SELECT
id,
displayName,
isOptional,
requiresVerification,
userAttribute,
userAttributeValues,
userInputType
FROM entra_id.identity.b2x_user_flows_user_attribute_assignments
WHERE b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' -- required
AND identity_user_flow_attribute_assignment_id = '{{ identity_user_flow_attribute_assignment_id }}' -- required
;

list

Get the identityUserFlowAttributeAssignment resources from the userAttributeAssignments navigation property in a b2xIdentityUserFlow.

SELECT
id,
displayName,
isOptional,
requiresVerification,
userAttribute,
userAttributeValues,
userInputType
FROM entra_id.identity.b2x_user_flows_user_attribute_assignments
WHERE b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' -- required
;

INSERT examples

insert

Create a new identityUserFlowAttributeAssignment object in a b2xIdentityUserFlow.

INSERT INTO entra_id.identity.b2x_user_flows_user_attribute_assignments (
id,
displayName,
isOptional,
requiresVerification,
userAttributeValues,
userInputType,
userAttribute,
b2x_identity_user_flow_id
)
SELECT 
'{{ id }}',
'{{ displayName }}',
{{ isOptional }},
{{ requiresVerification }},
'{{ userAttributeValues }}',
'{{ userInputType }}',
'{{ userAttribute }}',
'{{ b2x_identity_user_flow_id }}'
RETURNING
id,
displayName,
isOptional,
requiresVerification,
userAttribute,
userAttributeValues,
userInputType
;

Manifest

# Description fields are for documentation purposes
- name: b2x_user_flows_user_attribute_assignments
props:
  - name: b2x_identity_user_flow_id
    value: "{{ b2x_identity_user_flow_id }}"
    description: Required parameter for the b2x_user_flows_user_attribute_assignments resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The display name of the identityUserFlowAttribute within a user flow.
  - name: isOptional
    value: {{ isOptional }}
    description: |
      Determines whether the identityUserFlowAttribute is optional. true means the user doesn't have to provide a value. false means the user can't complete sign-up without providing a value.
  - name: requiresVerification
    value: {{ requiresVerification }}
    description: |
      Determines whether the identityUserFlowAttribute requires verification, and is only used for verifying the user's phone number or email address.
  - name: userAttributeValues
    description: |
      The input options for the user flow attribute. Only applicable when the userInputType is radioSingleSelect, dropdownSingleSelect, or checkboxMultiSelect.
    value:
      - isDefault: {{ isDefault }}
        name: "{{ name }}"
        value: "{{ value }}"
  - name: userInputType
    value: "{{ userInputType }}"
    valid_values: ['textBox', 'dateTimeDropdown', 'radioSingleSelect', 'dropdownSingleSelect', 'emailBox', 'checkboxMultiSelect']
  - name: userAttribute
    value: "{{ userAttribute }}"
    description: |
      The user attribute that you want to add to your user flow.

UPDATE examples

update

Update the properties of a identityUserFlowAttributeAssignment object.

UPDATE entra_id.identity.b2x_user_flows_user_attribute_assignments
SET 
id = '{{ id }}',
displayName = '{{ displayName }}',
isOptional = {{ isOptional }},
requiresVerification = {{ requiresVerification }},
userAttributeValues = '{{ userAttributeValues }}',
userInputType = '{{ userInputType }}',
userAttribute = '{{ userAttribute }}'
WHERE 
b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' --required
AND identity_user_flow_attribute_assignment_id = '{{ identity_user_flow_attribute_assignment_id }}' --required
RETURNING
id,
displayName,
isOptional,
requiresVerification,
userAttribute,
userAttributeValues,
userInputType;

DELETE examples

delete

Delete an identityUserFlowAttributeAssignment object.

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

Lifecycle Methods

set_order

Set the order of identityUserFlowAttributeAssignments being collected within a user flow.

EXEC entra_id.identity.b2x_user_flows_user_attribute_assignments.set_order 
@b2x_identity_user_flow_id='{{ b2x_identity_user_flow_id }}' --required 
@@json=
'{
"newAssignmentOrder": "{{ newAssignmentOrder }}"
}'
;