Skip to content

Commit

Permalink
Clarify Jira auth.
Browse files Browse the repository at this point in the history
  • Loading branch information
jertel authored Dec 9, 2022
1 parent 89d7053 commit 94f7e8c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/source/ruletypes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2449,13 +2449,13 @@ This alert requires four additional options:

For an example Jira account file, see ``examples/rules/jira_acct.yaml``. The account file is a YAML formatted file.

When using user/password authentication, the Jira account file must contain two fields:
When using user/password authentication, or when using Jira Cloud the Jira account file must contain two fields:

``user``: The username to authenticate with Jira.

``password``: The password to authenticate with Jira.
``password``: The password to authenticate with Jira. Jira cloud users must specify the Jira Cloud API token for this value.

When using a Personal Access Token, the Jira account file must contain a single field:
When using a Personal Access Token, such as when using a locally hosted Jira installation, the Jira account file must contain a single field:

``apikey``: The Personal Access Token for authenticating with Jira.

Expand Down

0 comments on commit 94f7e8c

Please sign in to comment.