diff --git a/docs/_images/integrations/builtin/credentials/quickbase/using-api.gif b/docs/_images/integrations/builtin/credentials/quickbase/using-api.gif deleted file mode 100644 index dee2dd861..000000000 Binary files a/docs/_images/integrations/builtin/credentials/quickbase/using-api.gif and /dev/null differ diff --git a/docs/integrations/builtin/credentials/postgres.md b/docs/integrations/builtin/credentials/postgres.md index 6ab719f2d..5ce6d7739 100644 --- a/docs/integrations/builtin/credentials/postgres.md +++ b/docs/integrations/builtin/credentials/postgres.md @@ -42,7 +42,7 @@ To configure this credential, you'll need: - **Require**: Sets the `ssl-mode` parameter to `require`. 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. -- The **Port**: The port number to use for the connection. +- The **Port**: Enter the port number to use for the connection. - **SSH Tunnel**: If turned on, the credential uses SSH to encrypt the network connection with the Postgres server. Refer to [Using SSH tunnel](#using-ssh-tunnel) for more information. Refer to [Connection Strings](https://www.postgresql.org/docs/16/libpq-connect.html#LIBPQ-CONNSTRING){:target=_blank .external-link} for more information on finding and formatting these fields. diff --git a/docs/integrations/builtin/credentials/qdrant.md b/docs/integrations/builtin/credentials/qdrant.md index 556ab4606..c5de97fdf 100644 --- a/docs/integrations/builtin/credentials/qdrant.md +++ b/docs/integrations/builtin/credentials/qdrant.md @@ -12,12 +12,21 @@ You can use these credentials to authenticate the following nodes: ## Prerequisites -You need an API key and Qdrant cluster URL to establish a connection. +Create a [Qdrant cluster](https://qdrant.tech/documentation/cloud/create-cluster/){:target=_blank .external-link}. -Refer to [Qdrant's authentication docs](https://qdrant.tech/documentation/cloud/authentication/#authentication){:target=_blank .external-link} for guidance on getting your key and URL. +## Supported authentication methods + +- API key ## Related resources -Refer to [Qdrant's documentation](https://qdrant.tech/documentation/){:target=_blank .external-link} +Refer to [Qdrant's documentation](https://qdrant.tech/documentation/){:target=_blank .external-link} for more information. --8<-- "_snippets/integrations/builtin/cluster-nodes/langchain-overview-link.md" + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: Create an API key from your **Cloud Dashboard > Access Management**. Refer to [Qdrant's authentication documentation](https://qdrant.tech/documentation/cloud/authentication/){:target=_blank .external-link} for more information. +- A **Qdrant URL**: The URL for your Qdrant cluster. Refer to [Qdrant Web UI](https://qdrant.tech/documentation/interfaces/web-ui/){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/qradar.md b/docs/integrations/builtin/credentials/qradar.md index c60157536..a52981f5c 100644 --- a/docs/integrations/builtin/credentials/qradar.md +++ b/docs/integrations/builtin/credentials/qradar.md @@ -5,14 +5,24 @@ description: Documentation for the QRadar credentials. Use these credentials to # QRadar 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 QRadar authentication with an API key. +Create a [Qradar](https://www.ibm.com/qradar){:target=_blank .external-link} account. + +## Supported authentication methods + +- API key ## Related resources Refer to [QRadar's documentation](https://ibmsecuritydocs.github.io/qradar_api_overview/){: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/qradar/){:target=_blank .external-link} on n8n's website. + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: Also known as an authorized service token. Use the **Manage Authorized Services** window on the **Admin** tab to create an authentication token. Refer to [Creating an authentication token](https://www.ibm.com/docs/en/qradar-common?topic=forwarding-creating-authentication-token){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/qualys.md b/docs/integrations/builtin/credentials/qualys.md index 98ca223e4..bd4055bf6 100644 --- a/docs/integrations/builtin/credentials/qualys.md +++ b/docs/integrations/builtin/credentials/qualys.md @@ -5,14 +5,26 @@ description: Documentation for the Qualys credentials. Use these credentials to # Qualys 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 Qualys authentication with username and password. +Create a [Qualys](https://www.qualys.com/){:target=_blank .external-link} user account with any user role except Contact. + +## Supported authentication methods + +- Basic auth ## Related resources Refer to [Qualys's documentation](https://qualysguard.qg2.apps.qualys.com/qwebhelp/fo_portal/api_doc/index.htm){: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/qualys/){:target=_blank .external-link} on n8n's website. + +## Using basic auth + +To configure this credential, you'll need: + +- A **Username** +- A **Password** +- A **Requested With** string: Enter a user description, like a user agent, or keep the default `n8n application`. This sets the required `X-Requested-With` header. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/questdb.md b/docs/integrations/builtin/credentials/questdb.md index fb7687f47..3293bc715 100644 --- a/docs/integrations/builtin/credentials/questdb.md +++ b/docs/integrations/builtin/credentials/questdb.md @@ -6,16 +6,36 @@ contentType: integration # QuestDB credentials -You can use these credentials to authenticate the following nodes with QuestDB. +You can use these credentials to authenticate the following nodes: - [QuestDB](/integrations/builtin/app-nodes/n8n-nodes-base.questdb/) ## Prerequisites -An available instance of QuestDB. +Create a user account on an instance of [QuestDB](https://questdb.io/){:target=_blank .external-link}. -## Using Database Connection +## Supported authentication methods -1. Retrieve your QuestDB credentials and connection parameters. -2. Use the credentials and connection parameters with your QuestDB node credentials in n8n. +- Database connection +## Related resources + +Refer to [QuestDB's documentation](https://questdb.io/docs){:target=_blank .external-link} for more information about the service. + +## Using database connection + +To configure this credential, you'll need: + +- The **Host**: Enter the host name or IP address for the server. +- The **Database**: Enter the database name, for example `qdb`. +- A **User**: Enter the username for the user account as configured in `pg.user` or `pg.readonly.user` property in `server.conf`. Default value is `admin`. +- A **Password**: Enter the password for the user account as configured in `pg.password` or `pg.readonly.password` property in `server.conf`. Default value is `quest`. +- **SSL**: Select whether the connection should use SSL, which sets the `sslmode` parameter. Options include: + - **Allow** + - **Disable** + - **Require** + - **Verify** + - **Verify-Full** +- The **Port**: Enter the port number to use for the connection. Default is `8812`. + +Refer to [List of supported connection properties](https://questdb.io/docs/reference/api/postgres/#list-of-supported-connection-properties){:target=_blank .external-link} for more information. \ No newline at end of file diff --git a/docs/integrations/builtin/credentials/quickbase.md b/docs/integrations/builtin/credentials/quickbase.md index 1458de582..9ffcdbe65 100644 --- a/docs/integrations/builtin/credentials/quickbase.md +++ b/docs/integrations/builtin/credentials/quickbase.md @@ -6,29 +6,26 @@ contentType: integration # Quick Base credentials -You can use these credentials to authenticate the following nodes with Quick Base. +You can use these credentials to authenticate the following nodes: - [Quick Base](/integrations/builtin/app-nodes/n8n-nodes-base.quickbase/) ## Prerequisites -Create a [Quick Base](https://www.quickbase.com/) account. +Create a [Quick Base](https://www.quickbase.com/){:target=_blank .external-link} account. -## Using API +## Supported authentication methods -1. Access your Quick Base dashboard. -2. Click on your name on the top right and select 'My preferences' from the dropdown list. -3. Click on ***Manage my user tokens*** under the ***My User Information*** section. -4. Click on the ***+ New user token*** button. -5. Enter a name in the ***Name*** field. -6. Select an app from the ***Assign token to apps*** dropdown list. -7. Click on the ***Save*** button. -8. Copy the string of characters located between `https://` and `/db` in your Quick Base URL. This string is the hostname. -9. Use this ***Hostname*** and ***User Token*** with your Quick Base node credentials in n8n. +- API key -![Getting Quick Base credentials](/_images/integrations/builtin/credentials/quickbase/using-api.gif) +## Related resources -## Further Reference +Refer to [Quick Base's API documentation](https://developer.quickbase.com/auth/){:target=_blank .external-link} for more information about the service. -- [Quick Base API Portal](https://developer.quickbase.com/auth) +## Using API key + +To configure this credential, you'll need: + +- A **Hostname**: The string of characters located between `https://` and `/db` in your Quick Base URL. +- A **User Token**: To generate a token, select your **Profile > My preferences > My User Information > Manage my user tokens**. Refer to [Creating and using user tokens](https://helpv2.quickbase.com/hc/en-us/articles/4570374095124-Creating-and-using-user-tokens){:target=_blank .external-link} for detailed instructions. diff --git a/docs/integrations/builtin/credentials/quickbooks.md b/docs/integrations/builtin/credentials/quickbooks.md index c794d7a77..ac08638d3 100644 --- a/docs/integrations/builtin/credentials/quickbooks.md +++ b/docs/integrations/builtin/credentials/quickbooks.md @@ -6,45 +6,40 @@ contentType: integration # QuickBooks credentials -You can use these credentials to authenticate the following nodes with QuickBooks. +You can use these credentials to authenticate the following nodes: - [QuickBooks](/integrations/builtin/app-nodes/n8n-nodes-base.quickbooks/) ## Prerequisites -Create a [Intuit developer](https://developer.intuit.com/) account. +Create an [Intuit developer](https://developer.intuit.com/){:target=_blank .external-link} account. -## Using OAuth +## Supported authentication methods - +- OAuth2 -1. Open the Intuit Developer [dashboard](https://developer.intuit.com/app/developer/dashboard) page. -2. Click on the ***+ Create an app*** button. -3. Select the ***QuickBooks Online and Payments*** platform. -4. Enter the name of the app in the ***What's your app name?*** field. -5. Select the required scopes under the ***Select Scope*** section. -6. Click on the ***Create app*** button. -7. Click on ***Keys & OAuth*** under the ***Development*** section. -8. Scroll down to the ***Redirect URIs*** section and click on the ***Add URI*** button. -9. Copy the 'OAuth Callback URL' provided in the 'QuickBooks OAuth2 API' credentials in n8n. -10. Paste the URL in the ***Link*** field. -11. Click on the ***Save*** button. -12. Copy the displayed ***Client ID***. -13. Enter a name for your credentials in the ***Credentials Name*** field in the 'QuickBooks OAuth2 API' credentials in n8n. -14. Paste the client ID in the ***Client ID*** field in the 'QuickBooks OAuth2 API' credentials in n8n. -15. Copy the displayed ***Client Secret*** from the Keys page. -16. Paste the client secret in the ***Client Secret*** field in the 'QuickBooks OAuth2 API' credentials in n8n. -17. Select 'Sandbox' from the ***Environment*** dropdown list in the 'QuickBooks OAuth2 API' credentials in n8n. -18. Click on the circle button in the OAuth section to connect a QuickBooks account to n8n. -19. Click the ***Save*** button to save your credentials in n8n. +## Related resources -**Note:** To build the application in production, you will have to fulfill all the requirements mentioned by Intuit. You can learn more on Intuit's [documentation](https://developer.intuit.com/app/developer/qbo/docs/go-live). +Refer to [Intuit's API documentation](https://developer.intuit.com/app/developer/qbo/docs/develop){:target=_blank .external-link} for more information about the service. -The following video demonstrates the steps mentioned above. +## Using OAuth2 -
- -
+To configure this credential, you'll need: +- A **Client ID**: Generated when you create an app. +- A **Client Secret**: Generated when you create an app. +- An **Environment**: Select whether this credential should access your **Production** or **Sandbox** environment. + +To generate your **Client ID** and **Client Secret**, [create an app](https://developer.intuit.com/app/developer/qbo/docs/get-started/start-developing-your-app#create-an-app){:target=_blank .external-link}. + +Use these settings when creating your app: + +- Select appropriate scopes for your app. Refer to [Learn about scopes](https://developer.intuit.com/app/developer/qbo/docs/learn/scopes){:target=_blank .external-link} for more information. +- Enter the **OAuth Redirect URL** from n8n as a **Redirect URI** in the app's **Development > Keys & OAuth** section. +- Copy the **Client ID** and **Client Secret** from the app's **Development > Keys & OAuth** section to enter in n8n. Refer to [Get the Client ID and Client Secret for your app](https://developer.intuit.com/app/developer/qbo/docs/get-started/get-client-id-and-client-secret){:target=_blank .external-link} for more information. + +Refer to Intuit's [Set up OAuth 2.0 documentation](https://developer.intuit.com/app/developer/qbo/docs/develop/authentication-and-authorization/oauth-2.0){:target=_blank .external-link} for more information on the entire process. + +/// note | Environment selection +If you're creating a new app from scratch, start with the **Sandbox** environment. Production apps need to fulfill all Intuit's requirements. Refer to Intuit's [Publish your app documentation](https://developer.intuit.com/app/developer/qbo/docs/go-live/publish-app){:target=_blank .external-link} for more information. +/// \ No newline at end of file