General

Which types of API authentication are supported by which DocuWare version? What features do they support?

Cookie Authorization

6.x until & including 7.10

Features:

• Login with Username & Password
• Login with DocuWare Login Token
• Login with NTLM (OnPremise - Windows Login)
• Login Trusted User

OAuth

7.8 until 7.x

Features:

• Login with Username & Password
• Login with DocuWare Login token
• Login with NTLM (OnPremise - Windows Login)
• Login Trusted User

7.11 until 7.x

Features:

• Login with App Registration (OAuth Authorization Code Flow)
  • SSO from Microsoft Entra ID include in this article?
  • Refresh tokens (optional)
  • Identity tokens (optional)

Which migration path is recommended?

In case your application requires you to support a single version of DocuWare:

1. Organizations with DocuWare 7.7 or older: Use cookie authorization
2. Organizations from DocuWare 7.8 until 7.10: Use OAuth
   • Optional if you don't use this version with DocuWare 7.11
3. Organizations with DocuWare 7.11 or newer: Use OAuth with App Registration (Authorization Code Flow)

In case your application requires you to support multiple versions of DocuWare at once:

1. Organizations with DocuWare 7.10 or older: Use cookie authorization
2. Organizations with DocuWare 7.11 or newer: Use OAuth with App Registration (Authorization Code Flow)

How to get the DocuWare Version via API?

You find the version inside the JSON, which you can GET from this endpoint: https://servername/DocuWare/Platform

How to use OAuth instead of Cookies?

.NET

Please update to the latest DocuWare NuGet Packages. Unless you create the ServiceConnection or Cookies manually, it should use OAuth as soon as you release with latest DocuWare NuGet Packages.

Minimum Version:

• DocuWare.Platform.ServerClient: 13.0.*

Here is an overview of all NuGet versions: Version overview | DocuWare SDK Documentation

REST

Postman collections | DocuWare SDK Documentation:

• 7.8+
• 7.11+

How to read documentation in Postman (there are more than examples in Postman): KBA-37491 · DocuWare Support Portal

How to use App Registration?

.NET

Connect to DocuWare with an App Registration | DocuWare SDK Documentation

REST

Postman collections | DocuWare SDK Documentation

• App Registration Postman collection (7.11+)

Documentation: KBA-37491 · DocuWare Support Portal

How to renew a session when not using App Registration?

• Please try to log in again when you get an HTTP 401 Unauthorized Error or once the access token is expired.

• Make sure to avoid an endless loop to not lock your account when credentials are wrong.

What is the difference between Access tokens and Login tokens? When to use Refresh tokens?

• You get an Access token when providing correct login information to OAuth. It allows you to authenticate until the Access token is expired or until you log out.

• Create a new session: If you are already logged in, you can retrieve a Login token and set a custom expiration. The login token can be used to log in without using username + password.

• Keep a session alive: Refresh tokens can be retrieved when you are using the App Registration.