@fusionauth/typescript-client 1.55.0 → 1.56.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.
|
@@ -2811,15 +2811,6 @@ export default FusionAuthClient;
|
|
|
2811
2811
|
* A 128 bit UUID in string format "8-4-4-4-12", for example "58D5E212-165B-4CA0-909B-C86B9CEE0111".
|
|
2812
2812
|
*/
|
|
2813
2813
|
export declare type UUID = string;
|
|
2814
|
-
/**
|
|
2815
|
-
* Identity Provider response.
|
|
2816
|
-
*
|
|
2817
|
-
* @author Spencer Witt
|
|
2818
|
-
*/
|
|
2819
|
-
export interface IdentityProviderSearchResponse {
|
|
2820
|
-
identityProviders?: Array<BaseIdentityProvider<any>>;
|
|
2821
|
-
total?: number;
|
|
2822
|
-
}
|
|
2823
2814
|
/**
|
|
2824
2815
|
* Authorization Grant types as defined by the <a href="https://tools.ietf.org/html/rfc6749">The OAuth 2.0 Authorization
|
|
2825
2816
|
* Framework - RFC 6749</a>.
|
|
@@ -2850,6 +2841,15 @@ export declare enum AttestationType {
|
|
|
2850
2841
|
anonymizationCa = "anonymizationCa",
|
|
2851
2842
|
none = "none"
|
|
2852
2843
|
}
|
|
2844
|
+
/**
|
|
2845
|
+
* Identity Provider response.
|
|
2846
|
+
*
|
|
2847
|
+
* @author Spencer Witt
|
|
2848
|
+
*/
|
|
2849
|
+
export interface IdentityProviderSearchResponse {
|
|
2850
|
+
identityProviders?: Array<BaseIdentityProvider<any>>;
|
|
2851
|
+
total?: number;
|
|
2852
|
+
}
|
|
2853
2853
|
/**
|
|
2854
2854
|
* @author Daniel DeGroff
|
|
2855
2855
|
*/
|
|
@@ -4146,14 +4146,6 @@ export interface Group {
|
|
|
4146
4146
|
roles?: Record<UUID, Array<ApplicationRole>>;
|
|
4147
4147
|
tenantId?: UUID;
|
|
4148
4148
|
}
|
|
4149
|
-
/**
|
|
4150
|
-
* Base class for all {@link User}-related events.
|
|
4151
|
-
*
|
|
4152
|
-
* @author Spencer Witt
|
|
4153
|
-
*/
|
|
4154
|
-
export interface BaseUserEvent extends BaseEvent {
|
|
4155
|
-
user?: User;
|
|
4156
|
-
}
|
|
4157
4149
|
/**
|
|
4158
4150
|
* @author Daniel DeGroff
|
|
4159
4151
|
*/
|
|
@@ -4166,6 +4158,14 @@ export interface Form {
|
|
|
4166
4158
|
steps?: Array<FormStep>;
|
|
4167
4159
|
type?: FormType;
|
|
4168
4160
|
}
|
|
4161
|
+
/**
|
|
4162
|
+
* Base class for all {@link User}-related events.
|
|
4163
|
+
*
|
|
4164
|
+
* @author Spencer Witt
|
|
4165
|
+
*/
|
|
4166
|
+
export interface BaseUserEvent extends BaseEvent {
|
|
4167
|
+
user?: User;
|
|
4168
|
+
}
|
|
4169
4169
|
/**
|
|
4170
4170
|
* @author Daniel DeGroff
|
|
4171
4171
|
*/
|
|
@@ -4183,6 +4183,14 @@ export declare enum UserState {
|
|
|
4183
4183
|
export interface WebhookEventLogConfiguration {
|
|
4184
4184
|
delete?: DeleteConfiguration;
|
|
4185
4185
|
}
|
|
4186
|
+
/**
|
|
4187
|
+
* Model a user event when a two-factor method has been removed.
|
|
4188
|
+
*
|
|
4189
|
+
* @author Daniel DeGroff
|
|
4190
|
+
*/
|
|
4191
|
+
export interface UserTwoFactorMethodAddEvent extends BaseUserEvent {
|
|
4192
|
+
method?: TwoFactorMethod;
|
|
4193
|
+
}
|
|
4186
4194
|
/**
|
|
4187
4195
|
* @author Daniel DeGroff
|
|
4188
4196
|
*/
|
|
@@ -4192,14 +4200,6 @@ export interface LinkedInApplicationConfiguration extends BaseIdentityProviderAp
|
|
|
4192
4200
|
client_secret?: string;
|
|
4193
4201
|
scope?: string;
|
|
4194
4202
|
}
|
|
4195
|
-
/**
|
|
4196
|
-
* Model a user event when a two-factor method has been removed.
|
|
4197
|
-
*
|
|
4198
|
-
* @author Daniel DeGroff
|
|
4199
|
-
*/
|
|
4200
|
-
export interface UserTwoFactorMethodAddEvent extends BaseUserEvent {
|
|
4201
|
-
method?: TwoFactorMethod;
|
|
4202
|
-
}
|
|
4203
4203
|
/**
|
|
4204
4204
|
* @author Lyle Schemmerling
|
|
4205
4205
|
*/
|
|
@@ -5261,13 +5261,6 @@ export interface RateLimitedRequestConfiguration extends Enableable {
|
|
|
5261
5261
|
*/
|
|
5262
5262
|
export interface NonTransactionalEvent {
|
|
5263
5263
|
}
|
|
5264
|
-
/**
|
|
5265
|
-
* @author Daniel DeGroff
|
|
5266
|
-
*/
|
|
5267
|
-
export interface TwoFactorResponse {
|
|
5268
|
-
code?: string;
|
|
5269
|
-
recoveryCodes?: Array<string>;
|
|
5270
|
-
}
|
|
5271
5264
|
/**
|
|
5272
5265
|
* @author Brett Guy
|
|
5273
5266
|
*/
|
|
@@ -5276,6 +5269,13 @@ export declare enum ProofKeyForCodeExchangePolicy {
|
|
|
5276
5269
|
NotRequired = "NotRequired",
|
|
5277
5270
|
NotRequiredWhenUsingClientAuthentication = "NotRequiredWhenUsingClientAuthentication"
|
|
5278
5271
|
}
|
|
5272
|
+
/**
|
|
5273
|
+
* @author Daniel DeGroff
|
|
5274
|
+
*/
|
|
5275
|
+
export interface TwoFactorResponse {
|
|
5276
|
+
code?: string;
|
|
5277
|
+
recoveryCodes?: Array<string>;
|
|
5278
|
+
}
|
|
5279
5279
|
/**
|
|
5280
5280
|
* Epic gaming login provider.
|
|
5281
5281
|
*
|
|
@@ -6399,17 +6399,6 @@ export interface UserRegistrationVerifiedEvent extends BaseUserEvent {
|
|
|
6399
6399
|
export interface MessageTemplateRequest {
|
|
6400
6400
|
messageTemplate?: MessageTemplate;
|
|
6401
6401
|
}
|
|
6402
|
-
/**
|
|
6403
|
-
* @author Daniel DeGroff
|
|
6404
|
-
*/
|
|
6405
|
-
export interface AppleIdentityProvider extends BaseIdentityProvider<AppleApplicationConfiguration> {
|
|
6406
|
-
bundleId?: string;
|
|
6407
|
-
buttonText?: string;
|
|
6408
|
-
keyId?: UUID;
|
|
6409
|
-
scope?: string;
|
|
6410
|
-
servicesId?: string;
|
|
6411
|
-
teamId?: string;
|
|
6412
|
-
}
|
|
6413
6402
|
/**
|
|
6414
6403
|
* @author Daniel DeGroff
|
|
6415
6404
|
*/
|
|
@@ -6422,6 +6411,17 @@ export interface DeviceUserCodeResponse {
|
|
|
6422
6411
|
tenantId?: UUID;
|
|
6423
6412
|
user_code?: string;
|
|
6424
6413
|
}
|
|
6414
|
+
/**
|
|
6415
|
+
* @author Daniel DeGroff
|
|
6416
|
+
*/
|
|
6417
|
+
export interface AppleIdentityProvider extends BaseIdentityProvider<AppleApplicationConfiguration> {
|
|
6418
|
+
bundleId?: string;
|
|
6419
|
+
buttonText?: string;
|
|
6420
|
+
keyId?: UUID;
|
|
6421
|
+
scope?: string;
|
|
6422
|
+
servicesId?: string;
|
|
6423
|
+
teamId?: string;
|
|
6424
|
+
}
|
|
6425
6425
|
/**
|
|
6426
6426
|
* @author Daniel DeGroff
|
|
6427
6427
|
*/
|
|
@@ -6788,6 +6788,13 @@ export interface TwitterIdentityProvider extends BaseIdentityProvider<TwitterApp
|
|
|
6788
6788
|
consumerKey?: string;
|
|
6789
6789
|
consumerSecret?: string;
|
|
6790
6790
|
}
|
|
6791
|
+
/**
|
|
6792
|
+
* @author Michael Sleevi
|
|
6793
|
+
*/
|
|
6794
|
+
export interface SMSMessageTemplate extends MessageTemplate {
|
|
6795
|
+
defaultTemplate?: string;
|
|
6796
|
+
localizedTemplates?: LocalizedStrings;
|
|
6797
|
+
}
|
|
6791
6798
|
/**
|
|
6792
6799
|
* Lambda API request object.
|
|
6793
6800
|
*
|
|
@@ -6796,13 +6803,6 @@ export interface TwitterIdentityProvider extends BaseIdentityProvider<TwitterApp
|
|
|
6796
6803
|
export interface LambdaRequest {
|
|
6797
6804
|
lambda?: Lambda;
|
|
6798
6805
|
}
|
|
6799
|
-
/**
|
|
6800
|
-
* @author Michael Sleevi
|
|
6801
|
-
*/
|
|
6802
|
-
export interface SMSMessageTemplate extends MessageTemplate {
|
|
6803
|
-
defaultTemplate?: string;
|
|
6804
|
-
localizedTemplates?: LocalizedStrings;
|
|
6805
|
-
}
|
|
6806
6806
|
/**
|
|
6807
6807
|
* Models an event where a user is being created with an "in-use" login Id (email or username).
|
|
6808
6808
|
*
|
|
@@ -8034,14 +8034,6 @@ export interface RefreshTokenSlidingWindowConfiguration {
|
|
|
8034
8034
|
export interface ThemeSearchRequest {
|
|
8035
8035
|
search?: ThemeSearchCriteria;
|
|
8036
8036
|
}
|
|
8037
|
-
/**
|
|
8038
|
-
* @author Daniel DeGroff
|
|
8039
|
-
*/
|
|
8040
|
-
export declare enum ObjectState {
|
|
8041
|
-
Active = "Active",
|
|
8042
|
-
Inactive = "Inactive",
|
|
8043
|
-
PendingDelete = "PendingDelete"
|
|
8044
|
-
}
|
|
8045
8037
|
/**
|
|
8046
8038
|
* Search request for Consents
|
|
8047
8039
|
*
|
|
@@ -8050,6 +8042,14 @@ export declare enum ObjectState {
|
|
|
8050
8042
|
export interface ConsentSearchRequest {
|
|
8051
8043
|
search?: ConsentSearchCriteria;
|
|
8052
8044
|
}
|
|
8045
|
+
/**
|
|
8046
|
+
* @author Daniel DeGroff
|
|
8047
|
+
*/
|
|
8048
|
+
export declare enum ObjectState {
|
|
8049
|
+
Active = "Active",
|
|
8050
|
+
Inactive = "Inactive",
|
|
8051
|
+
PendingDelete = "PendingDelete"
|
|
8052
|
+
}
|
|
8053
8053
|
/**
|
|
8054
8054
|
* Search request for Identity Providers
|
|
8055
8055
|
*
|
|
@@ -8139,6 +8139,7 @@ export interface GroupCreateCompleteEvent extends BaseGroupEvent {
|
|
|
8139
8139
|
* @author Brett Pontarelli
|
|
8140
8140
|
*/
|
|
8141
8141
|
export interface TenantSSOConfiguration {
|
|
8142
|
+
allowAccessTokenBootstrap?: boolean;
|
|
8142
8143
|
deviceTrustTimeToLiveInSeconds?: number;
|
|
8143
8144
|
}
|
|
8144
8145
|
/**
|
|
@@ -8462,6 +8463,11 @@ export interface UserDeleteRequest extends BaseEventRequest {
|
|
|
8462
8463
|
export interface TenantAccessControlConfiguration {
|
|
8463
8464
|
uiIPAccessControlListId?: UUID;
|
|
8464
8465
|
}
|
|
8466
|
+
/**
|
|
8467
|
+
* Interface for any object that can provide JSON Web key Information.
|
|
8468
|
+
*/
|
|
8469
|
+
export interface JSONWebKeyInfoProvider {
|
|
8470
|
+
}
|
|
8465
8471
|
/**
|
|
8466
8472
|
* This class is a simple attachment with a byte array, name and MIME type.
|
|
8467
8473
|
*
|
|
@@ -8472,11 +8478,6 @@ export interface Attachment {
|
|
|
8472
8478
|
mime?: string;
|
|
8473
8479
|
name?: string;
|
|
8474
8480
|
}
|
|
8475
|
-
/**
|
|
8476
|
-
* Interface for any object that can provide JSON Web key Information.
|
|
8477
|
-
*/
|
|
8478
|
-
export interface JSONWebKeyInfoProvider {
|
|
8479
|
-
}
|
|
8480
8481
|
/**
|
|
8481
8482
|
* Tenant-level configuration for WebAuthn
|
|
8482
8483
|
*
|
|
@@ -8733,7 +8734,9 @@ export interface APIKey {
|
|
|
8733
8734
|
keyManager?: boolean;
|
|
8734
8735
|
lastUpdateInstant?: number;
|
|
8735
8736
|
metaData?: APIKeyMetaData;
|
|
8737
|
+
name?: string;
|
|
8736
8738
|
permissions?: APIKeyPermissions;
|
|
8739
|
+
retrievable?: boolean;
|
|
8737
8740
|
tenantId?: UUID;
|
|
8738
8741
|
}
|
|
8739
8742
|
export interface APIKeyMetaData {
|
|
@@ -8851,6 +8854,13 @@ export interface EntityTypePermission {
|
|
|
8851
8854
|
lastUpdateInstant?: number;
|
|
8852
8855
|
name?: string;
|
|
8853
8856
|
}
|
|
8857
|
+
/**
|
|
8858
|
+
* This class is the user query. It provides a build pattern as well as public fields for use on forms and in actions.
|
|
8859
|
+
*
|
|
8860
|
+
* @author Brian Pontarelli
|
|
8861
|
+
*/
|
|
8862
|
+
export interface UserSearchCriteria extends BaseElasticSearchCriteria {
|
|
8863
|
+
}
|
|
8854
8864
|
/**
|
|
8855
8865
|
* User comment search response
|
|
8856
8866
|
*
|
|
@@ -8860,13 +8870,6 @@ export interface UserCommentSearchResponse {
|
|
|
8860
8870
|
total?: number;
|
|
8861
8871
|
userComments?: Array<UserComment>;
|
|
8862
8872
|
}
|
|
8863
|
-
/**
|
|
8864
|
-
* This class is the user query. It provides a build pattern as well as public fields for use on forms and in actions.
|
|
8865
|
-
*
|
|
8866
|
-
* @author Brian Pontarelli
|
|
8867
|
-
*/
|
|
8868
|
-
export interface UserSearchCriteria extends BaseElasticSearchCriteria {
|
|
8869
|
-
}
|
|
8870
8873
|
/**
|
|
8871
8874
|
* @author Daniel DeGroff
|
|
8872
8875
|
*/
|