Import users

With the import, you register or update many portal users at once from a CSV file. The file is processed in the background, line by line, and at the end you see how many lines succeeded and which ones failed.

How to import

1. In Portal › Users (/dashboard/users), click Import.
2. Select the CSV file or drag it into the window.
3. Click Confirm.
4. Follow the progress. At the end, the window shows the summary and, if there are any, the error of each line.

When the import finishes, the user list refreshes by itself.

The file

• CSV format, in UTF-8, with a comma as the separator. Other formats (such as XLSX) are not accepted.
• Up to 10 MB.
• The first line is the header, with the column names below. The order doesn't matter.
• Values containing a comma go between quotes.

Column	Required	What it does
email	Yes	The user's e-mail. A line without an e-mail gives an error
tenant_id	No	The tenant ID. Without the column, the tenant ID doesn't change; with an empty cell, it is cleared
status	No	active, pending_verification, pending_invitation, suspended or locked. Empty or missing becomes pending_verification
sso_only	No	true, 1, yes or sim marks the user as SSO only (no password). Any other value, or a missing column, unmarks it
public_id	No	The user's public ID. Used to find an existing user
metadata	No	A JSON object with extra data

The user's name is not imported.

Example:

email,tenant_id,status
larissa.pereira@clientes-aurora.com.br,36790981705,active
caio.nascimento@clientes-aurora.com.br,51205326000196,active

Create or update

Each line looks for a user in the workspace by public_id and, if it finds none, by email:

• Found — the user is updated with the line's values.
• Not found — a new user is created.

The import doesn't send e-mails. A user created as pending_verification signs in through the portal (with a magic link, for example) and the first sign-in activates them. If you want to send an invitation, use Invite user — see Portal users.

:::warning Updating an existing user When updating, status, sso_only and metadata are always rewritten. If your spreadsheet doesn't have these columns, an Active user goes back to Pending, loses the SSO-only mark and is left without metadata. Include the columns with the current values when you are only adjusting the tenant ID — the export brings all of them. :::

:::tip Reusing an export The export file uses headers in Portuguese (E-mail, ID do Titular...). To import it back, replace the header with the column names above (email, tenant_id...). :::

Import status

Status	What it means
pending	Queued. The window shows Processing import...
processing	Reading the lines. The window shows how many are done (12 of 40)
Import completed (completed)	All lines succeeded
Import completed with errors (completed_with_errors)	Some lines failed; the window lists each one with the reason (Line 5: ...)
Import failed (failed)	The file couldn't be read — for example, with no data lines

The lines that succeeded stay saved even when others fail. Fix only the lines with errors and import again.

Each import is recorded in the Audit log.

note

The import depends on the Allow creating users in the dashboard option, in Settings › Records. With it turned off, the import is refused.