@fusionauth/typescript-client 1.34.0 → 1.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/build/src/FusionAuthClient.d.ts +377 -68
- package/build/src/FusionAuthClient.js +165 -41
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +166 -42
- package/dist/fusionauth-typescript-client.min.js +1 -1
- package/dist/fusionauth-typescript-client.min.js.map +1 -1
- package/package.json +1 -1
|
@@ -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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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}
|
|
1651
|
+
* @param {UUID} tokenId The Id of the token.
|
|
1642
1652
|
* @returns {Promise<ClientResponse<RefreshTokenResponse>>}
|
|
1643
1653
|
*/
|
|
1644
|
-
retrieveRefreshTokenById(
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
2658
|
-
*
|
|
2659
|
-
* @author Brian Pontarelli
|
|
2707
|
+
* @author Daniel DeGroff
|
|
2660
2708
|
*/
|
|
2661
|
-
export interface
|
|
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.
|
|
@@ -3233,6 +3291,7 @@ export interface EmailAddress {
|
|
|
3233
3291
|
*/
|
|
3234
3292
|
export interface EmailConfiguration {
|
|
3235
3293
|
additionalHeaders?: Array<EmailHeader>;
|
|
3294
|
+
debug?: boolean;
|
|
3236
3295
|
defaultFromEmail?: string;
|
|
3237
3296
|
defaultFromName?: string;
|
|
3238
3297
|
emailUpdateEmailTemplateId?: UUID;
|
|
@@ -3521,7 +3580,7 @@ export interface EntityTypeSearchRequest {
|
|
|
3521
3580
|
search?: EntityTypeSearchCriteria;
|
|
3522
3581
|
}
|
|
3523
3582
|
/**
|
|
3524
|
-
* Search
|
|
3583
|
+
* Search response for entity types.
|
|
3525
3584
|
*
|
|
3526
3585
|
* @author Brian Pontarelli
|
|
3527
3586
|
*/
|
|
@@ -3678,6 +3737,18 @@ export declare enum EventType {
|
|
|
3678
3737
|
AuditLogCreate = "audit-log.create",
|
|
3679
3738
|
EventLogCreate = "event-log.create",
|
|
3680
3739
|
KickstartSuccess = "kickstart.success",
|
|
3740
|
+
GroupCreate = "group.create",
|
|
3741
|
+
GroupCreateComplete = "group.create.complete",
|
|
3742
|
+
GroupDelete = "group.delete",
|
|
3743
|
+
GroupDeleteComplete = "group.delete.complete",
|
|
3744
|
+
GroupMemberAdd = "group.member.add",
|
|
3745
|
+
GroupMemberAddComplete = "group.member.add.complete",
|
|
3746
|
+
GroupMemberRemove = "group.member.remove",
|
|
3747
|
+
GroupMemberRemoveComplete = "group.member.remove.complete",
|
|
3748
|
+
GroupMemberUpdate = "group.member.update",
|
|
3749
|
+
GroupMemberUpdateComplete = "group.member.update.complete",
|
|
3750
|
+
GroupUpdate = "group.update",
|
|
3751
|
+
GroupUpdateComplete = "group.update.complete",
|
|
3681
3752
|
UserAction = "user.action",
|
|
3682
3753
|
UserBulkCreate = "user.bulk.create",
|
|
3683
3754
|
UserCreate = "user.create",
|
|
@@ -3685,10 +3756,12 @@ export declare enum EventType {
|
|
|
3685
3756
|
UserDeactivate = "user.deactivate",
|
|
3686
3757
|
UserDelete = "user.delete",
|
|
3687
3758
|
UserDeleteComplete = "user.delete.complete",
|
|
3688
|
-
UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
|
|
3689
|
-
UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
|
|
3690
3759
|
UserEmailUpdate = "user.email.update",
|
|
3691
3760
|
UserEmailVerified = "user.email.verified",
|
|
3761
|
+
UserIdentityProviderLink = "user.identity-provider.link",
|
|
3762
|
+
UserIdentityProviderUnlink = "user.identity-provider.unlink",
|
|
3763
|
+
UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
|
|
3764
|
+
UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
|
|
3692
3765
|
UserLoginFailed = "user.login.failed",
|
|
3693
3766
|
UserLoginNewDevice = "user.login.new-device",
|
|
3694
3767
|
UserLoginSuccess = "user.login.success",
|
|
@@ -4098,6 +4171,38 @@ export interface Group {
|
|
|
4098
4171
|
roles?: Record<UUID, Array<ApplicationRole>>;
|
|
4099
4172
|
tenantId?: UUID;
|
|
4100
4173
|
}
|
|
4174
|
+
/**
|
|
4175
|
+
* Models the Group Created Event.
|
|
4176
|
+
*
|
|
4177
|
+
* @author Daniel DeGroff
|
|
4178
|
+
*/
|
|
4179
|
+
export interface GroupCreateCompleteEvent extends BaseEvent {
|
|
4180
|
+
group?: Group;
|
|
4181
|
+
}
|
|
4182
|
+
/**
|
|
4183
|
+
* Models the Group Create Event.
|
|
4184
|
+
*
|
|
4185
|
+
* @author Daniel DeGroff
|
|
4186
|
+
*/
|
|
4187
|
+
export interface GroupCreateEvent extends BaseEvent {
|
|
4188
|
+
group?: Group;
|
|
4189
|
+
}
|
|
4190
|
+
/**
|
|
4191
|
+
* Models the Group Create Complete Event.
|
|
4192
|
+
*
|
|
4193
|
+
* @author Daniel DeGroff
|
|
4194
|
+
*/
|
|
4195
|
+
export interface GroupDeleteCompleteEvent extends BaseEvent {
|
|
4196
|
+
group?: Group;
|
|
4197
|
+
}
|
|
4198
|
+
/**
|
|
4199
|
+
* Models the Group Delete Event.
|
|
4200
|
+
*
|
|
4201
|
+
* @author Daniel DeGroff
|
|
4202
|
+
*/
|
|
4203
|
+
export interface GroupDeleteEvent extends BaseEvent {
|
|
4204
|
+
group?: Group;
|
|
4205
|
+
}
|
|
4101
4206
|
/**
|
|
4102
4207
|
* A User's membership into a Group
|
|
4103
4208
|
*
|
|
@@ -4108,8 +4213,90 @@ export interface GroupMember {
|
|
|
4108
4213
|
groupId?: UUID;
|
|
4109
4214
|
id?: UUID;
|
|
4110
4215
|
insertInstant?: number;
|
|
4216
|
+
user?: User;
|
|
4111
4217
|
userId?: UUID;
|
|
4112
4218
|
}
|
|
4219
|
+
/**
|
|
4220
|
+
* Models the Group Member Add Complete Event.
|
|
4221
|
+
*
|
|
4222
|
+
* @author Daniel DeGroff
|
|
4223
|
+
*/
|
|
4224
|
+
export interface GroupMemberAddCompleteEvent extends BaseEvent {
|
|
4225
|
+
group?: Group;
|
|
4226
|
+
members?: Array<GroupMember>;
|
|
4227
|
+
}
|
|
4228
|
+
/**
|
|
4229
|
+
* Models the Group Member Add Event.
|
|
4230
|
+
*
|
|
4231
|
+
* @author Daniel DeGroff
|
|
4232
|
+
*/
|
|
4233
|
+
export interface GroupMemberAddEvent extends BaseEvent {
|
|
4234
|
+
group?: Group;
|
|
4235
|
+
members?: Array<GroupMember>;
|
|
4236
|
+
}
|
|
4237
|
+
/**
|
|
4238
|
+
* Models the Group Member Remove Complete Event.
|
|
4239
|
+
*
|
|
4240
|
+
* @author Daniel DeGroff
|
|
4241
|
+
*/
|
|
4242
|
+
export interface GroupMemberRemoveCompleteEvent extends BaseEvent {
|
|
4243
|
+
group?: Group;
|
|
4244
|
+
members?: Array<GroupMember>;
|
|
4245
|
+
}
|
|
4246
|
+
/**
|
|
4247
|
+
* Models the Group Member Remove Event.
|
|
4248
|
+
*
|
|
4249
|
+
* @author Daniel DeGroff
|
|
4250
|
+
*/
|
|
4251
|
+
export interface GroupMemberRemoveEvent extends BaseEvent {
|
|
4252
|
+
group?: Group;
|
|
4253
|
+
members?: Array<GroupMember>;
|
|
4254
|
+
}
|
|
4255
|
+
/**
|
|
4256
|
+
* Search criteria for Group Members
|
|
4257
|
+
*
|
|
4258
|
+
* @author Daniel DeGroff
|
|
4259
|
+
*/
|
|
4260
|
+
export interface GroupMemberSearchCriteria extends BaseSearchCriteria {
|
|
4261
|
+
groupId?: UUID;
|
|
4262
|
+
tenantId?: UUID;
|
|
4263
|
+
userId?: UUID;
|
|
4264
|
+
}
|
|
4265
|
+
/**
|
|
4266
|
+
* Search request for Group Members.
|
|
4267
|
+
*
|
|
4268
|
+
* @author Daniel DeGroff
|
|
4269
|
+
*/
|
|
4270
|
+
export interface GroupMemberSearchRequest {
|
|
4271
|
+
search?: GroupMemberSearchCriteria;
|
|
4272
|
+
}
|
|
4273
|
+
/**
|
|
4274
|
+
* Search response for Group Members
|
|
4275
|
+
*
|
|
4276
|
+
* @author Daniel DeGroff
|
|
4277
|
+
*/
|
|
4278
|
+
export interface GroupMemberSearchResponse {
|
|
4279
|
+
members?: Array<GroupMember>;
|
|
4280
|
+
total?: number;
|
|
4281
|
+
}
|
|
4282
|
+
/**
|
|
4283
|
+
* Models the Group Member Update Complete Event.
|
|
4284
|
+
*
|
|
4285
|
+
* @author Daniel DeGroff
|
|
4286
|
+
*/
|
|
4287
|
+
export interface GroupMemberUpdateCompleteEvent extends BaseEvent {
|
|
4288
|
+
group?: Group;
|
|
4289
|
+
members?: Array<GroupMember>;
|
|
4290
|
+
}
|
|
4291
|
+
/**
|
|
4292
|
+
* Models the Group Member Update Event.
|
|
4293
|
+
*
|
|
4294
|
+
* @author Daniel DeGroff
|
|
4295
|
+
*/
|
|
4296
|
+
export interface GroupMemberUpdateEvent extends BaseEvent {
|
|
4297
|
+
group?: Group;
|
|
4298
|
+
members?: Array<GroupMember>;
|
|
4299
|
+
}
|
|
4113
4300
|
/**
|
|
4114
4301
|
* Group API request object.
|
|
4115
4302
|
*
|
|
@@ -4128,6 +4315,24 @@ export interface GroupResponse {
|
|
|
4128
4315
|
group?: Group;
|
|
4129
4316
|
groups?: Array<Group>;
|
|
4130
4317
|
}
|
|
4318
|
+
/**
|
|
4319
|
+
* Models the Group Update Complete Event.
|
|
4320
|
+
*
|
|
4321
|
+
* @author Daniel DeGroff
|
|
4322
|
+
*/
|
|
4323
|
+
export interface GroupUpdateCompleteEvent extends BaseEvent {
|
|
4324
|
+
group?: Group;
|
|
4325
|
+
original?: Group;
|
|
4326
|
+
}
|
|
4327
|
+
/**
|
|
4328
|
+
* Models the Group Update Event.
|
|
4329
|
+
*
|
|
4330
|
+
* @author Daniel DeGroff
|
|
4331
|
+
*/
|
|
4332
|
+
export interface GroupUpdateEvent extends BaseEvent {
|
|
4333
|
+
group?: Group;
|
|
4334
|
+
original?: Group;
|
|
4335
|
+
}
|
|
4131
4336
|
export interface HistoryItem {
|
|
4132
4337
|
actionerUserId?: UUID;
|
|
4133
4338
|
comment?: string;
|
|
@@ -4202,6 +4407,7 @@ export interface IdentityProviderLink {
|
|
|
4202
4407
|
*/
|
|
4203
4408
|
export declare enum IdentityProviderLinkingStrategy {
|
|
4204
4409
|
CreatePendingLink = "CreatePendingLink",
|
|
4410
|
+
Disabled = "Disabled",
|
|
4205
4411
|
LinkAnonymously = "LinkAnonymously",
|
|
4206
4412
|
LinkByEmail = "LinkByEmail",
|
|
4207
4413
|
LinkByEmailForExistingUser = "LinkByEmailForExistingUser",
|
|
@@ -4212,7 +4418,7 @@ export declare enum IdentityProviderLinkingStrategy {
|
|
|
4212
4418
|
/**
|
|
4213
4419
|
* @author Daniel DeGroff
|
|
4214
4420
|
*/
|
|
4215
|
-
export interface IdentityProviderLinkRequest {
|
|
4421
|
+
export interface IdentityProviderLinkRequest extends BaseEventRequest {
|
|
4216
4422
|
displayName?: string;
|
|
4217
4423
|
identityProviderId?: UUID;
|
|
4218
4424
|
identityProviderUserId?: string;
|
|
@@ -4505,7 +4711,7 @@ export interface JWTConfiguration extends Enableable {
|
|
|
4505
4711
|
timeToLiveInSeconds?: number;
|
|
4506
4712
|
}
|
|
4507
4713
|
/**
|
|
4508
|
-
* Models the JWT public key Refresh Token Revoke Event
|
|
4714
|
+
* Models the JWT public key Refresh Token Revoke Event. This event might be for a single
|
|
4509
4715
|
* token, a user or an entire application.
|
|
4510
4716
|
*
|
|
4511
4717
|
* @author Brian Pontarelli
|
|
@@ -4528,16 +4734,18 @@ export interface JWTRefreshEvent extends BaseEvent {
|
|
|
4528
4734
|
/**
|
|
4529
4735
|
* API response for refreshing a JWT with a Refresh Token.
|
|
4530
4736
|
* <p>
|
|
4531
|
-
* Using a different response object from RefreshTokenResponse because the retrieve response will return an object for refreshToken, and this is a
|
|
4737
|
+
* Using a different response object from RefreshTokenResponse because the retrieve response will return an object for refreshToken, and this is a
|
|
4738
|
+
* string.
|
|
4532
4739
|
*
|
|
4533
4740
|
* @author Daniel DeGroff
|
|
4534
4741
|
*/
|
|
4535
4742
|
export interface JWTRefreshResponse {
|
|
4536
4743
|
refreshToken?: string;
|
|
4744
|
+
refreshTokenId?: UUID;
|
|
4537
4745
|
token?: string;
|
|
4538
4746
|
}
|
|
4539
4747
|
/**
|
|
4540
|
-
* Models the Refresh Token Revoke Event
|
|
4748
|
+
* Models the Refresh Token Revoke Event. This event might be for a single token, a user
|
|
4541
4749
|
* or an entire application.
|
|
4542
4750
|
*
|
|
4543
4751
|
* @author Brian Pontarelli
|
|
@@ -4545,6 +4753,7 @@ export interface JWTRefreshResponse {
|
|
|
4545
4753
|
export interface JWTRefreshTokenRevokeEvent extends BaseEvent {
|
|
4546
4754
|
applicationId?: UUID;
|
|
4547
4755
|
applicationTimeToLiveInSeconds?: Record<UUID, number>;
|
|
4756
|
+
refreshToken?: RefreshToken;
|
|
4548
4757
|
user?: User;
|
|
4549
4758
|
userId?: UUID;
|
|
4550
4759
|
}
|
|
@@ -4650,9 +4859,15 @@ export declare enum KeyUse {
|
|
|
4650
4859
|
export interface KickstartSuccessEvent extends BaseEvent {
|
|
4651
4860
|
instanceId?: UUID;
|
|
4652
4861
|
}
|
|
4653
|
-
|
|
4862
|
+
/**
|
|
4863
|
+
* A JavaScript lambda function that is executed during certain events inside FusionAuth.
|
|
4864
|
+
*
|
|
4865
|
+
* @author Brian Pontarelli
|
|
4866
|
+
*/
|
|
4867
|
+
export interface Lambda {
|
|
4654
4868
|
body?: string;
|
|
4655
4869
|
debug?: boolean;
|
|
4870
|
+
engineType?: LambdaEngineType;
|
|
4656
4871
|
id?: UUID;
|
|
4657
4872
|
insertInstant?: number;
|
|
4658
4873
|
lastUpdateInstant?: number;
|
|
@@ -4670,6 +4885,13 @@ export interface LambdaConfiguration {
|
|
|
4670
4885
|
export interface LambdaConfiguration {
|
|
4671
4886
|
reconcileId?: UUID;
|
|
4672
4887
|
}
|
|
4888
|
+
/**
|
|
4889
|
+
* @author Daniel DeGroff
|
|
4890
|
+
*/
|
|
4891
|
+
export declare enum LambdaEngineType {
|
|
4892
|
+
GraalJS = "GraalJS",
|
|
4893
|
+
Nashorn = "Nashorn"
|
|
4894
|
+
}
|
|
4673
4895
|
/**
|
|
4674
4896
|
* Lambda API request object.
|
|
4675
4897
|
*
|
|
@@ -4711,7 +4933,11 @@ export declare enum LambdaType {
|
|
|
4711
4933
|
SteamReconcile = "SteamReconcile",
|
|
4712
4934
|
TwitchReconcile = "TwitchReconcile",
|
|
4713
4935
|
XboxReconcile = "XboxReconcile",
|
|
4714
|
-
ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate"
|
|
4936
|
+
ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate",
|
|
4937
|
+
SCIMServerGroupRequestConverter = "SCIMServerGroupRequestConverter",
|
|
4938
|
+
SCIMServerGroupResponseConverter = "SCIMServerGroupResponseConverter",
|
|
4939
|
+
SCIMServerUserRequestConverter = "SCIMServerUserRequestConverter",
|
|
4940
|
+
SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter"
|
|
4715
4941
|
}
|
|
4716
4942
|
/**
|
|
4717
4943
|
* Models an LDAP connector.
|
|
@@ -4799,6 +5025,14 @@ export declare enum LoginIdType {
|
|
|
4799
5025
|
email = "email",
|
|
4800
5026
|
username = "username"
|
|
4801
5027
|
}
|
|
5028
|
+
/**
|
|
5029
|
+
* Login Ping API request object.
|
|
5030
|
+
*
|
|
5031
|
+
* @author Daniel DeGroff
|
|
5032
|
+
*/
|
|
5033
|
+
export interface LoginPingRequest extends BaseLoginRequest {
|
|
5034
|
+
userId?: UUID;
|
|
5035
|
+
}
|
|
4802
5036
|
/**
|
|
4803
5037
|
* The summary of the action that is preventing login to be returned on the login response.
|
|
4804
5038
|
*
|
|
@@ -4881,6 +5115,7 @@ export interface LoginResponse {
|
|
|
4881
5115
|
methods?: Array<TwoFactorMethod>;
|
|
4882
5116
|
pendingIdPLinkId?: string;
|
|
4883
5117
|
refreshToken?: string;
|
|
5118
|
+
refreshTokenId?: UUID;
|
|
4884
5119
|
registrationVerificationId?: string;
|
|
4885
5120
|
state?: Record<string, any>;
|
|
4886
5121
|
threatsDetected?: Array<AuthenticationThreats>;
|
|
@@ -5049,6 +5284,13 @@ export interface MultiFactorEmailMethod extends Enableable {
|
|
|
5049
5284
|
export interface MultiFactorEmailTemplate {
|
|
5050
5285
|
templateId?: UUID;
|
|
5051
5286
|
}
|
|
5287
|
+
/**
|
|
5288
|
+
* @author Daniel DeGroff
|
|
5289
|
+
*/
|
|
5290
|
+
export declare enum MultiFactorLoginPolicy {
|
|
5291
|
+
Disabled = "Disabled",
|
|
5292
|
+
Enabled = "Enabled"
|
|
5293
|
+
}
|
|
5052
5294
|
export interface MultiFactorSMSMethod extends Enableable {
|
|
5053
5295
|
messengerId?: UUID;
|
|
5054
5296
|
templateId?: UUID;
|
|
@@ -5063,7 +5305,10 @@ export interface NintendoApplicationConfiguration extends BaseIdentityProviderAp
|
|
|
5063
5305
|
buttonText?: string;
|
|
5064
5306
|
client_id?: string;
|
|
5065
5307
|
client_secret?: string;
|
|
5308
|
+
emailClaim?: string;
|
|
5066
5309
|
scope?: string;
|
|
5310
|
+
uniqueIdClaim?: string;
|
|
5311
|
+
usernameClaim?: string;
|
|
5067
5312
|
}
|
|
5068
5313
|
/**
|
|
5069
5314
|
* Nintendo gaming login provider.
|
|
@@ -5074,7 +5319,10 @@ export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoA
|
|
|
5074
5319
|
buttonText?: string;
|
|
5075
5320
|
client_id?: string;
|
|
5076
5321
|
client_secret?: string;
|
|
5322
|
+
emailClaim?: string;
|
|
5077
5323
|
scope?: string;
|
|
5324
|
+
uniqueIdClaim?: string;
|
|
5325
|
+
usernameClaim?: string;
|
|
5078
5326
|
}
|
|
5079
5327
|
/**
|
|
5080
5328
|
* A marker interface indicating this event cannot be made transactional.
|
|
@@ -5120,6 +5368,7 @@ export interface OAuthError {
|
|
|
5120
5368
|
error_reason?: OAuthErrorReason;
|
|
5121
5369
|
error_uri?: string;
|
|
5122
5370
|
two_factor_id?: string;
|
|
5371
|
+
two_factor_methods?: Array<TwoFactorMethod>;
|
|
5123
5372
|
}
|
|
5124
5373
|
export declare enum OAuthErrorReason {
|
|
5125
5374
|
auth_code_not_found = "auth_code_not_found",
|
|
@@ -5462,13 +5711,18 @@ export interface ReactorResponse {
|
|
|
5462
5711
|
*/
|
|
5463
5712
|
export interface ReactorStatus {
|
|
5464
5713
|
advancedIdentityProviders?: ReactorFeatureStatus;
|
|
5714
|
+
advancedLambdas?: ReactorFeatureStatus;
|
|
5465
5715
|
advancedMultiFactorAuthentication?: ReactorFeatureStatus;
|
|
5466
5716
|
advancedRegistration?: ReactorFeatureStatus;
|
|
5717
|
+
applicationMultiFactorAuthentication?: ReactorFeatureStatus;
|
|
5467
5718
|
applicationThemes?: ReactorFeatureStatus;
|
|
5468
5719
|
breachedPasswordDetection?: ReactorFeatureStatus;
|
|
5469
5720
|
connectors?: ReactorFeatureStatus;
|
|
5470
5721
|
entityManagement?: ReactorFeatureStatus;
|
|
5722
|
+
expiration?: string;
|
|
5723
|
+
licenseAttributes?: Record<string, string>;
|
|
5471
5724
|
licensed?: boolean;
|
|
5725
|
+
scimServer?: ReactorFeatureStatus;
|
|
5472
5726
|
threatDetection?: ReactorFeatureStatus;
|
|
5473
5727
|
}
|
|
5474
5728
|
/**
|
|
@@ -5997,6 +6251,7 @@ export interface Tenant {
|
|
|
5997
6251
|
insertInstant?: number;
|
|
5998
6252
|
issuer?: string;
|
|
5999
6253
|
jwtConfiguration?: JWTConfiguration;
|
|
6254
|
+
lambdaConfiguration?: TenantLambdaConfiguration;
|
|
6000
6255
|
lastUpdateInstant?: number;
|
|
6001
6256
|
loginConfiguration?: TenantLoginConfiguration;
|
|
6002
6257
|
logoutURL?: string;
|
|
@@ -6009,6 +6264,7 @@ export interface Tenant {
|
|
|
6009
6264
|
passwordValidationRules?: PasswordValidationRules;
|
|
6010
6265
|
rateLimitConfiguration?: TenantRateLimitConfiguration;
|
|
6011
6266
|
registrationConfiguration?: TenantRegistrationConfiguration;
|
|
6267
|
+
scimServerConfiguration?: TenantSCIMServerConfiguration;
|
|
6012
6268
|
ssoConfiguration?: TenantSSOConfiguration;
|
|
6013
6269
|
state?: ObjectState;
|
|
6014
6270
|
themeId?: UUID;
|
|
@@ -6049,6 +6305,17 @@ export interface TenantDeleteRequest extends BaseEventRequest {
|
|
|
6049
6305
|
export interface TenantFormConfiguration {
|
|
6050
6306
|
adminUserFormId?: UUID;
|
|
6051
6307
|
}
|
|
6308
|
+
/**
|
|
6309
|
+
* @author Rob Davis
|
|
6310
|
+
*/
|
|
6311
|
+
export interface TenantLambdaConfiguration {
|
|
6312
|
+
scimEnterpriseUserRequestConverterId?: UUID;
|
|
6313
|
+
scimEnterpriseUserResponseConverterId?: UUID;
|
|
6314
|
+
scimGroupRequestConverterId?: UUID;
|
|
6315
|
+
scimGroupResponseConverterId?: UUID;
|
|
6316
|
+
scimUserRequestConverterId?: UUID;
|
|
6317
|
+
scimUserResponseConverterId?: UUID;
|
|
6318
|
+
}
|
|
6052
6319
|
/**
|
|
6053
6320
|
* @author Daniel DeGroff
|
|
6054
6321
|
*/
|
|
@@ -6061,6 +6328,7 @@ export interface TenantLoginConfiguration {
|
|
|
6061
6328
|
export interface TenantMultiFactorConfiguration {
|
|
6062
6329
|
authenticator?: MultiFactorAuthenticatorMethod;
|
|
6063
6330
|
email?: MultiFactorEmailMethod;
|
|
6331
|
+
loginPolicy?: MultiFactorLoginPolicy;
|
|
6064
6332
|
sms?: MultiFactorSMSMethod;
|
|
6065
6333
|
}
|
|
6066
6334
|
export interface TenantOAuth2Configuration {
|
|
@@ -6089,6 +6357,7 @@ export interface TenantRegistrationConfiguration {
|
|
|
6089
6357
|
export interface TenantRequest extends BaseEventRequest {
|
|
6090
6358
|
sourceTenantId?: UUID;
|
|
6091
6359
|
tenant?: Tenant;
|
|
6360
|
+
webhookIds?: Array<UUID>;
|
|
6092
6361
|
}
|
|
6093
6362
|
/**
|
|
6094
6363
|
* @author Daniel DeGroff
|
|
@@ -6097,6 +6366,14 @@ export interface TenantResponse {
|
|
|
6097
6366
|
tenant?: Tenant;
|
|
6098
6367
|
tenants?: Array<Tenant>;
|
|
6099
6368
|
}
|
|
6369
|
+
/**
|
|
6370
|
+
* @author Rob Davis
|
|
6371
|
+
*/
|
|
6372
|
+
export interface TenantSCIMServerConfiguration extends Enableable {
|
|
6373
|
+
clientEntityTypeId?: UUID;
|
|
6374
|
+
schemas?: Record<string, any>;
|
|
6375
|
+
serverEntityTypeId?: UUID;
|
|
6376
|
+
}
|
|
6100
6377
|
/**
|
|
6101
6378
|
* @author Brett Pontarelli
|
|
6102
6379
|
*/
|
|
@@ -6357,6 +6634,18 @@ export interface TwoFactorStartResponse {
|
|
|
6357
6634
|
methods?: Array<TwoFactorMethod>;
|
|
6358
6635
|
twoFactorId?: string;
|
|
6359
6636
|
}
|
|
6637
|
+
/**
|
|
6638
|
+
* @author Daniel DeGroff
|
|
6639
|
+
*/
|
|
6640
|
+
export interface TwoFactorStatusResponse {
|
|
6641
|
+
trusts?: Array<TwoFactorTrust>;
|
|
6642
|
+
twoFactorTrustId?: string;
|
|
6643
|
+
}
|
|
6644
|
+
export interface TwoFactorTrust {
|
|
6645
|
+
applicationId?: UUID;
|
|
6646
|
+
expiration?: number;
|
|
6647
|
+
startInstant?: number;
|
|
6648
|
+
}
|
|
6360
6649
|
export interface UIConfiguration {
|
|
6361
6650
|
headerColor?: string;
|
|
6362
6651
|
logoURL?: string;
|
|
@@ -6433,7 +6722,7 @@ export interface UserAction {
|
|
|
6433
6722
|
userNotificationsEnabled?: boolean;
|
|
6434
6723
|
}
|
|
6435
6724
|
/**
|
|
6436
|
-
* Models the user action
|
|
6725
|
+
* Models the user action Event.
|
|
6437
6726
|
*
|
|
6438
6727
|
* @author Brian Pontarelli
|
|
6439
6728
|
*/
|
|
@@ -6551,7 +6840,7 @@ export interface UserActionResponse {
|
|
|
6551
6840
|
userActions?: Array<UserAction>;
|
|
6552
6841
|
}
|
|
6553
6842
|
/**
|
|
6554
|
-
* Models the User Bulk Create Event
|
|
6843
|
+
* Models the User Bulk Create Event.
|
|
6555
6844
|
*
|
|
6556
6845
|
* @author Brian Pontarelli
|
|
6557
6846
|
*/
|
|
@@ -6620,7 +6909,7 @@ export interface UserConsentResponse {
|
|
|
6620
6909
|
userConsents?: Array<UserConsent>;
|
|
6621
6910
|
}
|
|
6622
6911
|
/**
|
|
6623
|
-
* Models the User Created Event
|
|
6912
|
+
* Models the User Created Event.
|
|
6624
6913
|
* <p>
|
|
6625
6914
|
* This is different than the user.create event in that it will be sent after the user has been created. This event cannot be made transactional.
|
|
6626
6915
|
*
|
|
@@ -6630,7 +6919,7 @@ export interface UserCreateCompleteEvent extends BaseEvent {
|
|
|
6630
6919
|
user?: User;
|
|
6631
6920
|
}
|
|
6632
6921
|
/**
|
|
6633
|
-
* Models the User Create Event
|
|
6922
|
+
* Models the User Create Event.
|
|
6634
6923
|
*
|
|
6635
6924
|
* @author Brian Pontarelli
|
|
6636
6925
|
*/
|
|
@@ -6638,7 +6927,7 @@ export interface UserCreateEvent extends BaseEvent {
|
|
|
6638
6927
|
user?: User;
|
|
6639
6928
|
}
|
|
6640
6929
|
/**
|
|
6641
|
-
* Models the User Deactivate Event
|
|
6930
|
+
* Models the User Deactivate Event.
|
|
6642
6931
|
*
|
|
6643
6932
|
* @author Brian Pontarelli
|
|
6644
6933
|
*/
|
|
@@ -6706,13 +6995,31 @@ export interface UserEmailUpdateEvent extends BaseEvent {
|
|
|
6706
6995
|
user?: User;
|
|
6707
6996
|
}
|
|
6708
6997
|
/**
|
|
6709
|
-
* Models the User Email Verify Event
|
|
6998
|
+
* Models the User Email Verify Event.
|
|
6710
6999
|
*
|
|
6711
7000
|
* @author Trevor Smith
|
|
6712
7001
|
*/
|
|
6713
7002
|
export interface UserEmailVerifiedEvent extends BaseEvent {
|
|
6714
7003
|
user?: User;
|
|
6715
7004
|
}
|
|
7005
|
+
/**
|
|
7006
|
+
* Models the User Identity Provider Link Event.
|
|
7007
|
+
*
|
|
7008
|
+
* @author Rob Davis
|
|
7009
|
+
*/
|
|
7010
|
+
export interface UserIdentityProviderLinkEvent extends BaseEvent {
|
|
7011
|
+
identityProviderLink?: IdentityProviderLink;
|
|
7012
|
+
user?: User;
|
|
7013
|
+
}
|
|
7014
|
+
/**
|
|
7015
|
+
* Models the User Identity Provider Unlink Event.
|
|
7016
|
+
*
|
|
7017
|
+
* @author Rob Davis
|
|
7018
|
+
*/
|
|
7019
|
+
export interface UserIdentityProviderUnlinkEvent extends BaseEvent {
|
|
7020
|
+
identityProviderLink?: IdentityProviderLink;
|
|
7021
|
+
user?: User;
|
|
7022
|
+
}
|
|
6716
7023
|
/**
|
|
6717
7024
|
* @author Daniel DeGroff
|
|
6718
7025
|
*/
|
|
@@ -6820,7 +7127,7 @@ export interface UserPasswordUpdateEvent extends BaseEvent {
|
|
|
6820
7127
|
user?: User;
|
|
6821
7128
|
}
|
|
6822
7129
|
/**
|
|
6823
|
-
* Models the User Reactivate Event
|
|
7130
|
+
* Models the User Reactivate Event.
|
|
6824
7131
|
*
|
|
6825
7132
|
* @author Brian Pontarelli
|
|
6826
7133
|
*/
|
|
@@ -6850,9 +7157,10 @@ export interface UserRegistration {
|
|
|
6850
7157
|
verified?: boolean;
|
|
6851
7158
|
}
|
|
6852
7159
|
/**
|
|
6853
|
-
* Models the User Created Registration Event
|
|
7160
|
+
* Models the User Created Registration Event.
|
|
6854
7161
|
* <p>
|
|
6855
|
-
* This is different than the user.registration.create event in that it will be sent after the user has been created. This event cannot be made
|
|
7162
|
+
* This is different than the user.registration.create event in that it will be sent after the user has been created. This event cannot be made
|
|
7163
|
+
* transactional.
|
|
6856
7164
|
*
|
|
6857
7165
|
* @author Daniel DeGroff
|
|
6858
7166
|
*/
|
|
@@ -6862,7 +7170,7 @@ export interface UserRegistrationCreateCompleteEvent extends BaseEvent {
|
|
|
6862
7170
|
user?: User;
|
|
6863
7171
|
}
|
|
6864
7172
|
/**
|
|
6865
|
-
* Models the User Create Registration Event
|
|
7173
|
+
* Models the User Create Registration Event.
|
|
6866
7174
|
*
|
|
6867
7175
|
* @author Daniel DeGroff
|
|
6868
7176
|
*/
|
|
@@ -6872,7 +7180,7 @@ export interface UserRegistrationCreateEvent extends BaseEvent {
|
|
|
6872
7180
|
user?: User;
|
|
6873
7181
|
}
|
|
6874
7182
|
/**
|
|
6875
|
-
* Models the User Deleted Registration Event
|
|
7183
|
+
* Models the User Deleted Registration Event.
|
|
6876
7184
|
* <p>
|
|
6877
7185
|
* This is different than user.registration.delete in that it is sent after the TX has been committed. This event cannot be transactional.
|
|
6878
7186
|
*
|
|
@@ -6884,7 +7192,7 @@ export interface UserRegistrationDeleteCompleteEvent extends BaseEvent {
|
|
|
6884
7192
|
user?: User;
|
|
6885
7193
|
}
|
|
6886
7194
|
/**
|
|
6887
|
-
* Models the User Delete Registration Event
|
|
7195
|
+
* Models the User Delete Registration Event.
|
|
6888
7196
|
*
|
|
6889
7197
|
* @author Daniel DeGroff
|
|
6890
7198
|
*/
|
|
@@ -6894,7 +7202,7 @@ export interface UserRegistrationDeleteEvent extends BaseEvent {
|
|
|
6894
7202
|
user?: User;
|
|
6895
7203
|
}
|
|
6896
7204
|
/**
|
|
6897
|
-
* Models the User Update Registration Event
|
|
7205
|
+
* Models the User Update Registration Event.
|
|
6898
7206
|
* <p>
|
|
6899
7207
|
* This is different than user.registration.update in that it is sent after this event completes, this cannot be transactional.
|
|
6900
7208
|
*
|
|
@@ -6907,7 +7215,7 @@ export interface UserRegistrationUpdateCompleteEvent extends BaseEvent {
|
|
|
6907
7215
|
user?: User;
|
|
6908
7216
|
}
|
|
6909
7217
|
/**
|
|
6910
|
-
* Models the User Update Registration Event
|
|
7218
|
+
* Models the User Update Registration Event.
|
|
6911
7219
|
*
|
|
6912
7220
|
* @author Daniel DeGroff
|
|
6913
7221
|
*/
|
|
@@ -6918,7 +7226,7 @@ export interface UserRegistrationUpdateEvent extends BaseEvent {
|
|
|
6918
7226
|
user?: User;
|
|
6919
7227
|
}
|
|
6920
7228
|
/**
|
|
6921
|
-
* Models the User Registration Verified Event
|
|
7229
|
+
* Models the User Registration Verified Event.
|
|
6922
7230
|
*
|
|
6923
7231
|
* @author Trevor Smith
|
|
6924
7232
|
*/
|
|
@@ -7002,7 +7310,7 @@ export interface UserUpdateCompleteEvent extends BaseEvent {
|
|
|
7002
7310
|
user?: User;
|
|
7003
7311
|
}
|
|
7004
7312
|
/**
|
|
7005
|
-
* Models the User Update Event
|
|
7313
|
+
* Models the User Update Event.
|
|
7006
7314
|
*
|
|
7007
7315
|
* @author Brian Pontarelli
|
|
7008
7316
|
*/
|
|
@@ -7028,6 +7336,7 @@ export declare enum VerificationStrategy {
|
|
|
7028
7336
|
*/
|
|
7029
7337
|
export interface VerifyEmailRequest extends BaseEventRequest {
|
|
7030
7338
|
oneTimeCode?: string;
|
|
7339
|
+
userId?: UUID;
|
|
7031
7340
|
verificationId?: string;
|
|
7032
7341
|
}
|
|
7033
7342
|
/**
|
|
@@ -7063,7 +7372,6 @@ export interface VersionResponse {
|
|
|
7063
7372
|
* @author Brian Pontarelli
|
|
7064
7373
|
*/
|
|
7065
7374
|
export interface Webhook {
|
|
7066
|
-
applicationIds?: Array<UUID>;
|
|
7067
7375
|
connectTimeout?: number;
|
|
7068
7376
|
data?: Record<string, any>;
|
|
7069
7377
|
description?: string;
|
|
@@ -7077,6 +7385,7 @@ export interface Webhook {
|
|
|
7077
7385
|
lastUpdateInstant?: number;
|
|
7078
7386
|
readTimeout?: number;
|
|
7079
7387
|
sslCertificate?: string;
|
|
7388
|
+
tenantIds?: Array<UUID>;
|
|
7080
7389
|
url?: string;
|
|
7081
7390
|
}
|
|
7082
7391
|
/**
|