cidaas-javascript-sdk 4.3.2 → 4.3.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -3
- package/README.md +0 -1
- package/dist/login-service/LoginService.model.d.ts +2 -2
- package/dist/verification-service/VerificationService.d.ts +6 -0
- package/dist/verification-service/VerificationService.js +6 -0
- package/dist/verification-service/VerificationService.model.d.ts +16 -2
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,13 +1,18 @@
|
|
|
1
|
-
## [4.3.
|
|
1
|
+
## [4.3.3](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/compare/v4.3.2...v4.3.3) (2024-11-28)
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
### Bug Fixes
|
|
5
5
|
|
|
6
|
-
*
|
|
7
|
-
*
|
|
6
|
+
* fix vulnerabilty from npm audit ([2f8e0c5](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/2f8e0c5498e45d865ad4bdca8005339d5857c37e))
|
|
7
|
+
* semantic release format ([0d8b601](https://gitlab.widas.de/cidaas-public-devkits/cidaas-public-sdks/cidaas-javascript-sdk/commit/0d8b6014a673098a44d18297777ce1c65ba35602))
|
|
8
8
|
|
|
9
9
|
# Changelog
|
|
10
10
|
|
|
11
|
+
## V4.3.3
|
|
12
|
+
|
|
13
|
+
## Changed
|
|
14
|
+
- Update GetMFAListRequest to support more parameters
|
|
15
|
+
|
|
11
16
|
## V4.3.2
|
|
12
17
|
|
|
13
18
|
### Changed
|
package/README.md
CHANGED
|
@@ -66,12 +66,12 @@ export interface PasswordlessLoginRequest {
|
|
|
66
66
|
* */
|
|
67
67
|
verificationType: VerificationType | string;
|
|
68
68
|
/**
|
|
69
|
-
* Masked sub (id of user)
|
|
69
|
+
* Masked sub (id of user)
|
|
70
70
|
* Either sub or q have to be provided, depends on what is given from the query parameter.
|
|
71
71
|
* */
|
|
72
72
|
sub?: string;
|
|
73
73
|
/**
|
|
74
|
-
* Masked sub (id of user)
|
|
74
|
+
* Masked sub (id of user)
|
|
75
75
|
* Either sub or q have to be provided, depends on what is given from the query parameter.
|
|
76
76
|
* */
|
|
77
77
|
q?: string;
|
|
@@ -36,6 +36,12 @@ export declare function initiateAccountVerification(options: InitiateAccountVeri
|
|
|
36
36
|
export declare function verifyAccount(options: VerifyAccountRequest, headers?: HTTPRequestHeader): Promise<any>;
|
|
37
37
|
/**
|
|
38
38
|
* To get all configured multi factor authentication, call **getMFAList()**.
|
|
39
|
+
*
|
|
40
|
+
* As Parameter, you need to pass request id & one of the following: email or mobile phone or username.
|
|
41
|
+
*
|
|
42
|
+
* In case you are in prelogin page and don't have user information yet (such as mfa-required & account-verification page), you could pass
|
|
43
|
+
* request id & masked sub (one of the following: sub or q), depends on which one is available in the query parameter generated by cidaas.
|
|
44
|
+
*
|
|
39
45
|
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
|
|
40
46
|
* @example
|
|
41
47
|
* ```js
|
|
@@ -53,6 +53,12 @@ function verifyAccount(options, headers) {
|
|
|
53
53
|
exports.verifyAccount = verifyAccount;
|
|
54
54
|
/**
|
|
55
55
|
* To get all configured multi factor authentication, call **getMFAList()**.
|
|
56
|
+
*
|
|
57
|
+
* As Parameter, you need to pass request id & one of the following: email or mobile phone or username.
|
|
58
|
+
*
|
|
59
|
+
* In case you are in prelogin page and don't have user information yet (such as mfa-required & account-verification page), you could pass
|
|
60
|
+
* request id & masked sub (one of the following: sub or q), depends on which one is available in the query parameter generated by cidaas.
|
|
61
|
+
*
|
|
56
62
|
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
|
|
57
63
|
* @example
|
|
58
64
|
* ```js
|
|
@@ -39,10 +39,24 @@ export interface VerifyAccountRequest {
|
|
|
39
39
|
code: string;
|
|
40
40
|
}
|
|
41
41
|
export interface GetMFAListRequest {
|
|
42
|
-
/** email of user */
|
|
43
|
-
email: string;
|
|
44
42
|
/** Request id returned from the authorization call */
|
|
45
43
|
request_id: string;
|
|
44
|
+
/** Email of the user */
|
|
45
|
+
email?: string;
|
|
46
|
+
/** Mobile number of the user */
|
|
47
|
+
mobile_number?: string;
|
|
48
|
+
/** Username of the user */
|
|
49
|
+
username?: string;
|
|
50
|
+
/**
|
|
51
|
+
* Masked sub (id of user)
|
|
52
|
+
* Either sub or q have to be provided, depends on what is given from the query parameter.
|
|
53
|
+
* */
|
|
54
|
+
sub?: string;
|
|
55
|
+
/**
|
|
56
|
+
* Masked sub (id of user)
|
|
57
|
+
* Either sub or q have to be provided, depends on what is given from the query parameter.
|
|
58
|
+
* */
|
|
59
|
+
q?: string;
|
|
46
60
|
}
|
|
47
61
|
export interface CancelMFARequest {
|
|
48
62
|
/** comes from initiate MFA process */
|