Skip to content

Commit

Permalink
add oauth docs for jira (#1898)
Browse files Browse the repository at this point in the history
* add oauth docs for jira

* Update default-settings.jsx
  • Loading branch information
hadar-co authored Dec 30, 2024
1 parent 3ccb810 commit 2bf2c3e
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import Tabs from "@theme/Tabs"
import TabItem from "@theme/TabItem"
import Prerequisites from "/docs/build-your-software-catalog/sync-data-to-catalog/templates/\_ocean_helm_prerequisites_block.mdx"
import OceanSaasInstallation from "/docs/build-your-software-catalog/sync-data-to-catalog/templates/_ocean_saas_installation.mdx"
import OceanSaasInstallation from "/docs/build-your-software-catalog/sync-data-to-catalog/templates/_ocean_saas_installation_oauth.mdx"
import AdvancedConfig from '/docs/generalTemplates/\_ocean_advanced_configuration_note.md'
import AzurePremise from "/docs/build-your-software-catalog/sync-data-to-catalog/templates/\_ocean_azure_premise.mdx"
import DockerParameters from "/docs/build-your-software-catalog/sync-data-to-catalog/project-management/jira/_jira_one_time_docker_parameters.mdx"
Expand Down Expand Up @@ -54,7 +54,7 @@ Choose one of the following installation methods:

<TabItem value="hosted-by-port" label="Hosted by Port" default>

<OceanSaasInstallation />
<OceanSaasInstallation integration="Jira" />

</TabItem>

Expand Down Expand Up @@ -481,9 +481,12 @@ That's it! Now Jira API responses will include the `emailAddress` field when ret
All of the steps outlined here are also available in [Jira's documentation](https://support.atlassian.com/user-management/docs/verify-a-domain-to-manage-accounts/)
:::

<!-- ### OAuth account password change
### OAuth account password change

If the password of the account used to authenticate with Jira changes, the integration will need to be **reinstalled**. This is because the Jira API requires the use of an API token for authentication, and the token is generated using the account's password. -->
When installing the integration [via OAuth](/build-your-software-catalog/sync-data-to-catalog/project-management/jira/?oauth=oauth#setup):

If the password of the account used to authenticate with Jira changes, the integration will need to be **reinstalled**.
This is because the Jira API requires the use of an API token for authentication, and the token is generated using the account's password.

## Examples

Expand Down
2 changes: 1 addition & 1 deletion src/components/ocean-saas-specifics/default-settings.jsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import Markdown from "@theme/Markdown";

const defaultSettings = {
Jira:
'- `Resync interval`: Every 1 hour.' + '\n\n' +
'- `Resync interval`: Every 2 hours.' + '\n\n' +
'- `Send raw data examples`: Enabled.',
GitLab:
'- `Resync interval`: Every 2 hours.' + '\n\n' +
Expand Down

0 comments on commit 2bf2c3e

Please sign in to comment.