@fusionauth/typescript-client 1.32.1 → 1.36.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 +191 -36
- package/build/src/FusionAuthClient.js +124 -30
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +125 -31
- package/dist/fusionauth-typescript-client.min.js +1 -1
- package/dist/fusionauth-typescript-client.min.js.map +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -28,7 +28,7 @@ Refer to the FusionAuth API documentation to for request and response formats.
|
|
|
28
28
|
|
|
29
29
|
If you have a question or support issue regarding this client library, we'd love to hear from you.
|
|
30
30
|
|
|
31
|
-
If you have a paid edition with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid editions here](https://fusionauth.io/pricing
|
|
31
|
+
If you have a paid edition with support included, please [open a ticket in your account portal](https://account.fusionauth.io/account/support/). Learn more about [paid editions here](https://fusionauth.io/pricing).
|
|
32
32
|
|
|
33
33
|
Otherwise, please [post your question in the community forum](https://fusionauth.io/community/forum/).
|
|
34
34
|
|
|
@@ -58,6 +58,9 @@ export declare class FusionAuthClient {
|
|
|
58
58
|
* Changes a user's password using the change password Id. This usually occurs after an email has been sent to the user
|
|
59
59
|
* and they clicked on a link to reset their password.
|
|
60
60
|
*
|
|
61
|
+
* As of version 1.32.2, prefer sending the changePasswordId in the request body. To do this, omit the first parameter, and set
|
|
62
|
+
* the value in the request body.
|
|
63
|
+
*
|
|
61
64
|
* @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.
|
|
62
65
|
* @param {ChangePasswordRequest} request The change password request that contains all of the information used to change the password.
|
|
63
66
|
* @returns {Promise<ClientResponse<ChangePasswordResponse>>}
|
|
@@ -72,6 +75,39 @@ export declare class FusionAuthClient {
|
|
|
72
75
|
* @returns {Promise<ClientResponse<void>>}
|
|
73
76
|
*/
|
|
74
77
|
changePasswordByIdentity(request: ChangePasswordRequest): Promise<ClientResponse<void>>;
|
|
78
|
+
/**
|
|
79
|
+
* Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
|
|
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.
|
|
82
|
+
*
|
|
83
|
+
* An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
|
|
84
|
+
*
|
|
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
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
87
|
+
*/
|
|
88
|
+
checkChangePasswordUsingId(changePasswordId: string): Promise<ClientResponse<void>>;
|
|
89
|
+
/**
|
|
90
|
+
* Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
|
|
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.
|
|
93
|
+
*
|
|
94
|
+
* An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
|
|
95
|
+
*
|
|
96
|
+
* @param {string} encodedJWT The encoded JWT (access token).
|
|
97
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
98
|
+
*/
|
|
99
|
+
checkChangePasswordUsingJWT(encodedJWT: string): Promise<ClientResponse<void>>;
|
|
100
|
+
/**
|
|
101
|
+
* Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
|
|
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.
|
|
104
|
+
*
|
|
105
|
+
* An HTTP status code of 412 indicates that a Trust Token is required to make a POST request to this API.
|
|
106
|
+
*
|
|
107
|
+
* @param {string} loginId The loginId of the User that you intend to change the password for.
|
|
108
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
109
|
+
*/
|
|
110
|
+
checkChangePasswordUsingLoginId(loginId: string): Promise<ClientResponse<void>>;
|
|
75
111
|
/**
|
|
76
112
|
* Adds a comment to the user's account.
|
|
77
113
|
*
|
|
@@ -1185,7 +1221,7 @@ export declare class FusionAuthClient {
|
|
|
1185
1221
|
*/
|
|
1186
1222
|
retrieveAction(actionId: UUID): Promise<ClientResponse<ActionResponse>>;
|
|
1187
1223
|
/**
|
|
1188
|
-
* Retrieves all
|
|
1224
|
+
* Retrieves all the actions for the user with the given Id. This will return all time based actions that are active,
|
|
1189
1225
|
* and inactive as well as non-time based actions.
|
|
1190
1226
|
*
|
|
1191
1227
|
* @param {UUID} userId The Id of the user to fetch the actions for.
|
|
@@ -1193,14 +1229,14 @@ export declare class FusionAuthClient {
|
|
|
1193
1229
|
*/
|
|
1194
1230
|
retrieveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
|
|
1195
1231
|
/**
|
|
1196
|
-
* Retrieves all
|
|
1232
|
+
* Retrieves all the actions for the user with the given Id that are currently preventing the User from logging in.
|
|
1197
1233
|
*
|
|
1198
1234
|
* @param {UUID} userId The Id of the user to fetch the actions for.
|
|
1199
1235
|
* @returns {Promise<ClientResponse<ActionResponse>>}
|
|
1200
1236
|
*/
|
|
1201
1237
|
retrieveActionsPreventingLogin(userId: UUID): Promise<ClientResponse<ActionResponse>>;
|
|
1202
1238
|
/**
|
|
1203
|
-
* Retrieves all
|
|
1239
|
+
* Retrieves all the actions for the user with the given Id that are currently active.
|
|
1204
1240
|
* An active action means one that is time based and has not been canceled, and has not ended.
|
|
1205
1241
|
*
|
|
1206
1242
|
* @param {UUID} userId The Id of the user to fetch the actions for.
|
|
@@ -1215,7 +1251,7 @@ export declare class FusionAuthClient {
|
|
|
1215
1251
|
*/
|
|
1216
1252
|
retrieveApplication(applicationId: UUID): Promise<ClientResponse<ApplicationResponse>>;
|
|
1217
1253
|
/**
|
|
1218
|
-
* Retrieves all
|
|
1254
|
+
* Retrieves all the applications.
|
|
1219
1255
|
*
|
|
1220
1256
|
* @returns {Promise<ClientResponse<ApplicationResponse>>}
|
|
1221
1257
|
*/
|
|
@@ -1235,7 +1271,7 @@ export declare class FusionAuthClient {
|
|
|
1235
1271
|
*/
|
|
1236
1272
|
retrieveConnector(connectorId: UUID): Promise<ClientResponse<ConnectorResponse>>;
|
|
1237
1273
|
/**
|
|
1238
|
-
* Retrieves all
|
|
1274
|
+
* Retrieves all the connectors.
|
|
1239
1275
|
*
|
|
1240
1276
|
* @returns {Promise<ClientResponse<ConnectorResponse>>}
|
|
1241
1277
|
*/
|
|
@@ -1248,7 +1284,7 @@ export declare class FusionAuthClient {
|
|
|
1248
1284
|
*/
|
|
1249
1285
|
retrieveConsent(consentId: UUID): Promise<ClientResponse<ConsentResponse>>;
|
|
1250
1286
|
/**
|
|
1251
|
-
* Retrieves all
|
|
1287
|
+
* Retrieves all the consent.
|
|
1252
1288
|
*
|
|
1253
1289
|
* @returns {Promise<ClientResponse<ConsentResponse>>}
|
|
1254
1290
|
*/
|
|
@@ -1280,7 +1316,7 @@ export declare class FusionAuthClient {
|
|
|
1280
1316
|
*/
|
|
1281
1317
|
retrieveEmailTemplatePreview(request: PreviewRequest): Promise<ClientResponse<PreviewResponse>>;
|
|
1282
1318
|
/**
|
|
1283
|
-
* Retrieves all
|
|
1319
|
+
* Retrieves all the email templates.
|
|
1284
1320
|
*
|
|
1285
1321
|
* @returns {Promise<ClientResponse<EmailTemplateResponse>>}
|
|
1286
1322
|
*/
|
|
@@ -1309,7 +1345,7 @@ export declare class FusionAuthClient {
|
|
|
1309
1345
|
*/
|
|
1310
1346
|
retrieveEntityType(entityTypeId: UUID): Promise<ClientResponse<EntityTypeResponse>>;
|
|
1311
1347
|
/**
|
|
1312
|
-
* Retrieves all
|
|
1348
|
+
* Retrieves all the Entity Types.
|
|
1313
1349
|
*
|
|
1314
1350
|
* @returns {Promise<ClientResponse<EntityTypeResponse>>}
|
|
1315
1351
|
*/
|
|
@@ -1322,14 +1358,14 @@ export declare class FusionAuthClient {
|
|
|
1322
1358
|
*/
|
|
1323
1359
|
retrieveEventLog(eventLogId: number): Promise<ClientResponse<EventLogResponse>>;
|
|
1324
1360
|
/**
|
|
1325
|
-
* Retrieves all
|
|
1361
|
+
* Retrieves all the families that a user belongs to.
|
|
1326
1362
|
*
|
|
1327
1363
|
* @param {UUID} userId The User's id
|
|
1328
1364
|
* @returns {Promise<ClientResponse<FamilyResponse>>}
|
|
1329
1365
|
*/
|
|
1330
1366
|
retrieveFamilies(userId: UUID): Promise<ClientResponse<FamilyResponse>>;
|
|
1331
1367
|
/**
|
|
1332
|
-
* Retrieves all
|
|
1368
|
+
* Retrieves all the members of a family by the unique Family Id.
|
|
1333
1369
|
*
|
|
1334
1370
|
* @param {UUID} familyId The unique Id of the Family.
|
|
1335
1371
|
* @returns {Promise<ClientResponse<FamilyResponse>>}
|
|
@@ -1350,13 +1386,13 @@ export declare class FusionAuthClient {
|
|
|
1350
1386
|
*/
|
|
1351
1387
|
retrieveFormField(fieldId: UUID): Promise<ClientResponse<FormFieldResponse>>;
|
|
1352
1388
|
/**
|
|
1353
|
-
* Retrieves all
|
|
1389
|
+
* Retrieves all the forms fields
|
|
1354
1390
|
*
|
|
1355
1391
|
* @returns {Promise<ClientResponse<FormFieldResponse>>}
|
|
1356
1392
|
*/
|
|
1357
1393
|
retrieveFormFields(): Promise<ClientResponse<FormFieldResponse>>;
|
|
1358
1394
|
/**
|
|
1359
|
-
* Retrieves all
|
|
1395
|
+
* Retrieves all the forms.
|
|
1360
1396
|
*
|
|
1361
1397
|
* @returns {Promise<ClientResponse<FormResponse>>}
|
|
1362
1398
|
*/
|
|
@@ -1369,7 +1405,7 @@ export declare class FusionAuthClient {
|
|
|
1369
1405
|
*/
|
|
1370
1406
|
retrieveGroup(groupId: UUID): Promise<ClientResponse<GroupResponse>>;
|
|
1371
1407
|
/**
|
|
1372
|
-
* Retrieves all
|
|
1408
|
+
* Retrieves all the groups.
|
|
1373
1409
|
*
|
|
1374
1410
|
* @returns {Promise<ClientResponse<GroupResponse>>}
|
|
1375
1411
|
*/
|
|
@@ -1398,13 +1434,13 @@ export declare class FusionAuthClient {
|
|
|
1398
1434
|
*/
|
|
1399
1435
|
retrieveIdentityProviderByType(type: IdentityProviderType): Promise<ClientResponse<IdentityProviderResponse>>;
|
|
1400
1436
|
/**
|
|
1401
|
-
* Retrieves all
|
|
1437
|
+
* Retrieves all the identity providers.
|
|
1402
1438
|
*
|
|
1403
1439
|
* @returns {Promise<ClientResponse<IdentityProviderResponse>>}
|
|
1404
1440
|
*/
|
|
1405
1441
|
retrieveIdentityProviders(): Promise<ClientResponse<IdentityProviderResponse>>;
|
|
1406
1442
|
/**
|
|
1407
|
-
* Retrieves all
|
|
1443
|
+
* Retrieves all the actions for the user with the given Id that are currently inactive.
|
|
1408
1444
|
* An inactive action means one that is time based and has been canceled or has expired, or is not time based.
|
|
1409
1445
|
*
|
|
1410
1446
|
* @param {UUID} userId The Id of the user to fetch the actions for.
|
|
@@ -1412,13 +1448,13 @@ export declare class FusionAuthClient {
|
|
|
1412
1448
|
*/
|
|
1413
1449
|
retrieveInactiveActions(userId: UUID): Promise<ClientResponse<ActionResponse>>;
|
|
1414
1450
|
/**
|
|
1415
|
-
* Retrieves all
|
|
1451
|
+
* Retrieves all the applications that are currently inactive.
|
|
1416
1452
|
*
|
|
1417
1453
|
* @returns {Promise<ClientResponse<ApplicationResponse>>}
|
|
1418
1454
|
*/
|
|
1419
1455
|
retrieveInactiveApplications(): Promise<ClientResponse<ApplicationResponse>>;
|
|
1420
1456
|
/**
|
|
1421
|
-
* Retrieves all
|
|
1457
|
+
* Retrieves all the user actions that are currently inactive.
|
|
1422
1458
|
*
|
|
1423
1459
|
* @returns {Promise<ClientResponse<UserActionResponse>>}
|
|
1424
1460
|
*/
|
|
@@ -1463,7 +1499,7 @@ export declare class FusionAuthClient {
|
|
|
1463
1499
|
*/
|
|
1464
1500
|
retrieveKey(keyId: UUID): Promise<ClientResponse<KeyResponse>>;
|
|
1465
1501
|
/**
|
|
1466
|
-
* Retrieves all
|
|
1502
|
+
* Retrieves all the keys.
|
|
1467
1503
|
*
|
|
1468
1504
|
* @returns {Promise<ClientResponse<KeyResponse>>}
|
|
1469
1505
|
*/
|
|
@@ -1476,13 +1512,13 @@ export declare class FusionAuthClient {
|
|
|
1476
1512
|
*/
|
|
1477
1513
|
retrieveLambda(lambdaId: UUID): Promise<ClientResponse<LambdaResponse>>;
|
|
1478
1514
|
/**
|
|
1479
|
-
* Retrieves all
|
|
1515
|
+
* Retrieves all the lambdas.
|
|
1480
1516
|
*
|
|
1481
1517
|
* @returns {Promise<ClientResponse<LambdaResponse>>}
|
|
1482
1518
|
*/
|
|
1483
1519
|
retrieveLambdas(): Promise<ClientResponse<LambdaResponse>>;
|
|
1484
1520
|
/**
|
|
1485
|
-
* Retrieves all
|
|
1521
|
+
* Retrieves all the lambdas for the provided type.
|
|
1486
1522
|
*
|
|
1487
1523
|
* @param {LambdaType} type The type of the lambda to return.
|
|
1488
1524
|
* @returns {Promise<ClientResponse<LambdaResponse>>}
|
|
@@ -1513,7 +1549,7 @@ export declare class FusionAuthClient {
|
|
|
1513
1549
|
*/
|
|
1514
1550
|
retrieveMessageTemplatePreview(request: PreviewMessageTemplateRequest): Promise<ClientResponse<PreviewMessageTemplateResponse>>;
|
|
1515
1551
|
/**
|
|
1516
|
-
* Retrieves all
|
|
1552
|
+
* Retrieves all the message templates.
|
|
1517
1553
|
*
|
|
1518
1554
|
* @returns {Promise<ClientResponse<MessageTemplateResponse>>}
|
|
1519
1555
|
*/
|
|
@@ -1526,7 +1562,7 @@ export declare class FusionAuthClient {
|
|
|
1526
1562
|
*/
|
|
1527
1563
|
retrieveMessenger(messengerId: UUID): Promise<ClientResponse<MessengerResponse>>;
|
|
1528
1564
|
/**
|
|
1529
|
-
* Retrieves all
|
|
1565
|
+
* Retrieves all the messengers.
|
|
1530
1566
|
*
|
|
1531
1567
|
* @returns {Promise<ClientResponse<MessengerResponse>>}
|
|
1532
1568
|
*/
|
|
@@ -1573,7 +1609,7 @@ export declare class FusionAuthClient {
|
|
|
1573
1609
|
*/
|
|
1574
1610
|
retrievePasswordValidationRulesWithTenantId(tenantId: UUID): Promise<ClientResponse<PasswordValidationRulesResponse>>;
|
|
1575
1611
|
/**
|
|
1576
|
-
* Retrieves all
|
|
1612
|
+
* Retrieves all the children for the given parent email address.
|
|
1577
1613
|
*
|
|
1578
1614
|
* @param {string} parentEmail The email of the parent.
|
|
1579
1615
|
* @returns {Promise<ClientResponse<PendingResponse>>}
|
|
@@ -1652,7 +1688,7 @@ export declare class FusionAuthClient {
|
|
|
1652
1688
|
*/
|
|
1653
1689
|
retrieveTenant(tenantId: UUID): Promise<ClientResponse<TenantResponse>>;
|
|
1654
1690
|
/**
|
|
1655
|
-
* Retrieves all
|
|
1691
|
+
* Retrieves all the tenants.
|
|
1656
1692
|
*
|
|
1657
1693
|
* @returns {Promise<ClientResponse<TenantResponse>>}
|
|
1658
1694
|
*/
|
|
@@ -1665,7 +1701,7 @@ export declare class FusionAuthClient {
|
|
|
1665
1701
|
*/
|
|
1666
1702
|
retrieveTheme(themeId: UUID): Promise<ClientResponse<ThemeResponse>>;
|
|
1667
1703
|
/**
|
|
1668
|
-
* Retrieves all
|
|
1704
|
+
* Retrieves all the themes.
|
|
1669
1705
|
*
|
|
1670
1706
|
* @returns {Promise<ClientResponse<ThemeResponse>>}
|
|
1671
1707
|
*/
|
|
@@ -1714,7 +1750,7 @@ export declare class FusionAuthClient {
|
|
|
1714
1750
|
*/
|
|
1715
1751
|
retrieveUserActionReasons(): Promise<ClientResponse<UserActionReasonResponse>>;
|
|
1716
1752
|
/**
|
|
1717
|
-
* Retrieves all
|
|
1753
|
+
* Retrieves all the user actions.
|
|
1718
1754
|
*
|
|
1719
1755
|
* @returns {Promise<ClientResponse<UserActionResponse>>}
|
|
1720
1756
|
*/
|
|
@@ -1757,7 +1793,7 @@ export declare class FusionAuthClient {
|
|
|
1757
1793
|
*/
|
|
1758
1794
|
retrieveUserByVerificationId(verificationId: string): Promise<ClientResponse<UserResponse>>;
|
|
1759
1795
|
/**
|
|
1760
|
-
* Retrieves all
|
|
1796
|
+
* Retrieves all the comments for the user with the given Id.
|
|
1761
1797
|
*
|
|
1762
1798
|
* @param {UUID} userId The Id of the user.
|
|
1763
1799
|
* @returns {Promise<ClientResponse<UserCommentResponse>>}
|
|
@@ -1771,7 +1807,7 @@ export declare class FusionAuthClient {
|
|
|
1771
1807
|
*/
|
|
1772
1808
|
retrieveUserConsent(userConsentId: UUID): Promise<ClientResponse<UserConsentResponse>>;
|
|
1773
1809
|
/**
|
|
1774
|
-
* Retrieves all
|
|
1810
|
+
* Retrieves all the consents for a User.
|
|
1775
1811
|
*
|
|
1776
1812
|
* @param {UUID} userId The User's Id
|
|
1777
1813
|
* @returns {Promise<ClientResponse<UserConsentResponse>>}
|
|
@@ -1983,6 +2019,13 @@ export declare class FusionAuthClient {
|
|
|
1983
2019
|
* @returns {Promise<ClientResponse<EventLogSearchResponse>>}
|
|
1984
2020
|
*/
|
|
1985
2021
|
searchEventLogs(request: EventLogSearchRequest): Promise<ClientResponse<EventLogSearchResponse>>;
|
|
2022
|
+
/**
|
|
2023
|
+
* Searches group members with the specified criteria and pagination.
|
|
2024
|
+
*
|
|
2025
|
+
* @param {GroupMemberSearchRequest} request The search criteria and pagination information.
|
|
2026
|
+
* @returns {Promise<ClientResponse<GroupMemberSearchResponse>>}
|
|
2027
|
+
*/
|
|
2028
|
+
searchGroupMembers(request: GroupMemberSearchRequest): Promise<ClientResponse<GroupMemberSearchResponse>>;
|
|
1986
2029
|
/**
|
|
1987
2030
|
* Searches the IP Access Control Lists with the specified criteria and pagination.
|
|
1988
2031
|
*
|
|
@@ -2220,6 +2263,13 @@ export declare class FusionAuthClient {
|
|
|
2220
2263
|
* @returns {Promise<ClientResponse<GroupResponse>>}
|
|
2221
2264
|
*/
|
|
2222
2265
|
updateGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
|
|
2266
|
+
/**
|
|
2267
|
+
* Creates a member in a group.
|
|
2268
|
+
*
|
|
2269
|
+
* @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
|
|
2270
|
+
* @returns {Promise<ClientResponse<MemberResponse>>}
|
|
2271
|
+
*/
|
|
2272
|
+
updateGroupMembers(request: MemberRequest): Promise<ClientResponse<MemberResponse>>;
|
|
2223
2273
|
/**
|
|
2224
2274
|
* Updates the IP Access Control List with the given Id.
|
|
2225
2275
|
*
|
|
@@ -2962,10 +3012,13 @@ export declare enum ChangePasswordReason {
|
|
|
2962
3012
|
*/
|
|
2963
3013
|
export interface ChangePasswordRequest extends BaseEventRequest {
|
|
2964
3014
|
applicationId?: UUID;
|
|
3015
|
+
changePasswordId?: string;
|
|
2965
3016
|
currentPassword?: string;
|
|
2966
3017
|
loginId?: string;
|
|
2967
3018
|
password?: string;
|
|
2968
3019
|
refreshToken?: string;
|
|
3020
|
+
trustChallenge?: string;
|
|
3021
|
+
trustToken?: string;
|
|
2969
3022
|
}
|
|
2970
3023
|
/**
|
|
2971
3024
|
* Change password response object.
|
|
@@ -3482,7 +3535,7 @@ export interface EntityTypeSearchRequest {
|
|
|
3482
3535
|
search?: EntityTypeSearchCriteria;
|
|
3483
3536
|
}
|
|
3484
3537
|
/**
|
|
3485
|
-
* Search
|
|
3538
|
+
* Search response for entity types.
|
|
3486
3539
|
*
|
|
3487
3540
|
* @author Brian Pontarelli
|
|
3488
3541
|
*/
|
|
@@ -3646,10 +3699,12 @@ export declare enum EventType {
|
|
|
3646
3699
|
UserDeactivate = "user.deactivate",
|
|
3647
3700
|
UserDelete = "user.delete",
|
|
3648
3701
|
UserDeleteComplete = "user.delete.complete",
|
|
3649
|
-
UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
|
|
3650
|
-
UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
|
|
3651
3702
|
UserEmailUpdate = "user.email.update",
|
|
3652
3703
|
UserEmailVerified = "user.email.verified",
|
|
3704
|
+
UserIdentityProviderLink = "user.identity-provider.link",
|
|
3705
|
+
UserIdentityProviderUnlink = "user.identity-provider.unlink",
|
|
3706
|
+
UserLoginIdDuplicateOnCreate = "user.loginId.duplicate.create",
|
|
3707
|
+
UserLoginIdDuplicateOnUpdate = "user.loginId.duplicate.update",
|
|
3653
3708
|
UserLoginFailed = "user.login.failed",
|
|
3654
3709
|
UserLoginNewDevice = "user.login.new-device",
|
|
3655
3710
|
UserLoginSuccess = "user.login.success",
|
|
@@ -3707,6 +3762,7 @@ export interface ExternalIdentifierConfiguration {
|
|
|
3707
3762
|
samlv2AuthNRequestIdTimeToLiveInSeconds?: number;
|
|
3708
3763
|
setupPasswordIdGenerator?: SecureGeneratorConfiguration;
|
|
3709
3764
|
setupPasswordIdTimeToLiveInSeconds?: number;
|
|
3765
|
+
trustTokenTimeToLiveInSeconds?: number;
|
|
3710
3766
|
twoFactorIdTimeToLiveInSeconds?: number;
|
|
3711
3767
|
twoFactorOneTimeCodeIdGenerator?: SecureGeneratorConfiguration;
|
|
3712
3768
|
twoFactorOneTimeCodeIdTimeToLiveInSeconds?: number;
|
|
@@ -4068,8 +4124,35 @@ export interface GroupMember {
|
|
|
4068
4124
|
groupId?: UUID;
|
|
4069
4125
|
id?: UUID;
|
|
4070
4126
|
insertInstant?: number;
|
|
4127
|
+
user?: User;
|
|
4128
|
+
userId?: UUID;
|
|
4129
|
+
}
|
|
4130
|
+
/**
|
|
4131
|
+
* Search criteria for Group Members
|
|
4132
|
+
*
|
|
4133
|
+
* @author Daniel DeGroff
|
|
4134
|
+
*/
|
|
4135
|
+
export interface GroupMemberSearchCriteria extends BaseSearchCriteria {
|
|
4136
|
+
groupId?: UUID;
|
|
4071
4137
|
userId?: UUID;
|
|
4072
4138
|
}
|
|
4139
|
+
/**
|
|
4140
|
+
* Search request for Group Members.
|
|
4141
|
+
*
|
|
4142
|
+
* @author Daniel DeGroff
|
|
4143
|
+
*/
|
|
4144
|
+
export interface GroupMemberSearchRequest {
|
|
4145
|
+
search?: GroupMemberSearchCriteria;
|
|
4146
|
+
}
|
|
4147
|
+
/**
|
|
4148
|
+
* Search response for Group Members
|
|
4149
|
+
*
|
|
4150
|
+
* @author Daniel DeGroff
|
|
4151
|
+
*/
|
|
4152
|
+
export interface GroupMemberSearchResponse {
|
|
4153
|
+
members?: Array<GroupMember>;
|
|
4154
|
+
total?: number;
|
|
4155
|
+
}
|
|
4073
4156
|
/**
|
|
4074
4157
|
* Group API request object.
|
|
4075
4158
|
*
|
|
@@ -4172,7 +4255,7 @@ export declare enum IdentityProviderLinkingStrategy {
|
|
|
4172
4255
|
/**
|
|
4173
4256
|
* @author Daniel DeGroff
|
|
4174
4257
|
*/
|
|
4175
|
-
export interface IdentityProviderLinkRequest {
|
|
4258
|
+
export interface IdentityProviderLinkRequest extends BaseEventRequest {
|
|
4176
4259
|
displayName?: string;
|
|
4177
4260
|
identityProviderId?: UUID;
|
|
4178
4261
|
identityProviderUserId?: string;
|
|
@@ -4610,9 +4693,15 @@ export declare enum KeyUse {
|
|
|
4610
4693
|
export interface KickstartSuccessEvent extends BaseEvent {
|
|
4611
4694
|
instanceId?: UUID;
|
|
4612
4695
|
}
|
|
4613
|
-
|
|
4696
|
+
/**
|
|
4697
|
+
* A JavaScript lambda function that is executed during certain events inside FusionAuth.
|
|
4698
|
+
*
|
|
4699
|
+
* @author Brian Pontarelli
|
|
4700
|
+
*/
|
|
4701
|
+
export interface Lambda {
|
|
4614
4702
|
body?: string;
|
|
4615
4703
|
debug?: boolean;
|
|
4704
|
+
engineType?: LambdaEngineType;
|
|
4616
4705
|
id?: UUID;
|
|
4617
4706
|
insertInstant?: number;
|
|
4618
4707
|
lastUpdateInstant?: number;
|
|
@@ -4630,6 +4719,13 @@ export interface LambdaConfiguration {
|
|
|
4630
4719
|
export interface LambdaConfiguration {
|
|
4631
4720
|
reconcileId?: UUID;
|
|
4632
4721
|
}
|
|
4722
|
+
/**
|
|
4723
|
+
* @author Daniel DeGroff
|
|
4724
|
+
*/
|
|
4725
|
+
export declare enum LambdaEngineType {
|
|
4726
|
+
GraalJS = "GraalJS",
|
|
4727
|
+
Nashorn = "Nashorn"
|
|
4728
|
+
}
|
|
4633
4729
|
/**
|
|
4634
4730
|
* Lambda API request object.
|
|
4635
4731
|
*
|
|
@@ -4671,7 +4767,11 @@ export declare enum LambdaType {
|
|
|
4671
4767
|
SteamReconcile = "SteamReconcile",
|
|
4672
4768
|
TwitchReconcile = "TwitchReconcile",
|
|
4673
4769
|
XboxReconcile = "XboxReconcile",
|
|
4674
|
-
ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate"
|
|
4770
|
+
ClientCredentialsJWTPopulate = "ClientCredentialsJWTPopulate",
|
|
4771
|
+
SCIMServerGroupRequestConverter = "SCIMServerGroupRequestConverter",
|
|
4772
|
+
SCIMServerGroupResponseConverter = "SCIMServerGroupResponseConverter",
|
|
4773
|
+
SCIMServerUserRequestConverter = "SCIMServerUserRequestConverter",
|
|
4774
|
+
SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter"
|
|
4675
4775
|
}
|
|
4676
4776
|
/**
|
|
4677
4777
|
* Models an LDAP connector.
|
|
@@ -4845,6 +4945,8 @@ export interface LoginResponse {
|
|
|
4845
4945
|
state?: Record<string, any>;
|
|
4846
4946
|
threatsDetected?: Array<AuthenticationThreats>;
|
|
4847
4947
|
token?: string;
|
|
4948
|
+
tokenExpirationInstant?: number;
|
|
4949
|
+
trustToken?: string;
|
|
4848
4950
|
twoFactorId?: string;
|
|
4849
4951
|
twoFactorTrustId?: string;
|
|
4850
4952
|
user?: User;
|
|
@@ -4874,8 +4976,8 @@ export interface LookupResponse {
|
|
|
4874
4976
|
/**
|
|
4875
4977
|
* This class contains the managed fields that are also put into the database during FusionAuth setup.
|
|
4876
4978
|
* <p>
|
|
4877
|
-
*
|
|
4878
|
-
*
|
|
4979
|
+
* Internal Note: These fields are also declared in SQL in order to bootstrap the system. These need to stay in sync.
|
|
4980
|
+
* Any changes to these fields needs to also be reflected in mysql.sql and postgresql.sql
|
|
4879
4981
|
*
|
|
4880
4982
|
* @author Brian Pontarelli
|
|
4881
4983
|
*/
|
|
@@ -5021,7 +5123,10 @@ export interface NintendoApplicationConfiguration extends BaseIdentityProviderAp
|
|
|
5021
5123
|
buttonText?: string;
|
|
5022
5124
|
client_id?: string;
|
|
5023
5125
|
client_secret?: string;
|
|
5126
|
+
emailClaim?: string;
|
|
5024
5127
|
scope?: string;
|
|
5128
|
+
uniqueIdClaim?: string;
|
|
5129
|
+
usernameClaim?: string;
|
|
5025
5130
|
}
|
|
5026
5131
|
/**
|
|
5027
5132
|
* Nintendo gaming login provider.
|
|
@@ -5032,7 +5137,10 @@ export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoA
|
|
|
5032
5137
|
buttonText?: string;
|
|
5033
5138
|
client_id?: string;
|
|
5034
5139
|
client_secret?: string;
|
|
5140
|
+
emailClaim?: string;
|
|
5035
5141
|
scope?: string;
|
|
5142
|
+
uniqueIdClaim?: string;
|
|
5143
|
+
usernameClaim?: string;
|
|
5036
5144
|
}
|
|
5037
5145
|
/**
|
|
5038
5146
|
* A marker interface indicating this event cannot be made transactional.
|
|
@@ -5078,6 +5186,7 @@ export interface OAuthError {
|
|
|
5078
5186
|
error_reason?: OAuthErrorReason;
|
|
5079
5187
|
error_uri?: string;
|
|
5080
5188
|
two_factor_id?: string;
|
|
5189
|
+
two_factor_methods?: Array<TwoFactorMethod>;
|
|
5081
5190
|
}
|
|
5082
5191
|
export declare enum OAuthErrorReason {
|
|
5083
5192
|
auth_code_not_found = "auth_code_not_found",
|
|
@@ -5420,13 +5529,16 @@ export interface ReactorResponse {
|
|
|
5420
5529
|
*/
|
|
5421
5530
|
export interface ReactorStatus {
|
|
5422
5531
|
advancedIdentityProviders?: ReactorFeatureStatus;
|
|
5532
|
+
advancedLambdas?: ReactorFeatureStatus;
|
|
5423
5533
|
advancedMultiFactorAuthentication?: ReactorFeatureStatus;
|
|
5424
5534
|
advancedRegistration?: ReactorFeatureStatus;
|
|
5425
5535
|
applicationThemes?: ReactorFeatureStatus;
|
|
5426
5536
|
breachedPasswordDetection?: ReactorFeatureStatus;
|
|
5427
5537
|
connectors?: ReactorFeatureStatus;
|
|
5428
5538
|
entityManagement?: ReactorFeatureStatus;
|
|
5539
|
+
expiration?: string;
|
|
5429
5540
|
licensed?: boolean;
|
|
5541
|
+
scimServer?: ReactorFeatureStatus;
|
|
5430
5542
|
threatDetection?: ReactorFeatureStatus;
|
|
5431
5543
|
}
|
|
5432
5544
|
/**
|
|
@@ -5566,6 +5678,7 @@ export interface RegistrationResponse {
|
|
|
5566
5678
|
registration?: UserRegistration;
|
|
5567
5679
|
registrationVerificationId?: string;
|
|
5568
5680
|
token?: string;
|
|
5681
|
+
tokenExpirationInstant?: number;
|
|
5569
5682
|
user?: User;
|
|
5570
5683
|
}
|
|
5571
5684
|
export declare enum RegistrationType {
|
|
@@ -5954,6 +6067,7 @@ export interface Tenant {
|
|
|
5954
6067
|
insertInstant?: number;
|
|
5955
6068
|
issuer?: string;
|
|
5956
6069
|
jwtConfiguration?: JWTConfiguration;
|
|
6070
|
+
lambdaConfiguration?: TenantLambdaConfiguration;
|
|
5957
6071
|
lastUpdateInstant?: number;
|
|
5958
6072
|
loginConfiguration?: TenantLoginConfiguration;
|
|
5959
6073
|
logoutURL?: string;
|
|
@@ -5966,6 +6080,7 @@ export interface Tenant {
|
|
|
5966
6080
|
passwordValidationRules?: PasswordValidationRules;
|
|
5967
6081
|
rateLimitConfiguration?: TenantRateLimitConfiguration;
|
|
5968
6082
|
registrationConfiguration?: TenantRegistrationConfiguration;
|
|
6083
|
+
scimServerConfiguration?: TenantSCIMServerConfiguration;
|
|
5969
6084
|
ssoConfiguration?: TenantSSOConfiguration;
|
|
5970
6085
|
state?: ObjectState;
|
|
5971
6086
|
themeId?: UUID;
|
|
@@ -6006,6 +6121,17 @@ export interface TenantDeleteRequest extends BaseEventRequest {
|
|
|
6006
6121
|
export interface TenantFormConfiguration {
|
|
6007
6122
|
adminUserFormId?: UUID;
|
|
6008
6123
|
}
|
|
6124
|
+
/**
|
|
6125
|
+
* @author Rob Davis
|
|
6126
|
+
*/
|
|
6127
|
+
export interface TenantLambdaConfiguration {
|
|
6128
|
+
scimEnterpriseUserRequestConverterId?: UUID;
|
|
6129
|
+
scimEnterpriseUserResponseConverterId?: UUID;
|
|
6130
|
+
scimGroupRequestConverterId?: UUID;
|
|
6131
|
+
scimGroupResponseConverterId?: UUID;
|
|
6132
|
+
scimUserRequestConverterId?: UUID;
|
|
6133
|
+
scimUserResponseConverterId?: UUID;
|
|
6134
|
+
}
|
|
6009
6135
|
/**
|
|
6010
6136
|
* @author Daniel DeGroff
|
|
6011
6137
|
*/
|
|
@@ -6054,6 +6180,14 @@ export interface TenantResponse {
|
|
|
6054
6180
|
tenant?: Tenant;
|
|
6055
6181
|
tenants?: Array<Tenant>;
|
|
6056
6182
|
}
|
|
6183
|
+
/**
|
|
6184
|
+
* @author Rob Davis
|
|
6185
|
+
*/
|
|
6186
|
+
export interface TenantSCIMServerConfiguration extends Enableable {
|
|
6187
|
+
clientEntityTypeId?: UUID;
|
|
6188
|
+
schemas?: Record<string, any>;
|
|
6189
|
+
serverEntityTypeId?: UUID;
|
|
6190
|
+
}
|
|
6057
6191
|
/**
|
|
6058
6192
|
* @author Brett Pontarelli
|
|
6059
6193
|
*/
|
|
@@ -6303,6 +6437,8 @@ export interface TwoFactorStartRequest {
|
|
|
6303
6437
|
code?: string;
|
|
6304
6438
|
loginId?: string;
|
|
6305
6439
|
state?: Record<string, any>;
|
|
6440
|
+
trustChallenge?: string;
|
|
6441
|
+
userId?: UUID;
|
|
6306
6442
|
}
|
|
6307
6443
|
/**
|
|
6308
6444
|
* @author Daniel DeGroff
|
|
@@ -6668,6 +6804,24 @@ export interface UserEmailUpdateEvent extends BaseEvent {
|
|
|
6668
6804
|
export interface UserEmailVerifiedEvent extends BaseEvent {
|
|
6669
6805
|
user?: User;
|
|
6670
6806
|
}
|
|
6807
|
+
/**
|
|
6808
|
+
* Models the User Identity Provider Link Event.
|
|
6809
|
+
*
|
|
6810
|
+
* @author Rob Davis
|
|
6811
|
+
*/
|
|
6812
|
+
export interface UserIdentityProviderLinkEvent extends BaseEvent {
|
|
6813
|
+
identityProviderLink?: IdentityProviderLink;
|
|
6814
|
+
user?: User;
|
|
6815
|
+
}
|
|
6816
|
+
/**
|
|
6817
|
+
* Models the User Identity Provider Unlink Event.
|
|
6818
|
+
*
|
|
6819
|
+
* @author Rob Davis
|
|
6820
|
+
*/
|
|
6821
|
+
export interface UserIdentityProviderUnlinkEvent extends BaseEvent {
|
|
6822
|
+
identityProviderLink?: IdentityProviderLink;
|
|
6823
|
+
user?: User;
|
|
6824
|
+
}
|
|
6671
6825
|
/**
|
|
6672
6826
|
* @author Daniel DeGroff
|
|
6673
6827
|
*/
|
|
@@ -6903,6 +7057,7 @@ export interface UserResponse {
|
|
|
6903
7057
|
emailVerificationId?: string;
|
|
6904
7058
|
registrationVerificationIds?: Record<UUID, string>;
|
|
6905
7059
|
token?: string;
|
|
7060
|
+
tokenExpirationInstant?: number;
|
|
6906
7061
|
user?: User;
|
|
6907
7062
|
}
|
|
6908
7063
|
/**
|