b2x_user_flows_languages

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

Overview

Name	b2x_user_flows_languages
Type	Resource
Id	entra_id.identity.b2x_user_flows_languages

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.
defaultPages	array	Collection of pages with the default content to display in a user flow for a specified language. This collection doesn't allow any kind of modification.
displayName	string	The language name to display. This property is read-only.
isEnabled	boolean	Indicates whether the language is enabled within the user flow.
overridesPages	array	Collection of pages with the overrides messages to display in a user flow for a specified language. This collection only allows you to modify the content of the page, any other modification isn't allowed (creation or deletion of pages).

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
defaultPages	array	Collection of pages with the default content to display in a user flow for a specified language. This collection doesn't allow any kind of modification.
displayName	string	The language name to display. This property is read-only.
isEnabled	boolean	Indicates whether the language is enabled within the user flow.
overridesPages	array	Collection of pages with the overrides messages to display in a user flow for a specified language. This collection only allows you to modify the content of the page, any other modification isn't allowed (creation or deletion of pages).

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	b2x_identity_user_flow_id, user_flow_language_configuration_id		Read the properties and relationships of a userFlowLanguageConfiguration object. These objects represent a language available in a user flow. Note: Language customization is enabled by default in Microsoft Entra user flows.
list	select	b2x_identity_user_flow_id		Retrieve a list of languages supported for customization in a B2X user flow.
insert	insert	b2x_identity_user_flow_id
update	update	b2x_identity_user_flow_id, user_flow_language_configuration_id
delete	delete	b2x_identity_user_flow_id, user_flow_language_configuration_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
user_flow_language_configuration_id	string	The unique identifier of userFlowLanguageConfiguration
If-Match	string	ETag

SELECT examples

get

Read the properties and relationships of a userFlowLanguageConfiguration object. These objects represent a language available in a user flow. Note: Language customization is enabled by default in Microsoft Entra user flows.

SELECT
id,
defaultPages,
displayName,
isEnabled,
overridesPages
FROM entra_id.identity.b2x_user_flows_languages
WHERE b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' -- required
AND user_flow_language_configuration_id = '{{ user_flow_language_configuration_id }}' -- required
;

list

Retrieve a list of languages supported for customization in a B2X user flow.

SELECT
id,
defaultPages,
displayName,
isEnabled,
overridesPages
FROM entra_id.identity.b2x_user_flows_languages
WHERE b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity.b2x_user_flows_languages (
id,
displayName,
isEnabled,
defaultPages,
overridesPages,
b2x_identity_user_flow_id
)
SELECT 
'{{ id }}',
'{{ displayName }}',
{{ isEnabled }},
'{{ defaultPages }}',
'{{ overridesPages }}',
'{{ b2x_identity_user_flow_id }}'
RETURNING
id,
defaultPages,
displayName,
isEnabled,
overridesPages
;

Manifest

# Description fields are for documentation purposes
- name: b2x_user_flows_languages
props:
  - name: b2x_identity_user_flow_id
    value: "{{ b2x_identity_user_flow_id }}"
    description: Required parameter for the b2x_user_flows_languages resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      The language name to display. This property is read-only.
  - name: isEnabled
    value: {{ isEnabled }}
    description: |
      Indicates whether the language is enabled within the user flow.
  - name: defaultPages
    description: |
      Collection of pages with the default content to display in a user flow for a specified language. This collection doesn't allow any kind of modification.
    value:
      - id: "{{ id }}"
  - name: overridesPages
    description: |
      Collection of pages with the overrides messages to display in a user flow for a specified language. This collection only allows you to modify the content of the page, any other modification isn't allowed (creation or deletion of pages).
    value:
      - id: "{{ id }}"

UPDATE examples

update

No description available.

UPDATE entra_id.identity.b2x_user_flows_languages
SET 
id = '{{ id }}',
displayName = '{{ displayName }}',
isEnabled = {{ isEnabled }},
defaultPages = '{{ defaultPages }}',
overridesPages = '{{ overridesPages }}'
WHERE 
b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' --required
AND user_flow_language_configuration_id = '{{ user_flow_language_configuration_id }}' --required
RETURNING
id,
defaultPages,
displayName,
isEnabled,
overridesPages;

DELETE examples

delete

No description available.

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