Skip to main content

Onboarding Data Model

There are two ways to look at the database schema in the onboarding project:

  1. Data model — How the data is structured (tables, fields, relationships).
  2. Conceptual model — How that data results in an OnboardingRequest turning into an Account. When an onboarding request is made, there is no corresponding account yet; the account is created during provisioning.

For the overall flow (how a request leads to a provisioned account), see Onboarding and the Developer Guide.

OnboardingRequest

OnboardingRequest represents a form submission — the data submitted in that form. It is used to provision a new account, including configuration in Admin.

OAuth fields and OAuthProvider

The oauth_* fields on OnboardingRequest are normally used to create the OAuthProvider in Admin when the account is provisioned.

Salesforce exception

For Salesforce, the Salesforce OAuth application is configured globally for Deepdesk. In that case:

  • Client credentials are not included in the onboarding request.
  • Credentials are read from Platform (configured in the Onboarding service).
  • The OAuth settings are set manually via Onboarding Admin and read from the Platform (e.g. Salesforce) application.
  • The oauth_* fields on Platform (not on OnboardingRequest) are used to create the OAuthProvider in Admin.

So: for most platforms, OnboardingRequest.oauth_* → OAuthProvider in Admin; for Salesforce, Platform.oauth_* (maintained in Onboarding Admin) → OAuthProvider in Admin.

See also