Skip to content

Commit 837bac8

Browse files
committed
pointing to code+pkce docs and to token refresh docs in readme
1 parent 4cd99d6 commit 837bac8

File tree

6 files changed

+16
-6
lines changed

6 files changed

+16
-6
lines changed

README.md

+8
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,14 @@ OAuthModule.forRoot({
235235

236236
If you need more versatility, you can look in the [documentation](https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/working-with-httpinterceptors.html) how to setup a custom interceptor.
237237

238+
## Code Flow + PKCE
239+
240+
See docs: https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/code-flow-+-pcke.html
241+
242+
## Token Refresh
243+
244+
See docs: https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/refreshing-a-token.html
245+
238246
## Routing
239247

240248
If you use the ``PathLocationStrategy`` (which is on by default) and have a general catch-all-route (``path: '**'``) you should be fine. Otherwise look up the section ``Routing with the HashStrategy`` in the [documentation](https://manfredsteyer.github.io/angular-oauth2-oidc/docs/).

docs-src/silent-refresh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The last section shows how to automate refreshing for both flows.
66

77
## Refreshing when using Code Flow (not Implicit Flow!)
88

9-
>> For refreshing a token with implicit flow, please see section below!
9+
> For refreshing a token with implicit flow, please see section below!
1010
1111
When using code flow, you can get an ``refresh_token``. While the original standard DOES NOT allow this for SPAs, the mentioned document proposes to ease this limitation. However, it specifies a list of requirements one should take care about before using refresh_tokens. Please make sure you respect those requirements.
1212

docs/additional-documentation/refreshing-a-token.html

-2
Original file line numberDiff line numberDiff line change
@@ -53,10 +53,8 @@ <h1 id="refreshing-a-token">Refreshing a Token</h1>
5353
<p>The last section shows how to automate refreshing for both flows.</p>
5454
<h2 id="refreshing-when-using-code-flow-not-implicit-flow">Refreshing when using Code Flow (not Implicit Flow!)</h2>
5555
<blockquote>
56-
<blockquote>
5756
<p>For refreshing a token with implicit flow, please see section below!</p>
5857
</blockquote>
59-
</blockquote>
6058
<p>When using code flow, you can get an <code>refresh_token</code>. While the original standard DOES NOT allow this for SPAs, the mentioned document proposes to ease this limitation. However, it specifies a list of requirements one should take care about before using refresh_tokens. Please make sure you respect those requirements.</p>
6159
<p>Please also note, that you have to request the <code>offline_access</code> scope to get an refresh token.</p>
6260
<p>To refresh your token, just call the <code>refresh</code> method:</p>

docs/index.html

+4
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,10 @@ <h3 id="calling-a-web-api-with-an-access-token">Calling a Web API with an Access
219219
sendAccessToken: true
220220
}
221221
})</code></pre></div><p>If you need more versatility, you can look in the <a href="https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/working-with-httpinterceptors.html">documentation</a> how to setup a custom interceptor.</p>
222+
<h2 id="code-flow--pkce">Code Flow + PKCE</h2>
223+
<p>See docs: <a href="https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/code-flow-+-pcke.html">https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/code-flow-+-pcke.html</a></p>
224+
<h2 id="token-refresh">Token Refresh</h2>
225+
<p>See docs: <a href="https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/refreshing-a-token.html">https://manfredsteyer.github.io/angular-oauth2-oidc/docs/additional-documentation/refreshing-a-token.html</a></p>
222226
<h2 id="routing">Routing</h2>
223227
<p>If you use the <code>PathLocationStrategy</code> (which is on by default) and have a general catch-all-route (<code>path: &#39;**&#39;</code>) you should be fine. Otherwise look up the section <code>Routing with the HashStrategy</code> in the <a href="https://manfredsteyer.github.io/angular-oauth2-oidc/docs/">documentation</a>.</p>
224228
<h2 id="more-documentation-">More Documentation (!)</h2>

docs/js/search/search_index.js

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

projects/lib/package.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"author": {
55
"name": "Manfred Steyer"
66
},
7-
"version": "8.0.0",
7+
"version": "8.0.1",
88
"repository": "manfredsteyer/angular-oauth2-oidc",
99
"dependencies": {
1010
"jsrsasign": "^8.0.12"

0 commit comments

Comments
 (0)