Skip to main content

LoginBody

No behavioral description is attached to this declaration. The public signature, parameter and return types, and source location below document its published contract.

Kind: Type alias
Package: @ovok/core

Import​

import { LoginBody } from '@ovok/core';

TypeScript shape​

type LoginBody = {
    email: string;
    password: string;
    type: "Patient" | "Practitioner";
} & ({
    type: "Patient";
    tenantCode: string;
} | {
    type: "Practitioner";
    tenantCode?: string;
});

This is a type-level export; it has no call parameters.

Public members​

MemberTypeDetails
emailstringThe email address of the patient
passwordstringThe password of the patient
type"Patient" | "Practitioner"The type of user to login
tenantCodestringOptional. The tenant code to login to. This is required for patient login. The tenant code to login to. This is optional for practitioner login. If not provided, the first tenant code will be used.

Learn the workflow​

Continue with Authentication for the workflow context and examples.

Source​

View the declaration in the SDK source.