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-875: Creds overhaul for O-R #2144

Merged
merged 17 commits into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 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.
40 changes: 29 additions & 11 deletions docs/integrations/builtin/credentials/odoo.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,36 @@ contentType: integration

# Odoo credentials

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

- [Odoo](/integrations/builtin/app-nodes/n8n-nodes-base.odoo/)

1. Sign up for Odoo and create an API key or password. Refer to Odoo's documentation for more information: [External API](https://www.odoo.com/documentation/15.0/developer/misc/api/odoo.html). Note that some Odoo modules and settings require API keys, not passwords.
2. In n8n, create a new credential. You can either:
* Click **Credentials** > **New**, then search for **Odoo API**. After selecting **Odoo API**, click **Continue**.
* In an Odoo node, click the **Credential for Odoo API** dropdown, then click **Create new**.
3. Enter your Odoo information:
* **Site URL**: the domain of your Odoo instance.
* **Username**: username as displayed on the user's **Change password** screen in Odoo.
* **Database name**: the name of the Odoo instance.
* **Password or API key**: the credential you created in step one.
4. Click **Save**. n8n tests the key to check it can connect to Odoo.
## Prerequisites

Create an [Odoo](https://www.odoo.com/){:target=_blank .external-link} account, instance, and database.

Refer to the Odoo [Getting Started tutorial](https://www.odoo.com/slides/getting-started-15){:target=_blank .external-link} if you're new to Odoo.

/// note | Required plan type
Access to Odoo's external API is only available on **Custom** Odoo pricing plans. Refer to [Odoo Pricing Plans](https://www.odoo.com/pricing-plan){:target=_blank .external-link} for more information.
///

## Supported authentication methods

- API key or password

Odoo supports both formats, but some Odoo modules require an API key.

## Related resources

Refer to [Odoo's External API documentation](https://www.odoo.com/documentation/17.0/developer/reference/external_api.html){:target=_blank .external-link} for more information about the service.

## Using API key or password

To configure this credential, you'll need:

- Your **Site URL**: The domain of your Odoo instance.
- A **Username**: Your username as displayed on the user's **Change password** screen in Odoo.
- A **Password or API key**: You can use your user password or an API key. Odoo supports both formats, but some Odoo modules require an API key. To generate an API key, go to **Your Profile > Preferences > Account Security > Developer API Keys**. Refer to [Odoo API Keys](https://www.odoo.com/documentation/15.0/developer/reference/external_api.html?#api-keys){:target=_blank .external-link} for more information.
- A **Database name**: The name of the Odoo instance.

19 changes: 16 additions & 3 deletions docs/integrations/builtin/credentials/okta.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,27 @@

# Okta credentials

You can use these credentials to authenticate when using the HTTP Request node to make a [Custom API call](/integrations/custom-operations/).
You can use these credentials to authenticate when using the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to make a [Custom API call](/integrations/custom-operations/).

## Authentication methods
## Prerequisites

n8n supports Okta authentication with an access token.
Create an [Okta free trial](https://www.okta.com/free-trial/){:target=_blank .external-link} or create an admin account on an existing Okta org.

## Supported authentication methods

- SSWS API Access token

## Related resources

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

This is a credential-only node. Refer to [Custom API operations](/integrations/custom-operations/) to learn more. View [example workflows and related content](https://n8n.io/integrations/okta/){:target=_blank .external-link} on n8n's website.

## Using SSWS API access token

To configure this credential, you'll need:

- The **URL**: The base URL of your Okta org, also referred to as your unique subdomain. There are two quick ways to access it:
1. In the Admin Console, select your **Profile**, hover over the domain listed below your username, and select the **Copy** icon. Paste this into n8n, but be sure to add `https://` before it.
2. Copy the base URL of your Admin Console URL, for example `https://dev-123456-admin.okta.com`. Paste it into n8n and remove `-admin`, for example: `https://dev-123456.okta.com`.
- An **SSWS Access Token**: Create a token by going to **Security > API > Tokens > Create token**. Refer to [Create Okta API tokens](https://help.okta.com/en-us/content/topics/security/api.htm?cshid=ext-create-api-token#create-okta-api-token){:target=_blank .external-link} for more information.

Check warning on line 31 in docs/integrations/builtin/credentials/okta.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [from-microsoft.We] Try to avoid using first-person plural like 'us'. Raw Output: {"message": "[from-microsoft.We] Try to avoid using first-person plural like 'us'.", "location": {"path": "docs/integrations/builtin/credentials/okta.md", "range": {"start": {"line": 31, "column": 159}}}, "severity": "WARNING"}
28 changes: 16 additions & 12 deletions docs/integrations/builtin/credentials/onesimpleapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,28 @@ contentType: integration
<!-- Not adding 'Simple' to accept.txt but can't really get away from it here -->
# One Simple API credentials

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

- [One Simple API](/integrations/builtin/app-nodes/n8n-nodes-base.onesimpleapi/)

## Prerequisites

Create a [One Simple API](https://onesimpleapi.com/register) account.
Create a [One Simple API](https://onesimpleapi.com/register){:target=_blank .external-link} account.

## Using an API Token
## Supported authentication methods

1. [Log in](https://onesimpleapi.com/login) to your One Simple API account.
2. Create a new API token on the [API Tokens](https://onesimpleapi.com/user/api-tokens) page.
3. Check the required permissions for your new API token.
4. Click the **Create** button.
5. Copy the API token provided by One Simple API.
![The API token shown on the One Simple API website](/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_website.png)
6. Paste the API token into the API Token field of n8n.
![The API token field in n8n](/_images/integrations/builtin/credentials/onesimpleapi/one_simple_api_n8n_credentials.png)
7. Click the **Save** button.
- API token

## Related resources

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

## Using API token

To configure this credential, you'll need:

- An **API token**: Create a new API token on the [API Tokens](https://onesimpleapi.com/user/api-tokens) page. Be sure you select appropriate permissions for the token.

You can also access the API Tokens page by selecting your **Profile > API Tokens**.

<!-- vale on -->
29 changes: 19 additions & 10 deletions docs/integrations/builtin/credentials/onfleet.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,27 @@ contentType: integration

# Onfleet credentials

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

- [Onfleet](/integrations/builtin/app-nodes/n8n-nodes-base.onfleet/)
- [Onfleet Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.onfleettrigger/)

1. Sign up for Onfleet and create an API key. Refer to Onfleet's documentation for more information:
* [Creating an API key](https://support.onfleet.com/hc/en-us/articles/360045763292-API)
* [Getting started with the Onfleet API](https://docs.onfleet.com/reference#setup-tutorial)
2. In n8n, create a new credential. You can either:
* Click **Credentials** > **New**, then search for **Onfleet API**. After selecting **Onfleet API**, click **Continue**.
* In an Onfleet node, click the **Credential for Onfleet API** dropdown, then click **Create new**.
3. In the **Onfleet account** modal, paste your Onfleet API key into **API key**.
4. By default, this credential is available to both the Onfleet and Onfleet Trigger nodes. You can change this using the settings on the **Details** tab.
5. After entering the key and editing the credential details, click **Save**. n8n tests the key to check it can connect to Onfleet.
## Prerequisites

Create an [Onfleet](https://onfleet.com/){:target=_blank .external-link} administrator account.

# Supported authentication methods

- API key

## Related resources

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

## Using API key

To configure this credential, you'll need:

- An **API key**: To create an API key, log into your organization's administrator account. Select **Settings > API & Webhooks**, then select **+** to create a new key. Refer to Onfleet's [Creating an API key documentation](https://support.onfleet.com/hc/en-us/articles/360045763292-API) for more information.


16 changes: 13 additions & 3 deletions docs/integrations/builtin/credentials/opencti.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,24 @@ description: Documentation for the OpenCTI credentials. Use these credentials to

# OpenCTI credentials

You can use these credentials to authenticate when using the HTTP node to make a [Custom API call](/integrations/custom-operations/).
You can use these credentials to authenticate when using the [HTTP Request node](/integrations/builtin/core-nodes/n8n-nodes-base.httprequest/) to make a [Custom API call](/integrations/custom-operations/).

## Prerequisites

Create an [OpenCTI](https://filigran.io/solutions/open-cti/){:target=_blank .external-link} developer account.

## Authentication methods

n8n supports OpenCTI authentication with an API key.
- API key

## Related resources

Refer to [OpenCTI's documentation](https://docs.opencti.io/5.7.X/deployment/integrations/){:target=_blank .external-link} for more information about the service.
Refer to [OpenCTI's documentation](https://docs.opencti.io/latest/){:target=_blank .external-link} for more information about the service.

This is a credential-only node. Refer to [Custom API operations](/integrations/custom-operations/) to learn more. View [example workflows and related content](https://n8n.io/integrations/opencti/){:target=_blank .external-link} on n8n's website.

## Using API key

To configure this credential, you'll need:

- An **API Key**: To get your API key, go to your **Profile > API access**. Refer to the OpenCTI [Integrations Authentication documentation](https://docs.opencti.io/latest/deployment/integrations/#authentication){:target=_blank .external-link} for more information.
23 changes: 15 additions & 8 deletions docs/integrations/builtin/credentials/openweathermap.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,27 @@ contentType: integration

# OpenWeatherMap credentials

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

- [OpenWeatherMap](/integrations/builtin/app-nodes/n8n-nodes-base.openweathermap/)

## Prerequisites

Create a [OpenWeatherMap](https://openweathermap.org/) account.
Create an [OpenWeatherMap](https://openweathermap.org/){:target=_blank .external-link} account.

## Using Access Token
## Supported authentication methods

1. Access your OpenWeatherMap [account page](https://home.openweathermap.org/api_keys).
2. In the 'Create key' section, type a name and click on the *Generate* button.
3. Copy the API Key that you just generated.
4. Use this API key with your OpenWeatherMap API node credentials in n8n.
- API access token

![Getting OpenWeatherMap API credentials](/_images/integrations/builtin/credentials/openweathermap/using-access-token.gif)
## Related resources

Refer to [OpenWeatherMap's API documentation](https://openweathermap.org/api){:target=_blank .external-link} for more information about the service.

## Using API access token

To configure this credential, you'll need:

- An **Access Token**: When you first sign up for your account, OpenWeatherMap includes an **API Key** (APP Key) in your confirmation email.

To create and view API keys, go to **Account >** [**API Keys**](https://home.openweathermap.org/api_keys){:target=_blank .external-link}.

24 changes: 14 additions & 10 deletions docs/integrations/builtin/credentials/orbit.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,24 +6,28 @@ contentType: integration

# Orbit credentials

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

- [Orbit](/integrations/builtin/app-nodes/n8n-nodes-base.orbit/)

## Prerequisites

Create an [Orbit](https://app.orbit.love/) account.
Create an [Orbit](https://orbit.love/){:target=_blank .external-link} account.

## Using API Token
## Supported authentication methods

1. Access the [Account Settings page](https://app.orbit.love/user/edit).
2. Scroll down to the ***API Token*** section.
3. Click on the ***Copy*** button to copy the API Token.
4. Use this ***API Token*** in with your Orbit node credentials in n8n.
- API token

![Getting Orbit credentials](/_images/integrations/builtin/credentials/orbit/using-api.gif)
## Related resources

## Further Reference
Refer to [Orbit's API documentation](https://orbit.love/docs/developers){:target=_blank .external-link} for more information about the service.

- [Orbit API Documentation](https://www.notion.so/Orbit-API-Documentation-41ed7911e070400b99cfebb296813670#cb4111e0436e420c8c05af078496ff30)
## Using API token

To configure this credential, you'll need:

- An **API Token**: Use either a user API token or a workspace API token.
- Get your user token in **Account Settings > API Token**. Refer to [User API tokens](https://orbit.love/docs/all/api-tokens#623e061e89cd4037bef69fe3a6af0ee5){:target=_blank .external-link} for more information.
- Get a workspace token from your **Workspace Settings > Workspace API Tokens**. Only workspace owners can create workspace tokens. Refer to [Workspace API tokens](https://orbit.love/docs/all/api-tokens#51526766b5394f7e83c0a1fc01543330){:target=_blank .external-link} for more information.

Refer to [Which token type to use](https://orbit.love/docs/all/api-tokens#837393b02e6842a6b31865abde47511a){:target=_blank .external-link} for more information on the two token types.
24 changes: 12 additions & 12 deletions docs/integrations/builtin/credentials/oura.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,26 @@

# Oura credentials

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

- [Oura](/integrations/builtin/app-nodes/n8n-nodes-base.oura/)

## Prerequisites

Create a [Oura](https://www.ouraring.com/) account.
Create an [Oura](https://ouraring.com/developer){:target=_blank .external-link} account.

## Using Access Token
## Supported authentication methods

1. Open the [Personal Access Tokens](https://cloud.ouraring.com/personal-access-tokens) page.
2. On the top-right corner of the page, click on the ***Create A New Personal Access Token*** button.
3. Enter a note for the new Personal Access Token you are about to generate.
4. Click on the ***Create Personal Access Token*** to create the Personal Access Token.
5. Copy the displayed Personal Access Token.
6. Enter a name for your credentials in the ***Credentials Name*** field in the 'Oura API' credentials in n8n.
7. Paste the Personal Access Token in the ***Personal Access Token*** field in the 'Oura API' credentials in n8n.
8. Click on the ***Create*** button to create your credentials.
- API access token

## Related resources

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

- [Oura API Documentation](https://cloud.ouraring.com/docs/authentication)
## Using API access token

To configure this credential, you'll need:

- A **Personal Access Token**: To generate a personal access token, go to the [Personal Access Tokens](https://cloud.ouraring.com/personal-access-tokens){:target=_blank .external-link} page and select **Create A New Personal Access Token**.

Refer to [How to Generate Personal Access Tokens](https://support.ouraring.com/hc/en-us/articles/4415266939155-The-Oura-API#h_01H5B94SP4P9YHG9ZKN1H69E7Z){:target=_blank .external-link} for more information.

Check warning on line 31 in docs/integrations/builtin/credentials/oura.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐶 [from-microsoft.We] Try to avoid using first-person plural like 'us'. Raw Output: {"message": "[from-microsoft.We] Try to avoid using first-person plural like 'us'.", "location": {"path": "docs/integrations/builtin/credentials/oura.md", "range": {"start": {"line": 31, "column": 86}}}, "severity": "WARNING"}
30 changes: 20 additions & 10 deletions docs/integrations/builtin/credentials/paddle.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,32 @@ contentType: integration

# Paddle credentials

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

- [Paddle](/integrations/builtin/app-nodes/n8n-nodes-base.paddle/)

## Prerequisites

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

## Using Access Token
## Supported authentication methods

1. Open your Paddle dashboard.
2. Open the ***Developer Tools*** dropdown list in the sidebar and select ***Authentication***.
3. Enter a name and description in the ***Generate Auth Code*** section and click on ***Generate Key***.
4. Click on the ***Reveal Auth Code*** button to reveal the access token.
5. Use the displayed ***vendor_id*** and ***Auth Code*** with your Paddle API credentials in n8n.
6. Click on the ***Save*** button to save your credentials.
- API access token (Classic)

![Getting Paddle credentials](/_images/integrations/builtin/credentials/paddle/using-access-token.gif)
/// warning | Paddle Classic API
This credential works with Paddle Classic's API. If you joined Paddle after August 2023, you're using the [Paddle Billing API](https://developer.paddle.com/api-reference/overview){:target=_blank .external-link} and this credential may not work for you.
///

## Related resources

Refer to [Paddle Classic's API documentation](https://developer.paddle.com/classic/api-reference/1384a288aca7a-api-reference){:target=_blank .external-link} for more information about the service.

## Using API access token (Classic)

To configure this credential, you'll need:

- A **Vendor Auth Code**: Created when you generate an API key.
- A **Vendor ID**: Displayed when you generate an API key.
- **Use Sandbox Environment API**: When turned on, nodes using this credential will hit the Sandbox API endpoint instead of the live API endpoint.

To generate an auth code and view your Vendor ID, go to **Paddle > Developer Tools > Authentication > Generate Auth Code**. Select **Reveal Auth Code** to display the Auth Code. Refer to [API Authentication](https://developer.paddle.com/classic/api-reference/zg9joji1mzuzotg5-api-authentication){:target=_blank .external-link} for more information.
Loading
Loading