Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC-901: Creds overhaul for T-Z #2169

Merged
merged 20 commits into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
781dcea
Update Taiga, Tapfiliate, TheHive, and TheHive 5 credentials to templ…
freakwriter Jun 10, 2024
1e43a58
Merge branch 'main' into DOC-901
freakwriter Jun 11, 2024
ef9e88c
Update TimescaleDB and Todoist credentials to template, remove old gifs
freakwriter Jun 11, 2024
67d0373
Update Toggl, TOTP, and Travis CI credentials to template, remove old…
freakwriter Jun 11, 2024
3c379e5
Update Trellix ePO, Trello, and Twake credentials to template, remove…
freakwriter Jun 13, 2024
049b851
Small tweaks
freakwriter Jun 13, 2024
cb23f06
Merge branch 'main' into DOC-901
freakwriter Jun 13, 2024
bbe3d7c
Update Twist credentials to template, remove old gif
freakwriter Jun 13, 2024
2e4d5db
Update navigation for renaming Twitter to X
freakwriter Jun 13, 2024
4098ef8
Update Twitter credential to template, update Twitter base node to use X
freakwriter Jun 13, 2024
fa0cb02
Update Typeform credential to template, remove old gif and pngs
freakwriter Jun 13, 2024
9696681
Update all U-credentials to template, remove old gifs, fix a couple t…
freakwriter Jun 13, 2024
c1a4b73
Update Venafi credentials to template, remove old PDF file now that w…
freakwriter Jun 13, 2024
6d1899f
Update Vero credentials to template, update VERO to Vero in app and c…
freakwriter Jun 13, 2024
00aa623
UPdate VirusTotal and Vonage credentials to template, remove old gif
freakwriter Jun 13, 2024
f6f19d0
Update Webflow, Wekan, and Wise credentials to template, remove old gifs
freakwriter Jun 13, 2024
ce41f12
Update WolframAlpha, WooCommerce, WordPress, Workable, and Wufoo cred…
freakwriter Jun 17, 2024
4f150b4
Update Xata and Xero credentials to template
freakwriter Jun 17, 2024
b30dff1
Update Yourls credential to template and remove old gif
freakwriter Jun 17, 2024
1b15090
Update all Z credentials to template and remove old gifs
freakwriter Jun 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed docs/_downloads/venafi-tpp.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Diff not rendered.
Diff not rendered.
Diff not rendered.
Diff not rendered.
14 changes: 7 additions & 7 deletions docs/integrations/builtin/app-nodes/n8n-nodes-base.twitter.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: Twitter
description: Documentation for the Twitter node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
title: X
description: Documentation for the X node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
contentType: integration
---

# Twitter
# X

Use the Twitter node to automate work in Twitter, and integrate Twitter with other applications. n8n has built-in support for a wide range of Twitter features, including creating direct messages, and deleting, searching, liking and retweeting a tweet.
Use the X node to automate work in X and integrate X with other applications. n8n has built-in support for a wide range of X features, including creating direct messages and deleting, searching, liking, and retweeting a tweet.

On this page, you'll find a list of operations the Twitter node supports and links to more resources.
On this page, you'll find a list of operations the X node supports and links to more resources.

/// note | Credentials
Refer to [Twitter credentials](/integrations/builtin/credentials/twitter/) for guidance on setting up authentication.
Refer to [X credentials](/integrations/builtin/credentials/twitter/) for guidance on setting up authentication.
///
/// note | Examples and templates
For usage examples and templates to help you get started, take a look at n8n's [Twitter integrations](https://n8n.io/integrations/twitter/){:target="_blank" .external-link} list.
For usage examples and templates to help you get started, take a look at n8n's [X integrations](https://n8n.io/integrations/twitter/){:target="_blank" .external-link} list.
///

## Basic Operations
Expand Down
14 changes: 7 additions & 7 deletions docs/integrations/builtin/app-nodes/n8n-nodes-base.vero.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
---
title: VERO
description: Documentation for the VERO node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
title: Vero
description: Documentation for the Vero node in n8n, a workflow automation platform. Includes details of operations and configuration, and links to examples and credentials information.
contentType: integration
---

# VERO
# Vero

