cidaas-javascript-sdk 2.3.0 → 2.4.1

package/CHANGELOG.md

@@ -1,18 +1,13 @@
-# [2.3.0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v2.2.7...v2.3.0) (2023-03-02)
+## [2.4.1](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v2.4.0...v2.4.1) (2023-04-04)
 
 
 ### Bug Fixes
 
-* [813](https://gitlab.widas.de/cidaas-v2/ui/issues/-/issues/813) added headers parameters ([966b149](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/966b1493c93b5ccf80839f2bcff979a541974730))
-* [813](https://gitlab.widas.de/cidaas-v2/ui/issues/-/issues/813) added headers parameters ([d085513](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/d085513585770cdae5bc6c8693d10c7f6764faaf))
-* [813](https://gitlab.widas.de/cidaas-v2/ui/issues/-/issues/813) added headers parameters ([e103f95](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/e103f956583b727c7e66f32d56a38fac84ab3f02))
-* [813](https://gitlab.widas.de/cidaas-v2/ui/issues/-/issues/813) added headers parameters ([a38ac72](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/a38ac7219decd19cd237ec82c6898ca09880218a))
-* adapt review changes ([81aec32](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/81aec32ce735fad6955ee7db7c0e8edb80df3059))
-* end statement with semicolon ([c924be0](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/c924be0a26022db76f5a516e20bf03051b809cc6))
-* indentation fix and readme update ([4b1568f](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/4b1568f8068952b93fa43689ac04a8c2bd5a43ca))
-* revert long-lat change ([86a35bc](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/86a35bc70d0ffd01b0f3a0acf13d5b0d114590f7))
-
-
-### Features
-
-* added the acceptlanguage options in header ([7871bc9](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/7871bc9290ca34e5cf91d0ab00a0ae1905437bc6)), closes [/gitlab.widas.de/customer-specific-projects/integration-team/cidaas-public-devkit-documentation/-/issues/218#note_552348](https://gitlab.widas.de//gitlab.widas.de/customer-specific-projects/integration-team/cidaas-public-devkit-documentation/-/issues/218/issues/note_552348)
+* [#229](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/issues/229) Requirements section added to the Readme ([b93cef4](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/b93cef4971c0b23fd852ad0dfd0485770d2a6306))
+* Added depoy to stage ([ca110af](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/ca110afbcfb566d1e2b1c0d9110fc2d544438ea4))
+* Added some changes to gitlab-ci file for aws_upload ([387e20c](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/387e20c25707f09e3e422f7f15b5aea68e779c70))
+* api doc reference linked ([f426f17](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/f426f1761e07b011f76f40be80708bd605a97e1b))
+* bullet point the requirements ([0cc3e9b](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/0cc3e9bdf73f90c386f090ead896cc7d696ee291))
+* missing function added ([489b64d](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/489b64dc802f03df5cea5b25f93596e5daaf1431))
+* Modified the script tag ([e688923](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/e6889239ca72e7354ee78a305a79d52115ba4320))
+* parameter declaration ([ad4d19a](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/ad4d19a3105403cc680d472ec332e2bcf7eb994d))

package/README.md

@@ -11,6 +11,12 @@
 ## cidaas-javascript-sdk
 This cidaas Javascript SDK library is built on the top of [OIDC client javascript library](https://github.com/IdentityModel/oidc-client-js). 
 
+#### Requirements
+
+Make sure you have installed all of the following prerequisites on your development machine:
+* Node.js - Download & Install Node.js. The version required is >= 8
+* npm - node package manager to add the package and install dependent packages
+
 #### Installation
 
 From CDN
@@ -18,7 +24,7 @@ From CDN
 ```html
 <!-- Release version 2.0.9 -->
 <!-- Minified version -->
-<script src="https://cdn.cidaas.de/javascript/oidc/2.0.9/cidaas-javascript-sdk.min.js"></script>
+<script src="https://cdn.cidaas.de/javascript/oidc/2.5.0/cidaas-javascript-sdk.min.js"></script>
 ```
 
 From npm
@@ -83,7 +89,7 @@ To complete the login process, call ****logincallback()****. This will parses th
 
 ```js
 cidaas.loginCallback().then(function(response) {
-    // your success code here            
+    // the response will give you login details.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -103,7 +109,7 @@ cidaas.registerWithBrowser();
 To get the user profile information, call ****getUserInfo()****. This will return the basic user profile details along with groups, roles and whatever scopes you mentioned in the options.
 ```js
 cidaas.getUserInfo().then(function (response) {
-    // your success code here
+    // the response will give you profile details.
 }).catch(function(ex) {
     // your failure code here
 });; 
@@ -114,7 +120,7 @@ cidaas.getUserInfo().then(function (response) {
 
 ```js
 cidaas.logout().then(function () {
-    // your success code here
+    // your logout success code here
 }).catch(function(ex) {
     // your failure code here
 });
@@ -136,7 +142,7 @@ Each and every proccesses starts with requestId, it is an entry point to login o
 
 ```js
 cidaas.getRequestId().then(function (response) {
-    // your success code here
+    // the response will give you request ID.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -163,7 +169,7 @@ To get the tenant basic information, call ****getTenantInfo()****. This will ret
 ##### Sample code
 ```js
 cidaas.getTenantInfo().then(function (response) {
-    // your success code here
+    // the response will give you tenent details.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -196,7 +202,7 @@ cidaas.getClientInfo({
     requestId: 'your requestId',
     acceptlanguage: 'your locale' // optional example: de-de, en-US
 }).then(function (resp) {
-    // your success code here
+    // the response will give you client info.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -224,7 +230,7 @@ cidaas.getClientInfo({
 
 ##### Login with credentials
 
-To login with your credentials, call ****loginWithCredentials()****. After successful login, this will redirect you to the redirect_url that you mentioned earlier while initialising the sdk
+To login with your credentials, call ****loginWithCredentials()****. After successful login, this will redirect you to the redirect_url that you mentioned earlier while initialising the sdk. Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/5gphdk6vapp56-classic-login#call-login-api for more detials.
 
 ##### Sample code
 ```js
@@ -236,9 +242,37 @@ cidaas.loginWithCredentials({
 });
 ```
 
+#### Login with credentials and get response
+To login with username and password, call **loginWithCredentialsAsynFn()**. The function accepts a function parameter of type object. In the sample example the object is named as options. Below are the key that need to be passed in the options object
+
+| Name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| request_id | string | request id of the session | false |
+| username | string | the username of the user  | false |
+| password | string | password to authenticate the username | false |
+
+
+##### Sample code
+
+```js
+options = {
+  request_id: "bGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
+  username: "test@cidaas.de"
+  password: "cidaas"
+}
+
+cidaas.loginWithCredentialsAsynFn(options)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
 ##### Login with social
 
-To login with social providers, call ****loginWithSocial()****. This will redirect you to the facebook login page.
+To login with social providers, call ****loginWithSocial()****. This will redirect you to the facebook login page. Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/9mi5uqxhqlsm5-social-login#call-social-login-api for more details
 
 ##### Sample code
 ```js
@@ -258,7 +292,7 @@ cidaas.getRegistrationSetup({
     requestId: 'your requestId',
     acceptlanguage: 'your locale' // optional example: de-de, en-US
 }).then(function (resp) {
-    // your success code here
+    // the response will give you fields that are required.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -365,7 +399,7 @@ cidaas.register({
     provider: 'your provider', // FACEBOOK, GOOGLE, SELF
     acceptlanguage: 'your locale' // optional example: de-de, en-US
 }, headers).then(function (response) {
-    // type your code here
+    // the response will give you client registration details.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -417,9 +451,76 @@ cidaas.getMissingFields({
         requestId: 'your requestId', // which you will get it from url
         acceptlanguage: 'your locale' // optional example: de-de, en-US
 }).then(function (response) {
-    // type your code here 
+    // the response will give you user info with missing fields.
 }).catch(function (ex) {
-    // your failure code here  
+    // your failure code here
+});
+```
+
+##### Progressive Registration
+For progressive registration, call **progressiveRegistration()**. While logging in If the API returns 417 with the error message MissingRequiredFields, call the **getMissingFieldsLogin** to get the list of missing fileds and proceed with progressive registration. In the sample request only the required fields are added, however you must provide the missing fields along with the required fields.
+
+##### Function parameters
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| options | object | The object with the keys described in the below table under section options |
+| headers | object | The object with the keys described in the below table under section headers  |
+
+##### options
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| acceptlanguage | string | your locale/browser local  | true |
+
+* Please provide provide the missing fields along with the required fields
+
+##### headers
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| trackId | string | the track id received while logging in  | false |
+| requestId | string | request id of the session | false |
+
+
+##### Sample code
+
+```js
+options = {
+    acceptlanguage: 'en-Us'
+}
+
+headers = {
+    trackId: 'bGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
+    requestId: 'bGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9',
+}
+cidaas.progressiveRegistration(options, headers)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+})
+```
+
+##### Get Missing Fields Login
+To get the missing fields after login, call **getMissingFieldsLogin()**.
+
+##### Function parameters
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| trackId | string | the track id received while logging in  |
+
+
+##### Sample code
+
+```js
+let trackId = 'bGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9';
+cidaas.getMissingFieldsLogin(trackId)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
 });
 ```
 
@@ -436,7 +537,7 @@ cidaas.getCommunicationStatus({
     sub: 'your sub', // which you will get on the registration response
     acceptlanguage: 'your locale' // optional example: de-de, en-US
 }).then(function (response) {
-    // type your code here
+    // the response will give you account details once its verified.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -467,7 +568,7 @@ cidaas.initiateAccountVerification({
     processingType: 'CODE', 
     sub: 'your sub'
 }).then(function (response) {
-    // type your code here
+    // the response will give you account verification details.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -494,7 +595,7 @@ cidaas.verifyAccount({
     accvid: 'your accvid', // which you will get on initiate account verification response
     code: 'your code in email or sms or ivr'
 }).then(function (response) {
-    // type your code here
+    // the response will give you account verification ID and unique code.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -504,7 +605,7 @@ cidaas.verifyAccount({
 
 ##### Initiate Reset Password
 
-To initiate the password resetting, call ****initiateResetPassword()****. This will send verification code to your email or mobile based on the resetMedium you mentioned.
+To initiate the password resetting, call ****initiateResetPassword()****. This will send verification code to your email or mobile based on the resetMedium you mentioned. Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/6b29bac6002f4-initiate-password-reset for more details.
 
 ##### Sample code
 
@@ -515,7 +616,7 @@ cidaas.initiateResetPassword({
     requestId: 'your requestId',
     resetMedium: 'email'
 }).then(function (response) {
-    // type your code here
+    // the response will give you password reset details.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -535,7 +636,7 @@ cidaas.initiateResetPassword({
 
 ##### Handle Reset Password
 
-To handling the reset password by entering the verification code you received, call ****handleResetPassword()****. This will check your verification code was valid or not and allows you to proceed to the next step
+To handling the reset password by entering the verification code you received, call ****handleResetPassword()****. This will check your verification code was valid or not and allows you to proceed to the next step. More details available on https://docs.cidaas.com/docs/cidaas-iam/4aede115e5460-validate-reset-password
 
 ##### Sample code
 ```js
@@ -543,7 +644,7 @@ cidaas.handleResetPassword({
     code: 'your code in email or sms or ivr',
     resetRequestId: 'your resetRequestId' // which you will get on initiate reset password response
 }).then(function (response) {
-    // type your code here
+    // the response will give you valid verification code.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -563,7 +664,7 @@ cidaas.handleResetPassword({
 
 ##### Reset Password
 
-To change the password, call ****resetPassword()****. This will allow you to change your password.
+To change the password, call ****resetPassword()****. This will allow you to change your password. More detials available on https://docs.cidaas.com/docs/cidaas-iam/c7d767a7414df-accept-reset-password
 
 ##### Sample code
 ```js
@@ -573,7 +674,7 @@ cidaas.resetPassword({
     exchangeId: 'your exchangeId', // which you will get on handle reset password response
     resetRequestId: 'your resetRequestId' // which you will get on handle reset password response
 }).then(function (response) {
-    // type your code here
+    // the response will give you reset password details.
 }).catch(function(ex) {
     // your failure code here
 });
@@ -592,7 +693,7 @@ cidaas.resetPassword({
 
 ##### Change Password
 
-To change the password, call ****changePassword()****. This will allow you to change your password.
+To change the password, call ****changePassword()****. This will allow you to change your password. More details available on https://docs.cidaas.com/docs/cidaas-iam/09873c57d1fb8-change-password
 
 ##### Sample code
 ```js
@@ -603,9 +704,9 @@ cidaas.changePassword({
         identityId: 'asdauet1-quwyteuqqwejh-asdjhasd',
 }, 'your access token')
 .then(function () {
-    // type your code here 
+    // the response will give you changed password.
 }).catch(function (ex) {
-    // your failure code here  
+    // your failure code here
 });
 ```
 
@@ -631,9 +732,9 @@ cidaas.getProfileInfo({
         access_token: 'your access token',
         acceptlanguage: 'your locale' // optional example: de-de, en-US
 }).then(function (response) {
-    // type your code here 
+    // the response will give you user profile details.
 }).catch(function (ex) {
-    // your failure code here  
+    // your failure code here
 });
 ```
 
@@ -698,17 +799,24 @@ cidaas.getProfileInfo({
 
 #### Getting user profile
 
-To get the user profile information, call ****getUserProfile()****.
+To get the user profile information, call ****getUserProfile()****. The function accepts a function parameter of type object. In the sample example the object is named as options. Below are the key that need to be passed in the options object
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| access_token | string | a bearer token | false |
+| acceptlanguage | string | browser/custom local  | true |
 
 ##### Sample code
 ```js
-cidaas.getUserProfile({
-        access_token: 'your access token',
-        acceptlanguage: 'your locale' // optional example: de-de, en-US
-}).then(function (response) {
-    // type your code here 
+let options = {
+  access_token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c',
+  acceptlanguage: 'en-US'
+}
+cidaas.getUserProfile(options)
+.then(function (response) {
+  // the response will give you user profile information.
 }).catch(function (ex) {
-    // your failure code here  
+  // your failure code here
 });
 ```
 
@@ -742,9 +850,9 @@ cidaas.updateProfile({
         provider: 'self',
         acceptlanguage: 'your locale' // optional example: de-de, en-US
 }, 'your access token', 'your sub').then(function () {
-    // type your code here 
+    // the response will give you updated user profile info.
 }).catch(function (ex) {
-    // your failure code here  
+    // your failure code here
 });
 ```
 
@@ -762,7 +870,7 @@ To logout the user, call ****logoutUser()****.
 ##### Sample code
 ```js
 cidaas.logoutUser({
-        access_token : 'your accessToken'
+  access_token : 'your accessToken'
 });
 ```
 #### Delete User Account
@@ -787,7 +895,7 @@ The usage of the method is as follows.
 ```js
 cidaas.deleteUserAccount(options).then(function (response) {
 
-   // your success code here
+   // the response will give you account details to be deleted.
 
 }).catch(function(ex) {
 
@@ -806,6 +914,146 @@ cidaas.deleteUserAccount(options).then(function (response) {
    }
 }
 ```
+
+##### User Check Exists
+Check if user exists, call **userCheckExists()**. The function accepts a function parameter of type object. The object with the keys described in the below table
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| requestId | string | the request id of a session | false |
+
+##### Sample code
+
+```js
+options = {
+    requestId : "bGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9"
+}
+cidaas.userCheckExists(options)
+.then(function(response) {
+    // type your code here
+})
+.catch(function(ex) {
+    // your failure code here
+});
+```
+
+
+##### Initiate account linking
+To initiate account linking, call **initiateLinkAccount()**. The function parameters are mentioned below.
+
+##### Function parameters
+| Name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| options | object | an object with the keys described in the below table | false |
+| access_token | string | the username of the user  | false |
+
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| user_name_to_link | string | Username that needs to be linked | false |
+| master_sub | string | Master sub to link account | false |
+
+
+##### Sample code
+
+```js
+let options = {
+ master_sub : "vaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ",
+ user_name_to_link: "CidaasTest"
+}
+const acccess_token= "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+
+cidaas.initiateLinkAccount(options,access_token)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
+##### Complete link account
+To complete account linking, call **completeLinkAccount()**. The function parameters are mentioned below.
+
+##### Function parameters
+| Name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| options | object | an object with the keys described in the below table | false |
+| access_token | string | the username of the user  | false |
+
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| link_request_id | string | the request id of account link request | false |
+| code | string |  the code received while account linking | false |
+
+##### Sample code
+
+```js
+let options = {
+ link_request_id : "vaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ",
+ code: "1234567890"
+}
+const acccess_token= "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+
+cidaas.completeLinkAccount(options,access_token)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
+##### Get Linked Users
+To get all the linked social accounts, call **getLinkedUsers()**. The function accepts the below parameters 
+
+##### Function parameters
+| Name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| sub | string | the sub of the user | false |
+| access_token | string | the username of the user  | false |
+
+
+##### Sample code
+
+```js
+const sub = "vaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ";
+const acccess_token= "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+
+cidaas.getLinkedUsers(access_token, sub)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
+##### Unlink Account
+To unlink an social account for a user, call **unlinkAccount()**. The function accepts the below parameters
+
+##### Function parameters
+| Name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| identityId | string | The identity id of the account to be unlinked | false |
+| access_token | string | the username of the user  | false |
+
+##### Sample code
+
+```js
+const identityId = "vaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ";
+const acccess_token= "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c";
+
+cidaas.unlinkAccount(access_token, identityId)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
 #### Physical Verification
 
 After successful login, we can add multifactor authentications.
@@ -823,9 +1071,9 @@ this.cidaas.setupEmail({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for email setup.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -853,9 +1101,9 @@ this.cidaas.enrollEmail({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you email and device info to be linked.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -886,9 +1134,9 @@ this.cidaas.initiateEmail({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you email verification code details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -918,9 +1166,9 @@ this.cidaas.authenticateEmail({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you email authentication details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -948,7 +1196,7 @@ this.cidaas.setupSMS({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for SMS setup. 
     }).catch((err) => {
       // your failure code here 
     });
@@ -978,9 +1226,9 @@ this.cidaas.enrollSMS({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you SMS and device info to be linked 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1011,9 +1259,9 @@ this.cidaas.initiateSMS({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you SMS verification code details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1043,9 +1291,9 @@ this.cidaas.authenticateSMS({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you SMS authentiction details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1073,9 +1321,9 @@ this.cidaas.setupIVR({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for IVR setup.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1103,9 +1351,9 @@ this.cidaas.enrollIVR({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you IVR and device info to be linked.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1136,9 +1384,9 @@ this.cidaas.initiateIVR({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you IVR verification code details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1168,9 +1416,9 @@ this.cidaas.authenticateIVR({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you IVR authentication details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1198,9 +1446,9 @@ this.cidaas.setupBackupcode({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for backup-code setup.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1237,9 +1485,9 @@ this.cidaas.initiateBackupcode({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you backup-code verification code details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1269,9 +1517,9 @@ this.cidaas.authenticateBackupcode({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you backup-code authentication details. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1300,9 +1548,9 @@ this.cidaas.setupTOTP({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for TOTP setup. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1330,9 +1578,9 @@ this.cidaas.enrollTOTP({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you TOTP and device info to be linked. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1363,9 +1611,9 @@ this.cidaas.initiateTOTP({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you TOTP verification details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1395,9 +1643,9 @@ this.cidaas.authenticateTOTP({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you TOTP authentication details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1426,9 +1674,9 @@ this.cidaas.setupPattern({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for Pattern setup.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1460,9 +1708,9 @@ this.cidaas.initiatePattern({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you Pattern verification details. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1493,9 +1741,9 @@ this.cidaas.setupTouchId({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for Touch ID setup.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1527,9 +1775,9 @@ this.cidaas.initiateTouchId({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you Touch ID verification details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1560,9 +1808,9 @@ this.cidaas.setupSmartPush({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for Smart Push setup. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1583,9 +1831,9 @@ this.cidaas.initiateSmartPush({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you Smart Push verification details. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1616,9 +1864,9 @@ this.cidaas.setupFace({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for Face setup. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1650,9 +1898,9 @@ this.cidaas.initiateFace({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you Face verification details.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1683,9 +1931,9 @@ this.cidaas.setupVoice({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you details for Voice setup. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1717,9 +1965,9 @@ this.cidaas.initiateVoice({
         deviceId: 'your device id'
       }
     }).then((response) => {
-      // type your code here 
+      // the response will give you Voice verification details. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1751,6 +1999,22 @@ this.cidaas.mfaContinue({
 ```
 
 
+##### Get All Verification List
+List all verification type configured, call **getAllVerificationList()**. access_token must be passed as function paramere.
+
+##### Sample code
+```js
+const access_token = "eyJhbGciOiJSUzI1NiIsImtpZCI6IjEwMjM2ZWZiLWRlMjEtNDI5Mi04Z.";
+
+cidaas.getAllVerificationList(access_token)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
 #### Consent Management
 
 For the first time login, the user needs to accept the terms and conditions.
@@ -1765,7 +2029,7 @@ this.cidaas.getConsentDetails({
       consent_name: 'your consent name',
       acceptlanguage: 'your locale' // optional example: de-de, en-US
     }).then((response) => {
-      // type your code here 
+      // the response will give you details of consent.
     }).catch((err) => {
       // your failure code here 
     });
@@ -1784,6 +2048,22 @@ this.cidaas.getConsentDetails({
 }
 ```
 
+
+##### Get Consent Details V2
+To get consent details , call **getConsentDetailsV2()**. The function accepts a parameter of type object. The options paramter in the sample must contain the keys mentioned in in  the api document https://docs.cidaas.com/docs/cidaas-iam/858fbeb51c62b-find-consent-info
+
+##### Sample code
+
+```js
+cidaas.getConsentDetailsV2(options)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
 ##### Accept consent
 
 To accept consent, call ****acceptConsent()****
@@ -1796,9 +2076,9 @@ this.cidaas.acceptConsent({
       client_id: 'your client id',
       accepted: true
     }).then((response) => {
-      // type your code here 
+      // the response will give you details of accepted consent.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1813,6 +2093,21 @@ this.cidaas.acceptConsent({
 }
 ```
 
+##### Accept Consent V2
+To accept consent, call **acceptConsentV2()**. The function accepts a parameter of type object. The options paramter in the sample must contain the keys mentioned in in  the api document https://docs.cidaas.com/docs/cidaas-iam/0caa9bacdd29e-accept-consent
+
+##### Sample code
+
+```js
+cidaas.acceptConsentV2(options)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
 ##### Consent Continue
 
 To continue after Consent acceptance, call ****consentContinue()****.
@@ -1838,9 +2133,9 @@ this.cidaas.acceptClaimConsent({
       client_id: 'your client id',
       accepted: "accepted claims with array eg: []"
     }).then((response) => {
-      // type your code here 
+      // the response will give you accepted claim consent. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1863,7 +2158,7 @@ this.cidaas.revokeClaimConsent({
       sub: 'your sub',
       revoked_claims: "revoked claims with array eg: []"
     }).then((response) => {
-      // type your code here 
+      // the response will give you revoked claim consent.
     }).catch((err) => {
       // your failure code here 
     });
@@ -1877,6 +2172,95 @@ this.cidaas.revokeClaimConsent({
     "data": true
 }
 ```
+
+##### Get Scope Consent Details
+To get scope consent details, call **getScopeConsentDetails()**. The function accepts a parameter of type object. The options paramter in the sample must contain the keys mentioned in the below table.The function calls the api available in the document https://docs.cidaas.com/docs/cidaas-iam/f4b1bee4c3313-pre-login-check. Please refer to the api document for more details
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| track_id | string | the track id recieved while logging in | false |
+| locale | string | browser accept language or custom language | false |
+
+##### Sample code
+
+```js
+let options = {
+    track_id: "5f5cbb84-4ceb-4975-b347-4bfac61e9248",
+    locale: "en-US"
+}
+
+cidaas.getScopeConsentDetails(options)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
+##### Get Scope Consent Version Details V2
+To get scope consent version detials V2, call **getScopeConsentVersionDetailsV2()**. The function accepts a parameter of type object. The options paramter in the sample must contain the keys mentioned in the below table.The function calls the api available in the document https://docs.cidaas.com/docs/cidaas-iam/7e24ac2113315-get-consent-version-details. Please refer to the api document for more details.
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| scopeid | string | the consent id(please refer to api document mentioned above) | false |
+| locale | string | browser accept language or custom language | false |
+
+##### Sample code
+
+```js
+let options = {
+    scopeid: "5f5cbb84-4ceb-4975-b347-4bfac61e9248",
+    locale: "en-US"
+}
+
+cidaas.getScopeConsentVersionDestailsV(options)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
+##### Accept Scope Consent
+To accept scope consent, call **acceptScopeConsent()**. The options paramter in the sample must contain the keys mentioned in in  the api document https://docs.cidaas.com/docs/cidaas-iam/84c69a098c5c7-accept-scope-consent. Please refer to the api document for more details.
+
+##### Sample code
+
+```js
+cidaas
+    .acceptScopeConsent(options)
+    .then(function (response) {
+        // type your code here
+    })
+    .catch(function (ex) {
+        // your failure code here
+    });
+```
+
+##### Scope Consent Continue Login
+To scope consent continue login, call **scopeConsentContinue()**. The function accepts a parameter of type object. The options paramter in the sample must contain the keys mentioned in the below table.The function calls the api available in the document https://docs.cidaas.com/docs/cidaas-iam/aa32097970c52-continue-authentication-flow-after-prechecks. Please refer to the api document for more details.
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| track_id | string | track id recieved while loggine in| false |
+
+##### Sample code
+
+```js
+let options = {
+    track_id: "5f5cbb84-4ceb-4975-b347-4bfac61e9248"
+}
+cidaas.scopeConsentContinue(options)
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
 #### Deduplication
 
 ##### Get deduplication details
@@ -1889,9 +2273,9 @@ this.cidaas.getDeduplicationDetails({
       track_id: 'your track id',
       acceptlanguage: 'your locale' // optional example: de-de, en-US
     }).then((response) => {
-      // type your code here 
+      // the response will give you deduplication details of users.
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1924,9 +2308,9 @@ this.cidaas.registerDeduplication({
       track_id: 'your track id',
       acceptlanguage: 'your locale' // optional example: de-de, en-US
     }).then((response) => {
-      // type your code here 
+      // the response will give you new registered deduplication user. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1955,9 +2339,9 @@ this.cidaas.deduplicationLogin({
         requestId: 'your request id',
         password: 'your password'
     }).then((response) => {
-      // type your code here 
+      // the response will give you deduplication login details. 
     }).catch((err) => {
-      // your failure code here 
+      // your failure code here
     });
 ```
 
@@ -1976,6 +2360,40 @@ this.cidaas.deduplicationLogin({
     }
 }
 ```
+
+##### Initiate Users Link
+
+To initiate a new user link, call ****userAccountLink()****.
+
+##### Sample code
+
+```js
+var options = {
+    sub: 'sub of the user who initiates the user link',
+    username: 'username of the user which should get linked',
+    redirect_uri: 'redirect uri the user should get redirected after successful account linking'
+}
+```
+
+```js
+this.cidaas.userAccountLink(options, access_token).then((response) => {
+      // the response will give you that both user are linked.
+    }).catch((err) => {
+      // your failure code here 
+    });
+```
+
+##### Response
+```json
+{
+    "success":true,
+    "status":200,
+    "data": {
+         "redirectUri": "string"
+    }
+}
+```
+
 #### Socket Connection
 
 ##### Installation
@@ -2065,3 +2483,100 @@ this.socket.on("status-update", (msg) => {
     }
 });
 ```
+#### Access Token
+
+##### Get aceess token
+To get a new token with th grant type authorization_code, call **getAccessToken()**. The function accepts a function parameter of type object. The object with the keys described in the below table
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| code | string | code to create a new token | false |
+
+##### Sample code
+
+```js
+options = {
+  code: "123456",
+}
+
+cidaas.getAccessToken(options)
+.then(function (response) {
+  // type your code here
+})
+.catch(function (ex) {
+  // your failure code here
+});
+```
+
+##### Validate access token
+To validate an access token, call **validateAccessToken()**. The function accepts a function parameter of type object. The object with the keys described in the below table.
+
+| Key name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| token | string | access token | false |
+| token_type_hint | string | token type hint. accepted token type hints are access_token, id_token, refresh_token, sso | false |
+
+
+##### Sample code
+
+```js
+options = {
+  token: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+  token_type_hint: "access_token",
+}
+
+cidaas.validateAccessToken(options)
+.then(function (response) {
+  // type your code here
+})
+.catch(function (ex) {
+  // your failure code here
+});
+```
+
+##### Renew token
+To get a new token with the grant type refresh_token, call **renewToken()**. The function accepts a function parameter of type object. The object with the keys described in the below table
+
+| Key Name | Type | Description | Is optional |
+| ---- | ---- | ----------- | ----------- |
+| refresh_token | string | The refresh token to create a new token. The refresh token is received while creating an access token using the token endpoint and later can be used to fetch a new token without using credentials | false |
+
+##### Sample code
+
+```js
+options = {
+  refresh_token: "bGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
+}
+
+cidaas.renewToken(options)
+.then(function (response) {
+  // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+#### Device
+##### Get Device Info
+To get the device information, call **getDeviceInfo()**
+
+##### Sample code
+
+```js
+cidaas.getDeviceInfo()
+.then(function (response) {
+    // type your code here
+})
+.catch(function (ex) {
+    // your failure code here
+});
+```
+
+## Possible Error
+
+The SDK will throws Custom Exception if something went wrong during the operation:
+
+| HTTP Status Code | When could it be thrown |
+|----------------- | ----------------------- |
+|  500 | during creation of WebAuth instance |
+|  417 | if there are any other failure |

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cidaas-javascript-sdk",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "author": "cidaas by Widas ID GmbH",
   "description": "Cidaas native javascript sdk",
   "license": "MIT",
@@ -37,7 +37,7 @@
     "jest": "27.3.1",
     "terser-webpack-plugin": "^5.2.4",
     "typescript": "^4.5.4",
-    "webpack": "^5.59.1",
+    "webpack": "^5.76.2",
     "webpack-cli": "^4.9.1",
     "webpack-dev-server": "^4.3.1",
     "webpack-hot-middleware": "^2.25.1",

package/src/main/web-auth/webauth.js

@@ -307,7 +307,7 @@ WebAuth.prototype.base64URL = function (string) {
 };
 
 // get login url
-WebAuth.prototype.getLoginURL = function () {
+WebAuth.prototype.getLoginURL = function (options = {}) {
   var settings = window.webAuthSettings;
   if (!settings.response_type) {
     settings.response_type = "code";
@@ -328,6 +328,9 @@ WebAuth.prototype.getLoginURL = function () {
     loginURL += "&response_mode=" + settings.response_mode;
   }
   loginURL += "&scope=" + settings.scope;
+  if(options && options.max_age){
+    loginURL += "&max_age=" + options.max_age;
+  }
   console.log(loginURL);
   return loginURL;
 };
@@ -1446,7 +1449,7 @@ WebAuth.prototype.getUnreviewedDevices = function (access_token, sub) {
         }
       };
       http.open("GET", _serviceURL, true);
-      http = createHeaders(http, options);
+      http = createHeaders(http, null);
       http.setRequestHeader("Authorization", `Bearer ${access_token}`);
 
       http.send();
@@ -1472,7 +1475,7 @@ WebAuth.prototype.getReviewedDevices = function (access_token, sub) {
         }
       };
       http.open("GET", _serviceURL, true);
-      http = createHeaders(http, options);
+      http = createHeaders(http, null);
       http.setRequestHeader("Authorization", `Bearer ${access_token}`);
       http.send();
     } catch (ex) {
@@ -1768,7 +1771,7 @@ WebAuth.prototype.getMissingFieldsLogin = function (trackId) {
         }
       };
       http.open("GET", _serviceURL, true);
-      http = createHeaders(http, options);
+      http = createHeaders(http, null);
       http.send();
     } catch (ex) {
       reject(ex);
@@ -1887,4 +1890,10 @@ WebAuth.prototype.getDeviceInfo = function () {
   });
 };
 
+// initiates a new user link to link two existing users
+WebAuth.prototype.userAccountLink = function (options, access_token) {
+  var _serviceURL = window.webAuthSettings.authority + "/useractions-srv/users/" + options.sub + "/link";
+  return createPostPromise(options, _serviceURL, false, access_token);
+};
+
 module.exports = WebAuth;

package/types/main/web-auth/webauth.d.ts

@@ -15,7 +15,7 @@ declare class WebAuth {
     generateRandomString(length: any): string;
     generateCodeChallenge(code_verifier: any): any;
     base64URL(string: any): any;
-    getLoginURL(): string;
+    getLoginURL(options?: {}): string;
     getAccessToken(options: any): Promise<any>;
     validateAccessToken(options: any): Promise<any>;
     getRequestId(): Promise<any>;
@@ -27,6 +27,8 @@ declare class WebAuth {
     getTenantInfo(): Promise<any>;
     logoutUser(options: any): void;
     getClientInfo(options: any): Promise<any>;
+    getDevicesInfo(options: any): Promise<any>;
+    deleteDevice(options: any): Promise<any>;
     getRegistrationSetup(options: any): Promise<any>;
     register(options: any, headers: any): Promise<any>;
     getInviteUserDetails(options: any): Promise<any>;
@@ -134,5 +136,6 @@ declare class WebAuth {
     deviceCodeVerify(code: any): void;
     userCheckExists(options: any): Promise<any>;
     setAcceptLanguageHeader(acceptLanguage: any): void;
-    getDeviceInfo(options: any): Promise<any>;
+    getDeviceInfo(): Promise<any>;
+    userAccountLink(options: any, access_token: any): Promise<any>;
 }