@fusionauth/typescript-client 1.31.0 → 1.34.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/build/src/FusionAuthClient.d.ts +111 -39
- package/build/src/FusionAuthClient.js +91 -37
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +92 -38
- package/dist/fusionauth-typescript-client.min.js +1 -1
- package/dist/fusionauth-typescript-client.min.js.map +1 -1
- package/package.json +3 -3
|
@@ -42,7 +42,7 @@ export declare class FusionAuthClient {
|
|
|
42
42
|
* Adds a user to an existing family. The family id must be specified.
|
|
43
43
|
*
|
|
44
44
|
* @param {UUID} familyId The id of the family.
|
|
45
|
-
* @param {FamilyRequest} request The request object that contains all
|
|
45
|
+
* @param {FamilyRequest} request The request object that contains all the information used to determine which user to add to the family.
|
|
46
46
|
* @returns {Promise<ClientResponse<FamilyResponse>>}
|
|
47
47
|
*/
|
|
48
48
|
addUserToFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
|
|
@@ -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,10 +75,43 @@ 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
|
*
|
|
78
|
-
* @param {UserCommentRequest} request The request object that contains all
|
|
114
|
+
* @param {UserCommentRequest} request The request object that contains all the information used to create the user comment.
|
|
79
115
|
* @returns {Promise<ClientResponse<void>>}
|
|
80
116
|
*/
|
|
81
117
|
commentOnUser(request: UserCommentRequest): Promise<ClientResponse<void>>;
|
|
@@ -95,7 +131,7 @@ export declare class FusionAuthClient {
|
|
|
95
131
|
* Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
|
|
96
132
|
*
|
|
97
133
|
* @param {UUID} applicationId (Optional) The Id to use for the application. If not provided a secure random UUID will be generated.
|
|
98
|
-
* @param {ApplicationRequest} request The request object that contains all
|
|
134
|
+
* @param {ApplicationRequest} request The request object that contains all the information used to create the application.
|
|
99
135
|
* @returns {Promise<ClientResponse<ApplicationResponse>>}
|
|
100
136
|
*/
|
|
101
137
|
createApplication(applicationId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
|
|
@@ -105,7 +141,7 @@ export declare class FusionAuthClient {
|
|
|
105
141
|
*
|
|
106
142
|
* @param {UUID} applicationId The Id of the application to create the role on.
|
|
107
143
|
* @param {UUID} roleId (Optional) The Id of the role. If not provided a secure random UUID will be generated.
|
|
108
|
-
* @param {ApplicationRequest} request The request object that contains all
|
|
144
|
+
* @param {ApplicationRequest} request The request object that contains all the information used to create the application role.
|
|
109
145
|
* @returns {Promise<ClientResponse<ApplicationResponse>>}
|
|
110
146
|
*/
|
|
111
147
|
createApplicationRole(applicationId: UUID, roleId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
|
|
@@ -114,7 +150,7 @@ export declare class FusionAuthClient {
|
|
|
114
150
|
* make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically
|
|
115
151
|
* written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.
|
|
116
152
|
*
|
|
117
|
-
* @param {AuditLogRequest} request The request object that contains all
|
|
153
|
+
* @param {AuditLogRequest} request The request object that contains all the information used to create the audit log entry.
|
|
118
154
|
* @returns {Promise<ClientResponse<AuditLogResponse>>}
|
|
119
155
|
*/
|
|
120
156
|
createAuditLog(request: AuditLogRequest): Promise<ClientResponse<AuditLogResponse>>;
|
|
@@ -122,7 +158,7 @@ export declare class FusionAuthClient {
|
|
|
122
158
|
* Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
|
|
123
159
|
*
|
|
124
160
|
* @param {UUID} connectorId (Optional) The Id for the connector. If not provided a secure random UUID will be generated.
|
|
125
|
-
* @param {ConnectorRequest} request The request object that contains all
|
|
161
|
+
* @param {ConnectorRequest} request The request object that contains all the information used to create the connector.
|
|
126
162
|
* @returns {Promise<ClientResponse<ConnectorResponse>>}
|
|
127
163
|
*/
|
|
128
164
|
createConnector(connectorId: UUID, request: ConnectorRequest): Promise<ClientResponse<ConnectorResponse>>;
|
|
@@ -130,7 +166,7 @@ export declare class FusionAuthClient {
|
|
|
130
166
|
* Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
|
|
131
167
|
*
|
|
132
168
|
* @param {UUID} consentId (Optional) The Id for the consent. If not provided a secure random UUID will be generated.
|
|
133
|
-
* @param {ConsentRequest} request The request object that contains all
|
|
169
|
+
* @param {ConsentRequest} request The request object that contains all the information used to create the consent.
|
|
134
170
|
* @returns {Promise<ClientResponse<ConsentResponse>>}
|
|
135
171
|
*/
|
|
136
172
|
createConsent(consentId: UUID, request: ConsentRequest): Promise<ClientResponse<ConsentResponse>>;
|
|
@@ -138,7 +174,7 @@ export declare class FusionAuthClient {
|
|
|
138
174
|
* Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
|
|
139
175
|
*
|
|
140
176
|
* @param {UUID} emailTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
|
|
141
|
-
* @param {EmailTemplateRequest} request The request object that contains all
|
|
177
|
+
* @param {EmailTemplateRequest} request The request object that contains all the information used to create the email template.
|
|
142
178
|
* @returns {Promise<ClientResponse<EmailTemplateResponse>>}
|
|
143
179
|
*/
|
|
144
180
|
createEmailTemplate(emailTemplateId: UUID, request: EmailTemplateRequest): Promise<ClientResponse<EmailTemplateResponse>>;
|
|
@@ -146,7 +182,7 @@ export declare class FusionAuthClient {
|
|
|
146
182
|
* Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
|
|
147
183
|
*
|
|
148
184
|
* @param {UUID} entityId (Optional) The Id for the Entity. If not provided a secure random UUID will be generated.
|
|
149
|
-
* @param {EntityRequest} request The request object that contains all
|
|
185
|
+
* @param {EntityRequest} request The request object that contains all the information used to create the Entity.
|
|
150
186
|
* @returns {Promise<ClientResponse<EntityResponse>>}
|
|
151
187
|
*/
|
|
152
188
|
createEntity(entityId: UUID, request: EntityRequest): Promise<ClientResponse<EntityResponse>>;
|
|
@@ -154,7 +190,7 @@ export declare class FusionAuthClient {
|
|
|
154
190
|
* Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
|
|
155
191
|
*
|
|
156
192
|
* @param {UUID} entityTypeId (Optional) The Id for the Entity Type. If not provided a secure random UUID will be generated.
|
|
157
|
-
* @param {EntityTypeRequest} request The request object that contains all
|
|
193
|
+
* @param {EntityTypeRequest} request The request object that contains all the information used to create the Entity Type.
|
|
158
194
|
* @returns {Promise<ClientResponse<EntityTypeResponse>>}
|
|
159
195
|
*/
|
|
160
196
|
createEntityType(entityTypeId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
|
|
@@ -164,7 +200,7 @@ export declare class FusionAuthClient {
|
|
|
164
200
|
*
|
|
165
201
|
* @param {UUID} entityTypeId The Id of the entity type to create the permission on.
|
|
166
202
|
* @param {UUID} permissionId (Optional) The Id of the permission. If not provided a secure random UUID will be generated.
|
|
167
|
-
* @param {EntityTypeRequest} request The request object that contains all
|
|
203
|
+
* @param {EntityTypeRequest} request The request object that contains all the information used to create the permission.
|
|
168
204
|
* @returns {Promise<ClientResponse<EntityTypeResponse>>}
|
|
169
205
|
*/
|
|
170
206
|
createEntityTypePermission(entityTypeId: UUID, permissionId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
|
|
@@ -173,7 +209,7 @@ export declare class FusionAuthClient {
|
|
|
173
209
|
* family, if not provided one will be generated.
|
|
174
210
|
*
|
|
175
211
|
* @param {UUID} familyId (Optional) The id for the family. If not provided a secure random UUID will be generated.
|
|
176
|
-
* @param {FamilyRequest} request The request object that contains all
|
|
212
|
+
* @param {FamilyRequest} request The request object that contains all the information used to create the family.
|
|
177
213
|
* @returns {Promise<ClientResponse<FamilyResponse>>}
|
|
178
214
|
*/
|
|
179
215
|
createFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
|
|
@@ -181,7 +217,7 @@ export declare class FusionAuthClient {
|
|
|
181
217
|
* Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
|
|
182
218
|
*
|
|
183
219
|
* @param {UUID} formId (Optional) The Id for the form. If not provided a secure random UUID will be generated.
|
|
184
|
-
* @param {FormRequest} request The request object that contains all
|
|
220
|
+
* @param {FormRequest} request The request object that contains all the information used to create the form.
|
|
185
221
|
* @returns {Promise<ClientResponse<FormResponse>>}
|
|
186
222
|
*/
|
|
187
223
|
createForm(formId: UUID, request: FormRequest): Promise<ClientResponse<FormResponse>>;
|
|
@@ -189,7 +225,7 @@ export declare class FusionAuthClient {
|
|
|
189
225
|
* Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
|
|
190
226
|
*
|
|
191
227
|
* @param {UUID} fieldId (Optional) The Id for the form field. If not provided a secure random UUID will be generated.
|
|
192
|
-
* @param {FormFieldRequest} request The request object that contains all
|
|
228
|
+
* @param {FormFieldRequest} request The request object that contains all the information used to create the form field.
|
|
193
229
|
* @returns {Promise<ClientResponse<FormFieldResponse>>}
|
|
194
230
|
*/
|
|
195
231
|
createFormField(fieldId: UUID, request: FormFieldRequest): Promise<ClientResponse<FormFieldResponse>>;
|
|
@@ -197,14 +233,14 @@ export declare class FusionAuthClient {
|
|
|
197
233
|
* Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
|
|
198
234
|
*
|
|
199
235
|
* @param {UUID} groupId (Optional) The Id for the group. If not provided a secure random UUID will be generated.
|
|
200
|
-
* @param {GroupRequest} request The request object that contains all
|
|
236
|
+
* @param {GroupRequest} request The request object that contains all the information used to create the group.
|
|
201
237
|
* @returns {Promise<ClientResponse<GroupResponse>>}
|
|
202
238
|
*/
|
|
203
239
|
createGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
|
|
204
240
|
/**
|
|
205
241
|
* Creates a member in a group.
|
|
206
242
|
*
|
|
207
|
-
* @param {MemberRequest} request The request object that contains all
|
|
243
|
+
* @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
|
|
208
244
|
* @returns {Promise<ClientResponse<MemberResponse>>}
|
|
209
245
|
*/
|
|
210
246
|
createGroupMembers(request: MemberRequest): Promise<ClientResponse<MemberResponse>>;
|
|
@@ -212,7 +248,7 @@ export declare class FusionAuthClient {
|
|
|
212
248
|
* Creates an IP Access Control List. You can optionally specify an Id on this create request, if one is not provided one will be generated.
|
|
213
249
|
*
|
|
214
250
|
* @param {UUID} accessControlListId (Optional) The Id for the IP Access Control List. If not provided a secure random UUID will be generated.
|
|
215
|
-
* @param {IPAccessControlListRequest} request The request object that contains all
|
|
251
|
+
* @param {IPAccessControlListRequest} request The request object that contains all the information used to create the IP Access Control List.
|
|
216
252
|
* @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
|
|
217
253
|
*/
|
|
218
254
|
createIPAccessControlList(accessControlListId: UUID, request: IPAccessControlListRequest): Promise<ClientResponse<IPAccessControlListResponse>>;
|
|
@@ -220,7 +256,7 @@ export declare class FusionAuthClient {
|
|
|
220
256
|
* Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
|
|
221
257
|
*
|
|
222
258
|
* @param {UUID} identityProviderId (Optional) The Id of the identity provider. If not provided a secure random UUID will be generated.
|
|
223
|
-
* @param {IdentityProviderRequest} request The request object that contains all
|
|
259
|
+
* @param {IdentityProviderRequest} request The request object that contains all the information used to create the identity provider.
|
|
224
260
|
* @returns {Promise<ClientResponse<IdentityProviderResponse>>}
|
|
225
261
|
*/
|
|
226
262
|
createIdentityProvider(identityProviderId: UUID, request: IdentityProviderRequest): Promise<ClientResponse<IdentityProviderResponse>>;
|
|
@@ -228,7 +264,7 @@ export declare class FusionAuthClient {
|
|
|
228
264
|
* Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
|
|
229
265
|
*
|
|
230
266
|
* @param {UUID} lambdaId (Optional) The Id for the lambda. If not provided a secure random UUID will be generated.
|
|
231
|
-
* @param {LambdaRequest} request The request object that contains all
|
|
267
|
+
* @param {LambdaRequest} request The request object that contains all the information used to create the lambda.
|
|
232
268
|
* @returns {Promise<ClientResponse<LambdaResponse>>}
|
|
233
269
|
*/
|
|
234
270
|
createLambda(lambdaId: UUID, request: LambdaRequest): Promise<ClientResponse<LambdaResponse>>;
|
|
@@ -236,7 +272,7 @@ export declare class FusionAuthClient {
|
|
|
236
272
|
* Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
|
|
237
273
|
*
|
|
238
274
|
* @param {UUID} messageTemplateId (Optional) The Id for the template. If not provided a secure random UUID will be generated.
|
|
239
|
-
* @param {MessageTemplateRequest} request The request object that contains all
|
|
275
|
+
* @param {MessageTemplateRequest} request The request object that contains all the information used to create the message template.
|
|
240
276
|
* @returns {Promise<ClientResponse<MessageTemplateResponse>>}
|
|
241
277
|
*/
|
|
242
278
|
createMessageTemplate(messageTemplateId: UUID, request: MessageTemplateRequest): Promise<ClientResponse<MessageTemplateResponse>>;
|
|
@@ -244,7 +280,7 @@ export declare class FusionAuthClient {
|
|
|
244
280
|
* Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
|
|
245
281
|
*
|
|
246
282
|
* @param {UUID} messengerId (Optional) The Id for the messenger. If not provided a secure random UUID will be generated.
|
|
247
|
-
* @param {MessengerRequest} request The request object that contains all
|
|
283
|
+
* @param {MessengerRequest} request The request object that contains all the information used to create the messenger.
|
|
248
284
|
* @returns {Promise<ClientResponse<MessengerResponse>>}
|
|
249
285
|
*/
|
|
250
286
|
createMessenger(messengerId: UUID, request: MessengerRequest): Promise<ClientResponse<MessengerResponse>>;
|
|
@@ -252,7 +288,7 @@ export declare class FusionAuthClient {
|
|
|
252
288
|
* Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
|
|
253
289
|
*
|
|
254
290
|
* @param {UUID} tenantId (Optional) The Id for the tenant. If not provided a secure random UUID will be generated.
|
|
255
|
-
* @param {TenantRequest} request The request object that contains all
|
|
291
|
+
* @param {TenantRequest} request The request object that contains all the information used to create the tenant.
|
|
256
292
|
* @returns {Promise<ClientResponse<TenantResponse>>}
|
|
257
293
|
*/
|
|
258
294
|
createTenant(tenantId: UUID, request: TenantRequest): Promise<ClientResponse<TenantResponse>>;
|
|
@@ -260,7 +296,7 @@ export declare class FusionAuthClient {
|
|
|
260
296
|
* Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
|
|
261
297
|
*
|
|
262
298
|
* @param {UUID} themeId (Optional) The Id for the theme. If not provided a secure random UUID will be generated.
|
|
263
|
-
* @param {ThemeRequest} request The request object that contains all
|
|
299
|
+
* @param {ThemeRequest} request The request object that contains all the information used to create the theme.
|
|
264
300
|
* @returns {Promise<ClientResponse<ThemeResponse>>}
|
|
265
301
|
*/
|
|
266
302
|
createTheme(themeId: UUID, request: ThemeRequest): Promise<ClientResponse<ThemeResponse>>;
|
|
@@ -268,7 +304,7 @@ export declare class FusionAuthClient {
|
|
|
268
304
|
* Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
|
|
269
305
|
*
|
|
270
306
|
* @param {UUID} userId (Optional) The Id for the user. If not provided a secure random UUID will be generated.
|
|
271
|
-
* @param {UserRequest} request The request object that contains all
|
|
307
|
+
* @param {UserRequest} request The request object that contains all the information used to create the user.
|
|
272
308
|
* @returns {Promise<ClientResponse<UserResponse>>}
|
|
273
309
|
*/
|
|
274
310
|
createUser(userId: UUID, request: UserRequest): Promise<ClientResponse<UserResponse>>;
|
|
@@ -277,7 +313,7 @@ export declare class FusionAuthClient {
|
|
|
277
313
|
* that the user action can be applied to any user.
|
|
278
314
|
*
|
|
279
315
|
* @param {UUID} userActionId (Optional) The Id for the user action. If not provided a secure random UUID will be generated.
|
|
280
|
-
* @param {UserActionRequest} request The request object that contains all
|
|
316
|
+
* @param {UserActionRequest} request The request object that contains all the information used to create the user action.
|
|
281
317
|
* @returns {Promise<ClientResponse<UserActionResponse>>}
|
|
282
318
|
*/
|
|
283
319
|
createUserAction(userActionId: UUID, request: UserActionRequest): Promise<ClientResponse<UserActionResponse>>;
|
|
@@ -286,7 +322,7 @@ export declare class FusionAuthClient {
|
|
|
286
322
|
* successfully. Anytime after that the user action reason can be used.
|
|
287
323
|
*
|
|
288
324
|
* @param {UUID} userActionReasonId (Optional) The Id for the user action reason. If not provided a secure random UUID will be generated.
|
|
289
|
-
* @param {UserActionReasonRequest} request The request object that contains all
|
|
325
|
+
* @param {UserActionReasonRequest} request The request object that contains all the information used to create the user action reason.
|
|
290
326
|
* @returns {Promise<ClientResponse<UserActionReasonResponse>>}
|
|
291
327
|
*/
|
|
292
328
|
createUserActionReason(userActionReasonId: UUID, request: UserActionReasonRequest): Promise<ClientResponse<UserActionReasonResponse>>;
|
|
@@ -301,7 +337,7 @@ export declare class FusionAuthClient {
|
|
|
301
337
|
/**
|
|
302
338
|
* Link an external user from a 3rd party identity provider to a FusionAuth user.
|
|
303
339
|
*
|
|
304
|
-
* @param {IdentityProviderLinkRequest} request The request object that contains all
|
|
340
|
+
* @param {IdentityProviderLinkRequest} request The request object that contains all the information used to link the FusionAuth user.
|
|
305
341
|
* @returns {Promise<ClientResponse<IdentityProviderLinkResponse>>}
|
|
306
342
|
*/
|
|
307
343
|
createUserLink(request: IdentityProviderLinkRequest): Promise<ClientResponse<IdentityProviderLinkResponse>>;
|
|
@@ -309,7 +345,7 @@ export declare class FusionAuthClient {
|
|
|
309
345
|
* Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
|
|
310
346
|
*
|
|
311
347
|
* @param {UUID} webhookId (Optional) The Id for the webhook. If not provided a secure random UUID will be generated.
|
|
312
|
-
* @param {WebhookRequest} request The request object that contains all
|
|
348
|
+
* @param {WebhookRequest} request The request object that contains all the information used to create the webhook.
|
|
313
349
|
* @returns {Promise<ClientResponse<WebhookResponse>>}
|
|
314
350
|
*/
|
|
315
351
|
createWebhook(webhookId: UUID, request: WebhookRequest): Promise<ClientResponse<WebhookResponse>>;
|
|
@@ -543,7 +579,7 @@ export declare class FusionAuthClient {
|
|
|
543
579
|
* with the tenant and everything under the tenant (applications, users, etc).
|
|
544
580
|
*
|
|
545
581
|
* @param {UUID} tenantId The Id of the tenant to delete.
|
|
546
|
-
* @param {TenantDeleteRequest} request The request object that contains all
|
|
582
|
+
* @param {TenantDeleteRequest} request The request object that contains all the information used to delete the user.
|
|
547
583
|
* @returns {Promise<ClientResponse<void>>}
|
|
548
584
|
*/
|
|
549
585
|
deleteTenantWithRequest(tenantId: UUID, request: TenantDeleteRequest): Promise<ClientResponse<void>>;
|
|
@@ -591,7 +627,7 @@ export declare class FusionAuthClient {
|
|
|
591
627
|
* with the user.
|
|
592
628
|
*
|
|
593
629
|
* @param {UUID} userId The Id of the user to delete (required).
|
|
594
|
-
* @param {UserDeleteSingleRequest} request The request object that contains all
|
|
630
|
+
* @param {UserDeleteSingleRequest} request The request object that contains all the information used to delete the user.
|
|
595
631
|
* @returns {Promise<ClientResponse<void>>}
|
|
596
632
|
*/
|
|
597
633
|
deleteUserWithRequest(userId: UUID, request: UserDeleteSingleRequest): Promise<ClientResponse<void>>;
|
|
@@ -725,7 +761,7 @@ export declare class FusionAuthClient {
|
|
|
725
761
|
* Generate a new RSA or EC key pair or an HMAC secret.
|
|
726
762
|
*
|
|
727
763
|
* @param {UUID} keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
|
|
728
|
-
* @param {KeyRequest} request The request object that contains all
|
|
764
|
+
* @param {KeyRequest} request The request object that contains all the information used to create the key.
|
|
729
765
|
* @returns {Promise<ClientResponse<KeyResponse>>}
|
|
730
766
|
*/
|
|
731
767
|
generateKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
|
|
@@ -775,7 +811,7 @@ export declare class FusionAuthClient {
|
|
|
775
811
|
* Import an existing RSA or EC key pair or an HMAC secret.
|
|
776
812
|
*
|
|
777
813
|
* @param {UUID} keyId (Optional) The Id for the key. If not provided a secure random UUID will be generated.
|
|
778
|
-
* @param {KeyRequest} request The request object that contains all
|
|
814
|
+
* @param {KeyRequest} request The request object that contains all the information used to create the key.
|
|
779
815
|
* @returns {Promise<ClientResponse<KeyResponse>>}
|
|
780
816
|
*/
|
|
781
817
|
importKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
|
|
@@ -868,7 +904,7 @@ export declare class FusionAuthClient {
|
|
|
868
904
|
* The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
|
|
869
905
|
* client and revoke the refresh token stored. This API takes the refresh token in the JSON body.
|
|
870
906
|
*
|
|
871
|
-
* @param {LogoutRequest} request The request object that contains all
|
|
907
|
+
* @param {LogoutRequest} request The request object that contains all the information used to logout the user.
|
|
872
908
|
* @returns {Promise<ClientResponse<void>>}
|
|
873
909
|
*/
|
|
874
910
|
logoutWithRequest(request: LogoutRequest): Promise<ClientResponse<void>>;
|
|
@@ -2057,7 +2093,7 @@ export declare class FusionAuthClient {
|
|
|
2057
2093
|
/**
|
|
2058
2094
|
* Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
|
|
2059
2095
|
*
|
|
2060
|
-
* @param {TwoFactorSendRequest} request The request object that contains all
|
|
2096
|
+
* @param {TwoFactorSendRequest} request The request object that contains all the information used to send the code.
|
|
2061
2097
|
* @returns {Promise<ClientResponse<void>>}
|
|
2062
2098
|
*
|
|
2063
2099
|
* @deprecated This method has been renamed to sendTwoFactorCodeForEnableDisable, use that method instead.
|
|
@@ -2066,7 +2102,7 @@ export declare class FusionAuthClient {
|
|
|
2066
2102
|
/**
|
|
2067
2103
|
* Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
|
|
2068
2104
|
*
|
|
2069
|
-
* @param {TwoFactorSendRequest} request The request object that contains all
|
|
2105
|
+
* @param {TwoFactorSendRequest} request The request object that contains all the information used to send the code.
|
|
2070
2106
|
* @returns {Promise<ClientResponse<void>>}
|
|
2071
2107
|
*/
|
|
2072
2108
|
sendTwoFactorCodeForEnableDisable(request: TwoFactorSendRequest): Promise<ClientResponse<void>>;
|
|
@@ -2126,7 +2162,7 @@ export declare class FusionAuthClient {
|
|
|
2126
2162
|
* Updates an API key by given id
|
|
2127
2163
|
*
|
|
2128
2164
|
* @param {UUID} apiKeyId The Id of the API key to update.
|
|
2129
|
-
* @param {APIKeyRequest} request The request object that contains all
|
|
2165
|
+
* @param {APIKeyRequest} request The request object that contains all the information used to create the API Key.
|
|
2130
2166
|
* @returns {Promise<ClientResponse<APIKeyResponse>>}
|
|
2131
2167
|
*/
|
|
2132
2168
|
updateAPIKey(apiKeyId: UUID, request: APIKeyRequest): Promise<ClientResponse<APIKeyResponse>>;
|
|
@@ -2350,7 +2386,7 @@ export declare class FusionAuthClient {
|
|
|
2350
2386
|
* Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
|
|
2351
2387
|
*
|
|
2352
2388
|
* @param {UUID} entityId The Id of the Entity that the User/Entity is being granted access to.
|
|
2353
|
-
* @param {EntityGrantRequest} request The request object that contains all
|
|
2389
|
+
* @param {EntityGrantRequest} request The request object that contains all the information used to create the Entity Grant.
|
|
2354
2390
|
* @returns {Promise<ClientResponse<void>>}
|
|
2355
2391
|
*/
|
|
2356
2392
|
upsertEntityGrant(entityId: UUID, request: EntityGrantRequest): Promise<ClientResponse<void>>;
|
|
@@ -2844,6 +2880,7 @@ export interface BaseIdentityProvider<D extends BaseIdentityProviderApplicationC
|
|
|
2844
2880
|
lastUpdateInstant?: number;
|
|
2845
2881
|
linkingStrategy?: IdentityProviderLinkingStrategy;
|
|
2846
2882
|
name?: string;
|
|
2883
|
+
tenantConfiguration?: Record<UUID, IdentityProviderTenantConfiguration>;
|
|
2847
2884
|
type?: IdentityProviderType;
|
|
2848
2885
|
}
|
|
2849
2886
|
/**
|
|
@@ -2961,10 +2998,13 @@ export declare enum ChangePasswordReason {
|
|
|
2961
2998
|
*/
|
|
2962
2999
|
export interface ChangePasswordRequest extends BaseEventRequest {
|
|
2963
3000
|
applicationId?: UUID;
|
|
3001
|
+
changePasswordId?: string;
|
|
2964
3002
|
currentPassword?: string;
|
|
2965
3003
|
loginId?: string;
|
|
2966
3004
|
password?: string;
|
|
2967
3005
|
refreshToken?: string;
|
|
3006
|
+
trustChallenge?: string;
|
|
3007
|
+
trustToken?: string;
|
|
2968
3008
|
}
|
|
2969
3009
|
/**
|
|
2970
3010
|
* Change password response object.
|
|
@@ -3192,12 +3232,14 @@ export interface EmailAddress {
|
|
|
3192
3232
|
* @author Brian Pontarelli
|
|
3193
3233
|
*/
|
|
3194
3234
|
export interface EmailConfiguration {
|
|
3235
|
+
additionalHeaders?: Array<EmailHeader>;
|
|
3195
3236
|
defaultFromEmail?: string;
|
|
3196
3237
|
defaultFromName?: string;
|
|
3197
3238
|
emailUpdateEmailTemplateId?: UUID;
|
|
3198
3239
|
emailVerifiedEmailTemplateId?: UUID;
|
|
3199
3240
|
forgotPasswordEmailTemplateId?: UUID;
|
|
3200
3241
|
host?: string;
|
|
3242
|
+
implicitEmailVerificationAllowed?: boolean;
|
|
3201
3243
|
loginIdInUseOnCreateEmailTemplateId?: UUID;
|
|
3202
3244
|
loginIdInUseOnUpdateEmailTemplateId?: UUID;
|
|
3203
3245
|
loginNewDeviceEmailTemplateId?: UUID;
|
|
@@ -3219,6 +3261,13 @@ export interface EmailConfiguration {
|
|
|
3219
3261
|
verifyEmail?: boolean;
|
|
3220
3262
|
verifyEmailWhenChanged?: boolean;
|
|
3221
3263
|
}
|
|
3264
|
+
/**
|
|
3265
|
+
* @author Daniel DeGroff
|
|
3266
|
+
*/
|
|
3267
|
+
export interface EmailHeader {
|
|
3268
|
+
name?: string;
|
|
3269
|
+
value?: string;
|
|
3270
|
+
}
|
|
3222
3271
|
export interface EmailPlus extends Enableable {
|
|
3223
3272
|
emailTemplateId?: UUID;
|
|
3224
3273
|
maximumTimeToSendEmailInHours?: number;
|
|
@@ -3507,6 +3556,7 @@ export interface EpicGamesIdentityProvider extends BaseIdentityProvider<EpicGame
|
|
|
3507
3556
|
*/
|
|
3508
3557
|
export interface Error {
|
|
3509
3558
|
code?: string;
|
|
3559
|
+
data?: Record<string, any>;
|
|
3510
3560
|
message?: string;
|
|
3511
3561
|
}
|
|
3512
3562
|
/**
|
|
@@ -3696,6 +3746,7 @@ export interface ExternalIdentifierConfiguration {
|
|
|
3696
3746
|
samlv2AuthNRequestIdTimeToLiveInSeconds?: number;
|
|
3697
3747
|
setupPasswordIdGenerator?: SecureGeneratorConfiguration;
|
|
3698
3748
|
setupPasswordIdTimeToLiveInSeconds?: number;
|
|
3749
|
+
trustTokenTimeToLiveInSeconds?: number;
|
|
3699
3750
|
twoFactorIdTimeToLiveInSeconds?: number;
|
|
3700
3751
|
twoFactorOneTimeCodeIdGenerator?: SecureGeneratorConfiguration;
|
|
3701
3752
|
twoFactorOneTimeCodeIdTimeToLiveInSeconds?: number;
|
|
@@ -4124,6 +4175,12 @@ export interface IdentityProviderDetails {
|
|
|
4124
4175
|
oauth2?: IdentityProviderOauth2Configuration;
|
|
4125
4176
|
type?: IdentityProviderType;
|
|
4126
4177
|
}
|
|
4178
|
+
/**
|
|
4179
|
+
* @author Daniel DeGroff
|
|
4180
|
+
*/
|
|
4181
|
+
export interface IdentityProviderLimitUserLinkingPolicy extends Enableable {
|
|
4182
|
+
maximumLinks?: number;
|
|
4183
|
+
}
|
|
4127
4184
|
/**
|
|
4128
4185
|
* @author Daniel DeGroff
|
|
4129
4186
|
*/
|
|
@@ -4231,6 +4288,13 @@ export interface IdentityProviderStartLoginRequest extends BaseLoginRequest {
|
|
|
4231
4288
|
export interface IdentityProviderStartLoginResponse {
|
|
4232
4289
|
code?: string;
|
|
4233
4290
|
}
|
|
4291
|
+
/**
|
|
4292
|
+
* @author Daniel DeGroff
|
|
4293
|
+
*/
|
|
4294
|
+
export interface IdentityProviderTenantConfiguration {
|
|
4295
|
+
data?: Record<string, any>;
|
|
4296
|
+
limitUserLinkCount?: IdentityProviderLimitUserLinkingPolicy;
|
|
4297
|
+
}
|
|
4234
4298
|
/**
|
|
4235
4299
|
* @author Daniel DeGroff
|
|
4236
4300
|
*/
|
|
@@ -4821,6 +4885,8 @@ export interface LoginResponse {
|
|
|
4821
4885
|
state?: Record<string, any>;
|
|
4822
4886
|
threatsDetected?: Array<AuthenticationThreats>;
|
|
4823
4887
|
token?: string;
|
|
4888
|
+
tokenExpirationInstant?: number;
|
|
4889
|
+
trustToken?: string;
|
|
4824
4890
|
twoFactorId?: string;
|
|
4825
4891
|
twoFactorTrustId?: string;
|
|
4826
4892
|
user?: User;
|
|
@@ -4850,8 +4916,8 @@ export interface LookupResponse {
|
|
|
4850
4916
|
/**
|
|
4851
4917
|
* This class contains the managed fields that are also put into the database during FusionAuth setup.
|
|
4852
4918
|
* <p>
|
|
4853
|
-
*
|
|
4854
|
-
*
|
|
4919
|
+
* Internal Note: These fields are also declared in SQL in order to bootstrap the system. These need to stay in sync.
|
|
4920
|
+
* Any changes to these fields needs to also be reflected in mysql.sql and postgresql.sql
|
|
4855
4921
|
*
|
|
4856
4922
|
* @author Brian Pontarelli
|
|
4857
4923
|
*/
|
|
@@ -5266,7 +5332,9 @@ export interface PendingIdPLink {
|
|
|
5266
5332
|
displayName?: string;
|
|
5267
5333
|
email?: string;
|
|
5268
5334
|
identityProviderId?: UUID;
|
|
5335
|
+
identityProviderLinks?: Array<IdentityProviderLink>;
|
|
5269
5336
|
identityProviderName?: string;
|
|
5337
|
+
identityProviderTenantConfiguration?: IdentityProviderTenantConfiguration;
|
|
5270
5338
|
identityProviderType?: IdentityProviderType;
|
|
5271
5339
|
identityProviderUserId?: string;
|
|
5272
5340
|
user?: User;
|
|
@@ -5540,6 +5608,7 @@ export interface RegistrationResponse {
|
|
|
5540
5608
|
registration?: UserRegistration;
|
|
5541
5609
|
registrationVerificationId?: string;
|
|
5542
5610
|
token?: string;
|
|
5611
|
+
tokenExpirationInstant?: number;
|
|
5543
5612
|
user?: User;
|
|
5544
5613
|
}
|
|
5545
5614
|
export declare enum RegistrationType {
|
|
@@ -6277,6 +6346,8 @@ export interface TwoFactorStartRequest {
|
|
|
6277
6346
|
code?: string;
|
|
6278
6347
|
loginId?: string;
|
|
6279
6348
|
state?: Record<string, any>;
|
|
6349
|
+
trustChallenge?: string;
|
|
6350
|
+
userId?: UUID;
|
|
6280
6351
|
}
|
|
6281
6352
|
/**
|
|
6282
6353
|
* @author Daniel DeGroff
|
|
@@ -6877,6 +6948,7 @@ export interface UserResponse {
|
|
|
6877
6948
|
emailVerificationId?: string;
|
|
6878
6949
|
registrationVerificationIds?: Record<UUID, string>;
|
|
6879
6950
|
token?: string;
|
|
6951
|
+
tokenExpirationInstant?: number;
|
|
6880
6952
|
user?: User;
|
|
6881
6953
|
}
|
|
6882
6954
|
/**
|