Edit

userFlowLanguageConfiguration resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

User flows language customization is a feature that allows a given user flow to support customization of multiple languages, from all the built-in languages to a custom language.

For Azure Active Directory B2C user flows, you can use the built-in languages or provide the language customizations for a language that isn't currently built in by default. For Microsoft Entra user flows, you can only use the built-in languages provided by Microsoft. Both user flows for Azure Active Directory B2C and Microsoft Entra ID support customizing the language and strings shown to users as they go through the journeys you configure with your user flows.

Methods

Method Return type Description
Get userFlowLanguageConfiguration userFlowLanguageConfiguration Read the properties and relationships of a userFlowLanguageConfiguration object. These objects represent a language available in a user flow.
Delete userFlowLanguageConfiguration None Deletes a custom userFlowLanguageConfiguration object. These objects represent a language available in a user flow and only a custom language can be deleted from an Azure AD B2C user flow.
List defaultPages userFlowLanguagePage collection Get the userFlowLanguagePage resources from the defaultPages navigation property. Represents the default user journey in a user flow.
List overridesPages userFlowLanguagePage collection Get the userFlowLanguagePage resources from the overridesPages navigation property. Represents a custom experience for a user journey in a user flow.

Properties

Property Type Description
id String The identifier of the language. This field is Language ID tag RFC 5646 compliant and must be a documented Language ID.
isEnabled Boolean Indicates whether the language is enabled within the user flow.
displayName String The language name to display. This property is read-only.

Relationships

Relationship Type Description
defaultPages userFlowLanguagePage collection 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.
overridesPages userFlowLanguagePage collection Collection of pages with the overrides messages to display in a user flow for a specified language. This collection only allows to modify the content of the page, any other modification isn't allowed (creation or deletion of pages).

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.userFlowLanguageConfiguration",
  "id": "String (identifier)",
  "isEnabled": "Boolean",
  "displayName": "String"
}