Skip to main content

Flow Meta (V2)

getFlowMetaV2 fetches aggregated metadata for a V2 flow context — including application branding, organization unit details, theme configuration, and available translations. Use it to pre-load everything needed to render a custom sign-in or sign-up UI.

getFlowMetaV2(config)

import { getFlowMetaV2, FlowMetaType } from '@thunderid/javascript'

const meta = await getFlowMetaV2({
baseUrl: 'https://localhost:8090',
type: FlowMetaType.App,
id: '<your-app-id>',
language: 'en-US',
})

console.log(meta.application?.name)
console.log(meta.design.theme.colorSchemes)
console.log(meta.i18n.translations)

Parameters

ParameterTypeRequiredDescription
config.urlstringFull endpoint URL. Mutually exclusive with baseUrl
config.baseUrlstringThunderID base URL
config.typeFlowMetaTypeScope the metadata to an application (App) or organization unit (Ou)
config.idstringApplication ID or OU ID, depending on type
config.languagestringBCP 47 language tag for the i18n metadata (e.g., 'en-US')
config.namespacestringTranslation namespace filter

Response: FlowMetadataResponse

PropertyTypeDescription
applicationApplicationMetadataApplication details (name, logo, links). Present when type is App
ouOUMetadataOrganization unit details. Present when type is Ou
designDesignMetadataTheme and layout configuration
i18nI18nMetadataAvailable translations and language list
isRegistrationFlowEnabledbooleanWhether self-registration is enabled

ApplicationMetadata

PropertyTypeDescription
idstringApplication UUID
namestringApplication display name
urlstringApplication home URL
logoUrlstringApplication logo URL
policyUristringPrivacy policy URL
tosUristringTerms of service URL

OUMetadata

PropertyTypeDescription
idstringOrganization unit UUID
namestringOrganization unit name
handlestringOrganization handle (URL-safe identifier)
descriptionstringOrganization description
logoUrlstringOrganization logo URL
policyUristringPrivacy policy URL
tosUristringTerms of service URL
cookiePolicyUristringCookie policy URL

DesignMetadata

PropertyTypeDescription
themeFlowMetaThemeTheme configuration
layoutobjectLayout configuration

FlowMetaTheme

PropertyTypeDescription
colorSchemesRecord<string, FlowMetaThemeColorScheme>Named color scheme variants
defaultColorSchemestringDefault color scheme name ('light' or 'dark')
direction'ltr' | 'rtl'Text direction
shapeFlowMetaThemeShapeBorder radius configuration
typographyFlowMetaThemeTypographyFont family and size configuration

FlowMetaThemeColorScheme

PropertyTypeDescription
backgroundFlowMetaThemeBackgroundPage and surface background colors
colorsFlowMetaThemeColorsPrimary, secondary, and semantic colors
textFlowMetaThemeTextColorsForeground text colors

FlowMetaThemeColors

PropertyTypeDescription
primaryFlowMetaThemeColorSetPrimary brand color (main, dark, contrastText)
secondaryFlowMetaThemeColorSetSecondary brand color

I18nMetadata

PropertyTypeDescription
languagestringActive language for the response
languagesstring[]All supported language codes
translationsRecord<string, string>Translation key-value pairs for the active language
totalResultsnumberTotal number of available translation keys

Enum

FlowMetaType

ValueDescription
AppScope metadata to a specific application
OuScope metadata to a specific organization unit
ThunderID LogoThunderID Logo

Product

DocsAPIsSDKs
© WSO2 LLC. All rights reserved.Privacy PolicyCookie Policy