diff --git a/docs/_images/integrations/builtin/credentials/jotform/using-access-token.gif b/docs/_images/integrations/builtin/credentials/jotform/using-access-token.gif deleted file mode 100644 index d3ecde55f..000000000 Binary files a/docs/_images/integrations/builtin/credentials/jotform/using-access-token.gif and /dev/null differ diff --git a/docs/integrations/builtin/credentials/jenkins.md b/docs/integrations/builtin/credentials/jenkins.md index 03ff1a902..bb5150224 100644 --- a/docs/integrations/builtin/credentials/jenkins.md +++ b/docs/integrations/builtin/credentials/jenkins.md @@ -6,20 +6,30 @@ contentType: integration # Jenkins credentials -You can use these credentials to authenticate the following nodes with CircleCI. +You can use these credentials to authenticate the following nodes: - [Jenkins](/integrations/builtin/app-nodes/n8n-nodes-base.jenkins/) ## Prerequisites -Create an account on a [Jenkins](https://www.jenkins.io/) instance. +Create an account on a [Jenkins](https://www.jenkins.io/){:target=_blank .external-link} instance. -## Using Access Token +## Supported authentication methods -1. Access your Jenkins User. -2. Visit the *Configure* section. -3. Click on the *Add new Token* button. -4. Type in a name for your token and click on the *Generate* button. -5. Copy the generated API Token and use it with your Jenkins API node credentials in n8n. +- API token + +## Related resources + +Jenkins doesn't provide public API documentation; API documentation for each page is available from the user interface in the bottom right. Refer to those detailed pages for more information about the service. Refer to [Jenkins Remote Access API](https://www.jenkins.io/doc/book/using/remote-access-api/){:target=_blank .external-link} for information on the API and API wrappers. + +## Using API token + +To configure this credential, you'll need: + +- The **Jenkins Username**: For the user whom the token belongs to +- A **Personal API Token**: Generate this from the user's **profile details > Configure > Add new token**. Refer to [these Stack Overflow instructions](https://stackoverflow.com/questions/45466090/how-to-get-the-api-token-for-jenkins){:target=_blank .external-link} for more detail. +- The **Jenkins Instance URL** + +Jenkins rebuilt their API token setup in 2018. If you're working with an older Jenkins instance, be sure you're using a non-legacy API token. Refer to [Security Hardening: New API token system in Jenkins 2.129+](https://www.jenkins.io/blog/2018/07/02/new-api-token-system/){:target=_blank .external-link} for more information. diff --git a/docs/integrations/builtin/credentials/jira.md b/docs/integrations/builtin/credentials/jira.md index d33971dd7..4fb9791ba 100644 --- a/docs/integrations/builtin/credentials/jira.md +++ b/docs/integrations/builtin/credentials/jira.md @@ -6,22 +6,37 @@ contentType: integration # Jira credentials -You can use these credentials to authenticate the following nodes with Jira. +You can use these credentials to authenticate the following nodes: - [Jira](/integrations/builtin/app-nodes/n8n-nodes-base.jira/) - [Jira Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.jiratrigger/) ## Prerequisites -Create a [Jira](https://www.JIRA.com/) account. +Create a [Jira](https://www.atlassian.com/software/jira){:target=_blank .external-link} Software Cloud or Server account. -## Using Access Token +## Supported authentication methods -1. Access your Jira dashboard. -2. Select on your user icon in the top right. -3. Select **Manage account**. -4. Select the**Security** tab. -5. Select **Create and manage API tokens**. -6. Create API token. -7. Use the API token in the Jira node credentials in n8n, along with the email address and Jira domain. +- SW Cloud API token: For use with Jira Software Cloud +- SW Server account: For use with Jira Software Server + +## Related resources + +Refer to [Jira's API documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#about){:target=_blank .external-link} for more information about the service. + +## Using SW Cloud API token + +To configure this credential, you'll need: + +- The **Email** address associated with your Jira account +- An **API Token**: Refer to [Manage API tokens for your Atlassian account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/){:target=_blank .external-link} for instructions to create an API token. +- The **Domain** you access Jira on + +## Using SW Server account + +To configure this credential, you'll need: + +- The **Email** address associated with your Jira account +- A **Password** for that account +- The **Domain** you access Jira on diff --git a/docs/integrations/builtin/credentials/jotform.md b/docs/integrations/builtin/credentials/jotform.md index 2d179ad4b..48e07e462 100644 --- a/docs/integrations/builtin/credentials/jotform.md +++ b/docs/integrations/builtin/credentials/jotform.md @@ -6,23 +6,29 @@ contentType: integration # JotForm credentials -You can use these credentials to authenticate the following nodes with JotForm. +You can use these credentials to authenticate the following nodes: - [JotForm Trigger](/integrations/builtin/trigger-nodes/n8n-nodes-base.jotformtrigger/) ## Prerequisites -Create a [JotForm](https://www.jotform.com/) account. +Create a [JotForm](https://www.jotform.com/){:target=_blank .external-link} account. -## Using Access Token +## Supported authentication methods -1. Access your [JotForm account](https://www.jotform.com/myaccount/). -2. Click on the ***API*** tab on the left. -3. Click on the ***Create New Key*** button. -4. Change the Permissions to 'Full Access'. -5. Use the key in the JotForm credentials in n8n: paste it in the ***API Key*** field. +- API key -If you have problems retrieving the list of your forms, try to select one of the other options in the ***API Domain*** parameter. +## Related resources -![Getting JotForm credentials](/_images/integrations/builtin/credentials/jotform/using-access-token.gif) +Refer to [JotForm's API documentation](https://api.jotform.com/docs/){:target=_blank .external-link} for more information about the service. + +## Using API key + +To configure this credential, you'll need: + +- An **API Key**: Get an API key from the [API section](https://www.jotform.com/myaccount/api){:target=_blank .external-link} of **My Account**. Refer to [Jotform API Getting Started](https://api.jotform.com/docs/#gettingstarted) for detailed instructions. +- The **API Domain**: This determines which base URL is used for the API. The domain selected needs to match the forms you're working with. Options include: + - `api.jotform.com`: The default base URL. + - `eu-api.jotform.com`: Used by Jotform [EU Safe Forms](https://www.jotform.com/eu-safe-forms/){:target=_blank .external-link}. + - `hipaa-api.jotform.com`: Used by JotForm [HIPAA forms](https://www.jotform.com/hipaa/){:target=_blank .external-link}. diff --git a/docs/integrations/builtin/credentials/jwt.md b/docs/integrations/builtin/credentials/jwt.md index 0cc8ce7f3..14c794c54 100644 --- a/docs/integrations/builtin/credentials/jwt.md +++ b/docs/integrations/builtin/credentials/jwt.md @@ -7,18 +7,51 @@ description: Documentation for the JWT credentials. Use these credentials to aut You can use these credentials to authenticate the following nodes: -[JWT](/integrations/builtin/core-nodes/n8n-nodes-base.jwt/) +- [JWT](/integrations/builtin/core-nodes/n8n-nodes-base.jwt/) ## Supported authentication methods -You can use a passphrase or a PEM key. +- Passphrase: Signed with a secret with HMAC algorithm +- Private key (PEM key): For use with [Private Key JWT](https://auth0.com/docs/get-started/authentication-and-authorization-flow/authenticate-with-private-key-jwt){:target=_blank .external-link} with RSA or ECDSA algorithm ## Related resources -Refer to the [JWT website](https://jwt.io/introduction){:target=_blank .external-link} for more information about working with JWTs. +Refer to the [JSON Web Token spec](https://datatracker.ietf.org/doc/html/rfc7519){:target=_blank .external-link} for more details. +For a more verbose introduction, refer to the [JWT website Introduction to JSON Web Tokens](https://jwt.io/introduction){:target=_blank .external-link}. Refer to [JSON Web Token (JWT) Signing Algorithms Overview](https://auth0.com/blog/json-web-token-signing-algorithms-overview/){:target=_blank .external-link} for more information on selecting between the two types and the algorithms involved. +## Using Passphrase +To configure this credential, select the **Key Type** of **Passphrase**: +- **Key Type**: **Passphrase** +- The Passphrase **Secret** +- Select the **Algorithm** used to sign the assertion. Refer to [Available algorithms](#available-algorithms) below for a list of supported algorithms. +## Using private key (PEM key) + +To configure this credential, select the **Key Type** of **PEM Key**: + +- **Key Type**: **PEM** +- A **Private Key**: Obtained from generating a Key Pair. Refer to [Generate RSA Key Pair](https://auth0.com/docs/secure/application-credentials/generate-rsa-key-pair){:target=_blank .external-link} for an example. +- A **Public Key**: Obtained from generating a Key Pair. Refer to [Generate RSA Key Pair](https://auth0.com/docs/secure/application-credentials/generate-rsa-key-pair){:target=_blank .external-link} for an example. +- Select the **Algorithm** used to sign the assertion. Refer to [Available algorithms](#available-algorithms) below for a list of supported algorithms. + +## Available algorithms + +This n8n credential supports the following algorithms: + +- `HS256` +- `HS384` +- `HS512` +- `RS256` +- `RS384` +- `RS512` +- `ES256` +- `ES384` +- `ES512` +- `PS256` +- `PS384` +- `PS512` +- `none`