Skip to main content

Authentication Processes (setup)

This is the practical how-to for creating and managing authentication processes. For what a process is and how your application calls it, see the concept page: Authentication Processes.

caution

Managing processes is Environment-Access only. A Project-Access admin can view the Processes tabs (the table and each process's ID and template) but every create, edit, transfer, and delete control is disabled: "Viewing only: adding, editing, transferring and deleting processes is restricted to administrators with 'Environment Access'." See Administrators & Access Levels.

Where processes live​

  • Project level — Configuration → Processes. Only a limited set is available here: Login and Generic email.
  • Tenant level — Tenants → [tenant] → Processes. All process types are available, including the Registration templates.
info

Rule of thumb: Login and Generic at the project, Registration inside the tenant. In a single-tenant project the tenant is hidden, so you manage everything from the project's Configuration — the Project scope / Tenant scope switch on the tab picks which (see Managing Tenants).

info

You rarely start from scratch. The project wizard and the tenant wizard create the registration processes for the end-user types you selected (named DEMO: …), and switching a project to multi-tenant offers to create its Login process. This page is for everything beyond that. See Create Your First Project and Managing Tenants.

Creating a process​

Gateways and channels. A process sends its codes through a gateway you configure in External Services. You can still create a process before its gateway exists — Cockpit warns you in the modal and the process simply won't send on that channel until a matching gateway is set up.

caution

On the demo setup, SMS is unavailable. While only the demo SendGrid gateway is configured, the modal shows the demo reminder and the SMS template option is disabled: "SMS is not available with the demo setup. To send SMS messages, configure an SMS gateway in External Services." Add a real SMS gateway to enable it.

See Email, SMS and Demo setup.

On the Processes tab, click Create process (or Create project process / Create tenant process) and fill in the form:

  1. Process template — pick one: Patient / Organisation / Practitioner … Registration, Generic Email or SMS template, or Email or SMS Login. This is fixed once created.
  2. Name and an optional Language.
  3. Email template — a Subject and an HTML body; or SMS template — a Message.
  4. Parent organisation (registration templates only) — the organization new users are attached to. Required for patient processes ("Parent organisation is required for patient authentication process.").
  5. Create auto delegation to parent organisation (registration templates only) — when on, users created through this process share with the parent so HCPs with the same parent can access their data.

Click Autofill defaults to start from a ready-made template, then Submit.

info

One process per language. A process holds a single language and message, so to support more than one language, create a separate process per language — each with its own Process ID.

Dynamic variables​

Subject, HTML, and SMS text can interpolate values with {{it.variable}}: validationCode (the one-time code), firstName, lastName, email, mobilePhone. (Generic, non-authentication templates support all of these except validationCode.) The default email subject is Your confirmation code: {{it.validationCode}}.

Managing existing processes​

The Processes table lists each process with a Process ID column — "Use this ID to reference the process in your application code." Per row you can:

  • Edit process — change its name, language, or message (not its template).
  • Delete process — remove it (with confirmation).
  • Transfer to another group — move it between the project and one of its tenants ("Transfer to another group"). Registration processes can't be moved.

For multi-tenant projects the table also shows the Parent ID, Auto delegation to parent, and Parent enrolment status of each registration process.

caution

If a registration process's parent organisation has no initialized private key, auto-delegation won't work and users created through it can't access encrypted data. Watch the Parent enrolment status and initialize the parent's key first — see Organization.

Where to go next​

Cardinal SDK reference: Registering users and Initialize the SDK — using the process IDs you create here.