@fusionauth/typescript-client 1.54.0 → 1.56.0

package/build/src/FusionAuthClient.d.ts

@@ -2829,15 +2829,6 @@ export declare enum GrantType {
     unknown = "unknown",
     device_code = "urn:ietf:params:oauth:grant-type:device_code"
 }
-/**
- * Identity Provider response.
- *
- * @author Spencer Witt
- */
-export interface IdentityProviderSearchResponse {
-    identityProviders?: Array<BaseIdentityProvider<any>>;
-    total?: number;
-}
 /**
  * Used to indicate what type of attestation was included in the authenticator response for a given WebAuthn credential at the time it was created
  *
@@ -2850,6 +2841,15 @@ export declare enum AttestationType {
     anonymizationCa = "anonymizationCa",
     none = "none"
 }
+/**
+ * Identity Provider response.
+ *
+ * @author Spencer Witt
+ */
+export interface IdentityProviderSearchResponse {
+    identityProviders?: Array<BaseIdentityProvider<any>>;
+    total?: number;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -3137,6 +3137,7 @@ export interface SystemConfiguration {
     reportTimezone?: string;
     trustedProxyConfiguration?: SystemTrustedProxyConfiguration;
     uiConfiguration?: UIConfiguration;
+    usageDataConfiguration?: UsageDataConfiguration;
     webhookEventLogConfiguration?: WebhookEventLogConfiguration;
 }
 export interface AuditLogConfiguration {
@@ -3568,16 +3569,6 @@ export declare enum CoseAlgorithmIdentifier {
  */
 export interface UserinfoResponse extends Record<string, any> {
 }
-/**
- * @author Brett Pontarelli
- */
-export interface SteamApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
-    apiMode?: SteamAPIMode;
-    buttonText?: string;
-    client_id?: string;
-    scope?: string;
-    webAPIKey?: string;
-}
 /**
  * @author Daniel DeGroff
  */
@@ -3589,6 +3580,16 @@ export interface TwoFactorSendRequest {
     mobilePhone?: string;
     userId?: UUID;
 }
+/**
+ * @author Brett Pontarelli
+ */
+export interface SteamApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
+    apiMode?: SteamAPIMode;
+    buttonText?: string;
+    client_id?: string;
+    scope?: string;
+    webAPIKey?: string;
+}
 /**
  * Search criteria for Email templates
  *
@@ -3930,6 +3931,13 @@ export interface SendRequest {
     toAddresses?: Array<EmailAddress>;
     userIds?: Array<UUID>;
 }
+/**
+ * @author Michael Sleevi
+ */
+export interface MessageTemplateResponse {
+    messageTemplate?: MessageTemplate;
+    messageTemplates?: Array<MessageTemplate>;
+}
 /**
  * Identifies the WebAuthn workflow. This will affect the parameters used for credential creation
  * and request based on the Tenant configuration.
@@ -3941,13 +3949,6 @@ export declare enum WebAuthnWorkflow {
     general = "general",
     reauthentication = "reauthentication"
 }
-/**
- * @author Michael Sleevi
- */
-export interface MessageTemplateResponse {
-    messageTemplate?: MessageTemplate;
-    messageTemplates?: Array<MessageTemplate>;
-}
 /**
  * Models a consent.
  *
@@ -4054,6 +4055,14 @@ export interface Email {
 export interface LambdaSearchRequest {
     search?: LambdaSearchCriteria;
 }
+/**
+ * Config for Usage Data / Stats
+ *
+ * @author Lyle Schemmerling
+ */
+export interface UsageDataConfiguration extends Enableable {
+    numberOfDaysToRetain?: number;
+}
 /**
  * User login failed reason codes.
  */
@@ -4174,6 +4183,14 @@ export declare enum UserState {
 export interface WebhookEventLogConfiguration {
     delete?: DeleteConfiguration;
 }
+/**
+ * Model a user event when a two-factor method has been removed.
+ *
+ * @author Daniel DeGroff
+ */
+export interface UserTwoFactorMethodAddEvent extends BaseUserEvent {
+    method?: TwoFactorMethod;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -4183,14 +4200,6 @@ export interface LinkedInApplicationConfiguration extends BaseIdentityProviderAp
     client_secret?: string;
     scope?: string;
 }
-/**
- * Model a user event when a two-factor method has been removed.
- *
- * @author Daniel DeGroff
- */
-export interface UserTwoFactorMethodAddEvent extends BaseUserEvent {
-    method?: TwoFactorMethod;
-}
 /**
  * @author Lyle Schemmerling
  */
@@ -4308,6 +4317,15 @@ export interface EventConfiguration {
 export interface EventConfigurationData extends Enableable {
     transactionType?: TransactionType;
 }
+/**
+ * Refresh token one-time use configuration. This configuration is utilized when the usage policy is
+ * configured for one-time use.
+ *
+ * @author Daniel DeGroff
+ */
+export interface RefreshTokenOneTimeUseConfiguration {
+    gracePeriodInSeconds?: number;
+}
 /**
  * Models the User Deactivate Event.
  *
@@ -4399,13 +4417,6 @@ export interface Enableable {
 export interface GroupMemberAddEvent extends BaseGroupEvent {
     members?: Array<GroupMember>;
 }
-/**
- * The public Status API response
- *
- * @author Daniel DeGroff
- */
-export interface StatusResponse extends Record<string, any> {
-}
 /**
  * Models the User Password Reset Success Event.
  *
@@ -4421,6 +4432,13 @@ export declare enum RefreshTokenExpirationPolicy {
     SlidingWindow = "SlidingWindow",
     SlidingWindowWithMaximumLifetime = "SlidingWindowWithMaximumLifetime"
 }
+/**
+ * The public Status API response
+ *
+ * @author Daniel DeGroff
+ */
+export interface StatusResponse extends Record<string, any> {
+}
 /**
  * @author Brett Guy
  */
@@ -4656,6 +4674,12 @@ export interface UserConsent {
     userId?: UUID;
     values?: Array<string>;
 }
+/**
+ * @author Daniel DeGroff
+ */
+export interface IdentityProviderStartLoginResponse {
+    code?: string;
+}
 /**
  * Twitch gaming login provider.
  *
@@ -4667,12 +4691,6 @@ export interface TwitchIdentityProvider extends BaseIdentityProvider<TwitchAppli
     client_secret?: string;
     scope?: string;
 }
-/**
- * @author Daniel DeGroff
- */
-export interface IdentityProviderStartLoginResponse {
-    code?: string;
-}
 /**
  * Form response.
  *
@@ -4952,14 +4970,6 @@ export interface GroupSearchCriteria extends BaseSearchCriteria {
  */
 export interface UserDeleteCompleteEvent extends BaseUserEvent {
 }
-/**
- * @author Daniel DeGroff
- */
-export interface SortField {
-    missing?: string;
-    name?: string;
-    order?: Sort;
-}
 /**
  * Request to complete the WebAuthn registration ceremony for a new credential,.
  *
@@ -4971,6 +4981,14 @@ export interface WebAuthnRegisterCompleteRequest {
     rpId?: string;
     userId?: UUID;
 }
+/**
+ * @author Daniel DeGroff
+ */
+export interface SortField {
+    missing?: string;
+    name?: string;
+    order?: Sort;
+}
 /**
  * Search criteria for Lambdas
  *
@@ -5455,6 +5473,21 @@ export interface FormStep {
 export interface EntityTypeSearchCriteria extends BaseSearchCriteria {
     name?: string;
 }
+/**
+ * Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
+ *
+ * @author Brian Pontarelli
+ */
+export interface EventInfo {
+    data?: Record<string, any>;
+    deviceDescription?: string;
+    deviceName?: string;
+    deviceType?: string;
+    ipAddress?: string;
+    location?: Location;
+    os?: string;
+    userAgent?: string;
+}
 /**
  * Search criteria for Group Members
  *
@@ -5755,21 +5788,6 @@ export declare enum ApplicationMultiFactorTrustPolicy {
 export interface MaximumPasswordAge extends Enableable {
     days?: number;
 }
-/**
- * Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
- *
- * @author Brian Pontarelli
- */
-export interface EventInfo {
-    data?: Record<string, any>;
-    deviceDescription?: string;
-    deviceName?: string;
-    deviceType?: string;
-    ipAddress?: string;
-    location?: Location;
-    os?: string;
-    userAgent?: string;
-}
 /**
  * @author Daniel DeGroff
  */
@@ -5797,6 +5815,14 @@ export declare enum LambdaEngineType {
     GraalJS = "GraalJS",
     Nashorn = "Nashorn"
 }
+/**
+ * API response for starting a WebAuthn authentication ceremony
+ *
+ * @author Spencer Witt
+ */
+export interface WebAuthnStartResponse {
+    options?: PublicKeyCredentialRequestOptions;
+}
 /**
  * SAML v2 identity provider configuration.
  *
@@ -5817,14 +5843,6 @@ export interface SAMLv2IdentityProvider extends BaseSAMLv2IdentityProvider<SAMLv
     signRequest?: boolean;
     xmlSignatureC14nMethod?: CanonicalizationMethod;
 }
-/**
- * API response for starting a WebAuthn authentication ceremony
- *
- * @author Spencer Witt
- */
-export interface WebAuthnStartResponse {
-    options?: PublicKeyCredentialRequestOptions;
-}
 /**
  * Search request for entity types.
  *
@@ -5997,6 +6015,7 @@ export interface JWTConfiguration extends Enableable {
     accessTokenKeyId?: UUID;
     idTokenKeyId?: UUID;
     refreshTokenExpirationPolicy?: RefreshTokenExpirationPolicy;
+    refreshTokenOneTimeUseConfiguration?: RefreshTokenOneTimeUseConfiguration;
     refreshTokenRevocationPolicy?: RefreshTokenRevocationPolicy;
     refreshTokenSlidingWindowConfiguration?: RefreshTokenSlidingWindowConfiguration;
     refreshTokenTimeToLiveInMinutes?: number;
@@ -6081,17 +6100,6 @@ export declare enum UserVerificationRequirement {
  */
 export interface SupportsPostBindings {
 }
-/**
- * @author Brian Pontarelli
- */
-export declare enum ExpiryUnit {
-    MINUTES = "MINUTES",
-    HOURS = "HOURS",
-    DAYS = "DAYS",
-    WEEKS = "WEEKS",
-    MONTHS = "MONTHS",
-    YEARS = "YEARS"
-}
 /**
  * Search response for Themes
  *
@@ -6297,6 +6305,17 @@ export interface WebAuthnLoginRequest extends BaseLoginRequest {
     rpId?: string;
     twoFactorTrustId?: string;
 }
+/**
+ * @author Brian Pontarelli
+ */
+export declare enum ExpiryUnit {
+    MINUTES = "MINUTES",
+    HOURS = "HOURS",
+    DAYS = "DAYS",
+    WEEKS = "WEEKS",
+    MONTHS = "MONTHS",
+    YEARS = "YEARS"
+}
 /**
  * The Application API request object.
  *
@@ -6576,6 +6595,14 @@ export interface PublicKeyResponse {
 export interface RecentLoginResponse {
     logins?: Array<DisplayableRawLogin>;
 }
+/**
+ * Container for the event information. This is the JSON that is sent from FusionAuth to webhooks.
+ *
+ * @author Brian Pontarelli
+ */
+export interface EventRequest {
+    event?: BaseEvent;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -6602,15 +6629,6 @@ export declare enum SecureGeneratorType {
 export interface EntityGrantRequest {
     grant?: EntityGrant;
 }
-/**
- * Something that can be required and thus also optional. This currently extends Enableable because anything that is
- * required/optional is almost always enableable as well.
- *
- * @author Brian Pontarelli
- */
-export interface Requirable extends Enableable {
-    required?: boolean;
-}
 /**
  * Models the User Login Failed Event.
  *
@@ -6690,14 +6708,6 @@ export interface EntityTypeSearchResponse {
     entityTypes?: Array<EntityType>;
     total?: number;
 }
-/**
- * Container for the event information. This is the JSON that is sent from FusionAuth to webhooks.
- *
- * @author Brian Pontarelli
- */
-export interface EventRequest {
-    event?: BaseEvent;
-}
 /**
  * Search criteria for webhooks.
  *
@@ -6829,6 +6839,15 @@ export interface TwoFactorRequest extends BaseEventRequest {
     secretBase32Encoded?: string;
     twoFactorId?: string;
 }
+/**
+ * Something that can be required and thus also optional. This currently extends Enableable because anything that is
+ * required/optional is almost always enableable as well.
+ *
+ * @author Brian Pontarelli
+ */
+export interface Requirable extends Enableable {
+    required?: boolean;
+}
 /**
  * @author Daniel DeGroff
  */
@@ -7148,10 +7167,19 @@ export interface LoginRecordSearchRequest {
  */
 export interface UserCreateEvent extends BaseUserEvent {
 }
+/**
+ * User Action Reason API request object.
+ *
+ * @author Brian Pontarelli
+ */
+export interface UserActionReasonRequest {
+    userActionReason?: UserActionReason;
+}
 /**
  * @author Lyle Schemmerling
  */
 export interface BaseSAMLv2IdentityProvider<D extends BaseIdentityProviderApplicationConfiguration> extends BaseIdentityProvider<D> {
+    assertionDecryptionConfiguration?: SAMLv2AssertionDecryptionConfiguration;
     emailClaim?: string;
     keyId?: UUID;
     uniqueIdClaim?: string;
@@ -7166,14 +7194,6 @@ export interface BaseSAMLv2IdentityProvider<D extends BaseIdentityProviderApplic
 export interface WebAuthnRegistrationExtensionOptions {
     credProps?: boolean;
 }
-/**
- * User Action Reason API request object.
- *
- * @author Brian Pontarelli
- */
-export interface UserActionReasonRequest {
-    userActionReason?: UserActionReason;
-}
 /**
  * @author Daniel DeGroff
  */
@@ -8044,6 +8064,7 @@ export interface IdentityProviderSearchRequest {
 export interface RefreshTokenRevocationPolicy {
     onLoginPrevented?: boolean;
     onMultiFactorEnable?: boolean;
+    onOneTimeTokenReuse?: boolean;
     onPasswordChanged?: boolean;
 }
 /**
@@ -8118,6 +8139,7 @@ export interface GroupCreateCompleteEvent extends BaseGroupEvent {
  * @author Brett Pontarelli
  */
 export interface TenantSSOConfiguration {
+    allowAccessTokenBootstrap?: boolean;
     deviceTrustTimeToLiveInSeconds?: number;
 }
 /**
@@ -8371,6 +8393,14 @@ export interface WebAuthnCredential {
 export interface TestEvent extends BaseEvent {
     message?: string;
 }
+/**
+ * Configuration for encrypted assertions when acting as SAML Service Provider
+ *
+ * @author Jaret Hendrickson
+ */
+export interface SAMLv2AssertionDecryptionConfiguration extends Enableable {
+    keyTransportDecryptionKeyId?: UUID;
+}
 /**
  * Models the Refresh Token Revoke Event. This event might be for a single token, a user
  * or an entire application.
@@ -8433,6 +8463,11 @@ export interface UserDeleteRequest extends BaseEventRequest {
 export interface TenantAccessControlConfiguration {
     uiIPAccessControlListId?: UUID;
 }
+/**
+ * Interface for any object that can provide JSON Web key Information.
+ */
+export interface JSONWebKeyInfoProvider {
+}
 /**
  * This class is a simple attachment with a byte array, name and MIME type.
  *
@@ -8443,11 +8478,6 @@ export interface Attachment {
     mime?: string;
     name?: string;
 }
-/**
- * Interface for any object that can provide JSON Web key Information.
- */
-export interface JSONWebKeyInfoProvider {
-}
 /**
  * Tenant-level configuration for WebAuthn
  *
@@ -8514,6 +8544,7 @@ export interface IdentityProviderLink {
  */
 export interface RegistrationResponse {
     refreshToken?: string;
+    refreshTokenId?: UUID;
     registration?: UserRegistration;
     registrationVerificationId?: string;
     registrationVerificationOneTimeCode?: string;
@@ -8695,6 +8726,7 @@ export interface AuditLogResponse {
  * @author sanjay
  */
 export interface APIKey {
+    expirationInstant?: number;
     id?: UUID;
     insertInstant?: number;
     ipAccessControlListId?: UUID;
@@ -8702,7 +8734,9 @@ export interface APIKey {
     keyManager?: boolean;
     lastUpdateInstant?: number;
     metaData?: APIKeyMetaData;
+    name?: string;
     permissions?: APIKeyPermissions;
+    retrievable?: boolean;
     tenantId?: UUID;
 }
 export interface APIKeyMetaData {

package/build/src/FusionAuthClient.js

@@ -15,7 +15,7 @@
 * language governing permissions and limitations under the License.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Algorithm = exports.ClientAuthenticationMethod = exports.OAuthApplicationRelationship = exports.UnknownScopePolicy = exports.EventType = exports.CaptchaMethod = exports.SteamAPIMode = exports.AuthenticationThreats = exports.TOTPAlgorithm = exports.VerificationStrategy = exports.IdentityProviderType = exports.ObjectState = exports.OAuthScopeConsentMode = exports.KeyType = exports.KeyAlgorithm = exports.CoseEllipticCurve = exports.PublicKeyCredentialType = exports.AuthenticatorAttachmentPreference = exports.Sort = exports.XMLSignatureLocation = exports.SAMLLogoutBehavior = exports.RegistrationType = exports.LoginIdType = exports.SystemTrustedProxyConfigurationPolicy = exports.LambdaType = exports.UserActionPhase = exports.IPAccessControlEntryAction = exports.MultiFactorLoginPolicy = exports.IdentityProviderLinkingStrategy = exports.FormDataType = exports.SecureGeneratorType = exports.CanonicalizationMethod = exports.FormType = exports.ClientAuthenticationPolicy = exports.ExpiryUnit = exports.UserVerificationRequirement = exports.LambdaEngineType = exports.RateLimitedRequestType = exports.ApplicationMultiFactorTrustPolicy = exports.DeviceType = exports.OAuthErrorType = exports.OAuthErrorReason = exports.SAMLv2DestinationAssertionPolicy = exports.RefreshTokenUsagePolicy = exports.IdentityProviderLoginMethod = exports.AuthenticatorAttachment = exports.Oauth2AuthorizedURLValidationPolicy = exports.LDAPSecurityMethod = exports.ChangePasswordReason = exports.ResidentKeyRequirement = exports.MessageType = exports.ProofKeyForCodeExchangePolicy = exports.ConnectorType = exports.ThemeType = exports.CoseKeyType = exports.TransactionType = exports.EventLogType = exports.WebhookAttemptResult = exports.OAuthScopeHandlingPolicy = exports.FormControl = exports.BreachedPasswordStatus = exports.KeyUse = exports.RefreshTokenExpirationPolicy = exports.UserState = exports.HTTPMethod = exports.ConsentStatus = exports.WebAuthnWorkflow = exports.WebhookEventResult = exports.AttestationConveyancePreference = exports.FormFieldAdminPolicy = exports.BreachMatchMode = exports.BreachAction = exports.MessengerType = exports.UnverifiedBehavior = exports.ReactorFeatureStatus = exports.CoseAlgorithmIdentifier = exports.FamilyRole = exports.LogoutBehavior = exports.ContentStatus = exports.TokenType = exports.UniqueUsernameStrategy = exports.EmailSecurityType = exports.AttestationType = exports.GrantType = exports.FusionAuthClient = void 0;
+exports.Algorithm = exports.ClientAuthenticationMethod = exports.OAuthApplicationRelationship = exports.UnknownScopePolicy = exports.EventType = exports.CaptchaMethod = exports.SteamAPIMode = exports.AuthenticationThreats = exports.TOTPAlgorithm = exports.VerificationStrategy = exports.IdentityProviderType = exports.ObjectState = exports.OAuthScopeConsentMode = exports.KeyType = exports.KeyAlgorithm = exports.CoseEllipticCurve = exports.PublicKeyCredentialType = exports.AuthenticatorAttachmentPreference = exports.Sort = exports.XMLSignatureLocation = exports.SAMLLogoutBehavior = exports.RegistrationType = exports.LoginIdType = exports.SystemTrustedProxyConfigurationPolicy = exports.LambdaType = exports.UserActionPhase = exports.IPAccessControlEntryAction = exports.MultiFactorLoginPolicy = exports.IdentityProviderLinkingStrategy = exports.FormDataType = exports.SecureGeneratorType = exports.ExpiryUnit = exports.CanonicalizationMethod = exports.FormType = exports.ClientAuthenticationPolicy = exports.UserVerificationRequirement = exports.LambdaEngineType = exports.RateLimitedRequestType = exports.ApplicationMultiFactorTrustPolicy = exports.DeviceType = exports.OAuthErrorType = exports.OAuthErrorReason = exports.SAMLv2DestinationAssertionPolicy = exports.RefreshTokenUsagePolicy = exports.IdentityProviderLoginMethod = exports.AuthenticatorAttachment = exports.Oauth2AuthorizedURLValidationPolicy = exports.LDAPSecurityMethod = exports.ChangePasswordReason = exports.ResidentKeyRequirement = exports.MessageType = exports.ProofKeyForCodeExchangePolicy = exports.ConnectorType = exports.ThemeType = exports.CoseKeyType = exports.TransactionType = exports.EventLogType = exports.WebhookAttemptResult = exports.OAuthScopeHandlingPolicy = exports.FormControl = exports.BreachedPasswordStatus = exports.KeyUse = exports.RefreshTokenExpirationPolicy = exports.UserState = exports.HTTPMethod = exports.ConsentStatus = exports.WebAuthnWorkflow = exports.WebhookEventResult = exports.AttestationConveyancePreference = exports.FormFieldAdminPolicy = exports.BreachMatchMode = exports.BreachAction = exports.MessengerType = exports.UnverifiedBehavior = exports.ReactorFeatureStatus = exports.CoseAlgorithmIdentifier = exports.FamilyRole = exports.LogoutBehavior = exports.ContentStatus = exports.TokenType = exports.UniqueUsernameStrategy = exports.EmailSecurityType = exports.AttestationType = exports.GrantType = exports.FusionAuthClient = void 0;
 const DefaultRESTClientBuilder_1 = require("./DefaultRESTClientBuilder");
 const url_1 = require("url");
 class FusionAuthClient {
@@ -5675,18 +5675,6 @@ var UserVerificationRequirement;
     UserVerificationRequirement["preferred"] = "preferred";
     UserVerificationRequirement["discouraged"] = "discouraged";
 })(UserVerificationRequirement = exports.UserVerificationRequirement || (exports.UserVerificationRequirement = {}));
-/**
- * @author Brian Pontarelli
- */
-var ExpiryUnit;
-(function (ExpiryUnit) {
-    ExpiryUnit["MINUTES"] = "MINUTES";
-    ExpiryUnit["HOURS"] = "HOURS";
-    ExpiryUnit["DAYS"] = "DAYS";
-    ExpiryUnit["WEEKS"] = "WEEKS";
-    ExpiryUnit["MONTHS"] = "MONTHS";
-    ExpiryUnit["YEARS"] = "YEARS";
-})(ExpiryUnit = exports.ExpiryUnit || (exports.ExpiryUnit = {}));
 /**
  * @author Brett Guy
  */
@@ -5718,6 +5706,18 @@ var CanonicalizationMethod;
     CanonicalizationMethod["inclusive"] = "inclusive";
     CanonicalizationMethod["inclusive_with_comments"] = "inclusive_with_comments";
 })(CanonicalizationMethod = exports.CanonicalizationMethod || (exports.CanonicalizationMethod = {}));
+/**
+ * @author Brian Pontarelli
+ */
+var ExpiryUnit;
+(function (ExpiryUnit) {
+    ExpiryUnit["MINUTES"] = "MINUTES";
+    ExpiryUnit["HOURS"] = "HOURS";
+    ExpiryUnit["DAYS"] = "DAYS";
+    ExpiryUnit["WEEKS"] = "WEEKS";
+    ExpiryUnit["MONTHS"] = "MONTHS";
+    ExpiryUnit["YEARS"] = "YEARS";
+})(ExpiryUnit = exports.ExpiryUnit || (exports.ExpiryUnit = {}));
 /**
  * @author Daniel DeGroff
  */