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

Introduce confluence api token option #992

Merged
merged 3 commits into from
Jun 27, 2024
Merged

Conversation

jdknight
Copy link
Member

The following introduces the option confluence_api_token to this extension. The goal is somewhat of a replacement of the option confluence_server_pass. For Confluence Cloud, API tokens are required for authentication. For Confluence Data Center, PATs are preferred although there may be some level of support for passwords.

The option confluence_server_pass was one of the original options introduced by this extension. Over the years there has been a transition towards tokens, so a rename may be best. Specifically, there seem to be cases where people place API tokens in the personal access token (PAT) option but should have been under the "pass" option. Having the option explicitly say "API token" should provide some clarify.

Note that confluence_api_token should be functionally the same as using confluence_server_pass, so existing environments should not require any immediate changes. Over time, confluence_server_pass may be deprecated.

The following introduces the option `confluence_api_token` to this
extension. The goal is somewhat of a replacement of the option
`confluence_server_pass`. For Confluence Cloud, API tokens are required
for authentication. For Confluence Data Center, PATs are preferred
although there may be some level of support for passwords.

The option `confluence_server_pass` was one of the original options
introduced by this extension. Over the years there has been a transition
towards tokens, so a rename may be best. Specifically, there seem to be
cases where people place API tokens in the personal access token (PAT)
option but should have been under the "pass" option. Having the option
explicitly say "API token" should provide some clarify.

Note that `confluence_api_token` should be functionally the same as
using `confluence_server_pass`, so existing environments should not
require any immediate changes. Over time, `confluence_server_pass` may
be deprecated.

Signed-off-by: James Knight <james.d.knight@live.com>
Signed-off-by: James Knight <james.d.knight@live.com>
Signed-off-by: James Knight <james.d.knight@live.com>
@jdknight jdknight merged commit 0c9d23b into main Jun 27, 2024
29 checks passed
@jdknight jdknight deleted the introduce-api-token-cfg-option branch June 27, 2024 04:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant