Skip to content
This repository has been archived by the owner on Jul 23, 2020. It is now read-only.

plattform dependent hints for authentication #200

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ for various API calls.

jira-connector supports two forms of authentication:

### Basic Authentication (Deprecated)
### Basic Authentication (Deprecated, Server only)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure that base64 basic auth actual? How I remember all basic auth mechanism is deprecated

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably just mark all basic auth as deprecated?


[Deprecated](https://confluence.atlassian.com/cloud/deprecation-of-basic-authentication-with-passwords-for-jira-and-confluence-apis-972355348.html). It will require you to
provide a username and password each time you connect to the
Expand Down Expand Up @@ -156,6 +156,23 @@ var jira = new JiraClient({
// Base64 encoding of 'SirUserOfName:Password123' (for legacy server version) or 'email:api_token' (jira cloud)
```

You can easily create the base64 encoded string.

Linux/Unix/MacOS:

```bash
echo -n [email protected]:api-token | base64
```

Windows 7 and later:

```powershell
$Text = ‘[email protected]:api-token’
$Bytes = [System.Text.Encoding]::UTF8.GetBytes($Text)
$EncodedText = [Convert]::ToBase64String($Bytes)
$EncodedText
```

### OAuth Authentication

This should be the preferred method of authentication; it is more secure and does not require disclosing
Expand Down