@fusionauth/typescript-client 1.33.0 → 1.37.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.
@@ -78,9 +78,9 @@ export declare class FusionAuthClient {
78
78
  /**
79
79
  * Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
80
80
  * When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
81
- * your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
81
+ * your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.
82
82
  *
83
- * An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
83
+ * An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
84
84
  *
85
85
  * @param {string} changePasswordId The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
86
86
  * @returns {Promise<ClientResponse<void>>}
@@ -89,9 +89,9 @@ export declare class FusionAuthClient {
89
89
  /**
90
90
  * Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
91
91
  * When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
92
- * your password, you must obtain a Truest Token by completing a Two-Factor Step-Up authentication.
92
+ * your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.
93
93
  *
94
- * An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
94
+ * An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
95
95
  *
96
96
  * @param {string} encodedJWT The encoded JWT (access token).
97
97
  * @returns {Promise<ClientResponse<void>>}
@@ -100,9 +100,9 @@ export declare class FusionAuthClient {
100
100
  /**
101
101
  * Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
102
102
  * When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
103
- * your password, you must obtain a Truest Request Id by completing a Two-Factor Step-Up authentication.
103
+ * your password, you must obtain a Trust Request Id by completing a Two-Factor Step-Up authentication.
104
104
  *
105
- * An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
105
+ * An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
106
106
  *
107
107
  * @param {string} loginId The loginId of the User that you intend to change the password for.
108
108
  * @returns {Promise<ClientResponse<void>>}
@@ -888,6 +888,16 @@ export declare class FusionAuthClient {
888
888
  * @returns {Promise<ClientResponse<LoginResponse>>}
889
889
  */
890
890
  loginPing(userId: UUID, applicationId: UUID, callerIPAddress: string): Promise<ClientResponse<LoginResponse>>;
891
+ /**
892
+ * Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using
893
+ * FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an
894
+ * application where they no longer have a session. This helps correctly track login counts, times and helps with
895
+ * reporting.
896
+ *
897
+ * @param {LoginPingRequest} request The login request that contains the user credentials used to log them in.
898
+ * @returns {Promise<ClientResponse<LoginResponse>>}
899
+ */
900
+ loginPingWithRequest(request: LoginPingRequest): Promise<ClientResponse<LoginResponse>>;
891
901
  /**
892
902
  * The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
893
903
  * client and revoke the refresh token stored. This API does nothing if the request does not contain an access
@@ -1221,7 +1231,7 @@ export declare class FusionAuthClient {
1221
1231
  */
1222
1232
  retrieveAction(actionId: UUID): Promise<ClientResponse<ActionResponse>>;
1223
1233
  /**
1224
- * Retrieves all of the actions for the user with the given Id. This will return all time based actions that are active,
1234
+ * Retrieves all the actions for the user with the given Id. This will return all time based actions that are active,
1225
1235
  * and inactive as well as non-time based actions.
1226
1236
  *
1227
1237
  * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -1229,14 +1239,14 @@ export declare class FusionAuthClient {
1229
1239
  */
1230
1240
  retrieveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
1231
1241
  /**
1232
- * Retrieves all of the actions for the user with the given Id that are currently preventing the User from logging in.
1242
+ * Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
1233
1243
  *
1234
1244
  * @param {UUID} userId The Id of the user to fetch the actions for.
1235
1245
  * @returns {Promise<ClientResponse<ActionResponse>>}
1236
1246
  */
1237
1247
  retrieveActionsPreventingLogin(userId: UUID): Promise<ClientResponse<ActionResponse>>;
1238
1248
  /**
1239
- * Retrieves all of the actions for the user with the given Id that are currently active.
1249
+ * Retrieves all the actions for the user with the given Id that are currently active.
1240
1250
  * An active action means one that is time based and has not been canceled, and has not ended.
1241
1251
  *
1242
1252
  * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -1251,7 +1261,7 @@ export declare class FusionAuthClient {
1251
1261
  */
1252
1262
  retrieveApplication(applicationId: UUID): Promise<ClientResponse<ApplicationResponse>>;
1253
1263
  /**
1254
- * Retrieves all of the applications.
1264
+ * Retrieves all the applications.
1255
1265
  *
1256
1266
  * @returns {Promise<ClientResponse<ApplicationResponse>>}
1257
1267
  */
@@ -1271,7 +1281,7 @@ export declare class FusionAuthClient {
1271
1281
  */
1272
1282
  retrieveConnector(connectorId: UUID): Promise<ClientResponse<ConnectorResponse>>;
1273
1283
  /**
1274
- * Retrieves all of the connectors.
1284
+ * Retrieves all the connectors.
1275
1285
  *
1276
1286
  * @returns {Promise<ClientResponse<ConnectorResponse>>}
1277
1287
  */
@@ -1284,7 +1294,7 @@ export declare class FusionAuthClient {
1284
1294
  */
1285
1295
  retrieveConsent(consentId: UUID): Promise<ClientResponse<ConsentResponse>>;
1286
1296
  /**
1287
- * Retrieves all of the consent.
1297
+ * Retrieves all the consent.
1288
1298
  *
1289
1299
  * @returns {Promise<ClientResponse<ConsentResponse>>}
1290
1300
  */
@@ -1316,7 +1326,7 @@ export declare class FusionAuthClient {
1316
1326
  */
1317
1327
  retrieveEmailTemplatePreview(request: PreviewRequest): Promise<ClientResponse<PreviewResponse>>;
1318
1328
  /**
1319
- * Retrieves all of the email templates.
1329
+ * Retrieves all the email templates.
1320
1330
  *
1321
1331
  * @returns {Promise<ClientResponse<EmailTemplateResponse>>}
1322
1332
  */
@@ -1345,7 +1355,7 @@ export declare class FusionAuthClient {
1345
1355
  */
1346
1356
  retrieveEntityType(entityTypeId: UUID): Promise<ClientResponse<EntityTypeResponse>>;
1347
1357
  /**
1348
- * Retrieves all of the Entity Types.
1358
+ * Retrieves all the Entity Types.
1349
1359
  *
1350
1360
  * @returns {Promise<ClientResponse<EntityTypeResponse>>}
1351
1361
  */
@@ -1358,14 +1368,14 @@ export declare class FusionAuthClient {
1358
1368
  */
1359
1369
  retrieveEventLog(eventLogId: number): Promise<ClientResponse<EventLogResponse>>;
1360
1370
  /**
1361
- * Retrieves all of the families that a user belongs to.
1371
+ * Retrieves all the families that a user belongs to.
1362
1372
  *
1363
1373
  * @param {UUID} userId The User's id
1364
1374
  * @returns {Promise<ClientResponse<FamilyResponse>>}
1365
1375
  */
1366
1376
  retrieveFamilies(userId: UUID): Promise<ClientResponse<FamilyResponse>>;
1367
1377
  /**
1368
- * Retrieves all of the members of a family by the unique Family Id.
1378
+ * Retrieves all the members of a family by the unique Family Id.
1369
1379
  *
1370
1380
  * @param {UUID} familyId The unique Id of the Family.
1371
1381
  * @returns {Promise<ClientResponse<FamilyResponse>>}
@@ -1386,13 +1396,13 @@ export declare class FusionAuthClient {
1386
1396
  */
1387
1397
  retrieveFormField(fieldId: UUID): Promise<ClientResponse<FormFieldResponse>>;
1388
1398
  /**
1389
- * Retrieves all of the forms fields
1399
+ * Retrieves all the forms fields
1390
1400
  *
1391
1401
  * @returns {Promise<ClientResponse<FormFieldResponse>>}
1392
1402
  */
1393
1403
  retrieveFormFields(): Promise<ClientResponse<FormFieldResponse>>;
1394
1404
  /**
1395
- * Retrieves all of the forms.
1405
+ * Retrieves all the forms.
1396
1406
  *
1397
1407
  * @returns {Promise<ClientResponse<FormResponse>>}
1398
1408
  */
@@ -1405,7 +1415,7 @@ export declare class FusionAuthClient {
1405
1415
  */
1406
1416
  retrieveGroup(groupId: UUID): Promise<ClientResponse<GroupResponse>>;
1407
1417
  /**
1408
- * Retrieves all of the groups.
1418
+ * Retrieves all the groups.
1409
1419
  *
1410
1420
  * @returns {Promise<ClientResponse<GroupResponse>>}
1411
1421
  */
@@ -1434,13 +1444,13 @@ export declare class FusionAuthClient {
1434
1444
  */
1435
1445
  retrieveIdentityProviderByType(type: IdentityProviderType): Promise<ClientResponse<IdentityProviderResponse>>;
1436
1446
  /**
1437
- * Retrieves all of the identity providers.
1447
+ * Retrieves all the identity providers.
1438
1448
  *
1439
1449
  * @returns {Promise<ClientResponse<IdentityProviderResponse>>}
1440
1450
  */
1441
1451
  retrieveIdentityProviders(): Promise<ClientResponse<IdentityProviderResponse>>;
1442
1452
  /**
1443
- * Retrieves all of the actions for the user with the given Id that are currently inactive.
1453
+ * Retrieves all the actions for the user with the given Id that are currently inactive.
1444
1454
  * An inactive action means one that is time based and has been canceled or has expired, or is not time based.
1445
1455
  *
1446
1456
  * @param {UUID} userId The Id of the user to fetch the actions for.
@@ -1448,13 +1458,13 @@ export declare class FusionAuthClient {
1448
1458
  */
1449
1459
  retrieveInactiveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
1450
1460
  /**
1451
- * Retrieves all of the applications that are currently inactive.
1461
+ * Retrieves all the applications that are currently inactive.
1452
1462
  *
1453
1463
  * @returns {Promise<ClientResponse<ApplicationResponse>>}
1454
1464
  */
1455
1465
  retrieveInactiveApplications(): Promise<ClientResponse<ApplicationResponse>>;
1456
1466
  /**
1457
- * Retrieves all of the user actions that are currently inactive.
1467
+ * Retrieves all the user actions that are currently inactive.
1458
1468
  *
1459
1469
  * @returns {Promise<ClientResponse<UserActionResponse>>}
1460
1470
  */
@@ -1499,7 +1509,7 @@ export declare class FusionAuthClient {
1499
1509
  */
1500
1510
  retrieveKey(keyId: UUID): Promise<ClientResponse<KeyResponse>>;
1501
1511
  /**
1502
- * Retrieves all of the keys.
1512
+ * Retrieves all the keys.
1503
1513
  *
1504
1514
  * @returns {Promise<ClientResponse<KeyResponse>>}
1505
1515
  */
@@ -1512,13 +1522,13 @@ export declare class FusionAuthClient {
1512
1522
  */
1513
1523
  retrieveLambda(lambdaId: UUID): Promise<ClientResponse<LambdaResponse>>;
1514
1524
  /**
1515
- * Retrieves all of the lambdas.
1525
+ * Retrieves all the lambdas.
1516
1526
  *
1517
1527
  * @returns {Promise<ClientResponse<LambdaResponse>>}
1518
1528
  */
1519
1529
  retrieveLambdas(): Promise<ClientResponse<LambdaResponse>>;
1520
1530
  /**
1521
- * Retrieves all of the lambdas for the provided type.
1531
+ * Retrieves all the lambdas for the provided type.
1522
1532
  *
1523
1533
  * @param {LambdaType} type The type of the lambda to return.
1524
1534
  * @returns {Promise<ClientResponse<LambdaResponse>>}
@@ -1549,7 +1559,7 @@ export declare class FusionAuthClient {
1549
1559
  */
1550
1560
  retrieveMessageTemplatePreview(request: PreviewMessageTemplateRequest): Promise<ClientResponse<PreviewMessageTemplateResponse>>;
1551
1561
  /**
1552
- * Retrieves all of the message templates.
1562
+ * Retrieves all the message templates.
1553
1563
  *
1554
1564
  * @returns {Promise<ClientResponse<MessageTemplateResponse>>}
1555
1565
  */
@@ -1562,7 +1572,7 @@ export declare class FusionAuthClient {
1562
1572
  */
1563
1573
  retrieveMessenger(messengerId: UUID): Promise<ClientResponse<MessengerResponse>>;
1564
1574
  /**
1565
- * Retrieves all of the messengers.
1575
+ * Retrieves all the messengers.
1566
1576
  *
1567
1577
  * @returns {Promise<ClientResponse<MessengerResponse>>}
1568
1578
  */
@@ -1609,7 +1619,7 @@ export declare class FusionAuthClient {
1609
1619
  */
1610
1620
  retrievePasswordValidationRulesWithTenantId(tenantId: UUID): Promise<ClientResponse<PasswordValidationRulesResponse>>;
1611
1621
  /**
1612
- * Retrieves all of the children for the given parent email address.
1622
+ * Retrieves all the children for the given parent email address.
1613
1623
  *
1614
1624
  * @param {string} parentEmail The email of the parent.
1615
1625
  * @returns {Promise<ClientResponse<PendingResponse>>}
@@ -1636,12 +1646,12 @@ export declare class FusionAuthClient {
1636
1646
  */
1637
1647
  retrieveRecentLogins(offset: number, limit: number): Promise<ClientResponse<RecentLoginResponse>>;
1638
1648
  /**
1639
- * Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token, if you have that, you already have what you need..
1649
+ * Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token. If you have that, you already have what you need.
1640
1650
  *
1641
- * @param {UUID} userId The Id of the user.
1651
+ * @param {UUID} tokenId The Id of the token.
1642
1652
  * @returns {Promise<ClientResponse<RefreshTokenResponse>>}
1643
1653
  */
1644
- retrieveRefreshTokenById(userId: UUID): Promise<ClientResponse<RefreshTokenResponse>>;
1654
+ retrieveRefreshTokenById(tokenId: UUID): Promise<ClientResponse<RefreshTokenResponse>>;
1645
1655
  /**
1646
1656
  * Retrieves the refresh tokens that belong to the user with the given Id.
1647
1657
  *
@@ -1688,7 +1698,7 @@ export declare class FusionAuthClient {
1688
1698
  */
1689
1699
  retrieveTenant(tenantId: UUID): Promise<ClientResponse<TenantResponse>>;
1690
1700
  /**
1691
- * Retrieves all of the tenants.
1701
+ * Retrieves all the tenants.
1692
1702
  *
1693
1703
  * @returns {Promise<ClientResponse<TenantResponse>>}
1694
1704
  */
@@ -1701,7 +1711,7 @@ export declare class FusionAuthClient {
1701
1711
  */
1702
1712
  retrieveTheme(themeId: UUID): Promise<ClientResponse<ThemeResponse>>;
1703
1713
  /**
1704
- * Retrieves all of the themes.
1714
+ * Retrieves all the themes.
1705
1715
  *
1706
1716
  * @returns {Promise<ClientResponse<ThemeResponse>>}
1707
1717
  */
@@ -1720,6 +1730,18 @@ export declare class FusionAuthClient {
1720
1730
  * @returns {Promise<ClientResponse<TwoFactorRecoveryCodeResponse>>}
1721
1731
  */
1722
1732
  retrieveTwoFactorRecoveryCodes(userId: UUID): Promise<ClientResponse<TwoFactorRecoveryCodeResponse>>;
1733
+ /**
1734
+ * Retrieve a user's two-factor status.
1735
+ *
1736
+ * This can be used to see if a user will need to complete a two-factor challenge to complete a login,
1737
+ * and optionally identify the state of the two-factor trust across various applications.
1738
+ *
1739
+ * @param {UUID} userId The user Id to retrieve the Two-Factor status.
1740
+ * @param {UUID} applicationId The optional applicationId to verify.
1741
+ * @param {string} twoFactorTrustId The optional two-factor trust Id to verify.
1742
+ * @returns {Promise<ClientResponse<TwoFactorStatusResponse>>}
1743
+ */
1744
+ retrieveTwoFactorStatus(userId: UUID, applicationId: UUID, twoFactorTrustId: string): Promise<ClientResponse<TwoFactorStatusResponse>>;
1723
1745
  /**
1724
1746
  * Retrieves the user for the given Id.
1725
1747
  *
@@ -1750,7 +1772,7 @@ export declare class FusionAuthClient {
1750
1772
  */
1751
1773
  retrieveUserActionReasons(): Promise<ClientResponse<UserActionReasonResponse>>;
1752
1774
  /**
1753
- * Retrieves all of the user actions.
1775
+ * Retrieves all the user actions.
1754
1776
  *
1755
1777
  * @returns {Promise<ClientResponse<UserActionResponse>>}
1756
1778
  */
@@ -1793,7 +1815,7 @@ export declare class FusionAuthClient {
1793
1815
  */
1794
1816
  retrieveUserByVerificationId(verificationId: string): Promise<ClientResponse<UserResponse>>;
1795
1817
  /**
1796
- * Retrieves all of the comments for the user with the given Id.
1818
+ * Retrieves all the comments for the user with the given Id.
1797
1819
  *
1798
1820
  * @param {UUID} userId The Id of the user.
1799
1821
  * @returns {Promise<ClientResponse<UserCommentResponse>>}
@@ -1807,7 +1829,7 @@ export declare class FusionAuthClient {
1807
1829
  */
1808
1830
  retrieveUserConsent(userConsentId: UUID): Promise<ClientResponse<UserConsentResponse>>;
1809
1831
  /**
1810
- * Retrieves all of the consents for a User.
1832
+ * Retrieves all the consents for a User.
1811
1833
  *
1812
1834
  * @param {UUID} userId The User's Id
1813
1835
  * @returns {Promise<ClientResponse<UserConsentResponse>>}
@@ -2019,6 +2041,13 @@ export declare class FusionAuthClient {
2019
2041
  * @returns {Promise<ClientResponse<EventLogSearchResponse>>}
2020
2042
  */
2021
2043
  searchEventLogs(request: EventLogSearchRequest): Promise<ClientResponse<EventLogSearchResponse>>;
2044
+ /**
2045
+ * Searches group members with the specified criteria and pagination.
2046
+ *
2047
+ * @param {GroupMemberSearchRequest} request The search criteria and pagination information.
2048
+ * @returns {Promise<ClientResponse<GroupMemberSearchResponse>>}
2049
+ */
2050
+ searchGroupMembers(request: GroupMemberSearchRequest): Promise<ClientResponse<GroupMemberSearchResponse>>;
2022
2051
  /**
2023
2052
  * Searches the IP Access Control Lists with the specified criteria and pagination.
2024
2053
  *
@@ -2256,6 +2285,13 @@ export declare class FusionAuthClient {
2256
2285
  * @returns {Promise<ClientResponse<GroupResponse>>}
2257
2286
  */
2258
2287
  updateGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
2288
+ /**
2289
+ * Creates a member in a group.
2290
+ *
2291
+ * @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
2292
+ * @returns {Promise<ClientResponse<MemberResponse>>}
2293
+ */
2294
+ updateGroupMembers(request: MemberRequest): Promise<ClientResponse<MemberResponse>>;
2259
2295
  /**
2260
2296
  * Updates the IP Access Control List with the given Id.
2261
2297
  *
@@ -2445,6 +2481,15 @@ export declare class FusionAuthClient {
2445
2481
  * @returns {Promise<ClientResponse<void>>}
2446
2482
  */
2447
2483
  verifyEmailAddress(request: VerifyEmailRequest): Promise<ClientResponse<void>>;
2484
+ /**
2485
+ * Administratively verify a user's email address. Use this method to bypass email verification for the user.
2486
+ *
2487
+ * The request body will contain the userId to be verified. An API key is required when sending the userId in the request body.
2488
+ *
2489
+ * @param {VerifyEmailRequest} request The request that contains the userId to verify.
2490
+ * @returns {Promise<ClientResponse<void>>}
2491
+ */
2492
+ verifyEmailAddressByUserId(request: VerifyEmailRequest): Promise<ClientResponse<void>>;
2448
2493
  /**
2449
2494
  * Confirms an application registration. The Id given is usually from an email sent to the user.
2450
2495
  *
@@ -2488,6 +2533,7 @@ export interface AccessToken {
2488
2533
  expires_in?: number;
2489
2534
  id_token?: string;
2490
2535
  refresh_token?: string;
2536
+ refresh_token_id?: UUID;
2491
2537
  scope?: string;
2492
2538
  token_type?: TokenType;
2493
2539
  userId?: UUID;
@@ -2534,6 +2580,9 @@ export declare enum Algorithm {
2534
2580
  HS256 = "HS256",
2535
2581
  HS384 = "HS384",
2536
2582
  HS512 = "HS512",
2583
+ PS256 = "PS256",
2584
+ PS384 = "PS384",
2585
+ PS512 = "PS512",
2537
2586
  RS256 = "RS256",
2538
2587
  RS384 = "RS384",
2539
2588
  RS512 = "RS512",
@@ -2608,6 +2657,7 @@ export interface Application {
2608
2657
  cleanSpeakConfiguration?: CleanSpeakConfiguration;
2609
2658
  data?: Record<string, any>;
2610
2659
  emailConfiguration?: ApplicationEmailConfiguration;
2660
+ externalIdentifierConfiguration?: ApplicationExternalIdentifierConfiguration;
2611
2661
  formConfiguration?: ApplicationFormConfiguration;
2612
2662
  id?: UUID;
2613
2663
  insertInstant?: number;
@@ -2654,11 +2704,10 @@ export interface ApplicationEmailConfiguration {
2654
2704
  twoFactorMethodRemoveEmailTemplateId?: UUID;
2655
2705
  }
2656
2706
  /**
2657
- * Events that are bound to applications.
2658
- *
2659
- * @author Brian Pontarelli
2707
+ * @author Daniel DeGroff
2660
2708
  */
2661
- export interface ApplicationEvent {
2709
+ export interface ApplicationExternalIdentifierConfiguration {
2710
+ twoFactorTrustIdTimeToLiveInSeconds?: number;
2662
2711
  }
2663
2712
  /**
2664
2713
  * @author Daniel DeGroff
@@ -2672,7 +2721,17 @@ export interface ApplicationFormConfiguration {
2672
2721
  */
2673
2722
  export interface ApplicationMultiFactorConfiguration {
2674
2723
  email?: MultiFactorEmailTemplate;
2724
+ loginPolicy?: MultiFactorLoginPolicy;
2675
2725
  sms?: MultiFactorSMSTemplate;
2726
+ trustPolicy?: ApplicationMultiFactorTrustPolicy;
2727
+ }
2728
+ /**
2729
+ * @author Daniel DeGroff
2730
+ */
2731
+ export declare enum ApplicationMultiFactorTrustPolicy {
2732
+ Any = "Any",
2733
+ This = "This",
2734
+ None = "None"
2676
2735
  }
2677
2736
  /**
2678
2737
  * A Application-level policy for deleting Users.
@@ -2690,7 +2749,6 @@ export interface ApplicationRegistrationDeletePolicy {
2690
2749
  export interface ApplicationRequest extends BaseEventRequest {
2691
2750
  application?: Application;
2692
2751
  role?: ApplicationRole;
2693
- webhookIds?: Array<UUID>;
2694
2752
  }
2695
2753
  /**
2696
2754
  * The Application API response.
@@ -2848,6 +2906,7 @@ export interface BaseElasticSearchCriteria extends BaseSearchCriteria {
2848
2906
  * @author Brian Pontarelli
2849
2907
  */
2850
2908
  export interface BaseEvent {
2909
+ applicationIds?: Array<UUID>;
2851
2910
  createInstant?: number;
2852
2911
  id?: UUID;
2853
2912
  info?: EventInfo;
@@ -3233,6 +3292,7 @@ export interface EmailAddress {
3233
3292
  */
3234
3293
  export interface EmailConfiguration {
3235
3294
  additionalHeaders?: Array<EmailHeader>;
3295
+ debug?: boolean;
3236
3296
  defaultFromEmail?: string;
3237
3297
  defaultFromName?: string;
3238
3298
  emailUpdateEmailTemplateId?: UUID;
@@ -3521,7 +3581,7 @@ export interface EntityTypeSearchRequest {
3521
3581
  search?: EntityTypeSearchCriteria;
3522
3582
  }
3523
3583
  /**
3524
- * Search request for entity types.
3584
+ * Search response for entity types.
3525
3585
  *
3526
3586
  * @author Brian Pontarelli
3527
3587
  */
@@ -3685,10 +3745,12 @@ export declare enum EventType {
3685
3745
  UserDeactivate = "user.deactivate",
3686
3746
  UserDelete = "user.delete",
3687
3747
  UserDeleteComplete = "user.delete.complete",
3688
- UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
3689
- UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
3690
3748
  UserEmailUpdate = "user.email.update",
3691
3749
  UserEmailVerified = "user.email.verified",
3750
+ UserIdentityProviderLink = "user.identity-provider.link",
3751
+ UserIdentityProviderUnlink = "user.identity-provider.unlink",
3752
+ UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
3753
+ UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
3692
3754
  UserLoginFailed = "user.login.failed",
3693
3755
  UserLoginNewDevice = "user.login.new-device",
3694
3756
  UserLoginSuccess = "user.login.success",
@@ -4108,8 +4170,35 @@ export interface GroupMember {
4108
4170
  groupId?: UUID;
4109
4171
  id?: UUID;
4110
4172
  insertInstant?: number;
4173
+ user?: User;
4111
4174
  userId?: UUID;
4112
4175
  }
4176
+ /**
4177
+ * Search criteria for Group Members
4178
+ *
4179
+ * @author Daniel DeGroff
4180
+ */
4181
+ export interface GroupMemberSearchCriteria extends BaseSearchCriteria {
4182
+ groupId?: UUID;
4183
+ userId?: UUID;
4184
+ }
4185
+ /**
4186
+ * Search request for Group Members.
4187
+ *
4188
+ * @author Daniel DeGroff
4189
+ */
4190
+ export interface GroupMemberSearchRequest {
4191
+ search?: GroupMemberSearchCriteria;
4192
+ }
4193
+ /**
4194
+ * Search response for Group Members
4195
+ *
4196
+ * @author Daniel DeGroff
4197
+ */
4198
+ export interface GroupMemberSearchResponse {
4199
+ members?: Array<GroupMember>;
4200
+ total?: number;
4201
+ }
4113
4202
  /**
4114
4203
  * Group API request object.
4115
4204
  *
@@ -4202,6 +4291,7 @@ export interface IdentityProviderLink {
4202
4291
  */
4203
4292
  export declare enum IdentityProviderLinkingStrategy {
4204
4293
  CreatePendingLink = "CreatePendingLink",
4294
+ Disabled = "Disabled",
4205
4295
  LinkAnonymously = "LinkAnonymously",
4206
4296
  LinkByEmail = "LinkByEmail",
4207
4297
  LinkByEmailForExistingUser = "LinkByEmailForExistingUser",
@@ -4212,7 +4302,7 @@ export declare enum IdentityProviderLinkingStrategy {
4212
4302
  /**
4213
4303
  * @author Daniel DeGroff
4214
4304
  */
4215
- export interface IdentityProviderLinkRequest {
4305
+ export interface IdentityProviderLinkRequest extends BaseEventRequest {
4216
4306
  displayName?: string;
4217
4307
  identityProviderId?: UUID;
4218
4308
  identityProviderUserId?: string;
@@ -4511,7 +4601,6 @@ export interface JWTConfiguration extends Enableable {
4511
4601
  * @author Brian Pontarelli
4512
4602
  */
4513
4603
  export interface JWTPublicKeyUpdateEvent extends BaseEvent {
4514
- applicationIds?: Array<UUID>;
4515
4604
  }
4516
4605
  /**
4517
4606
  * Models the JWT Refresh Event. This event will be fired when a JWT is "refreshed" (generated) using a Refresh Token.
@@ -4528,12 +4617,14 @@ export interface JWTRefreshEvent extends BaseEvent {
4528
4617
  /**
4529
4618
  * API response for refreshing a JWT with a Refresh Token.
4530
4619
  * <p>
4531
- * Using a different response object from RefreshTokenResponse because the retrieve response will return an object for refreshToken, and this is a string.
4620
+ * Using a different response object from RefreshTokenResponse because the retrieve response will return an object for refreshToken, and this is a
4621
+ * string.
4532
4622
  *
4533
4623
  * @author Daniel DeGroff
4534
4624
  */
4535
4625
  export interface JWTRefreshResponse {
4536
4626
  refreshToken?: string;
4627
+ refreshTokenId?: UUID;
4537
4628
  token?: string;
4538
4629
  }
4539
4630
  /**
@@ -4545,6 +4636,7 @@ export interface JWTRefreshResponse {
4545
4636
  export interface JWTRefreshTokenRevokeEvent extends BaseEvent {
4546
4637
  applicationId?: UUID;
4547
4638
  applicationTimeToLiveInSeconds?: Record<UUID, number>;
4639
+ refreshToken?: RefreshToken;
4548
4640
  user?: User;
4549
4641
  userId?: UUID;
4550
4642
  }
@@ -4650,9 +4742,15 @@ export declare enum KeyUse {
4650
4742
  export interface KickstartSuccessEvent extends BaseEvent {
4651
4743
  instanceId?: UUID;
4652
4744
  }
4653
- export interface Lambda extends Enableable {
4745
+ /**
4746
+ * A JavaScript lambda function that is executed during certain events inside FusionAuth.
4747
+ *
4748
+ * @author Brian Pontarelli
4749
+ */
4750
+ export interface Lambda {
4654
4751
  body?: string;
4655
4752
  debug?: boolean;
4753
+ engineType?: LambdaEngineType;
4656
4754
  id?: UUID;
4657
4755
  insertInstant?: number;
4658
4756
  lastUpdateInstant?: number;
@@ -4670,6 +4768,13 @@ export interface LambdaConfiguration {
4670
4768
  export interface LambdaConfiguration {
4671
4769
  reconcileId?: UUID;
4672
4770
  }
4771
+ /**
4772
+ * @author Daniel DeGroff
4773
+ */
4774
+ export declare enum LambdaEngineType {
4775
+ GraalJS = "GraalJS",
4776
+ Nashorn = "Nashorn"
4777
+ }
4673
4778
  /**
4674
4779
  * Lambda API request object.
4675
4780
  *
@@ -4711,7 +4816,11 @@ export declare enum LambdaType {
4711
4816
  SteamReconcile = "SteamReconcile",
4712
4817
  TwitchReconcile = "TwitchReconcile",
4713
4818
  XboxReconcile = "XboxReconcile",
4714
- ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate"
4819
+ ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate",
4820
+ SCIMServerGroupRequestConverter = "SCIMServerGroupRequestConverter",
4821
+ SCIMServerGroupResponseConverter = "SCIMServerGroupResponseConverter",
4822
+ SCIMServerUserRequestConverter = "SCIMServerUserRequestConverter",
4823
+ SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter"
4715
4824
  }
4716
4825
  /**
4717
4826
  * Models an LDAP connector.
@@ -4799,6 +4908,14 @@ export declare enum LoginIdType {
4799
4908
  email = "email",
4800
4909
  username = "username"
4801
4910
  }
4911
+ /**
4912
+ * Login Ping API request object.
4913
+ *
4914
+ * @author Daniel DeGroff
4915
+ */
4916
+ export interface LoginPingRequest extends BaseLoginRequest {
4917
+ userId?: UUID;
4918
+ }
4802
4919
  /**
4803
4920
  * The summary of the action that is preventing login to be returned on the login response.
4804
4921
  *
@@ -4881,6 +4998,7 @@ export interface LoginResponse {
4881
4998
  methods?: Array<TwoFactorMethod>;
4882
4999
  pendingIdPLinkId?: string;
4883
5000
  refreshToken?: string;
5001
+ refreshTokenId?: UUID;
4884
5002
  registrationVerificationId?: string;
4885
5003
  state?: Record<string, any>;
4886
5004
  threatsDetected?: Array<AuthenticationThreats>;
@@ -5049,6 +5167,13 @@ export interface MultiFactorEmailMethod extends Enableable {
5049
5167
  export interface MultiFactorEmailTemplate {
5050
5168
  templateId?: UUID;
5051
5169
  }
5170
+ /**
5171
+ * @author Daniel DeGroff
5172
+ */
5173
+ export declare enum MultiFactorLoginPolicy {
5174
+ Disabled = "Disabled",
5175
+ Enabled = "Enabled"
5176
+ }
5052
5177
  export interface MultiFactorSMSMethod extends Enableable {
5053
5178
  messengerId?: UUID;
5054
5179
  templateId?: UUID;
@@ -5063,7 +5188,10 @@ export interface NintendoApplicationConfiguration extends BaseIdentityProviderAp
5063
5188
  buttonText?: string;
5064
5189
  client_id?: string;
5065
5190
  client_secret?: string;
5191
+ emailClaim?: string;
5066
5192
  scope?: string;
5193
+ uniqueIdClaim?: string;
5194
+ usernameClaim?: string;
5067
5195
  }
5068
5196
  /**
5069
5197
  * Nintendo gaming login provider.
@@ -5074,7 +5202,10 @@ export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoA
5074
5202
  buttonText?: string;
5075
5203
  client_id?: string;
5076
5204
  client_secret?: string;
5205
+ emailClaim?: string;
5077
5206
  scope?: string;
5207
+ uniqueIdClaim?: string;
5208
+ usernameClaim?: string;
5078
5209
  }
5079
5210
  /**
5080
5211
  * A marker interface indicating this event cannot be made transactional.
@@ -5120,6 +5251,7 @@ export interface OAuthError {
5120
5251
  error_reason?: OAuthErrorReason;
5121
5252
  error_uri?: string;
5122
5253
  two_factor_id?: string;
5254
+ two_factor_methods?: Array<TwoFactorMethod>;
5123
5255
  }
5124
5256
  export declare enum OAuthErrorReason {
5125
5257
  auth_code_not_found = "auth_code_not_found",
@@ -5462,13 +5594,18 @@ export interface ReactorResponse {
5462
5594
  */
5463
5595
  export interface ReactorStatus {
5464
5596
  advancedIdentityProviders?: ReactorFeatureStatus;
5597
+ advancedLambdas?: ReactorFeatureStatus;
5465
5598
  advancedMultiFactorAuthentication?: ReactorFeatureStatus;
5466
5599
  advancedRegistration?: ReactorFeatureStatus;
5600
+ applicationMultiFactorAuthentication?: ReactorFeatureStatus;
5467
5601
  applicationThemes?: ReactorFeatureStatus;
5468
5602
  breachedPasswordDetection?: ReactorFeatureStatus;
5469
5603
  connectors?: ReactorFeatureStatus;
5470
5604
  entityManagement?: ReactorFeatureStatus;
5605
+ expiration?: string;
5606
+ licenseAttributes?: Record<string, string>;
5471
5607
  licensed?: boolean;
5608
+ scimServer?: ReactorFeatureStatus;
5472
5609
  threatDetection?: ReactorFeatureStatus;
5473
5610
  }
5474
5611
  /**
@@ -5997,6 +6134,7 @@ export interface Tenant {
5997
6134
  insertInstant?: number;
5998
6135
  issuer?: string;
5999
6136
  jwtConfiguration?: JWTConfiguration;
6137
+ lambdaConfiguration?: TenantLambdaConfiguration;
6000
6138
  lastUpdateInstant?: number;
6001
6139
  loginConfiguration?: TenantLoginConfiguration;
6002
6140
  logoutURL?: string;
@@ -6009,6 +6147,7 @@ export interface Tenant {
6009
6147
  passwordValidationRules?: PasswordValidationRules;
6010
6148
  rateLimitConfiguration?: TenantRateLimitConfiguration;
6011
6149
  registrationConfiguration?: TenantRegistrationConfiguration;
6150
+ scimServerConfiguration?: TenantSCIMServerConfiguration;
6012
6151
  ssoConfiguration?: TenantSSOConfiguration;
6013
6152
  state?: ObjectState;
6014
6153
  themeId?: UUID;
@@ -6049,6 +6188,17 @@ export interface TenantDeleteRequest extends BaseEventRequest {
6049
6188
  export interface TenantFormConfiguration {
6050
6189
  adminUserFormId?: UUID;
6051
6190
  }
6191
+ /**
6192
+ * @author Rob Davis
6193
+ */
6194
+ export interface TenantLambdaConfiguration {
6195
+ scimEnterpriseUserRequestConverterId?: UUID;
6196
+ scimEnterpriseUserResponseConverterId?: UUID;
6197
+ scimGroupRequestConverterId?: UUID;
6198
+ scimGroupResponseConverterId?: UUID;
6199
+ scimUserRequestConverterId?: UUID;
6200
+ scimUserResponseConverterId?: UUID;
6201
+ }
6052
6202
  /**
6053
6203
  * @author Daniel DeGroff
6054
6204
  */
@@ -6061,6 +6211,7 @@ export interface TenantLoginConfiguration {
6061
6211
  export interface TenantMultiFactorConfiguration {
6062
6212
  authenticator?: MultiFactorAuthenticatorMethod;
6063
6213
  email?: MultiFactorEmailMethod;
6214
+ loginPolicy?: MultiFactorLoginPolicy;
6064
6215
  sms?: MultiFactorSMSMethod;
6065
6216
  }
6066
6217
  export interface TenantOAuth2Configuration {
@@ -6089,6 +6240,7 @@ export interface TenantRegistrationConfiguration {
6089
6240
  export interface TenantRequest extends BaseEventRequest {
6090
6241
  sourceTenantId?: UUID;
6091
6242
  tenant?: Tenant;
6243
+ webhookIds?: Array<UUID>;
6092
6244
  }
6093
6245
  /**
6094
6246
  * @author Daniel DeGroff
@@ -6097,6 +6249,14 @@ export interface TenantResponse {
6097
6249
  tenant?: Tenant;
6098
6250
  tenants?: Array<Tenant>;
6099
6251
  }
6252
+ /**
6253
+ * @author Rob Davis
6254
+ */
6255
+ export interface TenantSCIMServerConfiguration extends Enableable {
6256
+ clientEntityTypeId?: UUID;
6257
+ schemas?: Record<string, any>;
6258
+ serverEntityTypeId?: UUID;
6259
+ }
6100
6260
  /**
6101
6261
  * @author Brett Pontarelli
6102
6262
  */
@@ -6357,6 +6517,18 @@ export interface TwoFactorStartResponse {
6357
6517
  methods?: Array<TwoFactorMethod>;
6358
6518
  twoFactorId?: string;
6359
6519
  }
6520
+ /**
6521
+ * @author Daniel DeGroff
6522
+ */
6523
+ export interface TwoFactorStatusResponse {
6524
+ trusts?: Array<TwoFactorTrust>;
6525
+ twoFactorTrustId?: string;
6526
+ }
6527
+ export interface TwoFactorTrust {
6528
+ applicationId?: UUID;
6529
+ expiration?: number;
6530
+ startInstant?: number;
6531
+ }
6360
6532
  export interface UIConfiguration {
6361
6533
  headerColor?: string;
6362
6534
  logoURL?: string;
@@ -6442,7 +6614,6 @@ export interface UserActionEvent extends BaseEvent {
6442
6614
  actioneeUserId?: UUID;
6443
6615
  actionerUserId?: UUID;
6444
6616
  actionId?: UUID;
6445
- applicationIds?: Array<UUID>;
6446
6617
  comment?: string;
6447
6618
  email?: Email;
6448
6619
  emailedUser?: boolean;
@@ -6713,6 +6884,24 @@ export interface UserEmailUpdateEvent extends BaseEvent {
6713
6884
  export interface UserEmailVerifiedEvent extends BaseEvent {
6714
6885
  user?: User;
6715
6886
  }
6887
+ /**
6888
+ * Models the User Identity Provider Link Event.
6889
+ *
6890
+ * @author Rob Davis
6891
+ */
6892
+ export interface UserIdentityProviderLinkEvent extends BaseEvent {
6893
+ identityProviderLink?: IdentityProviderLink;
6894
+ user?: User;
6895
+ }
6896
+ /**
6897
+ * Models the User Identity Provider Unlink Event.
6898
+ *
6899
+ * @author Rob Davis
6900
+ */
6901
+ export interface UserIdentityProviderUnlinkEvent extends BaseEvent {
6902
+ identityProviderLink?: IdentityProviderLink;
6903
+ user?: User;
6904
+ }
6716
6905
  /**
6717
6906
  * @author Daniel DeGroff
6718
6907
  */
@@ -7028,6 +7217,7 @@ export declare enum VerificationStrategy {
7028
7217
  */
7029
7218
  export interface VerifyEmailRequest extends BaseEventRequest {
7030
7219
  oneTimeCode?: string;
7220
+ userId?: UUID;
7031
7221
  verificationId?: string;
7032
7222
  }
7033
7223
  /**
@@ -7063,7 +7253,6 @@ export interface VersionResponse {
7063
7253
  * @author Brian Pontarelli
7064
7254
  */
7065
7255
  export interface Webhook {
7066
- applicationIds?: Array<UUID>;
7067
7256
  connectTimeout?: number;
7068
7257
  data?: Record<string, any>;
7069
7258
  description?: string;
@@ -7077,6 +7266,7 @@ export interface Webhook {
7077
7266
  lastUpdateInstant?: number;
7078
7267
  readTimeout?: number;
7079
7268
  sslCertificate?: string;
7269
+ tenantIds?: Array<UUID>;
7080
7270
  url?: string;
7081
7271
  }
7082
7272
  /**