@fusionauth/typescript-client 1.51.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.
@@ -1801,6 +1801,24 @@ export declare class FusionAuthClient {
1801
1801
  * @returns {Promise<ClientResponse<SystemConfigurationResponse>>}
1802
1802
  */
1803
1803
  retrieveSystemConfiguration(): Promise<ClientResponse<SystemConfigurationResponse>>;
1804
+ /**
1805
+ * Retrieves the FusionAuth system health. This API will return 200 if the system is healthy, and 500 if the system is un-healthy.
1806
+ *
1807
+ * @returns {Promise<ClientResponse<void>>}
1808
+ */
1809
+ retrieveSystemHealth(): Promise<ClientResponse<void>>;
1810
+ /**
1811
+ * Retrieves the FusionAuth system status. This request is anonymous and does not require an API key. When an API key is not provided the response will contain a single value in the JSON response indicating the current health check.
1812
+ *
1813
+ * @returns {Promise<ClientResponse<StatusResponse>>}
1814
+ */
1815
+ retrieveSystemStatus(): Promise<ClientResponse<StatusResponse>>;
1816
+ /**
1817
+ * Retrieves the FusionAuth system status using an API key. Using an API key will cause the response to include the product version, health checks and various runtime metrics.
1818
+ *
1819
+ * @returns {Promise<ClientResponse<StatusResponse>>}
1820
+ */
1821
+ retrieveSystemStatusUsingAPIKey(): Promise<ClientResponse<StatusResponse>>;
1804
1822
  /**
1805
1823
  * Retrieves the tenant for the given Id.
1806
1824
  *
@@ -2057,6 +2075,20 @@ export declare class FusionAuthClient {
2057
2075
  * @returns {Promise<ClientResponse<WebhookResponse>>}
2058
2076
  */
2059
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>>;
2060
2092
  /**
2061
2093
  * Retrieves all the webhooks.
2062
2094
  *
@@ -2313,6 +2345,13 @@ export declare class FusionAuthClient {
2313
2345
  * @deprecated This method has been renamed to searchUsersByQuery, use that method instead.
2314
2346
  */
2315
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>>;
2316
2355
  /**
2317
2356
  * Searches webhooks with the specified criteria and pagination.
2318
2357
  *
@@ -2772,10 +2811,19 @@ export default FusionAuthClient;
2772
2811
  * A 128 bit UUID in string format "8-4-4-4-12", for example "58D5E212-165B-4CA0-909B-C86B9CEE0111".
2773
2812
  */
2774
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
+ }
2775
2822
  /**
2776
2823
  * @author Rob Davis
2777
2824
  */