Use the VERO node to automate work in VERO, and integrate VERO with other applications. n8n has built-in support for a wide range of VERO features, including creating and deleting users.
Use the Vero node to automate work in Vero and integrate Vero with other applications. n8n has built-in support for a wide range of Vero features, including creating and deleting users.

On this page, you'll find a list of operations the VERO node supports and links to more resources.
On this page, you'll find a list of operations the Vero node supports and links to more resources.

/// note | Credentials
Refer to [VERO credentials](/integrations/builtin/credentials/vero/) for guidance on setting up authentication.
Refer to [Vero credentials](/integrations/builtin/credentials/vero/) for guidance on setting up authentication.
///
/// note | Examples and templates
For usage examples and templates to help you get started, take a look at n8n's [VERO integrations](https://n8n.io/integrations/vero/){:target="_blank" .external-link} list.
For usage examples and templates to help you get started, take a look at n8n's [Vero integrations](https://n8n.io/integrations/vero/){:target="_blank" .external-link} list.
///

## Basic Operations
Expand Down
21 changes: 16 additions & 5 deletions docs/integrations/builtin/credentials/taiga.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,29 @@ contentType: integration

# Taiga credentials

You can use these credentials to authenticate the following nodes with Taiga.
You can use these credentials to authenticate the following nodes:

- [Taiga](/integrations/builtin/app-nodes/n8n-nodes-base.taiga/)
- [Taiga Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.taigatrigger/)

## Prerequisites

