@fusionauth/typescript-client 1.30.0 → 1.32.1
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 +82 -66
- package/build/src/FusionAuthClient.js +48 -37
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +49 -38
- package/dist/fusionauth-typescript-client.min.js +1 -1
- package/dist/fusionauth-typescript-client.min.js.map +1 -1
- package/package.json +1 -1
|
@@ -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>>;
|
|
@@ -75,7 +75,7 @@ export declare class FusionAuthClient {
|
|
|
75
75
|
/**
|
|
76
76
|
* Adds a comment to the user's account.
|
|
77
77
|
*
|
|
78
|
-
* @param {UserCommentRequest} request The request object that contains all
|
|
78
|
+
* @param {UserCommentRequest} request The request object that contains all the information used to create the user comment.
|
|
79
79
|
* @returns {Promise<ClientResponse<void>>}
|
|
80
80
|
*/
|
|
81
81
|
commentOnUser(request: UserCommentRequest): Promise<ClientResponse<void>>;
|
|
@@ -95,7 +95,7 @@ export declare class FusionAuthClient {
|
|
|
95
95
|
* Creates an application. You can optionally specify an Id for the application, if not provided one will be generated.
|
|
96
96
|
*
|
|
97
97
|
* @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
|
|
98
|
+
* @param {ApplicationRequest} request The request object that contains all the information used to create the application.
|
|
99
99
|
* @returns {Promise<ClientResponse<ApplicationResponse>>}
|
|
100
100
|
*/
|
|
101
101
|
createApplication(applicationId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
|
|
@@ -105,7 +105,7 @@ export declare class FusionAuthClient {
|
|
|
105
105
|
*
|
|
106
106
|
* @param {UUID} applicationId The Id of the application to create the role on.
|
|
107
107
|
* @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
|
|
108
|
+
* @param {ApplicationRequest} request The request object that contains all the information used to create the application role.
|
|
109
109
|
* @returns {Promise<ClientResponse<ApplicationResponse>>}
|
|
110
110
|
*/
|
|
111
111
|
createApplicationRole(applicationId: UUID, roleId: UUID, request: ApplicationRequest): Promise<ClientResponse<ApplicationResponse>>;
|
|
@@ -114,7 +114,7 @@ export declare class FusionAuthClient {
|
|
|
114
114
|
* make changes to the FusionAuth database. When using the FusionAuth App web interface, any changes are automatically
|
|
115
115
|
* written to the audit log. However, if you are accessing the API, you must write the audit logs yourself.
|
|
116
116
|
*
|
|
117
|
-
* @param {AuditLogRequest} request The request object that contains all
|
|
117
|
+
* @param {AuditLogRequest} request The request object that contains all the information used to create the audit log entry.
|
|
118
118
|
* @returns {Promise<ClientResponse<AuditLogResponse>>}
|
|
119
119
|
*/
|
|
120
120
|
createAuditLog(request: AuditLogRequest): Promise<ClientResponse<AuditLogResponse>>;
|
|
@@ -122,7 +122,7 @@ export declare class FusionAuthClient {
|
|
|
122
122
|
* Creates a connector. You can optionally specify an Id for the connector, if not provided one will be generated.
|
|
123
123
|
*
|
|
124
124
|
* @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
|
|
125
|
+
* @param {ConnectorRequest} request The request object that contains all the information used to create the connector.
|
|
126
126
|
* @returns {Promise<ClientResponse<ConnectorResponse>>}
|
|
127
127
|
*/
|
|
128
128
|
createConnector(connectorId: UUID, request: ConnectorRequest): Promise<ClientResponse<ConnectorResponse>>;
|
|
@@ -130,7 +130,7 @@ export declare class FusionAuthClient {
|
|
|
130
130
|
* Creates a user consent type. You can optionally specify an Id for the consent type, if not provided one will be generated.
|
|
131
131
|
*
|
|
132
132
|
* @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
|
|
133
|
+
* @param {ConsentRequest} request The request object that contains all the information used to create the consent.
|
|
134
134
|
* @returns {Promise<ClientResponse<ConsentResponse>>}
|
|
135
135
|
*/
|
|
136
136
|
createConsent(consentId: UUID, request: ConsentRequest): Promise<ClientResponse<ConsentResponse>>;
|
|
@@ -138,7 +138,7 @@ export declare class FusionAuthClient {
|
|
|
138
138
|
* Creates an email template. You can optionally specify an Id for the template, if not provided one will be generated.
|
|
139
139
|
*
|
|
140
140
|
* @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
|
|
141
|
+
* @param {EmailTemplateRequest} request The request object that contains all the information used to create the email template.
|
|
142
142
|
* @returns {Promise<ClientResponse<EmailTemplateResponse>>}
|
|
143
143
|
*/
|
|
144
144
|
createEmailTemplate(emailTemplateId: UUID, request: EmailTemplateRequest): Promise<ClientResponse<EmailTemplateResponse>>;
|
|
@@ -146,7 +146,7 @@ export declare class FusionAuthClient {
|
|
|
146
146
|
* Creates an Entity. You can optionally specify an Id for the Entity. If not provided one will be generated.
|
|
147
147
|
*
|
|
148
148
|
* @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
|
|
149
|
+
* @param {EntityRequest} request The request object that contains all the information used to create the Entity.
|
|
150
150
|
* @returns {Promise<ClientResponse<EntityResponse>>}
|
|
151
151
|
*/
|
|
152
152
|
createEntity(entityId: UUID, request: EntityRequest): Promise<ClientResponse<EntityResponse>>;
|
|
@@ -154,7 +154,7 @@ export declare class FusionAuthClient {
|
|
|
154
154
|
* Creates a Entity Type. You can optionally specify an Id for the Entity Type, if not provided one will be generated.
|
|
155
155
|
*
|
|
156
156
|
* @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
|
|
157
|
+
* @param {EntityTypeRequest} request The request object that contains all the information used to create the Entity Type.
|
|
158
158
|
* @returns {Promise<ClientResponse<EntityTypeResponse>>}
|
|
159
159
|
*/
|
|
160
160
|
createEntityType(entityTypeId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
|
|
@@ -164,7 +164,7 @@ export declare class FusionAuthClient {
|
|
|
164
164
|
*
|
|
165
165
|
* @param {UUID} entityTypeId The Id of the entity type to create the permission on.
|
|
166
166
|
* @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
|
|
167
|
+
* @param {EntityTypeRequest} request The request object that contains all the information used to create the permission.
|
|
168
168
|
* @returns {Promise<ClientResponse<EntityTypeResponse>>}
|
|
169
169
|
*/
|
|
170
170
|
createEntityTypePermission(entityTypeId: UUID, permissionId: UUID, request: EntityTypeRequest): Promise<ClientResponse<EntityTypeResponse>>;
|
|
@@ -173,7 +173,7 @@ export declare class FusionAuthClient {
|
|
|
173
173
|
* family, if not provided one will be generated.
|
|
174
174
|
*
|
|
175
175
|
* @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
|
|
176
|
+
* @param {FamilyRequest} request The request object that contains all the information used to create the family.
|
|
177
177
|
* @returns {Promise<ClientResponse<FamilyResponse>>}
|
|
178
178
|
*/
|
|
179
179
|
createFamily(familyId: UUID, request: FamilyRequest): Promise<ClientResponse<FamilyResponse>>;
|
|
@@ -181,7 +181,7 @@ export declare class FusionAuthClient {
|
|
|
181
181
|
* Creates a form. You can optionally specify an Id for the form, if not provided one will be generated.
|
|
182
182
|
*
|
|
183
183
|
* @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
|
|
184
|
+
* @param {FormRequest} request The request object that contains all the information used to create the form.
|
|
185
185
|
* @returns {Promise<ClientResponse<FormResponse>>}
|
|
186
186
|
*/
|
|
187
187
|
createForm(formId: UUID, request: FormRequest): Promise<ClientResponse<FormResponse>>;
|
|
@@ -189,7 +189,7 @@ export declare class FusionAuthClient {
|
|
|
189
189
|
* Creates a form field. You can optionally specify an Id for the form, if not provided one will be generated.
|
|
190
190
|
*
|
|
191
191
|
* @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
|
|
192
|
+
* @param {FormFieldRequest} request The request object that contains all the information used to create the form field.
|
|
193
193
|
* @returns {Promise<ClientResponse<FormFieldResponse>>}
|
|
194
194
|
*/
|
|
195
195
|
createFormField(fieldId: UUID, request: FormFieldRequest): Promise<ClientResponse<FormFieldResponse>>;
|
|
@@ -197,14 +197,14 @@ export declare class FusionAuthClient {
|
|
|
197
197
|
* Creates a group. You can optionally specify an Id for the group, if not provided one will be generated.
|
|
198
198
|
*
|
|
199
199
|
* @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
|
|
200
|
+
* @param {GroupRequest} request The request object that contains all the information used to create the group.
|
|
201
201
|
* @returns {Promise<ClientResponse<GroupResponse>>}
|
|
202
202
|
*/
|
|
203
203
|
createGroup(groupId: UUID, request: GroupRequest): Promise<ClientResponse<GroupResponse>>;
|
|
204
204
|
/**
|
|
205
205
|
* Creates a member in a group.
|
|
206
206
|
*
|
|
207
|
-
* @param {MemberRequest} request The request object that contains all
|
|
207
|
+
* @param {MemberRequest} request The request object that contains all the information used to create the group member(s).
|
|
208
208
|
* @returns {Promise<ClientResponse<MemberResponse>>}
|
|
209
209
|
*/
|
|
210
210
|
createGroupMembers(request: MemberRequest): Promise<ClientResponse<MemberResponse>>;
|
|
@@ -212,7 +212,7 @@ export declare class FusionAuthClient {
|
|
|
212
212
|
* 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
213
|
*
|
|
214
214
|
* @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
|
|
215
|
+
* @param {IPAccessControlListRequest} request The request object that contains all the information used to create the IP Access Control List.
|
|
216
216
|
* @returns {Promise<ClientResponse<IPAccessControlListResponse>>}
|
|
217
217
|
*/
|
|
218
218
|
createIPAccessControlList(accessControlListId: UUID, request: IPAccessControlListRequest): Promise<ClientResponse<IPAccessControlListResponse>>;
|
|
@@ -220,7 +220,7 @@ export declare class FusionAuthClient {
|
|
|
220
220
|
* Creates an identity provider. You can optionally specify an Id for the identity provider, if not provided one will be generated.
|
|
221
221
|
*
|
|
222
222
|
* @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
|
|
223
|
+
* @param {IdentityProviderRequest} request The request object that contains all the information used to create the identity provider.
|
|
224
224
|
* @returns {Promise<ClientResponse<IdentityProviderResponse>>}
|
|
225
225
|
*/
|
|
226
226
|
createIdentityProvider(identityProviderId: UUID, request: IdentityProviderRequest): Promise<ClientResponse<IdentityProviderResponse>>;
|
|
@@ -228,7 +228,7 @@ export declare class FusionAuthClient {
|
|
|
228
228
|
* Creates a Lambda. You can optionally specify an Id for the lambda, if not provided one will be generated.
|
|
229
229
|
*
|
|
230
230
|
* @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
|
|
231
|
+
* @param {LambdaRequest} request The request object that contains all the information used to create the lambda.
|
|
232
232
|
* @returns {Promise<ClientResponse<LambdaResponse>>}
|
|
233
233
|
*/
|
|
234
234
|
createLambda(lambdaId: UUID, request: LambdaRequest): Promise<ClientResponse<LambdaResponse>>;
|
|
@@ -236,7 +236,7 @@ export declare class FusionAuthClient {
|
|
|
236
236
|
* Creates an message template. You can optionally specify an Id for the template, if not provided one will be generated.
|
|
237
237
|
*
|
|
238
238
|
* @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
|
|
239
|
+
* @param {MessageTemplateRequest} request The request object that contains all the information used to create the message template.
|
|
240
240
|
* @returns {Promise<ClientResponse<MessageTemplateResponse>>}
|
|
241
241
|
*/
|
|
242
242
|
createMessageTemplate(messageTemplateId: UUID, request: MessageTemplateRequest): Promise<ClientResponse<MessageTemplateResponse>>;
|
|
@@ -244,7 +244,7 @@ export declare class FusionAuthClient {
|
|
|
244
244
|
* Creates a messenger. You can optionally specify an Id for the messenger, if not provided one will be generated.
|
|
245
245
|
*
|
|
246
246
|
* @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
|
|
247
|
+
* @param {MessengerRequest} request The request object that contains all the information used to create the messenger.
|
|
248
248
|
* @returns {Promise<ClientResponse<MessengerResponse>>}
|
|
249
249
|
*/
|
|
250
250
|
createMessenger(messengerId: UUID, request: MessengerRequest): Promise<ClientResponse<MessengerResponse>>;
|
|
@@ -252,7 +252,7 @@ export declare class FusionAuthClient {
|
|
|
252
252
|
* Creates a tenant. You can optionally specify an Id for the tenant, if not provided one will be generated.
|
|
253
253
|
*
|
|
254
254
|
* @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
|
|
255
|
+
* @param {TenantRequest} request The request object that contains all the information used to create the tenant.
|
|
256
256
|
* @returns {Promise<ClientResponse<TenantResponse>>}
|
|
257
257
|
*/
|
|
258
258
|
createTenant(tenantId: UUID, request: TenantRequest): Promise<ClientResponse<TenantResponse>>;
|
|
@@ -260,7 +260,7 @@ export declare class FusionAuthClient {
|
|
|
260
260
|
* Creates a Theme. You can optionally specify an Id for the theme, if not provided one will be generated.
|
|
261
261
|
*
|
|
262
262
|
* @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
|
|
263
|
+
* @param {ThemeRequest} request The request object that contains all the information used to create the theme.
|
|
264
264
|
* @returns {Promise<ClientResponse<ThemeResponse>>}
|
|
265
265
|
*/
|
|
266
266
|
createTheme(themeId: UUID, request: ThemeRequest): Promise<ClientResponse<ThemeResponse>>;
|
|
@@ -268,7 +268,7 @@ export declare class FusionAuthClient {
|
|
|
268
268
|
* Creates a user. You can optionally specify an Id for the user, if not provided one will be generated.
|
|
269
269
|
*
|
|
270
270
|
* @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
|
|
271
|
+
* @param {UserRequest} request The request object that contains all the information used to create the user.
|
|
272
272
|
* @returns {Promise<ClientResponse<UserResponse>>}
|
|
273
273
|
*/
|
|
274
274
|
createUser(userId: UUID, request: UserRequest): Promise<ClientResponse<UserResponse>>;
|
|
@@ -277,7 +277,7 @@ export declare class FusionAuthClient {
|
|
|
277
277
|
* that the user action can be applied to any user.
|
|
278
278
|
*
|
|
279
279
|
* @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
|
|
280
|
+
* @param {UserActionRequest} request The request object that contains all the information used to create the user action.
|
|
281
281
|
* @returns {Promise<ClientResponse<UserActionResponse>>}
|
|
282
282
|
*/
|
|
283
283
|
createUserAction(userActionId: UUID, request: UserActionRequest): Promise<ClientResponse<UserActionResponse>>;
|
|
@@ -286,7 +286,7 @@ export declare class FusionAuthClient {
|
|
|
286
286
|
* successfully. Anytime after that the user action reason can be used.
|
|
287
287
|
*
|
|
288
288
|
* @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
|
|
289
|
+
* @param {UserActionReasonRequest} request The request object that contains all the information used to create the user action reason.
|
|
290
290
|
* @returns {Promise<ClientResponse<UserActionReasonResponse>>}
|
|
291
291
|
*/
|
|
292
292
|
createUserActionReason(userActionReasonId: UUID, request: UserActionReasonRequest): Promise<ClientResponse<UserActionReasonResponse>>;
|
|
@@ -301,7 +301,7 @@ export declare class FusionAuthClient {
|
|
|
301
301
|
/**
|
|
302
302
|
* Link an external user from a 3rd party identity provider to a FusionAuth user.
|
|
303
303
|
*
|
|
304
|
-
* @param {IdentityProviderLinkRequest} request The request object that contains all
|
|
304
|
+
* @param {IdentityProviderLinkRequest} request The request object that contains all the information used to link the FusionAuth user.
|
|
305
305
|
* @returns {Promise<ClientResponse<IdentityProviderLinkResponse>>}
|
|
306
306
|
*/
|
|
307
307
|
createUserLink(request: IdentityProviderLinkRequest): Promise<ClientResponse<IdentityProviderLinkResponse>>;
|
|
@@ -309,7 +309,7 @@ export declare class FusionAuthClient {
|
|
|
309
309
|
* Creates a webhook. You can optionally specify an Id for the webhook, if not provided one will be generated.
|
|
310
310
|
*
|
|
311
311
|
* @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
|
|
312
|
+
* @param {WebhookRequest} request The request object that contains all the information used to create the webhook.
|
|
313
313
|
* @returns {Promise<ClientResponse<WebhookResponse>>}
|
|
314
314
|
*/
|
|
315
315
|
createWebhook(webhookId: UUID, request: WebhookRequest): Promise<ClientResponse<WebhookResponse>>;
|
|
@@ -543,7 +543,7 @@ export declare class FusionAuthClient {
|
|
|
543
543
|
* with the tenant and everything under the tenant (applications, users, etc).
|
|
544
544
|
*
|
|
545
545
|
* @param {UUID} tenantId The Id of the tenant to delete.
|
|
546
|
-
* @param {TenantDeleteRequest} request The request object that contains all
|
|
546
|
+
* @param {TenantDeleteRequest} request The request object that contains all the information used to delete the user.
|
|
547
547
|
* @returns {Promise<ClientResponse<void>>}
|
|
548
548
|
*/
|
|
549
549
|
deleteTenantWithRequest(tenantId: UUID, request: TenantDeleteRequest): Promise<ClientResponse<void>>;
|
|
@@ -591,7 +591,7 @@ export declare class FusionAuthClient {
|
|
|
591
591
|
* with the user.
|
|
592
592
|
*
|
|
593
593
|
* @param {UUID} userId The Id of the user to delete (required).
|
|
594
|
-
* @param {UserDeleteSingleRequest} request The request object that contains all
|
|
594
|
+
* @param {UserDeleteSingleRequest} request The request object that contains all the information used to delete the user.
|
|
595
595
|
* @returns {Promise<ClientResponse<void>>}
|
|
596
596
|
*/
|
|
597
597
|
deleteUserWithRequest(userId: UUID, request: UserDeleteSingleRequest): Promise<ClientResponse<void>>;
|
|
@@ -725,7 +725,7 @@ export declare class FusionAuthClient {
|
|
|
725
725
|
* Generate a new RSA or EC key pair or an HMAC secret.
|
|
726
726
|
*
|
|
727
727
|
* @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
|
|
728
|
+
* @param {KeyRequest} request The request object that contains all the information used to create the key.
|
|
729
729
|
* @returns {Promise<ClientResponse<KeyResponse>>}
|
|
730
730
|
*/
|
|
731
731
|
generateKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
|
|
@@ -775,7 +775,7 @@ export declare class FusionAuthClient {
|
|
|
775
775
|
* Import an existing RSA or EC key pair or an HMAC secret.
|
|
776
776
|
*
|
|
777
777
|
* @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
|
|
778
|
+
* @param {KeyRequest} request The request object that contains all the information used to create the key.
|
|
779
779
|
* @returns {Promise<ClientResponse<KeyResponse>>}
|
|
780
780
|
*/
|
|
781
781
|
importKey(keyId: UUID, request: KeyRequest): Promise<ClientResponse<KeyResponse>>;
|
|
@@ -868,7 +868,7 @@ export declare class FusionAuthClient {
|
|
|
868
868
|
* The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
|
|
869
869
|
* client and revoke the refresh token stored. This API takes the refresh token in the JSON body.
|
|
870
870
|
*
|
|
871
|
-
* @param {LogoutRequest} request The request object that contains all
|
|
871
|
+
* @param {LogoutRequest} request The request object that contains all the information used to logout the user.
|
|
872
872
|
* @returns {Promise<ClientResponse<void>>}
|
|
873
873
|
*/
|
|
874
874
|
logoutWithRequest(request: LogoutRequest): Promise<ClientResponse<void>>;
|
|
@@ -1579,6 +1579,12 @@ export declare class FusionAuthClient {
|
|
|
1579
1579
|
* @returns {Promise<ClientResponse<PendingResponse>>}
|
|
1580
1580
|
*/
|
|
1581
1581
|
retrievePendingChildren(parentEmail: string): Promise<ClientResponse<PendingResponse>>;
|
|
1582
|
+
/**
|
|
1583
|
+
* Retrieves the FusionAuth Reactor metrics.
|
|
1584
|
+
*
|
|
1585
|
+
* @returns {Promise<ClientResponse<ReactorMetricsResponse>>}
|
|
1586
|
+
*/
|
|
1587
|
+
retrieveReactorMetrics(): Promise<ClientResponse<ReactorMetricsResponse>>;
|
|
1582
1588
|
/**
|
|
1583
1589
|
* Retrieves the FusionAuth Reactor status.
|
|
1584
1590
|
*
|
|
@@ -2051,7 +2057,7 @@ export declare class FusionAuthClient {
|
|
|
2051
2057
|
/**
|
|
2052
2058
|
* Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
|
|
2053
2059
|
*
|
|
2054
|
-
* @param {TwoFactorSendRequest} request The request object that contains all
|
|
2060
|
+
* @param {TwoFactorSendRequest} request The request object that contains all the information used to send the code.
|
|
2055
2061
|
* @returns {Promise<ClientResponse<void>>}
|
|
2056
2062
|
*
|
|
2057
2063
|
* @deprecated This method has been renamed to sendTwoFactorCodeForEnableDisable, use that method instead.
|
|
@@ -2060,7 +2066,7 @@ export declare class FusionAuthClient {
|
|
|
2060
2066
|
/**
|
|
2061
2067
|
* Send a Two Factor authentication code to assist in setting up Two Factor authentication or disabling.
|
|
2062
2068
|
*
|
|
2063
|
-
* @param {TwoFactorSendRequest} request The request object that contains all
|
|
2069
|
+
* @param {TwoFactorSendRequest} request The request object that contains all the information used to send the code.
|
|
2064
2070
|
* @returns {Promise<ClientResponse<void>>}
|
|
2065
2071
|
*/
|
|
2066
2072
|
sendTwoFactorCodeForEnableDisable(request: TwoFactorSendRequest): Promise<ClientResponse<void>>;
|
|
@@ -2120,7 +2126,7 @@ export declare class FusionAuthClient {
|
|
|
2120
2126
|
* Updates an API key by given id
|
|
2121
2127
|
*
|
|
2122
2128
|
* @param {UUID} apiKeyId The Id of the API key to update.
|
|
2123
|
-
* @param {APIKeyRequest} request The request object that contains all
|
|
2129
|
+
* @param {APIKeyRequest} request The request object that contains all the information used to create the API Key.
|
|
2124
2130
|
* @returns {Promise<ClientResponse<APIKeyResponse>>}
|
|
2125
2131
|
*/
|
|
2126
2132
|
updateAPIKey(apiKeyId: UUID, request: APIKeyRequest): Promise<ClientResponse<APIKeyResponse>>;
|
|
@@ -2344,7 +2350,7 @@ export declare class FusionAuthClient {
|
|
|
2344
2350
|
* Creates or updates an Entity Grant. This is when a User/Entity is granted permissions to an Entity.
|
|
2345
2351
|
*
|
|
2346
2352
|
* @param {UUID} entityId The Id of the Entity that the User/Entity is being granted access to.
|
|
2347
|
-
* @param {EntityGrantRequest} request The request object that contains all
|
|
2353
|
+
* @param {EntityGrantRequest} request The request object that contains all the information used to create the Entity Grant.
|
|
2348
2354
|
* @returns {Promise<ClientResponse<void>>}
|
|
2349
2355
|
*/
|
|
2350
2356
|
upsertEntityGrant(entityId: UUID, request: EntityGrantRequest): Promise<ClientResponse<void>>;
|
|
@@ -2838,6 +2844,7 @@ export interface BaseIdentityProvider<D extends BaseIdentityProviderApplicationC
|
|
|
2838
2844
|
lastUpdateInstant?: number;
|
|
2839
2845
|
linkingStrategy?: IdentityProviderLinkingStrategy;
|
|
2840
2846
|
name?: string;
|
|
2847
|
+
tenantConfiguration?: Record<UUID, IdentityProviderTenantConfiguration>;
|
|
2841
2848
|
type?: IdentityProviderType;
|
|
2842
2849
|
}
|
|
2843
2850
|
/**
|
|
@@ -3186,12 +3193,14 @@ export interface EmailAddress {
|
|
|
3186
3193
|
* @author Brian Pontarelli
|
|
3187
3194
|
*/
|
|
3188
3195
|
export interface EmailConfiguration {
|
|
3196
|
+
additionalHeaders?: Array<EmailHeader>;
|
|
3189
3197
|
defaultFromEmail?: string;
|
|
3190
3198
|
defaultFromName?: string;
|
|
3191
3199
|
emailUpdateEmailTemplateId?: UUID;
|
|
3192
3200
|
emailVerifiedEmailTemplateId?: UUID;
|
|
3193
3201
|
forgotPasswordEmailTemplateId?: UUID;
|
|
3194
3202
|
host?: string;
|
|
3203
|
+
implicitEmailVerificationAllowed?: boolean;
|
|
3195
3204
|
loginIdInUseOnCreateEmailTemplateId?: UUID;
|
|
3196
3205
|
loginIdInUseOnUpdateEmailTemplateId?: UUID;
|
|
3197
3206
|
loginNewDeviceEmailTemplateId?: UUID;
|
|
@@ -3213,6 +3222,13 @@ export interface EmailConfiguration {
|
|
|
3213
3222
|
verifyEmail?: boolean;
|
|
3214
3223
|
verifyEmailWhenChanged?: boolean;
|
|
3215
3224
|
}
|
|
3225
|
+
/**
|
|
3226
|
+
* @author Daniel DeGroff
|
|
3227
|
+
*/
|
|
3228
|
+
export interface EmailHeader {
|
|
3229
|
+
name?: string;
|
|
3230
|
+
value?: string;
|
|
3231
|
+
}
|
|
3216
3232
|
export interface EmailPlus extends Enableable {
|
|
3217
3233
|
emailTemplateId?: UUID;
|
|
3218
3234
|
maximumTimeToSendEmailInHours?: number;
|
|
@@ -3501,6 +3517,7 @@ export interface EpicGamesIdentityProvider extends BaseIdentityProvider<EpicGame
|
|
|
3501
3517
|
*/
|
|
3502
3518
|
export interface Error {
|
|
3503
3519
|
code?: string;
|
|
3520
|
+
data?: Record<string, any>;
|
|
3504
3521
|
message?: string;
|
|
3505
3522
|
}
|
|
3506
3523
|
/**
|
|
@@ -4118,6 +4135,12 @@ export interface IdentityProviderDetails {
|
|
|
4118
4135
|
oauth2?: IdentityProviderOauth2Configuration;
|
|
4119
4136
|
type?: IdentityProviderType;
|
|
4120
4137
|
}
|
|
4138
|
+
/**
|
|
4139
|
+
* @author Daniel DeGroff
|
|
4140
|
+
*/
|
|
4141
|
+
export interface IdentityProviderLimitUserLinkingPolicy extends Enableable {
|
|
4142
|
+
maximumLinks?: number;
|
|
4143
|
+
}
|
|
4121
4144
|
/**
|
|
4122
4145
|
* @author Daniel DeGroff
|
|
4123
4146
|
*/
|
|
@@ -4225,6 +4248,13 @@ export interface IdentityProviderStartLoginRequest extends BaseLoginRequest {
|
|
|
4225
4248
|
export interface IdentityProviderStartLoginResponse {
|
|
4226
4249
|
code?: string;
|
|
4227
4250
|
}
|
|
4251
|
+
/**
|
|
4252
|
+
* @author Daniel DeGroff
|
|
4253
|
+
*/
|
|
4254
|
+
export interface IdentityProviderTenantConfiguration {
|
|
4255
|
+
data?: Record<string, any>;
|
|
4256
|
+
limitUserLinkCount?: IdentityProviderLimitUserLinkingPolicy;
|
|
4257
|
+
}
|
|
4228
4258
|
/**
|
|
4229
4259
|
* @author Daniel DeGroff
|
|
4230
4260
|
*/
|
|
@@ -4289,27 +4319,6 @@ export interface Integrations {
|
|
|
4289
4319
|
cleanspeak?: CleanSpeakConfiguration;
|
|
4290
4320
|
kafka?: KafkaConfiguration;
|
|
4291
4321
|
}
|
|
4292
|
-
/**
|
|
4293
|
-
* Counts for a period.
|
|
4294
|
-
*
|
|
4295
|
-
* @author Brian Pontarelli
|
|
4296
|
-
*/
|
|
4297
|
-
export interface IntervalCount {
|
|
4298
|
-
applicationId?: UUID;
|
|
4299
|
-
count?: number;
|
|
4300
|
-
decrementedCount?: number;
|
|
4301
|
-
period?: number;
|
|
4302
|
-
}
|
|
4303
|
-
/**
|
|
4304
|
-
* A user over an period (for daily and monthly active user calculations).
|
|
4305
|
-
*
|
|
4306
|
-
* @author Brian Pontarelli
|
|
4307
|
-
*/
|
|
4308
|
-
export interface IntervalUser {
|
|
4309
|
-
applicationId?: UUID;
|
|
4310
|
-
period?: number;
|
|
4311
|
-
userId?: UUID;
|
|
4312
|
-
}
|
|
4313
4322
|
/**
|
|
4314
4323
|
* @author Daniel DeGroff
|
|
4315
4324
|
*/
|
|
@@ -5281,7 +5290,9 @@ export interface PendingIdPLink {
|
|
|
5281
5290
|
displayName?: string;
|
|
5282
5291
|
email?: string;
|
|
5283
5292
|
identityProviderId?: UUID;
|
|
5293
|
+
identityProviderLinks?: Array<IdentityProviderLink>;
|
|
5284
5294
|
identityProviderName?: string;
|
|
5295
|
+
identityProviderTenantConfiguration?: IdentityProviderTenantConfiguration;
|
|
5285
5296
|
identityProviderType?: IdentityProviderType;
|
|
5286
5297
|
identityProviderUserId?: string;
|
|
5287
5298
|
user?: User;
|
|
@@ -5383,6 +5394,12 @@ export declare enum ReactorFeatureStatus {
|
|
|
5383
5394
|
export interface ReactorMetrics {
|
|
5384
5395
|
breachedPasswordMetrics?: Record<UUID, BreachedPasswordTenantMetric>;
|
|
5385
5396
|
}
|
|
5397
|
+
/**
|
|
5398
|
+
* @author Daniel DeGroff
|
|
5399
|
+
*/
|
|
5400
|
+
export interface ReactorMetricsResponse {
|
|
5401
|
+
metrics?: ReactorMetrics;
|
|
5402
|
+
}
|
|
5386
5403
|
/**
|
|
5387
5404
|
* Request for managing FusionAuth Reactor and licenses.
|
|
5388
5405
|
*
|
|
@@ -5396,7 +5413,6 @@ export interface ReactorRequest {
|
|
|
5396
5413
|
* @author Daniel DeGroff
|
|
5397
5414
|
*/
|
|
5398
5415
|
export interface ReactorResponse {
|
|
5399
|
-
metrics?: ReactorMetrics;
|
|
5400
5416
|
status?: ReactorStatus;
|
|
5401
5417
|
}
|
|
5402
5418
|
/**
|
|
@@ -5854,7 +5870,6 @@ export interface SystemConfiguration {
|
|
|
5854
5870
|
lastUpdateInstant?: number;
|
|
5855
5871
|
loginRecordConfiguration?: LoginRecordConfiguration;
|
|
5856
5872
|
reportTimezone?: string;
|
|
5857
|
-
ssoConfiguration?: SystemSSOConfiguration;
|
|
5858
5873
|
uiConfiguration?: UIConfiguration;
|
|
5859
5874
|
}
|
|
5860
5875
|
/**
|
|
@@ -5879,12 +5894,6 @@ export interface SystemConfigurationResponse {
|
|
|
5879
5894
|
export interface SystemLogsExportRequest extends BaseExportRequest {
|
|
5880
5895
|
lastNBytes?: number;
|
|
5881
5896
|
}
|
|
5882
|
-
/**
|
|
5883
|
-
* @author Brett Pontarelli
|
|
5884
|
-
*/
|
|
5885
|
-
export interface SystemSSOConfiguration {
|
|
5886
|
-
deviceTrustTimeToLiveInSeconds?: number;
|
|
5887
|
-
}
|
|
5888
5897
|
export interface Templates {
|
|
5889
5898
|
accountEdit?: string;
|
|
5890
5899
|
accountIndex?: string;
|
|
@@ -5957,6 +5966,7 @@ export interface Tenant {
|
|
|
5957
5966
|
passwordValidationRules?: PasswordValidationRules;
|
|
5958
5967
|
rateLimitConfiguration?: TenantRateLimitConfiguration;
|
|
5959
5968
|
registrationConfiguration?: TenantRegistrationConfiguration;
|
|
5969
|
+
ssoConfiguration?: TenantSSOConfiguration;
|
|
5960
5970
|
state?: ObjectState;
|
|
5961
5971
|
themeId?: UUID;
|
|
5962
5972
|
userDeletePolicy?: TenantUserDeletePolicy;
|
|
@@ -6044,6 +6054,12 @@ export interface TenantResponse {
|
|
|
6044
6054
|
tenant?: Tenant;
|
|
6045
6055
|
tenants?: Array<Tenant>;
|
|
6046
6056
|
}
|
|
6057
|
+
/**
|
|
6058
|
+
* @author Brett Pontarelli
|
|
6059
|
+
*/
|
|
6060
|
+
export interface TenantSSOConfiguration {
|
|
6061
|
+
deviceTrustTimeToLiveInSeconds?: number;
|
|
6062
|
+
}
|
|
6047
6063
|
/**
|
|
6048
6064
|
* @author Daniel DeGroff
|
|
6049
6065
|
*/
|