2778
2825
  export interface TenantLambdaConfiguration {
2826
+ loginValidationId?: UUID;
2779
2827
  scimEnterpriseUserRequestConverterId?: UUID;
2780
2828
  scimEnterpriseUserResponseConverterId?: UUID;
2781
2829
  scimGroupRequestConverterId?: UUID;
@@ -2807,7 +2855,7 @@ export interface UserActionReason {
2807
2855
  export interface AuthenticationTokenConfiguration extends Enableable {
2808
2856
  }
2809
2857
  /**
2810
- * Event event to an audit log was created.
2858
+ * Event to indicate an audit log was created.
2811
2859
  *
2812
2860
  * @author Daniel DeGroff
2813
2861
  */
@@ -2903,10 +2951,9 @@ export interface ApplicationRegistrationDeletePolicy {
2903
2951
  *
2904
2952
  * @author Daniel DeGroff
2905
2953
  */
2906
- export interface UserRegistrationDeleteEvent extends BaseEvent {
2954
+ export interface UserRegistrationDeleteEvent extends BaseUserEvent {
2907
2955
  applicationId?: UUID;
2908
2956
  registration?: UserRegistration;
2909
- user?: User;
2910
2957
  }
2911
2958
  /**
2912
2959
  * @author Daniel DeGroff
@@ -2949,8 +2996,7 @@ export interface UserComment {
2949
2996
  *
2950
2997
  * @author Daniel DeGroff
2951
2998
  */
2952
- export interface GroupDeleteCompleteEvent extends BaseEvent {
2953
- group?: Group;
2999
+ export interface GroupDeleteCompleteEvent extends BaseGroupEvent {
2954
3000
  }
2955
3001
  /**
2956
3002
  * Email template search response
@@ -3110,8 +3156,7 @@ export interface EmailTemplate {
3110
3156
  *
3111
3157
  * @author Trevor Smith
3112
3158
  */
3113
- export interface UserEmailVerifiedEvent extends BaseEvent {
3114
- user?: User;
3159
+ export interface UserEmailVerifiedEvent extends BaseUserEvent {
3115
3160
  }
3116
3161
  /**
3117
3162
  * @author Daniel DeGroff
@@ -3176,8 +3221,7 @@ export interface ConsentSearchRequest {
3176
3221
  *
3177
3222
  * @author Brian Pontarelli
3178
3223
  */
3179
- export interface UserReactivateEvent extends BaseEvent {
3180
- user?: User;
3224
+ export interface UserReactivateEvent extends BaseUserEvent {
3181
3225
  }
3182
3226
  /**
3183
3227
  * OpenID Connect Configuration as described by the <a href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata">OpenID
@@ -3283,9 +3327,8 @@ export interface AuditLog {
3283
3327
  *
3284
3328
  * @author Rob Davis
3285
3329
  */
3286
- export interface UserIdentityProviderLinkEvent extends BaseEvent {
3330
+ export interface UserIdentityProviderLinkEvent extends BaseUserEvent {
3287
3331
  identityProviderLink?: IdentityProviderLink;
3288
- user?: User;
3289
3332
  }
3290
3333
  /**
3291
3334
  * Application search response
@@ -3384,9 +3427,8 @@ export interface GroupMember {
3384
3427
  *
3385
3428
  * @author Brian Pontarelli
3386
3429
  */
3387
- export interface UserUpdateEvent extends BaseEvent {
3430
+ export interface UserUpdateEvent extends BaseUserEvent {
3388
3431
  original?: User;
3389
- user?: User;
3390
3432
  }
3391
3433
  /**
3392
3434
  * The application's relationship to the authorization server. First-party applications will be granted implicit permission for requested scopes.
@@ -3472,8 +3514,7 @@ export interface TwoFactorStartRequest {
3472
3514
  *
3473
3515
  * @author Daniel DeGroff
3474
3516
  */
3475
- export interface GroupCreateEvent extends BaseEvent {
3476
- group?: Group;
3517
+ export interface GroupCreateEvent extends BaseGroupEvent {
3477
3518
  }
3478
3519
  /**
3479
3520
  * @author Trevor Smith
@@ -3598,11 +3639,10 @@ export interface RefreshRequest extends BaseEventRequest {
3598
3639
  *
3599
3640
  * @author Daniel DeGroff
3600
3641
  */
3601
- export interface UserLoginIdDuplicateOnCreateEvent extends BaseEvent {
3642
+ export interface UserLoginIdDuplicateOnCreateEvent extends BaseUserEvent {
3602
3643
  duplicateEmail?: string;
3603
3644
  duplicateUsername?: string;
3604
3645
  existing?: User;
3605
- user?: User;
3606
3646
  }
3607
3647
  export declare enum ThemeType {
3608
3648
  advanced = "advanced",
@@ -3619,6 +3659,16 @@ export interface LoginRequest extends BaseLoginRequest {
3619
3659
  password?: string;
3620
3660
  twoFactorTrustId?: string;
3621
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
+ }
3622
3672
  /**
3623
3673
  * Response for the user login report.
3624
3674
  *
@@ -3922,8 +3972,7 @@ export declare enum AuthenticatorAttachmentPreference {
3922
3972
  *
3923
3973
  * @author Daniel DeGroff
3924
3974
  */
3925
- export interface GroupUpdateCompleteEvent extends BaseEvent {
3926
- group?: Group;
3975
+ export interface GroupUpdateCompleteEvent extends BaseGroupEvent {
3927
3976
  original?: Group;
3928
3977
  }
3929
3978
  export interface LambdaConfiguration {
@@ -3953,6 +4002,7 @@ export interface SystemConfiguration {
3953
4002
  reportTimezone?: string;
3954
4003
  trustedProxyConfiguration?: SystemTrustedProxyConfiguration;
3955
4004
  uiConfiguration?: UIConfiguration;
4005
+ webhookEventLogConfiguration?: WebhookEventLogConfiguration;
3956
4006
  }
3957
4007
  /**
3958
4008
  * @author Brett Guy
@@ -4389,8 +4439,7 @@ export interface ConnectorRequest {
4389
4439
  *
4390
4440
  * @author Daniel DeGroff
4391
4441
  */
4392
- export interface UserCreateCompleteEvent extends BaseEvent {
4393
- user?: User;
4442
+ export interface UserCreateCompleteEvent extends BaseUserEvent {
4394
4443
  }
4395
4444
  /**
4396
4445
  * A number identifying a cryptographic algorithm. Values should be registered with the <a
@@ -4443,10 +4492,9 @@ export interface KafkaMessengerConfiguration extends BaseMessengerConfiguration
4443
4492
  *
4444
4493
  * @author Daniel DeGroff
4445
4494
  */
4446
- export interface UserRegistrationCreateCompleteEvent extends BaseEvent {
4495
+ export interface UserRegistrationCreateCompleteEvent extends BaseUserEvent {
4447
4496
  applicationId?: UUID;
4448
4497
  registration?: UserRegistration;
4449
- user?: User;
4450
4498
  }
4451
4499
  /**
4452
4500
  * @author Daniel DeGroff
@@ -4518,7 +4566,8 @@ export declare enum LambdaType {
4518
4566
  SCIMServerUserRequestConverter = "SCIMServerUserRequestConverter",
4519
4567
  SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter",
4520
4568
  SelfServiceRegistrationValidation = "SelfServiceRegistrationValidation",
4521
- UserInfoPopulate = "UserInfoPopulate"
4569
+ UserInfoPopulate = "UserInfoPopulate",
4570
+ LoginValidation = "LoginValidation"
4522
4571
  }
4523
4572
  /**
4524
4573
  * @author Daniel DeGroff
@@ -4571,9 +4620,8 @@ export interface LambdaRequest {
4571
4620
  *
4572
4621
  * @author Daniel DeGroff
4573
4622
  */
4574
- export interface UserEmailUpdateEvent extends BaseEvent {
4623
+ export interface UserEmailUpdateEvent extends BaseUserEvent {
4575
4624
  previousEmail?: string;
4576
- user?: User;
4577
4625
  }
4578
4626
  /**
4579
4627
  * Raw login information for each time a user logs into an application.
@@ -4802,9 +4850,8 @@ export interface TenantWebAuthnWorkflowConfiguration extends Enableable {
4802
4850
  *
4803
4851
  * @author Daniel DeGroff
4804
4852
  */
4805
- export interface UserTwoFactorMethodRemoveEvent extends BaseEvent {
4853
+ export interface UserTwoFactorMethodRemoveEvent extends BaseUserEvent {
4806
4854
  method?: TwoFactorMethod;
4807
- user?: User;
4808
4855
  }
4809
4856
  export interface UsernameModeration extends Enableable {
4810
4857
  applicationId?: UUID;
@@ -4960,8 +5007,7 @@ export interface Integrations {
4960
5007
  *
4961
5008
  * @author Daniel DeGroff
4962
5009
  */
4963
- export interface UserPasswordUpdateEvent extends BaseEvent {
4964
- user?: User;
5010
+ export interface UserPasswordUpdateEvent extends BaseUserEvent {
4965
5011
  }
4966
5012
  /**
4967
5013
  * Standard error domain object that can also be used as the response from an API call.
@@ -4979,6 +5025,16 @@ export interface PreviewMessageTemplateResponse {
4979
5025
  errors?: Errors;
4980
5026
  message?: SMSMessage;
4981
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
+ }
4982
5038
  /**
4983
5039
  * @author Daniel DeGroff
4984
5040
  */
@@ -5218,10 +5274,9 @@ export interface ApplicationSearchCriteria extends BaseSearchCriteria {
5218
5274
  *
5219
5275
  * @author Trevor Smith
5220
5276
  */
5221
- export interface UserRegistrationVerifiedEvent extends BaseEvent {
5277
+ export interface UserRegistrationVerifiedEvent extends BaseUserEvent {
5222
5278
  applicationId?: UUID;
5223
5279
  registration?: UserRegistration;
5224
- user?: User;
5225
5280
  }
5226
5281
  /**
5227
5282
  * A Message Template Request to the API
@@ -5252,8 +5307,7 @@ export interface NonTransactionalEvent {
5252
5307
  *
5253
5308
  * @author Brian Pontarelli
5254
5309
  */
5255
- export interface UserCreateEvent extends BaseEvent {
5256
- user?: User;
5310
+ export interface UserCreateEvent extends BaseUserEvent {
5257
5311
  }
5258
5312
  /**
5259
5313
  * @author Daniel DeGroff
@@ -5356,6 +5410,14 @@ export interface RefreshTokenRevocationPolicy {
5356
5410
  onMultiFactorEnable?: boolean;
5357
5411
  onPasswordChanged?: boolean;
5358
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
+ }
5359
5421
  /**
5360
5422
  * @author Daniel DeGroff
5361
5423
  */
@@ -5387,8 +5449,7 @@ export declare enum AttestationType {
5387
5449
  *
5388
5450
  * @author Daniel DeGroff
5389
5451
  */
5390
- export interface GroupUpdateEvent extends BaseEvent {
5391
- group?: Group;
5452
+ export interface GroupUpdateEvent extends BaseGroupEvent {
5392
5453
  original?: Group;
5393
5454
  }
5394
5455
  /**
@@ -5563,8 +5624,7 @@ export interface UserLoginIdDuplicateOnUpdateEvent extends UserLoginIdDuplicateO
5563
5624
  *
5564
5625
  * @author Daniel DeGroff
5565
5626
  */
5566
- export interface GroupMemberRemoveCompleteEvent extends BaseEvent {
5567
- group?: Group;
5627
+ export interface GroupMemberRemoveCompleteEvent extends BaseGroupEvent {
5568
5628
  members?: Array<GroupMember>;
5569
5629
  }
5570
5630
  export interface EventLogConfiguration {
@@ -5590,8 +5650,7 @@ export interface WebhookSearchRequest {
5590
5650
  *
5591
5651
  * @author Daniel DeGroff
5592
5652
  */
5593
- export interface GroupMemberAddCompleteEvent extends BaseEvent {
5594
- group?: Group;
5653
+ export interface GroupMemberAddCompleteEvent extends BaseGroupEvent {
5595
5654
  members?: Array<GroupMember>;
5596
5655
  }
5597
5656
  /**
@@ -5623,6 +5682,7 @@ export interface ExternalIdentifierConfiguration {
5623
5682
  emailVerificationIdTimeToLiveInSeconds?: number;
5624
5683
  emailVerificationOneTimeCodeGenerator?: SecureGeneratorConfiguration;
5625
5684
  externalAuthenticationIdTimeToLiveInSeconds?: number;
5685
+ loginIntentTimeToLiveInSeconds?: number;
5626
5686
  oneTimePasswordTimeToLiveInSeconds?: number;
5627
5687
  passwordlessLoginGenerator?: SecureGeneratorConfiguration;
5628
5688
  passwordlessLoginTimeToLiveInSeconds?: number;
@@ -5820,6 +5880,21 @@ export interface UIConfiguration {
5820
5880
  logoURL?: string;
5821
5881
  menuFontColor?: string;
5822
5882
  }
5883
+ /**
5884
+ * Webhook event log response.
5885
+ *
5886
+ * @author Spencer Witt
5887
+ */
5888
+ export interface WebhookEventLogResponse {
5889
+ webhookEventLog?: WebhookEventLog;
5890
+ }
5891
+ /**
5892
+ * The public Status API response
5893
+ *
5894
+ * @author Daniel DeGroff
5895
+ */
5896
+ export interface StatusResponse extends Record<string, any> {
5897
+ }
5823
5898
  export declare enum RegistrationType {
5824
5899
  basic = "basic",
5825
5900
  advanced = "advanced"
@@ -5858,11 +5933,11 @@ export interface MessengerResponse {
5858
5933
  *
5859
5934
  * @author Daniel DeGroff
5860
5935
  */
5861
- export interface UserLoginFailedEvent extends BaseEvent {
5936
+ export interface UserLoginFailedEvent extends BaseUserEvent {
5862
5937
  applicationId?: UUID;
5863
5938
  authenticationType?: string;
5864
5939
  ipAddress?: string;
5865
- user?: User;
5940
+ reason?: UserLoginFailedReason;
5866
5941
  }
5867
5942
  /**
5868
5943
  * @author Daniel DeGroff
@@ -5910,8 +5985,7 @@ export interface Tenant {
5910
5985
  *
5911
5986
  * @author Daniel DeGroff
5912
5987
  */
5913
- export interface GroupMemberUpdateCompleteEvent extends BaseEvent {
5914
- group?: Group;
5988
+ export interface GroupMemberUpdateCompleteEvent extends BaseGroupEvent {
5915
5989
  members?: Array<GroupMember>;
5916
5990
  }
5917
5991
  export interface BaseMessengerConfiguration {
@@ -6044,8 +6118,7 @@ export interface AuditLogSearchRequest {
6044
6118
  *
6045
6119
  * @author Matthew Altman
6046
6120
  */
6047
- export interface UserPasswordBreachEvent extends BaseEvent {
6048
- user?: User;
6121
+ export interface UserPasswordBreachEvent extends BaseUserEvent {
6049
6122
  }
6050
6123
  /**
6051
6124
  * @author Daniel DeGroff
@@ -6068,14 +6141,18 @@ export interface SendRequest {
6068
6141
  export interface AuditLogConfiguration {
6069
6142
  delete?: DeleteConfiguration;
6070
6143
  }
6144
+ /**
6145
+ * User login failed reason codes.
6146
+ */
6147
+ export interface UserLoginFailedReasonCode {
6148
+ }
6071
6149
  /**
6072
6150
  * Models the User Event (and can be converted to JSON) that is used for all user modifications (create, update,
6073
6151
  * delete).
6074
6152
  *
6075
6153
  * @author Brian Pontarelli
6076
6154
  */
6077
- export interface UserDeleteEvent extends BaseEvent {
6078
- user?: User;
6155
+ export interface UserDeleteEvent extends BaseUserEvent {
6079
6156
  }
6080
6157
  /**
6081
6158
  * A custom OAuth scope for a specific application.
@@ -6312,6 +6389,21 @@ export interface MetaData {
6312
6389
  device?: DeviceInfo;
6313
6390
  scopes?: Array<string>;
6314
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
+ }
6315
6407
  export declare enum SAMLLogoutBehavior {
6316
6408
  AllParticipants = "AllParticipants",
6317
6409
  OnlyOriginator = "OnlyOriginator"
@@ -6496,11 +6588,10 @@ export declare enum EventLogType {
6496
6588
  *
6497
6589
  * @author Daniel DeGroff
6498
6590
  */
6499
- export interface UserRegistrationUpdateEvent extends BaseEvent {
6591
+ export interface UserRegistrationUpdateEvent extends BaseUserEvent {
6500
6592
  applicationId?: UUID;
6501
6593
  original?: UserRegistration;
6502
6594
  registration?: UserRegistration;
6503
- user?: User;
6504
6595
  }
6505
6596
  /**
6506
6597
  * Entity API response object.
@@ -6554,10 +6645,9 @@ export interface EpicGamesApplicationConfiguration extends BaseIdentityProviderA
6554
6645
  *
6555
6646
  * @author Daniel DeGroff
6556
6647
  */
6557
- export interface UserRegistrationDeleteCompleteEvent extends BaseEvent {
6648
+ export interface UserRegistrationDeleteCompleteEvent extends BaseUserEvent {
6558
6649
  applicationId?: UUID;
6559
6650
  registration?: UserRegistration;
6560
- user?: User;
6561
6651
  }
6562
6652
  /**
6563
6653
  * Group API request object.
@@ -6602,8 +6692,7 @@ export interface GoogleApplicationConfiguration extends BaseIdentityProviderAppl
6602
6692
  *
6603
6693
  * @author Daniel DeGroff
6604
6694
  */
6605
- export interface UserDeleteCompleteEvent extends BaseEvent {
6606
- user?: User;
6695
+ export interface UserDeleteCompleteEvent extends BaseUserEvent {
6607
6696
  }
6608
6697
  /**
6609
6698
  * Supply additional information about the user account when creating a new credential
@@ -6756,6 +6845,21 @@ export interface User extends SecureIdentity {
6756
6845
  timezone?: string;
6757
6846
  twoFactor?: UserTwoFactorConfiguration;
6758
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
+ }
6759
6863
  /**
6760
6864
  * Search criteria for entity types.
6761
6865
  *
@@ -6769,9 +6873,8 @@ export interface EntityTypeSearchCriteria extends BaseSearchCriteria {
6769
6873
  *
6770
6874
  * @author Rob Davis
6771
6875
  */
6772
- export interface UserIdentityProviderUnlinkEvent extends BaseEvent {
6876
+ export interface UserIdentityProviderUnlinkEvent extends BaseUserEvent {
6773
6877
  identityProviderLink?: IdentityProviderLink;
6774
- user?: User;
6775
6878
  }
6776
6879
  /**
6777
6880
  * Contains extension output for requested extensions during a WebAuthn ceremony
@@ -6815,8 +6918,7 @@ export interface TenantWebAuthnConfiguration extends Enableable {
6815
6918
  *
6816
6919
  * @author Daniel DeGroff
6817
6920
  */
6818
- export interface GroupCreateCompleteEvent extends BaseEvent {
6819
- group?: Group;
6921
+ export interface GroupCreateCompleteEvent extends BaseGroupEvent {
6820
6922
  }
6821
6923
  /**
6822
6924
  * Options to request extensions during credential registration
@@ -6826,6 +6928,14 @@ export interface GroupCreateCompleteEvent extends BaseEvent {
6826
6928
  export interface WebAuthnRegistrationExtensionOptions {
6827
6929
  credProps?: boolean;
6828
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
+ }
6829
6939
  /**
6830
6940
  * Password Encryption Scheme Configuration
6831
6941
  *
@@ -7087,9 +7197,15 @@ export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoA
7087
7197
  *
7088
7198
  * @author Daniel DeGroff
7089
7199
  */
7090
- export interface UserUpdateCompleteEvent extends BaseEvent {
7200
+ export interface UserUpdateCompleteEvent extends BaseUserEvent {
7091
7201
  original?: User;
7092
- 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 {
7093
7209
  }
7094
7210
  /**
7095
7211
  * The transaction types for Webhooks and other event systems within FusionAuth.
@@ -7108,14 +7224,13 @@ export declare enum TransactionType {
7108
7224
  *
7109
7225
  * @author Daniel DeGroff
7110
7226
  */
7111
- export interface UserLoginSuccessEvent extends BaseEvent {
7227
+ export interface UserLoginSuccessEvent extends BaseUserEvent {
7112
7228
  applicationId?: UUID;
7113
7229
  authenticationType?: string;
7114
7230
  connectorId?: UUID;
7115
7231
  identityProviderId?: UUID;
7116
7232
  identityProviderName?: string;
7117
7233
  ipAddress?: string;
7118
- user?: User;
7119
7234
  }
7120
7235
  /**
7121
7236
  * Group Member Delete Request
@@ -7147,11 +7262,10 @@ export interface RegistrationResponse {
7147
7262
  *
7148
7263
  * @author Daniel DeGroff
7149
7264
  */
7150
- export interface UserRegistrationUpdateCompleteEvent extends BaseEvent {
7265
+ export interface UserRegistrationUpdateCompleteEvent extends BaseUserEvent {
7151
7266
  applicationId?: UUID;
7152
7267
  original?: UserRegistration;
7153
7268
  registration?: UserRegistration;
7154
- user?: User;
7155
7269
  }
7156
7270
  /**
7157
7271
  * Search response for Themes
@@ -7232,8 +7346,7 @@ export interface LoginConfiguration {
7232
7346
  *
7233
7347
  * @author Daniel DeGroff
7234
7348
  */
7235
- export interface GroupMemberAddEvent extends BaseEvent {
7236
- group?: Group;
7349
+ export interface GroupMemberAddEvent extends BaseGroupEvent {
7237
7350
  members?: Array<GroupMember>;
7238
7351
  }
7239
7352
  /**
@@ -7281,6 +7394,14 @@ export interface GenericConnectorConfiguration extends BaseConnectorConfiguratio
7281
7394
  readTimeout?: number;
7282
7395
  sslCertificateKeyId?: UUID;
7283
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
+ }
7284
7405
  /**
7285
7406
  * @author Daniel DeGroff
7286
7407
  */
@@ -7323,6 +7444,15 @@ export interface WebAuthnCredentialResponse {
7323
7444
  credential?: WebAuthnCredential;
7324
7445
  credentials?: Array<WebAuthnCredential>;
7325
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
+ }
7326
7456
  /**
7327
7457
  * @author Trevor Smith
7328
7458
  */
@@ -7752,7 +7882,7 @@ export interface PasswordBreachDetection extends Enableable {
7752
7882
  onLogin?: BreachAction;
7753
7883
  }
7754
7884
  /**
7755
- * Base-class for all FusionAuth events.
7885
+ * Base class for all FusionAuth events.
7756
7886
  *
7757
7887
  * @author Brian Pontarelli
7758
7888
  */
@@ -7940,8 +8070,7 @@ export interface LambdaSearchRequest {
7940
8070
  *
7941
8071
  * @author Daniel DeGroff
7942
8072
  */
7943
- export interface UserPasswordResetSendEvent extends BaseEvent {
7944
- user?: User;
8073
+ export interface UserPasswordResetSendEvent extends BaseUserEvent {
7945
8074
  }
7946
8075
  /**
7947
8076
  * The Integration Request
@@ -8102,9 +8231,8 @@ export declare enum VerificationStrategy {
8102
8231
  *
8103
8232
  * @author Daniel DeGroff
8104
8233
  */
8105
- export interface UserTwoFactorMethodAddEvent extends BaseEvent {
8234
+ export interface UserTwoFactorMethodAddEvent extends BaseUserEvent {
8106
8235
  method?: TwoFactorMethod;
8107
- user?: User;
8108
8236
  }
8109
8237
  /**
8110
8238
  * API request to start a WebAuthn registration ceremony
@@ -8137,8 +8265,7 @@ export interface IPAccessControlEntry {
8137
8265
  *
8138
8266
  * @author Daniel DeGroff
8139
8267
  */
8140
- export interface GroupMemberUpdateEvent extends BaseEvent {
8141
- group?: Group;
8268
+ export interface GroupMemberUpdateEvent extends BaseGroupEvent {
8142
8269
  members?: Array<GroupMember>;
8143
8270
  }
8144
8271
  /**
@@ -8146,8 +8273,19 @@ export interface GroupMemberUpdateEvent extends BaseEvent {
8146
8273
  *
8147
8274
  * @author Brian Pontarelli
8148
8275
  */
8149
- export interface UserDeactivateEvent extends BaseEvent {
8150
- 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;
8151
8289
  }
8152
8290
  /**
8153
8291
  * Group Member Response
@@ -8157,6 +8295,14 @@ export interface UserDeactivateEvent extends BaseEvent {
8157
8295
  export interface MemberResponse {
8158
8296
  members?: Record<UUID, Array<GroupMember>>;
8159
8297
  }
8298
+ /**
8299
+ * Webhook event log search request.
8300
+ *
8301
+ * @author Spencer Witt
8302
+ */
8303
+ export interface WebhookEventLogSearchRequest {
8304
+ search?: WebhookEventLogSearchCriteria;
8305
+ }
8160
8306
  /**
8161
8307
  * API response for completing WebAuthn assertion
8162
8308
  *
@@ -8259,10 +8405,9 @@ export interface LogHistory {
8259
8405
  *
8260
8406
  * @author Daniel DeGroff
8261
8407
  */
8262
- export interface UserRegistrationCreateEvent extends BaseEvent {
8408
+ export interface UserRegistrationCreateEvent extends BaseUserEvent {
8263
8409
  applicationId?: UUID;
8264
8410
  registration?: UserRegistration;
8265
- user?: User;
8266
8411
  }
8267
8412
  /**
8268
8413
  * Search request for Applications
@@ -8272,6 +8417,16 @@ export interface UserRegistrationCreateEvent extends BaseEvent {
8272
8417
  export interface ApplicationSearchRequest extends ExpandableRequest {
8273
8418
  search?: ApplicationSearchCriteria;
8274
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
+ }
8275
8430
  /**
8276
8431
  * API request for User consent types.
8277
8432
  *
@@ -8433,8 +8588,7 @@ export interface HYPRIdentityProvider extends BaseIdentityProvider<HYPRApplicati
8433
8588
  *
8434
8589
  * @author Daniel DeGroff
8435
8590
  */
8436
- export interface UserPasswordResetSuccessEvent extends BaseEvent {
8437
- user?: User;
8591
+ export interface UserPasswordResetSuccessEvent extends BaseUserEvent {
8438
8592
  }
8439
8593
  /**
8440
8594
  * Something that can be required and thus also optional. This currently extends Enableable because anything that is
@@ -8518,16 +8672,14 @@ export declare enum UnknownScopePolicy {
8518
8672
  *
8519
8673
  * @author Daniel DeGroff
8520
8674
  */
8521
- export interface UserPasswordResetStartEvent extends BaseEvent {
8522
- user?: User;
8675
+ export interface UserPasswordResetStartEvent extends BaseUserEvent {
8523
8676
  }
8524
8677
  /**
8525
8678
  * Models the Group Delete Event.
8526
8679
  *
8527
8680
  * @author Daniel DeGroff
8528
8681
  */
8529
- export interface GroupDeleteEvent extends BaseEvent {
8530
- group?: Group;
8682
+ export interface GroupDeleteEvent extends BaseGroupEvent {
8531
8683
  }
8532
8684
  export interface MultiFactorEmailTemplate {
8533
8685
  templateId?: UUID;
@@ -8624,8 +8776,7 @@ export interface ConsentResponse {
8624
8776
  *
8625
8777
  * @author Daniel DeGroff
8626
8778
  */
8627
- export interface GroupMemberRemoveEvent extends BaseEvent {
8628
- group?: Group;
8779
+ export interface GroupMemberRemoveEvent extends BaseGroupEvent {
8629
8780
  members?: Array<GroupMember>;
8630
8781
  }
8631
8782
  /**
@@ -8752,6 +8903,17 @@ export interface TenantDeleteRequest extends BaseEventRequest {
8752
8903
  export interface EventLogCreateEvent extends BaseEvent {
8753
8904
  eventLog?: EventLog;
8754
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
+ }
8755
8917
  export interface UniqueUsernameConfiguration extends Enableable {
8756
8918
  numberOfDigits?: number;
8757
8919
  separator?: string;