-
Notifications
You must be signed in to change notification settings - Fork 6
/
VerificationService.ts
286 lines (274 loc) · 10.2 KB
/
VerificationService.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
import {
IConfiguredListRequestEntity,
IInitVerificationAuthenticationRequestEntity,
IEnrollVerificationSetupRequestEntity,
IAuthVerificationAuthenticationRequestEntity,
AccountVerificationRequestEntity,
} from "./Entities"
import { Helper, CustomException } from "./Helper";
export namespace VerificationService {
/**
* To initiate the account verification, call **initiateAccountVerification()**. This will send verification code email or sms or ivr based on the verificationMedium you mentioned.
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/cgans5erj5alg-init-account-verification for more details.
* @example
* ```js
* cidaas.initiateAccountVerification({
* verificationMedium: 'email',
* requestId: 'your requestId',
* processingType: 'CODE',
* email: 'your email'
* }).then(function (response) {
* // the response will give you account verification details.
* }).catch(function(ex) {
* // your failure code here
* });
* ```
*/
export function initiateAccountVerification(options: AccountVerificationRequestEntity) {
try {
const url = window.webAuthSettings.authority + "/verification-srv/account/initiate";
let form = Helper.createForm(url, options)
document.body.appendChild(form);
form.submit();
} catch (ex) {
throw new CustomException(ex, 417);
}
};
/**
* To complete the verification, call **verifyAccount()**.
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/r8h9mvavvw2e6-verify-account for more details.
* @example
* ```js
* 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) {
* // the response will give you account verification ID and unique code.
* }).catch(function(ex) {
* // your failure code here
* });
* ```
*/
export function verifyAccount(options: {
accvid: string;
code: string;
}) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/account/verify";
return Helper.createHttpPromise(options, _serviceURL, false, "POST");
};
/**
* To get all configured multi factor authentication, call **getMFAList()**.
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/ee688a9c52b63-list-of-configured-verification-methods for more details.
* @example
* ```js
* cidaas.getMFAList({
* request_id: 'your request id',
* email: 'your email'
* }).then(function (response) {
* // the response will give you list of configured multi factor authentication
* }).catch(function(ex) {
* // your failure code here
* });
* ```
*/
export function getMFAList(options: IConfiguredListRequestEntity) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/public/configured/list";
return Helper.createHttpPromise(options, _serviceURL, false, "POST");
};
/**
* to cancel mfa process, call **cancelMFA()**.
* @example
* ```js
* cidaas.cancelMFA({
* exchange_id: 'exchange id from initiateMFA() response',
* reason: 'reason of mfa cancelation',
* type: 'authentication type e.g. email'
* }).then(function (response) {
* // your success code here
* }).catch(function(ex) {
* // your failure code here
* });
* ```
*/
export function cancelMFA(options: {
exchange_id: string;
reason: string;
type: string;
}) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/cancel/" + options.type;
return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
};
/**
* To get list of all verification type configured, call **getAllVerificationList()**. access_token must be passed as function parameter.
* @example
* ```js
* const access_token = "your access token";
*
* cidaas.getAllVerificationList(access_token)
* .then(function (response) {
* // type your code here
* })
* .catch(function (ex) {
* // your failure code here
* });
* ```
*/
export function getAllVerificationList(access_token: string) {
const _serviceURL = `${window.webAuthSettings.authority}/verification-srv/config/list`;
return Helper.createHttpPromise(undefined, _serviceURL, undefined, "GET", access_token);
};
/**
* To initiate enrollment of new multi factor authentication, call **initiateEnrollment()**.
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/f85aef6754714-initiate-physical-verification-setup for more details.
* @example
* ```js
* const access_token = "your access token";
* const options = {
* verification_type: 'one of verification_type such as fido2, face, ivr',
* deviceInfo: {
* deviceId: '',
* location: {lat: '', lon: ''}
* }
* }
*
* cidaas.initiateEnrollment(options, access_token)
* .then(function (response) {
* // type your code here
* })
* .catch(function (ex) {
* // your failure code here
* });
* ```
*/
export function initiateEnrollment(options: {
verification_type: string,
deviceInfo?: {
deviceId: string,
location: {
lat: string,
lon: string
}
}
}, accessToken: string) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/initiate/" + options.verification_type;
return Helper.createHttpPromise(options, _serviceURL, undefined, "POST", accessToken);
};
/**
* to get the status of MFA enrollment, call **getEnrollmentStatus()**.
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/b06447d02d8e0-get-status-of-physical-verification-setup-configuration for more details.
* @example
* ```js
* cidaas.getEnrollmentStatus('statusId from initiateEnrollment()', 'your access token')
* .then(function (response) {
* // type your code here
* })
* .catch(function (ex) {
* // your failure code here
* });
* ```
*/
export function getEnrollmentStatus(status_id: string, accessToken: string) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/notification/status/" + status_id;
return Helper.createHttpPromise(undefined, _serviceURL, undefined, "POST", accessToken);
};
/**
* to finish enrollment process of new multi factor authentication, call **enrollVerification()**.
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/branches/master/20ec76e937b27-enroll-physical-verification-setup for more details.
* @example
* ```js
* const fidoPayload = {
* sub: 'your sub',
* exchange_id: 'exchange_id from initiateEnrollment()',
* verification_type: 'fido2',
* fido2_client_response: {
* client_response: 'client_response from doing fido process',
* fidoRequestId: 'fidoRequestId from initiateEnrollment',
* }
* }
* cidaas.enrollVerification(fidoPayload)
* .then(function (response) {
* // type your code here
* })
* .catch(function (ex) {
* // your failure code here
* });
* ```
*/
export function enrollVerification(options: IEnrollVerificationSetupRequestEntity) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/enroll/" + options.verification_type;
return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
};
/**
* to see details of configured verification type, call **checkVerificationTypeConfigured()**.
* @example
* ```js
* cidaas.checkVerificationTypeConfigured({
* request_id: 'your request id',
* email: 'your email',
* verification_type: 'email'
* }).then(function (response) {
* // type your code here
* })
* .catch(function (ex) {
* // your failure code here
* });
* ```
*/
export function checkVerificationTypeConfigured(options: IConfiguredListRequestEntity) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/setup/public/configured/check/" + options.verification_type;
return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
};
/**
* to initiate multi factor auhentication, call **initiateMFA()**.
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/2a3ea581bb249-initiate-verification for more details.
* @example
* ```js
* const access_token = "your access token";
* const options = {
* request_id: 'your request id',
* usage_type: 'PASSWORDLESS_AUTHENTICATION',
* type: 'email'
* email: 'your email'
* }
* }
*
* cidaas.initiateMFA(options, access_token)
* .then(function (response) {
* // type your code here
* })
* .catch(function (ex) {
* // your failure code here
* });
* ```
*/
export function initiateMFA(options: IInitVerificationAuthenticationRequestEntity, accessToken?: string) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/initiate/" + options.type;
// TODO: remove accessToken parameter in the next major release
if (accessToken) {
return Helper.createHttpPromise(options, _serviceURL, false, "POST", accessToken);
}
return Helper.createHttpPromise(options, _serviceURL, false, "POST");
};
/**
* to authenticate with multi factor auhentication, call **authenticateMFA()**.
* Please refer to the api document https://docs.cidaas.com/docs/cidaas-iam/1aa38936252d6-perform-the-authentication-method for more details.
* @example
* ```js
* cidaas.authenticateMFA({
* type: 'email',
* client_id: 'your client id',
* exchange_id: exchange id from initiateMFA(),
* pass_code: 'code to authenticate'
* }).then(function (response) {
* // type your code here
* })
* .catch(function (ex) {
* // your failure code here
* });
* ```
*/
export function authenticateMFA(options: IAuthVerificationAuthenticationRequestEntity) {
var _serviceURL = window.webAuthSettings.authority + "/verification-srv/v2/authenticate/authenticate/" + options.type;
return Helper.createHttpPromise(options, _serviceURL, undefined, "POST");
};
}