@fusionauth/typescript-client 1.29.1 → 1.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/src/FusionAuthClient.d.ts +690 -90
- package/build/src/FusionAuthClient.js +299 -47
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +300 -48
- package/dist/fusionauth-typescript-client.min.js +1 -1
- package/dist/fusionauth-typescript-client.min.js.map +1 -1
- package/package.json +2 -2
|
@@ -42,7 +42,7 @@ export declare class FusionAuthClient {
|
|
|
42
42
|
* Adds a user to an existing family. The family id must be specified.
|
|
43
43
|
*
|
|
44
44
|
* @param {UUID} familyId The id of the family.
|
|
45
|
-
* @param {FamilyRequest} request The request object that contains all
|
|
45
|
+
* @param {FamilyRequest} request The request object that contains all the information used to determine which user to add to the family.
|
|
46
46
|
* @returns {Promise<ClientResponse<FamilyResponse>>}
|
|
47
47
|
*/
|
|
48
48
|
addUserToFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
|
|
@@ -75,7 +75,7 @@ export declare class FusionAuthClient {
|
|
|
75
75
|
/**
|
|
76
76
|
* Adds a comment to the user's account.
|
|
77
77
|
*
|
|
78
|
-
* @param {UserCommentRequest} request The request object that contains all
|
|
78
|
+
* @param {UserCommentRequest} request The request object that contains all the information used to create the user comment.
|
|
79
79
|
* @returns {Promise<ClientResponse<void>>}
|
|
80
80
|
*/
|
|
81
81
|
commentOnUser(request: UserCommentRequest): Promise<ClientResponse<void>>;
|
|
@@ -95,7 +95,7 @@ export declare class FusionAuthClient {
|
|
|
95
95
|
* Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
|
|
96
96
|
*
|
|
97
97
|
* @param {UUID} applicationId (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.
|
|
98
|
-
* @param {ApplicationRequest} request The request object that contains all
|
|
98
|
+
* @param {ApplicationRequest} request The request object that contains all the information used to create the application.
|
|
99
99
|
* @returns {Promise<ClientResponse<ApplicationResponse>>}
|
|
100
100
|
*/
|
|
101
101
|
createApplication(applicationId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
|
|
@@ -105,7 +105,7 @@ export declare class FusionAuthClient {
|
|
|
105
105
|
*
|
|
106
106
|
* @param {UUID} applicationId The Id of the application to create the role on.
|
|
107
107
|
* @param {UUID} roleId (Optional) The Id of the role. If not provided a secure random UUID will be generated.
|
|
108
|
-
* @param {ApplicationRequest} request The request object that contains all
|
|
108
|
+
* @param {ApplicationRequest} request The request object that contains all the information used to create the application role.
|
|
109
109
|
* @returns {Promise<ClientResponse<ApplicationResponse>>}
|
|
110
110
|
*/
|
|
111
111
|
createApplicationRole(applicationId: UUID, roleId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
|
|
@@ -114,7 +114,7 @@ export declare class FusionAuthClient {
|
|
|
114
114
|
* make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically
|
|
115
115
|
* written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.
|
|
116
116
|
*
|
|
117
|
-
* @param {AuditLogRequest} request The request object that contains all
|
|
117
|
+
* @param {AuditLogRequest} request The request object that contains all the information used to create the audit log entry.
|
|
118
118
|
* @returns {Promise<ClientResponse<AuditLogResponse>>}
|
|
119
119
|
*/
|
|
120
120
|
createAuditLog(request: AuditLogRequest): Promise<ClientResponse<AuditLogResponse>>;
|
|
@@ -122,7 +122,7 @@ export declare class FusionAuthClient {
|
|
|
122
122
|
* Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
|
|
123
123
|
*
|
|
124
124
|
* @param {UUID} connectorId (Optional) The Id for the connector. If not provided a secure random UUID will be generated.
|
|
125
|
-
* @param {ConnectorRequest} request The request object that contains all
|
|
125
|
+
* @param {ConnectorRequest} request The request object that contains all the information used to create the connector.
|
|
126
126
|
* @returns {Promise<ClientResponse<ConnectorResponse>>}
|
|
127
127
|
*/
|
|
128
128
|
createConnector(connectorId: UUID, request: ConnectorRequest): Promise<ClientResponse<ConnectorResponse>>;
|
|
@@ -130,7 +130,7 @@ export declare class FusionAuthClient {
|
|
|
130
130
|
* Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
|
|
131
131
|
*
|
|
132
132
|
* @param {UUID} consentId (Optional) The Id for the consent. If not provided a secure random UUID will be generated.
|
|
133
|
-
* @param {ConsentRequest} request The request object that contains all
|
|
133
|
+
* @param {ConsentRequest} request The request object that contains all the information used to create the consent.
|
|
134
134
|
* @returns {Promise<ClientResponse<ConsentResponse>>}
|
|
135
135
|
*/
|
|
136
136
|
createConsent(consentId: UUID, request: ConsentRequest): Promise<ClientResponse<ConsentResponse>>;
|
|
@@ -138,7 +138,7 @@ export declare class FusionAuthClient {
|
|
|
138
138
|
* Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
|
|
139
139
|
*
|
|
140
140
|
* @param {UUID} emailTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
|
|
141
|
-
* @param {EmailTemplateRequest} request The request object that contains all
|
|
141
|
+
* @param {EmailTemplateRequest} request The request object that contains all the information used to create the email template.
|
|
142
142
|
* @returns {Promise<ClientResponse<EmailTemplateResponse>>}
|
|
143
143
|
*/
|
|
144
144
|
createEmailTemplate(emailTemplateId: UUID, request: EmailTemplateRequest): Promise<ClientResponse<EmailTemplateResponse>>;
|
|
@@ -146,7 +146,7 @@ export declare class FusionAuthClient {
|
|
|
146
146
|
* Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
|
|
147
147
|
*
|
|
148
148
|
* @param {UUID} entityId (Optional) The Id for the Entity. If not provided a secure random UUID will be generated.
|
|
149
|
-
* @param {EntityRequest} request The request object that contains all
|
|
149
|
+
* @param {EntityRequest} request The request object that contains all the information used to create the Entity.
|
|
150
150
|
* @returns {Promise<ClientResponse<EntityResponse>>}
|
|
151
151
|
*/
|
|
152
152
|
createEntity(entityId: UUID, request: EntityRequest): Promise<ClientResponse<EntityResponse>>;
|
|
@@ -154,7 +154,7 @@ export declare class FusionAuthClient {
|
|
|
154
154
|
* Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
|
|
155
155
|
*
|
|
156
156
|
* @param {UUID} entityTypeId (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.
|
|
157
|
-
* @param {EntityTypeRequest} request The request object that contains all
|
|
157
|
+
* @param {EntityTypeRequest} request The request object that contains all the information used to create the Entity Type.
|
|
158
158
|
* @returns {Promise<ClientResponse<EntityTypeResponse>>}
|
|
159
159
|
*/
|
|
160
160
|
createEntityType(entityTypeId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
|
|
@@ -164,7 +164,7 @@ export declare class FusionAuthClient {
|
|
|
164
164
|
*
|
|
165
165
|
* @param {UUID} entityTypeId The Id of the entity type to create the permission on.
|
|
166
166
|
* @param {UUID} permissionId (Optional) The Id of the permission. If not provided a secure random UUID will be generated.
|
|
167
|
-
* @param {EntityTypeRequest} request The request object that contains all
|
|
167
|
+
* @param {EntityTypeRequest} request The request object that contains all the information used to create the permission.
|
|
168
168
|
* @returns {Promise<ClientResponse<EntityTypeResponse>>}
|
|
169
169
|
*/
|
|
170
170
|
createEntityTypePermission(entityTypeId: UUID, permissionId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
|
|
@@ -173,7 +173,7 @@ export declare class FusionAuthClient {
|
|
|
173
173
|
* family, if not provided one will be generated.
|
|
174
174
|
*
|
|
175
175
|
* @param {UUID} familyId (Optional) The id for the family. If not provided a secure random UUID will be generated.
|
|
176
|
-
* @param {FamilyRequest} request The request object that contains all
|
|
176
|
+
* @param {FamilyRequest} request The request object that contains all the information used to create the family.
|
|
177
177
|
* @returns {Promise<ClientResponse<FamilyResponse>>}
|
|
178
178
|
*/
|
|
179
179
|
createFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
|
|
@@ -181,7 +181,7 @@ export declare class FusionAuthClient {
|
|
|
181
181
|
* Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
|
|
182
182
|
*
|
|
183
183
|
* @param {UUID} formId (Optional) The Id for the form. If not provided a secure random UUID will be generated.
|
|
184
|
-
* @param {FormRequest} request The request object that contains all
|
|
184
|
+
* @param {FormRequest} request The request object that contains all the information used to create the form.
|
|
185
185
|
* @returns {Promise<ClientResponse<FormResponse>>}
|
|
186
186
|
*/
|
|
187
187
|
createForm(formId: UUID, request: FormRequest): Promise<ClientResponse<FormResponse>>;
|
|
@@ -189,7 +189,7 @@ export declare class FusionAuthClient {
|
|
|
189
189
|
* Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
|
|
190
190
|
*
|
|
191
191
|
* @param {UUID} fieldId (Optional) The Id for the form field. If not provided a secure random UUID will be generated.
|
|
192
|
-
* @param {FormFieldRequest} request The request object that contains all
|
|
192
|
+
* @param {FormFieldRequest} request The request object that contains all the information used to create the form field.
|
|
193
193
|
* @returns {Promise<ClientResponse<FormFieldResponse>>}
|
|
194
194
|
*/
|
|
195
195
|
createFormField(fieldId: UUID, request: FormFieldRequest): Promise<ClientResponse<FormFieldResponse>>;
|
|
@@ -197,22 +197,30 @@ export declare class FusionAuthClient {
|
|
|
197
197
|
* Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
|
|
198
198
|
*
|
|
199
199
|
* @param {UUID} groupId (Optional) The Id for the group. If not provided a secure random UUID will be generated.
|
|
200
|
-
* @param {GroupRequest} request The request object that contains all
|
|
200
|
+
* @param {GroupRequest} request The request object that contains all the information used to create the group.
|
|
201
201
|
* @returns {Promise<ClientResponse<GroupResponse>>}
|
|
202
202
|
*/
|
|
203
203
|
createGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
|
|
204
204
|
/**
|
|
205
205
|
* Creates a member in a group.
|
|
206
206
|
*
|
|
207
|
-
* @param {MemberRequest} request The request object that contains all
|
|
207
|
+
* @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
|
|
208
208
|
* @returns {Promise<ClientResponse<MemberResponse>>}
|
|
209
209
|
*/
|
|
210
210
|
createGroupMembers(request: MemberRequest): Promise<ClientResponse<MemberResponse>>;
|
|
211
|
+
/**
|
|
212
|
+
* Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
|
|
213
|
+
*
|
|
214
|
+
* @param {UUID} accessControlListId (Optional) The Id for the IP Access Control List. If not provided a secure random UUID will be generated.
|
|
215
|
+
* @param {IPAccessControlListRequest} request The request object that contains all the information used to create the IP Access Control List.
|
|
216
|
+
* @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
|
|
217
|
+
*/
|
|
218
|
+
createIPAccessControlList(accessControlListId: UUID, request: IPAccessControlListRequest): Promise<ClientResponse<IPAccessControlListResponse>>;
|
|
211
219
|
/**
|
|
212
220
|
* Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
|
|
213
221
|
*
|
|
214
222
|
* @param {UUID} identityProviderId (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated.
|
|
215
|
-
* @param {IdentityProviderRequest} request The request object that contains all
|
|
223
|
+
* @param {IdentityProviderRequest} request The request object that contains all the information used to create the identity provider.
|
|
216
224
|
* @returns {Promise<ClientResponse<IdentityProviderResponse>>}
|
|
217
225
|
*/
|
|
218
226
|
createIdentityProvider(identityProviderId: UUID, request: IdentityProviderRequest): Promise<ClientResponse<IdentityProviderResponse>>;
|
|
@@ -220,7 +228,7 @@ export declare class FusionAuthClient {
|
|
|
220
228
|
* Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
|
|
221
229
|
*
|
|
222
230
|
* @param {UUID} lambdaId (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.
|
|
223
|
-
* @param {LambdaRequest} request The request object that contains all
|
|
231
|
+
* @param {LambdaRequest} request The request object that contains all the information used to create the lambda.
|
|
224
232
|
* @returns {Promise<ClientResponse<LambdaResponse>>}
|
|
225
233
|
*/
|
|
226
234
|
createLambda(lambdaId: UUID, request: LambdaRequest): Promise<ClientResponse<LambdaResponse>>;
|
|
@@ -228,7 +236,7 @@ export declare class FusionAuthClient {
|
|
|
228
236
|
* Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
|
|
229
237
|
*
|
|
230
238
|
* @param {UUID} messageTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
|
|
231
|
-
* @param {MessageTemplateRequest} request The request object that contains all
|
|
239
|
+
* @param {MessageTemplateRequest} request The request object that contains all the information used to create the message template.
|
|
232
240
|
* @returns {Promise<ClientResponse<MessageTemplateResponse>>}
|
|
233
241
|
*/
|
|
234
242
|
createMessageTemplate(messageTemplateId: UUID, request: MessageTemplateRequest): Promise<ClientResponse<MessageTemplateResponse>>;
|
|
@@ -236,7 +244,7 @@ export declare class FusionAuthClient {
|
|
|
236
244
|
* Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
|
|
237
245
|
*
|
|
238
246
|
* @param {UUID} messengerId (Optional) The Id for the messenger. If not provided a secure random UUID will be generated.
|
|
239
|
-
* @param {MessengerRequest} request The request object that contains all
|
|
247
|
+
* @param {MessengerRequest} request The request object that contains all the information used to create the messenger.
|
|
240
248
|
* @returns {Promise<ClientResponse<MessengerResponse>>}
|
|
241
249
|
*/
|
|
242
250
|
createMessenger(messengerId: UUID, request: MessengerRequest): Promise<ClientResponse<MessengerResponse>>;
|
|
@@ -244,7 +252,7 @@ export declare class FusionAuthClient {
|
|
|
244
252
|
* Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
|
|
245
253
|
*
|
|
246
254
|
* @param {UUID} tenantId (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.
|
|
247
|
-
* @param {TenantRequest} request The request object that contains all
|
|
255
|
+
* @param {TenantRequest} request The request object that contains all the information used to create the tenant.
|
|
248
256
|
* @returns {Promise<ClientResponse<TenantResponse>>}
|
|
249
257
|
*/
|
|
250
258
|
createTenant(tenantId: UUID, request: TenantRequest): Promise<ClientResponse<TenantResponse>>;
|
|
@@ -252,7 +260,7 @@ export declare class FusionAuthClient {
|
|
|
252
260
|
* Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
|
|
253
261
|
*
|
|
254
262
|
* @param {UUID} themeId (Optional) The Id for the theme. If not provided a secure random UUID will be generated.
|
|
255
|
-
* @param {ThemeRequest} request The request object that contains all
|
|
263
|
+
* @param {ThemeRequest} request The request object that contains all the information used to create the theme.
|
|
256
264
|
* @returns {Promise<ClientResponse<ThemeResponse>>}
|
|
257
265
|
*/
|
|
258
266
|
createTheme(themeId: UUID, request: ThemeRequest): Promise<ClientResponse<ThemeResponse>>;
|
|
@@ -260,7 +268,7 @@ export declare class FusionAuthClient {
|
|
|
260
268
|
* Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
|
|
261
269
|
*
|
|
262
270
|
* @param {UUID} userId (Optional) The Id for the user. If not provided a secure random UUID will be generated.
|
|
263
|
-
* @param {UserRequest} request The request object that contains all
|
|
271
|
+
* @param {UserRequest} request The request object that contains all the information used to create the user.
|
|
264
272
|
* @returns {Promise<ClientResponse<UserResponse>>}
|
|
265
273
|
*/
|
|
266
274
|
createUser(userId: UUID, request: UserRequest): Promise<ClientResponse<UserResponse>>;
|
|
@@ -269,7 +277,7 @@ export declare class FusionAuthClient {
|
|
|
269
277
|
* that the user action can be applied to any user.
|
|
270
278
|
*
|
|
271
279
|
* @param {UUID} userActionId (Optional) The Id for the user action. If not provided a secure random UUID will be generated.
|
|
272
|
-
* @param {UserActionRequest} request The request object that contains all
|
|
280
|
+
* @param {UserActionRequest} request The request object that contains all the information used to create the user action.
|
|
273
281
|
* @returns {Promise<ClientResponse<UserActionResponse>>}
|
|
274
282
|
*/
|
|
275
283
|
createUserAction(userActionId: UUID, request: UserActionRequest): Promise<ClientResponse<UserActionResponse>>;
|
|
@@ -278,7 +286,7 @@ export declare class FusionAuthClient {
|
|
|
278
286
|
* successfully. Anytime after that the user action reason can be used.
|
|
279
287
|
*
|
|
280
288
|
* @param {UUID} userActionReasonId (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.
|
|
281
|
-
* @param {UserActionReasonRequest} request The request object that contains all
|
|
289
|
+
* @param {UserActionReasonRequest} request The request object that contains all the information used to create the user action reason.
|
|
282
290
|
* @returns {Promise<ClientResponse<UserActionReasonResponse>>}
|
|
283
291
|
*/
|
|
284
292
|
createUserActionReason(userActionReasonId: UUID, request: UserActionReasonRequest): Promise<ClientResponse<UserActionReasonResponse>>;
|
|
@@ -293,7 +301,7 @@ export declare class FusionAuthClient {
|
|
|
293
301
|
/**
|
|
294
302
|
* Link an external user from a 3rd party identity provider to a FusionAuth user.
|
|
295
303
|
*
|
|
296
|
-
* @param {IdentityProviderLinkRequest} request The request object that contains all
|
|
304
|
+
* @param {IdentityProviderLinkRequest} request The request object that contains all the information used to link the FusionAuth user.
|
|
297
305
|
* @returns {Promise<ClientResponse<IdentityProviderLinkResponse>>}
|
|
298
306
|
*/
|
|
299
307
|
createUserLink(request: IdentityProviderLinkRequest): Promise<ClientResponse<IdentityProviderLinkResponse>>;
|
|
@@ -301,7 +309,7 @@ export declare class FusionAuthClient {
|
|
|
301
309
|
* Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
|
|
302
310
|
*
|
|
303
311
|
* @param {UUID} webhookId (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.
|
|
304
|
-
* @param {WebhookRequest} request The request object that contains all
|
|
312
|
+
* @param {WebhookRequest} request The request object that contains all the information used to create the webhook.
|
|
305
313
|
* @returns {Promise<ClientResponse<WebhookResponse>>}
|
|
306
314
|
*/
|
|
307
315
|
createWebhook(webhookId: UUID, request: WebhookRequest): Promise<ClientResponse<WebhookResponse>>;
|
|
@@ -455,6 +463,13 @@ export declare class FusionAuthClient {
|
|
|
455
463
|
* @returns {Promise<ClientResponse<void>>}
|
|
456
464
|
*/
|
|
457
465
|
deleteGroupMembers(request: MemberDeleteRequest): Promise<ClientResponse<void>>;
|
|
466
|
+
/**
|
|
467
|
+
* Deletes the IP Access Control List for the given Id.
|
|
468
|
+
*
|
|
469
|
+
* @param {UUID} ipAccessControlListId The Id of the IP Access Control List to delete.
|
|
470
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
471
|
+
*/
|
|
472
|
+
deleteIPAccessControlList(ipAccessControlListId: UUID): Promise<ClientResponse<void>>;
|
|
458
473
|
/**
|
|
459
474
|
* Deletes the identity provider for the given Id.
|
|
460
475
|
*
|
|
@@ -499,7 +514,17 @@ export declare class FusionAuthClient {
|
|
|
499
514
|
*/
|
|
500
515
|
deleteRegistration(userId: UUID, applicationId: UUID): Promise<ClientResponse<void>>;
|
|
501
516
|
/**
|
|
502
|
-
* Deletes the
|
|
517
|
+
* Deletes the user registration for the given user and application along with the given JSON body that contains the event information.
|
|
518
|
+
*
|
|
519
|
+
* @param {UUID} userId The Id of the user whose registration is being deleted.
|
|
520
|
+
* @param {UUID} applicationId The Id of the application to remove the registration for.
|
|
521
|
+
* @param {RegistrationDeleteRequest} request The request body that contains the event information.
|
|
522
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
523
|
+
*/
|
|
524
|
+
deleteRegistrationWithRequest(userId: UUID, applicationId: UUID, request: RegistrationDeleteRequest): Promise<ClientResponse<void>>;
|
|
525
|
+
/**
|
|
526
|
+
* Deletes the tenant based on the given Id on the URL. This permanently deletes all information, metrics, reports and data associated
|
|
527
|
+
* with the tenant and everything under the tenant (applications, users, etc).
|
|
503
528
|
*
|
|
504
529
|
* @param {UUID} tenantId The Id of the tenant to delete.
|
|
505
530
|
* @returns {Promise<ClientResponse<void>>}
|
|
@@ -513,6 +538,15 @@ export declare class FusionAuthClient {
|
|
|
513
538
|
* @returns {Promise<ClientResponse<void>>}
|
|
514
539
|
*/
|
|
515
540
|
deleteTenantAsync(tenantId: UUID): Promise<ClientResponse<void>>;
|
|
541
|
+
/**
|
|
542
|
+
* Deletes the tenant based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated
|
|
543
|
+
* with the tenant and everything under the tenant (applications, users, etc).
|
|
544
|
+
*
|
|
545
|
+
* @param {UUID} tenantId The Id of the tenant to delete.
|
|
546
|
+
* @param {TenantDeleteRequest} request The request object that contains all the information used to delete the user.
|
|
547
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
548
|
+
*/
|
|
549
|
+
deleteTenantWithRequest(tenantId: UUID, request: TenantDeleteRequest): Promise<ClientResponse<void>>;
|
|
516
550
|
/**
|
|
517
551
|
* Deletes the theme for the given Id.
|
|
518
552
|
*
|
|
@@ -552,6 +586,15 @@ export declare class FusionAuthClient {
|
|
|
552
586
|
* @returns {Promise<ClientResponse<IdentityProviderLinkResponse>>}
|
|
553
587
|
*/
|
|
554
588
|
deleteUserLink(identityProviderId: UUID, identityProviderUserId: string, userId: UUID): Promise<ClientResponse<IdentityProviderLinkResponse>>;
|
|
589
|
+
/**
|
|
590
|
+
* Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated
|
|
591
|
+
* with the user.
|
|
592
|
+
*
|
|
593
|
+
* @param {UUID} userId The Id of the user to delete (required).
|
|
594
|
+
* @param {UserDeleteSingleRequest} request The request object that contains all the information used to delete the user.
|
|
595
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
596
|
+
*/
|
|
597
|
+
deleteUserWithRequest(userId: UUID, request: UserDeleteSingleRequest): Promise<ClientResponse<void>>;
|
|
555
598
|
/**
|
|
556
599
|
* Deletes the users with the given ids, or users matching the provided JSON query or queryString.
|
|
557
600
|
* The order of preference is ids, query and then queryString, it is recommended to only provide one of the three for the request.
|
|
@@ -592,6 +635,14 @@ export declare class FusionAuthClient {
|
|
|
592
635
|
* @returns {Promise<ClientResponse<void>>}
|
|
593
636
|
*/
|
|
594
637
|
disableTwoFactor(userId: UUID, methodId: string, code: string): Promise<ClientResponse<void>>;
|
|
638
|
+
/**
|
|
639
|
+
* Disable Two Factor authentication for a user using a JSON body rather than URL parameters.
|
|
640
|
+
*
|
|
641
|
+
* @param {UUID} userId The Id of the User for which you're disabling Two Factor authentication.
|
|
642
|
+
* @param {TwoFactorDisableRequest} request The request information that contains the code and methodId along with any event information.
|
|
643
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
644
|
+
*/
|
|
645
|
+
disableTwoFactorWithRequest(userId: UUID, request: TwoFactorDisableRequest): Promise<ClientResponse<void>>;
|
|
595
646
|
/**
|
|
596
647
|
* Enable Two Factor authentication for a user.
|
|
597
648
|
*
|
|
@@ -674,7 +725,7 @@ export declare class FusionAuthClient {
|
|
|
674
725
|
* Generate a new RSA or EC key pair or an HMAC secret.
|
|
675
726
|
*
|
|
676
727
|
* @param {UUID} keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
|
|
677
|
-
* @param {KeyRequest} request The request object that contains all
|
|
728
|
+
* @param {KeyRequest} request The request object that contains all the information used to create the key.
|
|
678
729
|
* @returns {Promise<ClientResponse<KeyResponse>>}
|
|
679
730
|
*/
|
|
680
731
|
generateKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
|
|
@@ -724,7 +775,7 @@ export declare class FusionAuthClient {
|
|
|
724
775
|
* Import an existing RSA or EC key pair or an HMAC secret.
|
|
725
776
|
*
|
|
726
777
|
* @param {UUID} keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
|
|
727
|
-
* @param {KeyRequest} request The request object that contains all
|
|
778
|
+
* @param {KeyRequest} request The request object that contains all the information used to create the key.
|
|
728
779
|
* @returns {Promise<ClientResponse<KeyResponse>>}
|
|
729
780
|
*/
|
|
730
781
|
importKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
|
|
@@ -813,6 +864,14 @@ export declare class FusionAuthClient {
|
|
|
813
864
|
* @returns {Promise<ClientResponse<void>>}
|
|
814
865
|
*/
|
|
815
866
|
logout(global: boolean, refreshToken: string): Promise<ClientResponse<void>>;
|
|
867
|
+
/**
|
|
868
|
+
* The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
|
|
869
|
+
* client and revoke the refresh token stored. This API takes the refresh token in the JSON body.
|
|
870
|
+
*
|
|
871
|
+
* @param {LogoutRequest} request The request object that contains all the information used to logout the user.
|
|
872
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
873
|
+
*/
|
|
874
|
+
logoutWithRequest(request: LogoutRequest): Promise<ClientResponse<void>>;
|
|
816
875
|
/**
|
|
817
876
|
* Retrieves the identity provider for the given domain. A 200 response code indicates the domain is managed
|
|
818
877
|
* by a registered identity provider. A 404 indicates the domain is not managed.
|
|
@@ -1315,6 +1374,13 @@ export declare class FusionAuthClient {
|
|
|
1315
1374
|
* @returns {Promise<ClientResponse<GroupResponse>>}
|
|
1316
1375
|
*/
|
|
1317
1376
|
retrieveGroups(): Promise<ClientResponse<GroupResponse>>;
|
|
1377
|
+
/**
|
|
1378
|
+
* Retrieves the IP Access Control List with the given Id.
|
|
1379
|
+
*
|
|
1380
|
+
* @param {UUID} ipAccessControlListId The Id of the IP Access Control List.
|
|
1381
|
+
* @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
|
|
1382
|
+
*/
|
|
1383
|
+
retrieveIPAccessControlList(ipAccessControlListId: UUID): Promise<ClientResponse<IPAccessControlListResponse>>;
|
|
1318
1384
|
/**
|
|
1319
1385
|
* Retrieves the identity provider for the given id or all of the identity providers if the id is null.
|
|
1320
1386
|
*
|
|
@@ -1513,6 +1579,12 @@ export declare class FusionAuthClient {
|
|
|
1513
1579
|
* @returns {Promise<ClientResponse<PendingResponse>>}
|
|
1514
1580
|
*/
|
|
1515
1581
|
retrievePendingChildren(parentEmail: string): Promise<ClientResponse<PendingResponse>>;
|
|
1582
|
+
/**
|
|
1583
|
+
* Retrieves the FusionAuth Reactor metrics.
|
|
1584
|
+
*
|
|
1585
|
+
* @returns {Promise<ClientResponse<ReactorMetricsResponse>>}
|
|
1586
|
+
*/
|
|
1587
|
+
retrieveReactorMetrics(): Promise<ClientResponse<ReactorMetricsResponse>>;
|
|
1516
1588
|
/**
|
|
1517
1589
|
* Retrieves the FusionAuth Reactor status.
|
|
1518
1590
|
*
|
|
@@ -1854,6 +1926,14 @@ export declare class FusionAuthClient {
|
|
|
1854
1926
|
* @returns {Promise<ClientResponse<void>>}
|
|
1855
1927
|
*/
|
|
1856
1928
|
revokeRefreshTokensByUserIdForApplication(userId: UUID, applicationId: UUID): Promise<ClientResponse<void>>;
|
|
1929
|
+
/**
|
|
1930
|
+
* Revokes refresh tokens using the information in the JSON body. The handling for this method is the same as the revokeRefreshToken method
|
|
1931
|
+
* and is based on the information you provide in the RefreshDeleteRequest object. See that method for additional information.
|
|
1932
|
+
*
|
|
1933
|
+
* @param {RefreshTokenRevokeRequest} request The request information used to revoke the refresh tokens.
|
|
1934
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
1935
|
+
*/
|
|
1936
|
+
revokeRefreshTokensWithRequest(request: RefreshTokenRevokeRequest): Promise<ClientResponse<void>>;
|
|
1857
1937
|
/**
|
|
1858
1938
|
* Revokes a single User consent by Id.
|
|
1859
1939
|
*
|
|
@@ -1903,6 +1983,13 @@ export declare class FusionAuthClient {
|
|
|
1903
1983
|
* @returns {Promise<ClientResponse<EventLogSearchResponse>>}
|
|
1904
1984
|
*/
|
|
1905
1985
|
searchEventLogs(request: EventLogSearchRequest): Promise<ClientResponse<EventLogSearchResponse>>;
|
|
1986
|
+
/**
|
|
1987
|
+
* Searches the IP Access Control Lists with the specified criteria and pagination.
|
|
1988
|
+
*
|
|
1989
|
+
* @param {IPAccessControlListSearchRequest} request The search criteria and pagination information.
|
|
1990
|
+
* @returns {Promise<ClientResponse<IPAccessControlListSearchResponse>>}
|
|
1991
|
+
*/
|
|
1992
|
+
searchIPAccessControlLists(request: IPAccessControlListSearchRequest): Promise<ClientResponse<IPAccessControlListSearchResponse>>;
|
|
1906
1993
|
/**
|
|
1907
1994
|
* Searches the login records with the specified criteria and pagination.
|
|
1908
1995
|
*
|
|
@@ -1970,7 +2057,7 @@ export declare class FusionAuthClient {
|
|
|
1970
2057
|
/**
|
|
1971
2058
|
* Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
|
|
1972
2059
|
*
|
|
1973
|
-
* @param {TwoFactorSendRequest} request The request object that contains all
|
|
2060
|
+
* @param {TwoFactorSendRequest} request The request object that contains all the information used to send the code.
|
|
1974
2061
|
* @returns {Promise<ClientResponse<void>>}
|
|
1975
2062
|
*
|
|
1976
2063
|
* @deprecated This method has been renamed to sendTwoFactorCodeForEnableDisable, use that method instead.
|
|
@@ -1979,7 +2066,7 @@ export declare class FusionAuthClient {
|
|
|
1979
2066
|
/**
|
|
1980
2067
|
* Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
|
|
1981
2068
|
*
|
|
1982
|
-
* @param {TwoFactorSendRequest} request The request object that contains all
|
|
2069
|
+
* @param {TwoFactorSendRequest} request The request object that contains all the information used to send the code.
|
|
1983
2070
|
* @returns {Promise<ClientResponse<void>>}
|
|
1984
2071
|
*/
|
|
1985
2072
|
sendTwoFactorCodeForEnableDisable(request: TwoFactorSendRequest): Promise<ClientResponse<void>>;
|
|
@@ -2039,7 +2126,7 @@ export declare class FusionAuthClient {
|
|
|
2039
2126
|
* Updates an API key by given id
|
|
2040
2127
|
*
|
|
2041
2128
|
* @param {UUID} apiKeyId The Id of the API key to update.
|
|
2042
|
-
* @param {APIKeyRequest} request The request object that contains all
|
|
2129
|
+
* @param {APIKeyRequest} request The request object that contains all the information used to create the API Key.
|
|
2043
2130
|
* @returns {Promise<ClientResponse<APIKeyResponse>>}
|
|
2044
2131
|
*/
|
|
2045
2132
|
updateAPIKey(apiKeyId: UUID, request: APIKeyRequest): Promise<ClientResponse<APIKeyResponse>>;
|
|
@@ -2133,6 +2220,14 @@ export declare class FusionAuthClient {
|
|
|
2133
2220
|
* @returns {Promise<ClientResponse<GroupResponse>>}
|
|
2134
2221
|
*/
|
|
2135
2222
|
updateGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
|
|
2223
|
+
/**
|
|
2224
|
+
* Updates the IP Access Control List with the given Id.
|
|
2225
|
+
*
|
|
2226
|
+
* @param {UUID} accessControlListId The Id of the IP Access Control List to update.
|
|
2227
|
+
* @param {IPAccessControlListRequest} request The request that contains all of the new IP Access Control List information.
|
|
2228
|
+
* @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
|
|
2229
|
+
*/
|
|
2230
|
+
updateIPAccessControlList(accessControlListId: UUID, request: IPAccessControlListRequest): Promise<ClientResponse<IPAccessControlListResponse>>;
|
|
2136
2231
|
/**
|
|
2137
2232
|
* Updates the identity provider with the given Id.
|
|
2138
2233
|
*
|
|
@@ -2255,7 +2350,7 @@ export declare class FusionAuthClient {
|
|
|
2255
2350
|
* Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
|
|
2256
2351
|
*
|
|
2257
2352
|
* @param {UUID} entityId The Id of the Entity that the User/Entity is being granted access to.
|
|
2258
|
-
* @param {EntityGrantRequest} request The request object that contains all
|
|
2353
|
+
* @param {EntityGrantRequest} request The request object that contains all the information used to create the Entity Grant.
|
|
2259
2354
|
* @returns {Promise<ClientResponse<void>>}
|
|
2260
2355
|
*/
|
|
2261
2356
|
upsertEntityGrant(entityId: UUID, request: EntityGrantRequest): Promise<ClientResponse<void>>;
|
|
@@ -2278,6 +2373,21 @@ export declare class FusionAuthClient {
|
|
|
2278
2373
|
* @returns {Promise<ClientResponse<ValidateResponse>>}
|
|
2279
2374
|
*/
|
|
2280
2375
|
validateJWT(encodedJWT: string): Promise<ClientResponse<ValidateResponse>>;
|
|
2376
|
+
/**
|
|
2377
|
+
* It's a JWT vending machine!
|
|
2378
|
+
*
|
|
2379
|
+
* Issue a new access token (JWT) with the provided claims in the request. This JWT is not scoped to a tenant or user, it is a free form
|
|
2380
|
+
* token that will contain what claims you provide.
|
|
2381
|
+
* <p>
|
|
2382
|
+
* The iat, exp and jti claims will be added by FusionAuth, all other claims must be provided by the caller.
|
|
2383
|
+
*
|
|
2384
|
+
* If a TTL is not provided in the request, the TTL will be retrieved from the default Tenant or the Tenant specified on the request either
|
|
2385
|
+
* by way of the X-FusionAuth-TenantId request header, or a tenant scoped API key.
|
|
2386
|
+
*
|
|
2387
|
+
* @param {JWTVendRequest} request The request that contains all of the claims for this JWT.
|
|
2388
|
+
* @returns {Promise<ClientResponse<JWTVendResponse>>}
|
|
2389
|
+
*/
|
|
2390
|
+
vendJWT(request: JWTVendRequest): Promise<ClientResponse<JWTVendResponse>>;
|
|
2281
2391
|
/**
|
|
2282
2392
|
* Confirms a email verification. The Id given is usually from an email sent to the user.
|
|
2283
2393
|
*
|
|
@@ -2363,7 +2473,7 @@ export interface ActionData {
|
|
|
2363
2473
|
*
|
|
2364
2474
|
* @author Brian Pontarelli
|
|
2365
2475
|
*/
|
|
2366
|
-
export interface ActionRequest {
|
|
2476
|
+
export interface ActionRequest extends BaseEventRequest {
|
|
2367
2477
|
action?: ActionData;
|
|
2368
2478
|
broadcast?: boolean;
|
|
2369
2479
|
}
|
|
@@ -2401,6 +2511,7 @@ export declare enum Algorithm {
|
|
|
2401
2511
|
export interface APIKey {
|
|
2402
2512
|
id?: UUID;
|
|
2403
2513
|
insertInstant?: number;
|
|
2514
|
+
ipAccessControlListId?: UUID;
|
|
2404
2515
|
key?: string;
|
|
2405
2516
|
keyManager?: boolean;
|
|
2406
2517
|
lastUpdateInstant?: number;
|
|
@@ -2455,6 +2566,7 @@ export interface AppleIdentityProvider extends BaseIdentityProvider<AppleApplica
|
|
|
2455
2566
|
* @author Seth Musselman
|
|
2456
2567
|
*/
|
|
2457
2568
|
export interface Application {
|
|
2569
|
+
accessControlConfiguration?: ApplicationAccessControlConfiguration;
|
|
2458
2570
|
active?: boolean;
|
|
2459
2571
|
authenticationTokenConfiguration?: AuthenticationTokenConfiguration;
|
|
2460
2572
|
cleanSpeakConfiguration?: CleanSpeakConfiguration;
|
|
@@ -2483,11 +2595,27 @@ export interface Application {
|
|
|
2483
2595
|
verificationStrategy?: VerificationStrategy;
|
|
2484
2596
|
verifyRegistration?: boolean;
|
|
2485
2597
|
}
|
|
2598
|
+
/**
|
|
2599
|
+
* @author Daniel DeGroff
|
|
2600
|
+
*/
|
|
2601
|
+
export interface ApplicationAccessControlConfiguration {
|
|
2602
|
+
uiIPAccessControlListId?: UUID;
|
|
2603
|
+
}
|
|
2486
2604
|
export interface ApplicationEmailConfiguration {
|
|
2605
|
+
emailUpdateEmailTemplateId?: UUID;
|
|
2487
2606
|
emailVerificationEmailTemplateId?: UUID;
|
|
2607
|
+
emailVerifiedEmailTemplateId?: UUID;
|
|
2488
2608
|
forgotPasswordEmailTemplateId?: UUID;
|
|
2609
|
+
loginIdInUseOnCreateEmailTemplateId?: UUID;
|
|
2610
|
+
loginIdInUseOnUpdateEmailTemplateId?: UUID;
|
|
2611
|
+
loginNewDeviceEmailTemplateId?: UUID;
|
|
2612
|
+
loginSuspiciousEmailTemplateId?: UUID;
|
|
2489
2613
|
passwordlessEmailTemplateId?: UUID;
|
|
2614
|
+
passwordResetSuccessEmailTemplateId?: UUID;
|
|
2615
|
+
passwordUpdateEmailTemplateId?: UUID;
|
|
2490
2616
|
setPasswordEmailTemplateId?: UUID;
|
|
2617
|
+
twoFactorMethodAddEmailTemplateId?: UUID;
|
|
2618
|
+
twoFactorMethodRemoveEmailTemplateId?: UUID;
|
|
2491
2619
|
}
|
|
2492
2620
|
/**
|
|
2493
2621
|
* Events that are bound to applications.
|
|
@@ -2523,7 +2651,7 @@ export interface ApplicationRegistrationDeletePolicy {
|
|
|
2523
2651
|
*
|
|
2524
2652
|
* @author Brian Pontarelli
|
|
2525
2653
|
*/
|
|
2526
|
-
export interface ApplicationRequest {
|
|
2654
|
+
export interface ApplicationRequest extends BaseEventRequest {
|
|
2527
2655
|
application?: Application;
|
|
2528
2656
|
role?: ApplicationRole;
|
|
2529
2657
|
webhookIds?: Array<UUID>;
|
|
@@ -2588,6 +2716,14 @@ export interface AuditLog {
|
|
|
2588
2716
|
export interface AuditLogConfiguration {
|
|
2589
2717
|
delete?: DeleteConfiguration;
|
|
2590
2718
|
}
|
|
2719
|
+
/**
|
|
2720
|
+
* Event event to an audit log was created.
|
|
2721
|
+
*
|
|
2722
|
+
* @author Daniel DeGroff
|
|
2723
|
+
*/
|
|
2724
|
+
export interface AuditLogCreateEvent extends BaseEvent {
|
|
2725
|
+
auditLog?: AuditLog;
|
|
2726
|
+
}
|
|
2591
2727
|
/**
|
|
2592
2728
|
* @author Daniel DeGroff
|
|
2593
2729
|
*/
|
|
@@ -2597,7 +2733,7 @@ export interface AuditLogExportRequest extends BaseExportRequest {
|
|
|
2597
2733
|
/**
|
|
2598
2734
|
* @author Brian Pontarelli
|
|
2599
2735
|
*/
|
|
2600
|
-
export interface AuditLogRequest {
|
|
2736
|
+
export interface AuditLogRequest extends BaseEventRequest {
|
|
2601
2737
|
auditLog?: AuditLog;
|
|
2602
2738
|
}
|
|
2603
2739
|
/**
|
|
@@ -2614,6 +2750,9 @@ export interface AuditLogResponse {
|
|
|
2614
2750
|
export interface AuditLogSearchCriteria extends BaseSearchCriteria {
|
|
2615
2751
|
end?: number;
|
|
2616
2752
|
message?: string;
|
|
2753
|
+
newValue?: string;
|
|
2754
|
+
oldValue?: string;
|
|
2755
|
+
reason?: string;
|
|
2617
2756
|
start?: number;
|
|
2618
2757
|
user?: string;
|
|
2619
2758
|
}
|
|
@@ -2632,6 +2771,12 @@ export interface AuditLogSearchResponse {
|
|
|
2632
2771
|
auditLogs?: Array<AuditLog>;
|
|
2633
2772
|
total?: number;
|
|
2634
2773
|
}
|
|
2774
|
+
/**
|
|
2775
|
+
* @author Brett Pontarelli
|
|
2776
|
+
*/
|
|
2777
|
+
export declare enum AuthenticationThreats {
|
|
2778
|
+
ImpossibleTravel = "ImpossibleTravel"
|
|
2779
|
+
}
|
|
2635
2780
|
export interface AuthenticationTokenConfiguration extends Enableable {
|
|
2636
2781
|
}
|
|
2637
2782
|
/**
|
|
@@ -2669,7 +2814,18 @@ export interface BaseElasticSearchCriteria extends BaseSearchCriteria {
|
|
|
2669
2814
|
export interface BaseEvent {
|
|
2670
2815
|
createInstant?: number;
|
|
2671
2816
|
id?: UUID;
|
|
2817
|
+
info?: EventInfo;
|
|
2672
2818
|
tenantId?: UUID;
|
|
2819
|
+
type?: EventType;
|
|
2820
|
+
}
|
|
2821
|
+
/**
|
|
2822
|
+
* Base class for requests that can contain event information. This event information is used when sending Webhooks or emails
|
|
2823
|
+
* during the transaction. The caller is responsible for ensuring that the event information is correct.
|
|
2824
|
+
*
|
|
2825
|
+
* @author Brian Pontarelli
|
|
2826
|
+
*/
|
|
2827
|
+
export interface BaseEventRequest {
|
|
2828
|
+
eventInfo?: EventInfo;
|
|
2673
2829
|
}
|
|
2674
2830
|
/**
|
|
2675
2831
|
* @author Daniel DeGroff
|
|
@@ -2688,6 +2844,7 @@ export interface BaseIdentityProvider<D extends BaseIdentityProviderApplicationC
|
|
|
2688
2844
|
lastUpdateInstant?: number;
|
|
2689
2845
|
linkingStrategy?: IdentityProviderLinkingStrategy;
|
|
2690
2846
|
name?: string;
|
|
2847
|
+
tenantConfiguration?: Record<UUID, IdentityProviderTenantConfiguration>;
|
|
2691
2848
|
type?: IdentityProviderType;
|
|
2692
2849
|
}
|
|
2693
2850
|
/**
|
|
@@ -2700,10 +2857,11 @@ export interface BaseIdentityProviderApplicationConfiguration extends Enableable
|
|
|
2700
2857
|
/**
|
|
2701
2858
|
* @author Daniel DeGroff
|
|
2702
2859
|
*/
|
|
2703
|
-
export interface BaseLoginRequest {
|
|
2860
|
+
export interface BaseLoginRequest extends BaseEventRequest {
|
|
2704
2861
|
applicationId?: UUID;
|
|
2705
2862
|
ipAddress?: string;
|
|
2706
2863
|
metaData?: MetaData;
|
|
2864
|
+
newDevice?: boolean;
|
|
2707
2865
|
noJWT?: boolean;
|
|
2708
2866
|
}
|
|
2709
2867
|
export interface BaseMessengerConfiguration {
|
|
@@ -2767,6 +2925,15 @@ export declare enum CanonicalizationMethod {
|
|
|
2767
2925
|
inclusive = "inclusive",
|
|
2768
2926
|
inclusive_with_comments = "inclusive_with_comments"
|
|
2769
2927
|
}
|
|
2928
|
+
/**
|
|
2929
|
+
* @author Brett Pontarelli
|
|
2930
|
+
*/
|
|
2931
|
+
export declare enum CaptchaMethod {
|
|
2932
|
+
GoogleRecaptchaV2 = "GoogleRecaptchaV2",
|
|
2933
|
+
GoogleRecaptchaV3 = "GoogleRecaptchaV3",
|
|
2934
|
+
HCaptcha = "HCaptcha",
|
|
2935
|
+
HCaptchaEnterprise = "HCaptchaEnterprise"
|
|
2936
|
+
}
|
|
2770
2937
|
export interface CertificateInformation {
|
|
2771
2938
|
issuer?: string;
|
|
2772
2939
|
md5Fingerprint?: string;
|
|
@@ -2793,7 +2960,8 @@ export declare enum ChangePasswordReason {
|
|
|
2793
2960
|
*
|
|
2794
2961
|
* @author Brian Pontarelli
|
|
2795
2962
|
*/
|
|
2796
|
-
export interface ChangePasswordRequest {
|
|
2963
|
+
export interface ChangePasswordRequest extends BaseEventRequest {
|
|
2964
|
+
applicationId?: UUID;
|
|
2797
2965
|
currentPassword?: string;
|
|
2798
2966
|
loginId?: string;
|
|
2799
2967
|
password?: string;
|
|
@@ -2946,13 +3114,6 @@ export interface DailyActiveUserReportResponse {
|
|
|
2946
3114
|
dailyActiveUsers?: Array<Count>;
|
|
2947
3115
|
total?: number;
|
|
2948
3116
|
}
|
|
2949
|
-
/**
|
|
2950
|
-
* Helper for dealing with default values.
|
|
2951
|
-
*
|
|
2952
|
-
* @author Brian Pontarelli
|
|
2953
|
-
*/
|
|
2954
|
-
export interface DefaultTools {
|
|
2955
|
-
}
|
|
2956
3117
|
export interface DeleteConfiguration extends Enableable {
|
|
2957
3118
|
numberOfDaysToRetain?: number;
|
|
2958
3119
|
}
|
|
@@ -2995,6 +3156,7 @@ export declare enum DeviceType {
|
|
|
2995
3156
|
*/
|
|
2996
3157
|
export interface DisplayableRawLogin extends RawLogin {
|
|
2997
3158
|
applicationName?: string;
|
|
3159
|
+
location?: Location;
|
|
2998
3160
|
loginId?: string;
|
|
2999
3161
|
}
|
|
3000
3162
|
/**
|
|
@@ -3031,16 +3193,28 @@ export interface EmailAddress {
|
|
|
3031
3193
|
* @author Brian Pontarelli
|
|
3032
3194
|
*/
|
|
3033
3195
|
export interface EmailConfiguration {
|
|
3196
|
+
additionalHeaders?: Array<EmailHeader>;
|
|
3034
3197
|
defaultFromEmail?: string;
|
|
3035
3198
|
defaultFromName?: string;
|
|
3199
|
+
emailUpdateEmailTemplateId?: UUID;
|
|
3200
|
+
emailVerifiedEmailTemplateId?: UUID;
|
|
3036
3201
|
forgotPasswordEmailTemplateId?: UUID;
|
|
3037
3202
|
host?: string;
|
|
3203
|
+
implicitEmailVerificationAllowed?: boolean;
|
|
3204
|
+
loginIdInUseOnCreateEmailTemplateId?: UUID;
|
|
3205
|
+
loginIdInUseOnUpdateEmailTemplateId?: UUID;
|
|
3206
|
+
loginNewDeviceEmailTemplateId?: UUID;
|
|
3207
|
+
loginSuspiciousEmailTemplateId?: UUID;
|
|
3038
3208
|
password?: string;
|
|
3039
3209
|
passwordlessEmailTemplateId?: UUID;
|
|
3210
|
+
passwordResetSuccessEmailTemplateId?: UUID;
|
|
3211
|
+
passwordUpdateEmailTemplateId?: UUID;
|
|
3040
3212
|
port?: number;
|
|
3041
3213
|
properties?: string;
|
|
3042
3214
|
security?: EmailSecurityType;
|
|
3043
3215
|
setPasswordEmailTemplateId?: UUID;
|
|
3216
|
+
twoFactorMethodAddEmailTemplateId?: UUID;
|
|
3217
|
+
twoFactorMethodRemoveEmailTemplateId?: UUID;
|
|
3044
3218
|
unverified?: EmailUnverifiedOptions;
|
|
3045
3219
|
username?: string;
|
|
3046
3220
|
verificationEmailTemplateId?: UUID;
|
|
@@ -3048,6 +3222,13 @@ export interface EmailConfiguration {
|
|
|
3048
3222
|
verifyEmail?: boolean;
|
|
3049
3223
|
verifyEmailWhenChanged?: boolean;
|
|
3050
3224
|
}
|
|
3225
|
+
/**
|
|
3226
|
+
* @author Daniel DeGroff
|
|
3227
|
+
*/
|
|
3228
|
+
export interface EmailHeader {
|
|
3229
|
+
name?: string;
|
|
3230
|
+
value?: string;
|
|
3231
|
+
}
|
|
3051
3232
|
export interface EmailPlus extends Enableable {
|
|
3052
3233
|
emailTemplateId?: UUID;
|
|
3053
3234
|
maximumTimeToSendEmailInHours?: number;
|
|
@@ -3336,6 +3517,7 @@ export interface EpicGamesIdentityProvider extends BaseIdentityProvider<EpicGame
|
|
|
3336
3517
|
*/
|
|
3337
3518
|
export interface Error {
|
|
3338
3519
|
code?: string;
|
|
3520
|
+
data?: Record<string, any>;
|
|
3339
3521
|
message?: string;
|
|
3340
3522
|
}
|
|
3341
3523
|
/**
|
|
@@ -3356,6 +3538,21 @@ export interface EventConfiguration {
|
|
|
3356
3538
|
export interface EventConfigurationData extends Enableable {
|
|
3357
3539
|
transactionType?: TransactionType;
|
|
3358
3540
|
}
|
|
3541
|
+
/**
|
|
3542
|
+
* Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
|
|
3543
|
+
*
|
|
3544
|
+
* @author Brian Pontarelli
|
|
3545
|
+
*/
|
|
3546
|
+
export interface EventInfo {
|
|
3547
|
+
data?: Record<string, any>;
|
|
3548
|
+
deviceDescription?: string;
|
|
3549
|
+
deviceName?: string;
|
|
3550
|
+
deviceType?: string;
|
|
3551
|
+
ipAddress?: string;
|
|
3552
|
+
location?: Location;
|
|
3553
|
+
os?: string;
|
|
3554
|
+
userAgent?: string;
|
|
3555
|
+
}
|
|
3359
3556
|
/**
|
|
3360
3557
|
* Event log used internally by FusionAuth to help developers debug hooks, Webhooks, email templates, etc.
|
|
3361
3558
|
*
|
|
@@ -3370,6 +3567,14 @@ export interface EventLog {
|
|
|
3370
3567
|
export interface EventLogConfiguration {
|
|
3371
3568
|
numberToRetain?: number;
|
|
3372
3569
|
}
|
|
3570
|
+
/**
|
|
3571
|
+
* Event event to an event log was created.
|
|
3572
|
+
*
|
|
3573
|
+
* @author Daniel DeGroff
|
|
3574
|
+
*/
|
|
3575
|
+
export interface EventLogCreateEvent extends BaseEvent {
|
|
3576
|
+
eventLog?: EventLog;
|
|
3577
|
+
}
|
|
3373
3578
|
/**
|
|
3374
3579
|
* Event log response.
|
|
3375
3580
|
*
|
|
@@ -3428,24 +3633,44 @@ export interface EventRequest {
|
|
|
3428
3633
|
* @author Brian Pontarelli
|
|
3429
3634
|
*/
|
|
3430
3635
|
export declare enum EventType {
|
|
3431
|
-
|
|
3432
|
-
UserCreate = "user.create",
|
|
3433
|
-
UserUpdate = "user.update",
|
|
3434
|
-
UserDeactivate = "user.deactivate",
|
|
3435
|
-
UserBulkCreate = "user.bulk.create",
|
|
3436
|
-
UserReactivate = "user.reactivate",
|
|
3437
|
-
UserAction = "user.action",
|
|
3636
|
+
JWTPublicKeyUpdate = "jwt.public-key.update",
|
|
3438
3637
|
JWTRefreshTokenRevoke = "jwt.refresh-token.revoke",
|
|
3439
3638
|
JWTRefresh = "jwt.refresh",
|
|
3440
|
-
|
|
3441
|
-
|
|
3639
|
+
AuditLogCreate = "audit-log.create",
|
|
3640
|
+
EventLogCreate = "event-log.create",
|
|
3641
|
+
KickstartSuccess = "kickstart.success",
|
|
3642
|
+
UserAction = "user.action",
|
|
3643
|
+
UserBulkCreate = "user.bulk.create",
|
|
3644
|
+
UserCreate = "user.create",
|
|
3645
|
+
UserCreateComplete = "user.create.complete",
|
|
3646
|
+
UserDeactivate = "user.deactivate",
|
|
3647
|
+
UserDelete = "user.delete",
|
|
3648
|
+
UserDeleteComplete = "user.delete.complete",
|
|
3649
|
+
UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
|
|
3650
|
+
UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
|
|
3651
|
+
UserEmailUpdate = "user.email.update",
|
|
3652
|
+
UserEmailVerified = "user.email.verified",
|
|
3442
3653
|
UserLoginFailed = "user.login.failed",
|
|
3654
|
+
UserLoginNewDevice = "user.login.new-device",
|
|
3655
|
+
UserLoginSuccess = "user.login.success",
|
|
3656
|
+
UserLoginSuspicious = "user.login.suspicious",
|
|
3657
|
+
UserPasswordBreach = "user.password.breach",
|
|
3658
|
+
UserPasswordResetSend = "user.password.reset.send",
|
|
3659
|
+
UserPasswordResetStart = "user.password.reset.start",
|
|
3660
|
+
UserPasswordResetSuccess = "user.password.reset.success",
|
|
3661
|
+
UserPasswordUpdate = "user.password.update",
|
|
3662
|
+
UserReactivate = "user.reactivate",
|
|
3443
3663
|
UserRegistrationCreate = "user.registration.create",
|
|
3444
|
-
|
|
3664
|
+
UserRegistrationCreateComplete = "user.registration.create.complete",
|
|
3445
3665
|
UserRegistrationDelete = "user.registration.delete",
|
|
3666
|
+
UserRegistrationDeleteComplete = "user.registration.delete.complete",
|
|
3667
|
+
UserRegistrationUpdate = "user.registration.update",
|
|
3668
|
+
UserRegistrationUpdateComplete = "user.registration.update.complete",
|
|
3446
3669
|
UserRegistrationVerified = "user.registration.verified",
|
|
3447
|
-
|
|
3448
|
-
|
|
3670
|
+
UserTwoFactorMethodAdd = "user.two-factor.method.add",
|
|
3671
|
+
UserTwoFactorMethodRemove = "user.two-factor.method.remove",
|
|
3672
|
+
UserUpdate = "user.update",
|
|
3673
|
+
UserUpdateComplete = "user.update.complete",
|
|
3449
3674
|
Test = "test"
|
|
3450
3675
|
}
|
|
3451
3676
|
/**
|
|
@@ -3614,7 +3839,7 @@ export declare enum FamilyRole {
|
|
|
3614
3839
|
*
|
|
3615
3840
|
* @author Brian Pontarelli
|
|
3616
3841
|
*/
|
|
3617
|
-
export interface ForgotPasswordRequest {
|
|
3842
|
+
export interface ForgotPasswordRequest extends BaseEventRequest {
|
|
3618
3843
|
applicationId?: UUID;
|
|
3619
3844
|
changePasswordId?: string;
|
|
3620
3845
|
email?: string;
|
|
@@ -3910,6 +4135,12 @@ export interface IdentityProviderDetails {
|
|
|
3910
4135
|
oauth2?: IdentityProviderOauth2Configuration;
|
|
3911
4136
|
type?: IdentityProviderType;
|
|
3912
4137
|
}
|
|
4138
|
+
/**
|
|
4139
|
+
* @author Daniel DeGroff
|
|
4140
|
+
*/
|
|
4141
|
+
export interface IdentityProviderLimitUserLinkingPolicy extends Enableable {
|
|
4142
|
+
maximumLinks?: number;
|
|
4143
|
+
}
|
|
3913
4144
|
/**
|
|
3914
4145
|
* @author Daniel DeGroff
|
|
3915
4146
|
*/
|
|
@@ -4017,6 +4248,13 @@ export interface IdentityProviderStartLoginRequest extends BaseLoginRequest {
|
|
|
4017
4248
|
export interface IdentityProviderStartLoginResponse {
|
|
4018
4249
|
code?: string;
|
|
4019
4250
|
}
|
|
4251
|
+
/**
|
|
4252
|
+
* @author Daniel DeGroff
|
|
4253
|
+
*/
|
|
4254
|
+
export interface IdentityProviderTenantConfiguration {
|
|
4255
|
+
data?: Record<string, any>;
|
|
4256
|
+
limitUserLinkCount?: IdentityProviderLimitUserLinkingPolicy;
|
|
4257
|
+
}
|
|
4020
4258
|
/**
|
|
4021
4259
|
* @author Daniel DeGroff
|
|
4022
4260
|
*/
|
|
@@ -4043,12 +4281,19 @@ export declare enum IdentityProviderType {
|
|
|
4043
4281
|
*
|
|
4044
4282
|
* @author Brian Pontarelli
|
|
4045
4283
|
*/
|
|
4046
|
-
export interface ImportRequest {
|
|
4284
|
+
export interface ImportRequest extends BaseEventRequest {
|
|
4047
4285
|
encryptionScheme?: string;
|
|
4048
4286
|
factor?: number;
|
|
4049
4287
|
users?: Array<User>;
|
|
4050
4288
|
validateDbConstraints?: boolean;
|
|
4051
4289
|
}
|
|
4290
|
+
/**
|
|
4291
|
+
* A marker interface indicating this event is not scoped to a tenant and will be sent to all webhooks.
|
|
4292
|
+
*
|
|
4293
|
+
* @author Daniel DeGroff
|
|
4294
|
+
*/
|
|
4295
|
+
export interface InstanceEvent extends NonTransactionalEvent {
|
|
4296
|
+
}
|
|
4052
4297
|
/**
|
|
4053
4298
|
* The Integration Request
|
|
4054
4299
|
*
|
|
@@ -4075,30 +4320,69 @@ export interface Integrations {
|
|
|
4075
4320
|
kafka?: KafkaConfiguration;
|
|
4076
4321
|
}
|
|
4077
4322
|
/**
|
|
4078
|
-
*
|
|
4079
|
-
*
|
|
4080
|
-
* @author Brian Pontarelli
|
|
4323
|
+
* @author Daniel DeGroff
|
|
4081
4324
|
*/
|
|
4082
|
-
export interface
|
|
4083
|
-
applicationId?: UUID;
|
|
4084
|
-
count?: number;
|
|
4085
|
-
decrementedCount?: number;
|
|
4086
|
-
period?: number;
|
|
4325
|
+
export interface IntrospectResponse extends Record<string, any> {
|
|
4087
4326
|
}
|
|
4088
4327
|
/**
|
|
4089
|
-
*
|
|
4328
|
+
* @author Brett Guy
|
|
4329
|
+
*/
|
|
4330
|
+
export interface IPAccessControlEntry {
|
|
4331
|
+
action?: IPAccessControlEntryAction;
|
|
4332
|
+
endIPAddress?: string;
|
|
4333
|
+
startIPAddress?: string;
|
|
4334
|
+
}
|
|
4335
|
+
/**
|
|
4336
|
+
* @author Brett Guy
|
|
4337
|
+
*/
|
|
4338
|
+
export declare enum IPAccessControlEntryAction {
|
|
4339
|
+
Allow = "Allow",
|
|
4340
|
+
Block = "Block"
|
|
4341
|
+
}
|
|
4342
|
+
/**
|
|
4343
|
+
* @author Brett Guy
|
|
4344
|
+
*/
|
|
4345
|
+
export interface IPAccessControlList {
|
|
4346
|
+
data?: Record<string, any>;
|
|
4347
|
+
entries?: Array<IPAccessControlEntry>;
|
|
4348
|
+
id?: UUID;
|
|
4349
|
+
insertInstant?: number;
|
|
4350
|
+
lastUpdateInstant?: number;
|
|
4351
|
+
name?: string;
|
|
4352
|
+
}
|
|
4353
|
+
/**
|
|
4354
|
+
* @author Brett Guy
|
|
4355
|
+
*/
|
|
4356
|
+
export interface IPAccessControlListRequest {
|
|
4357
|
+
ipAccessControlList?: IPAccessControlList;
|
|
4358
|
+
}
|
|
4359
|
+
/**
|
|
4360
|
+
* @author Brett Guy
|
|
4361
|
+
*/
|
|
4362
|
+
export interface IPAccessControlListResponse {
|
|
4363
|
+
ipAccessControlList?: IPAccessControlList;
|
|
4364
|
+
ipAccessControlLists?: Array<IPAccessControlList>;
|
|
4365
|
+
}
|
|
4366
|
+
/**
|
|
4367
|
+
* @author Brett Guy
|
|
4368
|
+
*/
|
|
4369
|
+
export interface IPAccessControlListSearchCriteria extends BaseSearchCriteria {
|
|
4370
|
+
name?: string;
|
|
4371
|
+
}
|
|
4372
|
+
/**
|
|
4373
|
+
* Search request for IP ACLs .
|
|
4090
4374
|
*
|
|
4091
|
-
* @author
|
|
4375
|
+
* @author Brett Guy
|
|
4092
4376
|
*/
|
|
4093
|
-
export interface
|
|
4094
|
-
|
|
4095
|
-
period?: number;
|
|
4096
|
-
userId?: UUID;
|
|
4377
|
+
export interface IPAccessControlListSearchRequest {
|
|
4378
|
+
search?: IPAccessControlListSearchCriteria;
|
|
4097
4379
|
}
|
|
4098
4380
|
/**
|
|
4099
|
-
* @author
|
|
4381
|
+
* @author Brett Guy
|
|
4100
4382
|
*/
|
|
4101
|
-
export interface
|
|
4383
|
+
export interface IPAccessControlListSearchResponse {
|
|
4384
|
+
ipAccessControlLists?: Array<IPAccessControlList>;
|
|
4385
|
+
total?: number;
|
|
4102
4386
|
}
|
|
4103
4387
|
/**
|
|
4104
4388
|
* @author Daniel DeGroff
|
|
@@ -4224,6 +4508,20 @@ export interface JWTRefreshTokenRevokeEvent extends BaseEvent {
|
|
|
4224
4508
|
user?: User;
|
|
4225
4509
|
userId?: UUID;
|
|
4226
4510
|
}
|
|
4511
|
+
/**
|
|
4512
|
+
* @author Daniel DeGroff
|
|
4513
|
+
*/
|
|
4514
|
+
export interface JWTVendRequest {
|
|
4515
|
+
claims?: Record<string, any>;
|
|
4516
|
+
keyId?: UUID;
|
|
4517
|
+
timeToLiveInSeconds?: number;
|
|
4518
|
+
}
|
|
4519
|
+
/**
|
|
4520
|
+
* @author Daniel DeGroff
|
|
4521
|
+
*/
|
|
4522
|
+
export interface JWTVendResponse {
|
|
4523
|
+
token?: string;
|
|
4524
|
+
}
|
|
4227
4525
|
/**
|
|
4228
4526
|
* @author Daniel DeGroff
|
|
4229
4527
|
*/
|
|
@@ -4305,10 +4603,13 @@ export declare enum KeyUse {
|
|
|
4305
4603
|
VerifyOnly = "VerifyOnly"
|
|
4306
4604
|
}
|
|
4307
4605
|
/**
|
|
4308
|
-
*
|
|
4606
|
+
* Event event to indicate kickstart has been successfully completed.
|
|
4309
4607
|
*
|
|
4310
|
-
* @author
|
|
4608
|
+
* @author Daniel DeGroff
|
|
4311
4609
|
*/
|
|
4610
|
+
export interface KickstartSuccessEvent extends BaseEvent {
|
|
4611
|
+
instanceId?: UUID;
|
|
4612
|
+
}
|
|
4312
4613
|
export interface Lambda extends Enableable {
|
|
4313
4614
|
body?: string;
|
|
4314
4615
|
debug?: boolean;
|
|
@@ -4427,6 +4728,20 @@ export interface LocalizedIntegers extends Record<string, number> {
|
|
|
4427
4728
|
*/
|
|
4428
4729
|
export interface LocalizedStrings extends Record<string, string> {
|
|
4429
4730
|
}
|
|
4731
|
+
/**
|
|
4732
|
+
* Location information. Useful for IP addresses and other displayable data objects.
|
|
4733
|
+
*
|
|
4734
|
+
* @author Brian Pontarelli
|
|
4735
|
+
*/
|
|
4736
|
+
export interface Location {
|
|
4737
|
+
city?: string;
|
|
4738
|
+
country?: string;
|
|
4739
|
+
displayString?: string;
|
|
4740
|
+
latitude?: number;
|
|
4741
|
+
longitude?: number;
|
|
4742
|
+
region?: string;
|
|
4743
|
+
zipcode?: string;
|
|
4744
|
+
}
|
|
4430
4745
|
/**
|
|
4431
4746
|
* A historical state of a user log event. Since events can be modified, this stores the historical state.
|
|
4432
4747
|
*
|
|
@@ -4528,6 +4843,7 @@ export interface LoginResponse {
|
|
|
4528
4843
|
refreshToken?: string;
|
|
4529
4844
|
registrationVerificationId?: string;
|
|
4530
4845
|
state?: Record<string, any>;
|
|
4846
|
+
threatsDetected?: Array<AuthenticationThreats>;
|
|
4531
4847
|
token?: string;
|
|
4532
4848
|
twoFactorId?: string;
|
|
4533
4849
|
twoFactorTrustId?: string;
|
|
@@ -4540,6 +4856,15 @@ export declare enum LogoutBehavior {
|
|
|
4540
4856
|
RedirectOnly = "RedirectOnly",
|
|
4541
4857
|
AllApplications = "AllApplications"
|
|
4542
4858
|
}
|
|
4859
|
+
/**
|
|
4860
|
+
* Request for the Logout API that can be used as an alternative to URL parameters.
|
|
4861
|
+
*
|
|
4862
|
+
* @author Brian Pontarelli
|
|
4863
|
+
*/
|
|
4864
|
+
export interface LogoutRequest extends BaseEventRequest {
|
|
4865
|
+
global?: boolean;
|
|
4866
|
+
refreshToken?: string;
|
|
4867
|
+
}
|
|
4543
4868
|
/**
|
|
4544
4869
|
* @author Daniel DeGroff
|
|
4545
4870
|
*/
|
|
@@ -4710,11 +5035,11 @@ export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoA
|
|
|
4710
5035
|
scope?: string;
|
|
4711
5036
|
}
|
|
4712
5037
|
/**
|
|
4713
|
-
*
|
|
5038
|
+
* A marker interface indicating this event cannot be made transactional.
|
|
4714
5039
|
*
|
|
4715
|
-
* @author
|
|
5040
|
+
* @author Daniel DeGroff
|
|
4716
5041
|
*/
|
|
4717
|
-
export interface
|
|
5042
|
+
export interface NonTransactionalEvent {
|
|
4718
5043
|
}
|
|
4719
5044
|
/**
|
|
4720
5045
|
* @author Daniel DeGroff
|
|
@@ -4965,7 +5290,9 @@ export interface PendingIdPLink {
|
|
|
4965
5290
|
displayName?: string;
|
|
4966
5291
|
email?: string;
|
|
4967
5292
|
identityProviderId?: UUID;
|
|
5293
|
+
identityProviderLinks?: Array<IdentityProviderLink>;
|
|
4968
5294
|
identityProviderName?: string;
|
|
5295
|
+
identityProviderTenantConfiguration?: IdentityProviderTenantConfiguration;
|
|
4969
5296
|
identityProviderType?: IdentityProviderType;
|
|
4970
5297
|
identityProviderUserId?: string;
|
|
4971
5298
|
user?: User;
|
|
@@ -5022,6 +5349,24 @@ export interface PublicKeyResponse {
|
|
|
5022
5349
|
publicKey?: string;
|
|
5023
5350
|
publicKeys?: Record<string, string>;
|
|
5024
5351
|
}
|
|
5352
|
+
/**
|
|
5353
|
+
* @author Daniel DeGroff
|
|
5354
|
+
*/
|
|
5355
|
+
export interface RateLimitedRequestConfiguration extends Enableable {
|
|
5356
|
+
limit?: number;
|
|
5357
|
+
timePeriodInSeconds?: number;
|
|
5358
|
+
}
|
|
5359
|
+
/**
|
|
5360
|
+
* @author Daniel DeGroff
|
|
5361
|
+
*/
|
|
5362
|
+
export declare enum RateLimitedRequestType {
|
|
5363
|
+
FailedLogin = "FailedLogin",
|
|
5364
|
+
ForgotPassword = "ForgotPassword",
|
|
5365
|
+
SendEmailVerification = "SendEmailVerification",
|
|
5366
|
+
SendPasswordless = "SendPasswordless",
|
|
5367
|
+
SendRegistrationVerification = "SendRegistrationVerification",
|
|
5368
|
+
SendTwoFactor = "SendTwoFactor"
|
|
5369
|
+
}
|
|
5025
5370
|
/**
|
|
5026
5371
|
* Raw login information for each time a user logs into an application.
|
|
5027
5372
|
*
|
|
@@ -5040,6 +5385,7 @@ export declare enum ReactorFeatureStatus {
|
|
|
5040
5385
|
ACTIVE = "ACTIVE",
|
|
5041
5386
|
DISCONNECTED = "DISCONNECTED",
|
|
5042
5387
|
PENDING = "PENDING",
|
|
5388
|
+
DISABLED = "DISABLED",
|
|
5043
5389
|
UNKNOWN = "UNKNOWN"
|
|
5044
5390
|
}
|
|
5045
5391
|
/**
|
|
@@ -5048,6 +5394,12 @@ export declare enum ReactorFeatureStatus {
|
|
|
5048
5394
|
export interface ReactorMetrics {
|
|
5049
5395
|
breachedPasswordMetrics?: Record<UUID, BreachedPasswordTenantMetric>;
|
|
5050
5396
|
}
|
|
5397
|
+
/**
|
|
5398
|
+
* @author Daniel DeGroff
|
|
5399
|
+
*/
|
|
5400
|
+
export interface ReactorMetricsResponse {
|
|
5401
|
+
metrics?: ReactorMetrics;
|
|
5402
|
+
}
|
|
5051
5403
|
/**
|
|
5052
5404
|
* Request for managing FusionAuth Reactor and licenses.
|
|
5053
5405
|
*
|
|
@@ -5061,7 +5413,6 @@ export interface ReactorRequest {
|
|
|
5061
5413
|
* @author Daniel DeGroff
|
|
5062
5414
|
*/
|
|
5063
5415
|
export interface ReactorResponse {
|
|
5064
|
-
metrics?: ReactorMetrics;
|
|
5065
5416
|
status?: ReactorStatus;
|
|
5066
5417
|
}
|
|
5067
5418
|
/**
|
|
@@ -5076,6 +5427,7 @@ export interface ReactorStatus {
|
|
|
5076
5427
|
connectors?: ReactorFeatureStatus;
|
|
5077
5428
|
entityManagement?: ReactorFeatureStatus;
|
|
5078
5429
|
licensed?: boolean;
|
|
5430
|
+
threatDetection?: ReactorFeatureStatus;
|
|
5079
5431
|
}
|
|
5080
5432
|
/**
|
|
5081
5433
|
* Response for the user login report.
|
|
@@ -5088,7 +5440,7 @@ export interface RecentLoginResponse {
|
|
|
5088
5440
|
/**
|
|
5089
5441
|
* @author Daniel DeGroff
|
|
5090
5442
|
*/
|
|
5091
|
-
export interface RefreshRequest {
|
|
5443
|
+
export interface RefreshRequest extends BaseEventRequest {
|
|
5092
5444
|
refreshToken?: string;
|
|
5093
5445
|
token?: string;
|
|
5094
5446
|
}
|
|
@@ -5145,6 +5497,16 @@ export interface RefreshTokenRevocationPolicy {
|
|
|
5145
5497
|
onLoginPrevented?: boolean;
|
|
5146
5498
|
onPasswordChanged?: boolean;
|
|
5147
5499
|
}
|
|
5500
|
+
/**
|
|
5501
|
+
* Request for the Refresh Token API to revoke a refresh token rather than using the URL parameters.
|
|
5502
|
+
*
|
|
5503
|
+
* @author Brian Pontarelli
|
|
5504
|
+
*/
|
|
5505
|
+
export interface RefreshTokenRevokeRequest extends BaseEventRequest {
|
|
5506
|
+
applicationId?: UUID;
|
|
5507
|
+
token?: string;
|
|
5508
|
+
userId?: UUID;
|
|
5509
|
+
}
|
|
5148
5510
|
/**
|
|
5149
5511
|
* @author Daniel DeGroff
|
|
5150
5512
|
*/
|
|
@@ -5164,6 +5526,13 @@ export interface RegistrationConfiguration extends Enableable {
|
|
|
5164
5526
|
mobilePhone?: Requirable;
|
|
5165
5527
|
type?: RegistrationType;
|
|
5166
5528
|
}
|
|
5529
|
+
/**
|
|
5530
|
+
* Registration delete API request object.
|
|
5531
|
+
*
|
|
5532
|
+
* @author Brian Pontarelli
|
|
5533
|
+
*/
|
|
5534
|
+
export interface RegistrationDeleteRequest extends BaseEventRequest {
|
|
5535
|
+
}
|
|
5167
5536
|
/**
|
|
5168
5537
|
* Response for the registration report.
|
|
5169
5538
|
*
|
|
@@ -5178,7 +5547,8 @@ export interface RegistrationReportResponse {
|
|
|
5178
5547
|
*
|
|
5179
5548
|
* @author Brian Pontarelli
|
|
5180
5549
|
*/
|
|
5181
|
-
export interface RegistrationRequest {
|
|
5550
|
+
export interface RegistrationRequest extends BaseEventRequest {
|
|
5551
|
+
disableDomainBlock?: boolean;
|
|
5182
5552
|
generateAuthenticationToken?: boolean;
|
|
5183
5553
|
registration?: UserRegistration;
|
|
5184
5554
|
sendSetPasswordEmail?: boolean;
|
|
@@ -5562,11 +5932,14 @@ export interface Templates {
|
|
|
5562
5932
|
registrationVerificationRequired?: string;
|
|
5563
5933
|
registrationVerify?: string;
|
|
5564
5934
|
samlv2Logout?: string;
|
|
5935
|
+
unauthorized?: string;
|
|
5565
5936
|
}
|
|
5566
5937
|
/**
|
|
5567
5938
|
* @author Daniel DeGroff
|
|
5568
5939
|
*/
|
|
5569
5940
|
export interface Tenant {
|
|
5941
|
+
accessControlConfiguration?: TenantAccessControlConfiguration;
|
|
5942
|
+
captchaConfiguration?: TenantCaptchaConfiguration;
|
|
5570
5943
|
configured?: boolean;
|
|
5571
5944
|
connectorPolicies?: Array<ConnectorPolicy>;
|
|
5572
5945
|
data?: Record<string, any>;
|
|
@@ -5591,6 +5964,9 @@ export interface Tenant {
|
|
|
5591
5964
|
oauthConfiguration?: TenantOAuth2Configuration;
|
|
5592
5965
|
passwordEncryptionConfiguration?: PasswordEncryptionConfiguration;
|
|
5593
5966
|
passwordValidationRules?: PasswordValidationRules;
|
|
5967
|
+
rateLimitConfiguration?: TenantRateLimitConfiguration;
|
|
5968
|
+
registrationConfiguration?: TenantRegistrationConfiguration;
|
|
5969
|
+
ssoConfiguration?: TenantSSOConfiguration;
|
|
5594
5970
|
state?: ObjectState;
|
|
5595
5971
|
themeId?: UUID;
|
|
5596
5972
|
userDeletePolicy?: TenantUserDeletePolicy;
|
|
@@ -5601,6 +5977,29 @@ export interface Tenant {
|
|
|
5601
5977
|
*/
|
|
5602
5978
|
export interface Tenantable {
|
|
5603
5979
|
}
|
|
5980
|
+
/**
|
|
5981
|
+
* @author Brett Guy
|
|
5982
|
+
*/
|
|
5983
|
+
export interface TenantAccessControlConfiguration {
|
|
5984
|
+
uiIPAccessControlListId?: UUID;
|
|
5985
|
+
}
|
|
5986
|
+
/**
|
|
5987
|
+
* @author Brett Pontarelli
|
|
5988
|
+
*/
|
|
5989
|
+
export interface TenantCaptchaConfiguration extends Enableable {
|
|
5990
|
+
captchaMethod?: CaptchaMethod;
|
|
5991
|
+
secretKey?: string;
|
|
5992
|
+
siteKey?: string;
|
|
5993
|
+
threshold?: number;
|
|
5994
|
+
}
|
|
5995
|
+
/**
|
|
5996
|
+
* Request for the Tenant API to delete a tenant rather than using the URL parameters.
|
|
5997
|
+
*
|
|
5998
|
+
* @author Brian Pontarelli
|
|
5999
|
+
*/
|
|
6000
|
+
export interface TenantDeleteRequest extends BaseEventRequest {
|
|
6001
|
+
async?: boolean;
|
|
6002
|
+
}
|
|
5604
6003
|
/**
|
|
5605
6004
|
* @author Daniel DeGroff
|
|
5606
6005
|
*/
|
|
@@ -5627,7 +6026,24 @@ export interface TenantOAuth2Configuration {
|
|
|
5627
6026
|
/**
|
|
5628
6027
|
* @author Daniel DeGroff
|
|
5629
6028
|
*/
|
|
5630
|
-
export interface
|
|
6029
|
+
export interface TenantRateLimitConfiguration {
|
|
6030
|
+
failedLogin?: RateLimitedRequestConfiguration;
|
|
6031
|
+
forgotPassword?: RateLimitedRequestConfiguration;
|
|
6032
|
+
sendEmailVerification?: RateLimitedRequestConfiguration;
|
|
6033
|
+
sendPasswordless?: RateLimitedRequestConfiguration;
|
|
6034
|
+
sendRegistrationVerification?: RateLimitedRequestConfiguration;
|
|
6035
|
+
sendTwoFactor?: RateLimitedRequestConfiguration;
|
|
6036
|
+
}
|
|
6037
|
+
/**
|
|
6038
|
+
* @author Daniel DeGroff
|
|
6039
|
+
*/
|
|
6040
|
+
export interface TenantRegistrationConfiguration {
|
|
6041
|
+
blockedDomains?: Array<string>;
|
|
6042
|
+
}
|
|
6043
|
+
/**
|
|
6044
|
+
* @author Daniel DeGroff
|
|
6045
|
+
*/
|
|
6046
|
+
export interface TenantRequest extends BaseEventRequest {
|
|
5631
6047
|
sourceTenantId?: UUID;
|
|
5632
6048
|
tenant?: Tenant;
|
|
5633
6049
|
}
|
|
@@ -5638,6 +6054,12 @@ export interface TenantResponse {
|
|
|
5638
6054
|
tenant?: Tenant;
|
|
5639
6055
|
tenants?: Array<Tenant>;
|
|
5640
6056
|
}
|
|
6057
|
+
/**
|
|
6058
|
+
* @author Brett Pontarelli
|
|
6059
|
+
*/
|
|
6060
|
+
export interface TenantSSOConfiguration {
|
|
6061
|
+
deviceTrustTimeToLiveInSeconds?: number;
|
|
6062
|
+
}
|
|
5641
6063
|
/**
|
|
5642
6064
|
* @author Daniel DeGroff
|
|
5643
6065
|
*/
|
|
@@ -5800,6 +6222,14 @@ export interface TwitterIdentityProvider extends BaseIdentityProvider<TwitterApp
|
|
|
5800
6222
|
consumerKey?: string;
|
|
5801
6223
|
consumerSecret?: string;
|
|
5802
6224
|
}
|
|
6225
|
+
/**
|
|
6226
|
+
* @author Brian Pontarelli
|
|
6227
|
+
*/
|
|
6228
|
+
export interface TwoFactorDisableRequest extends BaseEventRequest {
|
|
6229
|
+
applicationId?: UUID;
|
|
6230
|
+
code?: string;
|
|
6231
|
+
methodId?: string;
|
|
6232
|
+
}
|
|
5803
6233
|
/**
|
|
5804
6234
|
* @author Daniel DeGroff
|
|
5805
6235
|
*/
|
|
@@ -5839,7 +6269,8 @@ export interface TwoFactorRecoveryCodeResponse {
|
|
|
5839
6269
|
/**
|
|
5840
6270
|
* @author Brian Pontarelli
|
|
5841
6271
|
*/
|
|
5842
|
-
export interface TwoFactorRequest {
|
|
6272
|
+
export interface TwoFactorRequest extends BaseEventRequest {
|
|
6273
|
+
applicationId?: UUID;
|
|
5843
6274
|
authenticatorId?: string;
|
|
5844
6275
|
code?: string;
|
|
5845
6276
|
email?: string;
|
|
@@ -6143,6 +6574,16 @@ export interface UserConsentResponse {
|
|
|
6143
6574
|
userConsent?: UserConsent;
|
|
6144
6575
|
userConsents?: Array<UserConsent>;
|
|
6145
6576
|
}
|
|
6577
|
+
/**
|
|
6578
|
+
* Models the User Created Event (and can be converted to JSON).
|
|
6579
|
+
* <p>
|
|
6580
|
+
* This is different than the user.create event in that it will be sent after the user has been created. This event cannot be made transactional.
|
|
6581
|
+
*
|
|
6582
|
+
* @author Daniel DeGroff
|
|
6583
|
+
*/
|
|
6584
|
+
export interface UserCreateCompleteEvent extends BaseEvent {
|
|
6585
|
+
user?: User;
|
|
6586
|
+
}
|
|
6146
6587
|
/**
|
|
6147
6588
|
* Models the User Create Event (and can be converted to JSON).
|
|
6148
6589
|
*
|
|
@@ -6159,6 +6600,17 @@ export interface UserCreateEvent extends BaseEvent {
|
|
|
6159
6600
|
export interface UserDeactivateEvent extends BaseEvent {
|
|
6160
6601
|
user?: User;
|
|
6161
6602
|
}
|
|
6603
|
+
/**
|
|
6604
|
+
* Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
|
|
6605
|
+
* delete).
|
|
6606
|
+
* <p>
|
|
6607
|
+
* This is different than user.delete because it is sent after the tx is committed, this cannot be transactional.
|
|
6608
|
+
*
|
|
6609
|
+
* @author Daniel DeGroff
|
|
6610
|
+
*/
|
|
6611
|
+
export interface UserDeleteCompleteEvent extends BaseEvent {
|
|
6612
|
+
user?: User;
|
|
6613
|
+
}
|
|
6162
6614
|
/**
|
|
6163
6615
|
* Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
|
|
6164
6616
|
* delete).
|
|
@@ -6173,7 +6625,7 @@ export interface UserDeleteEvent extends BaseEvent {
|
|
|
6173
6625
|
*
|
|
6174
6626
|
* @author Daniel DeGroff
|
|
6175
6627
|
*/
|
|
6176
|
-
export interface UserDeleteRequest {
|
|
6628
|
+
export interface UserDeleteRequest extends BaseEventRequest {
|
|
6177
6629
|
dryRun?: boolean;
|
|
6178
6630
|
hardDelete?: boolean;
|
|
6179
6631
|
query?: string;
|
|
@@ -6191,6 +6643,23 @@ export interface UserDeleteResponse {
|
|
|
6191
6643
|
total?: number;
|
|
6192
6644
|
userIds?: Array<string>;
|
|
6193
6645
|
}
|
|
6646
|
+
/**
|
|
6647
|
+
* User API delete request object for a single user.
|
|
6648
|
+
*
|
|
6649
|
+
* @author Brian Pontarelli
|
|
6650
|
+
*/
|
|
6651
|
+
export interface UserDeleteSingleRequest extends BaseEventRequest {
|
|
6652
|
+
hardDelete?: boolean;
|
|
6653
|
+
}
|
|
6654
|
+
/**
|
|
6655
|
+
* Models an event where a user's email is updated outside of a forgot / change password workflow.
|
|
6656
|
+
*
|
|
6657
|
+
* @author Daniel DeGroff
|
|
6658
|
+
*/
|
|
6659
|
+
export interface UserEmailUpdateEvent extends BaseEvent {
|
|
6660
|
+
previousEmail?: string;
|
|
6661
|
+
user?: User;
|
|
6662
|
+
}
|
|
6194
6663
|
/**
|
|
6195
6664
|
* Models the User Email Verify Event (and can be converted to JSON).
|
|
6196
6665
|
*
|
|
@@ -6215,6 +6684,31 @@ export interface UserLoginFailedEvent extends BaseEvent {
|
|
|
6215
6684
|
ipAddress?: string;
|
|
6216
6685
|
user?: User;
|
|
6217
6686
|
}
|
|
6687
|
+
/**
|
|
6688
|
+
* Models an event where a user is being created with an "in-use" login Id (email or username).
|
|
6689
|
+
*
|
|
6690
|
+
* @author Daniel DeGroff
|
|
6691
|
+
*/
|
|
6692
|
+
export interface UserLoginIdDuplicateOnCreateEvent extends BaseEvent {
|
|
6693
|
+
duplicateEmail?: string;
|
|
6694
|
+
duplicateUsername?: string;
|
|
6695
|
+
existing?: User;
|
|
6696
|
+
user?: User;
|
|
6697
|
+
}
|
|
6698
|
+
/**
|
|
6699
|
+
* Models an event where a user is being updated and tries to use an "in-use" login Id (email or username).
|
|
6700
|
+
*
|
|
6701
|
+
* @author Daniel DeGroff
|
|
6702
|
+
*/
|
|
6703
|
+
export interface UserLoginIdDuplicateOnUpdateEvent extends UserLoginIdDuplicateOnCreateEvent {
|
|
6704
|
+
}
|
|
6705
|
+
/**
|
|
6706
|
+
* Models the User Login event for a new device (un-recognized)
|
|
6707
|
+
*
|
|
6708
|
+
* @author Daniel DeGroff
|
|
6709
|
+
*/
|
|
6710
|
+
export interface UserLoginNewDeviceEvent extends UserLoginSuccessEvent {
|
|
6711
|
+
}
|
|
6218
6712
|
/**
|
|
6219
6713
|
* Models the User Login Success Event.
|
|
6220
6714
|
*
|
|
@@ -6229,6 +6723,14 @@ export interface UserLoginSuccessEvent extends BaseEvent {
|
|
|
6229
6723
|
ipAddress?: string;
|
|
6230
6724
|
user?: User;
|
|
6231
6725
|
}
|
|
6726
|
+
/**
|
|
6727
|
+
* Models the User Login event that is suspicious.
|
|
6728
|
+
*
|
|
6729
|
+
* @author Daniel DeGroff
|
|
6730
|
+
*/
|
|
6731
|
+
export interface UserLoginSuspiciousEvent extends UserLoginSuccessEvent {
|
|
6732
|
+
threatsDetected?: Array<AuthenticationThreats>;
|
|
6733
|
+
}
|
|
6232
6734
|
export interface UsernameModeration extends Enableable {
|
|
6233
6735
|
applicationId?: UUID;
|
|
6234
6736
|
}
|
|
@@ -6240,6 +6742,38 @@ export interface UsernameModeration extends Enableable {
|
|
|
6240
6742
|
export interface UserPasswordBreachEvent extends BaseEvent {
|
|
6241
6743
|
user?: User;
|
|
6242
6744
|
}
|
|
6745
|
+
/**
|
|
6746
|
+
* Models the User Password Reset Send Event.
|
|
6747
|
+
*
|
|
6748
|
+
* @author Daniel DeGroff
|
|
6749
|
+
*/
|
|
6750
|
+
export interface UserPasswordResetSendEvent extends BaseEvent {
|
|
6751
|
+
user?: User;
|
|
6752
|
+
}
|
|
6753
|
+
/**
|
|
6754
|
+
* Models the User Password Reset Start Event.
|
|
6755
|
+
*
|
|
6756
|
+
* @author Daniel DeGroff
|
|
6757
|
+
*/
|
|
6758
|
+
export interface UserPasswordResetStartEvent extends BaseEvent {
|
|
6759
|
+
user?: User;
|
|
6760
|
+
}
|
|
6761
|
+
/**
|
|
6762
|
+
* Models the User Password Reset Success Event.
|
|
6763
|
+
*
|
|
6764
|
+
* @author Daniel DeGroff
|
|
6765
|
+
*/
|
|
6766
|
+
export interface UserPasswordResetSuccessEvent extends BaseEvent {
|
|
6767
|
+
user?: User;
|
|
6768
|
+
}
|
|
6769
|
+
/**
|
|
6770
|
+
* Models the User Password Update Event.
|
|
6771
|
+
*
|
|
6772
|
+
* @author Daniel DeGroff
|
|
6773
|
+
*/
|
|
6774
|
+
export interface UserPasswordUpdateEvent extends BaseEvent {
|
|
6775
|
+
user?: User;
|
|
6776
|
+
}
|
|
6243
6777
|
/**
|
|
6244
6778
|
* Models the User Reactivate Event (and can be converted to JSON).
|
|
6245
6779
|
*
|
|
@@ -6270,6 +6804,18 @@ export interface UserRegistration {
|
|
|
6270
6804
|
usernameStatus?: ContentStatus;
|
|
6271
6805
|
verified?: boolean;
|
|
6272
6806
|
}
|
|
6807
|
+
/**
|
|
6808
|
+
* Models the User Created Registration Event (and can be converted to JSON).
|
|
6809
|
+
* <p>
|
|
6810
|
+
* This is different than the user.registration.create event in that it will be sent after the user has been created. This event cannot be made transactional.
|
|
6811
|
+
*
|
|
6812
|
+
* @author Daniel DeGroff
|
|
6813
|
+
*/
|
|
6814
|
+
export interface UserRegistrationCreateCompleteEvent extends BaseEvent {
|
|
6815
|
+
applicationId?: UUID;
|
|
6816
|
+
registration?: UserRegistration;
|
|
6817
|
+
user?: User;
|
|
6818
|
+
}
|
|
6273
6819
|
/**
|
|
6274
6820
|
* Models the User Create Registration Event (and can be converted to JSON).
|
|
6275
6821
|
*
|
|
@@ -6280,6 +6826,18 @@ export interface UserRegistrationCreateEvent extends BaseEvent {
|
|
|
6280
6826
|
registration?: UserRegistration;
|
|
6281
6827
|
user?: User;
|
|
6282
6828
|
}
|
|
6829
|
+
/**
|
|
6830
|
+
* Models the User Deleted Registration Event (and can be converted to JSON).
|
|
6831
|
+
* <p>
|
|
6832
|
+
* This is different than user.registration.delete in that it is sent after the TX has been committed. This event cannot be transactional.
|
|
6833
|
+
*
|
|
6834
|
+
* @author Daniel DeGroff
|
|
6835
|
+
*/
|
|
6836
|
+
export interface UserRegistrationDeleteCompleteEvent extends BaseEvent {
|
|
6837
|
+
applicationId?: UUID;
|
|
6838
|
+
registration?: UserRegistration;
|
|
6839
|
+
user?: User;
|
|
6840
|
+
}
|
|
6283
6841
|
/**
|
|
6284
6842
|
* Models the User Delete Registration Event (and can be converted to JSON).
|
|
6285
6843
|
*
|
|
@@ -6290,6 +6848,19 @@ export interface UserRegistrationDeleteEvent extends BaseEvent {
|
|
|
6290
6848
|
registration?: UserRegistration;
|
|
6291
6849
|
user?: User;
|
|
6292
6850
|
}
|
|
6851
|
+
/**
|
|
6852
|
+
* Models the User Update Registration Event (and can be converted to JSON).
|
|
6853
|
+
* <p>
|
|
6854
|
+
* This is different than user.registration.update in that it is sent after this event completes, this cannot be transactional.
|
|
6855
|
+
*
|
|
6856
|
+
* @author Daniel DeGroff
|
|
6857
|
+
*/
|
|
6858
|
+
export interface UserRegistrationUpdateCompleteEvent extends BaseEvent {
|
|
6859
|
+
applicationId?: UUID;
|
|
6860
|
+
original?: UserRegistration;
|
|
6861
|
+
registration?: UserRegistration;
|
|
6862
|
+
user?: User;
|
|
6863
|
+
}
|
|
6293
6864
|
/**
|
|
6294
6865
|
* Models the User Update Registration Event (and can be converted to JSON).
|
|
6295
6866
|
*
|
|
@@ -6316,7 +6887,9 @@ export interface UserRegistrationVerifiedEvent extends BaseEvent {
|
|
|
6316
6887
|
*
|
|
6317
6888
|
* @author Brian Pontarelli
|
|
6318
6889
|
*/
|
|
6319
|
-
export interface UserRequest {
|
|
6890
|
+
export interface UserRequest extends BaseEventRequest {
|
|
6891
|
+
applicationId?: UUID;
|
|
6892
|
+
disableDomainBlock?: boolean;
|
|
6320
6893
|
sendSetPasswordEmail?: boolean;
|
|
6321
6894
|
skipVerification?: boolean;
|
|
6322
6895
|
user?: User;
|
|
@@ -6355,6 +6928,33 @@ export interface UserTwoFactorConfiguration {
|
|
|
6355
6928
|
methods?: Array<TwoFactorMethod>;
|
|
6356
6929
|
recoveryCodes?: Array<string>;
|
|
6357
6930
|
}
|
|
6931
|
+
/**
|
|
6932
|
+
* Model a user event when a two-factor method has been removed.
|
|
6933
|
+
*
|
|
6934
|
+
* @author Daniel DeGroff
|
|
6935
|
+
*/
|
|
6936
|
+
export interface UserTwoFactorMethodAddEvent extends BaseEvent {
|
|
6937
|
+
method?: TwoFactorMethod;
|
|
6938
|
+
user?: User;
|
|
6939
|
+
}
|
|
6940
|
+
/**
|
|
6941
|
+
* Model a user event when a two-factor method has been added.
|
|
6942
|
+
*
|
|
6943
|
+
* @author Daniel DeGroff
|
|
6944
|
+
*/
|
|
6945
|
+
export interface UserTwoFactorMethodRemoveEvent extends BaseEvent {
|
|
6946
|
+
method?: TwoFactorMethod;
|
|
6947
|
+
user?: User;
|
|
6948
|
+
}
|
|
6949
|
+
/**
|
|
6950
|
+
* Models the User Update Event once it is completed. This cannot be transactional.
|
|
6951
|
+
*
|
|
6952
|
+
* @author Daniel DeGroff
|
|
6953
|
+
*/
|
|
6954
|
+
export interface UserUpdateCompleteEvent extends BaseEvent {
|
|
6955
|
+
original?: User;
|
|
6956
|
+
user?: User;
|
|
6957
|
+
}
|
|
6358
6958
|
/**
|
|
6359
6959
|
* Models the User Update Event (and can be converted to JSON).
|
|
6360
6960
|
*
|
|
@@ -6380,7 +6980,7 @@ export declare enum VerificationStrategy {
|
|
|
6380
6980
|
/**
|
|
6381
6981
|
* @author Daniel DeGroff
|
|
6382
6982
|
*/
|
|
6383
|
-
export interface VerifyEmailRequest {
|
|
6983
|
+
export interface VerifyEmailRequest extends BaseEventRequest {
|
|
6384
6984
|
oneTimeCode?: string;
|
|
6385
6985
|
verificationId?: string;
|
|
6386
6986
|
}
|
|
@@ -6394,7 +6994,7 @@ export interface VerifyEmailResponse {
|
|
|
6394
6994
|
/**
|
|
6395
6995
|
* @author Daniel DeGroff
|
|
6396
6996
|
*/
|
|
6397
|
-
export interface VerifyRegistrationRequest {
|
|
6997
|
+
export interface VerifyRegistrationRequest extends BaseEventRequest {
|
|
6398
6998
|
oneTimeCode?: string;
|
|
6399
6999
|
verificationId?: string;
|
|
6400
7000
|
}
|