Home Schema Example JSON Schema

Provider Input


Provider inputs are used by Heimdall login frontends for provider specific input values. These are usually things like access tokens and secret credentials generated by the authentication provider.

 No Additional Properties

root anyOf item 0
Type: object

The following properties are required:

  • access_token
root anyOf item 1
Type: object

The following properties are required:

  • jwt
root anyOf item 2
Type: object

The following properties are required:

  • session
root anyOf item 3
Type: object

The following properties are required:

  • token
root anyOf item 4
Type: object

The following properties are required:

  • maxicare_card_no
  • maxicare_clinic_domain
  • maxicare_dob
root anyOf item 5
Type: object

The following properties are required:

  • native_session
  • web_session
root anyOf item 6
Type: object

The following properties are required:

  • identifiable_information
root anyOf item 7
Type: object

The following properties are required:

  • sgid_session
root anyOf item 8
Type: object

The following properties are required:

  • sgid_authorize
root anyOf item 9
Type: object

The following properties are required:

  • chemocalc_nric

root access_token

Access Token

Type: string

Access tokens are usually generated by third party services which the backend can use to authenticate. This is used by Auth0Provider and PublicServiceProvider.

Must be at least 1 characters long

root native_session

QRCodeProvider: Native Session

Type: string

The current session token held by the native device. This is used by QRCodeProvider.

Must be at least 32 characters long

root web_session

QRCodeProvider: Web Session

Type: string

The pre-generated session token requested by the web device. This is usually enccoded within the QR code and generated by the web client. This is used by QRCodeProvider.

Must be at least 32 characters long

root jwt

JWT

Type: string

JWT tokens are usually generated by third party services which the backend can use to authenticate. This is used by LegacyJWTProvider.

Must be at least 1 characters long

root session

Session

Type: string

A valid Heimdal session UID often used for session exchange. This is used by CleoClinicianProvider.

Must be at least 32 characters long

root sgid_authorize

SGID Authorize

Type: boolean

Authorize against SGIDProvider instead of application. This is used by SGIDProvider.

root sgid_session

Sgid Session

Type: string

A valid Heimdall session UID with scoope sgid used for session exchange.

Must be at least 32 characters long

root chemocalc_nric

Chemocalc NRIC

Type: string

NRIC that is used by ChemocalcHeimdallProvider.

Must be at least 1 characters long

root maxicare_card_no

Maxicare Card No

Type: string

Maxicare Card No that is used by MaxicareHeimdallProvider

Must be at least 1 characters long

root maxicare_clinic_domain

Maxicare clinic domain

Type: string

Maxicare clinc domain that is used by MaxicareHeimdallProvider

Must be at least 1 characters long

root maxicare_dob

Maxicare Member DOB

Type: stringFormat: date

Maxicare's member DOB for verification

root token

Token

Type: string

Tokens are usually generated by third party services which the backend can use to authenticate. This is used by InternalServiceProvider and CleoPatientProvider.

Must be at least 1 characters long

root identifiable_information

Identifiable Information

Type: object

Identifiable information for OTPProvider to verify OTP.

 No Additional Properties

root identifiable_information oneOf item 0
Type: object

The following properties are required:

  • type
  • value
root identifiable_information oneOf item 1
Type: object

The following properties are required:

  • phone
root identifiable_information oneOf item 2
Type: object

The following properties are required:

  • email
root identifiable_information oneOf item 3
Type: object

The following properties are required:

  • whatsapp
root identifiable_information oneOf item 4
Type: object

The following properties are required:

  • governess_user_uid
root identifiable_information oneOf item 5
Type: object

The following properties are required:

  • hospital_profile_uid

root identifiable_information type

Type

Type: enum (of string)

The identifiable information type.

Must be one of:

  • "phone"
  • "email"
  • "whatsapp"
  • "governess_user_uid"
  • "hospital_profile_uid"

root identifiable_information value

Value

Type: string

The identifiable information value.

Must be at least 1 characters long

root identifiable_information phone

Phone

Type: string

Phone number in E.164 format.

Must match regular expression: ^\+\d{5,}$

root identifiable_information email

Email


Email address.

root identifiable_information email anyOf item 0
Type: objectFormat: email
root identifiable_information email anyOf item 1
Type: objectFormat: idn-email

root identifiable_information whatsapp

WhatsApp

Type: string

WhatsApp phone number in E.164 format.

Must match regular expression: ^\+\d{5,}$

root identifiable_information governess_user_uid

Governess User UID

Type: string

UID of Governess user.

Must match regular expression: ^[a-zA-Z0-9]{16,}$

root identifiable_information hospital_profile_uid

Hospital Profile UID

Type: string

UID of Hospital profile.

Must match regular expression: ^[a-zA-Z0-9]{16,}$