@wix/auto_sdk_identity_authentication 1.0.3 → 1.0.6
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/build/{internal/cjs/src/iam-authentication-v1-authentication-authentication.universal.d.ts → iam-authentication-v1-authentication-authentication.universal-ByfoI5Md.d.mts} +203 -251
- package/build/{cjs/src/iam-authentication-v1-authentication-authentication.universal.d.ts → iam-authentication-v1-authentication-authentication.universal-ByfoI5Md.d.ts} +203 -251
- package/build/index.d.mts +71 -0
- package/build/index.d.ts +71 -0
- package/build/index.js +859 -0
- package/build/index.js.map +1 -0
- package/build/index.mjs +816 -0
- package/build/index.mjs.map +1 -0
- package/build/{es/src/iam-authentication-v1-authentication-authentication.universal.d.ts → internal/iam-authentication-v1-authentication-authentication.universal-ByfoI5Md.d.mts} +203 -251
- package/build/internal/{es/src/iam-authentication-v1-authentication-authentication.universal.d.ts → iam-authentication-v1-authentication-authentication.universal-ByfoI5Md.d.ts} +203 -251
- package/build/internal/index.d.mts +71 -0
- package/build/internal/index.d.ts +71 -0
- package/build/internal/index.js +859 -0
- package/build/internal/index.js.map +1 -0
- package/build/internal/index.mjs +816 -0
- package/build/internal/index.mjs.map +1 -0
- package/build/{es/src/iam-authentication-v1-authentication-authentication.types.d.ts → internal/meta.d.mts} +107 -281
- package/build/internal/{cjs/src/iam-authentication-v1-authentication-authentication.types.d.ts → meta.d.ts} +107 -281
- package/build/internal/meta.js +518 -0
- package/build/internal/meta.js.map +1 -0
- package/build/internal/meta.mjs +485 -0
- package/build/internal/meta.mjs.map +1 -0
- package/build/{cjs/src/iam-authentication-v1-authentication-authentication.types.d.ts → meta.d.mts} +107 -281
- package/build/{internal/es/src/iam-authentication-v1-authentication-authentication.types.d.ts → meta.d.ts} +107 -281
- package/build/meta.js +518 -0
- package/build/meta.js.map +1 -0
- package/build/meta.mjs +485 -0
- package/build/meta.mjs.map +1 -0
- package/package.json +13 -12
- package/build/cjs/index.d.ts +0 -1
- package/build/cjs/index.js +0 -18
- package/build/cjs/index.js.map +0 -1
- package/build/cjs/index.typings.d.ts +0 -1
- package/build/cjs/index.typings.js +0 -18
- package/build/cjs/index.typings.js.map +0 -1
- package/build/cjs/meta.d.ts +0 -1
- package/build/cjs/meta.js +0 -18
- package/build/cjs/meta.js.map +0 -1
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.context.d.ts +0 -11
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.context.js +0 -26
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.context.js.map +0 -1
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.http.d.ts +0 -27
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.http.js +0 -334
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.http.js.map +0 -1
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.meta.d.ts +0 -21
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.meta.js +0 -161
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.meta.js.map +0 -1
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.public.d.ts +0 -63
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.public.js +0 -61
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.public.js.map +0 -1
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.types.js +0 -115
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.types.js.map +0 -1
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.universal.js +0 -450
- package/build/cjs/src/iam-authentication-v1-authentication-authentication.universal.js.map +0 -1
- package/build/es/index.d.ts +0 -1
- package/build/es/index.js +0 -2
- package/build/es/index.js.map +0 -1
- package/build/es/index.typings.d.ts +0 -1
- package/build/es/index.typings.js +0 -2
- package/build/es/index.typings.js.map +0 -1
- package/build/es/meta.d.ts +0 -1
- package/build/es/meta.js +0 -2
- package/build/es/meta.js.map +0 -1
- package/build/es/package.json +0 -3
- package/build/es/src/iam-authentication-v1-authentication-authentication.context.d.ts +0 -11
- package/build/es/src/iam-authentication-v1-authentication-authentication.context.js +0 -11
- package/build/es/src/iam-authentication-v1-authentication-authentication.context.js.map +0 -1
- package/build/es/src/iam-authentication-v1-authentication-authentication.http.d.ts +0 -27
- package/build/es/src/iam-authentication-v1-authentication-authentication.http.js +0 -324
- package/build/es/src/iam-authentication-v1-authentication-authentication.http.js.map +0 -1
- package/build/es/src/iam-authentication-v1-authentication-authentication.meta.d.ts +0 -21
- package/build/es/src/iam-authentication-v1-authentication-authentication.meta.js +0 -128
- package/build/es/src/iam-authentication-v1-authentication-authentication.meta.js.map +0 -1
- package/build/es/src/iam-authentication-v1-authentication-authentication.public.d.ts +0 -63
- package/build/es/src/iam-authentication-v1-authentication-authentication.public.js +0 -39
- package/build/es/src/iam-authentication-v1-authentication-authentication.public.js.map +0 -1
- package/build/es/src/iam-authentication-v1-authentication-authentication.types.js +0 -112
- package/build/es/src/iam-authentication-v1-authentication-authentication.types.js.map +0 -1
- package/build/es/src/iam-authentication-v1-authentication-authentication.universal.js +0 -417
- package/build/es/src/iam-authentication-v1-authentication-authentication.universal.js.map +0 -1
- package/build/internal/cjs/index.d.ts +0 -1
- package/build/internal/cjs/index.js +0 -18
- package/build/internal/cjs/index.js.map +0 -1
- package/build/internal/cjs/index.typings.d.ts +0 -1
- package/build/internal/cjs/index.typings.js +0 -18
- package/build/internal/cjs/index.typings.js.map +0 -1
- package/build/internal/cjs/meta.d.ts +0 -1
- package/build/internal/cjs/meta.js +0 -18
- package/build/internal/cjs/meta.js.map +0 -1
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.context.d.ts +0 -11
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.context.js +0 -26
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.context.js.map +0 -1
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.http.d.ts +0 -27
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.http.js +0 -334
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.http.js.map +0 -1
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.meta.d.ts +0 -21
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.meta.js +0 -161
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.meta.js.map +0 -1
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.public.d.ts +0 -63
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.public.js +0 -61
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.public.js.map +0 -1
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.types.js +0 -115
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.types.js.map +0 -1
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.universal.js +0 -450
- package/build/internal/cjs/src/iam-authentication-v1-authentication-authentication.universal.js.map +0 -1
- package/build/internal/es/index.d.ts +0 -1
- package/build/internal/es/index.js +0 -2
- package/build/internal/es/index.js.map +0 -1
- package/build/internal/es/index.typings.d.ts +0 -1
- package/build/internal/es/index.typings.js +0 -2
- package/build/internal/es/index.typings.js.map +0 -1
- package/build/internal/es/meta.d.ts +0 -1
- package/build/internal/es/meta.js +0 -2
- package/build/internal/es/meta.js.map +0 -1
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.context.d.ts +0 -11
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.context.js +0 -11
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.context.js.map +0 -1
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.http.d.ts +0 -27
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.http.js +0 -324
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.http.js.map +0 -1
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.meta.d.ts +0 -21
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.meta.js +0 -128
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.meta.js.map +0 -1
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.public.d.ts +0 -63
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.public.js +0 -39
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.public.js.map +0 -1
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.types.js +0 -112
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.types.js.map +0 -1
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.universal.js +0 -417
- package/build/internal/es/src/iam-authentication-v1-authentication-authentication.universal.js.map +0 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
|
|
1
|
+
interface Authentication {
|
|
2
2
|
}
|
|
3
|
-
|
|
3
|
+
interface RegisterV2Request {
|
|
4
4
|
/** Identifier of the registering member. */
|
|
5
5
|
loginId: LoginId;
|
|
6
6
|
/** Password of the registering member. */
|
|
@@ -12,7 +12,7 @@ export interface RegisterV2Request {
|
|
|
12
12
|
/** Additional data that's relevant for the flow. */
|
|
13
13
|
clientMetaData?: Record<string, any> | null;
|
|
14
14
|
}
|
|
15
|
-
|
|
15
|
+
interface LoginId extends LoginIdTypeOneOf {
|
|
16
16
|
/**
|
|
17
17
|
* Login email address.
|
|
18
18
|
* @format EMAIL
|
|
@@ -20,14 +20,14 @@ export interface LoginId extends LoginIdTypeOneOf {
|
|
|
20
20
|
email?: string;
|
|
21
21
|
}
|
|
22
22
|
/** @oneof */
|
|
23
|
-
|
|
23
|
+
interface LoginIdTypeOneOf {
|
|
24
24
|
/**
|
|
25
25
|
* Login email address.
|
|
26
26
|
* @format EMAIL
|
|
27
27
|
*/
|
|
28
28
|
email?: string;
|
|
29
29
|
}
|
|
30
|
-
|
|
30
|
+
interface IdentityProfile {
|
|
31
31
|
/** Profile first name. */
|
|
32
32
|
firstName?: string | null;
|
|
33
33
|
/** Profile last name. */
|
|
@@ -94,7 +94,7 @@ export interface IdentityProfile {
|
|
|
94
94
|
*/
|
|
95
95
|
slug?: string | null;
|
|
96
96
|
}
|
|
97
|
-
|
|
97
|
+
declare enum PrivacyStatus {
|
|
98
98
|
/** No defined privacy status. */
|
|
99
99
|
UNDEFINED = "UNDEFINED",
|
|
100
100
|
/** Profile details, such as profile name and profile picture, are visible to other members. */
|
|
@@ -102,7 +102,7 @@ export declare enum PrivacyStatus {
|
|
|
102
102
|
/** Profile details aren't visible to other members. */
|
|
103
103
|
PRIVATE = "PRIVATE"
|
|
104
104
|
}
|
|
105
|
-
|
|
105
|
+
interface CustomField {
|
|
106
106
|
/**
|
|
107
107
|
* Custom field name. The name must match one of the key properties of the objects returned by
|
|
108
108
|
* [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields)
|
|
@@ -112,7 +112,7 @@ export interface CustomField {
|
|
|
112
112
|
/** Custom field value. */
|
|
113
113
|
value?: V1CustomValue;
|
|
114
114
|
}
|
|
115
|
-
|
|
115
|
+
interface V1CustomValue extends V1CustomValueValueOneOf {
|
|
116
116
|
/** String value. */
|
|
117
117
|
strValue?: string;
|
|
118
118
|
/** Number value. */
|
|
@@ -125,7 +125,7 @@ export interface V1CustomValue extends V1CustomValueValueOneOf {
|
|
|
125
125
|
mapValue?: V1MapValue;
|
|
126
126
|
}
|
|
127
127
|
/** @oneof */
|
|
128
|
-
|
|
128
|
+
interface V1CustomValueValueOneOf {
|
|
129
129
|
/** String value. */
|
|
130
130
|
strValue?: string;
|
|
131
131
|
/** Number value. */
|
|
@@ -137,15 +137,15 @@ export interface V1CustomValueValueOneOf {
|
|
|
137
137
|
/** Map of values. */
|
|
138
138
|
mapValue?: V1MapValue;
|
|
139
139
|
}
|
|
140
|
-
|
|
140
|
+
interface V1ListValue {
|
|
141
141
|
/** Custom value. */
|
|
142
142
|
value?: V1CustomValue[];
|
|
143
143
|
}
|
|
144
|
-
|
|
144
|
+
interface V1MapValue {
|
|
145
145
|
/** Mapped custom value. */
|
|
146
146
|
value?: Record<string, V1CustomValue>;
|
|
147
147
|
}
|
|
148
|
-
|
|
148
|
+
interface SecondaryEmail {
|
|
149
149
|
/**
|
|
150
150
|
* Email address.
|
|
151
151
|
* @format EMAIL
|
|
@@ -154,13 +154,13 @@ export interface SecondaryEmail {
|
|
|
154
154
|
/** Email tag. */
|
|
155
155
|
tag?: EmailTag;
|
|
156
156
|
}
|
|
157
|
-
|
|
157
|
+
declare enum EmailTag {
|
|
158
158
|
UNTAGGED = "UNTAGGED",
|
|
159
159
|
MAIN = "MAIN",
|
|
160
160
|
HOME = "HOME",
|
|
161
161
|
WORK = "WORK"
|
|
162
162
|
}
|
|
163
|
-
|
|
163
|
+
interface Phone {
|
|
164
164
|
/**
|
|
165
165
|
* Phone country code.
|
|
166
166
|
* @format COUNTRY
|
|
@@ -174,7 +174,7 @@ export interface Phone {
|
|
|
174
174
|
/** Phone tag. */
|
|
175
175
|
tag?: PhoneTag;
|
|
176
176
|
}
|
|
177
|
-
|
|
177
|
+
declare enum PhoneTag {
|
|
178
178
|
UNTAGGED = "UNTAGGED",
|
|
179
179
|
MAIN = "MAIN",
|
|
180
180
|
HOME = "HOME",
|
|
@@ -182,14 +182,14 @@ export declare enum PhoneTag {
|
|
|
182
182
|
WORK = "WORK",
|
|
183
183
|
FAX = "FAX"
|
|
184
184
|
}
|
|
185
|
-
|
|
185
|
+
interface AddressWrapper {
|
|
186
186
|
/** Address. */
|
|
187
187
|
address?: Address;
|
|
188
188
|
/** Address tag. */
|
|
189
189
|
tag?: AddressTag;
|
|
190
190
|
}
|
|
191
191
|
/** Physical address */
|
|
192
|
-
|
|
192
|
+
interface Address {
|
|
193
193
|
/**
|
|
194
194
|
* Country code.
|
|
195
195
|
* @format COUNTRY
|
|
@@ -206,14 +206,14 @@ export interface Address {
|
|
|
206
206
|
/** Free text providing more detailed address info. Usually contains apartment, suite, and floor. */
|
|
207
207
|
addressLine2?: string | null;
|
|
208
208
|
}
|
|
209
|
-
|
|
209
|
+
declare enum AddressTag {
|
|
210
210
|
UNTAGGED = "UNTAGGED",
|
|
211
211
|
HOME = "HOME",
|
|
212
212
|
WORK = "WORK",
|
|
213
213
|
BILLING = "BILLING",
|
|
214
214
|
SHIPPING = "SHIPPING"
|
|
215
215
|
}
|
|
216
|
-
|
|
216
|
+
interface CaptchaToken extends CaptchaTokenTokenOneOf {
|
|
217
217
|
/** @maxLength 5000 */
|
|
218
218
|
Recaptcha?: string;
|
|
219
219
|
/** @maxLength 5000 */
|
|
@@ -222,7 +222,7 @@ export interface CaptchaToken extends CaptchaTokenTokenOneOf {
|
|
|
222
222
|
NoCaptcha?: string;
|
|
223
223
|
}
|
|
224
224
|
/** @oneof */
|
|
225
|
-
|
|
225
|
+
interface CaptchaTokenTokenOneOf {
|
|
226
226
|
/** @maxLength 5000 */
|
|
227
227
|
Recaptcha?: string;
|
|
228
228
|
/** @maxLength 5000 */
|
|
@@ -230,7 +230,7 @@ export interface CaptchaTokenTokenOneOf {
|
|
|
230
230
|
/** @maxLength 5000 */
|
|
231
231
|
NoCaptcha?: string;
|
|
232
232
|
}
|
|
233
|
-
|
|
233
|
+
interface StateMachineResponse extends StateMachineResponseStateDataOneOf {
|
|
234
234
|
/** Current state of the login or registration process. */
|
|
235
235
|
state?: StateType;
|
|
236
236
|
/** Session token. If `state` is not `SUCCESS`, this field is undefined. */
|
|
@@ -243,9 +243,9 @@ export interface StateMachineResponse extends StateMachineResponseStateDataOneOf
|
|
|
243
243
|
additionalData?: Record<string, CustomValue>;
|
|
244
244
|
}
|
|
245
245
|
/** @oneof */
|
|
246
|
-
|
|
246
|
+
interface StateMachineResponseStateDataOneOf {
|
|
247
247
|
}
|
|
248
|
-
|
|
248
|
+
declare enum StateType {
|
|
249
249
|
/** Initial unknown state. */
|
|
250
250
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
251
251
|
/** Login completed successfully. */
|
|
@@ -257,7 +257,7 @@ export declare enum StateType {
|
|
|
257
257
|
/** Indicates that the `status` is not one that prevents the member logging in, meaning it's not `OFFLINE`, `BLOCKED`, or `DELETED`. */
|
|
258
258
|
STATUS_CHECK = "STATUS_CHECK"
|
|
259
259
|
}
|
|
260
|
-
|
|
260
|
+
interface Identity {
|
|
261
261
|
/**
|
|
262
262
|
* Identity ID.
|
|
263
263
|
* @format GUID
|
|
@@ -303,20 +303,20 @@ export interface Identity {
|
|
|
303
303
|
*/
|
|
304
304
|
factors?: Factor[];
|
|
305
305
|
}
|
|
306
|
-
|
|
306
|
+
interface Connection extends ConnectionTypeOneOf {
|
|
307
307
|
/** IDP connection. */
|
|
308
308
|
idpConnection?: IdpConnection;
|
|
309
309
|
/** Authenticator connection. */
|
|
310
310
|
authenticatorConnection?: AuthenticatorConnection;
|
|
311
311
|
}
|
|
312
312
|
/** @oneof */
|
|
313
|
-
|
|
313
|
+
interface ConnectionTypeOneOf {
|
|
314
314
|
/** IDP connection. */
|
|
315
315
|
idpConnection?: IdpConnection;
|
|
316
316
|
/** Authenticator connection. */
|
|
317
317
|
authenticatorConnection?: AuthenticatorConnection;
|
|
318
318
|
}
|
|
319
|
-
|
|
319
|
+
interface IdpConnection {
|
|
320
320
|
/**
|
|
321
321
|
* IDP connection ID.
|
|
322
322
|
* @format GUID
|
|
@@ -325,7 +325,7 @@ export interface IdpConnection {
|
|
|
325
325
|
/** IDP user ID. */
|
|
326
326
|
idpUserId?: string;
|
|
327
327
|
}
|
|
328
|
-
|
|
328
|
+
interface AuthenticatorConnection {
|
|
329
329
|
/**
|
|
330
330
|
* Authenticator connection ID.
|
|
331
331
|
* @format GUID
|
|
@@ -334,14 +334,14 @@ export interface AuthenticatorConnection {
|
|
|
334
334
|
/** Whether re-enrollment is required. */
|
|
335
335
|
reEnrollmentRequired?: boolean;
|
|
336
336
|
}
|
|
337
|
-
|
|
337
|
+
interface Metadata {
|
|
338
338
|
/**
|
|
339
339
|
* General tags. For example, `"isOwner"`.
|
|
340
340
|
* @readonly
|
|
341
341
|
*/
|
|
342
342
|
tags?: string[];
|
|
343
343
|
}
|
|
344
|
-
|
|
344
|
+
interface Email {
|
|
345
345
|
/**
|
|
346
346
|
* Email address.
|
|
347
347
|
* @format EMAIL
|
|
@@ -350,11 +350,11 @@ export interface Email {
|
|
|
350
350
|
/** Whether the email address is verified. */
|
|
351
351
|
isVerified?: boolean;
|
|
352
352
|
}
|
|
353
|
-
|
|
353
|
+
interface StatusV2 {
|
|
354
354
|
name?: StatusName;
|
|
355
355
|
reasons?: Reason[];
|
|
356
356
|
}
|
|
357
|
-
|
|
357
|
+
declare enum StatusName {
|
|
358
358
|
UNKNOWN_STATUS = "UNKNOWN_STATUS",
|
|
359
359
|
PENDING = "PENDING",
|
|
360
360
|
ACTIVE = "ACTIVE",
|
|
@@ -362,12 +362,12 @@ export declare enum StatusName {
|
|
|
362
362
|
BLOCKED = "BLOCKED",
|
|
363
363
|
OFFLINE = "OFFLINE"
|
|
364
364
|
}
|
|
365
|
-
|
|
365
|
+
declare enum Reason {
|
|
366
366
|
UNKNOWN_REASON = "UNKNOWN_REASON",
|
|
367
367
|
PENDING_ADMIN_APPROVAL_REQUIRED = "PENDING_ADMIN_APPROVAL_REQUIRED",
|
|
368
368
|
PENDING_EMAIL_VERIFICATION_REQUIRED = "PENDING_EMAIL_VERIFICATION_REQUIRED"
|
|
369
369
|
}
|
|
370
|
-
|
|
370
|
+
interface Factor {
|
|
371
371
|
/**
|
|
372
372
|
* Factor ID.
|
|
373
373
|
* @format GUID
|
|
@@ -378,7 +378,7 @@ export interface Factor {
|
|
|
378
378
|
/** Factor status. */
|
|
379
379
|
status?: Status;
|
|
380
380
|
}
|
|
381
|
-
|
|
381
|
+
declare enum FactorType {
|
|
382
382
|
/** Unknown factor type. */
|
|
383
383
|
UNKNOWN_FACTOR_TYPE = "UNKNOWN_FACTOR_TYPE",
|
|
384
384
|
/** Requires a password. */
|
|
@@ -392,9 +392,11 @@ export declare enum FactorType {
|
|
|
392
392
|
/** Requires authentication via an authenticator app. */
|
|
393
393
|
TOTP = "TOTP",
|
|
394
394
|
/** Requires authentication via a push notification. */
|
|
395
|
-
PUSH = "PUSH"
|
|
395
|
+
PUSH = "PUSH",
|
|
396
|
+
/** Requires authentication via WebAuthn/passkey. */
|
|
397
|
+
WEBAUTHN = "WEBAUTHN"
|
|
396
398
|
}
|
|
397
|
-
|
|
399
|
+
declare enum Status {
|
|
398
400
|
/** Factor requires activation. */
|
|
399
401
|
INACTIVE = "INACTIVE",
|
|
400
402
|
/** Factor is active and can be used for authentication. */
|
|
@@ -402,7 +404,7 @@ export declare enum Status {
|
|
|
402
404
|
/** Factor is blocked and cannot be used for authentication. The user should reenroll the factor. */
|
|
403
405
|
REQUIRE_REENROLL = "REQUIRE_REENROLL"
|
|
404
406
|
}
|
|
405
|
-
|
|
407
|
+
interface CustomValue extends CustomValueValueOneOf {
|
|
406
408
|
/** String value. */
|
|
407
409
|
strValue?: string;
|
|
408
410
|
/** Number value. */
|
|
@@ -415,7 +417,7 @@ export interface CustomValue extends CustomValueValueOneOf {
|
|
|
415
417
|
mapValue?: MapValue;
|
|
416
418
|
}
|
|
417
419
|
/** @oneof */
|
|
418
|
-
|
|
420
|
+
interface CustomValueValueOneOf {
|
|
419
421
|
/** String value. */
|
|
420
422
|
strValue?: string;
|
|
421
423
|
/** Number value. */
|
|
@@ -427,15 +429,15 @@ export interface CustomValueValueOneOf {
|
|
|
427
429
|
/** Map value. */
|
|
428
430
|
mapValue?: MapValue;
|
|
429
431
|
}
|
|
430
|
-
|
|
432
|
+
interface ListValue {
|
|
431
433
|
/** Custom value. */
|
|
432
434
|
value?: CustomValue[];
|
|
433
435
|
}
|
|
434
|
-
|
|
436
|
+
interface MapValue {
|
|
435
437
|
/** Mapped custom value. */
|
|
436
438
|
value?: Record<string, CustomValue>;
|
|
437
439
|
}
|
|
438
|
-
|
|
440
|
+
interface RequireMfaData {
|
|
439
441
|
/**
|
|
440
442
|
* The factors available for the user to perform the required MFA.
|
|
441
443
|
* @maxSize 100
|
|
@@ -444,13 +446,13 @@ export interface RequireMfaData {
|
|
|
444
446
|
/** The reason the user is required to perform MFA. */
|
|
445
447
|
reason?: MfaReason;
|
|
446
448
|
}
|
|
447
|
-
|
|
449
|
+
interface V1Factor {
|
|
448
450
|
/** Type of verification factor. */
|
|
449
451
|
factorType?: FactorType;
|
|
450
452
|
/** Availability status for second factor */
|
|
451
453
|
factorStatus?: FactorStatus;
|
|
452
454
|
}
|
|
453
|
-
|
|
455
|
+
declare enum FactorStatus {
|
|
454
456
|
UNKNOWN_FACTOR_STATUS = "UNKNOWN_FACTOR_STATUS",
|
|
455
457
|
ENABLED = "ENABLED",
|
|
456
458
|
REQUIRE_ACTIVATION = "REQUIRE_ACTIVATION",
|
|
@@ -458,14 +460,14 @@ export declare enum FactorStatus {
|
|
|
458
460
|
ENABLED_BY_RULE = "ENABLED_BY_RULE",
|
|
459
461
|
DISABLED_BY_RULE = "DISABLED_BY_RULE"
|
|
460
462
|
}
|
|
461
|
-
|
|
463
|
+
declare enum MfaReason {
|
|
462
464
|
UNKNOWN_MFA_REASON = "UNKNOWN_MFA_REASON",
|
|
463
465
|
/** Mfa is required due to user settings */
|
|
464
466
|
USER_SETTINGS = "USER_SETTINGS",
|
|
465
467
|
/** Mfa is required due to high risk login */
|
|
466
468
|
HIGH_RISK_LOGIN = "HIGH_RISK_LOGIN"
|
|
467
469
|
}
|
|
468
|
-
|
|
470
|
+
interface MfaChallengeData {
|
|
469
471
|
/** Type of verifation factor. */
|
|
470
472
|
factorType?: FactorType;
|
|
471
473
|
verificationChallengeData?: VerificationChallenge;
|
|
@@ -477,16 +479,18 @@ export interface MfaChallengeData {
|
|
|
477
479
|
/** The reason the user is required to perform MFA. */
|
|
478
480
|
reason?: MfaReason;
|
|
479
481
|
}
|
|
480
|
-
|
|
482
|
+
interface VerificationChallenge extends VerificationChallengeFactorChallengeDataOneOf {
|
|
481
483
|
pushData?: PushChallengeData;
|
|
484
|
+
webauthnData?: WebAuthnChallengeData;
|
|
482
485
|
/** @maxLength 200 */
|
|
483
486
|
hint?: string | null;
|
|
484
487
|
}
|
|
485
488
|
/** @oneof */
|
|
486
|
-
|
|
489
|
+
interface VerificationChallengeFactorChallengeDataOneOf {
|
|
487
490
|
pushData?: PushChallengeData;
|
|
491
|
+
webauthnData?: WebAuthnChallengeData;
|
|
488
492
|
}
|
|
489
|
-
|
|
493
|
+
interface PushChallengeData {
|
|
490
494
|
/**
|
|
491
495
|
* This should be tied to a specific push notification.
|
|
492
496
|
* It will be sent in subsequent requests to verify the factor.
|
|
@@ -494,7 +498,100 @@ export interface PushChallengeData {
|
|
|
494
498
|
*/
|
|
495
499
|
transactionId?: string;
|
|
496
500
|
}
|
|
497
|
-
|
|
501
|
+
interface WebAuthnChallengeData {
|
|
502
|
+
/**
|
|
503
|
+
* A unique identifier for this challenge that will be used to correlate
|
|
504
|
+
* the authentication response with this challenge.
|
|
505
|
+
* This should be a cryptographically random GUID to prevent guessing attacks.
|
|
506
|
+
* @format GUID
|
|
507
|
+
*/
|
|
508
|
+
challengeId?: string;
|
|
509
|
+
/**
|
|
510
|
+
* The challenge that will be signed by the authenticator during the WebAuthn authentication ceremony.
|
|
511
|
+
* This should be a cryptographically secure random value with at least 16 bytes of entropy.
|
|
512
|
+
* The value is used to prevent replay attacks and MUST be randomly generated by the implementer.
|
|
513
|
+
*/
|
|
514
|
+
challenge?: Uint8Array;
|
|
515
|
+
/**
|
|
516
|
+
* The timeout in milliseconds for the WebAuthn authentication ceremony.
|
|
517
|
+
* After this time, the challenge will be considered expired and the authentication will need to be restarted.
|
|
518
|
+
* This is optional and may be overridden by the client if provided.
|
|
519
|
+
* The WebAuthn spec recommends a timeout of at least 1 minute (60000ms).
|
|
520
|
+
*/
|
|
521
|
+
timeoutMs?: number | null;
|
|
522
|
+
/**
|
|
523
|
+
* Optional list of credentials that are acceptable for this authentication ceremony.
|
|
524
|
+
* If empty, all credentials associated with the user will be considered.
|
|
525
|
+
* @maxSize 10
|
|
526
|
+
*/
|
|
527
|
+
allowCredentials?: PublicKeyCredentialDescriptor[];
|
|
528
|
+
/** Specifies the requirement for user verification during the authentication ceremony. */
|
|
529
|
+
userVerification?: UserVerificationRequirement;
|
|
530
|
+
/**
|
|
531
|
+
* Optional hints to guide the client UI
|
|
532
|
+
* Examples include "security-key" to emphasize external authenticators
|
|
533
|
+
* or "client-device" to emphasize built-in authenticators
|
|
534
|
+
* @maxLength 50
|
|
535
|
+
* @maxSize 10
|
|
536
|
+
*/
|
|
537
|
+
hints?: string[];
|
|
538
|
+
/**
|
|
539
|
+
* Optional extensions for the authentication ceremony
|
|
540
|
+
* Provides additional parameters for specialized WebAuthn functionality
|
|
541
|
+
*/
|
|
542
|
+
extensions?: AuthenticationExtensionInputs;
|
|
543
|
+
}
|
|
544
|
+
interface PublicKeyCredentialDescriptor {
|
|
545
|
+
/** The credential ID */
|
|
546
|
+
_id?: Uint8Array;
|
|
547
|
+
/**
|
|
548
|
+
* An optional hint as to the transports used by the credential
|
|
549
|
+
* Examples include "usb", "nfc", "ble", "internal", "hybrid"
|
|
550
|
+
* @maxLength 50
|
|
551
|
+
* @maxSize 10
|
|
552
|
+
*/
|
|
553
|
+
transports?: string[];
|
|
554
|
+
}
|
|
555
|
+
declare enum UserVerificationRequirement {
|
|
556
|
+
/** Default unspecified value */
|
|
557
|
+
USER_VERIFICATION_UNSPECIFIED = "USER_VERIFICATION_UNSPECIFIED",
|
|
558
|
+
/**
|
|
559
|
+
* The Relying Party requires user verification and will fail the operation if the response doesn't have the UV flag
|
|
560
|
+
* set
|
|
561
|
+
*/
|
|
562
|
+
USER_VERIFICATION_REQUIRED = "USER_VERIFICATION_REQUIRED",
|
|
563
|
+
/** The Relying Party prefers user verification but will not fail the operation if unavailable */
|
|
564
|
+
USER_VERIFICATION_PREFERRED = "USER_VERIFICATION_PREFERRED",
|
|
565
|
+
/** The Relying Party does not want user verification employed (e.g., to minimize disruption to the user experience) */
|
|
566
|
+
USER_VERIFICATION_DISCOURAGED = "USER_VERIFICATION_DISCOURAGED"
|
|
567
|
+
}
|
|
568
|
+
interface AuthenticationExtensionInputs extends AuthenticationExtensionInputsLargeBlobOperationOneOf {
|
|
569
|
+
/** Read existing large blob data from the authenticator */
|
|
570
|
+
largeBlobRead?: boolean;
|
|
571
|
+
/** Write data to the authenticator's large blob storage */
|
|
572
|
+
largeBlobWrite?: Uint8Array;
|
|
573
|
+
/**
|
|
574
|
+
* FIDO AppID Extension (appid)
|
|
575
|
+
* An AppID that was used for previously registered U2F authenticators
|
|
576
|
+
* This makes already-registered U2F credentials forward-compatible with the WebAuthn API
|
|
577
|
+
* @maxLength 256
|
|
578
|
+
*/
|
|
579
|
+
appid?: string;
|
|
580
|
+
/**
|
|
581
|
+
* User Verification Method Extension (uvm)
|
|
582
|
+
* Requests the authenticator to report which verification methods were used
|
|
583
|
+
* Examples include fingerprint, PIN, or facial recognition
|
|
584
|
+
*/
|
|
585
|
+
uvm?: boolean;
|
|
586
|
+
}
|
|
587
|
+
/** @oneof */
|
|
588
|
+
interface AuthenticationExtensionInputsLargeBlobOperationOneOf {
|
|
589
|
+
/** Read existing large blob data from the authenticator */
|
|
590
|
+
largeBlobRead?: boolean;
|
|
591
|
+
/** Write data to the authenticator's large blob storage */
|
|
592
|
+
largeBlobWrite?: Uint8Array;
|
|
593
|
+
}
|
|
594
|
+
interface LoginV2Request {
|
|
498
595
|
/** Identifier of identity logging in. */
|
|
499
596
|
loginId: LoginId;
|
|
500
597
|
/** Password of the identity logging in. */
|
|
@@ -504,13 +601,13 @@ export interface LoginV2Request {
|
|
|
504
601
|
/** Additional data that's relevant for the flow. */
|
|
505
602
|
clientMetaData?: Record<string, any> | null;
|
|
506
603
|
}
|
|
507
|
-
|
|
604
|
+
interface ChangePasswordRequest {
|
|
508
605
|
/** The new password to set for the logged in user */
|
|
509
606
|
newPassword: string;
|
|
510
607
|
}
|
|
511
|
-
|
|
608
|
+
interface ChangePasswordResponse {
|
|
512
609
|
}
|
|
513
|
-
|
|
610
|
+
interface LoginWithIdpConnectionRequest {
|
|
514
611
|
/**
|
|
515
612
|
* The id of the connection id (can be fetched by calling connection-service.listEnabledConnectionsClientData
|
|
516
613
|
* @format GUID
|
|
@@ -534,22 +631,22 @@ export interface LoginWithIdpConnectionRequest {
|
|
|
534
631
|
visitorId?: string | null;
|
|
535
632
|
bsi?: string | null;
|
|
536
633
|
}
|
|
537
|
-
|
|
634
|
+
declare enum TenantType {
|
|
538
635
|
UNKNOWN_TENANT_TYPE = "UNKNOWN_TENANT_TYPE",
|
|
539
636
|
ACCOUNT = "ACCOUNT",
|
|
540
637
|
SITE = "SITE",
|
|
541
638
|
ROOT = "ROOT"
|
|
542
639
|
}
|
|
543
|
-
|
|
640
|
+
interface RawHttpResponse {
|
|
544
641
|
body?: Uint8Array;
|
|
545
642
|
statusCode?: number | null;
|
|
546
643
|
headers?: HeadersEntry[];
|
|
547
644
|
}
|
|
548
|
-
|
|
645
|
+
interface HeadersEntry {
|
|
549
646
|
key?: string;
|
|
550
647
|
value?: string;
|
|
551
648
|
}
|
|
552
|
-
|
|
649
|
+
interface RawHttpRequest {
|
|
553
650
|
body?: Uint8Array;
|
|
554
651
|
pathParams?: PathParametersEntry[];
|
|
555
652
|
queryParams?: QueryParametersEntry[];
|
|
@@ -558,21 +655,21 @@ export interface RawHttpRequest {
|
|
|
558
655
|
rawPath?: string;
|
|
559
656
|
rawQuery?: string;
|
|
560
657
|
}
|
|
561
|
-
|
|
658
|
+
interface PathParametersEntry {
|
|
562
659
|
key?: string;
|
|
563
660
|
value?: string;
|
|
564
661
|
}
|
|
565
|
-
|
|
662
|
+
interface QueryParametersEntry {
|
|
566
663
|
key?: string;
|
|
567
664
|
value?: string;
|
|
568
665
|
}
|
|
569
|
-
|
|
666
|
+
interface LoginCallbackRequest {
|
|
570
667
|
/** state that that received on the redirect */
|
|
571
668
|
state?: string;
|
|
572
669
|
/** session token */
|
|
573
670
|
sessionToken?: string;
|
|
574
671
|
}
|
|
575
|
-
|
|
672
|
+
interface LoginWithIdpConnectionTokenParamsRequest {
|
|
576
673
|
/**
|
|
577
674
|
* The id of the connection id (can be fetched by calling connection-service.listEnabledConnectionsClientData)
|
|
578
675
|
* @format GUID
|
|
@@ -581,7 +678,7 @@ export interface LoginWithIdpConnectionTokenParamsRequest {
|
|
|
581
678
|
/** A set of fields that are required for the connection to be able to identify and authenticate the user */
|
|
582
679
|
tokenParams?: Record<string, string>;
|
|
583
680
|
}
|
|
584
|
-
|
|
681
|
+
interface SignOnRequest {
|
|
585
682
|
/** the identifier of the identity */
|
|
586
683
|
loginId: LoginId;
|
|
587
684
|
/** profile of the identity */
|
|
@@ -591,14 +688,14 @@ export interface SignOnRequest {
|
|
|
591
688
|
/** when false will create a new contact instead of merging the existing contact into the identity */
|
|
592
689
|
mergeExistingContact?: boolean;
|
|
593
690
|
}
|
|
594
|
-
|
|
691
|
+
interface SignOnResponse {
|
|
595
692
|
/** session token for the requested identity */
|
|
596
693
|
sessionToken?: string;
|
|
597
694
|
/** The Identity of the provided login_id */
|
|
598
695
|
identity?: Identity;
|
|
599
696
|
}
|
|
600
697
|
/** logout request payload */
|
|
601
|
-
|
|
698
|
+
interface LogoutRequest {
|
|
602
699
|
/**
|
|
603
700
|
* redirect after logout
|
|
604
701
|
* @format WEB_URL
|
|
@@ -610,12 +707,13 @@ export interface LogoutRequest {
|
|
|
610
707
|
*/
|
|
611
708
|
clientId?: string | null;
|
|
612
709
|
}
|
|
613
|
-
|
|
710
|
+
interface VerifyRequest extends VerifyRequestFactorDataOneOf {
|
|
614
711
|
smsData?: SmsVerifyData;
|
|
615
712
|
callData?: CallVerifyData;
|
|
616
713
|
emailData?: ExternalEmailVerifyData;
|
|
617
714
|
totpData?: TotpVerifyData;
|
|
618
715
|
pushData?: PushVerifyData;
|
|
716
|
+
webauthnData?: WebAuthnVerifyData;
|
|
619
717
|
/**
|
|
620
718
|
* TODO: is this a reasonable maxLength?
|
|
621
719
|
* @maxLength 1000
|
|
@@ -625,168 +723,70 @@ export interface VerifyRequest extends VerifyRequestFactorDataOneOf {
|
|
|
625
723
|
rememberThisDevice?: boolean;
|
|
626
724
|
}
|
|
627
725
|
/** @oneof */
|
|
628
|
-
|
|
726
|
+
interface VerifyRequestFactorDataOneOf {
|
|
629
727
|
smsData?: SmsVerifyData;
|
|
630
728
|
callData?: CallVerifyData;
|
|
631
729
|
emailData?: ExternalEmailVerifyData;
|
|
632
730
|
totpData?: TotpVerifyData;
|
|
633
731
|
pushData?: PushVerifyData;
|
|
732
|
+
webauthnData?: WebAuthnVerifyData;
|
|
634
733
|
}
|
|
635
|
-
|
|
734
|
+
interface SmsVerifyData {
|
|
636
735
|
/**
|
|
637
736
|
* @minLength 1
|
|
638
737
|
* @maxLength 100
|
|
639
738
|
*/
|
|
640
739
|
code?: string | null;
|
|
641
740
|
}
|
|
642
|
-
|
|
741
|
+
interface CallVerifyData {
|
|
643
742
|
/**
|
|
644
743
|
* @minLength 1
|
|
645
744
|
* @maxLength 100
|
|
646
745
|
*/
|
|
647
746
|
code?: string | null;
|
|
648
747
|
}
|
|
649
|
-
|
|
748
|
+
interface ExternalEmailVerifyData {
|
|
650
749
|
/**
|
|
651
750
|
* @minLength 1
|
|
652
751
|
* @maxLength 100
|
|
653
752
|
*/
|
|
654
753
|
code?: string | null;
|
|
655
754
|
}
|
|
656
|
-
|
|
755
|
+
interface TotpVerifyData {
|
|
657
756
|
/**
|
|
658
757
|
* @minLength 1
|
|
659
758
|
* @maxLength 100
|
|
660
759
|
*/
|
|
661
760
|
code?: string | null;
|
|
662
761
|
}
|
|
663
|
-
|
|
762
|
+
interface PushVerifyData {
|
|
664
763
|
/** @maxLength 36 */
|
|
665
764
|
transactionId?: string | null;
|
|
666
765
|
}
|
|
667
|
-
interface
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
|
|
766
|
+
interface WebAuthnVerifyData {
|
|
767
|
+
/**
|
|
768
|
+
* The challenge_id from the WebAuthnChallengeData that was returned in the previous
|
|
769
|
+
* verification response. This will always be present when completing the WebAuthn authentication
|
|
770
|
+
* ceremony with the credential data from the client.
|
|
771
|
+
* @format GUID
|
|
772
|
+
*/
|
|
773
|
+
challengeId?: string | null;
|
|
774
|
+
/**
|
|
775
|
+
* If this field is present, this is a request to complete the WebAuthn authentication
|
|
776
|
+
* with the credential data from the client.
|
|
777
|
+
*
|
|
778
|
+
* The credential contains a JSON string representation of a WebAuthn PublicKeyCredential
|
|
779
|
+
* object returned by the browser during authentication, serialized as per the WebAuthn specification.
|
|
780
|
+
* The SPI implementation should use this to verify the authentication assertion.
|
|
781
|
+
*
|
|
782
|
+
* Any standards-compliant WebAuthn server library should be able to process this serialized format.
|
|
783
|
+
* For details on the serialization format, refer to the W3C WebAuthn specification:
|
|
784
|
+
* https://www.w3.org/TR/webauthn-3/#dom-publickeycredential-tojson
|
|
785
|
+
* @maxLength 3000
|
|
786
|
+
*/
|
|
787
|
+
credential?: string | null;
|
|
680
788
|
}
|
|
681
|
-
interface
|
|
682
|
-
factorType: FactorType;
|
|
683
|
-
verificationChallengeData?: VerificationChallengeNonNullableFields;
|
|
684
|
-
availableFactors: V1FactorNonNullableFields[];
|
|
685
|
-
reason: MfaReason;
|
|
686
|
-
}
|
|
687
|
-
interface IdpConnectionNonNullableFields {
|
|
688
|
-
idpConnectionId: string;
|
|
689
|
-
idpUserId: string;
|
|
690
|
-
}
|
|
691
|
-
interface AuthenticatorConnectionNonNullableFields {
|
|
692
|
-
authenticatorConnectionId: string;
|
|
693
|
-
reEnrollmentRequired: boolean;
|
|
694
|
-
}
|
|
695
|
-
interface ConnectionNonNullableFields {
|
|
696
|
-
idpConnection?: IdpConnectionNonNullableFields;
|
|
697
|
-
authenticatorConnection?: AuthenticatorConnectionNonNullableFields;
|
|
698
|
-
}
|
|
699
|
-
interface V1ListValueNonNullableFields {
|
|
700
|
-
value: V1CustomValueNonNullableFields[];
|
|
701
|
-
}
|
|
702
|
-
interface V1CustomValueNonNullableFields {
|
|
703
|
-
strValue: string;
|
|
704
|
-
numValue: number;
|
|
705
|
-
listValue?: V1ListValueNonNullableFields;
|
|
706
|
-
}
|
|
707
|
-
interface CustomFieldNonNullableFields {
|
|
708
|
-
name: string;
|
|
709
|
-
value?: V1CustomValueNonNullableFields;
|
|
710
|
-
}
|
|
711
|
-
interface SecondaryEmailNonNullableFields {
|
|
712
|
-
email: string;
|
|
713
|
-
tag: EmailTag;
|
|
714
|
-
}
|
|
715
|
-
interface PhoneNonNullableFields {
|
|
716
|
-
phone: string;
|
|
717
|
-
tag: PhoneTag;
|
|
718
|
-
}
|
|
719
|
-
interface AddressWrapperNonNullableFields {
|
|
720
|
-
tag: AddressTag;
|
|
721
|
-
}
|
|
722
|
-
interface IdentityProfileNonNullableFields {
|
|
723
|
-
emails: string[];
|
|
724
|
-
phones: string[];
|
|
725
|
-
labels: string[];
|
|
726
|
-
privacyStatus: PrivacyStatus;
|
|
727
|
-
customFields: CustomFieldNonNullableFields[];
|
|
728
|
-
secondaryEmails: SecondaryEmailNonNullableFields[];
|
|
729
|
-
phonesV2: PhoneNonNullableFields[];
|
|
730
|
-
addresses: AddressWrapperNonNullableFields[];
|
|
731
|
-
}
|
|
732
|
-
interface MetadataNonNullableFields {
|
|
733
|
-
tags: string[];
|
|
734
|
-
}
|
|
735
|
-
interface EmailNonNullableFields {
|
|
736
|
-
address: string;
|
|
737
|
-
isVerified: boolean;
|
|
738
|
-
}
|
|
739
|
-
interface StatusV2NonNullableFields {
|
|
740
|
-
name: StatusName;
|
|
741
|
-
reasons: Reason[];
|
|
742
|
-
}
|
|
743
|
-
interface FactorNonNullableFields {
|
|
744
|
-
factorId: string;
|
|
745
|
-
type: FactorType;
|
|
746
|
-
status: Status;
|
|
747
|
-
}
|
|
748
|
-
interface IdentityNonNullableFields {
|
|
749
|
-
connections: ConnectionNonNullableFields[];
|
|
750
|
-
identityProfile?: IdentityProfileNonNullableFields;
|
|
751
|
-
metadata?: MetadataNonNullableFields;
|
|
752
|
-
email?: EmailNonNullableFields;
|
|
753
|
-
status?: StatusV2NonNullableFields;
|
|
754
|
-
factors: FactorNonNullableFields[];
|
|
755
|
-
}
|
|
756
|
-
export interface StateMachineResponseNonNullableFields {
|
|
757
|
-
requireMfaData?: RequireMfaDataNonNullableFields;
|
|
758
|
-
mfaChallengeData?: MfaChallengeDataNonNullableFields;
|
|
759
|
-
state: StateType;
|
|
760
|
-
identity?: IdentityNonNullableFields;
|
|
761
|
-
}
|
|
762
|
-
interface HeadersEntryNonNullableFields {
|
|
763
|
-
key: string;
|
|
764
|
-
value: string;
|
|
765
|
-
}
|
|
766
|
-
export interface RawHttpResponseNonNullableFields {
|
|
767
|
-
body: Uint8Array;
|
|
768
|
-
headers: HeadersEntryNonNullableFields[];
|
|
769
|
-
}
|
|
770
|
-
export interface SignOnResponseNonNullableFields {
|
|
771
|
-
sessionToken: string;
|
|
772
|
-
identity?: IdentityNonNullableFields;
|
|
773
|
-
}
|
|
774
|
-
/**
|
|
775
|
-
* Registers a new member.
|
|
776
|
-
*
|
|
777
|
-
* Typically, after a successful registration, you generate and use member tokens for the
|
|
778
|
-
* registered member so that subsequent API calls are called as part of a member session.
|
|
779
|
-
* Use the `sessionToken` in the response to [get the site member's access and refresh tokens](https://dev.wix.com/docs/go-headless/coding/rest-api/visitors-and-members/handle-members-with-custom-login#get-the-site-members-access-and-refresh-tokens).
|
|
780
|
-
*
|
|
781
|
-
* If the email used to register the member already exists as a contact email, the registering
|
|
782
|
-
* member need to verify the email address using a code that is sent to the address.
|
|
783
|
-
* @param loginId - Identifier of the registering member.
|
|
784
|
-
* @public
|
|
785
|
-
* @requiredField loginId
|
|
786
|
-
* @fqn wix.iam.authentication.v1.AuthenticationService.RegisterV2
|
|
787
|
-
*/
|
|
788
|
-
export declare function registerV2(loginId: LoginId, options?: RegisterV2Options): Promise<StateMachineResponse & StateMachineResponseNonNullableFields>;
|
|
789
|
-
export interface RegisterV2Options {
|
|
789
|
+
interface RegisterV2Options {
|
|
790
790
|
/** Password of the registering member. */
|
|
791
791
|
password?: string;
|
|
792
792
|
/** Profile information of registering member. */
|
|
@@ -796,19 +796,7 @@ export interface RegisterV2Options {
|
|
|
796
796
|
/** Additional data that's relevant for the flow. */
|
|
797
797
|
clientMetaData?: Record<string, any> | null;
|
|
798
798
|
}
|
|
799
|
-
|
|
800
|
-
* Logs in an existing member.
|
|
801
|
-
*
|
|
802
|
-
* Typically, after a successful login, you generate and use member tokens for the
|
|
803
|
-
* logged-in member so that subsequent API calls are called as part of a member session.
|
|
804
|
-
* Use the `sessionToken` in the response to [get the site member's access and refresh tokens](https://dev.wix.com/docs/go-headless/coding/rest-api/visitors-and-members/handle-members-with-custom-login#get-the-site-members-access-and-refresh-tokens).
|
|
805
|
-
* @param loginId - Identifier of identity logging in.
|
|
806
|
-
* @public
|
|
807
|
-
* @requiredField loginId
|
|
808
|
-
* @fqn wix.iam.authentication.v1.AuthenticationService.LoginV2
|
|
809
|
-
*/
|
|
810
|
-
export declare function loginV2(loginId: LoginId, options?: LoginV2Options): Promise<StateMachineResponse & StateMachineResponseNonNullableFields>;
|
|
811
|
-
export interface LoginV2Options {
|
|
799
|
+
interface LoginV2Options {
|
|
812
800
|
/** Password of the identity logging in. */
|
|
813
801
|
password?: string;
|
|
814
802
|
/** CAPTCHA tokens, when CAPTCHA setting is on. */
|
|
@@ -816,39 +804,13 @@ export interface LoginV2Options {
|
|
|
816
804
|
/** Additional data that's relevant for the flow. */
|
|
817
805
|
clientMetaData?: Record<string, any> | null;
|
|
818
806
|
}
|
|
819
|
-
|
|
820
|
-
* Changes the password of a logged in user.
|
|
821
|
-
* @param newPassword - The new password to set for the logged in user
|
|
822
|
-
* @public
|
|
823
|
-
* @documentationMaturity preview
|
|
824
|
-
* @requiredField newPassword
|
|
825
|
-
* @permissionId IAM.CHANGE_PASSWORD
|
|
826
|
-
* @fqn wix.iam.authentication.v1.AuthenticationService.ChangePassword
|
|
827
|
-
*/
|
|
828
|
-
export declare function changePassword(newPassword: string): Promise<void>;
|
|
829
|
-
/** @public
|
|
830
|
-
* @documentationMaturity preview
|
|
831
|
-
* @fqn wix.iam.authentication.v1.AuthenticationService.LoginCallback
|
|
832
|
-
*/
|
|
833
|
-
export declare function loginCallback(options?: LoginCallbackOptions): Promise<RawHttpResponse & RawHttpResponseNonNullableFields>;
|
|
834
|
-
export interface LoginCallbackOptions {
|
|
807
|
+
interface LoginCallbackOptions {
|
|
835
808
|
/** state that that received on the redirect */
|
|
836
809
|
state?: string;
|
|
837
810
|
/** session token */
|
|
838
811
|
sessionToken?: string;
|
|
839
812
|
}
|
|
840
|
-
|
|
841
|
-
* @public
|
|
842
|
-
* @documentationMaturity preview
|
|
843
|
-
* @requiredField loginId
|
|
844
|
-
* @permissionId IAM.AUTHENTICAITON_SIGN_ON
|
|
845
|
-
* @permissionScope Manage Members Authentication
|
|
846
|
-
* @permissionScopeId SCOPE.DC-IDENTITY.MANAGE_AUTHENTICATION
|
|
847
|
-
* @applicableIdentity APP
|
|
848
|
-
* @fqn wix.iam.authentication.v1.AuthenticationService.SignOn
|
|
849
|
-
*/
|
|
850
|
-
export declare function signOn(loginId: LoginId, options?: SignOnOptions): Promise<SignOnResponse & SignOnResponseNonNullableFields>;
|
|
851
|
-
export interface SignOnOptions {
|
|
813
|
+
interface SignOnOptions {
|
|
852
814
|
/** profile of the identity */
|
|
853
815
|
profile?: IdentityProfile;
|
|
854
816
|
/** when true will mark the email of the identity as verified */
|
|
@@ -856,14 +818,7 @@ export interface SignOnOptions {
|
|
|
856
818
|
/** when false will create a new contact instead of merging the existing contact into the identity */
|
|
857
819
|
mergeExistingContact?: boolean;
|
|
858
820
|
}
|
|
859
|
-
|
|
860
|
-
* Logs out a member.
|
|
861
|
-
* @public
|
|
862
|
-
* @documentationMaturity preview
|
|
863
|
-
* @fqn wix.iam.authentication.v1.AuthenticationService.Logout
|
|
864
|
-
*/
|
|
865
|
-
export declare function logout(options?: LogoutOptions): Promise<RawHttpResponse & RawHttpResponseNonNullableFields>;
|
|
866
|
-
export interface LogoutOptions {
|
|
821
|
+
interface LogoutOptions {
|
|
867
822
|
/**
|
|
868
823
|
* redirect after logout
|
|
869
824
|
* @format WEB_URL
|
|
@@ -875,13 +830,7 @@ export interface LogoutOptions {
|
|
|
875
830
|
*/
|
|
876
831
|
clientId?: string | null;
|
|
877
832
|
}
|
|
878
|
-
|
|
879
|
-
* @documentationMaturity preview
|
|
880
|
-
* @requiredField factorType
|
|
881
|
-
* @fqn wix.iam.authentication.v1.AuthenticationService.Verify
|
|
882
|
-
*/
|
|
883
|
-
export declare function verify(factorType: FactorType, options?: VerifyOptions): Promise<StateMachineResponse & StateMachineResponseNonNullableFields>;
|
|
884
|
-
export interface VerifyOptions extends VerifyOptionsFactorDataOneOf {
|
|
833
|
+
interface VerifyOptions extends VerifyOptionsFactorDataOneOf {
|
|
885
834
|
/**
|
|
886
835
|
* TODO: is this a reasonable maxLength?
|
|
887
836
|
* @maxLength 1000
|
|
@@ -893,13 +842,16 @@ export interface VerifyOptions extends VerifyOptionsFactorDataOneOf {
|
|
|
893
842
|
emailData?: ExternalEmailVerifyData;
|
|
894
843
|
totpData?: TotpVerifyData;
|
|
895
844
|
pushData?: PushVerifyData;
|
|
845
|
+
webauthnData?: WebAuthnVerifyData;
|
|
896
846
|
}
|
|
897
847
|
/** @oneof */
|
|
898
|
-
|
|
848
|
+
interface VerifyOptionsFactorDataOneOf {
|
|
899
849
|
smsData?: SmsVerifyData;
|
|
900
850
|
callData?: CallVerifyData;
|
|
901
851
|
emailData?: ExternalEmailVerifyData;
|
|
902
852
|
totpData?: TotpVerifyData;
|
|
903
853
|
pushData?: PushVerifyData;
|
|
854
|
+
webauthnData?: WebAuthnVerifyData;
|
|
904
855
|
}
|
|
905
|
-
|
|
856
|
+
|
|
857
|
+
export { type V1Factor as $, AddressTag as A, type Identity as B, type CustomField as C, type Connection as D, EmailTag as E, FactorType as F, type ConnectionTypeOneOf as G, type IdpConnection as H, type IdentityProfile as I, type AuthenticatorConnection as J, type Metadata as K, type LoginId as L, MfaReason as M, type Email as N, type StatusV2 as O, PrivacyStatus as P, type Factor as Q, type RegisterV2Options as R, type StateMachineResponse as S, TenantType as T, UserVerificationRequirement as U, type VerifyOptions as V, type CustomValue as W, type CustomValueValueOneOf as X, type ListValue as Y, type MapValue as Z, type RequireMfaData as _, type LoginV2Options as a, type MfaChallengeData as a0, type VerificationChallenge as a1, type VerificationChallengeFactorChallengeDataOneOf as a2, type PushChallengeData as a3, type WebAuthnChallengeData as a4, type PublicKeyCredentialDescriptor as a5, type AuthenticationExtensionInputs as a6, type AuthenticationExtensionInputsLargeBlobOperationOneOf as a7, type LoginV2Request as a8, type ChangePasswordRequest as a9, type ChangePasswordResponse as aa, type LoginWithIdpConnectionRequest as ab, type HeadersEntry as ac, type RawHttpRequest as ad, type PathParametersEntry as ae, type QueryParametersEntry as af, type LoginCallbackRequest as ag, type LoginWithIdpConnectionTokenParamsRequest as ah, type SignOnRequest as ai, type LogoutRequest as aj, type VerifyRequest as ak, type VerifyRequestFactorDataOneOf as al, type SmsVerifyData as am, type CallVerifyData as an, type ExternalEmailVerifyData as ao, type TotpVerifyData as ap, type PushVerifyData as aq, type WebAuthnVerifyData as ar, type VerifyOptionsFactorDataOneOf as as, type LoginCallbackOptions as b, type RawHttpResponse as c, type SignOnOptions as d, type SignOnResponse as e, type LogoutOptions as f, PhoneTag as g, StateType as h, StatusName as i, Reason as j, Status as k, FactorStatus as l, type Authentication as m, type RegisterV2Request as n, type LoginIdTypeOneOf as o, type V1CustomValue as p, type V1CustomValueValueOneOf as q, type V1ListValue as r, type V1MapValue as s, type SecondaryEmail as t, type Phone as u, type AddressWrapper as v, type Address as w, type CaptchaToken as x, type CaptchaTokenTokenOneOf as y, type StateMachineResponseStateDataOneOf as z };
|