diff --git a/build.savant b/build.savant
index 68992a0..5ecb81c 100644
--- a/build.savant
+++ b/build.savant
@@ -14,7 +14,7 @@
* language governing permissions and limitations under the License.
*/
-project(group: "io.fusionauth", name: "fusionauth-typescript-client", version: "1.53.3", licenses: ["ApacheV2_0"]) {
+project(group: "io.fusionauth", name: "fusionauth-typescript-client", version: "1.54.0", licenses: ["ApacheV2_0"]) {
workflow {
fetch {
cache()
diff --git a/package-lock.json b/package-lock.json
index eb6e5e3..3e79744 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,6 +1,6 @@
{
"name": "@fusionauth/typescript-client",
- "version": "1.53.3",
+ "version": "1.54.0",
"lockfileVersion": 3,
"requires": true,
"packages": {
diff --git a/package.json b/package.json
index 0eb7d47..2384d9b 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "@fusionauth/typescript-client",
- "version": "1.53.3",
+ "version": "1.54.0",
"description": "A typescript implementation of the FusionAuth client.",
"main": "build/index.js",
"types": "build/index.d.ts",
diff --git a/src/FusionAuthClient.ts b/src/FusionAuthClient.ts
index ae8610e..f943881 100644
--- a/src/FusionAuthClient.ts
+++ b/src/FusionAuthClient.ts
@@ -5489,887 +5489,829 @@ export type UUID = string;
/**
- * Authorization Grant types as defined by the The OAuth 2.0 Authorization
- * Framework - RFC 6749.
- *
- * Specific names as defined by
- * OAuth 2.0 Dynamic Client Registration Protocol - RFC 7591 Section 4.1
+ * Webhook attempt log response.
*
- * @author Daniel DeGroff
+ * @author Spencer Witt
*/
-export enum GrantType {
- authorization_code = "authorization_code",
- implicit = "implicit",
- password = "password",
- client_credentials = "client_credentials",
- refresh_token = "refresh_token",
- unknown = "unknown",
- device_code = "urn:ietf:params:oauth:grant-type:device_code"
+export interface WebhookAttemptLogResponse {
+ webhookAttemptLog?: WebhookAttemptLog;
}
/**
- * Used to indicate what type of attestation was included in the authenticator response for a given WebAuthn credential at the time it was created
- *
- * @author Spencer Witt
+ * @author Rob Davis
*/
-export enum AttestationType {
- basic = "basic",
- self = "self",
- attestationCa = "attestationCa",
- anonymizationCa = "anonymizationCa",
- none = "none"
+export interface TenantLambdaConfiguration {
+ loginValidationId?: UUID;
+ scimEnterpriseUserRequestConverterId?: UUID;
+ scimEnterpriseUserResponseConverterId?: UUID;
+ scimGroupRequestConverterId?: UUID;
+ scimGroupResponseConverterId?: UUID;
+ scimUserRequestConverterId?: UUID;
+ scimUserResponseConverterId?: UUID;
+}
+
+export interface SAMLv2AssertionEncryptionConfiguration extends Enableable {
+ digestAlgorithm?: string;
+ encryptionAlgorithm?: string;
+ keyLocation?: string;
+ keyTransportAlgorithm?: string;
+ keyTransportEncryptionKeyId?: UUID;
+ maskGenerationFunction?: string;
}
/**
- * Identity Provider response.
+ * Models action reasons.
*
- * @author Spencer Witt
+ * @author Brian Pontarelli
*/
-export interface IdentityProviderSearchResponse {
- identityProviders?: Array>;
- total?: number;
+export interface UserActionReason {
+ code?: string;
+ id?: UUID;
+ insertInstant?: number;
+ lastUpdateInstant?: number;
+ localizedTexts?: LocalizedStrings;
+ text?: string;
}
-/**
- * @author Daniel DeGroff
- */
-export interface BaseExportRequest {
- dateTimeSecondsFormat?: string;
- zoneId?: string;
+export interface AuthenticationTokenConfiguration extends Enableable {
}
/**
- * Models the User Created Registration Event.
- *
- * This is different than the user.registration.create event in that it will be sent after the user has been created. This event cannot be made
- * transactional.
+ * Event to indicate an audit log was created.
*
* @author Daniel DeGroff
*/
-export interface UserRegistrationCreateCompleteEvent extends BaseUserEvent {
- applicationId?: UUID;
- registration?: UserRegistration;
+export interface AuditLogCreateEvent extends BaseEvent {
+ auditLog?: AuditLog;
}
/**
- * The user action response object.
+ * Models the FusionAuth connector.
*
- * @author Brian Pontarelli
- */
-export interface ActionResponse {
- action?: UserActionLog;
- actions?: Array;
-}
-
-/**
- * @author Michael Sleevi
+ * @author Trevor Smith
*/
-export interface SMSMessage {
- phoneNumber?: string;
- textMessage?: string;
+export interface FusionAuthConnectorConfiguration extends BaseConnectorConfiguration {
}
/**
- * @author Daniel DeGroff
+ * @author Brian Pontarelli
*/
-export interface MessengerTransport {
+export interface AuditLogRequest extends BaseEventRequest {
+ auditLog?: AuditLog;
}
/**
- * User registration information for a single application.
- *
- * @author Brian Pontarelli
+ * @author Brett Guy
*/
-export interface UserRegistration {
- applicationId?: UUID;
- authenticationToken?: string;
- cleanSpeakId?: UUID;
+export interface IPAccessControlList {
data?: Record;
+ entries?: Array;
id?: UUID;
insertInstant?: number;
- lastLoginInstant?: number;
lastUpdateInstant?: number;
- preferredLanguages?: Array;
- roles?: Array;
- timezone?: string;
- tokens?: Record;
- username?: string;
- usernameStatus?: ContentStatus;
- verified?: boolean;
- verifiedInstant?: number;
+ name?: string;
}
/**
- * Base class for requests that can contain event information. This event information is used when sending Webhooks or emails
- * during the transaction. The caller is responsible for ensuring that the event information is correct.
- *
- * @author Brian Pontarelli
+ * @author Lyle Schemmerling
*/
-export interface BaseEventRequest {
- eventInfo?: EventInfo;
+export interface SAMLv2DestinationAssertionConfiguration {
+ alternates?: Array;
+ policy?: SAMLv2DestinationAssertionPolicy;
}
/**
- * A webhook call attempt log.
+ * Form response.
*
- * @author Spencer Witt
+ * @author Daniel DeGroff
*/
-export interface WebhookAttemptLog {
- attemptResult?: WebhookAttemptResult;
- data?: Record;
- endInstant?: number;
- id?: UUID;
- startInstant?: number;
- webhookCallResponse?: WebhookCallResponse;
- webhookEventLogId?: UUID;
- webhookId?: UUID;
+export interface FormRequest {
+ form?: Form;
}
/**
- * @author Daniel DeGroff
+ * @author Seth Musselman
*/
-export interface JWTVendRequest {
- claims?: Record;
- keyId?: UUID;
- timeToLiveInSeconds?: number;
+export interface UserCommentRequest {
+ userComment?: UserComment;
}
/**
- * Event log used internally by FusionAuth to help developers debug hooks, Webhooks, email templates, etc.
+ * IdP Initiated login configuration
*
- * @author Brian Pontarelli
+ * @author Daniel DeGroff
*/
-export interface EventLog {
- id?: number;
- insertInstant?: number;
- message?: string;
- type?: EventLogType;
+export interface SAMLv2IdPInitiatedLoginConfiguration extends Enableable {
+ nameIdFormat?: string;
+}
+
+export interface DeleteConfiguration extends Enableable {
+ numberOfDaysToRetain?: number;
}
/**
* @author Daniel DeGroff
*/
-export interface LookupResponse {
- identityProvider?: IdentityProviderDetails;
+export enum FormDataType {
+ bool = "bool",
+ consent = "consent",
+ date = "date",
+ email = "email",
+ number = "number",
+ string = "string"
}
-export interface IdentityProviderDetails {
- applicationIds?: Array;
- id?: UUID;
- idpEndpoint?: string;
- name?: string;
- oauth2?: IdentityProviderOauth2Configuration;
- type?: IdentityProviderType;
+/**
+ * Key search response
+ *
+ * @author Spencer Witt
+ */
+export interface KeySearchResponse {
+ keys?: Array;
+ total?: number;
}
/**
- * @author Daniel DeGroff
+ * A Application-level policy for deleting Users.
+ *
+ * @author Trevor Smith
*/
-export interface IntrospectResponse extends Record {
+export interface ApplicationRegistrationDeletePolicy {
+ unverified?: TimeBasedDeletePolicy;
}
/**
- * Models the Group Member Update Event.
+ * Models the User Delete Registration Event.
*
* @author Daniel DeGroff
*/
-export interface GroupMemberUpdateEvent extends BaseGroupEvent {
- members?: Array;
+export interface UserRegistrationDeleteEvent extends BaseUserEvent {
+ applicationId?: UUID;
+ registration?: UserRegistration;
}
/**
- * Search request for webhooks
- *
- * @author Spencer Witt
+ * @author Daniel DeGroff
*/
-export interface WebhookSearchRequest {
- search?: WebhookSearchCriteria;
+export interface AccessToken {
+ access_token?: string;
+ expires_in?: number;
+ id_token?: string;
+ refresh_token?: string;
+ refresh_token_id?: UUID;
+ scope?: string;
+ token_type?: TokenType;
+ userId?: UUID;
}
/**
- * Change password response object.
+ * Search request for Group Members.
*
* @author Daniel DeGroff
*/
-export interface ChangePasswordResponse {
- oneTimePassword?: string;
- state?: Record;
+export interface GroupMemberSearchRequest {
+ search?: GroupMemberSearchCriteria;
+}
+
+export interface MultiFactorSMSTemplate {
+ templateId?: UUID;
}
/**
- * A server where events are sent. This includes user action events and any other events sent by FusionAuth.
+ * A log for an event that happened to a User.
*
* @author Brian Pontarelli
*/
-export interface Webhook {
- connectTimeout?: number;
- data?: Record;
- description?: string;
- eventsEnabled?: Record;
- global?: boolean;
- headers?: HTTPHeaders;
- httpAuthenticationPassword?: string;
- httpAuthenticationUsername?: string;
+export interface UserComment {
+ comment?: string;
+ commenterId?: UUID;
id?: UUID;
insertInstant?: number;
- lastUpdateInstant?: number;
- readTimeout?: number;
- signatureConfiguration?: WebhookSignatureConfiguration;
- sslCertificate?: string;
- sslCertificateKeyId?: UUID;
- tenantIds?: Array;
- url?: string;
+ userId?: UUID;
}
/**
- * Available Integrations
+ * Models the Group Create Complete Event.
*
* @author Daniel DeGroff
*/
-export interface Integrations {
- cleanspeak?: CleanSpeakConfiguration;
- kafka?: KafkaConfiguration;
+export interface GroupDeleteCompleteEvent extends BaseGroupEvent {
}
/**
- * Search criteria for the event log.
+ * Email template search response
*
- * @author Brian Pontarelli
+ * @author Mark Manes
*/
-export interface EventLogSearchCriteria extends BaseSearchCriteria {
- end?: number;
- message?: string;
- start?: number;
- type?: EventLogType;
+export interface EmailTemplateSearchResponse {
+ emailTemplates?: Array;
+ total?: number;
}
/**
- * @author Brian Pontarelli
+ * A marker interface indicating this event is not scoped to a tenant and will be sent to all webhooks.
+ *
+ * @author Daniel DeGroff
*/
-export interface EmailConfiguration {
- additionalHeaders?: Array;
- debug?: boolean;
- defaultFromEmail?: string;
- defaultFromName?: string;
- emailUpdateEmailTemplateId?: UUID;
- emailVerifiedEmailTemplateId?: UUID;
- forgotPasswordEmailTemplateId?: UUID;
- host?: string;
- implicitEmailVerificationAllowed?: boolean;
- loginIdInUseOnCreateEmailTemplateId?: UUID;
- loginIdInUseOnUpdateEmailTemplateId?: UUID;
- loginNewDeviceEmailTemplateId?: UUID;
- loginSuspiciousEmailTemplateId?: UUID;
- password?: string;
- passwordlessEmailTemplateId?: UUID;
- passwordResetSuccessEmailTemplateId?: UUID;
- passwordUpdateEmailTemplateId?: UUID;
- port?: number;
- properties?: string;
- security?: EmailSecurityType;
- setPasswordEmailTemplateId?: UUID;
- twoFactorMethodAddEmailTemplateId?: UUID;
- twoFactorMethodRemoveEmailTemplateId?: UUID;
- unverified?: EmailUnverifiedOptions;
- username?: string;
- verificationEmailTemplateId?: UUID;
- verificationStrategy?: VerificationStrategy;
- verifyEmail?: boolean;
- verifyEmailWhenChanged?: boolean;
-}
-
-export enum EmailSecurityType {
- NONE = "NONE",
- SSL = "SSL",
- TLS = "TLS"
+export interface InstanceEvent extends NonTransactionalEvent {
}
/**
- * @author Brett Pontarelli
+ * Models the user action Event.
+ *
+ * @author Brian Pontarelli
*/
-export interface TwitchApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
- buttonText?: string;
- client_id?: string;
- client_secret?: string;
- scope?: string;
+export interface UserActionEvent extends BaseEvent {
+ action?: string;
+ actioneeUserId?: UUID;
+ actionerUserId?: UUID;
+ actionId?: UUID;
+ applicationIds?: Array;
+ comment?: string;
+ email?: Email;
+ emailedUser?: boolean;
+ expiry?: number;
+ localizedAction?: string;
+ localizedDuration?: string;
+ localizedOption?: string;
+ localizedReason?: string;
+ notifyUser?: boolean;
+ option?: string;
+ phase?: UserActionPhase;
+ reason?: string;
+ reasonCode?: string;
}
/**
- * @author Brett Pontarelli
+ * @author Daniel DeGroff
*/
-export interface XboxApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
- buttonText?: string;
- client_id?: string;
- client_secret?: string;
- scope?: string;
+export enum BreachedPasswordStatus {
+ None = "None",
+ ExactMatch = "ExactMatch",
+ SubAddressMatch = "SubAddressMatch",
+ PasswordOnly = "PasswordOnly",
+ CommonPassword = "CommonPassword"
}
/**
- * Models a generic connector.
- *
- * @author Trevor Smith
+ * @author Michael Sleevi
*/
-export interface GenericConnectorConfiguration extends BaseConnectorConfiguration {
- authenticationURL?: string;
- connectTimeout?: number;
- headers?: HTTPHeaders;
- httpAuthenticationPassword?: string;
- httpAuthenticationUsername?: string;
- readTimeout?: number;
- sslCertificateKeyId?: UUID;
+export interface SMSMessage {
+ phoneNumber?: string;
+ textMessage?: string;
}
/**
- * An Event "event" to indicate an event log was created.
- *
* @author Daniel DeGroff
*/
-export interface EventLogCreateEvent extends BaseEvent {
- eventLog?: EventLog;
+export interface TwitterApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
+ buttonText?: string;
+ consumerKey?: string;
+ consumerSecret?: string;
}
/**
- * @author Brian Pontarelli
+ * A User's WebAuthnCredential. Contains all data required to complete WebAuthn authentication ceremonies.
+ *
+ * @author Spencer Witt
*/
-export interface SystemConfiguration {
- auditLogConfiguration?: AuditLogConfiguration;
- corsConfiguration?: CORSConfiguration;
+export interface WebAuthnCredential {
+ algorithm?: CoseAlgorithmIdentifier;
+ attestationType?: AttestationType;
+ authenticatorSupportsUserVerification?: boolean;
+ credentialId?: string;
data?: Record;
- eventLogConfiguration?: EventLogConfiguration;
+ discoverable?: boolean;
+ displayName?: string;
+ id?: UUID;
insertInstant?: number;
- lastUpdateInstant?: number;
- loginRecordConfiguration?: LoginRecordConfiguration;
- reportTimezone?: string;
- trustedProxyConfiguration?: SystemTrustedProxyConfiguration;
- uiConfiguration?: UIConfiguration;
- webhookEventLogConfiguration?: WebhookEventLogConfiguration;
-}
-
-export interface AuditLogConfiguration {
- delete?: DeleteConfiguration;
-}
-
-export interface DeleteConfiguration extends Enableable {
- numberOfDaysToRetain?: number;
-}
-
-export interface EventLogConfiguration {
- numberToRetain?: number;
-}
-
-export interface LoginRecordConfiguration {
- delete?: DeleteConfiguration;
+ lastUseInstant?: number;
+ name?: string;
+ publicKey?: string;
+ relyingPartyId?: string;
+ signCount?: number;
+ tenantId?: UUID;
+ transports?: Array;
+ userAgent?: string;
+ userId?: UUID;
}
-export interface UIConfiguration {
- headerColor?: string;
- logoURL?: string;
- menuFontColor?: string;
+export interface LambdaConfiguration {
+ accessTokenPopulateId?: UUID;
+ idTokenPopulateId?: UUID;
+ samlv2PopulateId?: UUID;
+ selfServiceRegistrationValidationId?: UUID;
+ userinfoPopulateId?: UUID;
}
/**
* @author Daniel DeGroff
*/
-export interface TenantUsernameConfiguration {
- unique?: UniqueUsernameConfiguration;
-}
-
-export enum UniqueUsernameStrategy {
- Always = "Always",
- OnCollision = "OnCollision"
+export interface RegistrationUnverifiedOptions {
+ behavior?: UnverifiedBehavior;
}
-export interface UniqueUsernameConfiguration extends Enableable {
- numberOfDigits?: number;
- separator?: string;
- strategy?: UniqueUsernameStrategy;
+/**
+ * Models a consent.
+ *
+ * @author Daniel DeGroff
+ */
+export enum ConsentStatus {
+ Active = "Active",
+ Revoked = "Revoked"
}
/**
- * Consent search response
+ * Contains the output for the {@code credProps} extension
*
* @author Spencer Witt
*/
-export interface ConsentSearchResponse {
- consents?: Array;
- total?: number;
+export interface CredentialPropertiesOutput {
+ rk?: boolean;
}
/**
- *
- *
* @author Daniel DeGroff
*/
-export enum TokenType {
- Bearer = "Bearer",
- MAC = "MAC"
+export interface VerifyRegistrationRequest extends BaseEventRequest {
+ oneTimeCode?: string;
+ verificationId?: string;
}
/**
- * A grant for an entity to a user or another entity.
+ * @author Daniel DeGroff
+ */
+export interface UserinfoResponse extends Record {
+}
+
+/**
+ * Stores an email template used to send emails to users.
*
* @author Brian Pontarelli
*/
-export interface EntityGrant {
- data?: Record;
- entity?: Entity;
+export interface EmailTemplate {
+ defaultFromName?: string;
+ defaultHtmlTemplate?: string;
+ defaultSubject?: string;
+ defaultTextTemplate?: string;
+ fromEmail?: string;
id?: UUID;
insertInstant?: number;
lastUpdateInstant?: number;
- permissions?: Array;
- recipientEntityId?: UUID;
- userId?: UUID;
+ localizedFromNames?: LocalizedStrings;
+ localizedHtmlTemplates?: LocalizedStrings;
+ localizedSubjects?: LocalizedStrings;
+ localizedTextTemplates?: LocalizedStrings;
+ name?: string;
}
/**
- * Search criteria for user comments.
+ * Models the User Email Verify Event.
*
- * @author Spencer Witt
+ * @author Trevor Smith
*/
-export interface UserCommentSearchCriteria extends BaseSearchCriteria {
- comment?: string;
- commenterId?: UUID;
- tenantId?: UUID;
- userId?: UUID;
+export interface UserEmailVerifiedEvent extends BaseUserEvent {
}
/**
- * @author Derek Klatt
+ * @author Daniel DeGroff
*/
-export interface PasswordValidationRules {
- breachDetection?: PasswordBreachDetection;
- maxLength?: number;
- minLength?: number;
- rememberPreviousPasswords?: RememberPreviousPasswords;
- requireMixedCase?: boolean;
- requireNonAlpha?: boolean;
- requireNumber?: boolean;
- validateOnLogin?: boolean;
+export interface ApplicationAccessControlConfiguration {
+ uiIPAccessControlListId?: UUID;
}
/**
- * Models the User Email Verify Event.
+ * Form response.
*
- * @author Trevor Smith
+ * @author Daniel DeGroff
*/
-export interface UserEmailVerifiedEvent extends BaseUserEvent {
+export interface FormResponse {
+ form?: Form;
+ forms?: Array