Skip to content

Commit e352416

Browse files
committed
(docs) update README with more instructions.
1 parent fa50fd2 commit e352416

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,8 @@ Follow the [installation guide](https://github.com/ankitpokhrel/jira-cli/wiki/In
9191
more [here](https://github.com/ankitpokhrel/jira-cli/discussions/356).
9292
2. Run `jira init`, select installation type as `Cloud`, and provide required details to generate a config file required
9393
for the tool.
94+
3. Run the `jira init`, Select the `Cloud` installation type and then select the `OAuth` authentication type. This will prompt for your Jira App Client ID and Client Secret. You can learn more about how to create a Jira App [here](link-to-a-discussion)
95+
9496

9597
#### On-premise installation
9698

@@ -117,12 +119,13 @@ See [FAQs](https://github.com/ankitpokhrel/jira-cli/discussions/categories/faqs)
117119

118120
#### Authentication types
119121

120-
The tool supports `basic`, `bearer` (Personal Access Token), and `mtls` (Client Certificates) authentication types. Basic auth is used by
122+
The tool supports `basic`, `bearer` (Personal Access Token), `mtls` (Client Certificates), and `oauth` (OAuth 3LO) authentication types. Basic auth is used by
121123
default.
122124

123125
- If you want to use PAT, you need to set `JIRA_AUTH_TYPE` as `bearer`.
124126
- If you want to use `mtls` run `jira init`. Select installation type `Local`, and then select authentication type as `mtls`.
125127
- In case `JIRA_API_TOKEN` variable is set it will be used together with `mtls`.
128+
- If you want to use `oauth` run `jira init`. Select installation type `Cloud`, and then select authentication type as `oauth`.
126129

127130
#### Shell completion
128131

@@ -850,7 +853,7 @@ Sprint 1: 3
850853

851854
- https://jira.atlassian.com/browse/ECO-283
852855
- https://community.developer.atlassian.com/t/oauth-2-0-with-proof-key-for-code-exchange-pkce/80173/3
853-
- The 3LO doesn't support PKCE, to avoid the need for a client secret, so we need to use the legacy auth flow.
856+
- The 3LO doesn't support [Proof Key for Code Exchange (PKCE)](https://oauth.net/2/pkce/). Without this support, we would have to share the single distrubuted app's client secret with all the consumers. To avoid the need for globally sharing a client secret, each consumer will need to create a JIRA app to effectively use as a proxy into your Jira cloud instance.
854857

855858
## Feature requests
856859

0 commit comments

Comments
 (0)