Landing Pages
This is relevant for versions 2.3.27 and above
BioT allows customers to customize landing pages for different organizations for accepting invitations and forgot passwords.
To set landing pages
Please follow Landing Pages API
Setting up different landing pages to different organizations
By default, BioT sets landing pages to 3 different user roles:
- Patient
- Caregiver
- Organization User
Each user can have a unique landing page and each organization can have a different landing page.
Lets examine the defaults for accepting invitations and forgot passwords.
Accepting Invitations Landing Page
{
"type": "ACCEPT_INVITATION",
"pages": [
{
"userType": "patient",
"organizationId": null,
"url": "https://{{BASE_URL}}.biot-med.com/auth/invitation",
"landingPageType": "ACCEPT_INVITATION"
},
{
"userType": "caregiver",
"organizationId": null,
"url": "https://{{BASE_URL}}.biot-med.com/auth/invitation",
"landingPageType": "ACCEPT_INVITATION"
},
{
"userType": "organization-user",
"organizationId": null,
"url": "{{BASE_URL}}.biot-med.com/auth/invitation",
"landingPageType": "ACCEPT_INVITATION"
}
]
}
When "organizationId" = null, it applies to all existing organizations, which means that currently, every organization will have to same landing page.
If you wish to add a landing page to a specific organization's patients (3fa85f64-5717-4562-b3fc-2c963f66afa6), then you will have to pass the following payload:
{
"userType": "patient",
"organizationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"url": "<https://example.com/auth/invitation">
}
This will create a new landing page for organization 3fa85f64-5717-4562-b3fc-2c963f66afa6 patients.
The default landing page for all other organizations ("organizationId" = null) will remain the same and will not be overridden.
You cannot remove the default landing pages
Landing pages that are set with "organizationId" = null are the default landing pages and they cannot be removed. They can be updated with a different URL.
Forgot Password Landing Page
Unlike Accepting Invitations, this type of landing pages have 2 defaults entries:
{
"type": "FORGOT_PASSWORD",
"pages": [
{
"userType": "patient",
"organizationId": null,
"url": "https://{{organization_url}}.biot-med.com/auth/password/reset",
"landingPageType": "FORGOT_PASSWORD"
},
{
"userType": "caregiver",
"organizationId": null,
"url": "https://{{organization_url}}.biot-med.com/auth/password/reset",
"landingPageType": "FORGOT_PASSWORD"
},
{
"userType": "organization-user",
"organizationId": null,
"url": "https://{{organization_url}}.biot-med.com/auth/password/reset",
"landingPageType": "FORGOT_PASSWORD"
},
{
"userType": "patient",
"organizationId": "00000000-0000-0000-0000-000000000000",
"url": "https://{{manufacturer_url}}.biot-med.com/auth/password/reset",
"landingPageType": "FORGOT_PASSWORD"
},
{
"userType": "caregiver",
"organizationId": "00000000-0000-0000-0000-000000000000",
"url": "https://{{manufacturer_url}}.biot-med.com/auth/password/reset",
"landingPageType": "FORGOT_PASSWORD"
},
{
"userType": "organization-user",
"organizationId": "00000000-0000-0000-0000-000000000000",
"url": "https://{{manufacturer_url}}.biot-med.com/auth/password/reset",
"landingPageType": "FORGOT_PASSWORD"
}
]
}
By default, forgot password for the manufacturer organization (00000000-0000-0000-0000-000000000000) is defined, so all reset requests from the manufacturer organization will call "https://{{manufacturer_url}}.biot-med.com/auth/password/reset".
Any reset request from a custom organization will call https://{{organization_url}}.biot-med.com/auth/password/reset
If you wish to specify a landing page to a specific organization, the workflow is similar to the flow of accept invitation. In such case, non specified organizations will always look for "organizationId" = null.
Updated about 1 month ago