Skip to content

ONLYOFFICE credentials#

You can use these credentials to authenticate the following nodes:

Prerequisites#

Create a new ONLYOFFICE DocSpace portal or get an invitation to an existing one.

Supported authentication methods#

Using API key#

To configure this credential, you'll need:

  • A Base URL of your ONLYOFFICE DocSpace portal.
  • An API Key generated in your ONLYOFFICE DocSpace portal.

Generate API key in ONLYOFFICE DocSpace#

  1. In your ONLYOFFICE DocSpace portal, navigate to the Developer Tools section.
  2. Open the API keys tab.
  3. Click the Create new secret key button.
  4. Enter a Name for your API key (for example, n8n integration).
  5. Click the Generate button.
  6. Copy the generated API key.

Configure n8n credentials#

  1. In your n8n instance, navigate to the credentials form.
  2. Enter the Base URL of your ONLYOFFICE DocSpace portal (for example, https://yourportal.onlyoffice.com).
  3. Paste the copied API key into the API Key field.
  4. Click the Save button to save your credentials.

Refer to ONLYOFFICE DocSpace Help Center: API Keys and ONLYOFFICE DocSpace API: API Keys for more information.

Using basic auth#

To configure this credential, you'll need:

  • A Base URL of your ONLYOFFICE DocSpace portal.
  • An Email associated with your ONLYOFFICE DocSpace account.
  • A Password associated with your ONLYOFFICE DocSpace account.

Configure n8n credentials#

  1. In your n8n instance, navigate to the credentials form.
  2. Enter the Base URL of your ONLYOFFICE DocSpace portal (for example, https://yourportal.onlyoffice.com).
  3. Enter the Email associated with your ONLYOFFICE DocSpace account.
  4. Enter the Password associated with your ONLYOFFICE DocSpace account.
  5. Click the Save button to save your credentials.

Refer to ONLYOFFICE DocSpace API: Basic Authentication for more information.

Using OAuth2#

To configure this credential, you'll need:

  • A Base URL of your ONLYOFFICE DocSpace portal.
  • A Client ID of the application registered in your ONLYOFFICE DocSpace portal.
  • A Client Secret associated with the application registered in your ONLYOFFICE DocSpace portal.

Prepare workspace#

  1. Open your ONLYOFFICE DocSpace portal in one browser tab.
  2. Open your n8n instance in another browser tab.
  3. In your n8n instance, navigate to the credentials form.
  4. Copy the OAuth Redirect URL and keep it handy for the next steps.

Register OAuth application in ONLYOFFICE DocSpace#

  1. In your ONLYOFFICE DocSpace portal, navigate to the Developer Tools section.
  2. Open the OAuth 2.0 tab.
  3. Click the Register a new application button.
  4. Enter an App name for your application (for example, n8n integration).
  5. Enter a Website URL for your application (for example, https://n8n.io for the official n8n cloud, or your own n8n instance URL).
  6. Upload an App icon for your application (for example, the n8n official logo from the n8n Press pack).
  7. Past the OAuth Redirect URL you copied in step 4 of the "Prepare workspace" stage into the Redirects URLs field.
  8. Enter the Allowed origins URL (same as your website URL from step 5).
  9. Select Access scopes to limit n8n instance access to all user-related data. Check Read or Write options near each scope.
  10. Enter a Privacy policy URL (for example, https://n8n.io/legal/#privacy).
  11. Enter a Terms of Service URL (for example, https://n8n.io/legal/#terms).
  12. Click the Save button to create your application.

Configure n8n credentials#

  1. Open the newly created application in the OAuth 2.0 tab.
  2. Copy the Client ID from your ONLYOFFICE DocSpace application.
  3. In your n8n instance, navigate to the credentials form and paste the client ID into the Client ID field.
  4. Back in your ONLYOFFICE DocSpace portal, copy the Client Secret from your application.
  5. In your n8n instance, paste the client secret into the Client Secret field.
  6. Enter the Base URL of your ONLYOFFICE DocSpace portal (for example, https://yourportal.onlyoffice.com).
  7. Click the Save button to save your credentials.

Refer to ONLYOFFICE DocSpace Help Center: OAuth 2.0 and ONLYOFFICE DocSpace API: OAuth 2.0 for more information.

Using personal access token#

To configure this credential, you'll need:

  • A Base URL of your ONLYOFFICE DocSpace portal.
  • A Personal Access Token generated in your ONLYOFFICE DocSpace portal.

This authentication method is not recommended for general use. Personal access tokens can only be created using the ONLYOFFICE DocSpace API or retrieved from browser session cookies generated by the portal. This method should only be used for debugging purposes.

Refer to ONLYOFFICE DocSpace API: Personal Access Tokens for more information.