@wix/auto_sdk_identity_authentication 1.0.31 → 1.0.32
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/cjs/index.d.ts +33 -13
- package/build/cjs/index.js +2 -153
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +208 -180
- package/build/cjs/index.typings.js +2 -144
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +151 -145
- package/build/cjs/meta.js +2 -112
- package/build/cjs/meta.js.map +1 -1
- package/build/es/index.d.mts +33 -13
- package/build/es/index.mjs +1 -150
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +208 -180
- package/build/es/index.typings.mjs +1 -141
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +151 -145
- package/build/es/meta.mjs +1 -109
- package/build/es/meta.mjs.map +1 -1
- package/build/internal/cjs/index.d.ts +33 -13
- package/build/internal/cjs/index.js +2 -153
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +208 -180
- package/build/internal/cjs/index.typings.js +2 -144
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +151 -145
- package/build/internal/cjs/meta.js +2 -112
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/es/index.d.mts +33 -13
- package/build/internal/es/index.mjs +1 -150
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +208 -180
- package/build/internal/es/index.typings.mjs +1 -141
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +151 -145
- package/build/internal/es/meta.mjs +1 -109
- package/build/internal/es/meta.mjs.map +1 -1
- package/package.json +2 -2
package/build/cjs/meta.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { RegisterV2Request as RegisterV2Request$1, StateMachineResponse as StateMachineResponse$1, LoginV2Request as LoginV2Request$1, ChangePasswordRequest as ChangePasswordRequest$1, ChangePasswordResponse as ChangePasswordResponse$1, SignOnRequest as SignOnRequest$1, SignOnResponse as SignOnResponse$1, LogoutRequest as LogoutRequest$1, RawHttpResponse as RawHttpResponse$1
|
|
1
|
+
import { RegisterV2Request as RegisterV2Request$1, StateMachineResponse as StateMachineResponse$1, LoginV2Request as LoginV2Request$1, ChangePasswordRequest as ChangePasswordRequest$1, ChangePasswordResponse as ChangePasswordResponse$1, SignOnRequest as SignOnRequest$1, SignOnResponse as SignOnResponse$1, LogoutRequest as LogoutRequest$1, RawHttpResponse as RawHttpResponse$1 } from './index.typings.js';
|
|
2
2
|
import '@wix/sdk-types';
|
|
3
3
|
|
|
4
4
|
interface Authentication {
|
|
@@ -31,13 +31,13 @@ interface LoginIdTypeOneOf {
|
|
|
31
31
|
email?: string;
|
|
32
32
|
}
|
|
33
33
|
interface IdentityProfile {
|
|
34
|
-
/**
|
|
34
|
+
/** Member's first name. */
|
|
35
35
|
firstName?: string | null;
|
|
36
|
-
/**
|
|
36
|
+
/** Member's last name. */
|
|
37
37
|
lastName?: string | null;
|
|
38
|
-
/**
|
|
38
|
+
/** Member's display nickname. */
|
|
39
39
|
nickname?: string | null;
|
|
40
|
-
/**
|
|
40
|
+
/** URL to member's profile picture. */
|
|
41
41
|
picture?: string | null;
|
|
42
42
|
/**
|
|
43
43
|
* Deprecated. Use `secondaryEmails` instead.
|
|
@@ -54,27 +54,27 @@ interface IdentityProfile {
|
|
|
54
54
|
*/
|
|
55
55
|
phones?: string[];
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* Labels associated with the member.
|
|
58
58
|
* @maxSize 2000
|
|
59
59
|
*/
|
|
60
60
|
labels?: string[];
|
|
61
61
|
/**
|
|
62
|
-
*
|
|
62
|
+
* Member's preferred language code.
|
|
63
63
|
* @format LANGUAGE
|
|
64
64
|
*/
|
|
65
65
|
language?: string | null;
|
|
66
|
-
/**
|
|
66
|
+
/** Member's profile visibility setting. */
|
|
67
67
|
privacyStatus?: PrivacyStatusWithLiterals;
|
|
68
68
|
/**
|
|
69
69
|
* Any number of custom fields. [Custom fields](https://support.wix.com/en/article/adding-custom-fields-to-contacts)
|
|
70
70
|
* are used to store additional information about your site or app's contacts.
|
|
71
71
|
*/
|
|
72
72
|
customFields?: CustomField[];
|
|
73
|
-
/**
|
|
73
|
+
/** Additional email addresses for the member. */
|
|
74
74
|
secondaryEmails?: SecondaryEmail[];
|
|
75
|
-
/**
|
|
75
|
+
/** Phone numbers associated with the member. */
|
|
76
76
|
phonesV2?: Phone[];
|
|
77
|
-
/**
|
|
77
|
+
/** Physical addresses for the member. */
|
|
78
78
|
addresses?: AddressWrapper[];
|
|
79
79
|
/**
|
|
80
80
|
* Company name.
|
|
@@ -87,79 +87,79 @@ interface IdentityProfile {
|
|
|
87
87
|
*/
|
|
88
88
|
position?: string | null;
|
|
89
89
|
/**
|
|
90
|
-
*
|
|
90
|
+
* Member's birth date in `YYYY-MM-DD` format.
|
|
91
91
|
* @format LOCAL_DATE
|
|
92
92
|
*/
|
|
93
93
|
birthdate?: string | null;
|
|
94
94
|
/**
|
|
95
|
-
*
|
|
95
|
+
* URL-friendly slug for the member's profile.
|
|
96
96
|
* @maxLength 255
|
|
97
97
|
*/
|
|
98
98
|
slug?: string | null;
|
|
99
|
-
/**
|
|
99
|
+
/** Whether the member consents to receive marketing communications. */
|
|
100
100
|
subscription?: boolean | null;
|
|
101
101
|
/**
|
|
102
|
-
*
|
|
102
|
+
* Tax ID or VAT number for personal or corporate use.
|
|
103
103
|
* @maxLength 1000
|
|
104
104
|
*/
|
|
105
105
|
vatId?: string | null;
|
|
106
106
|
}
|
|
107
107
|
declare enum PrivacyStatus {
|
|
108
|
-
/** No
|
|
108
|
+
/** No privacy status defined. */
|
|
109
109
|
UNDEFINED = "UNDEFINED",
|
|
110
|
-
/** Profile details
|
|
110
|
+
/** Profile details are visible to other members. */
|
|
111
111
|
PUBLIC = "PUBLIC",
|
|
112
|
-
/** Profile details
|
|
112
|
+
/** Profile details are hidden from other members. */
|
|
113
113
|
PRIVATE = "PRIVATE"
|
|
114
114
|
}
|
|
115
115
|
/** @enumType */
|
|
116
116
|
type PrivacyStatusWithLiterals = PrivacyStatus | 'UNDEFINED' | 'PUBLIC' | 'PRIVATE';
|
|
117
117
|
interface CustomField {
|
|
118
118
|
/**
|
|
119
|
-
* Custom field name
|
|
120
|
-
*
|
|
121
|
-
*
|
|
119
|
+
* Custom field name matching an extended field key (without `custom.` prefix).
|
|
120
|
+
*
|
|
121
|
+
* Must match a key from [`List Extended Fields`](https://dev.wix.com/docs/rest/api-reference/contacts/extended-fields/list-extended-fields).
|
|
122
122
|
*/
|
|
123
123
|
name?: string;
|
|
124
|
-
/**
|
|
124
|
+
/** Value for the custom field. */
|
|
125
125
|
value?: V1CustomValue;
|
|
126
126
|
}
|
|
127
127
|
interface V1CustomValue extends V1CustomValueValueOneOf {
|
|
128
|
-
/**
|
|
128
|
+
/** Text value. */
|
|
129
129
|
strValue?: string;
|
|
130
|
-
/**
|
|
130
|
+
/** Numeric value. */
|
|
131
131
|
numValue?: number;
|
|
132
|
-
/** Date value. */
|
|
132
|
+
/** Date/time value. */
|
|
133
133
|
dateValue?: Date | null;
|
|
134
|
-
/**
|
|
134
|
+
/** List of values. */
|
|
135
135
|
listValue?: V1ListValue;
|
|
136
|
-
/**
|
|
136
|
+
/** Key-value pairs. */
|
|
137
137
|
mapValue?: V1MapValue;
|
|
138
138
|
}
|
|
139
139
|
/** @oneof */
|
|
140
140
|
interface V1CustomValueValueOneOf {
|
|
141
|
-
/**
|
|
141
|
+
/** Text value. */
|
|
142
142
|
strValue?: string;
|
|
143
|
-
/**
|
|
143
|
+
/** Numeric value. */
|
|
144
144
|
numValue?: number;
|
|
145
|
-
/** Date value. */
|
|
145
|
+
/** Date/time value. */
|
|
146
146
|
dateValue?: Date | null;
|
|
147
|
-
/**
|
|
147
|
+
/** List of values. */
|
|
148
148
|
listValue?: V1ListValue;
|
|
149
|
-
/**
|
|
149
|
+
/** Key-value pairs. */
|
|
150
150
|
mapValue?: V1MapValue;
|
|
151
151
|
}
|
|
152
152
|
interface V1ListValue {
|
|
153
|
-
/**
|
|
153
|
+
/** List of custom values. */
|
|
154
154
|
value?: V1CustomValue[];
|
|
155
155
|
}
|
|
156
156
|
interface V1MapValue {
|
|
157
|
-
/**
|
|
157
|
+
/** Map of custom field values. */
|
|
158
158
|
value?: Record<string, V1CustomValue>;
|
|
159
159
|
}
|
|
160
160
|
interface SecondaryEmail {
|
|
161
161
|
/**
|
|
162
|
-
*
|
|
162
|
+
* Secondary email address.
|
|
163
163
|
* @format EMAIL
|
|
164
164
|
*/
|
|
165
165
|
email?: string;
|
|
@@ -176,12 +176,12 @@ declare enum EmailTag {
|
|
|
176
176
|
type EmailTagWithLiterals = EmailTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'WORK';
|
|
177
177
|
interface Phone {
|
|
178
178
|
/**
|
|
179
|
-
*
|
|
179
|
+
* Country code for the phone number.
|
|
180
180
|
* @format COUNTRY
|
|
181
181
|
*/
|
|
182
182
|
countryCode?: string | null;
|
|
183
183
|
/**
|
|
184
|
-
* Phone number.
|
|
184
|
+
* Phone number without country code.
|
|
185
185
|
* @format PHONE
|
|
186
186
|
*/
|
|
187
187
|
phone?: string;
|
|
@@ -199,7 +199,7 @@ declare enum PhoneTag {
|
|
|
199
199
|
/** @enumType */
|
|
200
200
|
type PhoneTagWithLiterals = PhoneTag | 'UNTAGGED' | 'MAIN' | 'HOME' | 'MOBILE' | 'WORK' | 'FAX';
|
|
201
201
|
interface AddressWrapper {
|
|
202
|
-
/**
|
|
202
|
+
/** Physical address details. */
|
|
203
203
|
address?: Address;
|
|
204
204
|
/** Address tag. */
|
|
205
205
|
tag?: AddressTagWithLiterals;
|
|
@@ -278,11 +278,11 @@ declare enum StateType {
|
|
|
278
278
|
UNKNOWN_STATE = "UNKNOWN_STATE",
|
|
279
279
|
/** Login completed successfully. */
|
|
280
280
|
SUCCESS = "SUCCESS",
|
|
281
|
-
/**
|
|
281
|
+
/** Member needs the owner to approve their registration. */
|
|
282
282
|
REQUIRE_OWNER_APPROVAL = "REQUIRE_OWNER_APPROVAL",
|
|
283
|
-
/**
|
|
283
|
+
/** Member needs to verify their email. */
|
|
284
284
|
REQUIRE_EMAIL_VERIFICATION = "REQUIRE_EMAIL_VERIFICATION",
|
|
285
|
-
/**
|
|
285
|
+
/** The `status` is not one that prevents the member logging in, meaning it's not `OFFLINE`, `BLOCKED`, or `DELETED`. */
|
|
286
286
|
STATUS_CHECK = "STATUS_CHECK"
|
|
287
287
|
}
|
|
288
288
|
/** @enumType */
|
|
@@ -324,8 +324,6 @@ interface Identity {
|
|
|
324
324
|
email?: Email;
|
|
325
325
|
/** Identity's current status. */
|
|
326
326
|
status?: StatusV2;
|
|
327
|
-
/** Custom attributes. */
|
|
328
|
-
customAttributes?: Record<string, any> | null;
|
|
329
327
|
/**
|
|
330
328
|
* Identity verification factors.
|
|
331
329
|
* @maxSize 10
|
|
@@ -557,91 +555,10 @@ interface WebAuthnChallengeData {
|
|
|
557
555
|
*/
|
|
558
556
|
challengeId?: string;
|
|
559
557
|
/**
|
|
560
|
-
*
|
|
561
|
-
*
|
|
562
|
-
* The value is used to prevent replay attacks and MUST be randomly generated by the implementer.
|
|
563
|
-
*/
|
|
564
|
-
challenge?: Uint8Array;
|
|
565
|
-
/**
|
|
566
|
-
* The timeout in milliseconds for the WebAuthn authentication ceremony.
|
|
567
|
-
* After this time, the challenge will be considered expired and the authentication will need to be restarted.
|
|
568
|
-
* This is optional and may be overridden by the client if provided.
|
|
569
|
-
* The WebAuthn spec recommends a timeout of at least 1 minute (60000ms).
|
|
570
|
-
*/
|
|
571
|
-
timeoutMs?: number | null;
|
|
572
|
-
/**
|
|
573
|
-
* Optional list of credentials that are acceptable for this authentication ceremony.
|
|
574
|
-
* If empty, all credentials associated with the user will be considered.
|
|
575
|
-
* @maxSize 50
|
|
576
|
-
*/
|
|
577
|
-
allowCredentials?: PublicKeyCredentialDescriptor[];
|
|
578
|
-
/** Specifies the requirement for user verification during the authentication ceremony. */
|
|
579
|
-
userVerification?: UserVerificationRequirementWithLiterals;
|
|
580
|
-
/**
|
|
581
|
-
* Optional hints to guide the client UI
|
|
582
|
-
* Examples include "security-key" to emphasize external authenticators
|
|
583
|
-
* or "client-device" to emphasize built-in authenticators
|
|
584
|
-
* @maxLength 50
|
|
585
|
-
* @maxSize 10
|
|
586
|
-
*/
|
|
587
|
-
hints?: string[];
|
|
588
|
-
/**
|
|
589
|
-
* Optional extensions for the authentication ceremony
|
|
590
|
-
* Provides additional parameters for specialized WebAuthn functionality
|
|
591
|
-
*/
|
|
592
|
-
extensions?: AuthenticationExtensionInputs;
|
|
593
|
-
}
|
|
594
|
-
interface PublicKeyCredentialDescriptor {
|
|
595
|
-
/** The credential ID */
|
|
596
|
-
id?: Uint8Array;
|
|
597
|
-
/**
|
|
598
|
-
* An optional hint as to the transports used by the credential
|
|
599
|
-
* Examples include "usb", "nfc", "ble", "internal", "hybrid"
|
|
600
|
-
* @maxLength 50
|
|
601
|
-
* @maxSize 10
|
|
602
|
-
*/
|
|
603
|
-
transports?: string[];
|
|
604
|
-
}
|
|
605
|
-
declare enum UserVerificationRequirement {
|
|
606
|
-
/** Default unspecified value */
|
|
607
|
-
USER_VERIFICATION_UNSPECIFIED = "USER_VERIFICATION_UNSPECIFIED",
|
|
608
|
-
/**
|
|
609
|
-
* The Relying Party requires user verification and will fail the operation if the response doesn't have the UV flag
|
|
610
|
-
* set
|
|
611
|
-
*/
|
|
612
|
-
USER_VERIFICATION_REQUIRED = "USER_VERIFICATION_REQUIRED",
|
|
613
|
-
/** The Relying Party prefers user verification but will not fail the operation if unavailable */
|
|
614
|
-
USER_VERIFICATION_PREFERRED = "USER_VERIFICATION_PREFERRED",
|
|
615
|
-
/** The Relying Party does not want user verification employed (e.g., to minimize disruption to the user experience) */
|
|
616
|
-
USER_VERIFICATION_DISCOURAGED = "USER_VERIFICATION_DISCOURAGED"
|
|
617
|
-
}
|
|
618
|
-
/** @enumType */
|
|
619
|
-
type UserVerificationRequirementWithLiterals = UserVerificationRequirement | 'USER_VERIFICATION_UNSPECIFIED' | 'USER_VERIFICATION_REQUIRED' | 'USER_VERIFICATION_PREFERRED' | 'USER_VERIFICATION_DISCOURAGED';
|
|
620
|
-
interface AuthenticationExtensionInputs extends AuthenticationExtensionInputsLargeBlobOperationOneOf {
|
|
621
|
-
/** Read existing large blob data from the authenticator */
|
|
622
|
-
largeBlobRead?: boolean;
|
|
623
|
-
/** Write data to the authenticator's large blob storage */
|
|
624
|
-
largeBlobWrite?: Uint8Array;
|
|
625
|
-
/**
|
|
626
|
-
* FIDO AppID Extension (appid)
|
|
627
|
-
* An AppID that was used for previously registered U2F authenticators
|
|
628
|
-
* This makes already-registered U2F credentials forward-compatible with the WebAuthn API
|
|
629
|
-
* @maxLength 256
|
|
630
|
-
*/
|
|
631
|
-
appid?: string;
|
|
632
|
-
/**
|
|
633
|
-
* User Verification Method Extension (uvm)
|
|
634
|
-
* Requests the authenticator to report which verification methods were used
|
|
635
|
-
* Examples include fingerprint, PIN, or facial recognition
|
|
558
|
+
* A PublicKeyCredentialRequestOptions JSON as defined in the WebAuthn spec (https://www.w3.org/TR/webauthn-3/#dictdef-publickeycredentialrequestoptions).
|
|
559
|
+
* @maxLength 40000
|
|
636
560
|
*/
|
|
637
|
-
|
|
638
|
-
}
|
|
639
|
-
/** @oneof */
|
|
640
|
-
interface AuthenticationExtensionInputsLargeBlobOperationOneOf {
|
|
641
|
-
/** Read existing large blob data from the authenticator */
|
|
642
|
-
largeBlobRead?: boolean;
|
|
643
|
-
/** Write data to the authenticator's large blob storage */
|
|
644
|
-
largeBlobWrite?: Uint8Array;
|
|
561
|
+
publicKeyCredentialRequestOptionsJson?: string;
|
|
645
562
|
}
|
|
646
563
|
interface LoginV2Request {
|
|
647
564
|
/** Identifier of identity logging in. */
|
|
@@ -684,7 +601,11 @@ interface ExternalEmailVerifyData {
|
|
|
684
601
|
code?: string | null;
|
|
685
602
|
}
|
|
686
603
|
interface ChangePasswordRequest {
|
|
687
|
-
/**
|
|
604
|
+
/**
|
|
605
|
+
* New password to set for the logged-in member.
|
|
606
|
+
*
|
|
607
|
+
* The password must meet the site's configured password requirements for length and complexity.
|
|
608
|
+
*/
|
|
688
609
|
newPassword: string;
|
|
689
610
|
}
|
|
690
611
|
interface ChangePasswordResponse {
|
|
@@ -709,8 +630,24 @@ interface LoginWithIdpConnectionRequest {
|
|
|
709
630
|
* Encryption key should be base64 encoded. Encryption is done using AES-GCM with a random IV that's sent alongside the payload
|
|
710
631
|
*/
|
|
711
632
|
sessionId?: string;
|
|
633
|
+
/**
|
|
634
|
+
* Base64-encoded encryption key for securing the authentication response.
|
|
635
|
+
*
|
|
636
|
+
* Used to encrypt the authentication response sent via BroadcastChannel API.
|
|
637
|
+
* Encryption uses AES-GCM with a random IV.
|
|
638
|
+
*/
|
|
712
639
|
encryptionKey?: string;
|
|
640
|
+
/**
|
|
641
|
+
* Visitor ID for tracking purposes.
|
|
642
|
+
*
|
|
643
|
+
* Optional identifier for analytics and tracking the authentication flow.
|
|
644
|
+
*/
|
|
713
645
|
visitorId?: string | null;
|
|
646
|
+
/**
|
|
647
|
+
* Browser session identifier.
|
|
648
|
+
*
|
|
649
|
+
* Optional identifier for correlating the authentication request with browser session data.
|
|
650
|
+
*/
|
|
714
651
|
bsi?: string | null;
|
|
715
652
|
}
|
|
716
653
|
declare enum TenantType {
|
|
@@ -765,58 +702,122 @@ interface LoginWithIdpConnectionTokenParamsRequest {
|
|
|
765
702
|
tokenParams?: Record<string, string>;
|
|
766
703
|
}
|
|
767
704
|
interface SignOnRequest {
|
|
768
|
-
/**
|
|
705
|
+
/**
|
|
706
|
+
* Member identifier for authentication.
|
|
707
|
+
*
|
|
708
|
+
* Currently only email addresses are supported.
|
|
709
|
+
*/
|
|
769
710
|
loginId: LoginId;
|
|
770
|
-
/**
|
|
711
|
+
/**
|
|
712
|
+
* Member profile information.
|
|
713
|
+
*
|
|
714
|
+
* Profile data such as first name, last name, and other member details.
|
|
715
|
+
* If the member already exists, provided profile information will update the existing member's profile.
|
|
716
|
+
* If the member doesn't exist, this profile information is used to create the new member.
|
|
717
|
+
*/
|
|
771
718
|
profile?: IdentityProfile;
|
|
772
|
-
/**
|
|
719
|
+
/**
|
|
720
|
+
* Whether to mark the member's email as verified without requiring verification.
|
|
721
|
+
*
|
|
722
|
+
* When `true`, marks the email as verified without requiring verification.
|
|
723
|
+
* Use with caution in production as this bypasses security verification.
|
|
724
|
+
*
|
|
725
|
+
* Default: `false`
|
|
726
|
+
*/
|
|
773
727
|
verifyEmail?: boolean;
|
|
774
|
-
/**
|
|
728
|
+
/**
|
|
729
|
+
* Whether to merge with an existing contact with the same email address.
|
|
730
|
+
*
|
|
731
|
+
* When `true`, links the member to an existing contact record with the same email
|
|
732
|
+
* and inherits contact data. When `false`, creates a new contact record.
|
|
733
|
+
*
|
|
734
|
+
* Default: `true`
|
|
735
|
+
*/
|
|
775
736
|
mergeExistingContact?: boolean;
|
|
776
737
|
}
|
|
777
738
|
interface SignOnResponse {
|
|
778
|
-
/**
|
|
739
|
+
/**
|
|
740
|
+
* Session token for the authenticated member.
|
|
741
|
+
*
|
|
742
|
+
* Use this token to obtain access and refresh tokens for subsequent API calls.
|
|
743
|
+
*/
|
|
779
744
|
sessionToken?: string;
|
|
780
|
-
/**
|
|
745
|
+
/**
|
|
746
|
+
* Member identity information.
|
|
747
|
+
*
|
|
748
|
+
* Contains the member's identity details after successful authentication.
|
|
749
|
+
*/
|
|
781
750
|
identity?: Identity;
|
|
782
751
|
}
|
|
783
752
|
/** logout request payload */
|
|
784
753
|
interface LogoutRequest {
|
|
785
754
|
/**
|
|
786
|
-
* redirect after logout
|
|
755
|
+
* URL to redirect to after logout.
|
|
756
|
+
*
|
|
757
|
+
* Optional redirect destination after the logout process completes.
|
|
787
758
|
* @format WEB_URL
|
|
788
759
|
*/
|
|
789
760
|
postLogoutRedirectUri?: string | null;
|
|
790
761
|
/**
|
|
791
|
-
*
|
|
762
|
+
* Client identifier for the logout request.
|
|
763
|
+
*
|
|
764
|
+
* Identifies the application or client initiating the logout.
|
|
792
765
|
* @format GUID
|
|
793
766
|
*/
|
|
794
767
|
clientId?: string | null;
|
|
795
768
|
}
|
|
796
769
|
interface VerifyRequest extends VerifyRequestFactorDataOneOf {
|
|
770
|
+
/** SMS verification code sent to the member's phone number. */
|
|
797
771
|
smsData?: SmsVerifyData;
|
|
772
|
+
/** Voice call verification code received by the member. */
|
|
798
773
|
callData?: CallVerifyData;
|
|
774
|
+
/** Email verification code sent to the member's email address. */
|
|
799
775
|
emailData?: ExternalEmailVerifyData;
|
|
776
|
+
/** TOTP code from the member's authenticator app. */
|
|
800
777
|
totpData?: TotpVerifyData;
|
|
778
|
+
/** Push notification authentication response from the member's device. */
|
|
801
779
|
pushData?: PushVerifyData;
|
|
780
|
+
/** WebAuthn response from biometric or security key authentication. */
|
|
802
781
|
webauthnData?: WebAuthnVerifyData;
|
|
782
|
+
/** RecoveryCode response from a one-time code. */
|
|
783
|
+
recoveryCodeData?: RecoveryCodeVerifyData;
|
|
803
784
|
/**
|
|
804
|
-
*
|
|
785
|
+
* State token from the initial authentication response.
|
|
786
|
+
*
|
|
787
|
+
* Required to continue the multi-step authentication process.
|
|
805
788
|
* @maxLength 1000
|
|
806
789
|
*/
|
|
807
790
|
stateToken?: string;
|
|
808
|
-
|
|
809
|
-
|
|
791
|
+
/**
|
|
792
|
+
* Type of authentication factor being verified.
|
|
793
|
+
*
|
|
794
|
+
* Specifies which verification method is being used (SMS, email, TOTP, etc.).
|
|
795
|
+
*/
|
|
796
|
+
factorType?: FactorTypeWithLiterals;
|
|
797
|
+
/**
|
|
798
|
+
* Whether to remember this device for future authentication.
|
|
799
|
+
*
|
|
800
|
+
* When `true`, reduces future authentication requirements for this device.
|
|
801
|
+
* Only applicable for second factor authentication.
|
|
802
|
+
*/
|
|
810
803
|
rememberThisDevice?: boolean;
|
|
811
804
|
}
|
|
812
805
|
/** @oneof */
|
|
813
806
|
interface VerifyRequestFactorDataOneOf {
|
|
807
|
+
/** SMS verification code sent to the member's phone number. */
|
|
814
808
|
smsData?: SmsVerifyData;
|
|
809
|
+
/** Voice call verification code received by the member. */
|
|
815
810
|
callData?: CallVerifyData;
|
|
811
|
+
/** Email verification code sent to the member's email address. */
|
|
816
812
|
emailData?: ExternalEmailVerifyData;
|
|
813
|
+
/** TOTP code from the member's authenticator app. */
|
|
817
814
|
totpData?: TotpVerifyData;
|
|
815
|
+
/** Push notification authentication response from the member's device. */
|
|
818
816
|
pushData?: PushVerifyData;
|
|
817
|
+
/** WebAuthn response from biometric or security key authentication. */
|
|
819
818
|
webauthnData?: WebAuthnVerifyData;
|
|
819
|
+
/** RecoveryCode response from a one-time code. */
|
|
820
|
+
recoveryCodeData?: RecoveryCodeVerifyData;
|
|
820
821
|
}
|
|
821
822
|
interface SmsVerifyData {
|
|
822
823
|
/**
|
|
@@ -843,10 +844,18 @@ interface PushVerifyData {
|
|
|
843
844
|
/** @maxLength 36 */
|
|
844
845
|
transactionId?: string | null;
|
|
845
846
|
}
|
|
847
|
+
interface RecoveryCodeVerifyData {
|
|
848
|
+
/**
|
|
849
|
+
* @minLength 1
|
|
850
|
+
* @maxLength 100
|
|
851
|
+
*/
|
|
852
|
+
code?: string | null;
|
|
853
|
+
}
|
|
846
854
|
interface GetWebauthnChallengeRequest {
|
|
847
855
|
/**
|
|
848
|
-
* Identifier of
|
|
849
|
-
*
|
|
856
|
+
* Identifier of the member requesting the WebAuthn challenge.
|
|
857
|
+
*
|
|
858
|
+
* If not provided, returns an anonymous WebAuthn challenge for usernameless authentication.
|
|
850
859
|
*/
|
|
851
860
|
loginId?: LoginId;
|
|
852
861
|
}
|
|
@@ -980,8 +989,5 @@ declare function loginV2(): __PublicMethodMetaInfo<'POST', {}, LoginV2Request$1,
|
|
|
980
989
|
declare function changePassword(): __PublicMethodMetaInfo<'POST', {}, ChangePasswordRequest$1, ChangePasswordRequest, ChangePasswordResponse$1, ChangePasswordResponse>;
|
|
981
990
|
declare function signOn(): __PublicMethodMetaInfo<'POST', {}, SignOnRequest$1, SignOnRequest, SignOnResponse$1, SignOnResponse>;
|
|
982
991
|
declare function logout(): __PublicMethodMetaInfo<'GET', {}, LogoutRequest$1, LogoutRequest, RawHttpResponse$1, RawHttpResponse>;
|
|
983
|
-
declare function verify(): __PublicMethodMetaInfo<'POST', {
|
|
984
|
-
factorType: string;
|
|
985
|
-
}, VerifyRequest$1, VerifyRequest, StateMachineResponse$1, StateMachineResponse>;
|
|
986
992
|
|
|
987
|
-
export { type Address as AddressOriginal, AddressTag as AddressTagOriginal, type AddressTagWithLiterals as AddressTagWithLiteralsOriginal, type AddressWrapper as AddressWrapperOriginal, type
|
|
993
|
+
export { type Address as AddressOriginal, AddressTag as AddressTagOriginal, type AddressTagWithLiterals as AddressTagWithLiteralsOriginal, type AddressWrapper as AddressWrapperOriginal, type Authentication as AuthenticationOriginal, type AuthenticatorConnection as AuthenticatorConnectionOriginal, type CallVerifyData as CallVerifyDataOriginal, type CaptchaToken as CaptchaTokenOriginal, type CaptchaTokenTokenOneOf as CaptchaTokenTokenOneOfOriginal, type ChangePasswordRequest as ChangePasswordRequestOriginal, type ChangePasswordResponse as ChangePasswordResponseOriginal, type Connection as ConnectionOriginal, type ConnectionTypeOneOf as ConnectionTypeOneOfOriginal, type CustomField as CustomFieldOriginal, type CustomValue as CustomValueOriginal, type CustomValueValueOneOf as CustomValueValueOneOfOriginal, type Email as EmailOriginal, EmailTag as EmailTagOriginal, type EmailTagWithLiterals as EmailTagWithLiteralsOriginal, type ExternalEmailVerifyData as ExternalEmailVerifyDataOriginal, type Factor as FactorOriginal, FactorStatus as FactorStatusOriginal, type FactorStatusWithLiterals as FactorStatusWithLiteralsOriginal, FactorType as FactorTypeOriginal, type FactorTypeWithLiterals as FactorTypeWithLiteralsOriginal, type GetWebauthnChallengeRequest as GetWebauthnChallengeRequestOriginal, type GetWebauthnChallengeResponse as GetWebauthnChallengeResponseOriginal, type HeadersEntry as HeadersEntryOriginal, type Identity as IdentityOriginal, type IdentityProfile as IdentityProfileOriginal, type IdpConnection as IdpConnectionOriginal, type ListValue as ListValueOriginal, type LoginCallbackRequest as LoginCallbackRequestOriginal, type LoginId as LoginIdOriginal, type LoginIdTypeOneOf as LoginIdTypeOneOfOriginal, type LoginV2ApplicationErrors as LoginV2ApplicationErrorsOriginal, type LoginV2Request as LoginV2RequestOriginal, type LoginV2ValidationErrors as LoginV2ValidationErrorsOriginal, type LoginWithIdpConnectionRequest as LoginWithIdpConnectionRequestOriginal, type LoginWithIdpConnectionTokenParamsRequest as LoginWithIdpConnectionTokenParamsRequestOriginal, type LogoutRequest as LogoutRequestOriginal, type MapValue as MapValueOriginal, type Metadata as MetadataOriginal, type MfaChallengeData as MfaChallengeDataOriginal, MfaReason as MfaReasonOriginal, type MfaReasonWithLiterals as MfaReasonWithLiteralsOriginal, type PathParametersEntry as PathParametersEntryOriginal, type Phone as PhoneOriginal, PhoneTag as PhoneTagOriginal, type PhoneTagWithLiterals as PhoneTagWithLiteralsOriginal, PrivacyStatus as PrivacyStatusOriginal, type PrivacyStatusWithLiterals as PrivacyStatusWithLiteralsOriginal, type PushChallengeData as PushChallengeDataOriginal, type PushVerifyData as PushVerifyDataOriginal, type QueryParametersEntry as QueryParametersEntryOriginal, type RawHttpRequest as RawHttpRequestOriginal, type RawHttpResponse as RawHttpResponseOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type RecoveryCodeVerifyData as RecoveryCodeVerifyDataOriginal, type RegisterV2ApplicationErrors as RegisterV2ApplicationErrorsOriginal, type RegisterV2Request as RegisterV2RequestOriginal, type RegisterV2ValidationErrors as RegisterV2ValidationErrorsOriginal, type RequireMfaData as RequireMfaDataOriginal, type SecondaryEmail as SecondaryEmailOriginal, type SignOnRequest as SignOnRequestOriginal, type SignOnResponse as SignOnResponseOriginal, type SmsVerifyData as SmsVerifyDataOriginal, type StateMachineResponse as StateMachineResponseOriginal, type StateMachineResponseStateDataOneOf as StateMachineResponseStateDataOneOfOriginal, StateType as StateTypeOriginal, type StateTypeWithLiterals as StateTypeWithLiteralsOriginal, StatusName as StatusNameOriginal, type StatusNameWithLiterals as StatusNameWithLiteralsOriginal, Status as StatusOriginal, type StatusV2 as StatusV2Original, type StatusWithLiterals as StatusWithLiteralsOriginal, TenantType as TenantTypeOriginal, type TenantTypeWithLiterals as TenantTypeWithLiteralsOriginal, type TotpVerifyData as TotpVerifyDataOriginal, type V1CustomValue as V1CustomValueOriginal, type V1CustomValueValueOneOf as V1CustomValueValueOneOfOriginal, type V1Factor as V1FactorOriginal, type V1ListValue as V1ListValueOriginal, type V1MapValue as V1MapValueOriginal, type VerificationChallengeFactorChallengeDataOneOf as VerificationChallengeFactorChallengeDataOneOfOriginal, type VerificationChallenge as VerificationChallengeOriginal, type VerifyRequestFactorDataOneOf as VerifyRequestFactorDataOneOfOriginal, type VerifyRequest as VerifyRequestOriginal, type WebAuthnChallengeData as WebAuthnChallengeDataOriginal, type WebAuthnVerifyData as WebAuthnVerifyDataOriginal, type __PublicMethodMetaInfo, changePassword, loginV2, logout, registerV2, signOn };
|