Create a [Taiga](https://taiga.io/) account.
Create a [Taiga](https://taiga.io/){:target=_blank .external-link} account.

## Using Username and Password
## Supported authentication methods

Use your username and password with the Taiga node credentials in n8n.
- Basic auth

**Note:** For self-hosted instances, you will have to additionally use your Taiga URL with the Taiga node credentials in n8n.
## Related resources

Refer to [Taiga's API documentation](https://docs.taiga.io/api.html){:target=_blank .external-link} for more information about the service.

## Using basic auth

To configure this credential, you'll need:

- A **Username**: Enter your username or user email address. Refer to [Normal login](https://docs.taiga.io/api.html#auth-normal-login){:target=_blank .external-link} for more information.
- A **Password**: Enter your password.
- The **Environment**: Choose between **Cloud** or **Self-Hosted**. For **Self-Hosted** instances, you'll also need to add:
- The **URL**: Enter your Taiga URL.

28 changes: 13 additions & 15 deletions docs/integrations/builtin/credentials/tapfiliate.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,28 +6,26 @@ contentType: integration

# Tapfiliate credentials

You can use these credentials to authenticate the following nodes with Tapfiliate.
You can use these credentials to authenticate the following nodes:

- [Tapfiliate](/integrations/builtin/app-nodes/n8n-nodes-base.tapfiliate/)

## Prerequisites

Create a [Tapfiliate](https://tapfiliate.com/) account.
Create a [Tapfiliate](https://tapfiliate.com/){:target=_blank .external-link} account.

## Using API Key
## Supported authentication methods

1. Open your Tapfiliate [dashboard](https://app.tapfiliate.com/dashboard/) page.
2. Click on your avatar on the bottom left of the window.
3. Select 'Profile Settings' from the dropdown list.
4. Scroll down to the ***API Key*** section.
5. Copy the displayed ***API Key***.
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'Tapfiliate API' credentials in n8n.
7. Paste the API key in the ***API Key*** field in the 'Tapfiliate API' credentials in n8n.
8. Click the ***Create*** button to create your credentials in n8n.
- API key

The following video demonstrates the steps mentioned above.
## Related resources

<div class="video-container">
<iframe width="840" height="472.5" src="https://www.youtube.com/embed/xc8y_ieaepk" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>
Refer to [Tapfiliate's API documentation](https://tapfiliate.com/docs/rest/){:target=_blank .external-link} for more information about the service.

## Using API key

To configure this credential, you'll need:

- An **API Key**: Get your API Key from your [**Profile Settings**](https://app.tapfiliate.com/a/profile/){:target=_blank .external-link} **> API Key**.

Refer to [Your API key](https://support.tapfiliate.com/en/articles/1441950-your-api-key){:target=_blank .external-link} for more information.
28 changes: 20 additions & 8 deletions docs/integrations/builtin/credentials/thehive.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,35 @@ contentType: integration

# TheHive credentials

You can use these credentials to authenticate the following nodes with TheHive.
You can use these credentials to authenticate the following nodes:

- [TheHive](/integrations/builtin/app-nodes/n8n-nodes-base.thehive/)

/// note | TheHive and TheHive 5
n8n provides two nodes for TheHive. Use these credentials with TheHive node, for version 3 or 4 API of the API. If you are using TheHive5 node for version 5 of the API, use [TheHive 5 credentials](/integrations/builtin/credentials/thehive5/).
n8n provides two nodes for TheHive. Use these credentials with TheHive node for TheHive 3 or TheHive 4. If you're using TheHive5 node, use [TheHive 5 credentials](/integrations/builtin/credentials/thehive5/).
///

## Prerequisites

Install [TheHive](https://github.com/TheHive-Project/TheHiveDocs/blob/master/installation/install-guide.md){:target=_blank .external-link} on your server.

## Using API Key
## Supported authentication methods

- API key

## Related resources

Refer to [TheHive 3's API documentation](https://docs.thehive-project.org/thehive/legacy/thehive3/api/){:target=_blank .external-link} and [TheHive 4's API documentation](https://docs.thehive-project.org/thehive/){:target=_blank .external-link} for more information about the services.

## Using API key

1. Access your TheHive dashboard.
2. Click on the **Organization** tab in the top right.
3. Click on the **Create API Key** button for the user you want to generate the API Key for.
4. Use this **API Key** and your instance **URL** with your TheHive node credentials in n8n.
To configure this credential, you'll need:

![Getting TheHive credentials](/_images/integrations/builtin/credentials/thehive/using-api.gif)
- An **API Key**: Create an API key from **Organization > Create API Key**. Refer to [API Authentication](https://docs.thehive-project.org/thehive/legacy/thehive3/api/authentication/){:target=_blank .external-link} for more information.
- Your **URL**: The URL of your TheHive server.
- An **API Version**: Choose between:
- **TheHive 3 (api v0)**
- **TheHive 4 (api v1)**
- For TheHive 5, use [TheHive 5 credentials](/integrations/builtin/credentials/thehive5/) instead.
- **Ignore SSL Issues**: When turned on, n8n will connect even if SSL certificate validation fails.

28 changes: 24 additions & 4 deletions docs/integrations/builtin/credentials/thehive5.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,37 @@ description: Documentation for TheHive 5 credentials. Use these credentials to a
contentType: integration
---

# TheHive5 credentials
# TheHive 5 credentials

You can use these credentials to authenticate the following nodes with TheHive5.
You can use these credentials to authenticate the following nodes with TheHive 5.

- [TheHive 5](/integrations/builtin/app-nodes/n8n-nodes-base.thehive5/)

/// note | TheHive and TheHive 5
n8n provides two nodes for TheHive. Use these credentials with TheHive5 node, for version 5 the API. If you are using TheHive node for version 3 or 4 of the API, use [TheHive credentials](/integrations/builtin/credentials/thehive/).
n8n provides two nodes for TheHive. Use these credentials with TheHive 5 node. If you're using TheHive node for TheHive 3 or TheHive 4, use [TheHive credentials](/integrations/builtin/credentials/thehive/).
///
n8n supports authentication with TheHive using an API key.

## Prerequisites

Install [TheHive 5](https://docs.strangebee.com/thehive/download/){:target=_blank .external-link} on your server.

## Supported authentication methods

- API key

## Related resources

Refer to [TheHive's API documentation](https://docs.strangebee.com/thehive/api-docs/){:target=_blank .external-link} for more information about the service.

## Using API key

To configure this credential, you'll need:

- An **API Key**: Users with `orgAdmin` and `superAdmin` accounts can generate API keys:
- `orgAdmin` account: Go to **Organization > Create API Key** for the user you wish to generate a key for.
- `superAdmin` account: Go to **Users > Create API Key** for the user you wish to generate a key for.
- Refer to [API Authentication](https://docs.strangebee.com/cortex/api/api-guide/?h=api+key#authentication){:target=_blank .external-link} for more information.
- A **URL**: The URL of your TheHive server.
- **Ignore SSL Issues**: When turned on, n8n will connect even if SSL certificate validation fails.


31 changes: 26 additions & 5 deletions docs/integrations/builtin/credentials/timescaledb.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,37 @@ contentType: integration

# TimescaleDB credentials

You can use these credentials to authenticate the following nodes with TimescaleDB.
You can use these credentials to authenticate the following nodes:

- [TimescaleDB](/integrations/builtin/app-nodes/n8n-nodes-base.timescaledb/)

## Prerequisites

An available instance of TimescaleDB.
An available instance of [TimescaleDB](https://www.timescale.com/){:target=_blank .external-link}.

## Using Database Connection
## Supported authentication methods

1. Retrieve your TimescaleDB credentials and connection parameters.
2. Use the credentials and connection parameters with your TimescaleDB node credentials in n8n.
- Database connection

## Related resources

Refer to [Timescale's documentation](https://docs.timescale.com/){:target=_blank .external-link} for more information about the service.

## Using database connection

To configure this credential, you'll need:

- The **Host**: The fully qualified server name or IP address of your TimescaleDB server.
- The **Database**: The name of the database to connect to.
- A **User**: The user name you want to log in with.
- A **Password**: Enter the password for the database user you are connecting to.
- **Ignore SSL Issues**: If turned on, n8n will connect even if SSL certificate validation fails and you won't see the **SSL** selector.
- **SSL**: This setting controls the `ssl-mode` connection string for the connection. Options include:
- **Allow**: Sets the `ssl-mode` parameter to `allow`. First try a non-SSL connection; if that fails, try an SSL connection.
- **Disable**: Sets the `ssl-mode` parameter to `disable`. Only try a non-SSL connection.
- **Require**: Sets the `ssl-mode` parameter to `require`, which is the default for TimescaleDB connection strings. Only try an SSL connection. If a root CA file is present, verify that a trusted certificate authority (CA) issued the server certificate.
- **Verify**: Sets the `ssl-mode` parameter to `verify-ca`. Only try an SSL connection and verify that a trusted certificate authority (CA) issued the server certificate.
- **Verify-Full**: Sets the `ssl-mode` parameter to `verify-full`. Only try an SSL connection, verify that a trusted certificate authority (CA) issued the server certificate and that the requested server host name matches that in the certificate.
- **Port**: The port number of the TimescaleDB server.

Refer to [Timescale's connection settings documentation](https://docs.timescale.com/use-timescale/latest/integrations/query-admin/qstudio/#connection-settings){:target=_blank .external-link} for more information about the non-SSL fields. Refer to [Connect with a stricter SSL](https://docs.timescale.com/use-timescale/latest/security/strict-ssl/){:target=_blank .external-link} for more information about the SSL options.
50 changes: 29 additions & 21 deletions docs/integrations/builtin/credentials/todoist.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,37 +6,45 @@ contentType: integration

# Todoist credentials

You can use these credentials to authenticate the following nodes with Todoist.
You can use these credentials to authenticate the following nodes:

- [Todoist](/integrations/builtin/app-nodes/n8n-nodes-base.todoist/)

## Prerequisites

Create a [Todoist](https://todoist.com/) account.
Create a [Todoist](https://todoist.com/){:target=_blank .external-link} account.

## Using OAuth
## Supported authentication methods

/// note | Note for n8n Cloud users
You'll only need to enter the Credentials Name and click on the circle button in the OAuth section to connect your Todoist account to n8n.
///
- API key
- OAuth2

1. Access your Todoist [App Management Console](https://developer.todoist.com/appconsole.html)
2. Enter a name in the ***App display name*** field and click on the ***Create app*** button.
3. Copy the ***OAuth Callback URL*** from n8n and paste it in the ***OAuth redirect URL*** field.
4. Click on the ***Save settings*** button.
5. Use the provided ***Client ID*** and ***Client secret*** with your Todoist OAuth2 API credentials in n8n.
6. Click on the circle button in the OAuth section to connect a Todoist account to n8n.
7. Click the ***Save*** button to save your credentials in n8n.
## Related resources

![Getting Todoist OAuth credentials](/_images/integrations/builtin/credentials/todoist/using-oauth.gif)
Refer to [Todoist's REST API documentation](https://developer.todoist.com/rest/v2/#overview){:target=_blank .external-link} for more information about the service.

## Using Access Token
## Using API key

1. Access your Todoist dashboard.
2. Click on the gear icon in the top right.
3. Select Integrations on the left panel.
4. Scroll down to see your API token.
5. Use the API token with your Todoist node credentials in n8n.
To configure this credential, you'll need:

![Getting Todoist credentials](/_images/integrations/builtin/credentials/todoist/using-access-token.gif)
- An **API Key**: Get your personal API token from your [**Integration settings**](https://todoist.com/prefs/integrations){:target=_blank .external-link} and enter it here.


## Using OAuth2

--8<-- "_snippets/integrations/builtin/credentials/cloud-oauth-button.md"

To configure this credential from scratch, you'll need:

- A **Client ID**
- A **Client Secret**

Get both by creating an application in the Todoist [App Management Console](https://developer.todoist.com/appconsole.html){:target=_blank .external-link}.

Use these settings for your application:

- Copy the **OAuth Callback URL** from n8n and add it as the **OAuth redirect URL**.
- Copy the **Client ID** and **Client Secret** from Todoist and add it to n8n.

Refer to the Todoist [Authorization Guide](https://developer.todoist.com/guides/#authorization){:target=_blank .external-link} for more information.

21 changes: 17 additions & 4 deletions docs/integrations/builtin/credentials/toggl.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,28 @@ contentType: integration

# Toggl credentials

You can use these credentials to authenticate the following nodes with Toggl.
You can use these credentials to authenticate the following nodes:

- [Toggl Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.toggltrigger/)

## Prerequisites

Create a [Toggl](https://toggl.com/) account.
Create a [Toggl](https://toggl.com/){:target=_blank .external-link} account.

## Using Username and Password
## Supported authentication methods

1. Use your Toggle username and password with your node credentials in n8n.
- Basic auth

## Related resources

Refer to [Toggl's API documentation](https://engineering.toggl.com/docs/){:target=_blank .external-link} for more information about the service.

## Using basic auth

To configure this credential, you'll need:

- A **Username**: Enter your user email address.
- A **Password**: Enter your user password.

Refer to [Authentication](https://engineering.toggl.com/docs/authentication){:target=_blank .external-link} for more information.

21 changes: 18 additions & 3 deletions docs/integrations/builtin/credentials/totp.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,25 @@ contentType: integration

# TOTP credentials

You can use these credentials to authenticate the following nodes with TOTP.
You can use these credentials to authenticate the following nodes:

- [TOTP](/integrations/builtin/core-nodes/n8n-nodes-base.totp/)

To use TOTP, you need a **Secret**, which is the secret key encoded in the QR code during authenticator setup, and a **Label**, which is the identifier for the account.
## Prerequisites

Refer to [Google Authenticator | Key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format){:target=_blank .external-link} for more information.
Generate a TOTP **Secret** and **Label**.

## Supported authentication methods

- Secret and label

## Related resources

Time-based One-time Password (TOTP) is an algorithm that generates a one-time password (OTP) using the current time. Refer to [Google Authenticator | Key URI format](https://github.com/google/google-authenticator/wiki/Key-Uri-Format){:target=_blank .external-link} for more information.

## Using secret and label

To configure this credential, you'll need:

- A **Secret**: The secret key encoded in the QR code during authenticator setup. It's an arbitrary key value encoded in Base32, for example: `BVDRSBXQB2ZEL5HE`. Refer to [Google Authenticator Secret](https://github.com/google/google-authenticator/wiki/Key-Uri-Format#secret){:target=_blank .external-link} for more information.
- A **Label**: The identifier for the account. It contains an account name as a URI-encoded string. You can include prefixes to identify the provider or service managing the account. If you use prefixes, use a literal or url-encoded colon to separate the issuer prefix and the account name, for example: `GitHub:john-doe`. Refer to [Google Authenticator Label](https://github.com/google/google-authenticator/wiki/Key-Uri-Format#label){:target=_blank .external-link} for more information.
Loading
Loading