Skip to content

Commit

Permalink
Merge c4e49d1 into a06b94e
Browse files Browse the repository at this point in the history
  • Loading branch information
abod-akhras committed Jul 2, 2021
2 parents a06b94e + c4e49d1 commit ee0102b
Show file tree
Hide file tree
Showing 26 changed files with 2,167 additions and 40 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log

## [v0.4.2](https://github.com/ibm-cloud-security/appid-clientsdk-js/releases/tag/0.4.2) (2021-06-16)

**Added**

- Update dependency versions

## [v0.4.1](https://github.com/ibm-cloud-security/appid-clientsdk-js/releases/tag/0.4.1) (2020-07-21)

**Added**
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import AppID from 'ibmcloud-appid-js';

From the CDN:
```html
<script src="https://cdn.appid.cloud.ibm.com/appid-0.4.1.min.js"></script>
<script src="https://cdn.appid.cloud.ibm.com/appid-0.4.2.min.js"></script>
```

Or for development purposes use the minified file in this repo:
Expand Down
56 changes: 28 additions & 28 deletions docs/AppID.html
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ <h2>
AppID
</h2>

<div class="class-description"><p>This class provides functions to support authentication.</p></div>
<div class="class-description usertext"><p>This class provides functions to support authentication.</p></div>


</header>
Expand All @@ -75,7 +75,7 @@ <h4 class="name" id="AppID"><span class="type-signature"></span>new AppID<span c

<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line20">line 20</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line14">line 14</a>
</li></ul></dd>


Expand Down Expand Up @@ -114,7 +114,7 @@ <h4 class="name" id="AppID"><span class="type-signature"></span>new AppID<span c



<div class="description">
<div class="description usertext">
<p>This creates an instance of AppID. Once created, call init() before attempting to sign in.</p>
</div>

Expand Down Expand Up @@ -227,7 +227,7 @@ <h4 class="name" id="init"><span class="type-signature">(async) </span>init<span



<div class="description">
<div class="description usertext">
<p>Initialize AppID. Call this function before attempting to sign in. You must wait for the promise to resolve.</p>
</div>

Expand Down Expand Up @@ -511,7 +511,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>For missing required params.</p>
</div>
</dt>
Expand All @@ -538,7 +538,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>Any errors during a HTTP request.</p>
</div>
</dt>
Expand Down Expand Up @@ -640,7 +640,7 @@ <h4 class="name" id="signin"><span class="type-signature">(async) </span>signin<



<div class="description">
<div class="description usertext">
<p>This will open a sign in widget in a popup which will prompt the user to enter their credentials.<br>
After a successful sign in, the popup will close and tokens are returned.</p>
</div>
Expand Down Expand Up @@ -678,7 +678,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Popup closed&quot; - The user closed the popup before authentication was completed.</p>
</div>
</dt>
Expand All @@ -705,7 +705,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>Any token validation error.</p>
</div>
</dt>
Expand All @@ -732,7 +732,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>Any errors from the server according to the <a href="https://tools.ietf.org/html/rfc6749#section-4.1.2.1">OAuth spec</a>. e.g. {error: 'server_error', description: ''}</p>
</div>
</dt>
Expand All @@ -759,7 +759,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>Any errors during a HTTP request.</p>
</div>
</dt>
Expand Down Expand Up @@ -865,7 +865,7 @@ <h4 class="name" id="silentSignin"><span class="type-signature">(async) </span>s



