Skip to content

Docs: Remove Key-Cert authentication info #682

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jan 6, 2021
Merged

Docs: Remove Key-Cert authentication info #682

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 3 additions & 38 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,45 +49,10 @@ Add a connection:
username='admin',
password='admin')

Key/Cert Based authentication
-----------------------------
Other authentication methods
----------------------------

Add a connection using key/cert based authentication:

.. code-block:: python

from atlassian import Jira
from atlassian import Confluence
from atlassian import Bitbucket
from atlassian import ServiceDesk
from atlassian import Xray

jira = Jira(
url='http://localhost:8080',
key='/path/to/key',
cert='/path/to/cert')

confluence = Confluence(
url='http://localhost:8090',
key='/path/to/key',
cert='/path/to/cert')

bitbucket = Bitbucket(
url='http://localhost:7990',
key='/path/to/key',
cert='/path/to/cert')

service_desk = ServiceDesk(
url='http://localhost:8080',
key='/path/to/key',
cert='/path/to/cert')

xray = Xray(
url='http://localhost:8080',
key='/path/to/key',
cert='/path/to/cert')

Alternatively OAuth can be used:
Further authentication methods are available. For example OAuth can be used:

.. code-block:: python

Expand Down