ovok_sdk.resources.auth

The ovok.auth namespace: sign-in, registration and account management.

MfaChallengeCopy Anchor Link

MfaChallenge(profile_type: str, login_id: str, code_verifier: str)

Hand it back to verify_mfa: it carries the PKCE verifier the token exchange needs.

Parameters

SignedInCopy Anchor Link

SignedIn(session: Session, status: Literal['signed-in'] = 'signed-in')

The user is signed in.

Parameters

MfaRequiredCopy Anchor Link

MfaRequired(challenge: MfaChallenge, status: Literal['mfa-required'] = 'mfa-required')

The login needs a one-time code; pass challenge and the code to verify_mfa.

Parameters

AuthResourceCopy Anchor Link

AuthResource(
    http: HttpClient,
    tenant_code: str,
    session: UserSession | None,
    client_id: str | None = None,
)

User sign-in, registration and account management.

Created by Ovok; access it as ovok.auth. User sign-in needs a client built without client_secret; client_id names the app for social sign-in and password resets.

Examples

>>> result = ovok.auth.login(profile_type="Patient", email=email, password=password)
>>> if result.status == "mfa-required":
...     result = ovok.auth.verify_mfa(result.challenge, code)

login()Copy Anchor Link

login(*, profile_type: ProfileType, email: str, password: str) -> LoginResult

Sign a user in with email and password.

Parameters

Returns

• LoginResult: SignedIn with the stored session, or MfaRequired when a one-time code is needed.

Raises

• OvokConfigError: The client signs in with client_secret.
• OvokError: The API rejects the login, such as for wrong credentials.

verify_mfa()Copy Anchor Link

verify_mfa(challenge: MfaChallenge, code: str) -> SignedIn

Finish a login with the one-time code.

Parameters

Returns

• SignedIn: SignedIn with the stored session.

Raises

• OvokConfigError: The client signs in with client_secret.

register()Copy Anchor Link

register(registration: PatientRegistration) -> RegisterResult

Register a patient and sign them in.

Parameters

Returns

• RegisterResult: SignedIn with the stored session, or ClinicianInvite when the project routes the
• RegisterResult: email to a clinician invitation and no one is signed in.

Raises

• OvokConfigError: The client signs in with client_secret.
• OvokValidationError: The password and its confirmation differ.

register_practitioner()Copy Anchor Link

register_practitioner(registration: Registration) -> Session

Register a practitioner and sign them in.

Parameters

Returns

• Session: The stored session.

Raises

• OvokConfigError: The client signs in with client_secret.
• OvokValidationError: The password and its confirmation differ.

social_login()Copy Anchor Link

social_login(
    provider: SocialProvider,
    *,
    internal_id: str,
    credential: Mapping[str, Any],
) -> Session

Sign in with an Apple or Google credential.

Parameters

Returns

• Session: The stored session.

Raises

• OvokConfigError: The client has no client_id, or signs in with client_secret.

current()Copy Anchor Link

current() -> Session | None

Return the stored session.

Returns

• Session | None: The session, or None when no user is signed in or the client is a machine client.

me()Copy Anchor Link

me() -> dict[str, Any]

Read the signed-in user's profile and project.

Returns

• dict[str, Any]: The auth/me response.

change_password()Copy Anchor Link

change_password(*, old_password: str, new_password: str) -> dict[str, Any]

Change the signed-in user's password.

The confirmation is the app's to check; Ovok Core never receives it.

Parameters

Returns

• dict[str, Any]: The API's response.

reset_password()Copy Anchor Link

reset_password(
    *,
    email: str,
    profile_type: ProfileType,
    client_id: str | None = None,
) -> dict[str, Any]

Send a password reset email.

Parameters

Returns

• dict[str, Any]: The API's response.

complete_password_reset()Copy Anchor Link

complete_password_reset(*, reset_id: str, secret: str, password: str) -> dict[str, Any]

Set a new password from a reset link.

Parameters

Returns

• dict[str, Any]: The API's response.

delete_account()Copy Anchor Link

delete_account(*, days: int, wipe: bool) -> dict[str, Any]

Schedule the signed-in account for deletion.

The account stays signed in.

Parameters

Returns

• dict[str, Any]: The API's response.

logout()Copy Anchor Link

logout() -> None

Sign out.

Ends the session on the server, and always locally, even when the server cannot be reached.

Raises

• OvokConfigError: The client signs in with client_secret.