Skip to content

Commit 3d80963

Browse files
committed
Add documentation for OpenID Connect
1 parent ebe3d7e commit 3d80963

File tree

1 file changed

+47
-1
lines changed

1 file changed

+47
-1
lines changed

index.html

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,9 @@
4343
<h1 id="introduction">Introduction</h1>
4444
<p>
4545
Create AngularJS apps that connects to any OAuth 2.0 server using the client side
46-
flow (aka <a href="http://tools.ietf.org/html/rfc6749#section-1.3.2" target="_blank">OAuth 2.0 Implicit Grant</a>)
46+
flow (aka <a href="http://tools.ietf.org/html/rfc6749#section-1.3.2" target="_blank">OAuth 2.0 Implicit Grant</a>).
47+
In addition, <a href="http://openid.net/specs/openid-connect-core-1_0.html#ImplicitFlowAuth" target="_blank">OpenID Connect Implicit Flow</a>
48+
is also supported.
4749
</p>
4850
</div>
4951
</section>
@@ -402,6 +404,16 @@ <h1 id="configurations">Configurations</h1>
402404
Registered Client ID.
403405
</td>
404406
</tr>
407+
<tr>
408+
<td class="parameter">
409+
<span>response-type</span>
410+
<span class="info">required</span>
411+
</td>
412+
<td>
413+
Default to <code>token</code>, which is for OAuth 2.0 implicit grant type. To use OpenID Connect Implicit Flow,
414+
use <code>id_token</code> (to get id_token only) or <code>id_token token</code> (to get both id_token and access_token)
415+
</td>
416+
</tr>
405417
<tr>
406418
<td class="parameter">
407419
<span>redirect-uri</span>
@@ -418,6 +430,7 @@ <h1 id="configurations">Configurations</h1>
418430
</td>
419431
<td>
420432
Application privileges to be requested from the authorization server. The value should be in plain text and will be properly URI encoded for authorization.
433+
When using OpenID Connect Implicit Flow, value <code>openid</code> must be included.
421434
</td>
422435
</tr>
423436
<tr>
@@ -479,6 +492,39 @@ <h1 id="configurations">Configurations</h1>
479492
Defaults to <code>sessionStorage</code>.
480493
</td>
481494
</tr>
495+
<tr>
496+
<td class="parameter">
497+
<span>issuer</span>
498+
<span class="info">(optional)</span>
499+
</td>
500+
<td>
501+
For OpenID Connect Implicit Flow only.
502+
The issuer of the id_token. It must exactly match the <code>iss</code> claim (if exists) in the id_token
503+
</td>
504+
</tr>
505+
<tr>
506+
<td class="parameter">
507+
<span>subject</span>
508+
<span class="info">(optional)</span>
509+
</td>
510+
<td>
511+
For OpenID Connect Implicit Flow only.
512+
The subject of the id_token. The detailed meaning is usually application specific.
513+
It must exactly match the <code>sub</code> claim (if exists) in the id_token
514+
</td>
515+
</tr>
516+
<tr>
517+
<td class="parameter">
518+
<span>pub-key</span>
519+
<span class="info">(optional)</span>
520+
</td>
521+
<td>
522+
For OpenID Connect Implicit Flow only.
523+
The public key to verify the id_token signature. It could be <code>.pem</code> format or JWK format.<br>
524+
For signing algorithm (usually specified by <code>alg</code> in the id_token header), currently only <code>RS256</code>, <code>RS384</code>, or <code>RS512</code> is supported.<br>
525+
If not set, then the id_token itself should carry the public key, or the url which can be used to retrieve the public key.
526+
</td>
527+
</tr>
482528
</tbody>
483529
</table>
484530

0 commit comments

Comments
 (0)