b2x_user_flows_languages_overrides_pages

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

Overview

Name	b2x_user_flows_languages_overrides_pages
Type	Resource
Id	entra_id.identity.b2x_user_flows_languages_overrides_pages

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.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.

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, user_flow_language_page_id		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	select	b2x_identity_user_flow_id, user_flow_language_configuration_id		Get the userFlowLanguagePage resources from the overridesPages navigation property. These pages are used to customize the values shown to the user during a user journey in a user flow.
insert	insert	b2x_identity_user_flow_id, user_flow_language_configuration_id
update	update	b2x_identity_user_flow_id, user_flow_language_configuration_id, user_flow_language_page_id		Update the values in an userFlowLanguagePage object. You may only update the values in an overridesPage, which is used to customize the values shown to a user during a user journey defined by a user flow.
delete	delete	b2x_identity_user_flow_id, user_flow_language_configuration_id, user_flow_language_page_id	If-Match	Deletes the values in an userFlowLanguagePage object. You may only delete the values in an overridesPage, which is used to customize the values shown to a user during a user journey defined by 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
user_flow_language_configuration_id	string	The unique identifier of userFlowLanguageConfiguration
user_flow_language_page_id	string	The unique identifier of userFlowLanguagePage
If-Match	string	ETag

SELECT examples

get

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).

SELECT
id
FROM entra_id.identity.b2x_user_flows_languages_overrides_pages
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 user_flow_language_page_id = '{{ user_flow_language_page_id }}' -- required
;

list

Get the userFlowLanguagePage resources from the overridesPages navigation property. These pages are used to customize the values shown to the user during a user journey in a user flow.

SELECT
id
FROM entra_id.identity.b2x_user_flows_languages_overrides_pages
WHERE b2x_identity_user_flow_id = '{{ b2x_identity_user_flow_id }}' -- required
AND user_flow_language_configuration_id = '{{ user_flow_language_configuration_id }}' -- required
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity.b2x_user_flows_languages_overrides_pages (
id,
b2x_identity_user_flow_id,
user_flow_language_configuration_id
)
SELECT 
'{{ id }}',
'{{ b2x_identity_user_flow_id }}',
'{{ user_flow_language_configuration_id }}'
RETURNING
id
;

Manifest

# Description fields are for documentation purposes
- name: b2x_user_flows_languages_overrides_pages
props:
  - name: b2x_identity_user_flow_id
    value: "{{ b2x_identity_user_flow_id }}"
    description: Required parameter for the b2x_user_flows_languages_overrides_pages resource.
  - name: user_flow_language_configuration_id
    value: "{{ user_flow_language_configuration_id }}"
    description: Required parameter for the b2x_user_flows_languages_overrides_pages resource.
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.

UPDATE examples

update

Update the values in an userFlowLanguagePage object. You may only update the values in an overridesPage, which is used to customize the values shown to a user during a user journey defined by a user flow.

UPDATE entra_id.identity.b2x_user_flows_languages_overrides_pages
SET 
id = '{{ id }}',
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 user_flow_language_page_id = '{{ user_flow_language_page_id }}' --required
RETURNING
id,
@odata.type;

DELETE examples

delete

Deletes the values in an userFlowLanguagePage object. You may only delete the values in an overridesPage, which is used to customize the values shown to a user during a user journey defined by a user flow.

DELETE FROM entra_id.identity.b2x_user_flows_languages_overrides_pages
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 user_flow_language_page_id = '{{ user_flow_language_page_id }}' --required
AND If-Match = '{{ If-Match }}'
;