| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 2442 |
| Technical Name |
docuware_authentication |
| License | LGPL-3 |
| Website | https://www.codebar.ch |
| Availability |
Odoo Online
Odoo.sh
On Premise
|
| Odoo Apps Dependencies |
Discuss (mail)
|
| Lines of code | 2442 |
| Technical Name |
docuware_authentication |
| License | LGPL-3 |
| Website | https://www.codebar.ch |
DocuWare Authentication
OAuth2 with DocuWare Identity, token handling, and REST API access.
codebar Solutions AG
docuware_authentication is the foundation that
other DocuWare connector modules build on. It owns the
connection, credentials, OAuth2 flow, REST client, and an
immutable audit log — so business-level connectors can
stay focused on data. It does not push any data on its own;
companion modules (e.g. docuware_masterdata)
provide the business-level synchronization.
What’s in the box
OAuth2 with auto-discovery
Authorization Code + refresh token — the only flow
DocuWare Cloud reliably exposes for the
docuware.platform scope. The authorization and
token URLs are auto-discovered from the DocuWare Identity
Service; no manual entry.
Secrets gated to admins
Tokens and client secret are restricted to
base.group_system at the field level, so regular
DocuWare users never see them.
Immutable sync log
dw.log records every connection event and
cannot be edited or deleted from the UI. Useful for audits and
troubleshooting.
How it works
-
Register a Web (Authorization Code) application in DocuWare
Identity. Redirect URI:
<your-odoo-base-url>/docuware/oauth/callback. Scopes:docuware.platform openid dwprofile offline_access. -
In Odoo, set
web.base.urlto your full external URL so DocuWare can reach the OAuth callback at/docuware/oauth/callback. -
Create a record under
DocuWare → Connections: name, Platform URL
(e.g.
https://yourorg.docuware.cloud), Client ID and Client Secret. Save — the OAuth authorization and token URLs are auto-discovered on first authorize and cached on the record. - Click Authorize, sign in once on DocuWare, and Odoo persists the refresh token.
- Click Sync to enqueue a probe job that verifies the connection and writes the result to the Sync Log.
Requirements
- Odoo: 19.0
-
Python:
requests(declared as an external dependency) -
Odoo modules:
base,mail,web. OCA queue_job is an optional soft dependency: install it with a running worker for asynchronous execution; without it, jobs run inline in the request thread. - A DocuWare tenant with the Identity service enabled
Permissions
-
docuware_authentication.group_docuware_authentication— full CRUD ondw.connection; read access ondw.log. -
base.group_system— the only group that can read OAuth secrets and tokens (orthogonal, enforced at the field level).
Privacy & telemetry
Sentry telemetry is off by default. It activates
only when an administrator pastes a Sentry DSN under
Settings → DocuWare → Telemetry and saves.
Configuration is per database, stored as
ir.config_parameter records. There are no environment
variables to set and nothing is sent on a fresh install.
The sentry-sdk library is an optional
dependency: it is not installed with this module. To forward events
to Sentry, install it in Odoo’s Python environment
(pip install sentry-sdk), restart Odoo, then configure
the DSN. The telemetry screen shows whether the SDK is installed;
without it, nothing is sent.
What is sent when telemetry is active
- Unhandled exceptions raised inside the connector
- DocuWare sync errors with stack traces and error messages
- Connection identifiers and sync metadata
- IP addresses and user identifiers only when the “Send PII” toggle is explicitly enabled
OAuth tokens, refresh tokens, and client secrets are never sent.
Where it goes
Events are forwarded to the Sentry project that you control via the DSN you paste. codebar Solutions AG receives nothing unless you point the DSN at one of our projects.
Setup walkthrough
Assign access, optional telemetry, authorize the connection, then use DocuWare → Connections and the sync log.
User access rights
Grant DocuWare Authentication / companion groups under Settings → Users as needed.
Telemetry (optional)
Settings → DocuWare → Telemetry — off until you save a DSN.
Authorize connection
Start OAuth from the connection form.
DocuWare sign-in
Authorized
After login, the connection holds a refresh token (secrets remain admin-only).
Connections
Sync log
License & support
Released under LGPL-3.0-or-later .
Built and maintained by codebar Solutions AG. Support: helpdesk@codebar.ch.
Privacy: see codebar.ch for our data protection notice.
Please log in to comment on this module