Auth resource

AuthResourceCopy Anchor Link

class AuthResource

Sign-in, registration, passwords and the account; sign-in runs anonymously.

Reached through ovok.auth. Every request throws an OvokException subclass when it fails.

ConstructorsCopy Anchor Link

AuthResource.newCopy Anchor Link

AuthResource(
  HttpClient _http,
  String _tenantCode,
  UserSession _session,
  String? _clientId,
)

clientId is the ClientApplication social sign-in and password resets go through.

PropertiesCopy Anchor Link

AuthResource.sessionsCopy Anchor Link

final AuthSessionsResource sessions

The account's sessions on the server.

MethodsCopy Anchor Link

AuthResource.loginCopy Anchor Link

Future<LoginResult> login({
  required ProfileType profileType,
  required String email,
  required String password,
})

Runs the tenant login with PKCE for the configured tenant.

Calls POST auth/tenant/{profileType}/login/start, then the token step. Returns SignedIn, or MfaRequired when the account needs a second factor.

Returns Future<LoginResult>.

AuthResource.verifyMfaCopy Anchor Link

Future<LoginResult> verifyMfa(MfaChallenge challenge, String code)

Completes a login that returned MfaRequired with the user's MFA code.

Calls POST auth/tenant/{profileType}/login/mfa, then the token step.

Returns Future<LoginResult>.

AuthResource.registerCopy Anchor Link

Future<RegisterResult> register(Registration registration, {String? continueAsPatientToken})

Registers a patient account and signs it in.

Calls POST auth/tenant/Patient/register. Returns SignedIn, or ClinicianInvite when the project routes the email to a clinician invitation, which signs no one in. Throws OvokValidationException when the password and its confirmation differ.

Returns Future<RegisterResult>.

AuthResource.registerPractitionerCopy Anchor Link

Future<Session> registerPractitioner(Registration registration)

Registers a practitioner account and signs it in.

Calls POST auth/tenant/Practitioner/register. Throws OvokValidationException when the password and its confirmation differ.

Returns Future<Session>.

AuthResource.socialLoginCopy Anchor Link

Future<Session> socialLogin(
  SocialProvider provider, {
  required String internalId,
  required Map<String, dynamic> credential,
})

Signs in with an Apple or Google credential.

Calls POST auth/external/{provider}. credential is the provider's sign-in result, sent as it is. Throws OvokConfigException when the client was built without clientId.

Returns Future<Session>.

AuthResource.currentCopy Anchor Link

Future<Session?> current()

The stored session, or null when no one is signed in.

Returns Future<Session?>.

AuthResource.meCopy Anchor Link

Future<Map<String, dynamic>> me()

Fetches the signed-in account. Calls GET auth/me.

Returns Future<Map<String, dynamic>>.

AuthResource.changePasswordCopy Anchor Link

Future<Map<String, dynamic>> changePassword({required String oldPassword, required String newPassword})

Changes the signed-in user's password. Calls PATCH v2/auth/change-password.

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

Returns Future<Map<String, dynamic>>.

AuthResource.resetPasswordCopy Anchor Link

Future<Map<String, dynamic>> resetPassword({
  required String email,
  required ProfileType type,
  String? clientId,
})

Starts a password reset for email. Calls POST v2/auth/reset-password.

clientId overrides the client's configured clientId.

Returns Future<Map<String, dynamic>>.

AuthResource.completePasswordResetCopy Anchor Link

Future<Map<String, dynamic>> completePasswordReset({
  required String id,
  required String secret,
  required String password,
})

Sets password with the id and secret from the reset email.

Calls POST v2/auth/reset-password/process.

Returns Future<Map<String, dynamic>>.

AuthResource.deleteAccountCopy Anchor Link

Future<Map<String, dynamic>> deleteAccount({required int days, bool wipe = false})

Schedules the deletion in days; wipe also deletes the medical data then.

Calls DELETE auth/delete.

Returns Future<Map<String, dynamic>>.

AuthResource.logoutCopy Anchor Link

Future<void> logout()

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

Calls DELETE auth/session/current.

Returns Future<void>.

SocialProviderCopy Anchor Link

enum SocialProvider

An identity provider for AuthResource.socialLogin.

ValuesCopy Anchor Link

SocialProvider.appleCopy Anchor Link

static const SocialProvider apple

Sign in with Apple.

SocialProvider.googleCopy Anchor Link

static const SocialProvider google

Sign in with Google.