Home Schema Example JSON Schema

Provider-Application Settings

Type: object

ProviderApplication.settings are usually settings required by frontend for handling authentication. As this will be provided to the frontend (sometimes without authentication), we should not store any secrets in here. Common fields stored here are ids, logos, color themes, etc.

No Additional Properties

Auth0Provider

Type: object

ProviderApplication settings for Auth0Provider.

No Additional Properties

Domain

Type: stringFormat: hostname

Your Auth0 account domain (ex. auth.botmd.io).

Client ID

Type: string

Your Auth0 client ID.

Must be at least 1 characters long

Connection

Type: enum (of string)

Specifies how to send the code/link to the user. Value must be either email or sms.

Must be one of:

  • "email"
  • "sms"

Lock options

Type: object

Options to customize Lock.

AzureADProvider

Type: object

Provider settings for 'AzureADProvider'

Client ID

Type: string

The Azure AD client ID.

Must be at least 1 characters long

QRCodeProvider

Type: object

Provider settings for QRCodeProvider.

No Additional Properties

URL

Type: stringFormat: uri

The URL to use for generating the QR code. This URL will include a ${web_session} which should be replaced with the pre-generated web session UID. It is usually botmd://hospital/qrcodeLogin?session=${web_session}.