@fusionauth/typescript-client 1.52.0 → 1.53.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.
@@ -2075,6 +2075,20 @@ export declare class FusionAuthClient {
2075
2075
  * @returns {Promise<ClientResponse<WebhookResponse>>}
2076
2076
  */
2077
2077
  retrieveWebhook(webhookId: UUID): Promise<ClientResponse<WebhookResponse>>;
2078
+ /**
2079
+ * Retrieves a single webhook attempt log for the given Id.
2080
+ *
2081
+ * @param {UUID} webhookAttemptLogId The Id of the webhook attempt log to retrieve.
2082
+ * @returns {Promise<ClientResponse<WebhookAttemptLogResponse>>}
2083
+ */
2084
+ retrieveWebhookAttemptLog(webhookAttemptLogId: UUID): Promise<ClientResponse<WebhookAttemptLogResponse>>;
2085
+ /**
2086
+ * Retrieves a single webhook event log for the given Id.
2087
+ *
2088
+ * @param {UUID} webhookEventLogId The Id of the webhook event log to retrieve.
2089
+ * @returns {Promise<ClientResponse<WebhookEventLogResponse>>}
2090
+ */
2091
+ retrieveWebhookEventLog(webhookEventLogId: UUID): Promise<ClientResponse<WebhookEventLogResponse>>;
2078
2092
  /**
2079
2093
  * Retrieves all the webhooks.
2080
2094
  *
@@ -2331,6 +2345,13 @@ export declare class FusionAuthClient {
2331
2345
  * @deprecated This method has been renamed to searchUsersByQuery, use that method instead.
2332
2346
  */
2333
2347
  searchUsersByQueryString(request: SearchRequest): Promise<ClientResponse<SearchResponse>>;
2348
+ /**
2349
+ * Searches the webhook event logs with the specified criteria and pagination.
2350
+ *
2351
+ * @param {WebhookEventLogSearchRequest} request The search criteria and pagination information.
2352
+ * @returns {Promise<ClientResponse<WebhookEventLogSearchResponse>>}
2353
+ */
2354
+ searchWebhookEventLogs(request: WebhookEventLogSearchRequest): Promise<ClientResponse<WebhookEventLogSearchResponse>>;
2334
2355
  /**
2335
2356
  * Searches webhooks with the specified criteria and pagination.
2336
2357
  *
@@ -2790,10 +2811,19 @@ export default FusionAuthClient;
2790
2811
  * A 128 bit UUID in string format "8-4-4-4-12", for example "58D5E212-165B-4CA0-909B-C86B9CEE0111".
2791
2812
  */
2792
2813
  export declare type UUID = string;
2814
+ /**
2815
+ * Webhook attempt log response.
2816
+ *
2817
+ * @author Spencer Witt
2818
+ */
2819
+ export interface WebhookAttemptLogResponse {
2820
+ webhookAttemptLog?: WebhookAttemptLog;
2821
+ }
2793
2822
  /**
2794
2823
  * @author Rob Davis
2795
2824
  */
2796
2825
  export interface TenantLambdaConfiguration {
2826
+ loginValidationId?: UUID;
2797
2827
  scimEnterpriseUserRequestConverterId?: UUID;
2798
2828
  scimEnterpriseUserResponseConverterId?: UUID;
2799
2829
  scimGroupRequestConverterId?: UUID;
@@ -2825,7 +2855,7 @@ export interface UserActionReason {
2825
2855
  export interface AuthenticationTokenConfiguration extends Enableable {
2826
2856
  }
2827
2857
  /**
2828
- * Event event to an audit log was created.
2858
+ * Event to indicate an audit log was created.
2829
2859
  *
2830
2860
  * @author Daniel DeGroff
2831
2861
  */
@@ -2921,10 +2951,9 @@ export interface ApplicationRegistrationDeletePolicy {
2921
2951
  *
2922
2952
  * @author Daniel DeGroff
2923
2953
  */
2924
- export interface UserRegistrationDeleteEvent extends BaseEvent {
2954
+ export interface UserRegistrationDeleteEvent extends BaseUserEvent {
2925
2955
  applicationId?: UUID;
2926
2956
  registration?: UserRegistration;
2927
- user?: User;
2928
2957
  }
2929
2958
  /**
2930
2959
  * @author Daniel DeGroff
@@ -2967,8 +2996,7 @@ export interface UserComment {
2967
2996
  *
2968
2997
  * @author Daniel DeGroff
2969
2998
  */
2970
- export interface GroupDeleteCompleteEvent extends BaseEvent {
2971
- group?: Group;
2999
+ export interface GroupDeleteCompleteEvent extends BaseGroupEvent {
2972
3000
  }
2973
3001
  /**
2974
3002
  * Email template search response
@@ -3128,8 +3156,7 @@ export interface EmailTemplate {
3128
3156
  *
3129
3157
  * @author Trevor Smith
3130
3158
  */
3131
- export interface UserEmailVerifiedEvent extends BaseEvent {
3132
- user?: User;
3159
+ export interface UserEmailVerifiedEvent extends BaseUserEvent {
3133
3160
  }
3134
3161
  /**
3135
3162
  * @author Daniel DeGroff
@@ -3194,8 +3221,7 @@ export interface ConsentSearchRequest {
3194
3221
  *
3195
3222
  * @author Brian Pontarelli
3196
3223
  */
3197
- export interface UserReactivateEvent extends BaseEvent {
3198
- user?: User;
3224
+ export interface UserReactivateEvent extends BaseUserEvent {
3199
3225
  }
3200
3226
  /**
3201
3227
  * OpenID Connect Configuration as described by the <a href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata">OpenID
@@ -3301,9 +3327,8 @@ export interface AuditLog {
3301
3327
  *
3302
3328
  * @author Rob Davis
3303
3329
  */
3304
- export interface UserIdentityProviderLinkEvent extends BaseEvent {
3330
+ export interface UserIdentityProviderLinkEvent extends BaseUserEvent {
3305
3331
  identityProviderLink?: IdentityProviderLink;
3306
- user?: User;
3307
3332
  }
3308
3333
  /**
3309
3334
  * Application search response
@@ -3402,9 +3427,8 @@ export interface GroupMember {
3402
3427
  *
3403
3428
  * @author Brian Pontarelli
3404
3429
  */
3405
- export interface UserUpdateEvent extends BaseEvent {
3430
+ export interface UserUpdateEvent extends BaseUserEvent {
3406
3431
  original?: User;
3407
- user?: User;
3408
3432
  }
3409
3433
  /**
3410
3434
  * The application's relationship to the authorization server. First-party applications will be granted implicit permission for requested scopes.
@@ -3490,8 +3514,7 @@ export interface TwoFactorStartRequest {
3490
3514
  *
3491
3515
  * @author Daniel DeGroff
3492
3516
  */
3493
- export interface GroupCreateEvent extends BaseEvent {
3494
- group?: Group;
3517
+ export interface GroupCreateEvent extends BaseGroupEvent {
3495
3518
  }
3496
3519
  /**
3497
3520
  * @author Trevor Smith
@@ -3616,11 +3639,10 @@ export interface RefreshRequest extends BaseEventRequest {
3616
3639
  *
3617
3640
  * @author Daniel DeGroff
3618
3641
  */
3619
- export interface UserLoginIdDuplicateOnCreateEvent extends BaseEvent {
3642
+ export interface UserLoginIdDuplicateOnCreateEvent extends BaseUserEvent {
3620
3643
  duplicateEmail?: string;
3621
3644
  duplicateUsername?: string;
3622
3645
  existing?: User;
3623
- user?: User;
3624
3646
  }
3625
3647
  export declare enum ThemeType {
3626
3648
  advanced = "advanced",
@@ -3637,6 +3659,16 @@ export interface LoginRequest extends BaseLoginRequest {
3637
3659
  password?: string;
3638
3660
  twoFactorTrustId?: string;
3639
3661
  }
3662
+ /**
3663
+ * The reason for the login failure.
3664
+ *
3665
+ * @author Daniel DeGroff
3666
+ */
3667
+ export interface UserLoginFailedReason {
3668
+ code?: string;
3669
+ lambdaId?: UUID;
3670
+ lambdaResult?: Errors;
3671
+ }
3640
3672
  /**
3641
3673
  * Response for the user login report.
3642
3674
  *
@@ -3940,8 +3972,7 @@ export declare enum AuthenticatorAttachmentPreference {
3940
3972
  *
3941
3973
  * @author Daniel DeGroff
3942
3974
  */
3943
- export interface GroupUpdateCompleteEvent extends BaseEvent {
3944
- group?: Group;
3975
+ export interface GroupUpdateCompleteEvent extends BaseGroupEvent {
3945
3976
  original?: Group;
3946
3977
  }
3947
3978
  export interface LambdaConfiguration {
@@ -3971,6 +4002,7 @@ export interface SystemConfiguration {
3971
4002
  reportTimezone?: string;
3972
4003
  trustedProxyConfiguration?: SystemTrustedProxyConfiguration;
3973
4004
  uiConfiguration?: UIConfiguration;
4005
+ webhookEventLogConfiguration?: WebhookEventLogConfiguration;
3974
4006
  }
3975
4007
  /**
3976
4008
  * @author Brett Guy
@@ -4407,8 +4439,7 @@ export interface ConnectorRequest {
4407
4439
  *
4408
4440
  * @author Daniel DeGroff
4409
4441
  */
4410
- export interface UserCreateCompleteEvent extends BaseEvent {
4411
- user?: User;
4442
+ export interface UserCreateCompleteEvent extends BaseUserEvent {
4412
4443
  }
4413
4444
  /**
4414
4445
  * A number identifying a cryptographic algorithm. Values should be registered with the <a
@@ -4461,10 +4492,9 @@ export interface KafkaMessengerConfiguration extends BaseMessengerConfiguration
4461
4492
  *
4462
4493
  * @author Daniel DeGroff
4463
4494
  */
4464
- export interface UserRegistrationCreateCompleteEvent extends BaseEvent {
4495
+ export interface UserRegistrationCreateCompleteEvent extends BaseUserEvent {
4465
4496
  applicationId?: UUID;
4466
4497
  registration?: UserRegistration;
4467
- user?: User;
4468
4498
  }
4469
4499
  /**
4470
4500
  * @author Daniel DeGroff
@@ -4536,7 +4566,8 @@ export declare enum LambdaType {
4536
4566
  SCIMServerUserRequestConverter = "SCIMServerUserRequestConverter",
4537
4567
  SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter",
4538
4568
  SelfServiceRegistrationValidation = "SelfServiceRegistrationValidation",
4539
- UserInfoPopulate = "UserInfoPopulate"
4569
+ UserInfoPopulate = "UserInfoPopulate",
4570
+ LoginValidation = "LoginValidation"
4540
4571
  }
4541
4572
  /**
4542
4573
  * @author Daniel DeGroff
@@ -4589,9 +4620,8 @@ export interface LambdaRequest {
4589
4620
  *
4590
4621
  * @author Daniel DeGroff
4591
4622
  */
4592
- export interface UserEmailUpdateEvent extends BaseEvent {
4623
+ export interface UserEmailUpdateEvent extends BaseUserEvent {
4593
4624
  previousEmail?: string;
4594
- user?: User;
4595
4625
  }
4596
4626
  /**
4597
4627
  * Raw login information for each time a user logs into an application.
@@ -4820,9 +4850,8 @@ export interface TenantWebAuthnWorkflowConfiguration extends Enableable {
4820
4850
  *
4821
4851
  * @author Daniel DeGroff
4822
4852
  */
4823
- export interface UserTwoFactorMethodRemoveEvent extends BaseEvent {
4853
+ export interface UserTwoFactorMethodRemoveEvent extends BaseUserEvent {
4824
4854
  method?: TwoFactorMethod;
4825
- user?: User;
4826
4855
  }
4827
4856
  export interface UsernameModeration extends Enableable {
4828
4857
  applicationId?: UUID;
@@ -4978,8 +5007,7 @@ export interface Integrations {
4978
5007
  *
4979
5008
  * @author Daniel DeGroff
4980
5009
  */
4981
- export interface UserPasswordUpdateEvent extends BaseEvent {
4982
- user?: User;
5010
+ export interface UserPasswordUpdateEvent extends BaseUserEvent {
4983
5011
  }
4984
5012
  /**
4985
5013
  * Standard error domain object that can also be used as the response from an API call.
@@ -4997,6 +5025,16 @@ export interface PreviewMessageTemplateResponse {
4997
5025
  errors?: Errors;
4998
5026
  message?: SMSMessage;
4999
5027
  }
5028
+ /**
5029
+ * The possible states of an individual webhook attempt to a single endpoint.
5030
+ *
5031
+ * @author Spencer Witt
5032
+ */
5033
+ export declare enum WebhookAttemptResult {
5034
+ Success = "Success",
5035
+ Failure = "Failure",
5036
+ Unknown = "Unknown"
5037
+ }
5000
5038
  /**
5001
5039
  * @author Daniel DeGroff
5002
5040
  */
@@ -5236,10 +5274,9 @@ export interface ApplicationSearchCriteria extends BaseSearchCriteria {
5236
5274
  *
5237
5275
  * @author Trevor Smith
5238
5276
  */
5239
- export interface UserRegistrationVerifiedEvent extends BaseEvent {
5277
+ export interface UserRegistrationVerifiedEvent extends BaseUserEvent {
5240
5278
  applicationId?: UUID;
5241
5279
  registration?: UserRegistration;
5242
- user?: User;
5243
5280
  }
5244
5281
  /**
5245
5282
  * A Message Template Request to the API
@@ -5270,8 +5307,7 @@ export interface NonTransactionalEvent {
5270
5307
  *
5271
5308
  * @author Brian Pontarelli
5272
5309
  */
5273
- export interface UserCreateEvent extends BaseEvent {
5274
- user?: User;
5310
+ export interface UserCreateEvent extends BaseUserEvent {
5275
5311
  }
5276
5312
  /**
5277
5313
  * @author Daniel DeGroff
@@ -5374,6 +5410,14 @@ export interface RefreshTokenRevocationPolicy {
5374
5410
  onMultiFactorEnable?: boolean;
5375
5411
  onPasswordChanged?: boolean;
5376
5412
  }
5413
+ /**
5414
+ * Base class for all {@link User}-related events.
5415
+ *
5416
+ * @author Spencer Witt
5417
+ */
5418
+ export interface BaseUserEvent extends BaseEvent {
5419
+ user?: User;
5420
+ }
5377
5421
  /**
5378
5422
  * @author Daniel DeGroff
5379
5423
  */
@@ -5405,8 +5449,7 @@ export declare enum AttestationType {
5405
5449
  *
5406
5450
  * @author Daniel DeGroff
5407
5451
  */
5408
- export interface GroupUpdateEvent extends BaseEvent {
5409
- group?: Group;
5452
+ export interface GroupUpdateEvent extends BaseGroupEvent {
5410
5453
  original?: Group;
5411
5454
  }
5412
5455
  /**
@@ -5581,8 +5624,7 @@ export interface UserLoginIdDuplicateOnUpdateEvent extends UserLoginIdDuplicateO
5581
5624
  *
5582
5625
  * @author Daniel DeGroff
5583
5626
  */
5584
- export interface GroupMemberRemoveCompleteEvent extends BaseEvent {
5585
- group?: Group;
5627
+ export interface GroupMemberRemoveCompleteEvent extends BaseGroupEvent {
5586
5628
  members?: Array<GroupMember>;
5587
5629
  }
5588
5630
  export interface EventLogConfiguration {
@@ -5608,8 +5650,7 @@ export interface WebhookSearchRequest {
5608
5650
  *
5609
5651
  * @author Daniel DeGroff
5610
5652
  */
5611
- export interface GroupMemberAddCompleteEvent extends BaseEvent {
5612
- group?: Group;
5653
+ export interface GroupMemberAddCompleteEvent extends BaseGroupEvent {
5613
5654
  members?: Array<GroupMember>;
5614
5655
  }
5615
5656
  /**
@@ -5641,6 +5682,7 @@ export interface ExternalIdentifierConfiguration {
5641
5682
  emailVerificationIdTimeToLiveInSeconds?: number;
5642
5683
  emailVerificationOneTimeCodeGenerator?: SecureGeneratorConfiguration;
5643
5684
  externalAuthenticationIdTimeToLiveInSeconds?: number;
5685
+ loginIntentTimeToLiveInSeconds?: number;
5644
5686
  oneTimePasswordTimeToLiveInSeconds?: number;
5645
5687
  passwordlessLoginGenerator?: SecureGeneratorConfiguration;
5646
5688
  passwordlessLoginTimeToLiveInSeconds?: number;
@@ -5838,6 +5880,14 @@ export interface UIConfiguration {
5838
5880
  logoURL?: string;
5839
5881
  menuFontColor?: string;
5840
5882
  }
5883
+ /**
5884
+ * Webhook event log response.
5885
+ *
5886
+ * @author Spencer Witt
5887
+ */
5888
+ export interface WebhookEventLogResponse {
5889
+ webhookEventLog?: WebhookEventLog;
5890
+ }
5841
5891
  /**
5842
5892
  * The public Status API response
5843
5893
  *
@@ -5883,11 +5933,11 @@ export interface MessengerResponse {
5883
5933
  *
5884
5934
  * @author Daniel DeGroff
5885
5935
  */
5886
- export interface UserLoginFailedEvent extends BaseEvent {
5936
+ export interface UserLoginFailedEvent extends BaseUserEvent {
5887
5937
  applicationId?: UUID;
5888
5938
  authenticationType?: string;
5889
5939
  ipAddress?: string;
5890
- user?: User;
5940
+ reason?: UserLoginFailedReason;
5891
5941
  }
5892
5942
  /**
5893
5943
  * @author Daniel DeGroff
@@ -5935,8 +5985,7 @@ export interface Tenant {
5935
5985
  *
5936
5986
  * @author Daniel DeGroff
5937
5987
  */
5938
- export interface GroupMemberUpdateCompleteEvent extends BaseEvent {
5939
- group?: Group;
5988
+ export interface GroupMemberUpdateCompleteEvent extends BaseGroupEvent {
5940
5989
  members?: Array<GroupMember>;
5941
5990
  }
5942
5991
  export interface BaseMessengerConfiguration {
@@ -6069,8 +6118,7 @@ export interface AuditLogSearchRequest {
6069
6118
  *
6070
6119
  * @author Matthew Altman
6071
6120
  */
6072
- export interface UserPasswordBreachEvent extends BaseEvent {
6073
- user?: User;
6121
+ export interface UserPasswordBreachEvent extends BaseUserEvent {
6074
6122
  }
6075
6123
  /**
6076
6124
  * @author Daniel DeGroff
@@ -6093,14 +6141,18 @@ export interface SendRequest {
6093
6141
  export interface AuditLogConfiguration {
6094
6142
  delete?: DeleteConfiguration;
6095
6143
  }
6144
+ /**
6145
+ * User login failed reason codes.
6146
+ */
6147
+ export interface UserLoginFailedReasonCode {
6148
+ }
6096
6149
  /**
6097
6150
  * Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
6098
6151
  * delete).
6099
6152
  *
6100
6153
  * @author Brian Pontarelli
6101
6154
  */
6102
- export interface UserDeleteEvent extends BaseEvent {
6103
- user?: User;
6155
+ export interface UserDeleteEvent extends BaseUserEvent {
6104
6156
  }
6105
6157
  /**
6106
6158
  * A custom OAuth scope for a specific application.
@@ -6337,6 +6389,21 @@ export interface MetaData {
6337
6389
  device?: DeviceInfo;
6338
6390
  scopes?: Array<string>;
6339
6391
  }
6392
+ export interface WebhookEventLog {
6393
+ attempts?: Array<WebhookAttemptLog>;
6394
+ data?: Record<string, any>;
6395
+ event?: EventRequest;
6396
+ eventResult?: WebhookEventResult;
6397
+ eventType?: EventType;
6398
+ failedAttempts?: number;
6399
+ id?: UUID;
6400
+ insertInstant?: number;
6401
+ lastAttemptInstant?: number;
6402
+ lastUpdateInstant?: number;
6403
+ linkedObjectId?: UUID;
6404
+ sequence?: number;
6405
+ successfulAttempts?: number;
6406
+ }
6340
6407
  export declare enum SAMLLogoutBehavior {
6341
6408
  AllParticipants = "AllParticipants",
6342
6409
  OnlyOriginator = "OnlyOriginator"
@@ -6521,11 +6588,10 @@ export declare enum EventLogType {
6521
6588
  *
6522
6589
  * @author Daniel DeGroff
6523
6590
  */
6524
- export interface UserRegistrationUpdateEvent extends BaseEvent {
6591
+ export interface UserRegistrationUpdateEvent extends BaseUserEvent {
6525
6592
  applicationId?: UUID;
6526
6593
  original?: UserRegistration;
6527
6594
  registration?: UserRegistration;
6528
- user?: User;
6529
6595
  }
6530
6596
  /**
6531
6597
  * Entity API response object.
@@ -6579,10 +6645,9 @@ export interface EpicGamesApplicationConfiguration extends BaseIdentityProviderA
6579
6645
  *
6580
6646
  * @author Daniel DeGroff
6581
6647
  */
6582
- export interface UserRegistrationDeleteCompleteEvent extends BaseEvent {
6648
+ export interface UserRegistrationDeleteCompleteEvent extends BaseUserEvent {
6583
6649
  applicationId?: UUID;
6584
6650
  registration?: UserRegistration;
6585
- user?: User;
6586
6651
  }
6587
6652
  /**
6588
6653
  * Group API request object.
@@ -6627,8 +6692,7 @@ export interface GoogleApplicationConfiguration extends BaseIdentityProviderAppl
6627
6692
  *
6628
6693
  * @author Daniel DeGroff
6629
6694
  */
6630
- export interface UserDeleteCompleteEvent extends BaseEvent {
6631
- user?: User;
6695
+ export interface UserDeleteCompleteEvent extends BaseUserEvent {
6632
6696
  }
6633
6697
  /**
6634
6698
  * Supply additional information about the user account when creating a new credential
@@ -6781,6 +6845,21 @@ export interface User extends SecureIdentity {
6781
6845
  timezone?: string;
6782
6846
  twoFactor?: UserTwoFactorConfiguration;
6783
6847
  }
6848
+ /**
6849
+ * A webhook call attempt log.
6850
+ *
6851
+ * @author Spencer Witt
6852
+ */
6853
+ export interface WebhookAttemptLog {
6854
+ attemptResult?: WebhookAttemptResult;
6855
+ data?: Record<string, any>;
6856
+ endInstant?: number;
6857
+ id?: UUID;
6858
+ startInstant?: number;
6859
+ webhookCallResponse?: WebhookCallResponse;
6860
+ webhookEventLogId?: UUID;
6861
+ webhookId?: UUID;
6862
+ }
6784
6863
  /**
6785
6864
  * Search criteria for entity types.
6786
6865
  *
@@ -6794,9 +6873,8 @@ export interface EntityTypeSearchCriteria extends BaseSearchCriteria {
6794
6873
  *
6795
6874
  * @author Rob Davis
6796
6875
  */
6797
- export interface UserIdentityProviderUnlinkEvent extends BaseEvent {
6876
+ export interface UserIdentityProviderUnlinkEvent extends BaseUserEvent {
6798
6877
  identityProviderLink?: IdentityProviderLink;
6799
- user?: User;
6800
6878
  }
6801
6879
  /**
6802
6880
  * Contains extension output for requested extensions during a WebAuthn ceremony
@@ -6840,8 +6918,7 @@ export interface TenantWebAuthnConfiguration extends Enableable {
6840
6918
  *
6841
6919
  * @author Daniel DeGroff
6842
6920
  */
6843
- export interface GroupCreateCompleteEvent extends BaseEvent {
6844
- group?: Group;
6921
+ export interface GroupCreateCompleteEvent extends BaseGroupEvent {
6845
6922
  }
6846
6923
  /**
6847
6924
  * Options to request extensions during credential registration
@@ -6851,6 +6928,14 @@ export interface GroupCreateCompleteEvent extends BaseEvent {
6851
6928
  export interface WebAuthnRegistrationExtensionOptions {
6852
6929
  credProps?: boolean;
6853
6930
  }
6931
+ /**
6932
+ * The system configuration for Webhook Event Log data.
6933
+ *
6934
+ * @author Spencer Witt
6935
+ */
6936
+ export interface WebhookEventLogConfiguration {
6937
+ delete?: DeleteConfiguration;
6938
+ }
6854
6939
  /**
6855
6940
  * Password Encryption Scheme Configuration
6856
6941
  *
@@ -7112,9 +7197,15 @@ export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoA
7112
7197
  *
7113
7198
  * @author Daniel DeGroff
7114
7199
  */
7115
- export interface UserUpdateCompleteEvent extends BaseEvent {
7200
+ export interface UserUpdateCompleteEvent extends BaseUserEvent {
7116
7201
  original?: User;
7117
- user?: User;
7202
+ }
7203
+ /**
7204
+ * A marker interface indicating this event is an event that can supply a linked object Id.
7205
+ *
7206
+ * @author Spencer Witt
7207
+ */
7208
+ export interface ObjectIdentifiable {
7118
7209
  }
7119
7210
  /**
7120
7211
  * The transaction types for Webhooks and other event systems within FusionAuth.
@@ -7133,14 +7224,13 @@ export declare enum TransactionType {
7133
7224
  *
7134
7225
  * @author Daniel DeGroff
7135
7226
  */
7136
- export interface UserLoginSuccessEvent extends BaseEvent {
7227
+ export interface UserLoginSuccessEvent extends BaseUserEvent {
7137
7228
  applicationId?: UUID;
7138
7229
  authenticationType?: string;
7139
7230
  connectorId?: UUID;
7140
7231
  identityProviderId?: UUID;
7141
7232
  identityProviderName?: string;
7142
7233
  ipAddress?: string;
7143
- user?: User;
7144
7234
  }
7145
7235
  /**
7146
7236
  * Group Member Delete Request
@@ -7172,11 +7262,10 @@ export interface RegistrationResponse {
7172
7262
  *
7173
7263
  * @author Daniel DeGroff
7174
7264
  */
7175
- export interface UserRegistrationUpdateCompleteEvent extends BaseEvent {
7265
+ export interface UserRegistrationUpdateCompleteEvent extends BaseUserEvent {
7176
7266
  applicationId?: UUID;
7177
7267
  original?: UserRegistration;
7178
7268
  registration?: UserRegistration;
7179
- user?: User;
7180
7269
  }
7181
7270
  /**
7182
7271
  * Search response for Themes
@@ -7257,8 +7346,7 @@ export interface LoginConfiguration {
7257
7346
  *
7258
7347
  * @author Daniel DeGroff
7259
7348
  */
7260
- export interface GroupMemberAddEvent extends BaseEvent {
7261
- group?: Group;
7349
+ export interface GroupMemberAddEvent extends BaseGroupEvent {
7262
7350
  members?: Array<GroupMember>;
7263
7351
  }
7264
7352
  /**
@@ -7306,6 +7394,14 @@ export interface GenericConnectorConfiguration extends BaseConnectorConfiguratio
7306
7394
  readTimeout?: number;
7307
7395
  sslCertificateKeyId?: UUID;
7308
7396
  }
7397
+ /**
7398
+ * Base class for all {@link Group} and {@link GroupMember} events.
7399
+ *
7400
+ * @author Spencer Witt
7401
+ */
7402
+ export interface BaseGroupEvent extends BaseEvent {
7403
+ group?: Group;
7404
+ }
7309
7405
  /**
7310
7406
  * @author Daniel DeGroff
7311
7407
  */
@@ -7348,6 +7444,15 @@ export interface WebAuthnCredentialResponse {
7348
7444
  credential?: WebAuthnCredential;
7349
7445
  credentials?: Array<WebAuthnCredential>;
7350
7446
  }
7447
+ /**
7448
+ * Webhook event log search response.
7449
+ *
7450
+ * @author Spencer Witt
7451
+ */
7452
+ export interface WebhookEventLogSearchResponse {
7453
+ total?: number;
7454
+ webhookEventLogs?: Array<WebhookEventLog>;
7455
+ }
7351
7456
  /**
7352
7457
  * @author Trevor Smith
7353
7458
  */
@@ -7777,7 +7882,7 @@ export interface PasswordBreachDetection extends Enableable {
7777
7882
  onLogin?: BreachAction;
7778
7883
  }
7779
7884
  /**
7780
- * Base-class for all FusionAuth events.
7885
+ * Base class for all FusionAuth events.
7781
7886
  *
7782
7887
  * @author Brian Pontarelli
7783
7888
  */
@@ -7965,8 +8070,7 @@ export interface LambdaSearchRequest {
7965
8070
  *
7966
8071
  * @author Daniel DeGroff
7967
8072
  */
7968
- export interface UserPasswordResetSendEvent extends BaseEvent {
7969
- user?: User;
8073
+ export interface UserPasswordResetSendEvent extends BaseUserEvent {
7970
8074
  }
7971
8075
  /**
7972
8076
  * The Integration Request
@@ -8127,9 +8231,8 @@ export declare enum VerificationStrategy {
8127
8231
  *
8128
8232
  * @author Daniel DeGroff
8129
8233
  */
8130
- export interface UserTwoFactorMethodAddEvent extends BaseEvent {
8234
+ export interface UserTwoFactorMethodAddEvent extends BaseUserEvent {
8131
8235
  method?: TwoFactorMethod;
8132
- user?: User;
8133
8236
  }
8134
8237
  /**
8135
8238
  * API request to start a WebAuthn registration ceremony
@@ -8162,8 +8265,7 @@ export interface IPAccessControlEntry {
8162
8265
  *
8163
8266
  * @author Daniel DeGroff
8164
8267
  */
8165
- export interface GroupMemberUpdateEvent extends BaseEvent {
8166
- group?: Group;
8268
+ export interface GroupMemberUpdateEvent extends BaseGroupEvent {
8167
8269
  members?: Array<GroupMember>;
8168
8270
  }
8169
8271
  /**
@@ -8171,8 +8273,19 @@ export interface GroupMemberUpdateEvent extends BaseEvent {
8171
8273
  *
8172
8274
  * @author Brian Pontarelli
8173
8275
  */
8174
- export interface UserDeactivateEvent extends BaseEvent {
8175
- user?: User;
8276
+ export interface UserDeactivateEvent extends BaseUserEvent {
8277
+ }
8278
+ /**
8279
+ * Search criteria for the webhook event log.
8280
+ *
8281
+ * @author Spencer Witt
8282
+ */
8283
+ export interface WebhookEventLogSearchCriteria extends BaseSearchCriteria {
8284
+ end?: number;
8285
+ event?: string;
8286
+ eventResult?: WebhookEventResult;
8287
+ eventType?: EventType;
8288
+ start?: number;
8176
8289
  }
8177
8290
  /**
8178
8291
  * Group Member Response
@@ -8182,6 +8295,14 @@ export interface UserDeactivateEvent extends BaseEvent {
8182
8295
  export interface MemberResponse {
8183
8296
  members?: Record<UUID, Array<GroupMember>>;
8184
8297
  }
8298
+ /**
8299
+ * Webhook event log search request.
8300
+ *
8301
+ * @author Spencer Witt
8302
+ */
8303
+ export interface WebhookEventLogSearchRequest {
8304
+ search?: WebhookEventLogSearchCriteria;
8305
+ }
8185
8306
  /**
8186
8307
  * API response for completing WebAuthn assertion
8187
8308
  *
@@ -8284,10 +8405,9 @@ export interface LogHistory {
8284
8405
  *
8285
8406
  * @author Daniel DeGroff
8286
8407
  */
8287
- export interface UserRegistrationCreateEvent extends BaseEvent {
8408
+ export interface UserRegistrationCreateEvent extends BaseUserEvent {
8288
8409
  applicationId?: UUID;
8289
8410
  registration?: UserRegistration;
8290
- user?: User;
8291
8411
  }
8292
8412
  /**
8293
8413
  * Search request for Applications
@@ -8297,6 +8417,16 @@ export interface UserRegistrationCreateEvent extends BaseEvent {
8297
8417
  export interface ApplicationSearchRequest extends ExpandableRequest {
8298
8418
  search?: ApplicationSearchCriteria;
8299
8419
  }
8420
+ /**
8421
+ * A webhook call response.
8422
+ *
8423
+ * @author Spencer Witt
8424
+ */
8425
+ export interface WebhookCallResponse {
8426
+ exception?: string;
8427
+ statusCode?: number;
8428
+ url?: string;
8429
+ }
8300
8430
  /**
8301
8431
  * API request for User consent types.
8302
8432
  *
@@ -8458,8 +8588,7 @@ export interface HYPRIdentityProvider extends BaseIdentityProvider<HYPRApplicati
8458
8588
  *
8459
8589
  * @author Daniel DeGroff
8460
8590
  */
8461
- export interface UserPasswordResetSuccessEvent extends BaseEvent {
8462
- user?: User;
8591
+ export interface UserPasswordResetSuccessEvent extends BaseUserEvent {
8463
8592
  }
8464
8593
  /**
8465
8594
  * Something that can be required and thus also optional. This currently extends Enableable because anything that is
@@ -8543,16 +8672,14 @@ export declare enum UnknownScopePolicy {
8543
8672
  *
8544
8673
  * @author Daniel DeGroff
8545
8674
  */
8546
- export interface UserPasswordResetStartEvent extends BaseEvent {
8547
- user?: User;
8675
+ export interface UserPasswordResetStartEvent extends BaseUserEvent {
8548
8676
  }
8549
8677
  /**
8550
8678
  * Models the Group Delete Event.
8551
8679
  *
8552
8680
  * @author Daniel DeGroff
8553
8681
  */
8554
- export interface GroupDeleteEvent extends BaseEvent {
8555
- group?: Group;
8682
+ export interface GroupDeleteEvent extends BaseGroupEvent {
8556
8683
  }
8557
8684
  export interface MultiFactorEmailTemplate {
8558
8685
  templateId?: UUID;
@@ -8649,8 +8776,7 @@ export interface ConsentResponse {
8649
8776
  *
8650
8777
  * @author Daniel DeGroff
8651
8778
  */
8652
- export interface GroupMemberRemoveEvent extends BaseEvent {
8653
- group?: Group;
8779
+ export interface GroupMemberRemoveEvent extends BaseGroupEvent {
8654
8780
  members?: Array<GroupMember>;
8655
8781
  }
8656
8782
  /**
@@ -8777,6 +8903,17 @@ export interface TenantDeleteRequest extends BaseEventRequest {
8777
8903
  export interface EventLogCreateEvent extends BaseEvent {
8778
8904
  eventLog?: EventLog;
8779
8905
  }
8906
+ /**
8907
+ * The possible result states of a webhook event. This tracks the success of the overall webhook transaction according to the {@link TransactionType}
8908
+ * and configured webhooks.
8909
+ *
8910
+ * @author Spencer Witt
8911
+ */
8912
+ export declare enum WebhookEventResult {
8913
+ Failed = "Failed",
8914
+ Running = "Running",
8915
+ Succeeded = "Succeeded"
8916
+ }
8780
8917
  export interface UniqueUsernameConfiguration extends Enableable {
8781
8918
  numberOfDigits?: number;
8782
8919
  separator?: string;