Skip to content

Commit f57f71a

Browse files
Minor updates on docs based on latest changes on authorization header
1 parent d676079 commit f57f71a

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

index.html

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -85,13 +85,14 @@ <h2>Basic Example</h2>
8585
<h2>What does it do?</h2>
8686

8787
<p>
88-
It renders a Login link that redirects you to the authorization page. When authorized and
89-
redirected back to your app, the directive takes the access token from the fragment,
90-
saves it in the <a href="https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage#sessionStorage" target="_blank">SessionStorage</a>
91-
and sets the Authorization header to all HTTP requests made with AngularJS.
88+
It renders a Login link that lets you authorize a third party app through OAuth 2.0.
89+
When the flow is completed, the access token is saved in the <a href="https://developer.mozilla.org/en-US/docs/Web/Guide/API/DOM/Storage#sessionStorage" target="_blank">SessionStorage</a>.
9290
</p>
9391

94-
<pre><code><xmp>Authorization:Bearer 9e5c6bf5da8b10223babcb2f6776af5d2a05b3c7988be008eb956b290018464a</xmp></code></pre>
92+
<p class="notice">
93+
The oauth directive only works in HTML5 mode (automatically activated). <br>
94+
We are working on fixing this <a href="https://github.com/andreareginato/oauth-ng/issues/13">bug</a>.
95+
</p>
9596

9697
</div>
9798
</section>
@@ -775,9 +776,12 @@ <h1 id="profile">Profile resource</h1>
775776
<pre><code><xmp>$scope.profile = Profile.get();</xmp></code></pre>
776777

777778
<p>
778-
This profile is accessible only when the <code>profile-uri</code> attribute is defined.
779+
This profile is accessible only when the <code>profile-uri</code> attribute is defined and
780+
it sets the Authorization header with the access token to authenticate the request.
779781
</p>
780782

783+
<pre><code><xmp>Authorization:Bearer {token}</xmp></code></pre>
784+
781785
</div>
782786
</section>
783787

0 commit comments

Comments
 (0)