object
PlatformConfig
Schema representing the platform sales channel authentication configuration.
Fields
id
StringUnique document id of the platform config.
active
BooleanIs the application config active or not.
created_at
StringWhen was the application platform config document was created.
delete_account_consent
JSONAny consent you want a user to know while deleting the account.
delete_account_day
IntNumber of days after which the user account will be deleted.
delete_account_reasons
[DeleteAccountReasons]List of reasons you can set to ask the user when an account is being deleted from the application.
desktop_image
StringImage to be shown on registration page for desktop devices.
display
StringThe display name of the platform.
flash_card
FlashCardInformation of the flashcard like text colour, text and background color of text.
forgot_password
BooleanForgot password option to be given or not to application user.
login
LoginLogin option to be provided with password or OTP either both.
look_and_feel
LookAndFeelThe look and feel configuration of the platform.
meta
MetaDetailAdditional information for platform config.
mobile_image
StringImage to be shown on registration page for mobile devices.
name
StringName of the application.
register
BooleanWhether to show the registration page on landing page or not.
register_required_fields
RegisterRequiredFieldsInformation which fields are mandatory for application eg is email mandatory or phone number mandatory or either both of them are mandatory.
required_fields
RequiredFieldsInformation which fields are mandatory for application eg is email mandatory or phone number mandatory or either both of them are mandatory.
session_config
JSONContains session config formation like is session rolling, if yes then number of days or hours till session gets rolled .
skip_captcha
BooleanSkip the captcha or not.
skip_login
BooleanWhether to skip the login or not.
social
SocialInformation whether application social logins like facebook, google etc are enabled or disabled.
social_tokens
SocialTokensApplication credentials like client id and secret for social logins.
subtext
StringText to be shown at the top of the flash card like login to fynd, login to tira.
updated_at
StringThe date and time when the configuration was last updated.
Was this section helpful?