Skip to content

Commit a12997a

Browse files
Updated docs with key/cert authentication
Added key/cert authentication to documentation
1 parent 340d496 commit a12997a

File tree

1 file changed

+34
-1
lines changed

1 file changed

+34
-1
lines changed

docs/index.rst

Lines changed: 34 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,39 @@ Add a connection:
4242
url='http://localhost:8080',
4343
username='admin',
4444
password='admin')
45+
46+
47+
Key/Cert Based authentication
48+
-----------------------------
49+
50+
Add a connection using key/cert based authentication:
51+
52+
.. code-block:: python
53+
54+
from atlassian import Jira
55+
from atlassian import Confluence
56+
from atlassian import Bitbucket
57+
from atlassian import ServiceDesk
58+
59+
jira = Jira(
60+
url='http://localhost:8080',
61+
key='/path/to/key',
62+
cert='/path/to/cert')
63+
64+
confluence = Confluence(
65+
url='http://localhost:8090',
66+
key='/path/to/key',
67+
cert='/path/to/cert')
68+
69+
bitbucket = Bitbucket(
70+
url='http://localhost:7990',
71+
key='/path/to/key',
72+
cert='/path/to/cert')
73+
74+
service_desk = ServiceDesk(
75+
url='http://localhost:8080',
76+
key='/path/to/key',
77+
cert='/path/to/cert')
4578
4679
.. toctree::
4780
:maxdept:2
@@ -62,4 +95,4 @@ Add a connection:
6295
:alt: License
6396
.. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/c822908f507544fe98ae37b25518ae3d
6497
:target: https://www.codacy.com/project/gonchik/atlassian-python-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AstroMatt/atlassian-python-api&utm_campaign=Badge_Grade_Dashboard
65-
:alt: Codacy Badge
98+
:alt: Codacy Badge

0 commit comments

Comments
 (0)