Home Schema Example JSON Schema

Provider Settings

Type: object

ProviderApplication.provider_settings are used by backend to communicate with the authentication providers. This field will not be exposed to frontend.

No Additional Properties

AzureProvider

Type: object

Provider settings for AzureProvider.

Type: string

The identity provider root URL (ex. graph.microsoft.com/v2).

Auth0Provider

Type: object

Provider 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

Client Secret

Type: string

Auth0 client secret for using the Auth0 management API.

Must be at least 1 characters long

SgidProvider

Type: object

Provider Settings for 'SgidProvider'

No Additional Properties

Client ID

Type: string

Client id obtained from sgid developer portal.

Must be at least 1 characters long

Client Secret

Type: string

Client secret obtained from sgid developer portal.

Must be at least 1 characters long

Private Key

Type: string

Private key obtained from sgid developer portal.

Must be at least 1 characters long

Scope

Type: string

Scope for Sgid. "openid" must be provided as a scope.

Must be at least 1 characters long

Type: boolean

Use session as identifier for heimdall application. Defaults to false.

OTPProvider

Type: object

Provider Settings for 'OTPProvider'

No Additional Properties

Ratatoskr Providers

Type: array of object

Ratatoskr providers to use for delivering OTP.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:


No Additional Properties

Type: object

The following properties are required:

  • ii_type
  • uid
Type: object

The following properties are required:

  • ii_type
  • name

Identifiable Information Type

Type: enum (of string)

The II type to use this provider with.

Must be one of:

  • "phone"
  • "email"

UID

Type: string

The Ratatoskr provider application UID.

Must be at least 1 characters long

Name

Type: string

The Ratatoskr provider application name.

Must be at least 1 characters long

OTP Settings

Type: object

Settings for configuring the pyotp.TOTP object.

No Additional Properties

Secret (Hex)

Type: string

Hexadecimal secret key for generating and verifying OTPs. Defaults to settings.HEIMDALL_HMAC_KEY.

Must match regular expression: ^[a-z0-9]{64}$

Digits

Type: integer

Number of OTP digits.

Value must be greater or equal to 4

Name

Type: string

Name of OTP application. Defaults to OTP (<environment>).

Must be at least 1 characters long

Issuer

Type: string

Issuer of OTP application. Defaults to Bot MD.

Must be at least 1 characters long

Interval

Type: integer

Interval that the OTP is valid for. Since we are doing a time-based thing with validity window size of 1 interval, this means that the OTP may sometimes be valid for up to 2 * interval seconds; other times it could be valid for only interval seconds. Defaults to 300.

Value must be greater or equal to 1

CleoMaxicareProvider

Type: object

Provider Settings for 'CleoMaxicareProvider'

Token

Type: string

Token that used for validate access.

Must be at least 1 characters long

URL

Type: stringFormat: uri

URL of Maxicare service

PublicServiceProvider

Type: object

Provider Settings for 'PublicServiceProvider'

No Additional Properties

Access Token

Type: string

Token that used for validate access.

Must be at least 1 characters long