<div class="description">
<div class="description usertext">
<p>Silent sign in allows you to automatically obtain new tokens for a user without the user having to re-authenticate using a popup.<br>
This will attempt to authenticate the user in a hidden iframe.<br>
You will need to <a href="https://cloud.ibm.com/docs/services/appid?topic=appid-single-page#spa-silent-login">enable Cloud Directory SSO</a>.<br>
Expand Down Expand Up @@ -905,7 +905,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>Any errors from the server according to the <a href="https://tools.ietf.org/html/rfc6749#section-4.1.2.1">OAuth spec</a>. e.g. {error: 'access_denied', description: 'User not signed in'}</p>
</div>
</dt>
Expand All @@ -932,7 +932,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Silent sign-in timed out&quot; - The iframe will close after 5 seconds if authentication could not be completed.</p>
</div>
</dt>
Expand All @@ -959,7 +959,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>Any token validation error.</p>
</div>
</dt>
Expand All @@ -986,7 +986,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>Any errors during a HTTP request.</p>
</div>
</dt>
Expand Down Expand Up @@ -1092,7 +1092,7 @@ <h4 class="name" id="getUserInfo"><span class="type-signature">(async) </span>ge



<div class="description">
<div class="description usertext">
<p>This method will make a GET request to the <a href="https://us-south.appid.cloud.ibm.com/swagger-ui/#/Authorization%252520Server%252520-%252520Authorization%252520Server%252520V4/oauth-server.userInfo">user info endpoint</a> using the access token of the authenticated user.</p>
</div>

Expand Down Expand Up @@ -1173,7 +1173,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Access token must be a string&quot; Invalid access token.</p>
</div>
</dt>
Expand All @@ -1200,7 +1200,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>Any errors during a HTTP request.</p>
</div>
</dt>
Expand Down Expand Up @@ -1306,7 +1306,7 @@ <h4 class="name" id="changePassword"><span class="type-signature">(async) </span



<div class="description">
<div class="description usertext">
<p>This method will open a popup to the change password widget for Cloud Directory users.<br>
You must enable users to manage their account from your app in Cloud Directory settings.</p>
</div>
Expand Down Expand Up @@ -1393,7 +1393,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Expect id token payload object to have identities field&quot;</p>
</div>
</dt>
Expand All @@ -1420,7 +1420,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Must be a Cloud Directory user&quot;</p>
</div>
</dt>
Expand All @@ -1447,7 +1447,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Missing id token string&quot;</p>
</div>
</dt>
Expand Down Expand Up @@ -1553,7 +1553,7 @@ <h4 class="name" id="changeDetails"><span class="type-signature">(async) </span>



<div class="description">
<div class="description usertext">
<p>This method will open a popup to the change details widget for Cloud Directory users.<br>
You must enable users to manage their account from your app in Cloud Directory settings.</p>
</div>
Expand Down Expand Up @@ -1641,7 +1641,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Missing id token string&quot;</p>
</div>
</dt>
Expand All @@ -1668,7 +1668,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Missing access token string&quot;</p>
</div>
</dt>
Expand All @@ -1695,7 +1695,7 @@ <h5>Throws:</h5>

<dl>
<dt>
<div class="param-desc">
<div class="param-desc usertext">
<p>&quot;Missing tokens object&quot;</p>
</div>
</dt>
Expand Down Expand Up @@ -1761,7 +1761,7 @@ <h5>Returns:</h5>
<br class="clear">

<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Jul 21 2020 11:34:54 GMT-0500 (Central Daylight Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.6</a> on Wed Jun 16 2021 12:38:45 GMT+0100 (Irish Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>

<script>prettyPrint();</script>
Expand Down
Binary file added docs/fonts/Montserrat/Montserrat-Bold.eot
Binary file not shown.
Binary file added docs/fonts/Montserrat/Montserrat-Bold.ttf
Binary file not shown.
Binary file added docs/fonts/Montserrat/Montserrat-Bold.woff
Binary file not shown.
Binary file added docs/fonts/Montserrat/Montserrat-Bold.woff2
Binary file not shown.
Binary file added docs/fonts/Montserrat/Montserrat-Regular.eot
Binary file not shown.
Binary file added docs/fonts/Montserrat/Montserrat-Regular.ttf
Binary file not shown.
Binary file added docs/fonts/Montserrat/Montserrat-Regular.woff
Binary file not shown.
Binary file added docs/fonts/Montserrat/Montserrat-Regular.woff2
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit ee0102b

Please sign in to comment.