Skip to content

Commit 3e41fdd

Browse files
committed
Add links to docs (#18)
Update readme Fix
1 parent cfc5b30 commit 3e41fdd

File tree

1 file changed

+30
-4
lines changed

1 file changed

+30
-4
lines changed

README.md

Lines changed: 30 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@
55
[![release](https://img.shields.io/github/release-pre/cloudentity/oauth2c.svg)](https://github.com/cloudentity/oauth2c/releases)
66
[![downloads](https://img.shields.io/github/downloads/cloudentity/oauth2c/total)](https://github.com/cloudentity/oauth2c/releases)
77

8-
`oauth2c` provides a simple and intuitive interface that allows developers to quickly and easily experiment with different grant types and client authentication methods.
8+
`oauth2c` is a command-line tool that simplifies the process of experimenting with different grant types and client authentication methods for OAuth 2.0.
99

1010
![demo](https://user-images.githubusercontent.com/909896/176916616-36d803ef-832a-4bd8-ba8d-f6689e31ed22.gif)
1111

1212
## Features
1313

14-
* Supports all modern OAuth 2.0 grant types: authorization code, implicit, password, client credentials, refresh token, jwt bearer
15-
* Supports all client authentication methods: client secret basic, client secret post, client secret jwt, private key jwt, tls client auth
14+
* Simple and intuitive interface for quickly experimenting with different OAuth 2.0 grant types and client authentication methods
15+
* Supports all modern OAuth 2.0 grant types: authorization code, implicit, password, client credentials, refresh token, JWT bearer
16+
* Supports all client authentication methods: client secret basic, client secret post, client secret JWT, private key JWT, TLS client auth
1617

1718
## Installation
1819

@@ -29,7 +30,7 @@ Alternatively, you can download a pre-built binary from the [releases page].
2930

3031
## Usage
3132

32-
To use `oauth2c`, simply run the following command and follow the prompts:
33+
To use `oauth2c`, run the following command and follow the prompts:
3334

3435
``` sh
3536
oauth2c [issuer url] [flags]
@@ -67,6 +68,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
6768
--no-pkce
6869
```
6970

71+
[Learn more about authorization code flow](https://cloudentity.com/developers/basics/oauth-grant-types/authorization-code-flow/)
72+
7073
#### Authorization code + PKCE
7174

7275
The Proof Key for Code Exchange (PKCE) is an extension to the OAuth2 authorization code grant flow that
@@ -93,6 +96,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
9396
--pkce
9497
```
9598

99+
[Learn more about authorization code flow with pkce](https://cloudentity.com/developers/basics/oauth-grant-types/authorization-code-with-pkce/)
100+
96101
#### Implicit
97102

98103
This grant type is similar to the authorization code grant, but the access token is returned directly to
@@ -110,6 +115,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
110115
--scopes openid,email,offline_access
111116
```
112117

118+
[Learn more about implicit flow](https://cloudentity.com/developers/basics/oauth-grant-types/implicit-flow/)
119+
113120
#### Hybrid
114121

115122
To use the OAuth2 hybrid flow to obtain an authorization code and an ID token, the client first sends an authorization request to the OAuth2 provider. The request should include the code and id_token response types.
@@ -130,6 +137,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
130137
--no-pkce
131138
```
132139

140+
[Learn more about the hybrid flow](https://cloudentity.com/developers/basics/oauth-grant-types/hybrid-flow/)
141+
133142
#### Client credentials
134143

135144
This grant type involves the client providing its own credentials (i.e. client ID and client secret) to
@@ -145,6 +154,7 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
145154
--scopes introspect_tokens,revoke_tokens
146155
```
147156

157+
[Learn more about the client credentials flow](https://cloudentity.com/developers/basics/oauth-grant-types/client-credentials-flow/)
148158

149159
#### Refresh token
150160

@@ -161,6 +171,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
161171
--refresh-token 1X1IvWR8p5rgKnH2YNmHGd4pZp8Dq-85xzUQuJejT_g.O_DS8Y4eiTS5jZ47_eBv3VbwP4zQUyxjNVW93AyU82k
162172
```
163173

174+
[Learn more about the refresh token flow](https://cloudentity.com/developers/basics/oauth-grant-types/refresh-token-flow/)
175+
164176
#### Password
165177

166178
This grant type involves the client providing the user's username and password to the OAuth2 server, which
@@ -176,6 +188,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
176188
--scopes openid
177189
```
178190

191+
[Learn more about the password flow](https://cloudentity.com/developers/basics/oauth-grant-types/resource-owner-password-credentials/)
192+
179193
#### JWT Bearer
180194

181195
This grant type involves the client providing a JSON Web Token (JWT) to the OAuth2 server, which then returns
@@ -193,6 +207,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
193207
--assertion '{"sub":"[email protected]"}'
194208
```
195209

210+
[Learn more about the jwt bearer flow](https://cloudentity.com/developers/basics/oauth-grant-types/using-jwt-profile-for-authorization-flows/)
211+
196212
### Auth methods
197213

198214
#### Client Secret Basic
@@ -210,6 +226,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
210226
--scopes introspect_tokens,revoke_tokens
211227
```
212228

229+
[Learn more about client secret basic](https://cloudentity.com/developers/basics/oauth-client-authentication/client-secret-authentication/#process-of-authentication-with-client_secret_basic)
230+
213231
#### Client Secret Post
214232

215233
This client authentication method involves the client sending its client ID and client secret as part of
@@ -226,6 +244,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
226244
--scopes introspect_tokens,revoke_tokens
227245
```
228246

247+
[Learn more about client secret post](https://cloudentity.com/developers/basics/oauth-client-authentication/client-secret-authentication/#process-of-authentication-with-client_secret_post)
248+
229249
#### Client Secret JWT
230250

231251
This client authentication method involves the client signing a JSON Web Token (JWT) using its client secret,
@@ -241,6 +261,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
241261
--scopes introspect_tokens,revoke_tokens
242262
```
243263

264+
[Learn more about client secret jwt](https://cloudentity.com/developers/basics/oauth-client-authentication/client-secret-authentication/#process-of-authentication-with-client_secret_jwt)
265+
244266
#### Private Key JWT
245267

246268
This client authentication method involves the client signing a JSON Web Token (JWT) using its private key,
@@ -256,6 +278,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
256278
--scopes introspect_tokens,revoke_tokens
257279
```
258280

281+
[Learn more about private key jwt](https://cloudentity.com/developers/basics/oauth-client-authentication/private-key-jwt-client-authentication/)
282+
259283
#### TLS Client Auth
260284

261285
This client authentication method involves the client providing its own certificate as part of the TLS
@@ -273,6 +297,8 @@ oauth2c https://oauth2c.us.authz.cloudentity.io/oauth2c/demo \
273297
--scopes introspect_tokens,revoke_tokens
274298
```
275299

300+
[Learn more about tls client auth](https://cloudentity.com/developers/basics/oauth-client-authentication/oauth-mtls-client-authentication/)
301+
276302
## License
277303

278304
`oauth2c` is released under the [Apache v2.0](http://www.apache.org/licenses/LICENSE-2.0).

0 commit comments

Comments
 (0)