@fusionauth/typescript-client 1.54.0 → 1.55.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 +185 -154
- package/build/src/FusionAuthClient.js +13 -13
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +14 -14
- package/dist/fusionauth-typescript-client.min.js +1 -1
- package/dist/fusionauth-typescript-client.min.js.map +1 -1
- package/package.json +1 -1
|
@@ -2811,6 +2811,15 @@ 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
|
+
}
|
|
2814
2823
|
/**
|
|
2815
2824
|
* Authorization Grant types as defined by the <a href="https://tools.ietf.org/html/rfc6749">The OAuth 2.0 Authorization
|
|
2816
2825
|
* Framework - RFC 6749</a>.
|
|
@@ -2829,15 +2838,6 @@ export declare enum GrantType {
|
|
|
2829
2838
|
unknown = "unknown",
|
|
2830
2839
|
device_code = "urn:ietf:params:oauth:grant-type:device_code"
|
|
2831
2840
|
}
|
|
2832
|
-
/**
|
|
2833
|
-
* Identity Provider response.
|
|
2834
|
-
*
|
|
2835
|
-
* @author Spencer Witt
|
|
2836
|
-
*/
|
|
2837
|
-
export interface IdentityProviderSearchResponse {
|
|
2838
|
-
identityProviders?: Array<BaseIdentityProvider<any>>;
|
|
2839
|
-
total?: number;
|
|
2840
|
-
}
|
|
2841
2841
|
/**
|
|
2842
2842
|
* Used to indicate what type of attestation was included in the authenticator response for a given WebAuthn credential at the time it was created
|
|
2843
2843
|
*
|
|
@@ -3137,6 +3137,7 @@ export interface SystemConfiguration {
|
|
|
3137
3137
|
reportTimezone?: string;
|
|
3138
3138
|
trustedProxyConfiguration?: SystemTrustedProxyConfiguration;
|
|
3139
3139
|
uiConfiguration?: UIConfiguration;
|
|
3140
|
+
usageDataConfiguration?: UsageDataConfiguration;
|
|
3140
3141
|
webhookEventLogConfiguration?: WebhookEventLogConfiguration;
|
|
3141
3142
|
}
|
|
3142
3143
|
export interface AuditLogConfiguration {
|
|
@@ -3568,16 +3569,6 @@ export declare enum CoseAlgorithmIdentifier {
|
|
|
3568
3569
|
*/
|
|
3569
3570
|
export interface UserinfoResponse extends Record<string, any> {
|
|
3570
3571
|
}
|
|
3571
|
-
/**
|
|
3572
|
-
* @author Brett Pontarelli
|
|
3573
|
-
*/
|
|
3574
|
-
export interface SteamApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
|
|
3575
|
-
apiMode?: SteamAPIMode;
|
|
3576
|
-
buttonText?: string;
|
|
3577
|
-
client_id?: string;
|
|
3578
|
-
scope?: string;
|
|
3579
|
-
webAPIKey?: string;
|
|
3580
|
-
}
|
|
3581
3572
|
/**
|
|
3582
3573
|
* @author Daniel DeGroff
|
|
3583
3574
|
*/
|
|
@@ -3589,6 +3580,16 @@ export interface TwoFactorSendRequest {
|
|
|
3589
3580
|
mobilePhone?: string;
|
|
3590
3581
|
userId?: UUID;
|
|
3591
3582
|
}
|
|
3583
|
+
/**
|
|
3584
|
+
* @author Brett Pontarelli
|
|
3585
|
+
*/
|
|
3586
|
+
export interface SteamApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
|
|
3587
|
+
apiMode?: SteamAPIMode;
|
|
3588
|
+
buttonText?: string;
|
|
3589
|
+
client_id?: string;
|
|
3590
|
+
scope?: string;
|
|
3591
|
+
webAPIKey?: string;
|
|
3592
|
+
}
|
|
3592
3593
|
/**
|
|
3593
3594
|
* Search criteria for Email templates
|
|
3594
3595
|
*
|
|
@@ -3930,6 +3931,13 @@ export interface SendRequest {
|
|
|
3930
3931
|
toAddresses?: Array<EmailAddress>;
|
|
3931
3932
|
userIds?: Array<UUID>;
|
|
3932
3933
|
}
|
|
3934
|
+
/**
|
|
3935
|
+
* @author Michael Sleevi
|
|
3936
|
+
*/
|
|
3937
|
+
export interface MessageTemplateResponse {
|
|
3938
|
+
messageTemplate?: MessageTemplate;
|
|
3939
|
+
messageTemplates?: Array<MessageTemplate>;
|
|
3940
|
+
}
|
|
3933
3941
|
/**
|
|
3934
3942
|
* Identifies the WebAuthn workflow. This will affect the parameters used for credential creation
|
|
3935
3943
|
* and request based on the Tenant configuration.
|
|
@@ -3941,13 +3949,6 @@ export declare enum WebAuthnWorkflow {
|
|
|
3941
3949
|
general = "general",
|
|
3942
3950
|
reauthentication = "reauthentication"
|
|
3943
3951
|
}
|
|
3944
|
-
/**
|
|
3945
|
-
* @author Michael Sleevi
|
|
3946
|
-
*/
|
|
3947
|
-
export interface MessageTemplateResponse {
|
|
3948
|
-
messageTemplate?: MessageTemplate;
|
|
3949
|
-
messageTemplates?: Array<MessageTemplate>;
|
|
3950
|
-
}
|
|
3951
3952
|
/**
|
|
3952
3953
|
* Models a consent.
|
|
3953
3954
|
*
|
|
@@ -4054,6 +4055,14 @@ export interface Email {
|
|
|
4054
4055
|
export interface LambdaSearchRequest {
|
|
4055
4056
|
search?: LambdaSearchCriteria;
|
|
4056
4057
|
}
|
|
4058
|
+
/**
|
|
4059
|
+
* Config for Usage Data / Stats
|
|
4060
|
+
*
|
|
4061
|
+
* @author Lyle Schemmerling
|
|
4062
|
+
*/
|
|
4063
|
+
export interface UsageDataConfiguration extends Enableable {
|
|
4064
|
+
numberOfDaysToRetain?: number;
|
|
4065
|
+
}
|
|
4057
4066
|
/**
|
|
4058
4067
|
* User login failed reason codes.
|
|
4059
4068
|
*/
|
|
@@ -4137,6 +4146,14 @@ export interface Group {
|
|
|
4137
4146
|
roles?: Record<UUID, Array<ApplicationRole>>;
|
|
4138
4147
|
tenantId?: UUID;
|
|
4139
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
|
+
}
|
|
4140
4157
|
/**
|
|
4141
4158
|
* @author Daniel DeGroff
|
|
4142
4159
|
*/
|
|
@@ -4149,14 +4166,6 @@ export interface Form {
|
|
|
4149
4166
|
steps?: Array<FormStep>;
|
|
4150
4167
|
type?: FormType;
|
|
4151
4168
|
}
|
|
4152
|
-
/**
|
|
4153
|
-
* Base class for all {@link User}-related events.
|
|
4154
|
-
*
|
|
4155
|
-
* @author Spencer Witt
|
|
4156
|
-
*/
|
|
4157
|
-
export interface BaseUserEvent extends BaseEvent {
|
|
4158
|
-
user?: User;
|
|
4159
|
-
}
|
|
4160
4169
|
/**
|
|
4161
4170
|
* @author Daniel DeGroff
|
|
4162
4171
|
*/
|
|
@@ -4308,6 +4317,15 @@ export interface EventConfiguration {
|
|
|
4308
4317
|
export interface EventConfigurationData extends Enableable {
|
|
4309
4318
|
transactionType?: TransactionType;
|
|
4310
4319
|
}
|
|
4320
|
+
/**
|
|
4321
|
+
* Refresh token one-time use configuration. This configuration is utilized when the usage policy is
|
|
4322
|
+
* configured for one-time use.
|
|
4323
|
+
*
|
|
4324
|
+
* @author Daniel DeGroff
|
|
4325
|
+
*/
|
|
4326
|
+
export interface RefreshTokenOneTimeUseConfiguration {
|
|
4327
|
+
gracePeriodInSeconds?: number;
|
|
4328
|
+
}
|
|
4311
4329
|
/**
|
|
4312
4330
|
* Models the User Deactivate Event.
|
|
4313
4331
|
*
|
|
@@ -4399,13 +4417,6 @@ export interface Enableable {
|
|
|
4399
4417
|
export interface GroupMemberAddEvent extends BaseGroupEvent {
|
|
4400
4418
|
members?: Array<GroupMember>;
|
|
4401
4419
|
}
|
|
4402
|
-
/**
|
|
4403
|
-
* The public Status API response
|
|
4404
|
-
*
|
|
4405
|
-
* @author Daniel DeGroff
|
|
4406
|
-
*/
|
|
4407
|
-
export interface StatusResponse extends Record<string, any> {
|
|
4408
|
-
}
|
|
4409
4420
|
/**
|
|
4410
4421
|
* Models the User Password Reset Success Event.
|
|
4411
4422
|
*
|
|
@@ -4421,6 +4432,13 @@ export declare enum RefreshTokenExpirationPolicy {
|
|
|
4421
4432
|
SlidingWindow = "SlidingWindow",
|
|
4422
4433
|
SlidingWindowWithMaximumLifetime = "SlidingWindowWithMaximumLifetime"
|
|
4423
4434
|
}
|
|
4435
|
+
/**
|
|
4436
|
+
* The public Status API response
|
|
4437
|
+
*
|
|
4438
|
+
* @author Daniel DeGroff
|
|
4439
|
+
*/
|
|
4440
|
+
export interface StatusResponse extends Record<string, any> {
|
|
4441
|
+
}
|
|
4424
4442
|
/**
|
|
4425
4443
|
* @author Brett Guy
|
|
4426
4444
|
*/
|
|
@@ -4656,6 +4674,12 @@ export interface UserConsent {
|
|
|
4656
4674
|
userId?: UUID;
|
|
4657
4675
|
values?: Array<string>;
|
|
4658
4676
|
}
|
|
4677
|
+
/**
|
|
4678
|
+
* @author Daniel DeGroff
|
|
4679
|
+
*/
|
|
4680
|
+
export interface IdentityProviderStartLoginResponse {
|
|
4681
|
+
code?: string;
|
|
4682
|
+
}
|
|
4659
4683
|
/**
|
|
4660
4684
|
* Twitch gaming login provider.
|
|
4661
4685
|
*
|
|
@@ -4667,12 +4691,6 @@ export interface TwitchIdentityProvider extends BaseIdentityProvider<TwitchAppli
|
|
|
4667
4691
|
client_secret?: string;
|
|
4668
4692
|
scope?: string;
|
|
4669
4693
|
}
|
|
4670
|
-
/**
|
|
4671
|
-
* @author Daniel DeGroff
|
|
4672
|
-
*/
|
|
4673
|
-
export interface IdentityProviderStartLoginResponse {
|
|
4674
|
-
code?: string;
|
|
4675
|
-
}
|
|
4676
4694
|
/**
|
|
4677
4695
|
* Form response.
|
|
4678
4696
|
*
|
|
@@ -4952,14 +4970,6 @@ export interface GroupSearchCriteria extends BaseSearchCriteria {
|
|
|
4952
4970
|
*/
|
|
4953
4971
|
export interface UserDeleteCompleteEvent extends BaseUserEvent {
|
|
4954
4972
|
}
|
|
4955
|
-
/**
|
|
4956
|
-
* @author Daniel DeGroff
|
|
4957
|
-
*/
|
|
4958
|
-
export interface SortField {
|
|
4959
|
-
missing?: string;
|
|
4960
|
-
name?: string;
|
|
4961
|
-
order?: Sort;
|
|
4962
|
-
}
|
|
4963
4973
|
/**
|
|
4964
4974
|
* Request to complete the WebAuthn registration ceremony for a new credential,.
|
|
4965
4975
|
*
|
|
@@ -4971,6 +4981,14 @@ export interface WebAuthnRegisterCompleteRequest {
|
|
|
4971
4981
|
rpId?: string;
|
|
4972
4982
|
userId?: UUID;
|
|
4973
4983
|
}
|
|
4984
|
+
/**
|
|
4985
|
+
* @author Daniel DeGroff
|
|
4986
|
+
*/
|
|
4987
|
+
export interface SortField {
|
|
4988
|
+
missing?: string;
|
|
4989
|
+
name?: string;
|
|
4990
|
+
order?: Sort;
|
|
4991
|
+
}
|
|
4974
4992
|
/**
|
|
4975
4993
|
* Search criteria for Lambdas
|
|
4976
4994
|
*
|
|
@@ -5243,6 +5261,13 @@ export interface RateLimitedRequestConfiguration extends Enableable {
|
|
|
5243
5261
|
*/
|
|
5244
5262
|
export interface NonTransactionalEvent {
|
|
5245
5263
|
}
|
|
5264
|
+
/**
|
|
5265
|
+
* @author Daniel DeGroff
|
|
5266
|
+
*/
|
|
5267
|
+
export interface TwoFactorResponse {
|
|
5268
|
+
code?: string;
|
|
5269
|
+
recoveryCodes?: Array<string>;
|
|
5270
|
+
}
|
|
5246
5271
|
/**
|
|
5247
5272
|
* @author Brett Guy
|
|
5248
5273
|
*/
|
|
@@ -5251,13 +5276,6 @@ export declare enum ProofKeyForCodeExchangePolicy {
|
|
|
5251
5276
|
NotRequired = "NotRequired",
|
|
5252
5277
|
NotRequiredWhenUsingClientAuthentication = "NotRequiredWhenUsingClientAuthentication"
|
|
5253
5278
|
}
|
|
5254
|
-
/**
|
|
5255
|
-
* @author Daniel DeGroff
|
|
5256
|
-
*/
|
|
5257
|
-
export interface TwoFactorResponse {
|
|
5258
|
-
code?: string;
|
|
5259
|
-
recoveryCodes?: Array<string>;
|
|
5260
|
-
}
|
|
5261
5279
|
/**
|
|
5262
5280
|
* Epic gaming login provider.
|
|
5263
5281
|
*
|
|
@@ -5455,6 +5473,21 @@ export interface FormStep {
|
|
|
5455
5473
|
export interface EntityTypeSearchCriteria extends BaseSearchCriteria {
|
|
5456
5474
|
name?: string;
|
|
5457
5475
|
}
|
|
5476
|
+
/**
|
|
5477
|
+
* Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
|
|
5478
|
+
*
|
|
5479
|
+
* @author Brian Pontarelli
|
|
5480
|
+
*/
|
|
5481
|
+
export interface EventInfo {
|
|
5482
|
+
data?: Record<string, any>;
|
|
5483
|
+
deviceDescription?: string;
|
|
5484
|
+
deviceName?: string;
|
|
5485
|
+
deviceType?: string;
|
|
5486
|
+
ipAddress?: string;
|
|
5487
|
+
location?: Location;
|
|
5488
|
+
os?: string;
|
|
5489
|
+
userAgent?: string;
|
|
5490
|
+
}
|
|
5458
5491
|
/**
|
|
5459
5492
|
* Search criteria for Group Members
|
|
5460
5493
|
*
|
|
@@ -5755,21 +5788,6 @@ export declare enum ApplicationMultiFactorTrustPolicy {
|
|
|
5755
5788
|
export interface MaximumPasswordAge extends Enableable {
|
|
5756
5789
|
days?: number;
|
|
5757
5790
|
}
|
|
5758
|
-
/**
|
|
5759
|
-
* Information about a user event (login, register, etc) that helps identify the source of the event (location, device type, OS, etc).
|
|
5760
|
-
*
|
|
5761
|
-
* @author Brian Pontarelli
|
|
5762
|
-
*/
|
|
5763
|
-
export interface EventInfo {
|
|
5764
|
-
data?: Record<string, any>;
|
|
5765
|
-
deviceDescription?: string;
|
|
5766
|
-
deviceName?: string;
|
|
5767
|
-
deviceType?: string;
|
|
5768
|
-
ipAddress?: string;
|
|
5769
|
-
location?: Location;
|
|
5770
|
-
os?: string;
|
|
5771
|
-
userAgent?: string;
|
|
5772
|
-
}
|
|
5773
5791
|
/**
|
|
5774
5792
|
* @author Daniel DeGroff
|
|
5775
5793
|
*/
|
|
@@ -5797,6 +5815,14 @@ export declare enum LambdaEngineType {
|
|
|
5797
5815
|
GraalJS = "GraalJS",
|
|
5798
5816
|
Nashorn = "Nashorn"
|
|
5799
5817
|
}
|
|
5818
|
+
/**
|
|
5819
|
+
* API response for starting a WebAuthn authentication ceremony
|
|
5820
|
+
*
|
|
5821
|
+
* @author Spencer Witt
|
|
5822
|
+
*/
|
|
5823
|
+
export interface WebAuthnStartResponse {
|
|
5824
|
+
options?: PublicKeyCredentialRequestOptions;
|
|
5825
|
+
}
|
|
5800
5826
|
/**
|
|
5801
5827
|
* SAML v2 identity provider configuration.
|
|
5802
5828
|
*
|
|
@@ -5817,14 +5843,6 @@ export interface SAMLv2IdentityProvider extends BaseSAMLv2IdentityProvider<SAMLv
|
|
|
5817
5843
|
signRequest?: boolean;
|
|
5818
5844
|
xmlSignatureC14nMethod?: CanonicalizationMethod;
|
|
5819
5845
|
}
|
|
5820
|
-
/**
|
|
5821
|
-
* API response for starting a WebAuthn authentication ceremony
|
|
5822
|
-
*
|
|
5823
|
-
* @author Spencer Witt
|
|
5824
|
-
*/
|
|
5825
|
-
export interface WebAuthnStartResponse {
|
|
5826
|
-
options?: PublicKeyCredentialRequestOptions;
|
|
5827
|
-
}
|
|
5828
5846
|
/**
|
|
5829
5847
|
* Search request for entity types.
|
|
5830
5848
|
*
|
|
@@ -5997,6 +6015,7 @@ export interface JWTConfiguration extends Enableable {
|
|
|
5997
6015
|
accessTokenKeyId?: UUID;
|
|
5998
6016
|
idTokenKeyId?: UUID;
|
|
5999
6017
|
refreshTokenExpirationPolicy?: RefreshTokenExpirationPolicy;
|
|
6018
|
+
refreshTokenOneTimeUseConfiguration?: RefreshTokenOneTimeUseConfiguration;
|
|
6000
6019
|
refreshTokenRevocationPolicy?: RefreshTokenRevocationPolicy;
|
|
6001
6020
|
refreshTokenSlidingWindowConfiguration?: RefreshTokenSlidingWindowConfiguration;
|
|
6002
6021
|
refreshTokenTimeToLiveInMinutes?: number;
|
|
@@ -6081,17 +6100,6 @@ export declare enum UserVerificationRequirement {
|
|
|
6081
6100
|
*/
|
|
6082
6101
|
export interface SupportsPostBindings {
|
|
6083
6102
|
}
|
|
6084
|
-
/**
|
|
6085
|
-
* @author Brian Pontarelli
|
|
6086
|
-
*/
|
|
6087
|
-
export declare enum ExpiryUnit {
|
|
6088
|
-
MINUTES = "MINUTES",
|
|
6089
|
-
HOURS = "HOURS",
|
|
6090
|
-
DAYS = "DAYS",
|
|
6091
|
-
WEEKS = "WEEKS",
|
|
6092
|
-
MONTHS = "MONTHS",
|
|
6093
|
-
YEARS = "YEARS"
|
|
6094
|
-
}
|
|
6095
6103
|
/**
|
|
6096
6104
|
* Search response for Themes
|
|
6097
6105
|
*
|
|
@@ -6297,6 +6305,17 @@ export interface WebAuthnLoginRequest extends BaseLoginRequest {
|
|
|
6297
6305
|
rpId?: string;
|
|
6298
6306
|
twoFactorTrustId?: string;
|
|
6299
6307
|
}
|
|
6308
|
+
/**
|
|
6309
|
+
* @author Brian Pontarelli
|
|
6310
|
+
*/
|
|
6311
|
+
export declare enum ExpiryUnit {
|
|
6312
|
+
MINUTES = "MINUTES",
|
|
6313
|
+
HOURS = "HOURS",
|
|
6314
|
+
DAYS = "DAYS",
|
|
6315
|
+
WEEKS = "WEEKS",
|
|
6316
|
+
MONTHS = "MONTHS",
|
|
6317
|
+
YEARS = "YEARS"
|
|
6318
|
+
}
|
|
6300
6319
|
/**
|
|
6301
6320
|
* The Application API request object.
|
|
6302
6321
|
*
|
|
@@ -6380,6 +6399,17 @@ export interface UserRegistrationVerifiedEvent extends BaseUserEvent {
|
|
|
6380
6399
|
export interface MessageTemplateRequest {
|
|
6381
6400
|
messageTemplate?: MessageTemplate;
|
|
6382
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
|
+
}
|
|
6383
6413
|
/**
|
|
6384
6414
|
* @author Daniel DeGroff
|
|
6385
6415
|
*/
|
|
@@ -6392,17 +6422,6 @@ export interface DeviceUserCodeResponse {
|
|
|
6392
6422
|
tenantId?: UUID;
|
|
6393
6423
|
user_code?: string;
|
|
6394
6424
|
}
|
|
6395
|
-
/**
|
|
6396
|
-
* @author Daniel DeGroff
|
|
6397
|
-
*/
|
|
6398
|
-
export interface AppleIdentityProvider extends BaseIdentityProvider<AppleApplicationConfiguration> {
|
|
6399
|
-
bundleId?: string;
|
|
6400
|
-
buttonText?: string;
|
|
6401
|
-
keyId?: UUID;
|
|
6402
|
-
scope?: string;
|
|
6403
|
-
servicesId?: string;
|
|
6404
|
-
teamId?: string;
|
|
6405
|
-
}
|
|
6406
6425
|
/**
|
|
6407
6426
|
* @author Daniel DeGroff
|
|
6408
6427
|
*/
|
|
@@ -6576,6 +6595,14 @@ export interface PublicKeyResponse {
|
|
|
6576
6595
|
export interface RecentLoginResponse {
|
|
6577
6596
|
logins?: Array<DisplayableRawLogin>;
|
|
6578
6597
|
}
|
|
6598
|
+
/**
|
|
6599
|
+
* Container for the event information. This is the JSON that is sent from FusionAuth to webhooks.
|
|
6600
|
+
*
|
|
6601
|
+
* @author Brian Pontarelli
|
|
6602
|
+
*/
|
|
6603
|
+
export interface EventRequest {
|
|
6604
|
+
event?: BaseEvent;
|
|
6605
|
+
}
|
|
6579
6606
|
/**
|
|
6580
6607
|
* @author Daniel DeGroff
|
|
6581
6608
|
*/
|
|
@@ -6602,15 +6629,6 @@ export declare enum SecureGeneratorType {
|
|
|
6602
6629
|
export interface EntityGrantRequest {
|
|
6603
6630
|
grant?: EntityGrant;
|
|
6604
6631
|
}
|
|
6605
|
-
/**
|
|
6606
|
-
* Something that can be required and thus also optional. This currently extends Enableable because anything that is
|
|
6607
|
-
* required/optional is almost always enableable as well.
|
|
6608
|
-
*
|
|
6609
|
-
* @author Brian Pontarelli
|
|
6610
|
-
*/
|
|
6611
|
-
export interface Requirable extends Enableable {
|
|
6612
|
-
required?: boolean;
|
|
6613
|
-
}
|
|
6614
6632
|
/**
|
|
6615
6633
|
* Models the User Login Failed Event.
|
|
6616
6634
|
*
|
|
@@ -6690,14 +6708,6 @@ export interface EntityTypeSearchResponse {
|
|
|
6690
6708
|
entityTypes?: Array<EntityType>;
|
|
6691
6709
|
total?: number;
|
|
6692
6710
|
}
|
|
6693
|
-
/**
|
|
6694
|
-
* Container for the event information. This is the JSON that is sent from FusionAuth to webhooks.
|
|
6695
|
-
*
|
|
6696
|
-
* @author Brian Pontarelli
|
|
6697
|
-
*/
|
|
6698
|
-
export interface EventRequest {
|
|
6699
|
-
event?: BaseEvent;
|
|
6700
|
-
}
|
|
6701
6711
|
/**
|
|
6702
6712
|
* Search criteria for webhooks.
|
|
6703
6713
|
*
|
|
@@ -6778,13 +6788,6 @@ export interface TwitterIdentityProvider extends BaseIdentityProvider<TwitterApp
|
|
|
6778
6788
|
consumerKey?: string;
|
|
6779
6789
|
consumerSecret?: string;
|
|
6780
6790
|
}
|
|
6781
|
-
/**
|
|
6782
|
-
* @author Michael Sleevi
|
|
6783
|
-
*/
|
|
6784
|
-
export interface SMSMessageTemplate extends MessageTemplate {
|
|
6785
|
-
defaultTemplate?: string;
|
|
6786
|
-
localizedTemplates?: LocalizedStrings;
|
|
6787
|
-
}
|
|
6788
6791
|
/**
|
|
6789
6792
|
* Lambda API request object.
|
|
6790
6793
|
*
|
|
@@ -6793,6 +6796,13 @@ export interface SMSMessageTemplate extends MessageTemplate {
|
|
|
6793
6796
|
export interface LambdaRequest {
|
|
6794
6797
|
lambda?: Lambda;
|
|
6795
6798
|
}
|
|
6799
|
+
/**
|
|
6800
|
+
* @author Michael Sleevi
|
|
6801
|
+
*/
|
|
6802
|
+
export interface SMSMessageTemplate extends MessageTemplate {
|
|
6803
|
+
defaultTemplate?: string;
|
|
6804
|
+
localizedTemplates?: LocalizedStrings;
|
|
6805
|
+
}
|
|
6796
6806
|
/**
|
|
6797
6807
|
* Models an event where a user is being created with an "in-use" login Id (email or username).
|
|
6798
6808
|
*
|
|
@@ -6829,6 +6839,15 @@ export interface TwoFactorRequest extends BaseEventRequest {
|
|
|
6829
6839
|
secretBase32Encoded?: string;
|
|
6830
6840
|
twoFactorId?: string;
|
|
6831
6841
|
}
|
|
6842
|
+
/**
|
|
6843
|
+
* Something that can be required and thus also optional. This currently extends Enableable because anything that is
|
|
6844
|
+
* required/optional is almost always enableable as well.
|
|
6845
|
+
*
|
|
6846
|
+
* @author Brian Pontarelli
|
|
6847
|
+
*/
|
|
6848
|
+
export interface Requirable extends Enableable {
|
|
6849
|
+
required?: boolean;
|
|
6850
|
+
}
|
|
6832
6851
|
/**
|
|
6833
6852
|
* @author Daniel DeGroff
|
|
6834
6853
|
*/
|
|
@@ -7148,10 +7167,19 @@ export interface LoginRecordSearchRequest {
|
|
|
7148
7167
|
*/
|
|
7149
7168
|
export interface UserCreateEvent extends BaseUserEvent {
|
|
7150
7169
|
}
|
|
7170
|
+
/**
|
|
7171
|
+
* User Action Reason API request object.
|
|
7172
|
+
*
|
|
7173
|
+
* @author Brian Pontarelli
|
|
7174
|
+
*/
|
|
7175
|
+
export interface UserActionReasonRequest {
|
|
7176
|
+
userActionReason?: UserActionReason;
|
|
7177
|
+
}
|
|
7151
7178
|
/**
|
|
7152
7179
|
* @author Lyle Schemmerling
|
|
7153
7180
|
*/
|
|
7154
7181
|
export interface BaseSAMLv2IdentityProvider<D extends BaseIdentityProviderApplicationConfiguration> extends BaseIdentityProvider<D> {
|
|
7182
|
+
assertionDecryptionConfiguration?: SAMLv2AssertionDecryptionConfiguration;
|
|
7155
7183
|
emailClaim?: string;
|
|
7156
7184
|
keyId?: UUID;
|
|
7157
7185
|
uniqueIdClaim?: string;
|
|
@@ -7166,14 +7194,6 @@ export interface BaseSAMLv2IdentityProvider<D extends BaseIdentityProviderApplic
|
|
|
7166
7194
|
export interface WebAuthnRegistrationExtensionOptions {
|
|
7167
7195
|
credProps?: boolean;
|
|
7168
7196
|
}
|
|
7169
|
-
/**
|
|
7170
|
-
* User Action Reason API request object.
|
|
7171
|
-
*
|
|
7172
|
-
* @author Brian Pontarelli
|
|
7173
|
-
*/
|
|
7174
|
-
export interface UserActionReasonRequest {
|
|
7175
|
-
userActionReason?: UserActionReason;
|
|
7176
|
-
}
|
|
7177
7197
|
/**
|
|
7178
7198
|
* @author Daniel DeGroff
|
|
7179
7199
|
*/
|
|
@@ -8014,14 +8034,6 @@ export interface RefreshTokenSlidingWindowConfiguration {
|
|
|
8014
8034
|
export interface ThemeSearchRequest {
|
|
8015
8035
|
search?: ThemeSearchCriteria;
|
|
8016
8036
|
}
|
|
8017
|
-
/**
|
|
8018
|
-
* Search request for Consents
|
|
8019
|
-
*
|
|
8020
|
-
* @author Spencer Witt
|
|
8021
|
-
*/
|
|
8022
|
-
export interface ConsentSearchRequest {
|
|
8023
|
-
search?: ConsentSearchCriteria;
|
|
8024
|
-
}
|
|
8025
8037
|
/**
|
|
8026
8038
|
* @author Daniel DeGroff
|
|
8027
8039
|
*/
|
|
@@ -8030,6 +8042,14 @@ export declare enum ObjectState {
|
|
|
8030
8042
|
Inactive = "Inactive",
|
|
8031
8043
|
PendingDelete = "PendingDelete"
|
|
8032
8044
|
}
|
|
8045
|
+
/**
|
|
8046
|
+
* Search request for Consents
|
|
8047
|
+
*
|
|
8048
|
+
* @author Spencer Witt
|
|
8049
|
+
*/
|
|
8050
|
+
export interface ConsentSearchRequest {
|
|
8051
|
+
search?: ConsentSearchCriteria;
|
|
8052
|
+
}
|
|
8033
8053
|
/**
|
|
8034
8054
|
* Search request for Identity Providers
|
|
8035
8055
|
*
|
|
@@ -8044,6 +8064,7 @@ export interface IdentityProviderSearchRequest {
|
|
|
8044
8064
|
export interface RefreshTokenRevocationPolicy {
|
|
8045
8065
|
onLoginPrevented?: boolean;
|
|
8046
8066
|
onMultiFactorEnable?: boolean;
|
|
8067
|
+
onOneTimeTokenReuse?: boolean;
|
|
8047
8068
|
onPasswordChanged?: boolean;
|
|
8048
8069
|
}
|
|
8049
8070
|
/**
|
|
@@ -8371,6 +8392,14 @@ export interface WebAuthnCredential {
|
|
|
8371
8392
|
export interface TestEvent extends BaseEvent {
|
|
8372
8393
|
message?: string;
|
|
8373
8394
|
}
|
|
8395
|
+
/**
|
|
8396
|
+
* Configuration for encrypted assertions when acting as SAML Service Provider
|
|
8397
|
+
*
|
|
8398
|
+
* @author Jaret Hendrickson
|
|
8399
|
+
*/
|
|
8400
|
+
export interface SAMLv2AssertionDecryptionConfiguration extends Enableable {
|
|
8401
|
+
keyTransportDecryptionKeyId?: UUID;
|
|
8402
|
+
}
|
|
8374
8403
|
/**
|
|
8375
8404
|
* Models the Refresh Token Revoke Event. This event might be for a single token, a user
|
|
8376
8405
|
* or an entire application.
|
|
@@ -8514,6 +8543,7 @@ export interface IdentityProviderLink {
|
|
|
8514
8543
|
*/
|
|
8515
8544
|
export interface RegistrationResponse {
|
|
8516
8545
|
refreshToken?: string;
|
|
8546
|
+
refreshTokenId?: UUID;
|
|
8517
8547
|
registration?: UserRegistration;
|
|
8518
8548
|
registrationVerificationId?: string;
|
|
8519
8549
|
registrationVerificationOneTimeCode?: string;
|
|
@@ -8695,6 +8725,7 @@ export interface AuditLogResponse {
|
|
|
8695
8725
|
* @author sanjay
|
|
8696
8726
|
*/
|
|
8697
8727
|
export interface APIKey {
|
|
8728
|
+
expirationInstant?: number;
|
|
8698
8729
|
id?: UUID;
|
|
8699
8730
|
insertInstant?: number;
|
|
8700
8731
|
ipAccessControlListId?: UUID;
|
|
@@ -8820,13 +8851,6 @@ export interface EntityTypePermission {
|
|
|
8820
8851
|
lastUpdateInstant?: number;
|
|
8821
8852
|
name?: string;
|
|
8822
8853
|
}
|
|
8823
|
-
/**
|
|
8824
|
-
* This class is the user query. It provides a build pattern as well as public fields for use on forms and in actions.
|
|
8825
|
-
*
|
|
8826
|
-
* @author Brian Pontarelli
|
|
8827
|
-
*/
|
|
8828
|
-
export interface UserSearchCriteria extends BaseElasticSearchCriteria {
|
|
8829
|
-
}
|
|
8830
8854
|
/**
|
|
8831
8855
|
* User comment search response
|
|
8832
8856
|
*
|
|
@@ -8836,6 +8860,13 @@ export interface UserCommentSearchResponse {
|
|
|
8836
8860
|
total?: number;
|
|
8837
8861
|
userComments?: Array<UserComment>;
|
|
8838
8862
|
}
|
|
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
|
+
}
|
|
8839
8870
|
/**
|
|
8840
8871
|
* @author Daniel DeGroff
|
|
8841
8872
|
*/
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
* language governing permissions and limitations under the License.
|
|
16
16
|
*/
|
|
17
17
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
-
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.
|
|
18
|
+
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;
|
|
19
19
|
const DefaultRESTClientBuilder_1 = require("./DefaultRESTClientBuilder");
|
|
20
20
|
const url_1 = require("url");
|
|
21
21
|
class FusionAuthClient {
|
|
@@ -5675,18 +5675,6 @@ var UserVerificationRequirement;
|
|
|
5675
5675
|
UserVerificationRequirement["preferred"] = "preferred";
|
|
5676
5676
|
UserVerificationRequirement["discouraged"] = "discouraged";
|
|
5677
5677
|
})(UserVerificationRequirement = exports.UserVerificationRequirement || (exports.UserVerificationRequirement = {}));
|
|
5678
|
-
/**
|
|
5679
|
-
* @author Brian Pontarelli
|
|
5680
|
-
*/
|
|
5681
|
-
var ExpiryUnit;
|
|
5682
|
-
(function (ExpiryUnit) {
|
|
5683
|
-
ExpiryUnit["MINUTES"] = "MINUTES";
|
|
5684
|
-
ExpiryUnit["HOURS"] = "HOURS";
|
|
5685
|
-
ExpiryUnit["DAYS"] = "DAYS";
|
|
5686
|
-
ExpiryUnit["WEEKS"] = "WEEKS";
|
|
5687
|
-
ExpiryUnit["MONTHS"] = "MONTHS";
|
|
5688
|
-
ExpiryUnit["YEARS"] = "YEARS";
|
|
5689
|
-
})(ExpiryUnit = exports.ExpiryUnit || (exports.ExpiryUnit = {}));
|
|
5690
5678
|
/**
|
|
5691
5679
|
* @author Brett Guy
|
|
5692
5680
|
*/
|
|
@@ -5718,6 +5706,18 @@ var CanonicalizationMethod;
|
|
|
5718
5706
|
CanonicalizationMethod["inclusive"] = "inclusive";
|
|
5719
5707
|
CanonicalizationMethod["inclusive_with_comments"] = "inclusive_with_comments";
|
|
5720
5708
|
})(CanonicalizationMethod = exports.CanonicalizationMethod || (exports.CanonicalizationMethod = {}));
|
|
5709
|
+
/**
|
|
5710
|
+
* @author Brian Pontarelli
|
|
5711
|
+
*/
|
|
5712
|
+
var ExpiryUnit;
|
|
5713
|
+
(function (ExpiryUnit) {
|
|
5714
|
+
ExpiryUnit["MINUTES"] = "MINUTES";
|
|
5715
|
+
ExpiryUnit["HOURS"] = "HOURS";
|
|
5716
|
+
ExpiryUnit["DAYS"] = "DAYS";
|
|
5717
|
+
ExpiryUnit["WEEKS"] = "WEEKS";
|
|
5718
|
+
ExpiryUnit["MONTHS"] = "MONTHS";
|
|
5719
|
+
ExpiryUnit["YEARS"] = "YEARS";
|
|
5720
|
+
})(ExpiryUnit = exports.ExpiryUnit || (exports.ExpiryUnit = {}));
|
|
5721
5721
|
/**
|
|
5722
5722
|
* @author Daniel DeGroff
|
|
5723
5723
|
*/
|