Skip to content

Commit

Permalink
JWT and OAuth auths removed (#284)
Browse files Browse the repository at this point in the history
* JWT and OAuth auths removed

* XOR3 added

* unit tests fixed

* build fixed
  • Loading branch information
MrRefactoring authored Oct 11, 2023
1 parent 909d0be commit 454b032
Show file tree
Hide file tree
Showing 13 changed files with 71 additions and 369 deletions.
37 changes: 0 additions & 37 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,7 @@ Usability, consistency, and performance are key focuses of jira.js, and it also
- [Usage](#usage)
- [Authentication](#authentication)
- [Basic](#basic-authentication)
- [OAuth](#oauth)
- [OAuth 2.0](#oauth-20)
- [JWT](#jwt)
- [Personal access token](#personal-access-token)
- [Example and using algorithm](#example-and-using-algorithm)
- [Decreasing Webpack bundle size](#decreasing-webpack-bundle-size)
Expand Down Expand Up @@ -144,24 +142,6 @@ const client = new Version3Client({
});
```

##### [OAuth](https://developer.atlassian.com/cloud/jira/platform/jira-rest-api-oauth-authentication/)

```typescript
import { Version3Client } from 'jira.js';

const client = new Version3Client({
host: 'https://your-domain.atlassian.net',
authentication: {
oauth: {
consumerKey: 'your consumer key',
consumerSecret: '-----BEGIN RSA PRIVATE KEY-----\n" + "some private key\n" + "-----END RSA PRIVATE KEY-----',
accessToken: 'your access token',
tokenSecret: 'your token secret',
},
},
});
```

##### [OAuth 2.0](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/)

Only the authorization token is currently supported. To release it, you need to read the [documentation](https://developer.atlassian.com/cloud/jira/platform/oauth-2-3lo-apps/) and write your own code to get the token.
Expand All @@ -181,23 +161,6 @@ const client = new Version3Client({
});
```

##### [JWT](https://developer.atlassian.com/cloud/jira/platform/understanding-jwt-for-connect-apps/)

```typescript
import { Version3Client } from 'jira.js';

const client = new Version3Client({
host: 'https://your-domain.atlassian.net',
authentication: {
jwt: {
issuer: 'ISSUER',
secret: 'shhhh',
expiryTimeSeconds: 180,
},
},
});
```

##### [Personal access token](https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.html)

```typescript
Expand Down
Loading

0 comments on commit 454b032

Please sign in to comment.