@workos-inc/widgets 1.8.2 → 1.9.1
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 +11 -0
- package/dist/cjs/admin-portal-domain-verification.client.cjs.map +1 -1
- package/dist/cjs/admin-portal-sso-connection.client.cjs +4 -7
- package/dist/cjs/admin-portal-sso-connection.client.cjs.map +1 -1
- package/dist/cjs/api/api-provider.cjs.map +1 -1
- package/dist/cjs/api/api-provider.d.cts +1 -1
- package/dist/cjs/api/endpoint.cjs +741 -771
- package/dist/cjs/api/endpoint.cjs.map +1 -1
- package/dist/cjs/api/endpoint.d.cts +860 -813
- package/dist/cjs/directory-sync.client.cjs +156 -0
- package/dist/cjs/directory-sync.client.cjs.map +1 -0
- package/dist/cjs/directory-sync.client.d.cts +26 -0
- package/dist/cjs/experimental/api/fetch.cjs +327 -411
- package/dist/cjs/experimental/api/fetch.cjs.map +1 -1
- package/dist/cjs/experimental/api/fetch.d.cts +832 -798
- package/dist/cjs/experimental/api/react-query.cjs +747 -777
- package/dist/cjs/experimental/api/react-query.cjs.map +1 -1
- package/dist/cjs/experimental/api/react-query.d.cts +1378 -1263
- package/dist/cjs/experimental/api/swr.cjs +720 -742
- package/dist/cjs/experimental/api/swr.cjs.map +1 -1
- package/dist/cjs/experimental/api/swr.d.cts +1218 -1175
- package/dist/cjs/index.cjs +5 -0
- package/dist/cjs/index.cjs.map +1 -1
- package/dist/cjs/index.d.cts +2 -0
- package/dist/cjs/lib/add-mfa-dialog.cjs +18 -16
- package/dist/cjs/lib/add-mfa-dialog.cjs.map +1 -1
- package/dist/cjs/lib/admin-portal-sso-connection.cjs +0 -8
- package/dist/cjs/lib/admin-portal-sso-connection.cjs.map +1 -1
- package/dist/cjs/lib/admin-portal-sso-connection.d.cts +1 -2
- package/dist/cjs/lib/api-keys/api-keys-context.cjs +1 -1
- package/dist/cjs/lib/api-keys/api-keys-context.cjs.map +1 -1
- package/dist/cjs/lib/api-keys/api-keys-table.cjs +7 -5
- package/dist/cjs/lib/api-keys/api-keys-table.cjs.map +1 -1
- package/dist/cjs/lib/directory-sync.cjs +288 -0
- package/dist/cjs/lib/directory-sync.cjs.map +1 -0
- package/dist/cjs/lib/directory-sync.d.cts +72 -0
- package/dist/cjs/lib/identity-providers.cjs +57 -1
- package/dist/cjs/lib/identity-providers.cjs.map +1 -1
- package/dist/cjs/lib/identity-providers.d.cts +5 -3
- package/dist/cjs/lib/pipes.cjs +9 -9
- package/dist/cjs/lib/pipes.cjs.map +1 -1
- package/dist/cjs/lib/provider-icon.cjs.map +1 -1
- package/dist/cjs/lib/provider-icon.d.cts +2 -2
- package/dist/cjs/lib/reset-mfa-dialog.cjs +2 -1
- package/dist/cjs/lib/reset-mfa-dialog.cjs.map +1 -1
- package/dist/cjs/lib/use-permissions.cjs.map +1 -1
- package/dist/cjs/lib/use-permissions.d.cts +1 -1
- package/dist/cjs/lib/users-management-context.cjs +1 -1
- package/dist/cjs/lib/users-management-context.cjs.map +1 -1
- package/dist/cjs/lib/users-management.cjs +3 -3
- package/dist/cjs/lib/users-management.cjs.map +1 -1
- package/dist/cjs/lib/utils.cjs +9 -0
- package/dist/cjs/lib/utils.cjs.map +1 -1
- package/dist/cjs/lib/utils.d.cts +16 -2
- package/dist/cjs/workos-widgets.client.cjs +13 -1
- package/dist/cjs/workos-widgets.client.cjs.map +1 -1
- package/dist/esm/admin-portal-domain-verification.client.js +2 -2
- package/dist/esm/admin-portal-domain-verification.client.js.map +1 -1
- package/dist/esm/admin-portal-sso-connection.client.js +6 -9
- package/dist/esm/admin-portal-sso-connection.client.js.map +1 -1
- package/dist/esm/api/api-provider.d.ts +1 -1
- package/dist/esm/api/api-provider.js.map +1 -1
- package/dist/esm/api/endpoint.d.ts +860 -813
- package/dist/esm/api/endpoint.js +727 -751
- package/dist/esm/api/endpoint.js.map +1 -1
- package/dist/esm/directory-sync.client.d.ts +26 -0
- package/dist/esm/directory-sync.client.js +134 -0
- package/dist/esm/directory-sync.client.js.map +1 -0
- package/dist/esm/experimental/api/fetch.d.ts +832 -798
- package/dist/esm/experimental/api/fetch.js +319 -391
- package/dist/esm/experimental/api/fetch.js.map +1 -1
- package/dist/esm/experimental/api/react-query.d.ts +1378 -1263
- package/dist/esm/experimental/api/react-query.js +730 -757
- package/dist/esm/experimental/api/react-query.js.map +1 -1
- package/dist/esm/experimental/api/swr.d.ts +1218 -1175
- package/dist/esm/experimental/api/swr.js +706 -722
- package/dist/esm/experimental/api/swr.js.map +1 -1
- package/dist/esm/index.d.ts +2 -0
- package/dist/esm/index.js +6 -0
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/lib/add-mfa-dialog.js +18 -16
- package/dist/esm/lib/add-mfa-dialog.js.map +1 -1
- package/dist/esm/lib/admin-portal-sso-connection.d.ts +1 -2
- package/dist/esm/lib/admin-portal-sso-connection.js +0 -8
- package/dist/esm/lib/admin-portal-sso-connection.js.map +1 -1
- package/dist/esm/lib/api-keys/api-keys-context.js +1 -1
- package/dist/esm/lib/api-keys/api-keys-context.js.map +1 -1
- package/dist/esm/lib/api-keys/api-keys-table.js +7 -5
- package/dist/esm/lib/api-keys/api-keys-table.js.map +1 -1
- package/dist/esm/lib/directory-sync.d.ts +72 -0
- package/dist/esm/lib/directory-sync.js +259 -0
- package/dist/esm/lib/directory-sync.js.map +1 -0
- package/dist/esm/lib/identity-providers.d.ts +5 -3
- package/dist/esm/lib/identity-providers.js +55 -1
- package/dist/esm/lib/identity-providers.js.map +1 -1
- package/dist/esm/lib/pipes.js +9 -10
- package/dist/esm/lib/pipes.js.map +1 -1
- package/dist/esm/lib/provider-icon.d.ts +2 -2
- package/dist/esm/lib/provider-icon.js.map +1 -1
- package/dist/esm/lib/reset-mfa-dialog.js +2 -1
- package/dist/esm/lib/reset-mfa-dialog.js.map +1 -1
- package/dist/esm/lib/use-permissions.d.ts +1 -1
- package/dist/esm/lib/use-permissions.js.map +1 -1
- package/dist/esm/lib/users-management-context.js +1 -1
- package/dist/esm/lib/users-management-context.js.map +1 -1
- package/dist/esm/lib/users-management.js +5 -4
- package/dist/esm/lib/users-management.js.map +1 -1
- package/dist/esm/lib/utils.d.ts +16 -2
- package/dist/esm/lib/utils.js +8 -0
- package/dist/esm/lib/utils.js.map +1 -1
- package/dist/esm/workos-widgets.client.js +13 -1
- package/dist/esm/workos-widgets.client.js.map +1 -1
- package/package.json +2 -2
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
import { UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions,
|
|
1
|
+
import { UseMutationOptions, QueryClient, UseMutationResult, UseQueryOptions, DataTag, QueryKey, DefinedInitialDataOptions, DefinedUseQueryResult, UndefinedInitialDataOptions, UseQueryResult } from '@tanstack/react-query';
|
|
2
2
|
|
|
3
|
+
type MemberStatus = (typeof MemberStatus)[keyof typeof MemberStatus];
|
|
3
4
|
declare const MemberStatus: {
|
|
4
5
|
readonly Active: "Active";
|
|
5
6
|
readonly Invited: "Invited";
|
|
@@ -7,20 +8,20 @@ declare const MemberStatus: {
|
|
|
7
8
|
readonly InviteRevoked: "InviteRevoked";
|
|
8
9
|
readonly NoInvite: "NoInvite";
|
|
9
10
|
};
|
|
10
|
-
type
|
|
11
|
+
type MemberActionsItem = (typeof MemberActionsItem)[keyof typeof MemberActionsItem];
|
|
11
12
|
declare const MemberActionsItem: {
|
|
12
13
|
readonly "edit-role": "edit-role";
|
|
13
14
|
readonly "resend-invite": "resend-invite";
|
|
14
15
|
readonly "revoke-invite": "revoke-invite";
|
|
15
16
|
readonly "revoke-membership": "revoke-membership";
|
|
16
17
|
};
|
|
17
|
-
type MemberActions =
|
|
18
|
-
type
|
|
18
|
+
type MemberActions = MemberActionsItem[];
|
|
19
|
+
type MemberRoles = {
|
|
19
20
|
name: string;
|
|
20
21
|
slug: string;
|
|
21
22
|
/** @nullable */
|
|
22
23
|
description?: string | null;
|
|
23
|
-
};
|
|
24
|
+
}[] | null;
|
|
24
25
|
interface Member {
|
|
25
26
|
id: string;
|
|
26
27
|
email: string;
|
|
@@ -31,21 +32,26 @@ interface Member {
|
|
|
31
32
|
firstName?: string | null;
|
|
32
33
|
/** @nullable */
|
|
33
34
|
lastName?: string | null;
|
|
35
|
+
/** An ISO 8601 timestamp. */
|
|
34
36
|
createdAt: string;
|
|
35
37
|
/** @nullable */
|
|
36
38
|
lastActivityAt?: string | null;
|
|
37
39
|
status: MemberStatus;
|
|
38
40
|
actions: MemberActions;
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
/** @nullable */
|
|
42
|
-
roles?: MemberRolesItem[] | null;
|
|
41
|
+
isLoggedInUser?: true | null;
|
|
42
|
+
roles?: MemberRoles;
|
|
43
43
|
}
|
|
44
44
|
interface ListMetadata {
|
|
45
|
-
/**
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
45
|
+
/**
|
|
46
|
+
* An object ID that defines your place in the list. When the ID is not present, you are at the start of the list.
|
|
47
|
+
* @nullable
|
|
48
|
+
*/
|
|
49
|
+
before: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* An object ID that defines your place in the list. When the ID is not present, you are at the end of the list.
|
|
52
|
+
* @nullable
|
|
53
|
+
*/
|
|
54
|
+
after: string | null;
|
|
49
55
|
}
|
|
50
56
|
interface MemberRole {
|
|
51
57
|
name: string;
|
|
@@ -81,9 +87,6 @@ interface OAuthProfile {
|
|
|
81
87
|
/** @nullable */
|
|
82
88
|
lastLoginAt?: string | null;
|
|
83
89
|
}
|
|
84
|
-
/**
|
|
85
|
-
* @nullable
|
|
86
|
-
*/
|
|
87
90
|
type MeOauthProfiles = {
|
|
88
91
|
AppleOAuth?: OAuthProfile;
|
|
89
92
|
GithubOAuth?: OAuthProfile;
|
|
@@ -101,77 +104,43 @@ interface Me {
|
|
|
101
104
|
locale?: string | null;
|
|
102
105
|
/** @nullable */
|
|
103
106
|
profilePictureUrl?: string | null;
|
|
104
|
-
/** @nullable */
|
|
105
107
|
oauthProfiles?: MeOauthProfiles;
|
|
106
108
|
}
|
|
107
|
-
type
|
|
108
|
-
|
|
109
|
-
readonly authentication_factor: "authentication_factor";
|
|
110
|
-
};
|
|
111
|
-
type CreateTotpFactorResponseAuthenticationFactorAllOfType = (typeof CreateTotpFactorResponseAuthenticationFactorAllOfType)[keyof typeof CreateTotpFactorResponseAuthenticationFactorAllOfType];
|
|
112
|
-
declare const CreateTotpFactorResponseAuthenticationFactorAllOfType: {
|
|
113
|
-
readonly generic_otp: "generic_otp";
|
|
114
|
-
readonly sms: "sms";
|
|
115
|
-
readonly totp: "totp";
|
|
116
|
-
readonly webauthn: "webauthn";
|
|
117
|
-
};
|
|
118
|
-
/**
|
|
119
|
-
* @nullable
|
|
120
|
-
*/
|
|
121
|
-
type CreateTotpFactorResponseAuthenticationFactorAllOfSms = {
|
|
122
|
-
phone_number: string;
|
|
123
|
-
} | null;
|
|
124
|
-
/**
|
|
125
|
-
* @nullable
|
|
126
|
-
*/
|
|
127
|
-
type CreateTotpFactorResponseAuthenticationFactorAllOfTotpAnyOf = {
|
|
128
|
-
issuer: string;
|
|
129
|
-
user: string;
|
|
130
|
-
secret: string;
|
|
131
|
-
qr_code: string;
|
|
132
|
-
uri: string;
|
|
133
|
-
} | null;
|
|
134
|
-
/**
|
|
135
|
-
* @nullable
|
|
136
|
-
*/
|
|
137
|
-
type CreateTotpFactorResponseAuthenticationFactorAllOfTotpAnyOfTwo = {
|
|
138
|
-
issuer: string;
|
|
139
|
-
user: string;
|
|
140
|
-
} | null;
|
|
141
|
-
type CreateTotpFactorResponseAuthenticationFactorAllOfTotp = CreateTotpFactorResponseAuthenticationFactorAllOfTotpAnyOf | CreateTotpFactorResponseAuthenticationFactorAllOfTotpAnyOfTwo;
|
|
142
|
-
type CreateTotpFactorResponseAuthenticationFactorAllOf = {
|
|
143
|
-
object: CreateTotpFactorResponseAuthenticationFactorAllOfObject;
|
|
109
|
+
type CreateTotpFactorResponseAuthenticationFactor = {
|
|
110
|
+
object: "authentication_factor";
|
|
144
111
|
id: string;
|
|
145
|
-
type:
|
|
112
|
+
type: "generic_otp" | "sms" | "totp" | "webauthn";
|
|
146
113
|
/** @nullable */
|
|
147
114
|
user_id?: string | null;
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
115
|
+
sms?: {
|
|
116
|
+
phone_number: string;
|
|
117
|
+
} | null;
|
|
118
|
+
totp?: {
|
|
119
|
+
issuer: string;
|
|
120
|
+
user: string;
|
|
121
|
+
secret: string;
|
|
122
|
+
qr_code: string;
|
|
123
|
+
uri: string;
|
|
124
|
+
} | {
|
|
125
|
+
issuer: string;
|
|
126
|
+
user: string;
|
|
127
|
+
} | null;
|
|
128
|
+
} & {
|
|
153
129
|
created_at: string;
|
|
154
130
|
updated_at: string;
|
|
155
131
|
};
|
|
156
|
-
type
|
|
157
|
-
|
|
158
|
-
declare const CreateTotpFactorResponseAuthenticationChallengeAllOfObject: {
|
|
159
|
-
readonly authentication_challenge: "authentication_challenge";
|
|
160
|
-
};
|
|
161
|
-
type CreateTotpFactorResponseAuthenticationChallengeAllOf = {
|
|
162
|
-
object: CreateTotpFactorResponseAuthenticationChallengeAllOfObject;
|
|
132
|
+
type CreateTotpFactorResponseAuthenticationChallenge = {
|
|
133
|
+
object: "authentication_challenge";
|
|
163
134
|
id: string;
|
|
164
135
|
/** @nullable */
|
|
165
136
|
expires_at?: string | null;
|
|
166
137
|
/** @nullable */
|
|
167
138
|
code?: string | null;
|
|
168
139
|
authentication_factor_id: string;
|
|
169
|
-
}
|
|
170
|
-
type CreateTotpFactorResponseAuthenticationChallengeAllOfThree = {
|
|
140
|
+
} & {
|
|
171
141
|
created_at: string;
|
|
172
142
|
updated_at: string;
|
|
173
143
|
};
|
|
174
|
-
type CreateTotpFactorResponseAuthenticationChallenge = CreateTotpFactorResponseAuthenticationChallengeAllOf & CreateTotpFactorResponseAuthenticationChallengeAllOfThree;
|
|
175
144
|
interface CreateTotpFactorResponse {
|
|
176
145
|
authenticationFactor: CreateTotpFactorResponseAuthenticationFactor;
|
|
177
146
|
authenticationChallenge: CreateTotpFactorResponseAuthenticationChallenge;
|
|
@@ -180,57 +149,32 @@ interface VerifyTotpFactorRequest {
|
|
|
180
149
|
code: string;
|
|
181
150
|
authenticationChallengeId: string;
|
|
182
151
|
}
|
|
183
|
-
type AuthenticationInformationResponseDataVerificationMethodsMfaProvider = (typeof AuthenticationInformationResponseDataVerificationMethodsMfaProvider)[keyof typeof AuthenticationInformationResponseDataVerificationMethodsMfaProvider];
|
|
184
|
-
declare const AuthenticationInformationResponseDataVerificationMethodsMfaProvider: {
|
|
185
|
-
readonly MFA: "MFA";
|
|
186
|
-
};
|
|
187
|
-
/**
|
|
188
|
-
* @nullable
|
|
189
|
-
*/
|
|
190
152
|
type AuthenticationInformationResponseDataVerificationMethodsMfa = {
|
|
191
|
-
provider:
|
|
153
|
+
provider: "MFA";
|
|
192
154
|
isSetUp: boolean;
|
|
193
155
|
/** @nullable */
|
|
194
156
|
lastUsed?: string | null;
|
|
195
157
|
} | null;
|
|
196
|
-
type AuthenticationInformationResponseDataVerificationMethodsPasswordProvider = (typeof AuthenticationInformationResponseDataVerificationMethodsPasswordProvider)[keyof typeof AuthenticationInformationResponseDataVerificationMethodsPasswordProvider];
|
|
197
|
-
declare const AuthenticationInformationResponseDataVerificationMethodsPasswordProvider: {
|
|
198
|
-
readonly Password: "Password";
|
|
199
|
-
};
|
|
200
|
-
/**
|
|
201
|
-
* @nullable
|
|
202
|
-
*/
|
|
203
158
|
type AuthenticationInformationResponseDataVerificationMethodsPassword = {
|
|
204
|
-
provider:
|
|
159
|
+
provider: "Password";
|
|
205
160
|
isSetUp: boolean;
|
|
206
161
|
/** @nullable */
|
|
207
162
|
lastUsed?: string | null;
|
|
208
163
|
isCurrentSession: boolean;
|
|
209
164
|
} | null;
|
|
210
|
-
type AuthenticationInformationResponseDataVerificationMethodsPasskeyProvider = (typeof AuthenticationInformationResponseDataVerificationMethodsPasskeyProvider)[keyof typeof AuthenticationInformationResponseDataVerificationMethodsPasskeyProvider];
|
|
211
|
-
declare const AuthenticationInformationResponseDataVerificationMethodsPasskeyProvider: {
|
|
212
|
-
readonly Passkey: "Passkey";
|
|
213
|
-
};
|
|
214
|
-
type AuthenticationInformationResponseDataVerificationMethodsPasskeyPassKeysItem = {
|
|
215
|
-
id: string;
|
|
216
|
-
};
|
|
217
|
-
/**
|
|
218
|
-
* @nullable
|
|
219
|
-
*/
|
|
220
165
|
type AuthenticationInformationResponseDataVerificationMethodsPasskey = {
|
|
221
|
-
provider:
|
|
166
|
+
provider: "Passkey";
|
|
222
167
|
isSetUp: boolean;
|
|
223
168
|
/** @nullable */
|
|
224
169
|
lastUsed?: string | null;
|
|
225
|
-
passKeys:
|
|
170
|
+
passKeys: {
|
|
171
|
+
id: string;
|
|
172
|
+
}[];
|
|
226
173
|
isCurrentSession: boolean;
|
|
227
174
|
} | null;
|
|
228
175
|
type AuthenticationInformationResponseDataVerificationMethods = {
|
|
229
|
-
/** @nullable */
|
|
230
176
|
Mfa?: AuthenticationInformationResponseDataVerificationMethodsMfa;
|
|
231
|
-
/** @nullable */
|
|
232
177
|
Password?: AuthenticationInformationResponseDataVerificationMethodsPassword;
|
|
233
|
-
/** @nullable */
|
|
234
178
|
Passkey?: AuthenticationInformationResponseDataVerificationMethodsPasskey;
|
|
235
179
|
};
|
|
236
180
|
type AuthenticationInformationResponseDataPasswordSettings = {
|
|
@@ -263,9 +207,6 @@ type ActiveSessionState = {
|
|
|
263
207
|
/** @nullable */
|
|
264
208
|
expiresAt?: string | null;
|
|
265
209
|
};
|
|
266
|
-
/**
|
|
267
|
-
* @nullable
|
|
268
|
-
*/
|
|
269
210
|
type ActiveSessionCurrentLocation = {
|
|
270
211
|
cityName: string;
|
|
271
212
|
countryISOCode: string;
|
|
@@ -280,7 +221,6 @@ interface ActiveSession {
|
|
|
280
221
|
/** @nullable */
|
|
281
222
|
organizationId?: string | null;
|
|
282
223
|
state: ActiveSessionState;
|
|
283
|
-
/** @nullable */
|
|
284
224
|
currentLocation?: ActiveSessionCurrentLocation;
|
|
285
225
|
usedSsoAuth: boolean;
|
|
286
226
|
usedPasswordAuth: boolean;
|
|
@@ -310,13 +250,9 @@ interface ActiveSession {
|
|
|
310
250
|
interface ActiveSessionsResponse {
|
|
311
251
|
data: ActiveSession[];
|
|
312
252
|
}
|
|
313
|
-
type SendVerificationResponseType = (typeof SendVerificationResponseType)[keyof typeof SendVerificationResponseType];
|
|
314
|
-
declare const SendVerificationResponseType: {
|
|
315
|
-
readonly EmailVerification: "EmailVerification";
|
|
316
|
-
};
|
|
317
253
|
interface SendVerificationResponse {
|
|
318
254
|
authenticationChallenge: string;
|
|
319
|
-
type:
|
|
255
|
+
type: "EmailVerification";
|
|
320
256
|
}
|
|
321
257
|
interface VerifyRequest {
|
|
322
258
|
code: string;
|
|
@@ -340,12 +276,8 @@ interface VerifyPasskeyRequest {
|
|
|
340
276
|
challengeId: string;
|
|
341
277
|
response: VerifyPasskeyRequestResponse;
|
|
342
278
|
}
|
|
343
|
-
type SettingsResponseObject = (typeof SettingsResponseObject)[keyof typeof SettingsResponseObject];
|
|
344
|
-
declare const SettingsResponseObject: {
|
|
345
|
-
readonly settings: "settings";
|
|
346
|
-
};
|
|
347
279
|
interface SettingsResponse {
|
|
348
|
-
object:
|
|
280
|
+
object: "settings";
|
|
349
281
|
authkitOrigin: string;
|
|
350
282
|
/** @nullable */
|
|
351
283
|
logoDarkIconPath?: string | null;
|
|
@@ -425,101 +357,45 @@ interface SsoConnectionSessionJSON {
|
|
|
425
357
|
createdAt: string;
|
|
426
358
|
state: (typeof SsoConnectionSessionJSONState)[keyof typeof SsoConnectionSessionJSONState];
|
|
427
359
|
}
|
|
428
|
-
type
|
|
429
|
-
declare const SsoConnectionAnyOfType: {
|
|
430
|
-
readonly AdfsSaml: "AdfsSaml";
|
|
431
|
-
readonly Auth0Saml: "Auth0Saml";
|
|
432
|
-
readonly AzureSaml: "AzureSaml";
|
|
433
|
-
readonly CasSaml: "CasSaml";
|
|
434
|
-
readonly ClassLinkSaml: "ClassLinkSaml";
|
|
435
|
-
readonly CloudflareSaml: "CloudflareSaml";
|
|
436
|
-
readonly CyberArkSaml: "CyberArkSaml";
|
|
437
|
-
readonly DuoSaml: "DuoSaml";
|
|
438
|
-
readonly GenericSaml: "GenericSaml";
|
|
439
|
-
readonly GoogleSaml: "GoogleSaml";
|
|
440
|
-
readonly JumpCloudSaml: "JumpCloudSaml";
|
|
441
|
-
readonly KeycloakSaml: "KeycloakSaml";
|
|
442
|
-
readonly LastPassSaml: "LastPassSaml";
|
|
443
|
-
readonly MiniOrangeSaml: "MiniOrangeSaml";
|
|
444
|
-
readonly NetIqSaml: "NetIqSaml";
|
|
445
|
-
readonly OktaSaml: "OktaSaml";
|
|
446
|
-
readonly OneLoginSaml: "OneLoginSaml";
|
|
447
|
-
readonly OracleSaml: "OracleSaml";
|
|
448
|
-
readonly PingFederateSaml: "PingFederateSaml";
|
|
449
|
-
readonly PingOneSaml: "PingOneSaml";
|
|
450
|
-
readonly RipplingSaml: "RipplingSaml";
|
|
451
|
-
readonly SalesforceSaml: "SalesforceSaml";
|
|
452
|
-
readonly ShibbolethGenericSaml: "ShibbolethGenericSaml";
|
|
453
|
-
readonly ShibbolethSaml: "ShibbolethSaml";
|
|
454
|
-
readonly SimpleSamlPhpSaml: "SimpleSamlPhpSaml";
|
|
455
|
-
readonly TestIdp: "TestIdp";
|
|
456
|
-
readonly VmWareSaml: "VmWareSaml";
|
|
457
|
-
};
|
|
458
|
-
type SsoConnectionAnyOfState = (typeof SsoConnectionAnyOfState)[keyof typeof SsoConnectionAnyOfState];
|
|
459
|
-
declare const SsoConnectionAnyOfState: {
|
|
460
|
-
readonly Inactive: "Inactive";
|
|
461
|
-
readonly Validating: "Validating";
|
|
462
|
-
readonly Active: "Active";
|
|
463
|
-
readonly Deleting: "Deleting";
|
|
464
|
-
};
|
|
465
|
-
type SsoConnectionAnyOfLatestExpiringCertificate = X509CertificateJSON | null;
|
|
466
|
-
type SsoConnectionAnyOfLatestExpiredCertificate = X509CertificateJSON | null;
|
|
467
|
-
type SsoConnectionAnyOfProviderTag = (typeof SsoConnectionAnyOfProviderTag)[keyof typeof SsoConnectionAnyOfProviderTag];
|
|
468
|
-
declare const SsoConnectionAnyOfProviderTag: {
|
|
469
|
-
readonly Saml: "Saml";
|
|
470
|
-
};
|
|
471
|
-
type SsoConnectionAnyOfLastSession = SsoConnectionSessionJSON | null;
|
|
472
|
-
type SsoConnectionAnyOf = {
|
|
360
|
+
type SsoConnection = {
|
|
473
361
|
id: string;
|
|
474
|
-
type:
|
|
362
|
+
type: "AdfsSaml" | "Auth0Saml" | "AzureSaml" | "CasSaml" | "ClassLinkSaml" | "CloudflareSaml" | "CyberArkSaml" | "DuoSaml" | "GenericSaml" | "GoogleSaml" | "JumpCloudSaml" | "KeycloakSaml" | "LastPassSaml" | "MiniOrangeSaml" | "NetIqSaml" | "OktaSaml" | "OneLoginSaml" | "OracleSaml" | "PingFederateSaml" | "PingOneSaml" | "RipplingSaml" | "SalesforceSaml" | "ShibbolethGenericSaml" | "ShibbolethSaml" | "SimpleSamlPhpSaml" | "TestIdp" | "VmWareSaml";
|
|
475
363
|
name: string;
|
|
476
|
-
state:
|
|
364
|
+
state: "Inactive" | "Validating" | "Active" | "Deleting";
|
|
477
365
|
x509Certificates: X509CertificateJSON[];
|
|
478
|
-
latestExpiringCertificate?:
|
|
479
|
-
latestExpiredCertificate?:
|
|
366
|
+
latestExpiringCertificate?: X509CertificateJSON | null;
|
|
367
|
+
latestExpiredCertificate?: X509CertificateJSON | null;
|
|
480
368
|
createdAt: string;
|
|
481
|
-
providerTag:
|
|
482
|
-
lastSession?:
|
|
483
|
-
}
|
|
484
|
-
type SsoConnectionAnyOfEightAllOfState = (typeof SsoConnectionAnyOfEightAllOfState)[keyof typeof SsoConnectionAnyOfEightAllOfState];
|
|
485
|
-
declare const SsoConnectionAnyOfEightAllOfState: {
|
|
486
|
-
readonly Inactive: "Inactive";
|
|
487
|
-
readonly Validating: "Validating";
|
|
488
|
-
readonly Active: "Active";
|
|
489
|
-
readonly Deleting: "Deleting";
|
|
490
|
-
};
|
|
491
|
-
type SsoConnectionAnyOfEightAllOfType = (typeof SsoConnectionAnyOfEightAllOfType)[keyof typeof SsoConnectionAnyOfEightAllOfType];
|
|
492
|
-
declare const SsoConnectionAnyOfEightAllOfType: {
|
|
493
|
-
readonly AdpOidc: "AdpOidc";
|
|
494
|
-
readonly Auth0Migration: "Auth0Migration";
|
|
495
|
-
readonly CleverOidc: "CleverOidc";
|
|
496
|
-
readonly EntraIdOidc: "EntraIdOidc";
|
|
497
|
-
readonly GenericOidc: "GenericOidc";
|
|
498
|
-
readonly GoogleOidc: "GoogleOidc";
|
|
499
|
-
readonly OktaOidc: "OktaOidc";
|
|
500
|
-
readonly LoginGovOidc: "LoginGovOidc";
|
|
501
|
-
};
|
|
502
|
-
type SsoConnectionAnyOfEightAllOfProviderTag = (typeof SsoConnectionAnyOfEightAllOfProviderTag)[keyof typeof SsoConnectionAnyOfEightAllOfProviderTag];
|
|
503
|
-
declare const SsoConnectionAnyOfEightAllOfProviderTag: {
|
|
504
|
-
readonly OpenIdConnect: "OpenIdConnect";
|
|
505
|
-
};
|
|
506
|
-
type SsoConnectionAnyOfEightAllOfLastSession = SsoConnectionSessionJSON | null;
|
|
507
|
-
type SsoConnectionAnyOfEightAllOf = {
|
|
369
|
+
providerTag: "Saml";
|
|
370
|
+
lastSession?: SsoConnectionSessionJSON | null;
|
|
371
|
+
} | ({
|
|
508
372
|
id: string;
|
|
509
373
|
name: string;
|
|
510
|
-
state:
|
|
511
|
-
type:
|
|
374
|
+
state: "Inactive" | "Validating" | "Active" | "Deleting";
|
|
375
|
+
type: "AdpOidc" | "Auth0Migration" | "CleverOidc" | "EntraIdOidc" | "GenericOidc" | "GoogleOidc" | "OktaOidc" | "LoginGovOidc";
|
|
512
376
|
createdAt: string;
|
|
513
|
-
providerTag:
|
|
514
|
-
lastSession?:
|
|
515
|
-
}
|
|
516
|
-
|
|
377
|
+
providerTag: "OpenIdConnect";
|
|
378
|
+
lastSession?: SsoConnectionSessionJSON | null;
|
|
379
|
+
} & {
|
|
380
|
+
/** @nullable */
|
|
517
381
|
x509Certificates?: null;
|
|
382
|
+
/** @nullable */
|
|
518
383
|
latestExpiringCertificate?: null;
|
|
384
|
+
/** @nullable */
|
|
519
385
|
latestExpiredCertificate?: null;
|
|
520
|
-
};
|
|
521
|
-
type
|
|
522
|
-
type
|
|
386
|
+
});
|
|
387
|
+
type AuditLogStreamState = "Active" | "Inactive" | "Error" | "Invalid";
|
|
388
|
+
type AuditLogStreamType = "Datadog" | "Splunk" | "S3" | "GoogleCloudStorage" | "GenericHttps" | "AzureSentinel";
|
|
389
|
+
interface AuditLogStreamJSON {
|
|
390
|
+
id: string;
|
|
391
|
+
state: AuditLogStreamState;
|
|
392
|
+
type: AuditLogStreamType;
|
|
393
|
+
/** @nullable */
|
|
394
|
+
errorMessage?: string | null;
|
|
395
|
+
/** @nullable */
|
|
396
|
+
lastSyncedEventId?: string | null;
|
|
397
|
+
auditLogTrailId: string;
|
|
398
|
+
}
|
|
523
399
|
interface ListOrganizationApiKeysResponseData {
|
|
524
400
|
id: string;
|
|
525
401
|
name: string;
|
|
@@ -535,7 +411,7 @@ type ListOrganizationApiKeysResponseListMetadata = {
|
|
|
535
411
|
};
|
|
536
412
|
interface ListOrganizationApiKeysResponse {
|
|
537
413
|
data: ListOrganizationApiKeysResponseData[];
|
|
538
|
-
|
|
414
|
+
list_metadata: ListOrganizationApiKeysResponseListMetadata;
|
|
539
415
|
}
|
|
540
416
|
interface CreateOrganizationApiKeyRequest {
|
|
541
417
|
name: string;
|
|
@@ -562,137 +438,193 @@ type ListOrganizationApiKeyPermissionsResponseListMetadata = {
|
|
|
562
438
|
};
|
|
563
439
|
interface ListOrganizationApiKeyPermissionsResponse {
|
|
564
440
|
data: ListOrganizationApiKeyPermission[];
|
|
565
|
-
|
|
441
|
+
list_metadata: ListOrganizationApiKeyPermissionsResponseListMetadata;
|
|
566
442
|
}
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
readonly connected_account: "connected_account";
|
|
570
|
-
};
|
|
571
|
-
declare const DataInstallationState: {
|
|
572
|
-
readonly connected: "connected";
|
|
573
|
-
readonly needs_reauthorization: "needs_reauthorization";
|
|
574
|
-
};
|
|
575
|
-
interface DataInstallation {
|
|
576
|
-
object: (typeof DataInstallationObject)[keyof typeof DataInstallationObject];
|
|
443
|
+
type DataInstallation = {
|
|
444
|
+
object: "data_installation" | "connected_account";
|
|
577
445
|
id: string;
|
|
446
|
+
/** @nullable */
|
|
447
|
+
user_id?: string | null;
|
|
448
|
+
/** @nullable */
|
|
449
|
+
organization_id?: string | null;
|
|
450
|
+
scopes: string[];
|
|
451
|
+
state: "connected" | "needs_reauthorization";
|
|
452
|
+
created_at: string;
|
|
453
|
+
updated_at: string;
|
|
454
|
+
} & {
|
|
578
455
|
/** @nullable */
|
|
579
456
|
userlandUserId?: string | null;
|
|
580
457
|
/** @nullable */
|
|
581
458
|
organizationId?: string | null;
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
|
|
585
|
-
updatedAt: string;
|
|
586
|
-
}
|
|
587
|
-
type DataIntegrationObject = (typeof DataIntegrationObject)[keyof typeof DataIntegrationObject];
|
|
588
|
-
declare const DataIntegrationObject: {
|
|
589
|
-
readonly data_integration: "data_integration";
|
|
590
|
-
};
|
|
591
|
-
declare const DataIntegrationIntegrationType: {
|
|
592
|
-
readonly asana: "asana";
|
|
593
|
-
readonly box: "box";
|
|
594
|
-
readonly "cal-dot-com": "cal-dot-com";
|
|
595
|
-
readonly calendly: "calendly";
|
|
596
|
-
readonly confluence: "confluence";
|
|
597
|
-
readonly dropbox: "dropbox";
|
|
598
|
-
readonly "frame-io": "frame-io";
|
|
599
|
-
readonly front: "front";
|
|
600
|
-
readonly github: "github";
|
|
601
|
-
readonly gitlab: "gitlab";
|
|
602
|
-
readonly gmail: "gmail";
|
|
603
|
-
readonly google: "google";
|
|
604
|
-
readonly "google-calendar": "google-calendar";
|
|
605
|
-
readonly "google-drive": "google-drive";
|
|
606
|
-
readonly helpscout: "helpscout";
|
|
607
|
-
readonly hubspot: "hubspot";
|
|
608
|
-
readonly intercom: "intercom";
|
|
609
|
-
readonly jira: "jira";
|
|
610
|
-
readonly linear: "linear";
|
|
611
|
-
readonly microsoft: "microsoft";
|
|
612
|
-
readonly "microsoft-onedrive": "microsoft-onedrive";
|
|
613
|
-
readonly "microsoft-onenote": "microsoft-onenote";
|
|
614
|
-
readonly "microsoft-outlook": "microsoft-outlook";
|
|
615
|
-
readonly "microsoft-outlook-calendar": "microsoft-outlook-calendar";
|
|
616
|
-
readonly "microsoft-sharepoint": "microsoft-sharepoint";
|
|
617
|
-
readonly "microsoft-teams": "microsoft-teams";
|
|
618
|
-
readonly "microsoft-todo": "microsoft-todo";
|
|
619
|
-
readonly notion: "notion";
|
|
620
|
-
readonly prefect: "prefect";
|
|
621
|
-
readonly "pydantic-logfire": "pydantic-logfire";
|
|
622
|
-
readonly salesforce: "salesforce";
|
|
623
|
-
readonly sentry: "sentry";
|
|
624
|
-
readonly slack: "slack";
|
|
625
|
-
readonly snowflake: "snowflake";
|
|
626
|
-
readonly stripe: "stripe";
|
|
627
|
-
readonly xero: "xero";
|
|
628
|
-
readonly zendesk: "zendesk";
|
|
629
|
-
};
|
|
630
|
-
declare const DataIntegrationOwnership: {
|
|
631
|
-
readonly userland_user: "userland_user";
|
|
632
|
-
readonly organization: "organization";
|
|
633
|
-
};
|
|
634
|
-
declare const DataIntegrationCredentialsType: {
|
|
635
|
-
readonly shared: "shared";
|
|
636
|
-
readonly custom: "custom";
|
|
637
|
-
};
|
|
638
|
-
type DataIntegrationInstallation = DataInstallation | null;
|
|
459
|
+
createdAt?: string;
|
|
460
|
+
updatedAt?: string;
|
|
461
|
+
};
|
|
639
462
|
interface DataIntegration {
|
|
640
|
-
object:
|
|
463
|
+
object: "data_integration";
|
|
641
464
|
id: string;
|
|
642
465
|
name: string;
|
|
643
466
|
/** @nullable */
|
|
644
467
|
description?: string | null;
|
|
645
468
|
slug: string;
|
|
646
|
-
integrationType:
|
|
647
|
-
ownership:
|
|
648
|
-
credentialsType:
|
|
649
|
-
/** @nullable */
|
|
469
|
+
integrationType: "asana" | "box" | "cal-dot-com" | "calendly" | "confluence" | "dropbox" | "frame-io" | "front" | "github" | "gitlab" | "gmail" | "google" | "google-calendar" | "google-drive" | "helpscout" | "hubspot" | "intercom" | "jira" | "linear" | "microsoft" | "microsoft-onedrive" | "microsoft-onenote" | "microsoft-outlook" | "microsoft-outlook-calendar" | "microsoft-sharepoint" | "microsoft-teams" | "microsoft-todo" | "notion" | "prefect" | "pydantic-logfire" | "salesforce" | "sentry" | "slack" | "snowflake" | "stripe" | "xero" | "zendesk";
|
|
470
|
+
ownership: "userland_user" | "organization";
|
|
471
|
+
credentialsType: "shared" | "custom";
|
|
650
472
|
scopes?: string[] | null;
|
|
651
473
|
createdAt: string;
|
|
652
474
|
updatedAt: string;
|
|
653
|
-
installation?:
|
|
475
|
+
installation?: DataInstallation | null;
|
|
654
476
|
}
|
|
655
477
|
interface DataIntegrationsResponse {
|
|
656
478
|
data: DataIntegration[];
|
|
657
479
|
}
|
|
658
|
-
type
|
|
480
|
+
type GetDataIntegrationAuthorizeUrlResponse = {
|
|
659
481
|
url: string;
|
|
660
482
|
redirectToken: string;
|
|
661
|
-
}
|
|
662
|
-
type GetDataIntegrationAuthorizeUrlResponseAllOfTwo = {
|
|
483
|
+
} & {
|
|
663
484
|
handoffToken?: string;
|
|
664
485
|
};
|
|
665
|
-
type GetDataIntegrationAuthorizeUrlResponse = GetDataIntegrationAuthorizeUrlResponseAllOf & GetDataIntegrationAuthorizeUrlResponseAllOfTwo;
|
|
666
486
|
interface GetAuthorizationStatusResponse {
|
|
667
487
|
isConnecting: boolean;
|
|
668
488
|
}
|
|
669
|
-
type
|
|
489
|
+
type DirectoryType = (typeof DirectoryType)[keyof typeof DirectoryType];
|
|
490
|
+
declare const DirectoryType: {
|
|
491
|
+
readonly azure_scim_v20: "azure scim v2.0";
|
|
492
|
+
readonly bamboohr: "bamboohr";
|
|
493
|
+
readonly breathe_hr: "breathe hr";
|
|
494
|
+
readonly cezanne_hr: "cezanne hr";
|
|
495
|
+
readonly cyberark_scim_v20: "cyberark scim v2.0";
|
|
496
|
+
readonly fourth_hr: "fourth hr";
|
|
497
|
+
readonly generic_scim_v20: "generic scim v2.0";
|
|
498
|
+
readonly gsuite_directory: "gsuite directory";
|
|
499
|
+
readonly gusto: "gusto";
|
|
500
|
+
readonly hibob: "hibob";
|
|
501
|
+
readonly jump_cloud_scim_v20: "jump cloud scim v2.0";
|
|
502
|
+
readonly okta_scim_v20: "okta scim v2.0";
|
|
503
|
+
readonly onelogin_scim_v20: "onelogin scim v2.0";
|
|
504
|
+
readonly people_hr: "people hr";
|
|
505
|
+
readonly personio: "personio";
|
|
506
|
+
readonly pingfederate_scim_v20: "pingfederate scim v2.0";
|
|
507
|
+
readonly rippling: "rippling";
|
|
508
|
+
readonly rippling_scim_v20: "rippling scim v2.0";
|
|
509
|
+
readonly s3: "s3";
|
|
510
|
+
readonly sailpoint_scim_v20: "sailpoint scim v2.0";
|
|
511
|
+
readonly sftp: "sftp";
|
|
512
|
+
readonly sftp_workday: "sftp workday";
|
|
513
|
+
readonly workday: "workday";
|
|
514
|
+
};
|
|
515
|
+
type DirectoryState = (typeof DirectoryState)[keyof typeof DirectoryState];
|
|
516
|
+
declare const DirectoryState: {
|
|
517
|
+
readonly requires_type: "requires_type";
|
|
518
|
+
readonly linked: "linked";
|
|
519
|
+
readonly validating: "validating";
|
|
520
|
+
readonly invalid_credentials: "invalid_credentials";
|
|
521
|
+
readonly unlinked: "unlinked";
|
|
522
|
+
readonly deleting: "deleting";
|
|
523
|
+
};
|
|
524
|
+
interface DirectoryUsersMetadata {
|
|
525
|
+
active: number;
|
|
526
|
+
inactive: number;
|
|
527
|
+
}
|
|
528
|
+
interface DirectoryMetadata {
|
|
529
|
+
users: DirectoryUsersMetadata;
|
|
530
|
+
groups: number;
|
|
531
|
+
}
|
|
532
|
+
interface Directory {
|
|
533
|
+
id: string;
|
|
534
|
+
name: string;
|
|
535
|
+
type: DirectoryType;
|
|
536
|
+
state: DirectoryState;
|
|
537
|
+
createdAt: string;
|
|
538
|
+
updatedAt: string;
|
|
539
|
+
/** @nullable */
|
|
540
|
+
lastSyncRunAt?: string | null;
|
|
541
|
+
metadata: DirectoryMetadata;
|
|
542
|
+
}
|
|
543
|
+
interface DirectoriesResponse {
|
|
544
|
+
data: Directory[];
|
|
545
|
+
link: string;
|
|
546
|
+
}
|
|
547
|
+
type CreateOrganizationApiKey400 = {
|
|
548
|
+
message: string;
|
|
549
|
+
};
|
|
550
|
+
type CreateOrganizationApiKey403 = {
|
|
551
|
+
message: string;
|
|
552
|
+
};
|
|
553
|
+
type CreateOrganizationApiKey404 = {
|
|
554
|
+
message: string;
|
|
555
|
+
};
|
|
556
|
+
type CreateOrganizationApiKey422ErrorsItem = {
|
|
557
|
+
code: string;
|
|
558
|
+
field: string;
|
|
559
|
+
};
|
|
560
|
+
type CreateOrganizationApiKey422 = {
|
|
561
|
+
message: string;
|
|
562
|
+
errors: CreateOrganizationApiKey422ErrorsItem[];
|
|
563
|
+
};
|
|
564
|
+
type ListOrganizationApiKeysParams = {
|
|
565
|
+
limit?: number;
|
|
566
|
+
before?: string;
|
|
567
|
+
after?: string;
|
|
670
568
|
search?: string;
|
|
671
|
-
|
|
569
|
+
};
|
|
570
|
+
type ListOrganizationApiKeys400 = {
|
|
571
|
+
message: string;
|
|
572
|
+
};
|
|
573
|
+
type ListOrganizationApiKeys403 = {
|
|
574
|
+
message: string;
|
|
575
|
+
};
|
|
576
|
+
type ListOrganizationApiKeyPermissionsParams = {
|
|
577
|
+
search?: string;
|
|
578
|
+
limit?: number;
|
|
672
579
|
before?: string;
|
|
673
580
|
after?: string;
|
|
674
|
-
role?: string;
|
|
675
581
|
};
|
|
676
|
-
type
|
|
677
|
-
|
|
678
|
-
listMetadata: ListMetadata;
|
|
582
|
+
type ListOrganizationApiKeyPermissions400 = {
|
|
583
|
+
message: string;
|
|
679
584
|
};
|
|
680
|
-
type
|
|
585
|
+
type ListOrganizationApiKeyPermissions403 = {
|
|
681
586
|
message: string;
|
|
682
587
|
};
|
|
683
|
-
type
|
|
588
|
+
type DeleteOrganizationApiKey200 = {
|
|
589
|
+
success: boolean;
|
|
590
|
+
};
|
|
591
|
+
type DeleteOrganizationApiKey403 = {
|
|
684
592
|
message: string;
|
|
685
593
|
};
|
|
686
|
-
type
|
|
594
|
+
type DeleteOrganizationApiKey404 = {
|
|
687
595
|
message: string;
|
|
688
596
|
};
|
|
689
|
-
type
|
|
597
|
+
type DeleteDataInstallation200 = {
|
|
598
|
+
success: boolean;
|
|
599
|
+
};
|
|
600
|
+
type DeleteDataInstallation403 = {
|
|
690
601
|
message: string;
|
|
691
602
|
};
|
|
692
|
-
type
|
|
603
|
+
type DeleteDataInstallation404 = {
|
|
693
604
|
message: string;
|
|
694
605
|
};
|
|
695
|
-
type
|
|
606
|
+
type MyDataIntegrations403 = {
|
|
607
|
+
message: string;
|
|
608
|
+
};
|
|
609
|
+
type GetDataInstallationAuthorizationStatus400 = {
|
|
610
|
+
message: string;
|
|
611
|
+
};
|
|
612
|
+
type GetDataInstallationAuthorizationStatus403 = {
|
|
613
|
+
message: string;
|
|
614
|
+
};
|
|
615
|
+
type GetDataInstallationAuthorizationStatus404 = {
|
|
616
|
+
message: string;
|
|
617
|
+
};
|
|
618
|
+
type GetDataIntegrationAuthorizeUrlParams = {
|
|
619
|
+
requireHandoff?: boolean;
|
|
620
|
+
};
|
|
621
|
+
type GetDataIntegrationAuthorizeUrl400 = {
|
|
622
|
+
message: string;
|
|
623
|
+
};
|
|
624
|
+
type GetDataIntegrationAuthorizeUrl403 = {
|
|
625
|
+
message: string;
|
|
626
|
+
};
|
|
627
|
+
type GetDataIntegrationAuthorizeUrl404 = {
|
|
696
628
|
message: string;
|
|
697
629
|
};
|
|
698
630
|
type InviteMemberBody = {
|
|
@@ -715,6 +647,19 @@ type InviteMember403 = {
|
|
|
715
647
|
type InviteMember404 = {
|
|
716
648
|
message: string;
|
|
717
649
|
};
|
|
650
|
+
type RevokeInvite200 = {
|
|
651
|
+
id: string;
|
|
652
|
+
success: boolean;
|
|
653
|
+
};
|
|
654
|
+
type RevokeInvite400 = {
|
|
655
|
+
message: string;
|
|
656
|
+
};
|
|
657
|
+
type RevokeInvite403 = {
|
|
658
|
+
message: string;
|
|
659
|
+
};
|
|
660
|
+
type RevokeInvite404 = {
|
|
661
|
+
message: string;
|
|
662
|
+
};
|
|
718
663
|
type ResendInvite201 = {
|
|
719
664
|
/** @nullable */
|
|
720
665
|
id?: string | null;
|
|
@@ -732,17 +677,21 @@ type ResendInvite404 = {
|
|
|
732
677
|
type ResendInvite422 = {
|
|
733
678
|
message: string;
|
|
734
679
|
};
|
|
735
|
-
type
|
|
736
|
-
|
|
737
|
-
|
|
680
|
+
type MembersParams = {
|
|
681
|
+
search?: string;
|
|
682
|
+
limit?: string;
|
|
683
|
+
before?: string;
|
|
684
|
+
after?: string;
|
|
685
|
+
role?: string;
|
|
738
686
|
};
|
|
739
|
-
type
|
|
740
|
-
|
|
687
|
+
type Members200 = {
|
|
688
|
+
data: Member[];
|
|
689
|
+
list_metadata: ListMetadata;
|
|
741
690
|
};
|
|
742
|
-
type
|
|
691
|
+
type Members403 = {
|
|
743
692
|
message: string;
|
|
744
693
|
};
|
|
745
|
-
type
|
|
694
|
+
type Members404 = {
|
|
746
695
|
message: string;
|
|
747
696
|
};
|
|
748
697
|
type RemoveMember200 = {
|
|
@@ -783,18 +732,28 @@ type Organizations403 = {
|
|
|
783
732
|
type Organizations404 = {
|
|
784
733
|
message: string;
|
|
785
734
|
};
|
|
786
|
-
type
|
|
735
|
+
type Roles403 = {
|
|
787
736
|
message: string;
|
|
788
737
|
};
|
|
789
|
-
type
|
|
790
|
-
|
|
791
|
-
lastName?: string;
|
|
792
|
-
locale?: string;
|
|
738
|
+
type Roles404 = {
|
|
739
|
+
message: string;
|
|
793
740
|
};
|
|
794
|
-
type
|
|
741
|
+
type RolesAndConfig403 = {
|
|
795
742
|
message: string;
|
|
796
743
|
};
|
|
797
|
-
type
|
|
744
|
+
type RolesAndConfig404 = {
|
|
745
|
+
message: string;
|
|
746
|
+
};
|
|
747
|
+
type AuthenticationInformation403 = {
|
|
748
|
+
message: string;
|
|
749
|
+
};
|
|
750
|
+
type CreatePassword201 = {
|
|
751
|
+
success: boolean;
|
|
752
|
+
};
|
|
753
|
+
type CreatePassword400 = {
|
|
754
|
+
message: string;
|
|
755
|
+
};
|
|
756
|
+
type CreatePassword403 = {
|
|
798
757
|
message: string;
|
|
799
758
|
};
|
|
800
759
|
type CreateTotpFactor400 = {
|
|
@@ -803,43 +762,51 @@ type CreateTotpFactor400 = {
|
|
|
803
762
|
type CreateTotpFactor403 = {
|
|
804
763
|
message: string;
|
|
805
764
|
};
|
|
806
|
-
type
|
|
807
|
-
|
|
765
|
+
type Me403 = {
|
|
766
|
+
message: string;
|
|
808
767
|
};
|
|
809
|
-
type
|
|
768
|
+
type UpdateMeBody = {
|
|
769
|
+
firstName?: string;
|
|
770
|
+
lastName?: string;
|
|
771
|
+
locale?: string;
|
|
772
|
+
};
|
|
773
|
+
type UpdateMe400 = {
|
|
810
774
|
message: string;
|
|
811
775
|
};
|
|
812
|
-
type
|
|
776
|
+
type UpdateMe403 = {
|
|
813
777
|
message: string;
|
|
814
778
|
};
|
|
815
|
-
type
|
|
816
|
-
|
|
779
|
+
type RegisterPasskey400 = {
|
|
780
|
+
message: string;
|
|
817
781
|
};
|
|
818
|
-
type
|
|
782
|
+
type RegisterPasskey403 = {
|
|
819
783
|
message: string;
|
|
820
784
|
};
|
|
821
|
-
type
|
|
785
|
+
type VerifyPasskey200 = {
|
|
786
|
+
success: boolean;
|
|
787
|
+
};
|
|
788
|
+
type VerifyPasskey400 = {
|
|
822
789
|
message: string;
|
|
823
790
|
};
|
|
824
|
-
type
|
|
791
|
+
type VerifyPasskey403 = {
|
|
825
792
|
message: string;
|
|
826
793
|
};
|
|
827
|
-
type
|
|
794
|
+
type DeletePasskey200 = {
|
|
828
795
|
success: boolean;
|
|
829
796
|
};
|
|
830
|
-
type
|
|
797
|
+
type DeletePasskey400 = {
|
|
831
798
|
message: string;
|
|
832
799
|
};
|
|
833
|
-
type
|
|
800
|
+
type DeletePasskey403 = {
|
|
834
801
|
message: string;
|
|
835
802
|
};
|
|
836
|
-
type
|
|
837
|
-
|
|
803
|
+
type SendVerification400 = {
|
|
804
|
+
message: string;
|
|
838
805
|
};
|
|
839
|
-
type
|
|
806
|
+
type SendVerification403 = {
|
|
840
807
|
message: string;
|
|
841
808
|
};
|
|
842
|
-
type
|
|
809
|
+
type Sessions403 = {
|
|
843
810
|
message: string;
|
|
844
811
|
};
|
|
845
812
|
type RevokeAllSessions200 = {
|
|
@@ -860,55 +827,43 @@ type RevokeSession400 = {
|
|
|
860
827
|
type RevokeSession403 = {
|
|
861
828
|
message: string;
|
|
862
829
|
};
|
|
863
|
-
type
|
|
864
|
-
|
|
865
|
-
};
|
|
866
|
-
type SendVerification400 = {
|
|
867
|
-
message: string;
|
|
830
|
+
type DeleteTotpFactors200 = {
|
|
831
|
+
success: boolean;
|
|
868
832
|
};
|
|
869
|
-
type
|
|
833
|
+
type DeleteTotpFactors400 = {
|
|
870
834
|
message: string;
|
|
871
835
|
};
|
|
872
|
-
type
|
|
836
|
+
type DeleteTotpFactors403 = {
|
|
873
837
|
message: string;
|
|
874
838
|
};
|
|
875
|
-
type
|
|
876
|
-
|
|
839
|
+
type UpdatePassword201 = {
|
|
840
|
+
success: boolean;
|
|
877
841
|
};
|
|
878
|
-
type
|
|
842
|
+
type UpdatePassword400 = {
|
|
879
843
|
message: string;
|
|
880
844
|
};
|
|
881
|
-
type
|
|
845
|
+
type UpdatePassword403 = {
|
|
882
846
|
message: string;
|
|
883
847
|
};
|
|
884
|
-
type
|
|
885
|
-
success: boolean;
|
|
886
|
-
};
|
|
887
|
-
type VerifyPasskey400 = {
|
|
848
|
+
type Verify400 = {
|
|
888
849
|
message: string;
|
|
889
850
|
};
|
|
890
|
-
type
|
|
851
|
+
type Verify403 = {
|
|
891
852
|
message: string;
|
|
892
853
|
};
|
|
893
|
-
type
|
|
854
|
+
type VerifyTotpFactor200 = {
|
|
894
855
|
success: boolean;
|
|
895
856
|
};
|
|
896
|
-
type
|
|
897
|
-
message: string;
|
|
898
|
-
};
|
|
899
|
-
type DeletePasskey403 = {
|
|
857
|
+
type VerifyTotpFactor400 = {
|
|
900
858
|
message: string;
|
|
901
859
|
};
|
|
902
|
-
type
|
|
860
|
+
type VerifyTotpFactor403 = {
|
|
903
861
|
message: string;
|
|
904
862
|
};
|
|
905
|
-
type
|
|
906
|
-
|
|
907
|
-
};
|
|
908
|
-
type ListOrganizationDomains403 = {
|
|
909
|
-
message: string;
|
|
863
|
+
type GetAuditLogStream200 = AuditLogStreamJSON | {
|
|
864
|
+
[key: string]: unknown;
|
|
910
865
|
};
|
|
911
|
-
type
|
|
866
|
+
type GetAuditLogStream403 = {
|
|
912
867
|
message: string;
|
|
913
868
|
};
|
|
914
869
|
type GenerateAdminPortalLinkParams = {
|
|
@@ -918,6 +873,7 @@ type GenerateAdminPortalLinkIntent = (typeof GenerateAdminPortalLinkIntent)[keyo
|
|
|
918
873
|
declare const GenerateAdminPortalLinkIntent: {
|
|
919
874
|
readonly domain_verification: "domain_verification";
|
|
920
875
|
readonly sso: "sso";
|
|
876
|
+
readonly log_streams: "log_streams";
|
|
921
877
|
};
|
|
922
878
|
type GenerateAdminPortalLink201 = {
|
|
923
879
|
link: string;
|
|
@@ -931,245 +887,415 @@ type GenerateAdminPortalLink404 = {
|
|
|
931
887
|
type GenerateAdminPortalLink500 = {
|
|
932
888
|
message: string;
|
|
933
889
|
};
|
|
934
|
-
type
|
|
935
|
-
|
|
936
|
-
};
|
|
937
|
-
type DeleteOrganizationDomain404 = {
|
|
938
|
-
message: string;
|
|
939
|
-
};
|
|
940
|
-
type ReverifyOrganizationDomain403 = {
|
|
941
|
-
message: string;
|
|
942
|
-
};
|
|
943
|
-
type ReverifyOrganizationDomain404 = {
|
|
944
|
-
message: string;
|
|
945
|
-
};
|
|
946
|
-
type CreateOrganizationApiKey400 = {
|
|
947
|
-
message: string;
|
|
948
|
-
};
|
|
949
|
-
type CreateOrganizationApiKey403 = {
|
|
950
|
-
message: string;
|
|
890
|
+
type ListOrganizationDomains200 = {
|
|
891
|
+
data: OrganizationDomain[];
|
|
951
892
|
};
|
|
952
|
-
type
|
|
893
|
+
type ListOrganizationDomains403 = {
|
|
953
894
|
message: string;
|
|
954
895
|
};
|
|
955
|
-
type
|
|
956
|
-
code: string;
|
|
957
|
-
field: string;
|
|
958
|
-
};
|
|
959
|
-
type CreateOrganizationApiKey422 = {
|
|
896
|
+
type ListOrganizationDomains404 = {
|
|
960
897
|
message: string;
|
|
961
|
-
errors: CreateOrganizationApiKey422ErrorsItem[];
|
|
962
|
-
};
|
|
963
|
-
type ListOrganizationApiKeysParams = {
|
|
964
|
-
limit?: number;
|
|
965
|
-
before?: string;
|
|
966
|
-
after?: string;
|
|
967
|
-
search?: string;
|
|
968
898
|
};
|
|
969
|
-
type
|
|
899
|
+
type DeleteOrganizationDomain403 = {
|
|
970
900
|
message: string;
|
|
971
901
|
};
|
|
972
|
-
type
|
|
902
|
+
type DeleteOrganizationDomain404 = {
|
|
973
903
|
message: string;
|
|
974
904
|
};
|
|
975
|
-
type
|
|
976
|
-
search?: string;
|
|
977
|
-
limit?: number;
|
|
978
|
-
before?: string;
|
|
979
|
-
after?: string;
|
|
980
|
-
};
|
|
981
|
-
type ListOrganizationApiKeyPermissions400 = {
|
|
905
|
+
type ReverifyOrganizationDomain403 = {
|
|
982
906
|
message: string;
|
|
983
907
|
};
|
|
984
|
-
type
|
|
908
|
+
type ReverifyOrganizationDomain404 = {
|
|
985
909
|
message: string;
|
|
986
910
|
};
|
|
987
|
-
type
|
|
988
|
-
success: boolean;
|
|
989
|
-
};
|
|
990
|
-
type DeleteOrganizationApiKey403 = {
|
|
911
|
+
type ListDirectories403 = {
|
|
991
912
|
message: string;
|
|
992
913
|
};
|
|
993
|
-
type
|
|
914
|
+
type ListDirectories404 = {
|
|
994
915
|
message: string;
|
|
995
916
|
};
|
|
996
|
-
type
|
|
917
|
+
type GetDirectory403 = {
|
|
997
918
|
message: string;
|
|
998
919
|
};
|
|
999
|
-
type
|
|
1000
|
-
requireHandoff?: boolean;
|
|
1001
|
-
};
|
|
1002
|
-
type GetDataIntegrationAuthorizeUrl400 = {
|
|
920
|
+
type GetDirectory404 = {
|
|
1003
921
|
message: string;
|
|
1004
922
|
};
|
|
1005
|
-
type
|
|
923
|
+
type Settings403 = {
|
|
1006
924
|
message: string;
|
|
1007
925
|
};
|
|
1008
|
-
type
|
|
1009
|
-
|
|
926
|
+
type createOrganizationApiKeyResponse201 = {
|
|
927
|
+
data: CreateOrganizationApiKeyResponse;
|
|
928
|
+
status: 201;
|
|
1010
929
|
};
|
|
1011
|
-
type
|
|
1012
|
-
|
|
930
|
+
type createOrganizationApiKeyResponse400 = {
|
|
931
|
+
data: CreateOrganizationApiKey400;
|
|
932
|
+
status: 400;
|
|
1013
933
|
};
|
|
1014
|
-
type
|
|
1015
|
-
|
|
934
|
+
type createOrganizationApiKeyResponse403 = {
|
|
935
|
+
data: CreateOrganizationApiKey403;
|
|
936
|
+
status: 403;
|
|
1016
937
|
};
|
|
1017
|
-
type
|
|
1018
|
-
|
|
938
|
+
type createOrganizationApiKeyResponse404 = {
|
|
939
|
+
data: CreateOrganizationApiKey404;
|
|
940
|
+
status: 404;
|
|
1019
941
|
};
|
|
1020
|
-
type
|
|
1021
|
-
|
|
942
|
+
type createOrganizationApiKeyResponse422 = {
|
|
943
|
+
data: CreateOrganizationApiKey422;
|
|
944
|
+
status: 422;
|
|
1022
945
|
};
|
|
1023
|
-
type
|
|
1024
|
-
|
|
946
|
+
type createOrganizationApiKeyResponseSuccess = createOrganizationApiKeyResponse201 & {
|
|
947
|
+
headers: Headers;
|
|
1025
948
|
};
|
|
1026
|
-
type
|
|
1027
|
-
|
|
949
|
+
type createOrganizationApiKeyResponseError = (createOrganizationApiKeyResponse400 | createOrganizationApiKeyResponse403 | createOrganizationApiKeyResponse404 | createOrganizationApiKeyResponse422) & {
|
|
950
|
+
headers: Headers;
|
|
1028
951
|
};
|
|
1029
|
-
type
|
|
1030
|
-
|
|
952
|
+
type createOrganizationApiKeyResponse = createOrganizationApiKeyResponseSuccess | createOrganizationApiKeyResponseError;
|
|
953
|
+
declare const getCreateOrganizationApiKeyUrl: () => string;
|
|
954
|
+
declare const createOrganizationApiKey: (createOrganizationApiKeyRequest: CreateOrganizationApiKeyRequest, options?: RequestInit) => Promise<createOrganizationApiKeyResponse>;
|
|
955
|
+
declare const getCreateOrganizationApiKeyMutationOptions: <TError = CreateOrganizationApiKey400 | CreateOrganizationApiKey403 | CreateOrganizationApiKey404 | CreateOrganizationApiKey422, TContext = unknown>(options?: {
|
|
956
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createOrganizationApiKey>>, TError, {
|
|
957
|
+
data: CreateOrganizationApiKeyRequest;
|
|
958
|
+
}, TContext>;
|
|
959
|
+
fetch?: RequestInit;
|
|
960
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof createOrganizationApiKey>>, TError, {
|
|
961
|
+
data: CreateOrganizationApiKeyRequest;
|
|
962
|
+
}, TContext>;
|
|
963
|
+
type CreateOrganizationApiKeyMutationResult = NonNullable<Awaited<ReturnType<typeof createOrganizationApiKey>>>;
|
|
964
|
+
type CreateOrganizationApiKeyMutationBody = CreateOrganizationApiKeyRequest;
|
|
965
|
+
type CreateOrganizationApiKeyMutationError = CreateOrganizationApiKey400 | CreateOrganizationApiKey403 | CreateOrganizationApiKey404 | CreateOrganizationApiKey422;
|
|
966
|
+
declare const useCreateOrganizationApiKey: <TError = CreateOrganizationApiKey400 | CreateOrganizationApiKey403 | CreateOrganizationApiKey404 | CreateOrganizationApiKey422, TContext = unknown>(options?: {
|
|
967
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createOrganizationApiKey>>, TError, {
|
|
968
|
+
data: CreateOrganizationApiKeyRequest;
|
|
969
|
+
}, TContext>;
|
|
970
|
+
fetch?: RequestInit;
|
|
971
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createOrganizationApiKey>>, TError, {
|
|
972
|
+
data: CreateOrganizationApiKeyRequest;
|
|
973
|
+
}, TContext>;
|
|
974
|
+
type listOrganizationApiKeysResponse200 = {
|
|
975
|
+
data: ListOrganizationApiKeysResponse;
|
|
1031
976
|
status: 200;
|
|
1032
977
|
};
|
|
1033
|
-
type
|
|
1034
|
-
data:
|
|
1035
|
-
status:
|
|
978
|
+
type listOrganizationApiKeysResponse400 = {
|
|
979
|
+
data: ListOrganizationApiKeys400;
|
|
980
|
+
status: 400;
|
|
1036
981
|
};
|
|
1037
|
-
type
|
|
1038
|
-
data:
|
|
1039
|
-
status:
|
|
982
|
+
type listOrganizationApiKeysResponse403 = {
|
|
983
|
+
data: ListOrganizationApiKeys403;
|
|
984
|
+
status: 403;
|
|
1040
985
|
};
|
|
1041
|
-
type
|
|
986
|
+
type listOrganizationApiKeysResponseSuccess = listOrganizationApiKeysResponse200 & {
|
|
1042
987
|
headers: Headers;
|
|
1043
988
|
};
|
|
1044
|
-
type
|
|
989
|
+
type listOrganizationApiKeysResponseError = (listOrganizationApiKeysResponse400 | listOrganizationApiKeysResponse403) & {
|
|
1045
990
|
headers: Headers;
|
|
1046
991
|
};
|
|
1047
|
-
type
|
|
1048
|
-
declare const
|
|
1049
|
-
declare const
|
|
1050
|
-
declare const
|
|
1051
|
-
declare const
|
|
1052
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
992
|
+
type listOrganizationApiKeysResponse = listOrganizationApiKeysResponseSuccess | listOrganizationApiKeysResponseError;
|
|
993
|
+
declare const getListOrganizationApiKeysUrl: (params?: ListOrganizationApiKeysParams) => string;
|
|
994
|
+
declare const listOrganizationApiKeys: (params?: ListOrganizationApiKeysParams, options?: RequestInit) => Promise<listOrganizationApiKeysResponse>;
|
|
995
|
+
declare const getListOrganizationApiKeysQueryKey: (params?: ListOrganizationApiKeysParams) => readonly ["https://api.workos.com/_widgets/ApiKeys/organization-api-keys", ...ListOrganizationApiKeysParams[]];
|
|
996
|
+
declare const getListOrganizationApiKeysQueryOptions: <TData = Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError = ListOrganizationApiKeys400 | ListOrganizationApiKeys403>(params?: ListOrganizationApiKeysParams, options?: {
|
|
997
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError, TData>>;
|
|
1053
998
|
fetch?: RequestInit;
|
|
1054
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof
|
|
999
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError, TData> & {
|
|
1055
1000
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1056
1001
|
};
|
|
1057
|
-
type
|
|
1058
|
-
type
|
|
1059
|
-
declare function
|
|
1060
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1002
|
+
type ListOrganizationApiKeysQueryResult = NonNullable<Awaited<ReturnType<typeof listOrganizationApiKeys>>>;
|
|
1003
|
+
type ListOrganizationApiKeysQueryError = ListOrganizationApiKeys400 | ListOrganizationApiKeys403;
|
|
1004
|
+
declare function useListOrganizationApiKeys<TData = Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError = ListOrganizationApiKeys400 | ListOrganizationApiKeys403>(params: undefined | ListOrganizationApiKeysParams, options: {
|
|
1005
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError, Awaited<ReturnType<typeof listOrganizationApiKeys>>>, "initialData">;
|
|
1061
1006
|
fetch?: RequestInit;
|
|
1062
1007
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1063
1008
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1064
1009
|
};
|
|
1065
|
-
declare function
|
|
1066
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1010
|
+
declare function useListOrganizationApiKeys<TData = Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError = ListOrganizationApiKeys400 | ListOrganizationApiKeys403>(params?: ListOrganizationApiKeysParams, options?: {
|
|
1011
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError, Awaited<ReturnType<typeof listOrganizationApiKeys>>>, "initialData">;
|
|
1067
1012
|
fetch?: RequestInit;
|
|
1068
1013
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1069
1014
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1070
1015
|
};
|
|
1071
|
-
declare function
|
|
1072
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1016
|
+
declare function useListOrganizationApiKeys<TData = Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError = ListOrganizationApiKeys400 | ListOrganizationApiKeys403>(params?: ListOrganizationApiKeysParams, options?: {
|
|
1017
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeys>>, TError, TData>>;
|
|
1073
1018
|
fetch?: RequestInit;
|
|
1074
1019
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1075
1020
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1076
1021
|
};
|
|
1077
|
-
type
|
|
1078
|
-
data:
|
|
1022
|
+
type listOrganizationApiKeyPermissionsResponse200 = {
|
|
1023
|
+
data: ListOrganizationApiKeyPermissionsResponse;
|
|
1079
1024
|
status: 200;
|
|
1080
1025
|
};
|
|
1081
|
-
type
|
|
1082
|
-
data:
|
|
1083
|
-
status:
|
|
1026
|
+
type listOrganizationApiKeyPermissionsResponse400 = {
|
|
1027
|
+
data: ListOrganizationApiKeyPermissions400;
|
|
1028
|
+
status: 400;
|
|
1084
1029
|
};
|
|
1085
|
-
type
|
|
1086
|
-
data:
|
|
1087
|
-
status:
|
|
1030
|
+
type listOrganizationApiKeyPermissionsResponse403 = {
|
|
1031
|
+
data: ListOrganizationApiKeyPermissions403;
|
|
1032
|
+
status: 403;
|
|
1088
1033
|
};
|
|
1089
|
-
type
|
|
1034
|
+
type listOrganizationApiKeyPermissionsResponseSuccess = listOrganizationApiKeyPermissionsResponse200 & {
|
|
1090
1035
|
headers: Headers;
|
|
1091
1036
|
};
|
|
1092
|
-
type
|
|
1037
|
+
type listOrganizationApiKeyPermissionsResponseError = (listOrganizationApiKeyPermissionsResponse400 | listOrganizationApiKeyPermissionsResponse403) & {
|
|
1093
1038
|
headers: Headers;
|
|
1094
1039
|
};
|
|
1095
|
-
type
|
|
1096
|
-
declare const
|
|
1097
|
-
declare const
|
|
1098
|
-
declare const
|
|
1099
|
-
declare const
|
|
1100
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1040
|
+
type listOrganizationApiKeyPermissionsResponse = listOrganizationApiKeyPermissionsResponseSuccess | listOrganizationApiKeyPermissionsResponseError;
|
|
1041
|
+
declare const getListOrganizationApiKeyPermissionsUrl: (params?: ListOrganizationApiKeyPermissionsParams) => string;
|
|
1042
|
+
declare const listOrganizationApiKeyPermissions: (params?: ListOrganizationApiKeyPermissionsParams, options?: RequestInit) => Promise<listOrganizationApiKeyPermissionsResponse>;
|
|
1043
|
+
declare const getListOrganizationApiKeyPermissionsQueryKey: (params?: ListOrganizationApiKeyPermissionsParams) => readonly ["https://api.workos.com/_widgets/ApiKeys/permissions", ...ListOrganizationApiKeyPermissionsParams[]];
|
|
1044
|
+
declare const getListOrganizationApiKeyPermissionsQueryOptions: <TData = Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError = ListOrganizationApiKeyPermissions400 | ListOrganizationApiKeyPermissions403>(params?: ListOrganizationApiKeyPermissionsParams, options?: {
|
|
1045
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError, TData>>;
|
|
1101
1046
|
fetch?: RequestInit;
|
|
1102
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof
|
|
1047
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError, TData> & {
|
|
1103
1048
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1104
1049
|
};
|
|
1105
|
-
type
|
|
1106
|
-
type
|
|
1107
|
-
declare function
|
|
1108
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1050
|
+
type ListOrganizationApiKeyPermissionsQueryResult = NonNullable<Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>>;
|
|
1051
|
+
type ListOrganizationApiKeyPermissionsQueryError = ListOrganizationApiKeyPermissions400 | ListOrganizationApiKeyPermissions403;
|
|
1052
|
+
declare function useListOrganizationApiKeyPermissions<TData = Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError = ListOrganizationApiKeyPermissions400 | ListOrganizationApiKeyPermissions403>(params: undefined | ListOrganizationApiKeyPermissionsParams, options: {
|
|
1053
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError, Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>>, "initialData">;
|
|
1109
1054
|
fetch?: RequestInit;
|
|
1110
1055
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1111
1056
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1112
1057
|
};
|
|
1113
|
-
declare function
|
|
1114
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1058
|
+
declare function useListOrganizationApiKeyPermissions<TData = Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError = ListOrganizationApiKeyPermissions400 | ListOrganizationApiKeyPermissions403>(params?: ListOrganizationApiKeyPermissionsParams, options?: {
|
|
1059
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError, Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>>, "initialData">;
|
|
1115
1060
|
fetch?: RequestInit;
|
|
1116
1061
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1117
1062
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1118
1063
|
};
|
|
1119
|
-
declare function
|
|
1120
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1064
|
+
declare function useListOrganizationApiKeyPermissions<TData = Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError = ListOrganizationApiKeyPermissions400 | ListOrganizationApiKeyPermissions403>(params?: ListOrganizationApiKeyPermissionsParams, options?: {
|
|
1065
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationApiKeyPermissions>>, TError, TData>>;
|
|
1121
1066
|
fetch?: RequestInit;
|
|
1122
1067
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1123
1068
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1124
1069
|
};
|
|
1125
|
-
type
|
|
1126
|
-
data:
|
|
1070
|
+
type deleteOrganizationApiKeyResponse200 = {
|
|
1071
|
+
data: DeleteOrganizationApiKey200;
|
|
1127
1072
|
status: 200;
|
|
1128
1073
|
};
|
|
1129
|
-
type
|
|
1130
|
-
data:
|
|
1074
|
+
type deleteOrganizationApiKeyResponse403 = {
|
|
1075
|
+
data: DeleteOrganizationApiKey403;
|
|
1131
1076
|
status: 403;
|
|
1132
1077
|
};
|
|
1133
|
-
type
|
|
1134
|
-
data:
|
|
1078
|
+
type deleteOrganizationApiKeyResponse404 = {
|
|
1079
|
+
data: DeleteOrganizationApiKey404;
|
|
1135
1080
|
status: 404;
|
|
1136
1081
|
};
|
|
1137
|
-
type
|
|
1082
|
+
type deleteOrganizationApiKeyResponseSuccess = deleteOrganizationApiKeyResponse200 & {
|
|
1138
1083
|
headers: Headers;
|
|
1139
1084
|
};
|
|
1140
|
-
type
|
|
1085
|
+
type deleteOrganizationApiKeyResponseError = (deleteOrganizationApiKeyResponse403 | deleteOrganizationApiKeyResponse404) & {
|
|
1141
1086
|
headers: Headers;
|
|
1142
1087
|
};
|
|
1143
|
-
type
|
|
1144
|
-
declare const
|
|
1145
|
-
declare const
|
|
1146
|
-
declare const
|
|
1147
|
-
|
|
1148
|
-
|
|
1088
|
+
type deleteOrganizationApiKeyResponse = deleteOrganizationApiKeyResponseSuccess | deleteOrganizationApiKeyResponseError;
|
|
1089
|
+
declare const getDeleteOrganizationApiKeyUrl: (apiKeyId: string) => string;
|
|
1090
|
+
declare const deleteOrganizationApiKey: (apiKeyId: string, options?: RequestInit) => Promise<deleteOrganizationApiKeyResponse>;
|
|
1091
|
+
declare const getDeleteOrganizationApiKeyMutationOptions: <TError = DeleteOrganizationApiKey403 | DeleteOrganizationApiKey404, TContext = unknown>(options?: {
|
|
1092
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteOrganizationApiKey>>, TError, {
|
|
1093
|
+
apiKeyId: string;
|
|
1094
|
+
}, TContext>;
|
|
1149
1095
|
fetch?: RequestInit;
|
|
1150
|
-
}) =>
|
|
1096
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteOrganizationApiKey>>, TError, {
|
|
1097
|
+
apiKeyId: string;
|
|
1098
|
+
}, TContext>;
|
|
1099
|
+
type DeleteOrganizationApiKeyMutationResult = NonNullable<Awaited<ReturnType<typeof deleteOrganizationApiKey>>>;
|
|
1100
|
+
type DeleteOrganizationApiKeyMutationError = DeleteOrganizationApiKey403 | DeleteOrganizationApiKey404;
|
|
1101
|
+
declare const useDeleteOrganizationApiKey: <TError = DeleteOrganizationApiKey403 | DeleteOrganizationApiKey404, TContext = unknown>(options?: {
|
|
1102
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteOrganizationApiKey>>, TError, {
|
|
1103
|
+
apiKeyId: string;
|
|
1104
|
+
}, TContext>;
|
|
1105
|
+
fetch?: RequestInit;
|
|
1106
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteOrganizationApiKey>>, TError, {
|
|
1107
|
+
apiKeyId: string;
|
|
1108
|
+
}, TContext>;
|
|
1109
|
+
type deleteDataInstallationResponse200 = {
|
|
1110
|
+
data: DeleteDataInstallation200;
|
|
1111
|
+
status: 200;
|
|
1112
|
+
};
|
|
1113
|
+
type deleteDataInstallationResponse403 = {
|
|
1114
|
+
data: DeleteDataInstallation403;
|
|
1115
|
+
status: 403;
|
|
1116
|
+
};
|
|
1117
|
+
type deleteDataInstallationResponse404 = {
|
|
1118
|
+
data: DeleteDataInstallation404;
|
|
1119
|
+
status: 404;
|
|
1120
|
+
};
|
|
1121
|
+
type deleteDataInstallationResponseSuccess = deleteDataInstallationResponse200 & {
|
|
1122
|
+
headers: Headers;
|
|
1123
|
+
};
|
|
1124
|
+
type deleteDataInstallationResponseError = (deleteDataInstallationResponse403 | deleteDataInstallationResponse404) & {
|
|
1125
|
+
headers: Headers;
|
|
1126
|
+
};
|
|
1127
|
+
type deleteDataInstallationResponse = deleteDataInstallationResponseSuccess | deleteDataInstallationResponseError;
|
|
1128
|
+
declare const getDeleteDataInstallationUrl: (installationId: string) => string;
|
|
1129
|
+
declare const deleteDataInstallation: (installationId: string, options?: RequestInit) => Promise<deleteDataInstallationResponse>;
|
|
1130
|
+
declare const getDeleteDataInstallationMutationOptions: <TError = DeleteDataInstallation403 | DeleteDataInstallation404, TContext = unknown>(options?: {
|
|
1131
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteDataInstallation>>, TError, {
|
|
1132
|
+
installationId: string;
|
|
1133
|
+
}, TContext>;
|
|
1134
|
+
fetch?: RequestInit;
|
|
1135
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteDataInstallation>>, TError, {
|
|
1136
|
+
installationId: string;
|
|
1137
|
+
}, TContext>;
|
|
1138
|
+
type DeleteDataInstallationMutationResult = NonNullable<Awaited<ReturnType<typeof deleteDataInstallation>>>;
|
|
1139
|
+
type DeleteDataInstallationMutationError = DeleteDataInstallation403 | DeleteDataInstallation404;
|
|
1140
|
+
declare const useDeleteDataInstallation: <TError = DeleteDataInstallation403 | DeleteDataInstallation404, TContext = unknown>(options?: {
|
|
1141
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteDataInstallation>>, TError, {
|
|
1142
|
+
installationId: string;
|
|
1143
|
+
}, TContext>;
|
|
1144
|
+
fetch?: RequestInit;
|
|
1145
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteDataInstallation>>, TError, {
|
|
1146
|
+
installationId: string;
|
|
1147
|
+
}, TContext>;
|
|
1148
|
+
type myDataIntegrationsResponse200 = {
|
|
1149
|
+
data: DataIntegrationsResponse;
|
|
1150
|
+
status: 200;
|
|
1151
|
+
};
|
|
1152
|
+
type myDataIntegrationsResponse403 = {
|
|
1153
|
+
data: MyDataIntegrations403;
|
|
1154
|
+
status: 403;
|
|
1155
|
+
};
|
|
1156
|
+
type myDataIntegrationsResponseSuccess = myDataIntegrationsResponse200 & {
|
|
1157
|
+
headers: Headers;
|
|
1158
|
+
};
|
|
1159
|
+
type myDataIntegrationsResponseError = myDataIntegrationsResponse403 & {
|
|
1160
|
+
headers: Headers;
|
|
1161
|
+
};
|
|
1162
|
+
type myDataIntegrationsResponse = myDataIntegrationsResponseSuccess | myDataIntegrationsResponseError;
|
|
1163
|
+
declare const getMyDataIntegrationsUrl: () => string;
|
|
1164
|
+
declare const myDataIntegrations: (options?: RequestInit) => Promise<myDataIntegrationsResponse>;
|
|
1165
|
+
declare const getMyDataIntegrationsQueryKey: () => readonly ["https://api.workos.com/_widgets/DataIntegrations/mine"];
|
|
1166
|
+
declare const getMyDataIntegrationsQueryOptions: <TData = Awaited<ReturnType<typeof myDataIntegrations>>, TError = MyDataIntegrations403>(options?: {
|
|
1167
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof myDataIntegrations>>, TError, TData>>;
|
|
1168
|
+
fetch?: RequestInit;
|
|
1169
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof myDataIntegrations>>, TError, TData> & {
|
|
1151
1170
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1152
1171
|
};
|
|
1153
|
-
type
|
|
1154
|
-
type
|
|
1155
|
-
declare function
|
|
1156
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1172
|
+
type MyDataIntegrationsQueryResult = NonNullable<Awaited<ReturnType<typeof myDataIntegrations>>>;
|
|
1173
|
+
type MyDataIntegrationsQueryError = MyDataIntegrations403;
|
|
1174
|
+
declare function useMyDataIntegrations<TData = Awaited<ReturnType<typeof myDataIntegrations>>, TError = MyDataIntegrations403>(options: {
|
|
1175
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof myDataIntegrations>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof myDataIntegrations>>, TError, Awaited<ReturnType<typeof myDataIntegrations>>>, "initialData">;
|
|
1157
1176
|
fetch?: RequestInit;
|
|
1158
1177
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1159
1178
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1160
1179
|
};
|
|
1161
|
-
declare function
|
|
1162
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1180
|
+
declare function useMyDataIntegrations<TData = Awaited<ReturnType<typeof myDataIntegrations>>, TError = MyDataIntegrations403>(options?: {
|
|
1181
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof myDataIntegrations>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof myDataIntegrations>>, TError, Awaited<ReturnType<typeof myDataIntegrations>>>, "initialData">;
|
|
1163
1182
|
fetch?: RequestInit;
|
|
1164
1183
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1165
1184
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1166
1185
|
};
|
|
1167
|
-
declare function
|
|
1168
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1186
|
+
declare function useMyDataIntegrations<TData = Awaited<ReturnType<typeof myDataIntegrations>>, TError = MyDataIntegrations403>(options?: {
|
|
1187
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof myDataIntegrations>>, TError, TData>>;
|
|
1188
|
+
fetch?: RequestInit;
|
|
1189
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1190
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1191
|
+
};
|
|
1192
|
+
type getDataInstallationAuthorizationStatusResponse200 = {
|
|
1193
|
+
data: GetAuthorizationStatusResponse;
|
|
1194
|
+
status: 200;
|
|
1195
|
+
};
|
|
1196
|
+
type getDataInstallationAuthorizationStatusResponse400 = {
|
|
1197
|
+
data: GetDataInstallationAuthorizationStatus400;
|
|
1198
|
+
status: 400;
|
|
1199
|
+
};
|
|
1200
|
+
type getDataInstallationAuthorizationStatusResponse403 = {
|
|
1201
|
+
data: GetDataInstallationAuthorizationStatus403;
|
|
1202
|
+
status: 403;
|
|
1203
|
+
};
|
|
1204
|
+
type getDataInstallationAuthorizationStatusResponse404 = {
|
|
1205
|
+
data: GetDataInstallationAuthorizationStatus404;
|
|
1206
|
+
status: 404;
|
|
1207
|
+
};
|
|
1208
|
+
type getDataInstallationAuthorizationStatusResponseSuccess = getDataInstallationAuthorizationStatusResponse200 & {
|
|
1209
|
+
headers: Headers;
|
|
1210
|
+
};
|
|
1211
|
+
type getDataInstallationAuthorizationStatusResponseError = (getDataInstallationAuthorizationStatusResponse400 | getDataInstallationAuthorizationStatusResponse403 | getDataInstallationAuthorizationStatusResponse404) & {
|
|
1212
|
+
headers: Headers;
|
|
1213
|
+
};
|
|
1214
|
+
type getDataInstallationAuthorizationStatusResponse = getDataInstallationAuthorizationStatusResponseSuccess | getDataInstallationAuthorizationStatusResponseError;
|
|
1215
|
+
declare const getGetDataInstallationAuthorizationStatusUrl: (dataIntegrationId: string, state: string) => string;
|
|
1216
|
+
declare const getDataInstallationAuthorizationStatus: (dataIntegrationId: string, state: string, options?: RequestInit) => Promise<getDataInstallationAuthorizationStatusResponse>;
|
|
1217
|
+
declare const getGetDataInstallationAuthorizationStatusQueryKey: (dataIntegrationId: string, state: string) => readonly [`https://api.workos.com/_widgets/DataIntegrations/${string}/authorization-status/${string}`];
|
|
1218
|
+
declare const getGetDataInstallationAuthorizationStatusQueryOptions: <TData = Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError = GetDataInstallationAuthorizationStatus400 | GetDataInstallationAuthorizationStatus403 | GetDataInstallationAuthorizationStatus404>(dataIntegrationId: string, state: string, options?: {
|
|
1219
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError, TData>>;
|
|
1220
|
+
fetch?: RequestInit;
|
|
1221
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError, TData> & {
|
|
1222
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1223
|
+
};
|
|
1224
|
+
type GetDataInstallationAuthorizationStatusQueryResult = NonNullable<Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>>;
|
|
1225
|
+
type GetDataInstallationAuthorizationStatusQueryError = GetDataInstallationAuthorizationStatus400 | GetDataInstallationAuthorizationStatus403 | GetDataInstallationAuthorizationStatus404;
|
|
1226
|
+
declare function useGetDataInstallationAuthorizationStatus<TData = Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError = GetDataInstallationAuthorizationStatus400 | GetDataInstallationAuthorizationStatus403 | GetDataInstallationAuthorizationStatus404>(dataIntegrationId: string, state: string, options: {
|
|
1227
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError, Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>>, "initialData">;
|
|
1228
|
+
fetch?: RequestInit;
|
|
1229
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1230
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1231
|
+
};
|
|
1232
|
+
declare function useGetDataInstallationAuthorizationStatus<TData = Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError = GetDataInstallationAuthorizationStatus400 | GetDataInstallationAuthorizationStatus403 | GetDataInstallationAuthorizationStatus404>(dataIntegrationId: string, state: string, options?: {
|
|
1233
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError, Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>>, "initialData">;
|
|
1234
|
+
fetch?: RequestInit;
|
|
1235
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1236
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1237
|
+
};
|
|
1238
|
+
declare function useGetDataInstallationAuthorizationStatus<TData = Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError = GetDataInstallationAuthorizationStatus400 | GetDataInstallationAuthorizationStatus403 | GetDataInstallationAuthorizationStatus404>(dataIntegrationId: string, state: string, options?: {
|
|
1239
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDataInstallationAuthorizationStatus>>, TError, TData>>;
|
|
1240
|
+
fetch?: RequestInit;
|
|
1241
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1242
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1243
|
+
};
|
|
1244
|
+
type getDataIntegrationAuthorizeUrlResponse200 = {
|
|
1245
|
+
data: GetDataIntegrationAuthorizeUrlResponse;
|
|
1246
|
+
status: 200;
|
|
1247
|
+
};
|
|
1248
|
+
type getDataIntegrationAuthorizeUrlResponse400 = {
|
|
1249
|
+
data: GetDataIntegrationAuthorizeUrl400;
|
|
1250
|
+
status: 400;
|
|
1251
|
+
};
|
|
1252
|
+
type getDataIntegrationAuthorizeUrlResponse403 = {
|
|
1253
|
+
data: GetDataIntegrationAuthorizeUrl403;
|
|
1254
|
+
status: 403;
|
|
1255
|
+
};
|
|
1256
|
+
type getDataIntegrationAuthorizeUrlResponse404 = {
|
|
1257
|
+
data: GetDataIntegrationAuthorizeUrl404;
|
|
1258
|
+
status: 404;
|
|
1259
|
+
};
|
|
1260
|
+
type getDataIntegrationAuthorizeUrlResponseSuccess = getDataIntegrationAuthorizeUrlResponse200 & {
|
|
1261
|
+
headers: Headers;
|
|
1262
|
+
};
|
|
1263
|
+
type getDataIntegrationAuthorizeUrlResponseError = (getDataIntegrationAuthorizeUrlResponse400 | getDataIntegrationAuthorizeUrlResponse403 | getDataIntegrationAuthorizeUrlResponse404) & {
|
|
1264
|
+
headers: Headers;
|
|
1265
|
+
};
|
|
1266
|
+
type getDataIntegrationAuthorizeUrlResponse = getDataIntegrationAuthorizeUrlResponseSuccess | getDataIntegrationAuthorizeUrlResponseError;
|
|
1267
|
+
declare const getGetDataIntegrationAuthorizeUrlUrl: (slug: string, params?: GetDataIntegrationAuthorizeUrlParams) => string;
|
|
1268
|
+
declare const getDataIntegrationAuthorizeUrl: (slug: string, params?: GetDataIntegrationAuthorizeUrlParams, options?: RequestInit) => Promise<getDataIntegrationAuthorizeUrlResponse>;
|
|
1269
|
+
declare const getGetDataIntegrationAuthorizeUrlQueryKey: (slug: string, params?: GetDataIntegrationAuthorizeUrlParams) => readonly [`https://api.workos.com/_widgets/DataIntegrations/${string}/authorize`, ...GetDataIntegrationAuthorizeUrlParams[]];
|
|
1270
|
+
declare const getGetDataIntegrationAuthorizeUrlQueryOptions: <TData = Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError = GetDataIntegrationAuthorizeUrl400 | GetDataIntegrationAuthorizeUrl403 | GetDataIntegrationAuthorizeUrl404>(slug: string, params?: GetDataIntegrationAuthorizeUrlParams, options?: {
|
|
1271
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError, TData>>;
|
|
1272
|
+
fetch?: RequestInit;
|
|
1273
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError, TData> & {
|
|
1274
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1275
|
+
};
|
|
1276
|
+
type GetDataIntegrationAuthorizeUrlQueryResult = NonNullable<Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>>;
|
|
1277
|
+
type GetDataIntegrationAuthorizeUrlQueryError = GetDataIntegrationAuthorizeUrl400 | GetDataIntegrationAuthorizeUrl403 | GetDataIntegrationAuthorizeUrl404;
|
|
1278
|
+
declare function useGetDataIntegrationAuthorizeUrl<TData = Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError = GetDataIntegrationAuthorizeUrl400 | GetDataIntegrationAuthorizeUrl403 | GetDataIntegrationAuthorizeUrl404>(slug: string, params: undefined | GetDataIntegrationAuthorizeUrlParams, options: {
|
|
1279
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError, Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>>, "initialData">;
|
|
1280
|
+
fetch?: RequestInit;
|
|
1281
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1282
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1283
|
+
};
|
|
1284
|
+
declare function useGetDataIntegrationAuthorizeUrl<TData = Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError = GetDataIntegrationAuthorizeUrl400 | GetDataIntegrationAuthorizeUrl403 | GetDataIntegrationAuthorizeUrl404>(slug: string, params?: GetDataIntegrationAuthorizeUrlParams, options?: {
|
|
1285
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError, Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>>, "initialData">;
|
|
1286
|
+
fetch?: RequestInit;
|
|
1287
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1288
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1289
|
+
};
|
|
1290
|
+
declare function useGetDataIntegrationAuthorizeUrl<TData = Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError = GetDataIntegrationAuthorizeUrl400 | GetDataIntegrationAuthorizeUrl403 | GetDataIntegrationAuthorizeUrl404>(slug: string, params?: GetDataIntegrationAuthorizeUrlParams, options?: {
|
|
1291
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDataIntegrationAuthorizeUrl>>, TError, TData>>;
|
|
1169
1292
|
fetch?: RequestInit;
|
|
1170
1293
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1171
1294
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1172
1295
|
};
|
|
1296
|
+
/**
|
|
1297
|
+
* Sends an invitation email to a user to join the organization. If the user does not have an account, they will be prompted to create one upon accepting.
|
|
1298
|
+
*/
|
|
1173
1299
|
type inviteMemberResponse201 = {
|
|
1174
1300
|
data: InviteMember201;
|
|
1175
1301
|
status: 201;
|
|
@@ -1214,96 +1340,156 @@ declare const useInviteMember: <TError = InviteMember400 | InviteMember403 | Inv
|
|
|
1214
1340
|
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof inviteMember>>, TError, {
|
|
1215
1341
|
data: InviteMemberBody;
|
|
1216
1342
|
}, TContext>;
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1343
|
+
/**
|
|
1344
|
+
* Cancels a pending invitation for the specified user, preventing them from joining the organization via that invite link.
|
|
1345
|
+
*/
|
|
1346
|
+
type revokeInviteResponse200 = {
|
|
1347
|
+
data: RevokeInvite200;
|
|
1348
|
+
status: 200;
|
|
1220
1349
|
};
|
|
1221
|
-
type
|
|
1222
|
-
data:
|
|
1350
|
+
type revokeInviteResponse400 = {
|
|
1351
|
+
data: RevokeInvite400;
|
|
1223
1352
|
status: 400;
|
|
1224
1353
|
};
|
|
1225
|
-
type
|
|
1226
|
-
data:
|
|
1354
|
+
type revokeInviteResponse403 = {
|
|
1355
|
+
data: RevokeInvite403;
|
|
1227
1356
|
status: 403;
|
|
1228
1357
|
};
|
|
1229
|
-
type
|
|
1230
|
-
data:
|
|
1358
|
+
type revokeInviteResponse404 = {
|
|
1359
|
+
data: RevokeInvite404;
|
|
1231
1360
|
status: 404;
|
|
1232
1361
|
};
|
|
1233
|
-
type
|
|
1234
|
-
data: ResendInvite422;
|
|
1235
|
-
status: 422;
|
|
1236
|
-
};
|
|
1237
|
-
type resendInviteResponseSuccess = resendInviteResponse201 & {
|
|
1362
|
+
type revokeInviteResponseSuccess = revokeInviteResponse200 & {
|
|
1238
1363
|
headers: Headers;
|
|
1239
1364
|
};
|
|
1240
|
-
type
|
|
1365
|
+
type revokeInviteResponseError = (revokeInviteResponse400 | revokeInviteResponse403 | revokeInviteResponse404) & {
|
|
1241
1366
|
headers: Headers;
|
|
1242
1367
|
};
|
|
1243
|
-
type
|
|
1244
|
-
declare const
|
|
1245
|
-
declare const
|
|
1246
|
-
declare const
|
|
1247
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
1368
|
+
type revokeInviteResponse = revokeInviteResponseSuccess | revokeInviteResponseError;
|
|
1369
|
+
declare const getRevokeInviteUrl: (userId: string) => string;
|
|
1370
|
+
declare const revokeInvite: (userId: string, options?: RequestInit) => Promise<revokeInviteResponse>;
|
|
1371
|
+
declare const getRevokeInviteMutationOptions: <TError = RevokeInvite400 | RevokeInvite403 | RevokeInvite404, TContext = unknown>(options?: {
|
|
1372
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof revokeInvite>>, TError, {
|
|
1248
1373
|
userId: string;
|
|
1249
1374
|
}, TContext>;
|
|
1250
1375
|
fetch?: RequestInit;
|
|
1251
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
1376
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof revokeInvite>>, TError, {
|
|
1252
1377
|
userId: string;
|
|
1253
1378
|
}, TContext>;
|
|
1254
|
-
type
|
|
1255
|
-
type
|
|
1256
|
-
declare const
|
|
1257
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
1379
|
+
type RevokeInviteMutationResult = NonNullable<Awaited<ReturnType<typeof revokeInvite>>>;
|
|
1380
|
+
type RevokeInviteMutationError = RevokeInvite400 | RevokeInvite403 | RevokeInvite404;
|
|
1381
|
+
declare const useRevokeInvite: <TError = RevokeInvite400 | RevokeInvite403 | RevokeInvite404, TContext = unknown>(options?: {
|
|
1382
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof revokeInvite>>, TError, {
|
|
1258
1383
|
userId: string;
|
|
1259
1384
|
}, TContext>;
|
|
1260
1385
|
fetch?: RequestInit;
|
|
1261
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
1386
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof revokeInvite>>, TError, {
|
|
1262
1387
|
userId: string;
|
|
1263
1388
|
}, TContext>;
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
|
|
1389
|
+
/**
|
|
1390
|
+
* Resends the pending invitation email to the specified user. Returns an error if the invitation has already been accepted or has expired.
|
|
1391
|
+
*/
|
|
1392
|
+
type resendInviteResponse201 = {
|
|
1393
|
+
data: ResendInvite201;
|
|
1394
|
+
status: 201;
|
|
1267
1395
|
};
|
|
1268
|
-
type
|
|
1269
|
-
data:
|
|
1396
|
+
type resendInviteResponse400 = {
|
|
1397
|
+
data: ResendInvite400;
|
|
1270
1398
|
status: 400;
|
|
1271
1399
|
};
|
|
1272
|
-
type
|
|
1273
|
-
data:
|
|
1400
|
+
type resendInviteResponse403 = {
|
|
1401
|
+
data: ResendInvite403;
|
|
1274
1402
|
status: 403;
|
|
1275
1403
|
};
|
|
1276
|
-
type
|
|
1277
|
-
data:
|
|
1404
|
+
type resendInviteResponse404 = {
|
|
1405
|
+
data: ResendInvite404;
|
|
1278
1406
|
status: 404;
|
|
1279
1407
|
};
|
|
1280
|
-
type
|
|
1408
|
+
type resendInviteResponse422 = {
|
|
1409
|
+
data: ResendInvite422;
|
|
1410
|
+
status: 422;
|
|
1411
|
+
};
|
|
1412
|
+
type resendInviteResponseSuccess = resendInviteResponse201 & {
|
|
1281
1413
|
headers: Headers;
|
|
1282
1414
|
};
|
|
1283
|
-
type
|
|
1415
|
+
type resendInviteResponseError = (resendInviteResponse400 | resendInviteResponse403 | resendInviteResponse404 | resendInviteResponse422) & {
|
|
1284
1416
|
headers: Headers;
|
|
1285
1417
|
};
|
|
1286
|
-
type
|
|
1287
|
-
declare const
|
|
1288
|
-
declare const
|
|
1289
|
-
declare const
|
|
1290
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
1418
|
+
type resendInviteResponse = resendInviteResponseSuccess | resendInviteResponseError;
|
|
1419
|
+
declare const getResendInviteUrl: (userId: string) => string;
|
|
1420
|
+
declare const resendInvite: (userId: string, options?: RequestInit) => Promise<resendInviteResponse>;
|
|
1421
|
+
declare const getResendInviteMutationOptions: <TError = ResendInvite400 | ResendInvite403 | ResendInvite404 | ResendInvite422, TContext = unknown>(options?: {
|
|
1422
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof resendInvite>>, TError, {
|
|
1291
1423
|
userId: string;
|
|
1292
1424
|
}, TContext>;
|
|
1293
1425
|
fetch?: RequestInit;
|
|
1294
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
1426
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof resendInvite>>, TError, {
|
|
1295
1427
|
userId: string;
|
|
1296
1428
|
}, TContext>;
|
|
1297
|
-
type
|
|
1298
|
-
type
|
|
1299
|
-
declare const
|
|
1300
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
1429
|
+
type ResendInviteMutationResult = NonNullable<Awaited<ReturnType<typeof resendInvite>>>;
|
|
1430
|
+
type ResendInviteMutationError = ResendInvite400 | ResendInvite403 | ResendInvite404 | ResendInvite422;
|
|
1431
|
+
declare const useResendInvite: <TError = ResendInvite400 | ResendInvite403 | ResendInvite404 | ResendInvite422, TContext = unknown>(options?: {
|
|
1432
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof resendInvite>>, TError, {
|
|
1301
1433
|
userId: string;
|
|
1302
1434
|
}, TContext>;
|
|
1303
1435
|
fetch?: RequestInit;
|
|
1304
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
1436
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof resendInvite>>, TError, {
|
|
1305
1437
|
userId: string;
|
|
1306
1438
|
}, TContext>;
|
|
1439
|
+
/**
|
|
1440
|
+
* Returns a paginated list of members belonging to the organization. Supports filtering by search term and role, and cursor-based pagination via before/after parameters.
|
|
1441
|
+
*/
|
|
1442
|
+
type membersResponse200 = {
|
|
1443
|
+
data: Members200;
|
|
1444
|
+
status: 200;
|
|
1445
|
+
};
|
|
1446
|
+
type membersResponse403 = {
|
|
1447
|
+
data: Members403;
|
|
1448
|
+
status: 403;
|
|
1449
|
+
};
|
|
1450
|
+
type membersResponse404 = {
|
|
1451
|
+
data: Members404;
|
|
1452
|
+
status: 404;
|
|
1453
|
+
};
|
|
1454
|
+
type membersResponseSuccess = membersResponse200 & {
|
|
1455
|
+
headers: Headers;
|
|
1456
|
+
};
|
|
1457
|
+
type membersResponseError = (membersResponse403 | membersResponse404) & {
|
|
1458
|
+
headers: Headers;
|
|
1459
|
+
};
|
|
1460
|
+
type membersResponse = membersResponseSuccess | membersResponseError;
|
|
1461
|
+
declare const getMembersUrl: (params?: MembersParams) => string;
|
|
1462
|
+
declare const members: (params?: MembersParams, options?: RequestInit) => Promise<membersResponse>;
|
|
1463
|
+
declare const getMembersQueryKey: (params?: MembersParams) => readonly ["https://api.workos.com/_widgets/UserManagement/members", ...MembersParams[]];
|
|
1464
|
+
declare const getMembersQueryOptions: <TData = Awaited<ReturnType<typeof members>>, TError = Members403 | Members404>(params?: MembersParams, options?: {
|
|
1465
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof members>>, TError, TData>>;
|
|
1466
|
+
fetch?: RequestInit;
|
|
1467
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof members>>, TError, TData> & {
|
|
1468
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1469
|
+
};
|
|
1470
|
+
type MembersQueryResult = NonNullable<Awaited<ReturnType<typeof members>>>;
|
|
1471
|
+
type MembersQueryError = Members403 | Members404;
|
|
1472
|
+
declare function useMembers<TData = Awaited<ReturnType<typeof members>>, TError = Members403 | Members404>(params: undefined | MembersParams, options: {
|
|
1473
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof members>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof members>>, TError, Awaited<ReturnType<typeof members>>>, "initialData">;
|
|
1474
|
+
fetch?: RequestInit;
|
|
1475
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1476
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1477
|
+
};
|
|
1478
|
+
declare function useMembers<TData = Awaited<ReturnType<typeof members>>, TError = Members403 | Members404>(params?: MembersParams, options?: {
|
|
1479
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof members>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof members>>, TError, Awaited<ReturnType<typeof members>>>, "initialData">;
|
|
1480
|
+
fetch?: RequestInit;
|
|
1481
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1482
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1483
|
+
};
|
|
1484
|
+
declare function useMembers<TData = Awaited<ReturnType<typeof members>>, TError = Members403 | Members404>(params?: MembersParams, options?: {
|
|
1485
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof members>>, TError, TData>>;
|
|
1486
|
+
fetch?: RequestInit;
|
|
1487
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1488
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1489
|
+
};
|
|
1490
|
+
/**
|
|
1491
|
+
* Removes the specified user from the organization by revoking their membership. The user account itself is not deleted.
|
|
1492
|
+
*/
|
|
1307
1493
|
type removeMemberResponse200 = {
|
|
1308
1494
|
data: RemoveMember200;
|
|
1309
1495
|
status: 200;
|
|
@@ -1347,6 +1533,9 @@ declare const useRemoveMember: <TError = RemoveMember400 | RemoveMember403 | Rem
|
|
|
1347
1533
|
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof removeMember>>, TError, {
|
|
1348
1534
|
userId: string;
|
|
1349
1535
|
}, TContext>;
|
|
1536
|
+
/**
|
|
1537
|
+
* Updates the specified member's organization membership, such as changing their assigned role.
|
|
1538
|
+
*/
|
|
1350
1539
|
type updateMemberResponse200 = {
|
|
1351
1540
|
data: UpdateMember200;
|
|
1352
1541
|
status: 200;
|
|
@@ -1399,6 +1588,9 @@ declare const useUpdateMember: <TError = UpdateMember400 | UpdateMember403 | Upd
|
|
|
1399
1588
|
userId: string;
|
|
1400
1589
|
data: UpdateMemberBody;
|
|
1401
1590
|
}, TContext>;
|
|
1591
|
+
/**
|
|
1592
|
+
* Returns the list of organizations the authenticated user is a member of.
|
|
1593
|
+
*/
|
|
1402
1594
|
type organizationsResponse200 = {
|
|
1403
1595
|
data: OrganizationsResponse;
|
|
1404
1596
|
status: 200;
|
|
@@ -1447,195 +1639,114 @@ declare function useOrganizations<TData = Awaited<ReturnType<typeof organization
|
|
|
1447
1639
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1448
1640
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1449
1641
|
};
|
|
1450
|
-
|
|
1451
|
-
|
|
1642
|
+
/**
|
|
1643
|
+
* Returns the list of roles available in the organization that can be assigned to members.
|
|
1644
|
+
*/
|
|
1645
|
+
type rolesResponse200 = {
|
|
1646
|
+
data: MemberRole[];
|
|
1452
1647
|
status: 200;
|
|
1453
1648
|
};
|
|
1454
|
-
type
|
|
1455
|
-
data:
|
|
1649
|
+
type rolesResponse403 = {
|
|
1650
|
+
data: Roles403;
|
|
1456
1651
|
status: 403;
|
|
1457
1652
|
};
|
|
1458
|
-
type
|
|
1653
|
+
type rolesResponse404 = {
|
|
1654
|
+
data: Roles404;
|
|
1655
|
+
status: 404;
|
|
1656
|
+
};
|
|
1657
|
+
type rolesResponseSuccess = rolesResponse200 & {
|
|
1459
1658
|
headers: Headers;
|
|
1460
1659
|
};
|
|
1461
|
-
type
|
|
1660
|
+
type rolesResponseError = (rolesResponse403 | rolesResponse404) & {
|
|
1462
1661
|
headers: Headers;
|
|
1463
1662
|
};
|
|
1464
|
-
type
|
|
1465
|
-
declare const
|
|
1466
|
-
declare const
|
|
1467
|
-
declare const
|
|
1468
|
-
declare const
|
|
1469
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1663
|
+
type rolesResponse = rolesResponseSuccess | rolesResponseError;
|
|
1664
|
+
declare const getRolesUrl: () => string;
|
|
1665
|
+
declare const roles: (options?: RequestInit) => Promise<rolesResponse>;
|
|
1666
|
+
declare const getRolesQueryKey: () => readonly ["https://api.workos.com/_widgets/UserManagement/roles"];
|
|
1667
|
+
declare const getRolesQueryOptions: <TData = Awaited<ReturnType<typeof roles>>, TError = Roles403 | Roles404>(options?: {
|
|
1668
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof roles>>, TError, TData>>;
|
|
1470
1669
|
fetch?: RequestInit;
|
|
1471
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof
|
|
1670
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof roles>>, TError, TData> & {
|
|
1472
1671
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1473
1672
|
};
|
|
1474
|
-
type
|
|
1475
|
-
type
|
|
1476
|
-
declare function
|
|
1477
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1673
|
+
type RolesQueryResult = NonNullable<Awaited<ReturnType<typeof roles>>>;
|
|
1674
|
+
type RolesQueryError = Roles403 | Roles404;
|
|
1675
|
+
declare function useRoles<TData = Awaited<ReturnType<typeof roles>>, TError = Roles403 | Roles404>(options: {
|
|
1676
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof roles>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof roles>>, TError, Awaited<ReturnType<typeof roles>>>, "initialData">;
|
|
1478
1677
|
fetch?: RequestInit;
|
|
1479
1678
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1480
1679
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1481
1680
|
};
|
|
1482
|
-
declare function
|
|
1483
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1681
|
+
declare function useRoles<TData = Awaited<ReturnType<typeof roles>>, TError = Roles403 | Roles404>(options?: {
|
|
1682
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof roles>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof roles>>, TError, Awaited<ReturnType<typeof roles>>>, "initialData">;
|
|
1484
1683
|
fetch?: RequestInit;
|
|
1485
1684
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1486
1685
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1487
1686
|
};
|
|
1488
|
-
declare function
|
|
1489
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
1687
|
+
declare function useRoles<TData = Awaited<ReturnType<typeof roles>>, TError = Roles403 | Roles404>(options?: {
|
|
1688
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof roles>>, TError, TData>>;
|
|
1490
1689
|
fetch?: RequestInit;
|
|
1491
1690
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1492
1691
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1493
1692
|
};
|
|
1494
|
-
|
|
1495
|
-
|
|
1693
|
+
/**
|
|
1694
|
+
* Returns the list of roles available in the organization along with the user management configuration, such as whether role assignment is enabled.
|
|
1695
|
+
*/
|
|
1696
|
+
type rolesAndConfigResponse200 = {
|
|
1697
|
+
data: RolesAndConfigResponse;
|
|
1496
1698
|
status: 200;
|
|
1497
1699
|
};
|
|
1498
|
-
type
|
|
1499
|
-
data:
|
|
1500
|
-
status: 400;
|
|
1501
|
-
};
|
|
1502
|
-
type updateMeResponse403 = {
|
|
1503
|
-
data: UpdateMe403;
|
|
1700
|
+
type rolesAndConfigResponse403 = {
|
|
1701
|
+
data: RolesAndConfig403;
|
|
1504
1702
|
status: 403;
|
|
1505
1703
|
};
|
|
1506
|
-
type
|
|
1704
|
+
type rolesAndConfigResponse404 = {
|
|
1705
|
+
data: RolesAndConfig404;
|
|
1706
|
+
status: 404;
|
|
1707
|
+
};
|
|
1708
|
+
type rolesAndConfigResponseSuccess = rolesAndConfigResponse200 & {
|
|
1507
1709
|
headers: Headers;
|
|
1508
1710
|
};
|
|
1509
|
-
type
|
|
1711
|
+
type rolesAndConfigResponseError = (rolesAndConfigResponse403 | rolesAndConfigResponse404) & {
|
|
1510
1712
|
headers: Headers;
|
|
1511
1713
|
};
|
|
1512
|
-
type
|
|
1513
|
-
declare const
|
|
1514
|
-
declare const
|
|
1515
|
-
declare const
|
|
1516
|
-
|
|
1517
|
-
|
|
1518
|
-
}, TContext>;
|
|
1714
|
+
type rolesAndConfigResponse = rolesAndConfigResponseSuccess | rolesAndConfigResponseError;
|
|
1715
|
+
declare const getRolesAndConfigUrl: () => string;
|
|
1716
|
+
declare const rolesAndConfig: (options?: RequestInit) => Promise<rolesAndConfigResponse>;
|
|
1717
|
+
declare const getRolesAndConfigQueryKey: () => readonly ["https://api.workos.com/_widgets/UserManagement/roles-and-config"];
|
|
1718
|
+
declare const getRolesAndConfigQueryOptions: <TData = Awaited<ReturnType<typeof rolesAndConfig>>, TError = RolesAndConfig403 | RolesAndConfig404>(options?: {
|
|
1719
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof rolesAndConfig>>, TError, TData>>;
|
|
1519
1720
|
fetch?: RequestInit;
|
|
1520
|
-
}) =>
|
|
1521
|
-
|
|
1522
|
-
}
|
|
1523
|
-
type
|
|
1524
|
-
type
|
|
1525
|
-
|
|
1526
|
-
|
|
1527
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateMe>>, TError, {
|
|
1528
|
-
data: UpdateMeBody;
|
|
1529
|
-
}, TContext>;
|
|
1721
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof rolesAndConfig>>, TError, TData> & {
|
|
1722
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1723
|
+
};
|
|
1724
|
+
type RolesAndConfigQueryResult = NonNullable<Awaited<ReturnType<typeof rolesAndConfig>>>;
|
|
1725
|
+
type RolesAndConfigQueryError = RolesAndConfig403 | RolesAndConfig404;
|
|
1726
|
+
declare function useRolesAndConfig<TData = Awaited<ReturnType<typeof rolesAndConfig>>, TError = RolesAndConfig403 | RolesAndConfig404>(options: {
|
|
1727
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof rolesAndConfig>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof rolesAndConfig>>, TError, Awaited<ReturnType<typeof rolesAndConfig>>>, "initialData">;
|
|
1530
1728
|
fetch?: RequestInit;
|
|
1531
|
-
}, queryClient?: QueryClient)
|
|
1532
|
-
|
|
1533
|
-
}, TContext>;
|
|
1534
|
-
type createTotpFactorResponse201 = {
|
|
1535
|
-
data: CreateTotpFactorResponse;
|
|
1536
|
-
status: 201;
|
|
1729
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1730
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1537
1731
|
};
|
|
1538
|
-
|
|
1539
|
-
|
|
1540
|
-
|
|
1732
|
+
declare function useRolesAndConfig<TData = Awaited<ReturnType<typeof rolesAndConfig>>, TError = RolesAndConfig403 | RolesAndConfig404>(options?: {
|
|
1733
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof rolesAndConfig>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof rolesAndConfig>>, TError, Awaited<ReturnType<typeof rolesAndConfig>>>, "initialData">;
|
|
1734
|
+
fetch?: RequestInit;
|
|
1735
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1736
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1541
1737
|
};
|
|
1542
|
-
|
|
1543
|
-
|
|
1544
|
-
|
|
1738
|
+
declare function useRolesAndConfig<TData = Awaited<ReturnType<typeof rolesAndConfig>>, TError = RolesAndConfig403 | RolesAndConfig404>(options?: {
|
|
1739
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof rolesAndConfig>>, TError, TData>>;
|
|
1740
|
+
fetch?: RequestInit;
|
|
1741
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1742
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1545
1743
|
};
|
|
1546
|
-
|
|
1547
|
-
|
|
1548
|
-
|
|
1549
|
-
type
|
|
1550
|
-
|
|
1551
|
-
|
|
1552
|
-
type createTotpFactorResponse = createTotpFactorResponseSuccess | createTotpFactorResponseError;
|
|
1553
|
-
declare const getCreateTotpFactorUrl: () => string;
|
|
1554
|
-
declare const createTotpFactor: (options?: RequestInit) => Promise<createTotpFactorResponse>;
|
|
1555
|
-
declare const getCreateTotpFactorMutationOptions: <TError = CreateTotpFactor400 | CreateTotpFactor403, TContext = unknown>(options?: {
|
|
1556
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createTotpFactor>>, TError, void, TContext>;
|
|
1557
|
-
fetch?: RequestInit;
|
|
1558
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof createTotpFactor>>, TError, void, TContext>;
|
|
1559
|
-
type CreateTotpFactorMutationResult = NonNullable<Awaited<ReturnType<typeof createTotpFactor>>>;
|
|
1560
|
-
type CreateTotpFactorMutationError = CreateTotpFactor400 | CreateTotpFactor403;
|
|
1561
|
-
declare const useCreateTotpFactor: <TError = CreateTotpFactor400 | CreateTotpFactor403, TContext = unknown>(options?: {
|
|
1562
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createTotpFactor>>, TError, void, TContext>;
|
|
1563
|
-
fetch?: RequestInit;
|
|
1564
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createTotpFactor>>, TError, void, TContext>;
|
|
1565
|
-
type verifyTotpFactorResponse200 = {
|
|
1566
|
-
data: VerifyTotpFactor200;
|
|
1567
|
-
status: 200;
|
|
1568
|
-
};
|
|
1569
|
-
type verifyTotpFactorResponse400 = {
|
|
1570
|
-
data: VerifyTotpFactor400;
|
|
1571
|
-
status: 400;
|
|
1572
|
-
};
|
|
1573
|
-
type verifyTotpFactorResponse403 = {
|
|
1574
|
-
data: VerifyTotpFactor403;
|
|
1575
|
-
status: 403;
|
|
1576
|
-
};
|
|
1577
|
-
type verifyTotpFactorResponseSuccess = verifyTotpFactorResponse200 & {
|
|
1578
|
-
headers: Headers;
|
|
1579
|
-
};
|
|
1580
|
-
type verifyTotpFactorResponseError = (verifyTotpFactorResponse400 | verifyTotpFactorResponse403) & {
|
|
1581
|
-
headers: Headers;
|
|
1582
|
-
};
|
|
1583
|
-
type verifyTotpFactorResponse = verifyTotpFactorResponseSuccess | verifyTotpFactorResponseError;
|
|
1584
|
-
declare const getVerifyTotpFactorUrl: () => string;
|
|
1585
|
-
declare const verifyTotpFactor: (verifyTotpFactorRequest: VerifyTotpFactorRequest, options?: RequestInit) => Promise<verifyTotpFactorResponse>;
|
|
1586
|
-
declare const getVerifyTotpFactorMutationOptions: <TError = VerifyTotpFactor400 | VerifyTotpFactor403, TContext = unknown>(options?: {
|
|
1587
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof verifyTotpFactor>>, TError, {
|
|
1588
|
-
data: VerifyTotpFactorRequest;
|
|
1589
|
-
}, TContext>;
|
|
1590
|
-
fetch?: RequestInit;
|
|
1591
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof verifyTotpFactor>>, TError, {
|
|
1592
|
-
data: VerifyTotpFactorRequest;
|
|
1593
|
-
}, TContext>;
|
|
1594
|
-
type VerifyTotpFactorMutationResult = NonNullable<Awaited<ReturnType<typeof verifyTotpFactor>>>;
|
|
1595
|
-
type VerifyTotpFactorMutationBody = VerifyTotpFactorRequest;
|
|
1596
|
-
type VerifyTotpFactorMutationError = VerifyTotpFactor400 | VerifyTotpFactor403;
|
|
1597
|
-
declare const useVerifyTotpFactor: <TError = VerifyTotpFactor400 | VerifyTotpFactor403, TContext = unknown>(options?: {
|
|
1598
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof verifyTotpFactor>>, TError, {
|
|
1599
|
-
data: VerifyTotpFactorRequest;
|
|
1600
|
-
}, TContext>;
|
|
1601
|
-
fetch?: RequestInit;
|
|
1602
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof verifyTotpFactor>>, TError, {
|
|
1603
|
-
data: VerifyTotpFactorRequest;
|
|
1604
|
-
}, TContext>;
|
|
1605
|
-
type deleteTotpFactorsResponse200 = {
|
|
1606
|
-
data: DeleteTotpFactors200;
|
|
1607
|
-
status: 200;
|
|
1608
|
-
};
|
|
1609
|
-
type deleteTotpFactorsResponse400 = {
|
|
1610
|
-
data: DeleteTotpFactors400;
|
|
1611
|
-
status: 400;
|
|
1612
|
-
};
|
|
1613
|
-
type deleteTotpFactorsResponse403 = {
|
|
1614
|
-
data: DeleteTotpFactors403;
|
|
1615
|
-
status: 403;
|
|
1616
|
-
};
|
|
1617
|
-
type deleteTotpFactorsResponseSuccess = deleteTotpFactorsResponse200 & {
|
|
1618
|
-
headers: Headers;
|
|
1619
|
-
};
|
|
1620
|
-
type deleteTotpFactorsResponseError = (deleteTotpFactorsResponse400 | deleteTotpFactorsResponse403) & {
|
|
1621
|
-
headers: Headers;
|
|
1622
|
-
};
|
|
1623
|
-
type deleteTotpFactorsResponse = deleteTotpFactorsResponseSuccess | deleteTotpFactorsResponseError;
|
|
1624
|
-
declare const getDeleteTotpFactorsUrl: () => string;
|
|
1625
|
-
declare const deleteTotpFactors: (options?: RequestInit) => Promise<deleteTotpFactorsResponse>;
|
|
1626
|
-
declare const getDeleteTotpFactorsMutationOptions: <TError = DeleteTotpFactors400 | DeleteTotpFactors403, TContext = unknown>(options?: {
|
|
1627
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteTotpFactors>>, TError, void, TContext>;
|
|
1628
|
-
fetch?: RequestInit;
|
|
1629
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteTotpFactors>>, TError, void, TContext>;
|
|
1630
|
-
type DeleteTotpFactorsMutationResult = NonNullable<Awaited<ReturnType<typeof deleteTotpFactors>>>;
|
|
1631
|
-
type DeleteTotpFactorsMutationError = DeleteTotpFactors400 | DeleteTotpFactors403;
|
|
1632
|
-
declare const useDeleteTotpFactors: <TError = DeleteTotpFactors400 | DeleteTotpFactors403, TContext = unknown>(options?: {
|
|
1633
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteTotpFactors>>, TError, void, TContext>;
|
|
1634
|
-
fetch?: RequestInit;
|
|
1635
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteTotpFactors>>, TError, void, TContext>;
|
|
1636
|
-
type authenticationInformationResponse200 = {
|
|
1637
|
-
data: AuthenticationInformationResponse;
|
|
1638
|
-
status: 200;
|
|
1744
|
+
/**
|
|
1745
|
+
* Returns the authentication methods and MFA factors configured for the authenticated user, including enrolled TOTP factors and passkeys.
|
|
1746
|
+
*/
|
|
1747
|
+
type authenticationInformationResponse200 = {
|
|
1748
|
+
data: AuthenticationInformationResponse;
|
|
1749
|
+
status: 200;
|
|
1639
1750
|
};
|
|
1640
1751
|
type authenticationInformationResponse403 = {
|
|
1641
1752
|
data: AuthenticationInformation403;
|
|
@@ -1677,6 +1788,9 @@ declare function useAuthenticationInformation<TData = Awaited<ReturnType<typeof
|
|
|
1677
1788
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1678
1789
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1679
1790
|
};
|
|
1791
|
+
/**
|
|
1792
|
+
* Sets a password for the authenticated user. Only available when the user does not already have a password configured. Requires elevated access.
|
|
1793
|
+
*/
|
|
1680
1794
|
type createPasswordResponse201 = {
|
|
1681
1795
|
data: CreatePassword201;
|
|
1682
1796
|
status: 201;
|
|
@@ -1717,240 +1831,133 @@ declare const useCreatePassword: <TError = CreatePassword400 | CreatePassword403
|
|
|
1717
1831
|
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createPassword>>, TError, {
|
|
1718
1832
|
data: CreatePasswordRequest;
|
|
1719
1833
|
}, TContext>;
|
|
1720
|
-
|
|
1721
|
-
|
|
1834
|
+
/**
|
|
1835
|
+
* Initiates TOTP (authenticator app) enrollment for the authenticated user by generating a new TOTP secret and QR code. Requires elevated access.
|
|
1836
|
+
*/
|
|
1837
|
+
type createTotpFactorResponse201 = {
|
|
1838
|
+
data: CreateTotpFactorResponse;
|
|
1722
1839
|
status: 201;
|
|
1723
1840
|
};
|
|
1724
|
-
type
|
|
1725
|
-
data:
|
|
1841
|
+
type createTotpFactorResponse400 = {
|
|
1842
|
+
data: CreateTotpFactor400;
|
|
1726
1843
|
status: 400;
|
|
1727
1844
|
};
|
|
1728
|
-
type
|
|
1729
|
-
data:
|
|
1845
|
+
type createTotpFactorResponse403 = {
|
|
1846
|
+
data: CreateTotpFactor403;
|
|
1730
1847
|
status: 403;
|
|
1731
1848
|
};
|
|
1732
|
-
type
|
|
1849
|
+
type createTotpFactorResponseSuccess = createTotpFactorResponse201 & {
|
|
1733
1850
|
headers: Headers;
|
|
1734
1851
|
};
|
|
1735
|
-
type
|
|
1852
|
+
type createTotpFactorResponseError = (createTotpFactorResponse400 | createTotpFactorResponse403) & {
|
|
1736
1853
|
headers: Headers;
|
|
1737
1854
|
};
|
|
1738
|
-
type
|
|
1739
|
-
declare const
|
|
1740
|
-
declare const
|
|
1741
|
-
declare const
|
|
1742
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
1743
|
-
data: UpdatePasswordRequest;
|
|
1744
|
-
}, TContext>;
|
|
1855
|
+
type createTotpFactorResponse = createTotpFactorResponseSuccess | createTotpFactorResponseError;
|
|
1856
|
+
declare const getCreateTotpFactorUrl: () => string;
|
|
1857
|
+
declare const createTotpFactor: (options?: RequestInit) => Promise<createTotpFactorResponse>;
|
|
1858
|
+
declare const getCreateTotpFactorMutationOptions: <TError = CreateTotpFactor400 | CreateTotpFactor403, TContext = unknown>(options?: {
|
|
1859
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createTotpFactor>>, TError, void, TContext>;
|
|
1745
1860
|
fetch?: RequestInit;
|
|
1746
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
1747
|
-
|
|
1748
|
-
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
type UpdatePasswordMutationError = UpdatePassword400 | UpdatePassword403;
|
|
1752
|
-
declare const useUpdatePassword: <TError = UpdatePassword400 | UpdatePassword403, TContext = unknown>(options?: {
|
|
1753
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof updatePassword>>, TError, {
|
|
1754
|
-
data: UpdatePasswordRequest;
|
|
1755
|
-
}, TContext>;
|
|
1861
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof createTotpFactor>>, TError, void, TContext>;
|
|
1862
|
+
type CreateTotpFactorMutationResult = NonNullable<Awaited<ReturnType<typeof createTotpFactor>>>;
|
|
1863
|
+
type CreateTotpFactorMutationError = CreateTotpFactor400 | CreateTotpFactor403;
|
|
1864
|
+
declare const useCreateTotpFactor: <TError = CreateTotpFactor400 | CreateTotpFactor403, TContext = unknown>(options?: {
|
|
1865
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof createTotpFactor>>, TError, void, TContext>;
|
|
1756
1866
|
fetch?: RequestInit;
|
|
1757
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
1758
|
-
|
|
1759
|
-
|
|
1760
|
-
|
|
1761
|
-
|
|
1867
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof createTotpFactor>>, TError, void, TContext>;
|
|
1868
|
+
/**
|
|
1869
|
+
* Returns the profile information of the currently authenticated user, including their name, email, and linked authentication factors.
|
|
1870
|
+
*/
|
|
1871
|
+
type meResponse200 = {
|
|
1872
|
+
data: Me;
|
|
1762
1873
|
status: 200;
|
|
1763
1874
|
};
|
|
1764
|
-
type
|
|
1765
|
-
data:
|
|
1766
|
-
status: 400;
|
|
1767
|
-
};
|
|
1768
|
-
type revokeAllSessionsResponse403 = {
|
|
1769
|
-
data: RevokeAllSessions403;
|
|
1875
|
+
type meResponse403 = {
|
|
1876
|
+
data: Me403;
|
|
1770
1877
|
status: 403;
|
|
1771
1878
|
};
|
|
1772
|
-
type
|
|
1879
|
+
type meResponseSuccess = meResponse200 & {
|
|
1773
1880
|
headers: Headers;
|
|
1774
1881
|
};
|
|
1775
|
-
type
|
|
1882
|
+
type meResponseError = meResponse403 & {
|
|
1776
1883
|
headers: Headers;
|
|
1777
1884
|
};
|
|
1778
|
-
type
|
|
1779
|
-
declare const
|
|
1780
|
-
declare const
|
|
1781
|
-
declare const
|
|
1782
|
-
|
|
1783
|
-
|
|
1784
|
-
}, TContext>;
|
|
1885
|
+
type meResponse = meResponseSuccess | meResponseError;
|
|
1886
|
+
declare const getMeUrl: () => string;
|
|
1887
|
+
declare const me: (options?: RequestInit) => Promise<meResponse>;
|
|
1888
|
+
declare const getMeQueryKey: () => readonly ["https://api.workos.com/_widgets/UserProfile/me"];
|
|
1889
|
+
declare const getMeQueryOptions: <TData = Awaited<ReturnType<typeof me>>, TError = Me403>(options?: {
|
|
1890
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof me>>, TError, TData>>;
|
|
1785
1891
|
fetch?: RequestInit;
|
|
1786
|
-
}) =>
|
|
1787
|
-
|
|
1788
|
-
}
|
|
1789
|
-
type
|
|
1790
|
-
type
|
|
1791
|
-
|
|
1792
|
-
|
|
1793
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof revokeAllSessions>>, TError, {
|
|
1794
|
-
data: RevokeAllSessionsRequest;
|
|
1795
|
-
}, TContext>;
|
|
1892
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof me>>, TError, TData> & {
|
|
1893
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1894
|
+
};
|
|
1895
|
+
type MeQueryResult = NonNullable<Awaited<ReturnType<typeof me>>>;
|
|
1896
|
+
type MeQueryError = Me403;
|
|
1897
|
+
declare function useMe<TData = Awaited<ReturnType<typeof me>>, TError = Me403>(options: {
|
|
1898
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof me>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof me>>, TError, Awaited<ReturnType<typeof me>>>, "initialData">;
|
|
1796
1899
|
fetch?: RequestInit;
|
|
1797
|
-
}, queryClient?: QueryClient)
|
|
1798
|
-
|
|
1799
|
-
}
|
|
1800
|
-
|
|
1801
|
-
|
|
1900
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1901
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1902
|
+
};
|
|
1903
|
+
declare function useMe<TData = Awaited<ReturnType<typeof me>>, TError = Me403>(options?: {
|
|
1904
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof me>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof me>>, TError, Awaited<ReturnType<typeof me>>>, "initialData">;
|
|
1905
|
+
fetch?: RequestInit;
|
|
1906
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1907
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1908
|
+
};
|
|
1909
|
+
declare function useMe<TData = Awaited<ReturnType<typeof me>>, TError = Me403>(options?: {
|
|
1910
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof me>>, TError, TData>>;
|
|
1911
|
+
fetch?: RequestInit;
|
|
1912
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1913
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1914
|
+
};
|
|
1915
|
+
/**
|
|
1916
|
+
* Updates the profile information of the currently authenticated user, such as their first name, last name, or email address.
|
|
1917
|
+
*/
|
|
1918
|
+
type updateMeResponse200 = {
|
|
1919
|
+
data: Me;
|
|
1802
1920
|
status: 200;
|
|
1803
1921
|
};
|
|
1804
|
-
type
|
|
1805
|
-
data:
|
|
1922
|
+
type updateMeResponse400 = {
|
|
1923
|
+
data: UpdateMe400;
|
|
1806
1924
|
status: 400;
|
|
1807
1925
|
};
|
|
1808
|
-
type
|
|
1809
|
-
data:
|
|
1926
|
+
type updateMeResponse403 = {
|
|
1927
|
+
data: UpdateMe403;
|
|
1810
1928
|
status: 403;
|
|
1811
1929
|
};
|
|
1812
|
-
type
|
|
1930
|
+
type updateMeResponseSuccess = updateMeResponse200 & {
|
|
1813
1931
|
headers: Headers;
|
|
1814
1932
|
};
|
|
1815
|
-
type
|
|
1933
|
+
type updateMeResponseError = (updateMeResponse400 | updateMeResponse403) & {
|
|
1816
1934
|
headers: Headers;
|
|
1817
1935
|
};
|
|
1818
|
-
type
|
|
1819
|
-
declare const
|
|
1820
|
-
declare const
|
|
1821
|
-
declare const
|
|
1822
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
1823
|
-
|
|
1936
|
+
type updateMeResponse = updateMeResponseSuccess | updateMeResponseError;
|
|
1937
|
+
declare const getUpdateMeUrl: () => string;
|
|
1938
|
+
declare const updateMe: (updateMeBody: UpdateMeBody, options?: RequestInit) => Promise<updateMeResponse>;
|
|
1939
|
+
declare const getUpdateMeMutationOptions: <TError = UpdateMe400 | UpdateMe403, TContext = unknown>(options?: {
|
|
1940
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateMe>>, TError, {
|
|
1941
|
+
data: UpdateMeBody;
|
|
1824
1942
|
}, TContext>;
|
|
1825
1943
|
fetch?: RequestInit;
|
|
1826
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
1827
|
-
|
|
1944
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof updateMe>>, TError, {
|
|
1945
|
+
data: UpdateMeBody;
|
|
1828
1946
|
}, TContext>;
|
|
1829
|
-
type
|
|
1830
|
-
type
|
|
1831
|
-
|
|
1832
|
-
|
|
1833
|
-
|
|
1947
|
+
type UpdateMeMutationResult = NonNullable<Awaited<ReturnType<typeof updateMe>>>;
|
|
1948
|
+
type UpdateMeMutationBody = UpdateMeBody;
|
|
1949
|
+
type UpdateMeMutationError = UpdateMe400 | UpdateMe403;
|
|
1950
|
+
declare const useUpdateMe: <TError = UpdateMe400 | UpdateMe403, TContext = unknown>(options?: {
|
|
1951
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof updateMe>>, TError, {
|
|
1952
|
+
data: UpdateMeBody;
|
|
1834
1953
|
}, TContext>;
|
|
1835
1954
|
fetch?: RequestInit;
|
|
1836
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
1837
|
-
|
|
1838
|
-
}, TContext>;
|
|
1839
|
-
type sessionsResponse200 = {
|
|
1840
|
-
data: ActiveSessionsResponse;
|
|
1841
|
-
status: 200;
|
|
1842
|
-
};
|
|
1843
|
-
type sessionsResponse403 = {
|
|
1844
|
-
data: Sessions403;
|
|
1845
|
-
status: 403;
|
|
1846
|
-
};
|
|
1847
|
-
type sessionsResponseSuccess = sessionsResponse200 & {
|
|
1848
|
-
headers: Headers;
|
|
1849
|
-
};
|
|
1850
|
-
type sessionsResponseError = sessionsResponse403 & {
|
|
1851
|
-
headers: Headers;
|
|
1852
|
-
};
|
|
1853
|
-
type sessionsResponse = sessionsResponseSuccess | sessionsResponseError;
|
|
1854
|
-
declare const getSessionsUrl: () => string;
|
|
1855
|
-
declare const sessions: (options?: RequestInit) => Promise<sessionsResponse>;
|
|
1856
|
-
declare const getSessionsQueryKey: () => readonly ["https://api.workos.com/_widgets/UserProfile/sessions"];
|
|
1857
|
-
declare const getSessionsQueryOptions: <TData = Awaited<ReturnType<typeof sessions>>, TError = Sessions403>(options?: {
|
|
1858
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData>>;
|
|
1859
|
-
fetch?: RequestInit;
|
|
1860
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData> & {
|
|
1861
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1862
|
-
};
|
|
1863
|
-
type SessionsQueryResult = NonNullable<Awaited<ReturnType<typeof sessions>>>;
|
|
1864
|
-
type SessionsQueryError = Sessions403;
|
|
1865
|
-
declare function useSessions<TData = Awaited<ReturnType<typeof sessions>>, TError = Sessions403>(options: {
|
|
1866
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof sessions>>, TError, Awaited<ReturnType<typeof sessions>>>, "initialData">;
|
|
1867
|
-
fetch?: RequestInit;
|
|
1868
|
-
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
1869
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1870
|
-
};
|
|
1871
|
-
declare function useSessions<TData = Awaited<ReturnType<typeof sessions>>, TError = Sessions403>(options?: {
|
|
1872
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof sessions>>, TError, Awaited<ReturnType<typeof sessions>>>, "initialData">;
|
|
1873
|
-
fetch?: RequestInit;
|
|
1874
|
-
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1875
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1876
|
-
};
|
|
1877
|
-
declare function useSessions<TData = Awaited<ReturnType<typeof sessions>>, TError = Sessions403>(options?: {
|
|
1878
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData>>;
|
|
1879
|
-
fetch?: RequestInit;
|
|
1880
|
-
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
1881
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
1882
|
-
};
|
|
1883
|
-
type sendVerificationResponse200 = {
|
|
1884
|
-
data: SendVerificationResponse;
|
|
1885
|
-
status: 200;
|
|
1886
|
-
};
|
|
1887
|
-
type sendVerificationResponse400 = {
|
|
1888
|
-
data: SendVerification400;
|
|
1889
|
-
status: 400;
|
|
1890
|
-
};
|
|
1891
|
-
type sendVerificationResponse403 = {
|
|
1892
|
-
data: SendVerification403;
|
|
1893
|
-
status: 403;
|
|
1894
|
-
};
|
|
1895
|
-
type sendVerificationResponseSuccess = sendVerificationResponse200 & {
|
|
1896
|
-
headers: Headers;
|
|
1897
|
-
};
|
|
1898
|
-
type sendVerificationResponseError = (sendVerificationResponse400 | sendVerificationResponse403) & {
|
|
1899
|
-
headers: Headers;
|
|
1900
|
-
};
|
|
1901
|
-
type sendVerificationResponse = sendVerificationResponseSuccess | sendVerificationResponseError;
|
|
1902
|
-
declare const getSendVerificationUrl: () => string;
|
|
1903
|
-
declare const sendVerification: (options?: RequestInit) => Promise<sendVerificationResponse>;
|
|
1904
|
-
declare const getSendVerificationMutationOptions: <TError = SendVerification400 | SendVerification403, TContext = unknown>(options?: {
|
|
1905
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof sendVerification>>, TError, void, TContext>;
|
|
1906
|
-
fetch?: RequestInit;
|
|
1907
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof sendVerification>>, TError, void, TContext>;
|
|
1908
|
-
type SendVerificationMutationResult = NonNullable<Awaited<ReturnType<typeof sendVerification>>>;
|
|
1909
|
-
type SendVerificationMutationError = SendVerification400 | SendVerification403;
|
|
1910
|
-
declare const useSendVerification: <TError = SendVerification400 | SendVerification403, TContext = unknown>(options?: {
|
|
1911
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof sendVerification>>, TError, void, TContext>;
|
|
1912
|
-
fetch?: RequestInit;
|
|
1913
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof sendVerification>>, TError, void, TContext>;
|
|
1914
|
-
type verifyResponse200 = {
|
|
1915
|
-
data: VerifyResponse;
|
|
1916
|
-
status: 200;
|
|
1917
|
-
};
|
|
1918
|
-
type verifyResponse400 = {
|
|
1919
|
-
data: Verify400;
|
|
1920
|
-
status: 400;
|
|
1921
|
-
};
|
|
1922
|
-
type verifyResponse403 = {
|
|
1923
|
-
data: Verify403;
|
|
1924
|
-
status: 403;
|
|
1925
|
-
};
|
|
1926
|
-
type verifyResponseSuccess = verifyResponse200 & {
|
|
1927
|
-
headers: Headers;
|
|
1928
|
-
};
|
|
1929
|
-
type verifyResponseError = (verifyResponse400 | verifyResponse403) & {
|
|
1930
|
-
headers: Headers;
|
|
1931
|
-
};
|
|
1932
|
-
type verifyResponse = verifyResponseSuccess | verifyResponseError;
|
|
1933
|
-
declare const getVerifyUrl: () => string;
|
|
1934
|
-
declare const verify: (verifyRequest: VerifyRequest, options?: RequestInit) => Promise<verifyResponse>;
|
|
1935
|
-
declare const getVerifyMutationOptions: <TError = Verify400 | Verify403, TContext = unknown>(options?: {
|
|
1936
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof verify>>, TError, {
|
|
1937
|
-
data: VerifyRequest;
|
|
1938
|
-
}, TContext>;
|
|
1939
|
-
fetch?: RequestInit;
|
|
1940
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof verify>>, TError, {
|
|
1941
|
-
data: VerifyRequest;
|
|
1942
|
-
}, TContext>;
|
|
1943
|
-
type VerifyMutationResult = NonNullable<Awaited<ReturnType<typeof verify>>>;
|
|
1944
|
-
type VerifyMutationBody = VerifyRequest;
|
|
1945
|
-
type VerifyMutationError = Verify400 | Verify403;
|
|
1946
|
-
declare const useVerify: <TError = Verify400 | Verify403, TContext = unknown>(options?: {
|
|
1947
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof verify>>, TError, {
|
|
1948
|
-
data: VerifyRequest;
|
|
1949
|
-
}, TContext>;
|
|
1950
|
-
fetch?: RequestInit;
|
|
1951
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof verify>>, TError, {
|
|
1952
|
-
data: VerifyRequest;
|
|
1955
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof updateMe>>, TError, {
|
|
1956
|
+
data: UpdateMeBody;
|
|
1953
1957
|
}, TContext>;
|
|
1958
|
+
/**
|
|
1959
|
+
* Initiates passkey (WebAuthn) registration for the authenticated user by returning the credential creation options. Requires elevated access.
|
|
1960
|
+
*/
|
|
1954
1961
|
type registerPasskeyResponse201 = {
|
|
1955
1962
|
data: RegisterPasskeyResponse;
|
|
1956
1963
|
status: 201;
|
|
@@ -1982,6 +1989,9 @@ declare const useRegisterPasskey: <TError = RegisterPasskey400 | RegisterPasskey
|
|
|
1982
1989
|
mutation?: UseMutationOptions<Awaited<ReturnType<typeof registerPasskey>>, TError, void, TContext>;
|
|
1983
1990
|
fetch?: RequestInit;
|
|
1984
1991
|
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof registerPasskey>>, TError, void, TContext>;
|
|
1992
|
+
/**
|
|
1993
|
+
* Completes passkey (WebAuthn) registration by verifying the credential created by the authenticator. Requires elevated access.
|
|
1994
|
+
*/
|
|
1985
1995
|
type verifyPasskeyResponse200 = {
|
|
1986
1996
|
data: VerifyPasskey200;
|
|
1987
1997
|
status: 200;
|
|
@@ -2022,6 +2032,9 @@ declare const useVerifyPasskey: <TError = VerifyPasskey400 | VerifyPasskey403, T
|
|
|
2022
2032
|
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof verifyPasskey>>, TError, {
|
|
2023
2033
|
data: VerifyPasskeyRequest;
|
|
2024
2034
|
}, TContext>;
|
|
2035
|
+
/**
|
|
2036
|
+
* Removes the specified passkey from the authenticated user's account. Requires elevated access.
|
|
2037
|
+
*/
|
|
2025
2038
|
type deletePasskeyResponse200 = {
|
|
2026
2039
|
data: DeletePasskey200;
|
|
2027
2040
|
status: 200;
|
|
@@ -2061,625 +2074,727 @@ declare const useDeletePasskey: <TError = DeletePasskey400 | DeletePasskey403, T
|
|
|
2061
2074
|
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deletePasskey>>, TError, {
|
|
2062
2075
|
passkeyId: string;
|
|
2063
2076
|
}, TContext>;
|
|
2064
|
-
|
|
2065
|
-
|
|
2077
|
+
/**
|
|
2078
|
+
* Sends a verification email to the authenticated user to confirm their email address.
|
|
2079
|
+
*/
|
|
2080
|
+
type sendVerificationResponse200 = {
|
|
2081
|
+
data: SendVerificationResponse;
|
|
2066
2082
|
status: 200;
|
|
2067
2083
|
};
|
|
2068
|
-
type
|
|
2069
|
-
data:
|
|
2084
|
+
type sendVerificationResponse400 = {
|
|
2085
|
+
data: SendVerification400;
|
|
2086
|
+
status: 400;
|
|
2087
|
+
};
|
|
2088
|
+
type sendVerificationResponse403 = {
|
|
2089
|
+
data: SendVerification403;
|
|
2070
2090
|
status: 403;
|
|
2071
2091
|
};
|
|
2072
|
-
type
|
|
2092
|
+
type sendVerificationResponseSuccess = sendVerificationResponse200 & {
|
|
2073
2093
|
headers: Headers;
|
|
2074
2094
|
};
|
|
2075
|
-
type
|
|
2095
|
+
type sendVerificationResponseError = (sendVerificationResponse400 | sendVerificationResponse403) & {
|
|
2076
2096
|
headers: Headers;
|
|
2077
2097
|
};
|
|
2078
|
-
type
|
|
2079
|
-
declare const
|
|
2080
|
-
declare const
|
|
2081
|
-
declare const
|
|
2082
|
-
|
|
2083
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData>>;
|
|
2084
|
-
fetch?: RequestInit;
|
|
2085
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData> & {
|
|
2086
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2087
|
-
};
|
|
2088
|
-
type SettingsQueryResult = NonNullable<Awaited<ReturnType<typeof settings>>>;
|
|
2089
|
-
type SettingsQueryError = Settings403;
|
|
2090
|
-
declare function useSettings<TData = Awaited<ReturnType<typeof settings>>, TError = Settings403>(options: {
|
|
2091
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof settings>>, TError, Awaited<ReturnType<typeof settings>>>, "initialData">;
|
|
2092
|
-
fetch?: RequestInit;
|
|
2093
|
-
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2094
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2095
|
-
};
|
|
2096
|
-
declare function useSettings<TData = Awaited<ReturnType<typeof settings>>, TError = Settings403>(options?: {
|
|
2097
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof settings>>, TError, Awaited<ReturnType<typeof settings>>>, "initialData">;
|
|
2098
|
+
type sendVerificationResponse = sendVerificationResponseSuccess | sendVerificationResponseError;
|
|
2099
|
+
declare const getSendVerificationUrl: () => string;
|
|
2100
|
+
declare const sendVerification: (options?: RequestInit) => Promise<sendVerificationResponse>;
|
|
2101
|
+
declare const getSendVerificationMutationOptions: <TError = SendVerification400 | SendVerification403, TContext = unknown>(options?: {
|
|
2102
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof sendVerification>>, TError, void, TContext>;
|
|
2098
2103
|
fetch?: RequestInit;
|
|
2099
|
-
}
|
|
2100
|
-
|
|
2101
|
-
|
|
2102
|
-
declare
|
|
2103
|
-
|
|
2104
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof sendVerification>>, TError, void, TContext>;
|
|
2105
|
+
type SendVerificationMutationResult = NonNullable<Awaited<ReturnType<typeof sendVerification>>>;
|
|
2106
|
+
type SendVerificationMutationError = SendVerification400 | SendVerification403;
|
|
2107
|
+
declare const useSendVerification: <TError = SendVerification400 | SendVerification403, TContext = unknown>(options?: {
|
|
2108
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof sendVerification>>, TError, void, TContext>;
|
|
2104
2109
|
fetch?: RequestInit;
|
|
2105
|
-
}, queryClient?: QueryClient)
|
|
2106
|
-
|
|
2107
|
-
|
|
2108
|
-
|
|
2109
|
-
|
|
2110
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof sendVerification>>, TError, void, TContext>;
|
|
2111
|
+
/**
|
|
2112
|
+
* Returns all currently active sessions for the authenticated user, including device and location information where available.
|
|
2113
|
+
*/
|
|
2114
|
+
type sessionsResponse200 = {
|
|
2115
|
+
data: ActiveSessionsResponse;
|
|
2110
2116
|
status: 200;
|
|
2111
2117
|
};
|
|
2112
|
-
type
|
|
2113
|
-
data:
|
|
2118
|
+
type sessionsResponse403 = {
|
|
2119
|
+
data: Sessions403;
|
|
2114
2120
|
status: 403;
|
|
2115
2121
|
};
|
|
2116
|
-
type
|
|
2117
|
-
data: ListOrganizationDomains404;
|
|
2118
|
-
status: 404;
|
|
2119
|
-
};
|
|
2120
|
-
type listOrganizationDomainsResponseSuccess = listOrganizationDomainsResponse200 & {
|
|
2122
|
+
type sessionsResponseSuccess = sessionsResponse200 & {
|
|
2121
2123
|
headers: Headers;
|
|
2122
2124
|
};
|
|
2123
|
-
type
|
|
2125
|
+
type sessionsResponseError = sessionsResponse403 & {
|
|
2124
2126
|
headers: Headers;
|
|
2125
2127
|
};
|
|
2126
|
-
type
|
|
2127
|
-
declare const
|
|
2128
|
-
declare const
|
|
2129
|
-
declare const
|
|
2130
|
-
declare const
|
|
2131
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2128
|
+
type sessionsResponse = sessionsResponseSuccess | sessionsResponseError;
|
|
2129
|
+
declare const getSessionsUrl: () => string;
|
|
2130
|
+
declare const sessions: (options?: RequestInit) => Promise<sessionsResponse>;
|
|
2131
|
+
declare const getSessionsQueryKey: () => readonly ["https://api.workos.com/_widgets/UserProfile/sessions"];
|
|
2132
|
+
declare const getSessionsQueryOptions: <TData = Awaited<ReturnType<typeof sessions>>, TError = Sessions403>(options?: {
|
|
2133
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData>>;
|
|
2132
2134
|
fetch?: RequestInit;
|
|
2133
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof
|
|
2135
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData> & {
|
|
2134
2136
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2135
2137
|
};
|
|
2136
|
-
type
|
|
2137
|
-
type
|
|
2138
|
-
declare function
|
|
2139
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2138
|
+
type SessionsQueryResult = NonNullable<Awaited<ReturnType<typeof sessions>>>;
|
|
2139
|
+
type SessionsQueryError = Sessions403;
|
|
2140
|
+
declare function useSessions<TData = Awaited<ReturnType<typeof sessions>>, TError = Sessions403>(options: {
|
|
2141
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof sessions>>, TError, Awaited<ReturnType<typeof sessions>>>, "initialData">;
|
|
2140
2142
|
fetch?: RequestInit;
|
|
2141
2143
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2142
2144
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2143
2145
|
};
|
|
2144
|
-
declare function
|
|
2145
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2146
|
+
declare function useSessions<TData = Awaited<ReturnType<typeof sessions>>, TError = Sessions403>(options?: {
|
|
2147
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof sessions>>, TError, Awaited<ReturnType<typeof sessions>>>, "initialData">;
|
|
2146
2148
|
fetch?: RequestInit;
|
|
2147
2149
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2148
2150
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2149
2151
|
};
|
|
2150
|
-
declare function
|
|
2151
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2152
|
+
declare function useSessions<TData = Awaited<ReturnType<typeof sessions>>, TError = Sessions403>(options?: {
|
|
2153
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof sessions>>, TError, TData>>;
|
|
2152
2154
|
fetch?: RequestInit;
|
|
2153
2155
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2154
2156
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2155
2157
|
};
|
|
2156
|
-
|
|
2157
|
-
|
|
2158
|
-
|
|
2159
|
-
|
|
2160
|
-
|
|
2161
|
-
|
|
2162
|
-
status: 403;
|
|
2158
|
+
/**
|
|
2159
|
+
* Revokes all active sessions for the authenticated user except optionally the current one, signing them out of all other devices.
|
|
2160
|
+
*/
|
|
2161
|
+
type revokeAllSessionsResponse200 = {
|
|
2162
|
+
data: RevokeAllSessions200;
|
|
2163
|
+
status: 200;
|
|
2163
2164
|
};
|
|
2164
|
-
type
|
|
2165
|
-
data:
|
|
2166
|
-
status:
|
|
2165
|
+
type revokeAllSessionsResponse400 = {
|
|
2166
|
+
data: RevokeAllSessions400;
|
|
2167
|
+
status: 400;
|
|
2167
2168
|
};
|
|
2168
|
-
type
|
|
2169
|
-
data:
|
|
2170
|
-
status:
|
|
2169
|
+
type revokeAllSessionsResponse403 = {
|
|
2170
|
+
data: RevokeAllSessions403;
|
|
2171
|
+
status: 403;
|
|
2171
2172
|
};
|
|
2172
|
-
type
|
|
2173
|
+
type revokeAllSessionsResponseSuccess = revokeAllSessionsResponse200 & {
|
|
2173
2174
|
headers: Headers;
|
|
2174
2175
|
};
|
|
2175
|
-
type
|
|
2176
|
+
type revokeAllSessionsResponseError = (revokeAllSessionsResponse400 | revokeAllSessionsResponse403) & {
|
|
2176
2177
|
headers: Headers;
|
|
2177
2178
|
};
|
|
2178
|
-
type
|
|
2179
|
-
declare const
|
|
2180
|
-
declare const
|
|
2181
|
-
declare const
|
|
2182
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
2183
|
-
|
|
2179
|
+
type revokeAllSessionsResponse = revokeAllSessionsResponseSuccess | revokeAllSessionsResponseError;
|
|
2180
|
+
declare const getRevokeAllSessionsUrl: () => string;
|
|
2181
|
+
declare const revokeAllSessions: (revokeAllSessionsRequest: RevokeAllSessionsRequest, options?: RequestInit) => Promise<revokeAllSessionsResponse>;
|
|
2182
|
+
declare const getRevokeAllSessionsMutationOptions: <TError = RevokeAllSessions400 | RevokeAllSessions403, TContext = unknown>(options?: {
|
|
2183
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof revokeAllSessions>>, TError, {
|
|
2184
|
+
data: RevokeAllSessionsRequest;
|
|
2184
2185
|
}, TContext>;
|
|
2185
2186
|
fetch?: RequestInit;
|
|
2186
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
2187
|
-
|
|
2187
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof revokeAllSessions>>, TError, {
|
|
2188
|
+
data: RevokeAllSessionsRequest;
|
|
2188
2189
|
}, TContext>;
|
|
2189
|
-
type
|
|
2190
|
-
type
|
|
2191
|
-
|
|
2192
|
-
|
|
2193
|
-
|
|
2190
|
+
type RevokeAllSessionsMutationResult = NonNullable<Awaited<ReturnType<typeof revokeAllSessions>>>;
|
|
2191
|
+
type RevokeAllSessionsMutationBody = RevokeAllSessionsRequest;
|
|
2192
|
+
type RevokeAllSessionsMutationError = RevokeAllSessions400 | RevokeAllSessions403;
|
|
2193
|
+
declare const useRevokeAllSessions: <TError = RevokeAllSessions400 | RevokeAllSessions403, TContext = unknown>(options?: {
|
|
2194
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof revokeAllSessions>>, TError, {
|
|
2195
|
+
data: RevokeAllSessionsRequest;
|
|
2194
2196
|
}, TContext>;
|
|
2195
2197
|
fetch?: RequestInit;
|
|
2196
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
2197
|
-
|
|
2198
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof revokeAllSessions>>, TError, {
|
|
2199
|
+
data: RevokeAllSessionsRequest;
|
|
2198
2200
|
}, TContext>;
|
|
2199
|
-
|
|
2200
|
-
|
|
2201
|
+
/**
|
|
2202
|
+
* Revokes a specific active session by ID, signing the user out of that particular device or browser.
|
|
2203
|
+
*/
|
|
2204
|
+
type revokeSessionResponse200 = {
|
|
2205
|
+
data: RevokeSession200;
|
|
2201
2206
|
status: 200;
|
|
2202
2207
|
};
|
|
2203
|
-
type
|
|
2204
|
-
data:
|
|
2205
|
-
status:
|
|
2208
|
+
type revokeSessionResponse400 = {
|
|
2209
|
+
data: RevokeSession400;
|
|
2210
|
+
status: 400;
|
|
2206
2211
|
};
|
|
2207
|
-
type
|
|
2208
|
-
data:
|
|
2209
|
-
status:
|
|
2212
|
+
type revokeSessionResponse403 = {
|
|
2213
|
+
data: RevokeSession403;
|
|
2214
|
+
status: 403;
|
|
2210
2215
|
};
|
|
2211
|
-
type
|
|
2216
|
+
type revokeSessionResponseSuccess = revokeSessionResponse200 & {
|
|
2212
2217
|
headers: Headers;
|
|
2213
2218
|
};
|
|
2214
|
-
type
|
|
2219
|
+
type revokeSessionResponseError = (revokeSessionResponse400 | revokeSessionResponse403) & {
|
|
2215
2220
|
headers: Headers;
|
|
2216
2221
|
};
|
|
2217
|
-
type
|
|
2218
|
-
declare const
|
|
2219
|
-
declare const
|
|
2220
|
-
declare const
|
|
2221
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
2222
|
-
|
|
2222
|
+
type revokeSessionResponse = revokeSessionResponseSuccess | revokeSessionResponseError;
|
|
2223
|
+
declare const getRevokeSessionUrl: (sessionId: string) => string;
|
|
2224
|
+
declare const revokeSession: (sessionId: string, options?: RequestInit) => Promise<revokeSessionResponse>;
|
|
2225
|
+
declare const getRevokeSessionMutationOptions: <TError = RevokeSession400 | RevokeSession403, TContext = unknown>(options?: {
|
|
2226
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof revokeSession>>, TError, {
|
|
2227
|
+
sessionId: string;
|
|
2223
2228
|
}, TContext>;
|
|
2224
2229
|
fetch?: RequestInit;
|
|
2225
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
2226
|
-
|
|
2230
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof revokeSession>>, TError, {
|
|
2231
|
+
sessionId: string;
|
|
2227
2232
|
}, TContext>;
|
|
2228
|
-
type
|
|
2229
|
-
type
|
|
2230
|
-
declare const
|
|
2231
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
2232
|
-
|
|
2233
|
+
type RevokeSessionMutationResult = NonNullable<Awaited<ReturnType<typeof revokeSession>>>;
|
|
2234
|
+
type RevokeSessionMutationError = RevokeSession400 | RevokeSession403;
|
|
2235
|
+
declare const useRevokeSession: <TError = RevokeSession400 | RevokeSession403, TContext = unknown>(options?: {
|
|
2236
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof revokeSession>>, TError, {
|
|
2237
|
+
sessionId: string;
|
|
2233
2238
|
}, TContext>;
|
|
2234
2239
|
fetch?: RequestInit;
|
|
2235
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
2236
|
-
|
|
2240
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof revokeSession>>, TError, {
|
|
2241
|
+
sessionId: string;
|
|
2237
2242
|
}, TContext>;
|
|
2238
|
-
|
|
2239
|
-
|
|
2243
|
+
/**
|
|
2244
|
+
* Removes all TOTP factors enrolled for the authenticated user, disabling authenticator app as a second factor. Requires elevated access.
|
|
2245
|
+
*/
|
|
2246
|
+
type deleteTotpFactorsResponse200 = {
|
|
2247
|
+
data: DeleteTotpFactors200;
|
|
2240
2248
|
status: 200;
|
|
2241
2249
|
};
|
|
2242
|
-
type
|
|
2243
|
-
data:
|
|
2250
|
+
type deleteTotpFactorsResponse400 = {
|
|
2251
|
+
data: DeleteTotpFactors400;
|
|
2252
|
+
status: 400;
|
|
2253
|
+
};
|
|
2254
|
+
type deleteTotpFactorsResponse403 = {
|
|
2255
|
+
data: DeleteTotpFactors403;
|
|
2244
2256
|
status: 403;
|
|
2245
2257
|
};
|
|
2246
|
-
type
|
|
2247
|
-
|
|
2248
|
-
status: 404;
|
|
2258
|
+
type deleteTotpFactorsResponseSuccess = deleteTotpFactorsResponse200 & {
|
|
2259
|
+
headers: Headers;
|
|
2249
2260
|
};
|
|
2250
|
-
type
|
|
2261
|
+
type deleteTotpFactorsResponseError = (deleteTotpFactorsResponse400 | deleteTotpFactorsResponse403) & {
|
|
2251
2262
|
headers: Headers;
|
|
2252
2263
|
};
|
|
2253
|
-
type
|
|
2264
|
+
type deleteTotpFactorsResponse = deleteTotpFactorsResponseSuccess | deleteTotpFactorsResponseError;
|
|
2265
|
+
declare const getDeleteTotpFactorsUrl: () => string;
|
|
2266
|
+
declare const deleteTotpFactors: (options?: RequestInit) => Promise<deleteTotpFactorsResponse>;
|
|
2267
|
+
declare const getDeleteTotpFactorsMutationOptions: <TError = DeleteTotpFactors400 | DeleteTotpFactors403, TContext = unknown>(options?: {
|
|
2268
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteTotpFactors>>, TError, void, TContext>;
|
|
2269
|
+
fetch?: RequestInit;
|
|
2270
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteTotpFactors>>, TError, void, TContext>;
|
|
2271
|
+
type DeleteTotpFactorsMutationResult = NonNullable<Awaited<ReturnType<typeof deleteTotpFactors>>>;
|
|
2272
|
+
type DeleteTotpFactorsMutationError = DeleteTotpFactors400 | DeleteTotpFactors403;
|
|
2273
|
+
declare const useDeleteTotpFactors: <TError = DeleteTotpFactors400 | DeleteTotpFactors403, TContext = unknown>(options?: {
|
|
2274
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteTotpFactors>>, TError, void, TContext>;
|
|
2275
|
+
fetch?: RequestInit;
|
|
2276
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteTotpFactors>>, TError, void, TContext>;
|
|
2277
|
+
/**
|
|
2278
|
+
* Changes the password for the authenticated user. Requires the current password to be supplied alongside the new password.
|
|
2279
|
+
*/
|
|
2280
|
+
type updatePasswordResponse201 = {
|
|
2281
|
+
data: UpdatePassword201;
|
|
2282
|
+
status: 201;
|
|
2283
|
+
};
|
|
2284
|
+
type updatePasswordResponse400 = {
|
|
2285
|
+
data: UpdatePassword400;
|
|
2286
|
+
status: 400;
|
|
2287
|
+
};
|
|
2288
|
+
type updatePasswordResponse403 = {
|
|
2289
|
+
data: UpdatePassword403;
|
|
2290
|
+
status: 403;
|
|
2291
|
+
};
|
|
2292
|
+
type updatePasswordResponseSuccess = updatePasswordResponse201 & {
|
|
2254
2293
|
headers: Headers;
|
|
2255
2294
|
};
|
|
2256
|
-
type
|
|
2257
|
-
|
|
2258
|
-
|
|
2259
|
-
|
|
2260
|
-
|
|
2261
|
-
|
|
2295
|
+
type updatePasswordResponseError = (updatePasswordResponse400 | updatePasswordResponse403) & {
|
|
2296
|
+
headers: Headers;
|
|
2297
|
+
};
|
|
2298
|
+
type updatePasswordResponse = updatePasswordResponseSuccess | updatePasswordResponseError;
|
|
2299
|
+
declare const getUpdatePasswordUrl: () => string;
|
|
2300
|
+
declare const updatePassword: (updatePasswordRequest: UpdatePasswordRequest, options?: RequestInit) => Promise<updatePasswordResponse>;
|
|
2301
|
+
declare const getUpdatePasswordMutationOptions: <TError = UpdatePassword400 | UpdatePassword403, TContext = unknown>(options?: {
|
|
2302
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof updatePassword>>, TError, {
|
|
2303
|
+
data: UpdatePasswordRequest;
|
|
2262
2304
|
}, TContext>;
|
|
2263
2305
|
fetch?: RequestInit;
|
|
2264
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
2265
|
-
|
|
2306
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof updatePassword>>, TError, {
|
|
2307
|
+
data: UpdatePasswordRequest;
|
|
2266
2308
|
}, TContext>;
|
|
2267
|
-
type
|
|
2268
|
-
type
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2309
|
+
type UpdatePasswordMutationResult = NonNullable<Awaited<ReturnType<typeof updatePassword>>>;
|
|
2310
|
+
type UpdatePasswordMutationBody = UpdatePasswordRequest;
|
|
2311
|
+
type UpdatePasswordMutationError = UpdatePassword400 | UpdatePassword403;
|
|
2312
|
+
declare const useUpdatePassword: <TError = UpdatePassword400 | UpdatePassword403, TContext = unknown>(options?: {
|
|
2313
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof updatePassword>>, TError, {
|
|
2314
|
+
data: UpdatePasswordRequest;
|
|
2272
2315
|
}, TContext>;
|
|
2273
2316
|
fetch?: RequestInit;
|
|
2274
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
2275
|
-
|
|
2317
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof updatePassword>>, TError, {
|
|
2318
|
+
data: UpdatePasswordRequest;
|
|
2276
2319
|
}, TContext>;
|
|
2277
|
-
|
|
2278
|
-
|
|
2320
|
+
/**
|
|
2321
|
+
* Verifies the email address of the authenticated user using the code sent via the send-verification endpoint. On success, returns an elevated access token that grants access to sensitive operations such as MFA enrollment and passkey management.
|
|
2322
|
+
*/
|
|
2323
|
+
type verifyResponse200 = {
|
|
2324
|
+
data: VerifyResponse;
|
|
2279
2325
|
status: 200;
|
|
2280
2326
|
};
|
|
2281
|
-
type
|
|
2282
|
-
|
|
2327
|
+
type verifyResponse400 = {
|
|
2328
|
+
data: Verify400;
|
|
2329
|
+
status: 400;
|
|
2283
2330
|
};
|
|
2284
|
-
type
|
|
2285
|
-
|
|
2286
|
-
|
|
2287
|
-
declare const getListSsoConnectionsQueryKey: () => readonly ["https://api.workos.com/_widgets/admin-portal/sso-connections"];
|
|
2288
|
-
declare const getListSsoConnectionsQueryOptions: <TData = Awaited<ReturnType<typeof listSsoConnections>>, TError = unknown>(options?: {
|
|
2289
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, TData>>;
|
|
2290
|
-
fetch?: RequestInit;
|
|
2291
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, TData> & {
|
|
2292
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2331
|
+
type verifyResponse403 = {
|
|
2332
|
+
data: Verify403;
|
|
2333
|
+
status: 403;
|
|
2293
2334
|
};
|
|
2294
|
-
type
|
|
2295
|
-
|
|
2296
|
-
declare function useListSsoConnections<TData = Awaited<ReturnType<typeof listSsoConnections>>, TError = unknown>(options: {
|
|
2297
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, Awaited<ReturnType<typeof listSsoConnections>>>, "initialData">;
|
|
2298
|
-
fetch?: RequestInit;
|
|
2299
|
-
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2300
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2335
|
+
type verifyResponseSuccess = verifyResponse200 & {
|
|
2336
|
+
headers: Headers;
|
|
2301
2337
|
};
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
fetch?: RequestInit;
|
|
2305
|
-
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2306
|
-
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2338
|
+
type verifyResponseError = (verifyResponse400 | verifyResponse403) & {
|
|
2339
|
+
headers: Headers;
|
|
2307
2340
|
};
|
|
2308
|
-
|
|
2309
|
-
|
|
2341
|
+
type verifyResponse = verifyResponseSuccess | verifyResponseError;
|
|
2342
|
+
declare const getVerifyUrl: () => string;
|
|
2343
|
+
declare const verify: (verifyRequest: VerifyRequest, options?: RequestInit) => Promise<verifyResponse>;
|
|
2344
|
+
declare const getVerifyMutationOptions: <TError = Verify400 | Verify403, TContext = unknown>(options?: {
|
|
2345
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof verify>>, TError, {
|
|
2346
|
+
data: VerifyRequest;
|
|
2347
|
+
}, TContext>;
|
|
2310
2348
|
fetch?: RequestInit;
|
|
2311
|
-
}
|
|
2312
|
-
|
|
2313
|
-
}
|
|
2314
|
-
type
|
|
2315
|
-
|
|
2316
|
-
|
|
2349
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof verify>>, TError, {
|
|
2350
|
+
data: VerifyRequest;
|
|
2351
|
+
}, TContext>;
|
|
2352
|
+
type VerifyMutationResult = NonNullable<Awaited<ReturnType<typeof verify>>>;
|
|
2353
|
+
type VerifyMutationBody = VerifyRequest;
|
|
2354
|
+
type VerifyMutationError = Verify400 | Verify403;
|
|
2355
|
+
declare const useVerify: <TError = Verify400 | Verify403, TContext = unknown>(options?: {
|
|
2356
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof verify>>, TError, {
|
|
2357
|
+
data: VerifyRequest;
|
|
2358
|
+
}, TContext>;
|
|
2359
|
+
fetch?: RequestInit;
|
|
2360
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof verify>>, TError, {
|
|
2361
|
+
data: VerifyRequest;
|
|
2362
|
+
}, TContext>;
|
|
2363
|
+
/**
|
|
2364
|
+
* Completes TOTP enrollment by verifying the one-time code generated by the authenticator app. Requires elevated access.
|
|
2365
|
+
*/
|
|
2366
|
+
type verifyTotpFactorResponse200 = {
|
|
2367
|
+
data: VerifyTotpFactor200;
|
|
2368
|
+
status: 200;
|
|
2317
2369
|
};
|
|
2318
|
-
type
|
|
2319
|
-
data:
|
|
2370
|
+
type verifyTotpFactorResponse400 = {
|
|
2371
|
+
data: VerifyTotpFactor400;
|
|
2320
2372
|
status: 400;
|
|
2321
2373
|
};
|
|
2322
|
-
type
|
|
2323
|
-
data:
|
|
2374
|
+
type verifyTotpFactorResponse403 = {
|
|
2375
|
+
data: VerifyTotpFactor403;
|
|
2324
2376
|
status: 403;
|
|
2325
2377
|
};
|
|
2326
|
-
type
|
|
2327
|
-
data: CreateOrganizationApiKey404;
|
|
2328
|
-
status: 404;
|
|
2329
|
-
};
|
|
2330
|
-
type createOrganizationApiKeyResponse422 = {
|
|
2331
|
-
data: CreateOrganizationApiKey422;
|
|
2332
|
-
status: 422;
|
|
2333
|
-
};
|
|
2334
|
-
type createOrganizationApiKeyResponseSuccess = createOrganizationApiKeyResponse201 & {
|
|
2378
|
+
type verifyTotpFactorResponseSuccess = verifyTotpFactorResponse200 & {
|
|
2335
2379
|
headers: Headers;
|
|
2336
2380
|
};
|
|
2337
|
-
type
|
|
2381
|
+
type verifyTotpFactorResponseError = (verifyTotpFactorResponse400 | verifyTotpFactorResponse403) & {
|
|
2338
2382
|
headers: Headers;
|
|
2339
2383
|
};
|
|
2340
|
-
type
|
|
2341
|
-
declare const
|
|
2342
|
-
declare const
|
|
2343
|
-
declare const
|
|
2344
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
2345
|
-
data:
|
|
2384
|
+
type verifyTotpFactorResponse = verifyTotpFactorResponseSuccess | verifyTotpFactorResponseError;
|
|
2385
|
+
declare const getVerifyTotpFactorUrl: () => string;
|
|
2386
|
+
declare const verifyTotpFactor: (verifyTotpFactorRequest: VerifyTotpFactorRequest, options?: RequestInit) => Promise<verifyTotpFactorResponse>;
|
|
2387
|
+
declare const getVerifyTotpFactorMutationOptions: <TError = VerifyTotpFactor400 | VerifyTotpFactor403, TContext = unknown>(options?: {
|
|
2388
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof verifyTotpFactor>>, TError, {
|
|
2389
|
+
data: VerifyTotpFactorRequest;
|
|
2346
2390
|
}, TContext>;
|
|
2347
2391
|
fetch?: RequestInit;
|
|
2348
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
2349
|
-
data:
|
|
2392
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof verifyTotpFactor>>, TError, {
|
|
2393
|
+
data: VerifyTotpFactorRequest;
|
|
2350
2394
|
}, TContext>;
|
|
2351
|
-
type
|
|
2352
|
-
type
|
|
2353
|
-
type
|
|
2354
|
-
declare const
|
|
2355
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
2356
|
-
data:
|
|
2395
|
+
type VerifyTotpFactorMutationResult = NonNullable<Awaited<ReturnType<typeof verifyTotpFactor>>>;
|
|
2396
|
+
type VerifyTotpFactorMutationBody = VerifyTotpFactorRequest;
|
|
2397
|
+
type VerifyTotpFactorMutationError = VerifyTotpFactor400 | VerifyTotpFactor403;
|
|
2398
|
+
declare const useVerifyTotpFactor: <TError = VerifyTotpFactor400 | VerifyTotpFactor403, TContext = unknown>(options?: {
|
|
2399
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof verifyTotpFactor>>, TError, {
|
|
2400
|
+
data: VerifyTotpFactorRequest;
|
|
2357
2401
|
}, TContext>;
|
|
2358
2402
|
fetch?: RequestInit;
|
|
2359
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
2360
|
-
data:
|
|
2403
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof verifyTotpFactor>>, TError, {
|
|
2404
|
+
data: VerifyTotpFactorRequest;
|
|
2361
2405
|
}, TContext>;
|
|
2362
|
-
type
|
|
2363
|
-
data:
|
|
2406
|
+
type getAuditLogStreamResponse200 = {
|
|
2407
|
+
data: GetAuditLogStream200;
|
|
2364
2408
|
status: 200;
|
|
2365
2409
|
};
|
|
2366
|
-
type
|
|
2367
|
-
data:
|
|
2368
|
-
status: 400;
|
|
2369
|
-
};
|
|
2370
|
-
type listOrganizationApiKeysResponse403 = {
|
|
2371
|
-
data: ListOrganizationApiKeys403;
|
|
2410
|
+
type getAuditLogStreamResponse403 = {
|
|
2411
|
+
data: GetAuditLogStream403;
|
|
2372
2412
|
status: 403;
|
|
2373
2413
|
};
|
|
2374
|
-
type
|
|
2414
|
+
type getAuditLogStreamResponseSuccess = getAuditLogStreamResponse200 & {
|
|
2375
2415
|
headers: Headers;
|
|
2376
2416
|
};
|
|
2377
|
-
type
|
|
2417
|
+
type getAuditLogStreamResponseError = getAuditLogStreamResponse403 & {
|
|
2378
2418
|
headers: Headers;
|
|
2379
2419
|
};
|
|
2380
|
-
type
|
|
2381
|
-
declare const
|
|
2382
|
-
declare const
|
|
2383
|
-
declare const
|
|
2384
|
-
declare const
|
|
2385
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2420
|
+
type getAuditLogStreamResponse = getAuditLogStreamResponseSuccess | getAuditLogStreamResponseError;
|
|
2421
|
+
declare const getGetAuditLogStreamUrl: () => string;
|
|
2422
|
+
declare const getAuditLogStream: (options?: RequestInit) => Promise<getAuditLogStreamResponse>;
|
|
2423
|
+
declare const getGetAuditLogStreamQueryKey: () => readonly ["https://api.workos.com/_widgets/admin-portal/audit-log-stream"];
|
|
2424
|
+
declare const getGetAuditLogStreamQueryOptions: <TData = Awaited<ReturnType<typeof getAuditLogStream>>, TError = GetAuditLogStream403>(options?: {
|
|
2425
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAuditLogStream>>, TError, TData>>;
|
|
2386
2426
|
fetch?: RequestInit;
|
|
2387
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof
|
|
2427
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof getAuditLogStream>>, TError, TData> & {
|
|
2388
2428
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2389
2429
|
};
|
|
2390
|
-
type
|
|
2391
|
-
type
|
|
2392
|
-
declare function
|
|
2393
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2430
|
+
type GetAuditLogStreamQueryResult = NonNullable<Awaited<ReturnType<typeof getAuditLogStream>>>;
|
|
2431
|
+
type GetAuditLogStreamQueryError = GetAuditLogStream403;
|
|
2432
|
+
declare function useGetAuditLogStream<TData = Awaited<ReturnType<typeof getAuditLogStream>>, TError = GetAuditLogStream403>(options: {
|
|
2433
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAuditLogStream>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getAuditLogStream>>, TError, Awaited<ReturnType<typeof getAuditLogStream>>>, "initialData">;
|
|
2394
2434
|
fetch?: RequestInit;
|
|
2395
2435
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2396
2436
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2397
2437
|
};
|
|
2398
|
-
declare function
|
|
2399
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2438
|
+
declare function useGetAuditLogStream<TData = Awaited<ReturnType<typeof getAuditLogStream>>, TError = GetAuditLogStream403>(options?: {
|
|
2439
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAuditLogStream>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getAuditLogStream>>, TError, Awaited<ReturnType<typeof getAuditLogStream>>>, "initialData">;
|
|
2400
2440
|
fetch?: RequestInit;
|
|
2401
2441
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2402
2442
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2403
2443
|
};
|
|
2404
|
-
declare function
|
|
2405
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2444
|
+
declare function useGetAuditLogStream<TData = Awaited<ReturnType<typeof getAuditLogStream>>, TError = GetAuditLogStream403>(options?: {
|
|
2445
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getAuditLogStream>>, TError, TData>>;
|
|
2406
2446
|
fetch?: RequestInit;
|
|
2407
2447
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2408
2448
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2409
2449
|
};
|
|
2410
|
-
type
|
|
2411
|
-
data:
|
|
2412
|
-
status:
|
|
2450
|
+
type generateAdminPortalLinkResponse201 = {
|
|
2451
|
+
data: GenerateAdminPortalLink201;
|
|
2452
|
+
status: 201;
|
|
2413
2453
|
};
|
|
2414
|
-
type
|
|
2415
|
-
data:
|
|
2416
|
-
status:
|
|
2454
|
+
type generateAdminPortalLinkResponse403 = {
|
|
2455
|
+
data: GenerateAdminPortalLink403;
|
|
2456
|
+
status: 403;
|
|
2417
2457
|
};
|
|
2418
|
-
type
|
|
2419
|
-
data:
|
|
2458
|
+
type generateAdminPortalLinkResponse404 = {
|
|
2459
|
+
data: GenerateAdminPortalLink404;
|
|
2460
|
+
status: 404;
|
|
2461
|
+
};
|
|
2462
|
+
type generateAdminPortalLinkResponse500 = {
|
|
2463
|
+
data: GenerateAdminPortalLink500;
|
|
2464
|
+
status: 500;
|
|
2465
|
+
};
|
|
2466
|
+
type generateAdminPortalLinkResponseSuccess = generateAdminPortalLinkResponse201 & {
|
|
2467
|
+
headers: Headers;
|
|
2468
|
+
};
|
|
2469
|
+
type generateAdminPortalLinkResponseError = (generateAdminPortalLinkResponse403 | generateAdminPortalLinkResponse404 | generateAdminPortalLinkResponse500) & {
|
|
2470
|
+
headers: Headers;
|
|
2471
|
+
};
|
|
2472
|
+
type generateAdminPortalLinkResponse = generateAdminPortalLinkResponseSuccess | generateAdminPortalLinkResponseError;
|
|
2473
|
+
declare const getGenerateAdminPortalLinkUrl: (params: GenerateAdminPortalLinkParams) => string;
|
|
2474
|
+
declare const generateAdminPortalLink: (params: GenerateAdminPortalLinkParams, options?: RequestInit) => Promise<generateAdminPortalLinkResponse>;
|
|
2475
|
+
declare const getGenerateAdminPortalLinkMutationOptions: <TError = GenerateAdminPortalLink403 | GenerateAdminPortalLink404 | GenerateAdminPortalLink500, TContext = unknown>(options?: {
|
|
2476
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof generateAdminPortalLink>>, TError, {
|
|
2477
|
+
params: GenerateAdminPortalLinkParams;
|
|
2478
|
+
}, TContext>;
|
|
2479
|
+
fetch?: RequestInit;
|
|
2480
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof generateAdminPortalLink>>, TError, {
|
|
2481
|
+
params: GenerateAdminPortalLinkParams;
|
|
2482
|
+
}, TContext>;
|
|
2483
|
+
type GenerateAdminPortalLinkMutationResult = NonNullable<Awaited<ReturnType<typeof generateAdminPortalLink>>>;
|
|
2484
|
+
type GenerateAdminPortalLinkMutationError = GenerateAdminPortalLink403 | GenerateAdminPortalLink404 | GenerateAdminPortalLink500;
|
|
2485
|
+
declare const useGenerateAdminPortalLink: <TError = GenerateAdminPortalLink403 | GenerateAdminPortalLink404 | GenerateAdminPortalLink500, TContext = unknown>(options?: {
|
|
2486
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof generateAdminPortalLink>>, TError, {
|
|
2487
|
+
params: GenerateAdminPortalLinkParams;
|
|
2488
|
+
}, TContext>;
|
|
2489
|
+
fetch?: RequestInit;
|
|
2490
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof generateAdminPortalLink>>, TError, {
|
|
2491
|
+
params: GenerateAdminPortalLinkParams;
|
|
2492
|
+
}, TContext>;
|
|
2493
|
+
type listOrganizationDomainsResponse200 = {
|
|
2494
|
+
data: ListOrganizationDomains200;
|
|
2495
|
+
status: 200;
|
|
2496
|
+
};
|
|
2497
|
+
type listOrganizationDomainsResponse403 = {
|
|
2498
|
+
data: ListOrganizationDomains403;
|
|
2420
2499
|
status: 403;
|
|
2421
2500
|
};
|
|
2422
|
-
type
|
|
2501
|
+
type listOrganizationDomainsResponse404 = {
|
|
2502
|
+
data: ListOrganizationDomains404;
|
|
2503
|
+
status: 404;
|
|
2504
|
+
};
|
|
2505
|
+
type listOrganizationDomainsResponseSuccess = listOrganizationDomainsResponse200 & {
|
|
2423
2506
|
headers: Headers;
|
|
2424
2507
|
};
|
|
2425
|
-
type
|
|
2508
|
+
type listOrganizationDomainsResponseError = (listOrganizationDomainsResponse403 | listOrganizationDomainsResponse404) & {
|
|
2426
2509
|
headers: Headers;
|
|
2427
2510
|
};
|
|
2428
|
-
type
|
|
2429
|
-
declare const
|
|
2430
|
-
declare const
|
|
2431
|
-
declare const
|
|
2432
|
-
declare const
|
|
2433
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2511
|
+
type listOrganizationDomainsResponse = listOrganizationDomainsResponseSuccess | listOrganizationDomainsResponseError;
|
|
2512
|
+
declare const getListOrganizationDomainsUrl: () => string;
|
|
2513
|
+
declare const listOrganizationDomains: (options?: RequestInit) => Promise<listOrganizationDomainsResponse>;
|
|
2514
|
+
declare const getListOrganizationDomainsQueryKey: () => readonly ["https://api.workos.com/_widgets/admin-portal/organization-domains"];
|
|
2515
|
+
declare const getListOrganizationDomainsQueryOptions: <TData = Awaited<ReturnType<typeof listOrganizationDomains>>, TError = ListOrganizationDomains403 | ListOrganizationDomains404>(options?: {
|
|
2516
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationDomains>>, TError, TData>>;
|
|
2434
2517
|
fetch?: RequestInit;
|
|
2435
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof
|
|
2518
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof listOrganizationDomains>>, TError, TData> & {
|
|
2436
2519
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2437
2520
|
};
|
|
2438
|
-
type
|
|
2439
|
-
type
|
|
2440
|
-
declare function
|
|
2441
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2521
|
+
type ListOrganizationDomainsQueryResult = NonNullable<Awaited<ReturnType<typeof listOrganizationDomains>>>;
|
|
2522
|
+
type ListOrganizationDomainsQueryError = ListOrganizationDomains403 | ListOrganizationDomains404;
|
|
2523
|
+
declare function useListOrganizationDomains<TData = Awaited<ReturnType<typeof listOrganizationDomains>>, TError = ListOrganizationDomains403 | ListOrganizationDomains404>(options: {
|
|
2524
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationDomains>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listOrganizationDomains>>, TError, Awaited<ReturnType<typeof listOrganizationDomains>>>, "initialData">;
|
|
2442
2525
|
fetch?: RequestInit;
|
|
2443
2526
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2444
2527
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2445
2528
|
};
|
|
2446
|
-
declare function
|
|
2447
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2529
|
+
declare function useListOrganizationDomains<TData = Awaited<ReturnType<typeof listOrganizationDomains>>, TError = ListOrganizationDomains403 | ListOrganizationDomains404>(options?: {
|
|
2530
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationDomains>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listOrganizationDomains>>, TError, Awaited<ReturnType<typeof listOrganizationDomains>>>, "initialData">;
|
|
2448
2531
|
fetch?: RequestInit;
|
|
2449
2532
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2450
2533
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2451
2534
|
};
|
|
2452
|
-
declare function
|
|
2453
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2535
|
+
declare function useListOrganizationDomains<TData = Awaited<ReturnType<typeof listOrganizationDomains>>, TError = ListOrganizationDomains403 | ListOrganizationDomains404>(options?: {
|
|
2536
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listOrganizationDomains>>, TError, TData>>;
|
|
2454
2537
|
fetch?: RequestInit;
|
|
2455
2538
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2456
2539
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2457
2540
|
};
|
|
2458
|
-
type
|
|
2459
|
-
data:
|
|
2541
|
+
type deleteOrganizationDomainResponse200 = {
|
|
2542
|
+
data: OrganizationDomain;
|
|
2460
2543
|
status: 200;
|
|
2461
2544
|
};
|
|
2462
|
-
type
|
|
2463
|
-
data:
|
|
2545
|
+
type deleteOrganizationDomainResponse403 = {
|
|
2546
|
+
data: DeleteOrganizationDomain403;
|
|
2464
2547
|
status: 403;
|
|
2465
2548
|
};
|
|
2466
|
-
type
|
|
2467
|
-
data:
|
|
2549
|
+
type deleteOrganizationDomainResponse404 = {
|
|
2550
|
+
data: DeleteOrganizationDomain404;
|
|
2468
2551
|
status: 404;
|
|
2469
2552
|
};
|
|
2470
|
-
type
|
|
2553
|
+
type deleteOrganizationDomainResponseSuccess = deleteOrganizationDomainResponse200 & {
|
|
2471
2554
|
headers: Headers;
|
|
2472
2555
|
};
|
|
2473
|
-
type
|
|
2556
|
+
type deleteOrganizationDomainResponseError = (deleteOrganizationDomainResponse403 | deleteOrganizationDomainResponse404) & {
|
|
2474
2557
|
headers: Headers;
|
|
2475
2558
|
};
|
|
2476
|
-
type
|
|
2477
|
-
declare const
|
|
2478
|
-
declare const
|
|
2479
|
-
declare const
|
|
2480
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
2481
|
-
|
|
2559
|
+
type deleteOrganizationDomainResponse = deleteOrganizationDomainResponseSuccess | deleteOrganizationDomainResponseError;
|
|
2560
|
+
declare const getDeleteOrganizationDomainUrl: (domainId: string) => string;
|
|
2561
|
+
declare const deleteOrganizationDomain: (domainId: string, options?: RequestInit) => Promise<deleteOrganizationDomainResponse>;
|
|
2562
|
+
declare const getDeleteOrganizationDomainMutationOptions: <TError = DeleteOrganizationDomain403 | DeleteOrganizationDomain404, TContext = unknown>(options?: {
|
|
2563
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteOrganizationDomain>>, TError, {
|
|
2564
|
+
domainId: string;
|
|
2482
2565
|
}, TContext>;
|
|
2483
2566
|
fetch?: RequestInit;
|
|
2484
|
-
}) => UseMutationOptions<Awaited<ReturnType<typeof
|
|
2485
|
-
|
|
2567
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof deleteOrganizationDomain>>, TError, {
|
|
2568
|
+
domainId: string;
|
|
2486
2569
|
}, TContext>;
|
|
2487
|
-
type
|
|
2488
|
-
type
|
|
2489
|
-
declare const
|
|
2490
|
-
mutation?: UseMutationOptions<Awaited<ReturnType<typeof
|
|
2491
|
-
|
|
2570
|
+
type DeleteOrganizationDomainMutationResult = NonNullable<Awaited<ReturnType<typeof deleteOrganizationDomain>>>;
|
|
2571
|
+
type DeleteOrganizationDomainMutationError = DeleteOrganizationDomain403 | DeleteOrganizationDomain404;
|
|
2572
|
+
declare const useDeleteOrganizationDomain: <TError = DeleteOrganizationDomain403 | DeleteOrganizationDomain404, TContext = unknown>(options?: {
|
|
2573
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof deleteOrganizationDomain>>, TError, {
|
|
2574
|
+
domainId: string;
|
|
2492
2575
|
}, TContext>;
|
|
2493
2576
|
fetch?: RequestInit;
|
|
2494
|
-
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof
|
|
2495
|
-
|
|
2577
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof deleteOrganizationDomain>>, TError, {
|
|
2578
|
+
domainId: string;
|
|
2496
2579
|
}, TContext>;
|
|
2497
|
-
type
|
|
2498
|
-
data:
|
|
2580
|
+
type reverifyOrganizationDomainResponse200 = {
|
|
2581
|
+
data: OrganizationDomain;
|
|
2499
2582
|
status: 200;
|
|
2500
2583
|
};
|
|
2501
|
-
type
|
|
2502
|
-
data:
|
|
2584
|
+
type reverifyOrganizationDomainResponse403 = {
|
|
2585
|
+
data: ReverifyOrganizationDomain403;
|
|
2503
2586
|
status: 403;
|
|
2504
2587
|
};
|
|
2505
|
-
type
|
|
2588
|
+
type reverifyOrganizationDomainResponse404 = {
|
|
2589
|
+
data: ReverifyOrganizationDomain404;
|
|
2590
|
+
status: 404;
|
|
2591
|
+
};
|
|
2592
|
+
type reverifyOrganizationDomainResponseSuccess = reverifyOrganizationDomainResponse200 & {
|
|
2506
2593
|
headers: Headers;
|
|
2507
2594
|
};
|
|
2508
|
-
type
|
|
2595
|
+
type reverifyOrganizationDomainResponseError = (reverifyOrganizationDomainResponse403 | reverifyOrganizationDomainResponse404) & {
|
|
2509
2596
|
headers: Headers;
|
|
2510
2597
|
};
|
|
2511
|
-
type
|
|
2512
|
-
declare const
|
|
2513
|
-
declare const
|
|
2514
|
-
declare const
|
|
2515
|
-
|
|
2516
|
-
|
|
2598
|
+
type reverifyOrganizationDomainResponse = reverifyOrganizationDomainResponseSuccess | reverifyOrganizationDomainResponseError;
|
|
2599
|
+
declare const getReverifyOrganizationDomainUrl: (domainId: string) => string;
|
|
2600
|
+
declare const reverifyOrganizationDomain: (domainId: string, options?: RequestInit) => Promise<reverifyOrganizationDomainResponse>;
|
|
2601
|
+
declare const getReverifyOrganizationDomainMutationOptions: <TError = ReverifyOrganizationDomain403 | ReverifyOrganizationDomain404, TContext = unknown>(options?: {
|
|
2602
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof reverifyOrganizationDomain>>, TError, {
|
|
2603
|
+
domainId: string;
|
|
2604
|
+
}, TContext>;
|
|
2517
2605
|
fetch?: RequestInit;
|
|
2518
|
-
}) =>
|
|
2606
|
+
}) => UseMutationOptions<Awaited<ReturnType<typeof reverifyOrganizationDomain>>, TError, {
|
|
2607
|
+
domainId: string;
|
|
2608
|
+
}, TContext>;
|
|
2609
|
+
type ReverifyOrganizationDomainMutationResult = NonNullable<Awaited<ReturnType<typeof reverifyOrganizationDomain>>>;
|
|
2610
|
+
type ReverifyOrganizationDomainMutationError = ReverifyOrganizationDomain403 | ReverifyOrganizationDomain404;
|
|
2611
|
+
declare const useReverifyOrganizationDomain: <TError = ReverifyOrganizationDomain403 | ReverifyOrganizationDomain404, TContext = unknown>(options?: {
|
|
2612
|
+
mutation?: UseMutationOptions<Awaited<ReturnType<typeof reverifyOrganizationDomain>>, TError, {
|
|
2613
|
+
domainId: string;
|
|
2614
|
+
}, TContext>;
|
|
2615
|
+
fetch?: RequestInit;
|
|
2616
|
+
}, queryClient?: QueryClient) => UseMutationResult<Awaited<ReturnType<typeof reverifyOrganizationDomain>>, TError, {
|
|
2617
|
+
domainId: string;
|
|
2618
|
+
}, TContext>;
|
|
2619
|
+
type listSsoConnectionsResponse200 = {
|
|
2620
|
+
data: SsoConnection[];
|
|
2621
|
+
status: 200;
|
|
2622
|
+
};
|
|
2623
|
+
type listSsoConnectionsResponseSuccess = listSsoConnectionsResponse200 & {
|
|
2624
|
+
headers: Headers;
|
|
2625
|
+
};
|
|
2626
|
+
type listSsoConnectionsResponse = listSsoConnectionsResponseSuccess;
|
|
2627
|
+
declare const getListSsoConnectionsUrl: () => string;
|
|
2628
|
+
declare const listSsoConnections: (options?: RequestInit) => Promise<listSsoConnectionsResponse>;
|
|
2629
|
+
declare const getListSsoConnectionsQueryKey: () => readonly ["https://api.workos.com/_widgets/admin-portal/sso-connections"];
|
|
2630
|
+
declare const getListSsoConnectionsQueryOptions: <TData = Awaited<ReturnType<typeof listSsoConnections>>, TError = unknown>(options?: {
|
|
2631
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, TData>>;
|
|
2632
|
+
fetch?: RequestInit;
|
|
2633
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, TData> & {
|
|
2519
2634
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2520
2635
|
};
|
|
2521
|
-
type
|
|
2522
|
-
type
|
|
2523
|
-
declare function
|
|
2524
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2636
|
+
type ListSsoConnectionsQueryResult = NonNullable<Awaited<ReturnType<typeof listSsoConnections>>>;
|
|
2637
|
+
type ListSsoConnectionsQueryError = unknown;
|
|
2638
|
+
declare function useListSsoConnections<TData = Awaited<ReturnType<typeof listSsoConnections>>, TError = unknown>(options: {
|
|
2639
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, Awaited<ReturnType<typeof listSsoConnections>>>, "initialData">;
|
|
2525
2640
|
fetch?: RequestInit;
|
|
2526
2641
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2527
2642
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2528
2643
|
};
|
|
2529
|
-
declare function
|
|
2530
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2644
|
+
declare function useListSsoConnections<TData = Awaited<ReturnType<typeof listSsoConnections>>, TError = unknown>(options?: {
|
|
2645
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, Awaited<ReturnType<typeof listSsoConnections>>>, "initialData">;
|
|
2531
2646
|
fetch?: RequestInit;
|
|
2532
2647
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2533
2648
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2534
2649
|
};
|
|
2535
|
-
declare function
|
|
2536
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2650
|
+
declare function useListSsoConnections<TData = Awaited<ReturnType<typeof listSsoConnections>>, TError = unknown>(options?: {
|
|
2651
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listSsoConnections>>, TError, TData>>;
|
|
2537
2652
|
fetch?: RequestInit;
|
|
2538
2653
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2539
2654
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2540
2655
|
};
|
|
2541
|
-
type
|
|
2542
|
-
data:
|
|
2656
|
+
type listDirectoriesResponse200 = {
|
|
2657
|
+
data: DirectoriesResponse;
|
|
2543
2658
|
status: 200;
|
|
2544
2659
|
};
|
|
2545
|
-
type
|
|
2546
|
-
data:
|
|
2547
|
-
status: 400;
|
|
2548
|
-
};
|
|
2549
|
-
type getDataIntegrationAuthorizeUrlResponse403 = {
|
|
2550
|
-
data: GetDataIntegrationAuthorizeUrl403;
|
|
2660
|
+
type listDirectoriesResponse403 = {
|
|
2661
|
+
data: ListDirectories403;
|
|
2551
2662
|
status: 403;
|
|
2552
2663
|
};
|
|
2553
|
-
type
|
|
2554
|
-
data:
|
|
2664
|
+
type listDirectoriesResponse404 = {
|
|
2665
|
+
data: ListDirectories404;
|
|
2555
2666
|
status: 404;
|
|
2556
2667
|
};
|
|
2557
|
-
type
|
|
2668
|
+
type listDirectoriesResponseSuccess = listDirectoriesResponse200 & {
|
|
2558
2669
|
headers: Headers;
|
|
2559
2670
|
};
|
|
2560
|
-
type
|
|
2671
|
+
type listDirectoriesResponseError = (listDirectoriesResponse403 | listDirectoriesResponse404) & {
|
|
2561
2672
|
headers: Headers;
|
|
2562
2673
|
};
|
|
2563
|
-
type
|
|
2564
|
-
declare const
|
|
2565
|
-
declare const
|
|
2566
|
-
declare const
|
|
2567
|
-
declare const
|
|
2568
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2674
|
+
type listDirectoriesResponse = listDirectoriesResponseSuccess | listDirectoriesResponseError;
|
|
2675
|
+
declare const getListDirectoriesUrl: () => string;
|
|
2676
|
+
declare const listDirectories: (options?: RequestInit) => Promise<listDirectoriesResponse>;
|
|
2677
|
+
declare const getListDirectoriesQueryKey: () => readonly ["https://api.workos.com/_widgets/directory-sync/directories"];
|
|
2678
|
+
declare const getListDirectoriesQueryOptions: <TData = Awaited<ReturnType<typeof listDirectories>>, TError = ListDirectories403 | ListDirectories404>(options?: {
|
|
2679
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listDirectories>>, TError, TData>>;
|
|
2569
2680
|
fetch?: RequestInit;
|
|
2570
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof
|
|
2681
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof listDirectories>>, TError, TData> & {
|
|
2571
2682
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2572
2683
|
};
|
|
2573
|
-
type
|
|
2574
|
-
type
|
|
2575
|
-
declare function
|
|
2576
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2684
|
+
type ListDirectoriesQueryResult = NonNullable<Awaited<ReturnType<typeof listDirectories>>>;
|
|
2685
|
+
type ListDirectoriesQueryError = ListDirectories403 | ListDirectories404;
|
|
2686
|
+
declare function useListDirectories<TData = Awaited<ReturnType<typeof listDirectories>>, TError = ListDirectories403 | ListDirectories404>(options: {
|
|
2687
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof listDirectories>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof listDirectories>>, TError, Awaited<ReturnType<typeof listDirectories>>>, "initialData">;
|
|
2577
2688
|
fetch?: RequestInit;
|
|
2578
2689
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2579
2690
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2580
2691
|
};
|
|
2581
|
-
declare function
|
|
2582
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2692
|
+
declare function useListDirectories<TData = Awaited<ReturnType<typeof listDirectories>>, TError = ListDirectories403 | ListDirectories404>(options?: {
|
|
2693
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listDirectories>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof listDirectories>>, TError, Awaited<ReturnType<typeof listDirectories>>>, "initialData">;
|
|
2583
2694
|
fetch?: RequestInit;
|
|
2584
2695
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2585
2696
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2586
2697
|
};
|
|
2587
|
-
declare function
|
|
2588
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2698
|
+
declare function useListDirectories<TData = Awaited<ReturnType<typeof listDirectories>>, TError = ListDirectories403 | ListDirectories404>(options?: {
|
|
2699
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof listDirectories>>, TError, TData>>;
|
|
2589
2700
|
fetch?: RequestInit;
|
|
2590
2701
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2591
2702
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2592
2703
|
};
|
|
2593
|
-
type
|
|
2594
|
-
data:
|
|
2704
|
+
type getDirectoryResponse200 = {
|
|
2705
|
+
data: Directory;
|
|
2595
2706
|
status: 200;
|
|
2596
2707
|
};
|
|
2597
|
-
type
|
|
2598
|
-
data:
|
|
2599
|
-
status: 400;
|
|
2600
|
-
};
|
|
2601
|
-
type getDataInstallationAuthorizationStatusResponse403 = {
|
|
2602
|
-
data: GetDataInstallationAuthorizationStatus403;
|
|
2708
|
+
type getDirectoryResponse403 = {
|
|
2709
|
+
data: GetDirectory403;
|
|
2603
2710
|
status: 403;
|
|
2604
2711
|
};
|
|
2605
|
-
type
|
|
2606
|
-
data:
|
|
2712
|
+
type getDirectoryResponse404 = {
|
|
2713
|
+
data: GetDirectory404;
|
|
2607
2714
|
status: 404;
|
|
2608
2715
|
};
|
|
2609
|
-
type
|
|
2716
|
+
type getDirectoryResponseSuccess = getDirectoryResponse200 & {
|
|
2610
2717
|
headers: Headers;
|
|
2611
2718
|
};
|
|
2612
|
-
type
|
|
2719
|
+
type getDirectoryResponseError = (getDirectoryResponse403 | getDirectoryResponse404) & {
|
|
2613
2720
|
headers: Headers;
|
|
2614
2721
|
};
|
|
2615
|
-
type
|
|
2616
|
-
declare const
|
|
2617
|
-
declare const
|
|
2618
|
-
declare const
|
|
2619
|
-
declare const
|
|
2620
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2722
|
+
type getDirectoryResponse = getDirectoryResponseSuccess | getDirectoryResponseError;
|
|
2723
|
+
declare const getGetDirectoryUrl: (directoryId: string) => string;
|
|
2724
|
+
declare const getDirectory: (directoryId: string, options?: RequestInit) => Promise<getDirectoryResponse>;
|
|
2725
|
+
declare const getGetDirectoryQueryKey: (directoryId: string) => readonly [`https://api.workos.com/_widgets/directory-sync/directories/${string}`];
|
|
2726
|
+
declare const getGetDirectoryQueryOptions: <TData = Awaited<ReturnType<typeof getDirectory>>, TError = GetDirectory403 | GetDirectory404>(directoryId: string, options?: {
|
|
2727
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDirectory>>, TError, TData>>;
|
|
2621
2728
|
fetch?: RequestInit;
|
|
2622
|
-
}) => UseQueryOptions<Awaited<ReturnType<typeof
|
|
2729
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof getDirectory>>, TError, TData> & {
|
|
2623
2730
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2624
2731
|
};
|
|
2625
|
-
type
|
|
2626
|
-
type
|
|
2627
|
-
declare function
|
|
2628
|
-
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2732
|
+
type GetDirectoryQueryResult = NonNullable<Awaited<ReturnType<typeof getDirectory>>>;
|
|
2733
|
+
type GetDirectoryQueryError = GetDirectory403 | GetDirectory404;
|
|
2734
|
+
declare function useGetDirectory<TData = Awaited<ReturnType<typeof getDirectory>>, TError = GetDirectory403 | GetDirectory404>(directoryId: string, options: {
|
|
2735
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDirectory>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof getDirectory>>, TError, Awaited<ReturnType<typeof getDirectory>>>, "initialData">;
|
|
2629
2736
|
fetch?: RequestInit;
|
|
2630
2737
|
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2631
2738
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2632
2739
|
};
|
|
2633
|
-
declare function
|
|
2634
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2740
|
+
declare function useGetDirectory<TData = Awaited<ReturnType<typeof getDirectory>>, TError = GetDirectory403 | GetDirectory404>(directoryId: string, options?: {
|
|
2741
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDirectory>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof getDirectory>>, TError, Awaited<ReturnType<typeof getDirectory>>>, "initialData">;
|
|
2635
2742
|
fetch?: RequestInit;
|
|
2636
2743
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2637
2744
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2638
2745
|
};
|
|
2639
|
-
declare function
|
|
2640
|
-
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof
|
|
2746
|
+
declare function useGetDirectory<TData = Awaited<ReturnType<typeof getDirectory>>, TError = GetDirectory403 | GetDirectory404>(directoryId: string, options?: {
|
|
2747
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof getDirectory>>, TError, TData>>;
|
|
2641
2748
|
fetch?: RequestInit;
|
|
2642
2749
|
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2643
2750
|
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2644
2751
|
};
|
|
2645
|
-
|
|
2646
|
-
|
|
2752
|
+
/**
|
|
2753
|
+
* Returns the widget settings for the current environment, including enabled authentication methods and branding configuration.
|
|
2754
|
+
*/
|
|
2755
|
+
type settingsResponse200 = {
|
|
2756
|
+
data: SettingsResponse;
|
|
2647
2757
|
status: 200;
|
|
2648
2758
|
};
|
|
2649
|
-
type
|
|
2650
|
-
data:
|
|
2759
|
+
type settingsResponse403 = {
|
|
2760
|
+
data: Settings403;
|
|
2651
2761
|
status: 403;
|
|
2652
2762
|
};
|
|
2653
|
-
type
|
|
2654
|
-
data: DeleteDataInstallation404;
|
|
2655
|
-
status: 404;
|
|
2656
|
-
};
|
|
2657
|
-
type deleteDataInstallationResponseSuccess = deleteDataInstallationResponse200 & {
|
|
2763
|
+
type settingsResponseSuccess = settingsResponse200 & {
|
|
2658
2764
|
headers: Headers;
|
|
2659
2765
|
};
|
|
2660
|
-
type
|
|
2766
|
+
type settingsResponseError = settingsResponse403 & {
|
|
2661
2767
|
headers: Headers;
|
|
2662
2768
|
};
|
|
2663
|
-
type
|
|
2664
|
-
declare const
|
|
2665
|
-
declare const
|
|
2666
|
-
declare const
|
|
2667
|
-
|
|
2668
|
-
|
|
2669
|
-
}, TContext>;
|
|
2769
|
+
type settingsResponse = settingsResponseSuccess | settingsResponseError;
|
|
2770
|
+
declare const getSettingsUrl: () => string;
|
|
2771
|
+
declare const settings: (options?: RequestInit) => Promise<settingsResponse>;
|
|
2772
|
+
declare const getSettingsQueryKey: () => readonly ["https://api.workos.com/_widgets/settings"];
|
|
2773
|
+
declare const getSettingsQueryOptions: <TData = Awaited<ReturnType<typeof settings>>, TError = Settings403>(options?: {
|
|
2774
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData>>;
|
|
2670
2775
|
fetch?: RequestInit;
|
|
2671
|
-
}) =>
|
|
2672
|
-
|
|
2673
|
-
}
|
|
2674
|
-
type
|
|
2675
|
-
type
|
|
2676
|
-
declare
|
|
2677
|
-
|
|
2678
|
-
installationId: string;
|
|
2679
|
-
}, TContext>;
|
|
2776
|
+
}) => UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData> & {
|
|
2777
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2778
|
+
};
|
|
2779
|
+
type SettingsQueryResult = NonNullable<Awaited<ReturnType<typeof settings>>>;
|
|
2780
|
+
type SettingsQueryError = Settings403;
|
|
2781
|
+
declare function useSettings<TData = Awaited<ReturnType<typeof settings>>, TError = Settings403>(options: {
|
|
2782
|
+
query: Partial<UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof settings>>, TError, Awaited<ReturnType<typeof settings>>>, "initialData">;
|
|
2680
2783
|
fetch?: RequestInit;
|
|
2681
|
-
}, queryClient?: QueryClient)
|
|
2682
|
-
|
|
2683
|
-
}
|
|
2784
|
+
}, queryClient?: QueryClient): DefinedUseQueryResult<TData, TError> & {
|
|
2785
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2786
|
+
};
|
|
2787
|
+
declare function useSettings<TData = Awaited<ReturnType<typeof settings>>, TError = Settings403>(options?: {
|
|
2788
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof settings>>, TError, Awaited<ReturnType<typeof settings>>>, "initialData">;
|
|
2789
|
+
fetch?: RequestInit;
|
|
2790
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2791
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2792
|
+
};
|
|
2793
|
+
declare function useSettings<TData = Awaited<ReturnType<typeof settings>>, TError = Settings403>(options?: {
|
|
2794
|
+
query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof settings>>, TError, TData>>;
|
|
2795
|
+
fetch?: RequestInit;
|
|
2796
|
+
}, queryClient?: QueryClient): UseQueryResult<TData, TError> & {
|
|
2797
|
+
queryKey: DataTag<QueryKey, TData, TError>;
|
|
2798
|
+
};
|
|
2684
2799
|
|
|
2685
|
-
export { type ActiveSession, type ActiveSessionCurrentLocation, type ActiveSessionState, type ActiveSessionsResponse, type AuthenticationInformation403, type AuthenticationInformationQueryError, type AuthenticationInformationQueryResult, type AuthenticationInformationResponse, type AuthenticationInformationResponseData, type AuthenticationInformationResponseDataPasswordSettings, type AuthenticationInformationResponseDataVerificationMethods, type AuthenticationInformationResponseDataVerificationMethodsMfa, AuthenticationInformationResponseDataVerificationMethodsMfaProvider, type AuthenticationInformationResponseDataVerificationMethodsPasskey, type AuthenticationInformationResponseDataVerificationMethodsPasskeyPassKeysItem, AuthenticationInformationResponseDataVerificationMethodsPasskeyProvider, type AuthenticationInformationResponseDataVerificationMethodsPassword, AuthenticationInformationResponseDataVerificationMethodsPasswordProvider, type CreateOrganizationApiKey400, type CreateOrganizationApiKey403, type CreateOrganizationApiKey404, type CreateOrganizationApiKey422, type CreateOrganizationApiKey422ErrorsItem, type CreateOrganizationApiKeyMutationBody, type CreateOrganizationApiKeyMutationError, type CreateOrganizationApiKeyMutationResult, type CreateOrganizationApiKeyRequest, type CreateOrganizationApiKeyResponse, type CreatePassword201, type CreatePassword400, type CreatePassword403, type CreatePasswordMutationBody, type CreatePasswordMutationError, type CreatePasswordMutationResult, type CreatePasswordRequest, type CreateTotpFactor400, type CreateTotpFactor403, type CreateTotpFactorMutationError, type CreateTotpFactorMutationResult, type CreateTotpFactorResponse, type CreateTotpFactorResponseAuthenticationChallenge, type CreateTotpFactorResponseAuthenticationChallengeAllOf, CreateTotpFactorResponseAuthenticationChallengeAllOfObject, type CreateTotpFactorResponseAuthenticationChallengeAllOfThree, type CreateTotpFactorResponseAuthenticationFactor, type CreateTotpFactorResponseAuthenticationFactorAllOf, type CreateTotpFactorResponseAuthenticationFactorAllOfEight, CreateTotpFactorResponseAuthenticationFactorAllOfObject, type CreateTotpFactorResponseAuthenticationFactorAllOfSms, type CreateTotpFactorResponseAuthenticationFactorAllOfTotp, type CreateTotpFactorResponseAuthenticationFactorAllOfTotpAnyOf, type CreateTotpFactorResponseAuthenticationFactorAllOfTotpAnyOfTwo, CreateTotpFactorResponseAuthenticationFactorAllOfType, type DataInstallation, DataInstallationObject, DataInstallationState, type DataIntegration, DataIntegrationCredentialsType, type DataIntegrationInstallation, DataIntegrationIntegrationType, DataIntegrationObject, DataIntegrationOwnership, type DataIntegrationsResponse, type DeleteDataInstallation200, type DeleteDataInstallation403, type DeleteDataInstallation404, type DeleteDataInstallationMutationError, type DeleteDataInstallationMutationResult, type DeleteOrganizationApiKey200, type DeleteOrganizationApiKey403, type DeleteOrganizationApiKey404, type DeleteOrganizationApiKeyMutationError, type DeleteOrganizationApiKeyMutationResult, type DeleteOrganizationDomain403, type DeleteOrganizationDomain404, type DeleteOrganizationDomainMutationError, type DeleteOrganizationDomainMutationResult, type DeletePasskey200, type DeletePasskey400, type DeletePasskey403, type DeletePasskeyMutationError, type DeletePasskeyMutationResult, type DeleteTotpFactors200, type DeleteTotpFactors400, type DeleteTotpFactors403, type DeleteTotpFactorsMutationError, type DeleteTotpFactorsMutationResult, DomainVerificationNameServer, type GenerateAdminPortalLink201, type GenerateAdminPortalLink403, type GenerateAdminPortalLink404, type GenerateAdminPortalLink500, GenerateAdminPortalLinkIntent, type GenerateAdminPortalLinkMutationError, type GenerateAdminPortalLinkMutationResult, type GenerateAdminPortalLinkParams, type GetAuthorizationStatusResponse, type GetDataInstallationAuthorizationStatus400, type GetDataInstallationAuthorizationStatus403, type GetDataInstallationAuthorizationStatus404, type GetDataInstallationAuthorizationStatusQueryError, type GetDataInstallationAuthorizationStatusQueryResult, type GetDataIntegrationAuthorizeUrl400, type GetDataIntegrationAuthorizeUrl403, type GetDataIntegrationAuthorizeUrl404, type GetDataIntegrationAuthorizeUrlParams, type GetDataIntegrationAuthorizeUrlQueryError, type GetDataIntegrationAuthorizeUrlQueryResult, type GetDataIntegrationAuthorizeUrlResponse, type GetDataIntegrationAuthorizeUrlResponseAllOf, type GetDataIntegrationAuthorizeUrlResponseAllOfTwo, type InviteMember201, type InviteMember400, type InviteMember403, type InviteMember404, type InviteMemberBody, type InviteMemberMutationBody, type InviteMemberMutationError, type InviteMemberMutationResult, type ListMetadata, type ListOrganizationApiKeyPermission, type ListOrganizationApiKeyPermissions400, type ListOrganizationApiKeyPermissions403, type ListOrganizationApiKeyPermissionsParams, type ListOrganizationApiKeyPermissionsQueryError, type ListOrganizationApiKeyPermissionsQueryResult, type ListOrganizationApiKeyPermissionsResponse, type ListOrganizationApiKeyPermissionsResponseListMetadata, type ListOrganizationApiKeys400, type ListOrganizationApiKeys403, type ListOrganizationApiKeysParams, type ListOrganizationApiKeysQueryError, type ListOrganizationApiKeysQueryResult, type ListOrganizationApiKeysResponse, type ListOrganizationApiKeysResponseData, type ListOrganizationApiKeysResponseListMetadata, type ListOrganizationDomains200, type ListOrganizationDomains403, type ListOrganizationDomains404, type ListOrganizationDomainsQueryError, type ListOrganizationDomainsQueryResult, type ListSsoConnectionsQueryError, type ListSsoConnectionsQueryResult, type Me, type Me403, type MeOauthProfiles, type MeQueryError, type MeQueryResult, type Member, type MemberActions, MemberActionsItem, type MemberRole, type MemberRolesItem, MemberStatus, type Members200, type Members403, type Members404, type MembersParams, type MembersQueryError, type MembersQueryResult, type MyDataIntegrations403, type MyDataIntegrationsQueryError, type MyDataIntegrationsQueryResult, type OAuthProfile, OidcSessionState, type OrganizationDomain, OrganizationDomainState, type OrganizationInfo, type Organizations403, type Organizations404, type OrganizationsQueryError, type OrganizationsQueryResult, type OrganizationsResponse, type RegisterPasskey400, type RegisterPasskey403, type RegisterPasskeyMutationError, type RegisterPasskeyMutationResult, type RegisterPasskeyResponse, type RegisterPasskeyResponseOptions, type RemoveMember200, type RemoveMember400, type RemoveMember403, type RemoveMember404, type RemoveMemberMutationError, type RemoveMemberMutationResult, type ResendInvite201, type ResendInvite400, type ResendInvite403, type ResendInvite404, type ResendInvite422, type ResendInviteMutationError, type ResendInviteMutationResult, type ReverifyOrganizationDomain403, type ReverifyOrganizationDomain404, type ReverifyOrganizationDomainMutationError, type ReverifyOrganizationDomainMutationResult, type RevokeAllSessions200, type RevokeAllSessions400, type RevokeAllSessions403, type RevokeAllSessionsMutationBody, type RevokeAllSessionsMutationError, type RevokeAllSessionsMutationResult, type RevokeAllSessionsRequest, type RevokeInvite200, type RevokeInvite400, type RevokeInvite403, type RevokeInvite404, type RevokeInviteMutationError, type RevokeInviteMutationResult, type RevokeSession200, type RevokeSession400, type RevokeSession403, type RevokeSessionMutationError, type RevokeSessionMutationResult, type Roles403, type Roles404, type RolesAndConfig403, type RolesAndConfig404, type RolesAndConfigQueryError, type RolesAndConfigQueryResult, type RolesAndConfigResponse, type RolesQueryError, type RolesQueryResult, SamlSessionState, type SendVerification400, type SendVerification403, type SendVerificationMutationError, type SendVerificationMutationResult, type SendVerificationResponse, SendVerificationResponseType, type Sessions403, type SessionsQueryError, type SessionsQueryResult, type Settings403, type SettingsQueryError, type SettingsQueryResult, type SettingsResponse, SettingsResponseObject, type SsoConnection, type SsoConnectionAnyOf, type SsoConnectionAnyOfEight, type SsoConnectionAnyOfEightAllOf, type SsoConnectionAnyOfEightAllOfLastSession, SsoConnectionAnyOfEightAllOfProviderTag, type SsoConnectionAnyOfEightAllOfSix, SsoConnectionAnyOfEightAllOfState, SsoConnectionAnyOfEightAllOfType, type SsoConnectionAnyOfLastSession, type SsoConnectionAnyOfLatestExpiredCertificate, type SsoConnectionAnyOfLatestExpiringCertificate, SsoConnectionAnyOfProviderTag, SsoConnectionAnyOfState, SsoConnectionAnyOfType, type SsoConnectionSessionJSON, SsoConnectionSessionJSONState, type UpdateMe400, type UpdateMe403, type UpdateMeBody, type UpdateMeMutationBody, type UpdateMeMutationError, type UpdateMeMutationResult, type UpdateMember200, type UpdateMember400, type UpdateMember403, type UpdateMember404, type UpdateMember422, type UpdateMemberBody, type UpdateMemberMutationBody, type UpdateMemberMutationError, type UpdateMemberMutationResult, type UpdatePassword201, type UpdatePassword400, type UpdatePassword403, type UpdatePasswordMutationBody, type UpdatePasswordMutationError, type UpdatePasswordMutationResult, type UpdatePasswordRequest, type Verify400, type Verify403, type VerifyMutationBody, type VerifyMutationError, type VerifyMutationResult, type VerifyPasskey200, type VerifyPasskey400, type VerifyPasskey403, type VerifyPasskeyMutationBody, type VerifyPasskeyMutationError, type VerifyPasskeyMutationResult, type VerifyPasskeyRequest, type VerifyPasskeyRequestResponse, type VerifyRequest, type VerifyResponse, type VerifyTotpFactor200, type VerifyTotpFactor400, type VerifyTotpFactor403, type VerifyTotpFactorMutationBody, type VerifyTotpFactorMutationError, type VerifyTotpFactorMutationResult, type VerifyTotpFactorRequest, type X509CertificateJSON, authenticationInformation, type authenticationInformationResponse, type authenticationInformationResponse200, type authenticationInformationResponse403, type authenticationInformationResponseError, type authenticationInformationResponseSuccess, createOrganizationApiKey, type createOrganizationApiKeyResponse, type createOrganizationApiKeyResponse201, type createOrganizationApiKeyResponse400, type createOrganizationApiKeyResponse403, type createOrganizationApiKeyResponse404, type createOrganizationApiKeyResponse422, type createOrganizationApiKeyResponseError, type createOrganizationApiKeyResponseSuccess, createPassword, type createPasswordResponse, type createPasswordResponse201, type createPasswordResponse400, type createPasswordResponse403, type createPasswordResponseError, type createPasswordResponseSuccess, createTotpFactor, type createTotpFactorResponse, type createTotpFactorResponse201, type createTotpFactorResponse400, type createTotpFactorResponse403, type createTotpFactorResponseError, type createTotpFactorResponseSuccess, deleteDataInstallation, type deleteDataInstallationResponse, type deleteDataInstallationResponse200, type deleteDataInstallationResponse403, type deleteDataInstallationResponse404, type deleteDataInstallationResponseError, type deleteDataInstallationResponseSuccess, deleteOrganizationApiKey, type deleteOrganizationApiKeyResponse, type deleteOrganizationApiKeyResponse200, type deleteOrganizationApiKeyResponse403, type deleteOrganizationApiKeyResponse404, type deleteOrganizationApiKeyResponseError, type deleteOrganizationApiKeyResponseSuccess, deleteOrganizationDomain, type deleteOrganizationDomainResponse, type deleteOrganizationDomainResponse200, type deleteOrganizationDomainResponse403, type deleteOrganizationDomainResponse404, type deleteOrganizationDomainResponseError, type deleteOrganizationDomainResponseSuccess, deletePasskey, type deletePasskeyResponse, type deletePasskeyResponse200, type deletePasskeyResponse400, type deletePasskeyResponse403, type deletePasskeyResponseError, type deletePasskeyResponseSuccess, deleteTotpFactors, type deleteTotpFactorsResponse, type deleteTotpFactorsResponse200, type deleteTotpFactorsResponse400, type deleteTotpFactorsResponse403, type deleteTotpFactorsResponseError, type deleteTotpFactorsResponseSuccess, generateAdminPortalLink, type generateAdminPortalLinkResponse, type generateAdminPortalLinkResponse201, type generateAdminPortalLinkResponse403, type generateAdminPortalLinkResponse404, type generateAdminPortalLinkResponse500, type generateAdminPortalLinkResponseError, type generateAdminPortalLinkResponseSuccess, getAuthenticationInformationQueryKey, getAuthenticationInformationQueryOptions, getAuthenticationInformationUrl, getCreateOrganizationApiKeyMutationOptions, getCreateOrganizationApiKeyUrl, getCreatePasswordMutationOptions, getCreatePasswordUrl, getCreateTotpFactorMutationOptions, getCreateTotpFactorUrl, getDataInstallationAuthorizationStatus, type getDataInstallationAuthorizationStatusResponse, type getDataInstallationAuthorizationStatusResponse200, type getDataInstallationAuthorizationStatusResponse400, type getDataInstallationAuthorizationStatusResponse403, type getDataInstallationAuthorizationStatusResponse404, type getDataInstallationAuthorizationStatusResponseError, type getDataInstallationAuthorizationStatusResponseSuccess, getDataIntegrationAuthorizeUrl, type getDataIntegrationAuthorizeUrlResponse, type getDataIntegrationAuthorizeUrlResponse200, type getDataIntegrationAuthorizeUrlResponse400, type getDataIntegrationAuthorizeUrlResponse403, type getDataIntegrationAuthorizeUrlResponse404, type getDataIntegrationAuthorizeUrlResponseError, type getDataIntegrationAuthorizeUrlResponseSuccess, getDeleteDataInstallationMutationOptions, getDeleteDataInstallationUrl, getDeleteOrganizationApiKeyMutationOptions, getDeleteOrganizationApiKeyUrl, getDeleteOrganizationDomainMutationOptions, getDeleteOrganizationDomainUrl, getDeletePasskeyMutationOptions, getDeletePasskeyUrl, getDeleteTotpFactorsMutationOptions, getDeleteTotpFactorsUrl, getGenerateAdminPortalLinkMutationOptions, getGenerateAdminPortalLinkUrl, getGetDataInstallationAuthorizationStatusQueryKey, getGetDataInstallationAuthorizationStatusQueryOptions, getGetDataInstallationAuthorizationStatusUrl, getGetDataIntegrationAuthorizeUrlQueryKey, getGetDataIntegrationAuthorizeUrlQueryOptions, getGetDataIntegrationAuthorizeUrlUrl, getInviteMemberMutationOptions, getInviteMemberUrl, getListOrganizationApiKeyPermissionsQueryKey, getListOrganizationApiKeyPermissionsQueryOptions, getListOrganizationApiKeyPermissionsUrl, getListOrganizationApiKeysQueryKey, getListOrganizationApiKeysQueryOptions, getListOrganizationApiKeysUrl, getListOrganizationDomainsQueryKey, getListOrganizationDomainsQueryOptions, getListOrganizationDomainsUrl, getListSsoConnectionsQueryKey, getListSsoConnectionsQueryOptions, getListSsoConnectionsUrl, getMeQueryKey, getMeQueryOptions, getMeUrl, getMembersQueryKey, getMembersQueryOptions, getMembersUrl, getMyDataIntegrationsQueryKey, getMyDataIntegrationsQueryOptions, getMyDataIntegrationsUrl, getOrganizationsQueryKey, getOrganizationsQueryOptions, getOrganizationsUrl, getRegisterPasskeyMutationOptions, getRegisterPasskeyUrl, getRemoveMemberMutationOptions, getRemoveMemberUrl, getResendInviteMutationOptions, getResendInviteUrl, getReverifyOrganizationDomainMutationOptions, getReverifyOrganizationDomainUrl, getRevokeAllSessionsMutationOptions, getRevokeAllSessionsUrl, getRevokeInviteMutationOptions, getRevokeInviteUrl, getRevokeSessionMutationOptions, getRevokeSessionUrl, getRolesAndConfigQueryKey, getRolesAndConfigQueryOptions, getRolesAndConfigUrl, getRolesQueryKey, getRolesQueryOptions, getRolesUrl, getSendVerificationMutationOptions, getSendVerificationUrl, getSessionsQueryKey, getSessionsQueryOptions, getSessionsUrl, getSettingsQueryKey, getSettingsQueryOptions, getSettingsUrl, getUpdateMeMutationOptions, getUpdateMeUrl, getUpdateMemberMutationOptions, getUpdateMemberUrl, getUpdatePasswordMutationOptions, getUpdatePasswordUrl, getVerifyMutationOptions, getVerifyPasskeyMutationOptions, getVerifyPasskeyUrl, getVerifyTotpFactorMutationOptions, getVerifyTotpFactorUrl, getVerifyUrl, inviteMember, type inviteMemberResponse, type inviteMemberResponse201, type inviteMemberResponse400, type inviteMemberResponse403, type inviteMemberResponse404, type inviteMemberResponseError, type inviteMemberResponseSuccess, listOrganizationApiKeyPermissions, type listOrganizationApiKeyPermissionsResponse, type listOrganizationApiKeyPermissionsResponse200, type listOrganizationApiKeyPermissionsResponse400, type listOrganizationApiKeyPermissionsResponse403, type listOrganizationApiKeyPermissionsResponseError, type listOrganizationApiKeyPermissionsResponseSuccess, listOrganizationApiKeys, type listOrganizationApiKeysResponse, type listOrganizationApiKeysResponse200, type listOrganizationApiKeysResponse400, type listOrganizationApiKeysResponse403, type listOrganizationApiKeysResponseError, type listOrganizationApiKeysResponseSuccess, listOrganizationDomains, type listOrganizationDomainsResponse, type listOrganizationDomainsResponse200, type listOrganizationDomainsResponse403, type listOrganizationDomainsResponse404, type listOrganizationDomainsResponseError, type listOrganizationDomainsResponseSuccess, listSsoConnections, type listSsoConnectionsResponse, type listSsoConnectionsResponse200, type listSsoConnectionsResponseSuccess, me, type meResponse, type meResponse200, type meResponse403, type meResponseError, type meResponseSuccess, members, type membersResponse, type membersResponse200, type membersResponse403, type membersResponse404, type membersResponseError, type membersResponseSuccess, myDataIntegrations, type myDataIntegrationsResponse, type myDataIntegrationsResponse200, type myDataIntegrationsResponse403, type myDataIntegrationsResponseError, type myDataIntegrationsResponseSuccess, organizations, type organizationsResponse, type organizationsResponse200, type organizationsResponse403, type organizationsResponse404, type organizationsResponseError, type organizationsResponseSuccess, registerPasskey, type registerPasskeyResponse, type registerPasskeyResponse201, type registerPasskeyResponse400, type registerPasskeyResponse403, type registerPasskeyResponseError, type registerPasskeyResponseSuccess, removeMember, type removeMemberResponse, type removeMemberResponse200, type removeMemberResponse400, type removeMemberResponse403, type removeMemberResponse404, type removeMemberResponseError, type removeMemberResponseSuccess, resendInvite, type resendInviteResponse, type resendInviteResponse201, type resendInviteResponse400, type resendInviteResponse403, type resendInviteResponse404, type resendInviteResponse422, type resendInviteResponseError, type resendInviteResponseSuccess, reverifyOrganizationDomain, type reverifyOrganizationDomainResponse, type reverifyOrganizationDomainResponse200, type reverifyOrganizationDomainResponse403, type reverifyOrganizationDomainResponse404, type reverifyOrganizationDomainResponseError, type reverifyOrganizationDomainResponseSuccess, revokeAllSessions, type revokeAllSessionsResponse, type revokeAllSessionsResponse200, type revokeAllSessionsResponse400, type revokeAllSessionsResponse403, type revokeAllSessionsResponseError, type revokeAllSessionsResponseSuccess, revokeInvite, type revokeInviteResponse, type revokeInviteResponse200, type revokeInviteResponse400, type revokeInviteResponse403, type revokeInviteResponse404, type revokeInviteResponseError, type revokeInviteResponseSuccess, revokeSession, type revokeSessionResponse, type revokeSessionResponse200, type revokeSessionResponse400, type revokeSessionResponse403, type revokeSessionResponseError, type revokeSessionResponseSuccess, roles, rolesAndConfig, type rolesAndConfigResponse, type rolesAndConfigResponse200, type rolesAndConfigResponse403, type rolesAndConfigResponse404, type rolesAndConfigResponseError, type rolesAndConfigResponseSuccess, type rolesResponse, type rolesResponse200, type rolesResponse403, type rolesResponse404, type rolesResponseError, type rolesResponseSuccess, sendVerification, type sendVerificationResponse, type sendVerificationResponse200, type sendVerificationResponse400, type sendVerificationResponse403, type sendVerificationResponseError, type sendVerificationResponseSuccess, sessions, type sessionsResponse, type sessionsResponse200, type sessionsResponse403, type sessionsResponseError, type sessionsResponseSuccess, settings, type settingsResponse, type settingsResponse200, type settingsResponse403, type settingsResponseError, type settingsResponseSuccess, updateMe, type updateMeResponse, type updateMeResponse200, type updateMeResponse400, type updateMeResponse403, type updateMeResponseError, type updateMeResponseSuccess, updateMember, type updateMemberResponse, type updateMemberResponse200, type updateMemberResponse400, type updateMemberResponse403, type updateMemberResponse404, type updateMemberResponse422, type updateMemberResponseError, type updateMemberResponseSuccess, updatePassword, type updatePasswordResponse, type updatePasswordResponse201, type updatePasswordResponse400, type updatePasswordResponse403, type updatePasswordResponseError, type updatePasswordResponseSuccess, useAuthenticationInformation, useCreateOrganizationApiKey, useCreatePassword, useCreateTotpFactor, useDeleteDataInstallation, useDeleteOrganizationApiKey, useDeleteOrganizationDomain, useDeletePasskey, useDeleteTotpFactors, useGenerateAdminPortalLink, useGetDataInstallationAuthorizationStatus, useGetDataIntegrationAuthorizeUrl, useInviteMember, useListOrganizationApiKeyPermissions, useListOrganizationApiKeys, useListOrganizationDomains, useListSsoConnections, useMe, useMembers, useMyDataIntegrations, useOrganizations, useRegisterPasskey, useRemoveMember, useResendInvite, useReverifyOrganizationDomain, useRevokeAllSessions, useRevokeInvite, useRevokeSession, useRoles, useRolesAndConfig, useSendVerification, useSessions, useSettings, useUpdateMe, useUpdateMember, useUpdatePassword, useVerify, useVerifyPasskey, useVerifyTotpFactor, verify, verifyPasskey, type verifyPasskeyResponse, type verifyPasskeyResponse200, type verifyPasskeyResponse400, type verifyPasskeyResponse403, type verifyPasskeyResponseError, type verifyPasskeyResponseSuccess, type verifyResponse, type verifyResponse200, type verifyResponse400, type verifyResponse403, type verifyResponseError, type verifyResponseSuccess, verifyTotpFactor, type verifyTotpFactorResponse, type verifyTotpFactorResponse200, type verifyTotpFactorResponse400, type verifyTotpFactorResponse403, type verifyTotpFactorResponseError, type verifyTotpFactorResponseSuccess };
|
|
2800
|
+
export { type ActiveSession, type ActiveSessionCurrentLocation, type ActiveSessionState, type ActiveSessionsResponse, type AuditLogStreamJSON, type AuditLogStreamState, type AuditLogStreamType, type AuthenticationInformation403, type AuthenticationInformationQueryError, type AuthenticationInformationQueryResult, type AuthenticationInformationResponse, type AuthenticationInformationResponseData, type AuthenticationInformationResponseDataPasswordSettings, type AuthenticationInformationResponseDataVerificationMethods, type AuthenticationInformationResponseDataVerificationMethodsMfa, type AuthenticationInformationResponseDataVerificationMethodsPasskey, type AuthenticationInformationResponseDataVerificationMethodsPassword, type CreateOrganizationApiKey400, type CreateOrganizationApiKey403, type CreateOrganizationApiKey404, type CreateOrganizationApiKey422, type CreateOrganizationApiKey422ErrorsItem, type CreateOrganizationApiKeyMutationBody, type CreateOrganizationApiKeyMutationError, type CreateOrganizationApiKeyMutationResult, type CreateOrganizationApiKeyRequest, type CreateOrganizationApiKeyResponse, type CreatePassword201, type CreatePassword400, type CreatePassword403, type CreatePasswordMutationBody, type CreatePasswordMutationError, type CreatePasswordMutationResult, type CreatePasswordRequest, type CreateTotpFactor400, type CreateTotpFactor403, type CreateTotpFactorMutationError, type CreateTotpFactorMutationResult, type CreateTotpFactorResponse, type CreateTotpFactorResponseAuthenticationChallenge, type CreateTotpFactorResponseAuthenticationFactor, type DataInstallation, type DataIntegration, type DataIntegrationsResponse, type DeleteDataInstallation200, type DeleteDataInstallation403, type DeleteDataInstallation404, type DeleteDataInstallationMutationError, type DeleteDataInstallationMutationResult, type DeleteOrganizationApiKey200, type DeleteOrganizationApiKey403, type DeleteOrganizationApiKey404, type DeleteOrganizationApiKeyMutationError, type DeleteOrganizationApiKeyMutationResult, type DeleteOrganizationDomain403, type DeleteOrganizationDomain404, type DeleteOrganizationDomainMutationError, type DeleteOrganizationDomainMutationResult, type DeletePasskey200, type DeletePasskey400, type DeletePasskey403, type DeletePasskeyMutationError, type DeletePasskeyMutationResult, type DeleteTotpFactors200, type DeleteTotpFactors400, type DeleteTotpFactors403, type DeleteTotpFactorsMutationError, type DeleteTotpFactorsMutationResult, type DirectoriesResponse, type Directory, type DirectoryMetadata, DirectoryState, DirectoryType, type DirectoryUsersMetadata, DomainVerificationNameServer, type GenerateAdminPortalLink201, type GenerateAdminPortalLink403, type GenerateAdminPortalLink404, type GenerateAdminPortalLink500, GenerateAdminPortalLinkIntent, type GenerateAdminPortalLinkMutationError, type GenerateAdminPortalLinkMutationResult, type GenerateAdminPortalLinkParams, type GetAuditLogStream200, type GetAuditLogStream403, type GetAuditLogStreamQueryError, type GetAuditLogStreamQueryResult, type GetAuthorizationStatusResponse, type GetDataInstallationAuthorizationStatus400, type GetDataInstallationAuthorizationStatus403, type GetDataInstallationAuthorizationStatus404, type GetDataInstallationAuthorizationStatusQueryError, type GetDataInstallationAuthorizationStatusQueryResult, type GetDataIntegrationAuthorizeUrl400, type GetDataIntegrationAuthorizeUrl403, type GetDataIntegrationAuthorizeUrl404, type GetDataIntegrationAuthorizeUrlParams, type GetDataIntegrationAuthorizeUrlQueryError, type GetDataIntegrationAuthorizeUrlQueryResult, type GetDataIntegrationAuthorizeUrlResponse, type GetDirectory403, type GetDirectory404, type GetDirectoryQueryError, type GetDirectoryQueryResult, type InviteMember201, type InviteMember400, type InviteMember403, type InviteMember404, type InviteMemberBody, type InviteMemberMutationBody, type InviteMemberMutationError, type InviteMemberMutationResult, type ListDirectories403, type ListDirectories404, type ListDirectoriesQueryError, type ListDirectoriesQueryResult, type ListMetadata, type ListOrganizationApiKeyPermission, type ListOrganizationApiKeyPermissions400, type ListOrganizationApiKeyPermissions403, type ListOrganizationApiKeyPermissionsParams, type ListOrganizationApiKeyPermissionsQueryError, type ListOrganizationApiKeyPermissionsQueryResult, type ListOrganizationApiKeyPermissionsResponse, type ListOrganizationApiKeyPermissionsResponseListMetadata, type ListOrganizationApiKeys400, type ListOrganizationApiKeys403, type ListOrganizationApiKeysParams, type ListOrganizationApiKeysQueryError, type ListOrganizationApiKeysQueryResult, type ListOrganizationApiKeysResponse, type ListOrganizationApiKeysResponseData, type ListOrganizationApiKeysResponseListMetadata, type ListOrganizationDomains200, type ListOrganizationDomains403, type ListOrganizationDomains404, type ListOrganizationDomainsQueryError, type ListOrganizationDomainsQueryResult, type ListSsoConnectionsQueryError, type ListSsoConnectionsQueryResult, type Me, type Me403, type MeOauthProfiles, type MeQueryError, type MeQueryResult, type Member, type MemberActions, MemberActionsItem, type MemberRole, type MemberRoles, MemberStatus, type Members200, type Members403, type Members404, type MembersParams, type MembersQueryError, type MembersQueryResult, type MyDataIntegrations403, type MyDataIntegrationsQueryError, type MyDataIntegrationsQueryResult, type OAuthProfile, OidcSessionState, type OrganizationDomain, OrganizationDomainState, type OrganizationInfo, type Organizations403, type Organizations404, type OrganizationsQueryError, type OrganizationsQueryResult, type OrganizationsResponse, type RegisterPasskey400, type RegisterPasskey403, type RegisterPasskeyMutationError, type RegisterPasskeyMutationResult, type RegisterPasskeyResponse, type RegisterPasskeyResponseOptions, type RemoveMember200, type RemoveMember400, type RemoveMember403, type RemoveMember404, type RemoveMemberMutationError, type RemoveMemberMutationResult, type ResendInvite201, type ResendInvite400, type ResendInvite403, type ResendInvite404, type ResendInvite422, type ResendInviteMutationError, type ResendInviteMutationResult, type ReverifyOrganizationDomain403, type ReverifyOrganizationDomain404, type ReverifyOrganizationDomainMutationError, type ReverifyOrganizationDomainMutationResult, type RevokeAllSessions200, type RevokeAllSessions400, type RevokeAllSessions403, type RevokeAllSessionsMutationBody, type RevokeAllSessionsMutationError, type RevokeAllSessionsMutationResult, type RevokeAllSessionsRequest, type RevokeInvite200, type RevokeInvite400, type RevokeInvite403, type RevokeInvite404, type RevokeInviteMutationError, type RevokeInviteMutationResult, type RevokeSession200, type RevokeSession400, type RevokeSession403, type RevokeSessionMutationError, type RevokeSessionMutationResult, type Roles403, type Roles404, type RolesAndConfig403, type RolesAndConfig404, type RolesAndConfigQueryError, type RolesAndConfigQueryResult, type RolesAndConfigResponse, type RolesQueryError, type RolesQueryResult, SamlSessionState, type SendVerification400, type SendVerification403, type SendVerificationMutationError, type SendVerificationMutationResult, type SendVerificationResponse, type Sessions403, type SessionsQueryError, type SessionsQueryResult, type Settings403, type SettingsQueryError, type SettingsQueryResult, type SettingsResponse, type SsoConnection, type SsoConnectionSessionJSON, SsoConnectionSessionJSONState, type UpdateMe400, type UpdateMe403, type UpdateMeBody, type UpdateMeMutationBody, type UpdateMeMutationError, type UpdateMeMutationResult, type UpdateMember200, type UpdateMember400, type UpdateMember403, type UpdateMember404, type UpdateMember422, type UpdateMemberBody, type UpdateMemberMutationBody, type UpdateMemberMutationError, type UpdateMemberMutationResult, type UpdatePassword201, type UpdatePassword400, type UpdatePassword403, type UpdatePasswordMutationBody, type UpdatePasswordMutationError, type UpdatePasswordMutationResult, type UpdatePasswordRequest, type Verify400, type Verify403, type VerifyMutationBody, type VerifyMutationError, type VerifyMutationResult, type VerifyPasskey200, type VerifyPasskey400, type VerifyPasskey403, type VerifyPasskeyMutationBody, type VerifyPasskeyMutationError, type VerifyPasskeyMutationResult, type VerifyPasskeyRequest, type VerifyPasskeyRequestResponse, type VerifyRequest, type VerifyResponse, type VerifyTotpFactor200, type VerifyTotpFactor400, type VerifyTotpFactor403, type VerifyTotpFactorMutationBody, type VerifyTotpFactorMutationError, type VerifyTotpFactorMutationResult, type VerifyTotpFactorRequest, type X509CertificateJSON, authenticationInformation, type authenticationInformationResponse, type authenticationInformationResponse200, type authenticationInformationResponse403, type authenticationInformationResponseError, type authenticationInformationResponseSuccess, createOrganizationApiKey, type createOrganizationApiKeyResponse, type createOrganizationApiKeyResponse201, type createOrganizationApiKeyResponse400, type createOrganizationApiKeyResponse403, type createOrganizationApiKeyResponse404, type createOrganizationApiKeyResponse422, type createOrganizationApiKeyResponseError, type createOrganizationApiKeyResponseSuccess, createPassword, type createPasswordResponse, type createPasswordResponse201, type createPasswordResponse400, type createPasswordResponse403, type createPasswordResponseError, type createPasswordResponseSuccess, createTotpFactor, type createTotpFactorResponse, type createTotpFactorResponse201, type createTotpFactorResponse400, type createTotpFactorResponse403, type createTotpFactorResponseError, type createTotpFactorResponseSuccess, deleteDataInstallation, type deleteDataInstallationResponse, type deleteDataInstallationResponse200, type deleteDataInstallationResponse403, type deleteDataInstallationResponse404, type deleteDataInstallationResponseError, type deleteDataInstallationResponseSuccess, deleteOrganizationApiKey, type deleteOrganizationApiKeyResponse, type deleteOrganizationApiKeyResponse200, type deleteOrganizationApiKeyResponse403, type deleteOrganizationApiKeyResponse404, type deleteOrganizationApiKeyResponseError, type deleteOrganizationApiKeyResponseSuccess, deleteOrganizationDomain, type deleteOrganizationDomainResponse, type deleteOrganizationDomainResponse200, type deleteOrganizationDomainResponse403, type deleteOrganizationDomainResponse404, type deleteOrganizationDomainResponseError, type deleteOrganizationDomainResponseSuccess, deletePasskey, type deletePasskeyResponse, type deletePasskeyResponse200, type deletePasskeyResponse400, type deletePasskeyResponse403, type deletePasskeyResponseError, type deletePasskeyResponseSuccess, deleteTotpFactors, type deleteTotpFactorsResponse, type deleteTotpFactorsResponse200, type deleteTotpFactorsResponse400, type deleteTotpFactorsResponse403, type deleteTotpFactorsResponseError, type deleteTotpFactorsResponseSuccess, generateAdminPortalLink, type generateAdminPortalLinkResponse, type generateAdminPortalLinkResponse201, type generateAdminPortalLinkResponse403, type generateAdminPortalLinkResponse404, type generateAdminPortalLinkResponse500, type generateAdminPortalLinkResponseError, type generateAdminPortalLinkResponseSuccess, getAuditLogStream, type getAuditLogStreamResponse, type getAuditLogStreamResponse200, type getAuditLogStreamResponse403, type getAuditLogStreamResponseError, type getAuditLogStreamResponseSuccess, getAuthenticationInformationQueryKey, getAuthenticationInformationQueryOptions, getAuthenticationInformationUrl, getCreateOrganizationApiKeyMutationOptions, getCreateOrganizationApiKeyUrl, getCreatePasswordMutationOptions, getCreatePasswordUrl, getCreateTotpFactorMutationOptions, getCreateTotpFactorUrl, getDataInstallationAuthorizationStatus, type getDataInstallationAuthorizationStatusResponse, type getDataInstallationAuthorizationStatusResponse200, type getDataInstallationAuthorizationStatusResponse400, type getDataInstallationAuthorizationStatusResponse403, type getDataInstallationAuthorizationStatusResponse404, type getDataInstallationAuthorizationStatusResponseError, type getDataInstallationAuthorizationStatusResponseSuccess, getDataIntegrationAuthorizeUrl, type getDataIntegrationAuthorizeUrlResponse, type getDataIntegrationAuthorizeUrlResponse200, type getDataIntegrationAuthorizeUrlResponse400, type getDataIntegrationAuthorizeUrlResponse403, type getDataIntegrationAuthorizeUrlResponse404, type getDataIntegrationAuthorizeUrlResponseError, type getDataIntegrationAuthorizeUrlResponseSuccess, getDeleteDataInstallationMutationOptions, getDeleteDataInstallationUrl, getDeleteOrganizationApiKeyMutationOptions, getDeleteOrganizationApiKeyUrl, getDeleteOrganizationDomainMutationOptions, getDeleteOrganizationDomainUrl, getDeletePasskeyMutationOptions, getDeletePasskeyUrl, getDeleteTotpFactorsMutationOptions, getDeleteTotpFactorsUrl, getDirectory, type getDirectoryResponse, type getDirectoryResponse200, type getDirectoryResponse403, type getDirectoryResponse404, type getDirectoryResponseError, type getDirectoryResponseSuccess, getGenerateAdminPortalLinkMutationOptions, getGenerateAdminPortalLinkUrl, getGetAuditLogStreamQueryKey, getGetAuditLogStreamQueryOptions, getGetAuditLogStreamUrl, getGetDataInstallationAuthorizationStatusQueryKey, getGetDataInstallationAuthorizationStatusQueryOptions, getGetDataInstallationAuthorizationStatusUrl, getGetDataIntegrationAuthorizeUrlQueryKey, getGetDataIntegrationAuthorizeUrlQueryOptions, getGetDataIntegrationAuthorizeUrlUrl, getGetDirectoryQueryKey, getGetDirectoryQueryOptions, getGetDirectoryUrl, getInviteMemberMutationOptions, getInviteMemberUrl, getListDirectoriesQueryKey, getListDirectoriesQueryOptions, getListDirectoriesUrl, getListOrganizationApiKeyPermissionsQueryKey, getListOrganizationApiKeyPermissionsQueryOptions, getListOrganizationApiKeyPermissionsUrl, getListOrganizationApiKeysQueryKey, getListOrganizationApiKeysQueryOptions, getListOrganizationApiKeysUrl, getListOrganizationDomainsQueryKey, getListOrganizationDomainsQueryOptions, getListOrganizationDomainsUrl, getListSsoConnectionsQueryKey, getListSsoConnectionsQueryOptions, getListSsoConnectionsUrl, getMeQueryKey, getMeQueryOptions, getMeUrl, getMembersQueryKey, getMembersQueryOptions, getMembersUrl, getMyDataIntegrationsQueryKey, getMyDataIntegrationsQueryOptions, getMyDataIntegrationsUrl, getOrganizationsQueryKey, getOrganizationsQueryOptions, getOrganizationsUrl, getRegisterPasskeyMutationOptions, getRegisterPasskeyUrl, getRemoveMemberMutationOptions, getRemoveMemberUrl, getResendInviteMutationOptions, getResendInviteUrl, getReverifyOrganizationDomainMutationOptions, getReverifyOrganizationDomainUrl, getRevokeAllSessionsMutationOptions, getRevokeAllSessionsUrl, getRevokeInviteMutationOptions, getRevokeInviteUrl, getRevokeSessionMutationOptions, getRevokeSessionUrl, getRolesAndConfigQueryKey, getRolesAndConfigQueryOptions, getRolesAndConfigUrl, getRolesQueryKey, getRolesQueryOptions, getRolesUrl, getSendVerificationMutationOptions, getSendVerificationUrl, getSessionsQueryKey, getSessionsQueryOptions, getSessionsUrl, getSettingsQueryKey, getSettingsQueryOptions, getSettingsUrl, getUpdateMeMutationOptions, getUpdateMeUrl, getUpdateMemberMutationOptions, getUpdateMemberUrl, getUpdatePasswordMutationOptions, getUpdatePasswordUrl, getVerifyMutationOptions, getVerifyPasskeyMutationOptions, getVerifyPasskeyUrl, getVerifyTotpFactorMutationOptions, getVerifyTotpFactorUrl, getVerifyUrl, inviteMember, type inviteMemberResponse, type inviteMemberResponse201, type inviteMemberResponse400, type inviteMemberResponse403, type inviteMemberResponse404, type inviteMemberResponseError, type inviteMemberResponseSuccess, listDirectories, type listDirectoriesResponse, type listDirectoriesResponse200, type listDirectoriesResponse403, type listDirectoriesResponse404, type listDirectoriesResponseError, type listDirectoriesResponseSuccess, listOrganizationApiKeyPermissions, type listOrganizationApiKeyPermissionsResponse, type listOrganizationApiKeyPermissionsResponse200, type listOrganizationApiKeyPermissionsResponse400, type listOrganizationApiKeyPermissionsResponse403, type listOrganizationApiKeyPermissionsResponseError, type listOrganizationApiKeyPermissionsResponseSuccess, listOrganizationApiKeys, type listOrganizationApiKeysResponse, type listOrganizationApiKeysResponse200, type listOrganizationApiKeysResponse400, type listOrganizationApiKeysResponse403, type listOrganizationApiKeysResponseError, type listOrganizationApiKeysResponseSuccess, listOrganizationDomains, type listOrganizationDomainsResponse, type listOrganizationDomainsResponse200, type listOrganizationDomainsResponse403, type listOrganizationDomainsResponse404, type listOrganizationDomainsResponseError, type listOrganizationDomainsResponseSuccess, listSsoConnections, type listSsoConnectionsResponse, type listSsoConnectionsResponse200, type listSsoConnectionsResponseSuccess, me, type meResponse, type meResponse200, type meResponse403, type meResponseError, type meResponseSuccess, members, type membersResponse, type membersResponse200, type membersResponse403, type membersResponse404, type membersResponseError, type membersResponseSuccess, myDataIntegrations, type myDataIntegrationsResponse, type myDataIntegrationsResponse200, type myDataIntegrationsResponse403, type myDataIntegrationsResponseError, type myDataIntegrationsResponseSuccess, organizations, type organizationsResponse, type organizationsResponse200, type organizationsResponse403, type organizationsResponse404, type organizationsResponseError, type organizationsResponseSuccess, registerPasskey, type registerPasskeyResponse, type registerPasskeyResponse201, type registerPasskeyResponse400, type registerPasskeyResponse403, type registerPasskeyResponseError, type registerPasskeyResponseSuccess, removeMember, type removeMemberResponse, type removeMemberResponse200, type removeMemberResponse400, type removeMemberResponse403, type removeMemberResponse404, type removeMemberResponseError, type removeMemberResponseSuccess, resendInvite, type resendInviteResponse, type resendInviteResponse201, type resendInviteResponse400, type resendInviteResponse403, type resendInviteResponse404, type resendInviteResponse422, type resendInviteResponseError, type resendInviteResponseSuccess, reverifyOrganizationDomain, type reverifyOrganizationDomainResponse, type reverifyOrganizationDomainResponse200, type reverifyOrganizationDomainResponse403, type reverifyOrganizationDomainResponse404, type reverifyOrganizationDomainResponseError, type reverifyOrganizationDomainResponseSuccess, revokeAllSessions, type revokeAllSessionsResponse, type revokeAllSessionsResponse200, type revokeAllSessionsResponse400, type revokeAllSessionsResponse403, type revokeAllSessionsResponseError, type revokeAllSessionsResponseSuccess, revokeInvite, type revokeInviteResponse, type revokeInviteResponse200, type revokeInviteResponse400, type revokeInviteResponse403, type revokeInviteResponse404, type revokeInviteResponseError, type revokeInviteResponseSuccess, revokeSession, type revokeSessionResponse, type revokeSessionResponse200, type revokeSessionResponse400, type revokeSessionResponse403, type revokeSessionResponseError, type revokeSessionResponseSuccess, roles, rolesAndConfig, type rolesAndConfigResponse, type rolesAndConfigResponse200, type rolesAndConfigResponse403, type rolesAndConfigResponse404, type rolesAndConfigResponseError, type rolesAndConfigResponseSuccess, type rolesResponse, type rolesResponse200, type rolesResponse403, type rolesResponse404, type rolesResponseError, type rolesResponseSuccess, sendVerification, type sendVerificationResponse, type sendVerificationResponse200, type sendVerificationResponse400, type sendVerificationResponse403, type sendVerificationResponseError, type sendVerificationResponseSuccess, sessions, type sessionsResponse, type sessionsResponse200, type sessionsResponse403, type sessionsResponseError, type sessionsResponseSuccess, settings, type settingsResponse, type settingsResponse200, type settingsResponse403, type settingsResponseError, type settingsResponseSuccess, updateMe, type updateMeResponse, type updateMeResponse200, type updateMeResponse400, type updateMeResponse403, type updateMeResponseError, type updateMeResponseSuccess, updateMember, type updateMemberResponse, type updateMemberResponse200, type updateMemberResponse400, type updateMemberResponse403, type updateMemberResponse404, type updateMemberResponse422, type updateMemberResponseError, type updateMemberResponseSuccess, updatePassword, type updatePasswordResponse, type updatePasswordResponse201, type updatePasswordResponse400, type updatePasswordResponse403, type updatePasswordResponseError, type updatePasswordResponseSuccess, useAuthenticationInformation, useCreateOrganizationApiKey, useCreatePassword, useCreateTotpFactor, useDeleteDataInstallation, useDeleteOrganizationApiKey, useDeleteOrganizationDomain, useDeletePasskey, useDeleteTotpFactors, useGenerateAdminPortalLink, useGetAuditLogStream, useGetDataInstallationAuthorizationStatus, useGetDataIntegrationAuthorizeUrl, useGetDirectory, useInviteMember, useListDirectories, useListOrganizationApiKeyPermissions, useListOrganizationApiKeys, useListOrganizationDomains, useListSsoConnections, useMe, useMembers, useMyDataIntegrations, useOrganizations, useRegisterPasskey, useRemoveMember, useResendInvite, useReverifyOrganizationDomain, useRevokeAllSessions, useRevokeInvite, useRevokeSession, useRoles, useRolesAndConfig, useSendVerification, useSessions, useSettings, useUpdateMe, useUpdateMember, useUpdatePassword, useVerify, useVerifyPasskey, useVerifyTotpFactor, verify, verifyPasskey, type verifyPasskeyResponse, type verifyPasskeyResponse200, type verifyPasskeyResponse400, type verifyPasskeyResponse403, type verifyPasskeyResponseError, type verifyPasskeyResponseSuccess, type verifyResponse, type verifyResponse200, type verifyResponse400, type verifyResponse403, type verifyResponseError, type verifyResponseSuccess, verifyTotpFactor, type verifyTotpFactorResponse, type verifyTotpFactorResponse200, type verifyTotpFactorResponse400, type verifyTotpFactorResponse403, type verifyTotpFactorResponseError, type verifyTotpFactorResponseSuccess };
|