@fusionauth/typescript-client 1.41.0 → 1.43.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 +96 -30
- package/build/src/FusionAuthClient.js +32 -13
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +33 -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
|
@@ -700,27 +700,27 @@ export declare class FusionAuthClient {
|
|
|
700
700
|
*/
|
|
701
701
|
deleteWebhook(webhookId: UUID): Promise<ClientResponse<void>>;
|
|
702
702
|
/**
|
|
703
|
-
* Disable
|
|
703
|
+
* Disable two-factor authentication for a user.
|
|
704
704
|
*
|
|
705
|
-
* @param {UUID} userId The Id of the User for which you're disabling
|
|
705
|
+
* @param {UUID} userId The Id of the User for which you're disabling two-factor authentication.
|
|
706
706
|
* @param {string} methodId The two-factor method identifier you wish to disable
|
|
707
|
-
* @param {string} code The
|
|
707
|
+
* @param {string} code The two-factor code used verify the the caller knows the two-factor secret.
|
|
708
708
|
* @returns {Promise<ClientResponse<void>>}
|
|
709
709
|
*/
|
|
710
710
|
disableTwoFactor(userId: UUID, methodId: string, code: string): Promise<ClientResponse<void>>;
|
|
711
711
|
/**
|
|
712
|
-
* Disable
|
|
712
|
+
* Disable two-factor authentication for a user using a JSON body rather than URL parameters.
|
|
713
713
|
*
|
|
714
|
-
* @param {UUID} userId The Id of the User for which you're disabling
|
|
714
|
+
* @param {UUID} userId The Id of the User for which you're disabling two-factor authentication.
|
|
715
715
|
* @param {TwoFactorDisableRequest} request The request information that contains the code and methodId along with any event information.
|
|
716
716
|
* @returns {Promise<ClientResponse<void>>}
|
|
717
717
|
*/
|
|
718
718
|
disableTwoFactorWithRequest(userId: UUID, request: TwoFactorDisableRequest): Promise<ClientResponse<void>>;
|
|
719
719
|
/**
|
|
720
|
-
* Enable
|
|
720
|
+
* Enable two-factor authentication for a user.
|
|
721
721
|
*
|
|
722
|
-
* @param {UUID} userId The Id of the user to enable
|
|
723
|
-
* @param {TwoFactorRequest} request The two
|
|
722
|
+
* @param {UUID} userId The Id of the user to enable two-factor authentication.
|
|
723
|
+
* @param {TwoFactorRequest} request The two-factor enable request information.
|
|
724
724
|
* @returns {Promise<ClientResponse<TwoFactorResponse>>}
|
|
725
725
|
*/
|
|
726
726
|
enableTwoFactor(userId: UUID, request: TwoFactorRequest): Promise<ClientResponse<TwoFactorResponse>>;
|
|
@@ -729,7 +729,7 @@ export declare class FusionAuthClient {
|
|
|
729
729
|
* Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
|
|
730
730
|
*
|
|
731
731
|
* @param {string} code The authorization code returned on the /oauth2/authorize response.
|
|
732
|
-
* @param {string} client_id The unique client identifier. The client Id is the Id of the FusionAuth Application in which you
|
|
732
|
+
* @param {string} client_id The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
|
|
733
733
|
* @param {string} client_secret (Optional) The client secret. This value will be required if client authentication is enabled.
|
|
734
734
|
* @param {string} redirect_uri The URI to redirect to upon a successful request.
|
|
735
735
|
* @returns {Promise<ClientResponse<AccessToken>>}
|
|
@@ -740,7 +740,7 @@ export declare class FusionAuthClient {
|
|
|
740
740
|
* Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.
|
|
741
741
|
*
|
|
742
742
|
* @param {string} code The authorization code returned on the /oauth2/authorize response.
|
|
743
|
-
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you
|
|
743
|
+
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
|
|
744
744
|
* @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
|
|
745
745
|
* @param {string} redirect_uri The URI to redirect to upon a successful request.
|
|
746
746
|
* @param {string} code_verifier The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.
|
|
@@ -752,7 +752,7 @@ export declare class FusionAuthClient {
|
|
|
752
752
|
* If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.
|
|
753
753
|
*
|
|
754
754
|
* @param {string} refresh_token The refresh token that you would like to use to exchange for an access token.
|
|
755
|
-
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you
|
|
755
|
+
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
|
|
756
756
|
* @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
|
|
757
757
|
* @param {string} scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
|
|
758
758
|
* @param {string} user_code (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
|
|
@@ -772,7 +772,7 @@ export declare class FusionAuthClient {
|
|
|
772
772
|
*
|
|
773
773
|
* @param {string} username The login identifier of the user. The login identifier can be either the email or the username.
|
|
774
774
|
* @param {string} password The user’s password.
|
|
775
|
-
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you
|
|
775
|
+
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
|
|
776
776
|
* @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
|
|
777
777
|
* @param {string} scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
|
|
778
778
|
* @param {string} user_code (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
|
|
@@ -2710,6 +2710,7 @@ export interface APIKeyResponse {
|
|
|
2710
2710
|
* @author Daniel DeGroff
|
|
2711
2711
|
*/
|
|
2712
2712
|
export interface AppleApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
|
|
2713
|
+
bundleId?: string;
|
|
2713
2714
|
buttonText?: string;
|
|
2714
2715
|
keyId?: UUID;
|
|
2715
2716
|
scope?: string;
|
|
@@ -2720,6 +2721,7 @@ export interface AppleApplicationConfiguration extends BaseIdentityProviderAppli
|
|
|
2720
2721
|
* @author Daniel DeGroff
|
|
2721
2722
|
*/
|
|
2722
2723
|
export interface AppleIdentityProvider extends BaseIdentityProvider<AppleApplicationConfiguration> {
|
|
2724
|
+
bundleId?: string;
|
|
2723
2725
|
buttonText?: string;
|
|
2724
2726
|
keyId?: UUID;
|
|
2725
2727
|
scope?: string;
|
|
@@ -2836,6 +2838,7 @@ export interface ApplicationRegistrationDeletePolicy {
|
|
|
2836
2838
|
export interface ApplicationRequest extends BaseEventRequest {
|
|
2837
2839
|
application?: Application;
|
|
2838
2840
|
role?: ApplicationRole;
|
|
2841
|
+
sourceApplicationId?: UUID;
|
|
2839
2842
|
}
|
|
2840
2843
|
/**
|
|
2841
2844
|
* The Application API response.
|
|
@@ -3123,6 +3126,16 @@ export interface BaseMessengerConfiguration {
|
|
|
3123
3126
|
transport?: string;
|
|
3124
3127
|
type?: MessengerType;
|
|
3125
3128
|
}
|
|
3129
|
+
/**
|
|
3130
|
+
* @author Lyle Schemmerling
|
|
3131
|
+
*/
|
|
3132
|
+
export interface BaseSAMLv2IdentityProvider<D extends BaseIdentityProviderApplicationConfiguration> extends BaseIdentityProvider<D> {
|
|
3133
|
+
emailClaim?: string;
|
|
3134
|
+
keyId?: UUID;
|
|
3135
|
+
uniqueIdClaim?: string;
|
|
3136
|
+
useNameIdForEmail?: boolean;
|
|
3137
|
+
usernameClaim?: string;
|
|
3138
|
+
}
|
|
3126
3139
|
/**
|
|
3127
3140
|
* @author Brian Pontarelli
|
|
3128
3141
|
*/
|
|
@@ -4077,14 +4090,24 @@ export interface FacebookIdentityProvider extends BaseIdentityProvider<FacebookA
|
|
|
4077
4090
|
loginMethod?: IdentityProviderLoginMethod;
|
|
4078
4091
|
permissions?: string;
|
|
4079
4092
|
}
|
|
4093
|
+
/**
|
|
4094
|
+
* A policy to configure if and when the user-action is canceled prior to the expiration of the action.
|
|
4095
|
+
*
|
|
4096
|
+
* @author Daniel DeGroff
|
|
4097
|
+
*/
|
|
4098
|
+
export interface FailedAuthenticationActionCancelPolicy {
|
|
4099
|
+
onPasswordReset?: boolean;
|
|
4100
|
+
}
|
|
4080
4101
|
/**
|
|
4081
4102
|
* Configuration for the behavior of failed login attempts. This helps us protect against brute force password attacks.
|
|
4082
4103
|
*
|
|
4083
4104
|
* @author Daniel DeGroff
|
|
4084
4105
|
*/
|
|
4085
4106
|
export interface FailedAuthenticationConfiguration {
|
|
4107
|
+
actionCancelPolicy?: FailedAuthenticationActionCancelPolicy;
|
|
4086
4108
|
actionDuration?: number;
|
|
4087
4109
|
actionDurationUnit?: ExpiryUnit;
|
|
4110
|
+
emailUser?: boolean;
|
|
4088
4111
|
resetCountInSeconds?: number;
|
|
4089
4112
|
tooManyAttempts?: number;
|
|
4090
4113
|
userActionId?: UUID;
|
|
@@ -4655,11 +4678,8 @@ export declare enum IdentityProviderLinkingStrategy {
|
|
|
4655
4678
|
* @author Daniel DeGroff
|
|
4656
4679
|
*/
|
|
4657
4680
|
export interface IdentityProviderLinkRequest extends BaseEventRequest {
|
|
4658
|
-
|
|
4659
|
-
identityProviderId?: UUID;
|
|
4660
|
-
identityProviderUserId?: string;
|
|
4681
|
+
identityProviderLink?: IdentityProviderLink;
|
|
4661
4682
|
pendingIdPLinkId?: string;
|
|
4662
|
-
userId?: UUID;
|
|
4663
4683
|
}
|
|
4664
4684
|
/**
|
|
4665
4685
|
* @author Daniel DeGroff
|
|
@@ -5114,6 +5134,7 @@ export interface LambdaConfiguration {
|
|
|
5114
5134
|
accessTokenPopulateId?: UUID;
|
|
5115
5135
|
idTokenPopulateId?: UUID;
|
|
5116
5136
|
samlv2PopulateId?: UUID;
|
|
5137
|
+
selfServiceRegistrationValidationId?: UUID;
|
|
5117
5138
|
}
|
|
5118
5139
|
export interface LambdaConfiguration {
|
|
5119
5140
|
reconcileId?: UUID;
|
|
@@ -5173,7 +5194,8 @@ export declare enum LambdaType {
|
|
|
5173
5194
|
SCIMServerGroupRequestConverter = "SCIMServerGroupRequestConverter",
|
|
5174
5195
|
SCIMServerGroupResponseConverter = "SCIMServerGroupResponseConverter",
|
|
5175
5196
|
SCIMServerUserRequestConverter = "SCIMServerUserRequestConverter",
|
|
5176
|
-
SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter"
|
|
5197
|
+
SCIMServerUserResponseConverter = "SCIMServerUserResponseConverter",
|
|
5198
|
+
SelfServiceRegistrationValidation = "SelfServiceRegistrationValidation"
|
|
5177
5199
|
}
|
|
5178
5200
|
/**
|
|
5179
5201
|
* Models an LDAP connector.
|
|
@@ -5257,6 +5279,12 @@ export interface LoginConfiguration {
|
|
|
5257
5279
|
generateRefreshTokens?: boolean;
|
|
5258
5280
|
requireAuthentication?: boolean;
|
|
5259
5281
|
}
|
|
5282
|
+
/**
|
|
5283
|
+
* @author Daniel DeGroff
|
|
5284
|
+
*/
|
|
5285
|
+
export interface LoginHintConfiguration extends Enableable {
|
|
5286
|
+
parameterName?: string;
|
|
5287
|
+
}
|
|
5260
5288
|
export declare enum LoginIdType {
|
|
5261
5289
|
email = "email",
|
|
5262
5290
|
username = "username"
|
|
@@ -5347,6 +5375,7 @@ export interface LoginResponse {
|
|
|
5347
5375
|
actions?: Array<LoginPreventedResponse>;
|
|
5348
5376
|
changePasswordId?: string;
|
|
5349
5377
|
changePasswordReason?: ChangePasswordReason;
|
|
5378
|
+
configurableMethods?: Array<string>;
|
|
5350
5379
|
emailVerificationId?: string;
|
|
5351
5380
|
methods?: Array<TwoFactorMethod>;
|
|
5352
5381
|
pendingIdPLinkId?: string;
|
|
@@ -5526,7 +5555,8 @@ export interface MultiFactorEmailTemplate {
|
|
|
5526
5555
|
*/
|
|
5527
5556
|
export declare enum MultiFactorLoginPolicy {
|
|
5528
5557
|
Disabled = "Disabled",
|
|
5529
|
-
Enabled = "Enabled"
|
|
5558
|
+
Enabled = "Enabled",
|
|
5559
|
+
Required = "Required"
|
|
5530
5560
|
}
|
|
5531
5561
|
export interface MultiFactorSMSMethod extends Enableable {
|
|
5532
5562
|
messengerId?: UUID;
|
|
@@ -5568,12 +5598,20 @@ export interface NintendoIdentityProvider extends BaseIdentityProvider<NintendoA
|
|
|
5568
5598
|
*/
|
|
5569
5599
|
export interface NonTransactionalEvent {
|
|
5570
5600
|
}
|
|
5601
|
+
/**
|
|
5602
|
+
* @author Johnathon Wood
|
|
5603
|
+
*/
|
|
5604
|
+
export declare enum Oauth2AuthorizedURLValidationPolicy {
|
|
5605
|
+
AllowWildcards = "AllowWildcards",
|
|
5606
|
+
ExactMatch = "ExactMatch"
|
|
5607
|
+
}
|
|
5571
5608
|
/**
|
|
5572
5609
|
* @author Daniel DeGroff
|
|
5573
5610
|
*/
|
|
5574
5611
|
export interface OAuth2Configuration {
|
|
5575
5612
|
authorizedOriginURLs?: Array<string>;
|
|
5576
5613
|
authorizedRedirectURLs?: Array<string>;
|
|
5614
|
+
authorizedURLValidationPolicy?: Oauth2AuthorizedURLValidationPolicy;
|
|
5577
5615
|
clientAuthenticationPolicy?: ClientAuthenticationPolicy;
|
|
5578
5616
|
clientId?: string;
|
|
5579
5617
|
clientSecret?: string;
|
|
@@ -6109,6 +6147,7 @@ export interface RefreshTokenResponse {
|
|
|
6109
6147
|
*/
|
|
6110
6148
|
export interface RefreshTokenRevocationPolicy {
|
|
6111
6149
|
onLoginPrevented?: boolean;
|
|
6150
|
+
onMultiFactorEnable?: boolean;
|
|
6112
6151
|
onPasswordChanged?: boolean;
|
|
6113
6152
|
}
|
|
6114
6153
|
/**
|
|
@@ -6251,6 +6290,12 @@ export interface SAMLv2ApplicationConfiguration extends BaseIdentityProviderAppl
|
|
|
6251
6290
|
buttonImageURL?: string;
|
|
6252
6291
|
buttonText?: string;
|
|
6253
6292
|
}
|
|
6293
|
+
/**
|
|
6294
|
+
* @author Lyle Schemmerling
|
|
6295
|
+
*/
|
|
6296
|
+
export interface SAMLv2AssertionConfiguration {
|
|
6297
|
+
destination?: SAMLv2DestinationAssertionConfiguration;
|
|
6298
|
+
}
|
|
6254
6299
|
export interface SAMLv2Configuration extends Enableable {
|
|
6255
6300
|
audience?: string;
|
|
6256
6301
|
authorizedRedirectURLs?: Array<string>;
|
|
@@ -6266,26 +6311,39 @@ export interface SAMLv2Configuration extends Enableable {
|
|
|
6266
6311
|
xmlSignatureC14nMethod?: CanonicalizationMethod;
|
|
6267
6312
|
xmlSignatureLocation?: XMLSignatureLocation;
|
|
6268
6313
|
}
|
|
6314
|
+
/**
|
|
6315
|
+
* @author Lyle Schemmerling
|
|
6316
|
+
*/
|
|
6317
|
+
export interface SAMLv2DestinationAssertionConfiguration {
|
|
6318
|
+
alternates?: Array<string>;
|
|
6319
|
+
policy?: SAMLv2DestinationAssertionPolicy;
|
|
6320
|
+
}
|
|
6321
|
+
/**
|
|
6322
|
+
* @author Lyle Schemmerling
|
|
6323
|
+
*/
|
|
6324
|
+
export declare enum SAMLv2DestinationAssertionPolicy {
|
|
6325
|
+
Enabled = "Enabled",
|
|
6326
|
+
Disabled = "Disabled",
|
|
6327
|
+
AllowAlternates = "AllowAlternates"
|
|
6328
|
+
}
|
|
6269
6329
|
/**
|
|
6270
6330
|
* SAML v2 identity provider configuration.
|
|
6271
6331
|
*
|
|
6272
6332
|
* @author Brian Pontarelli
|
|
6273
6333
|
*/
|
|
6274
|
-
export interface SAMLv2IdentityProvider extends
|
|
6334
|
+
export interface SAMLv2IdentityProvider extends BaseSAMLv2IdentityProvider<SAMLv2ApplicationConfiguration> {
|
|
6335
|
+
assertionConfiguration?: SAMLv2AssertionConfiguration;
|
|
6275
6336
|
buttonImageURL?: string;
|
|
6276
6337
|
buttonText?: string;
|
|
6277
6338
|
domains?: Array<string>;
|
|
6278
|
-
emailClaim?: string;
|
|
6279
6339
|
idpEndpoint?: string;
|
|
6340
|
+
idpInitiatedConfiguration?: SAMLv2IdpInitiatedConfiguration;
|
|
6280
6341
|
issuer?: string;
|
|
6281
|
-
|
|
6342
|
+
loginHintConfiguration?: LoginHintConfiguration;
|
|
6282
6343
|
nameIdFormat?: string;
|
|
6283
6344
|
postRequest?: boolean;
|
|
6284
6345
|
requestSigningKeyId?: UUID;
|
|
6285
6346
|
signRequest?: boolean;
|
|
6286
|
-
uniqueIdClaim?: string;
|
|
6287
|
-
useNameIdForEmail?: boolean;
|
|
6288
|
-
usernameClaim?: string;
|
|
6289
6347
|
xmlSignatureC14nMethod?: CanonicalizationMethod;
|
|
6290
6348
|
}
|
|
6291
6349
|
/**
|
|
@@ -6293,18 +6351,21 @@ export interface SAMLv2IdentityProvider extends BaseIdentityProvider<SAMLv2Appli
|
|
|
6293
6351
|
*/
|
|
6294
6352
|
export interface SAMLv2IdPInitiatedApplicationConfiguration extends BaseIdentityProviderApplicationConfiguration {
|
|
6295
6353
|
}
|
|
6354
|
+
/**
|
|
6355
|
+
* Config for regular SAML IDP configurations that support IdP initiated requests
|
|
6356
|
+
*
|
|
6357
|
+
* @author Lyle Schemmerling
|
|
6358
|
+
*/
|
|
6359
|
+
export interface SAMLv2IdpInitiatedConfiguration extends Enableable {
|
|
6360
|
+
issuer?: string;
|
|
6361
|
+
}
|
|
6296
6362
|
/**
|
|
6297
6363
|
* SAML v2 IdP Initiated identity provider configuration.
|
|
6298
6364
|
*
|
|
6299
6365
|
* @author Daniel DeGroff
|
|
6300
6366
|
*/
|
|
6301
|
-
export interface SAMLv2IdPInitiatedIdentityProvider extends
|
|
6302
|
-
emailClaim?: string;
|
|
6367
|
+
export interface SAMLv2IdPInitiatedIdentityProvider extends BaseSAMLv2IdentityProvider<SAMLv2IdPInitiatedApplicationConfiguration> {
|
|
6303
6368
|
issuer?: string;
|
|
6304
|
-
keyId?: UUID;
|
|
6305
|
-
uniqueIdClaim?: string;
|
|
6306
|
-
useNameIdForEmail?: boolean;
|
|
6307
|
-
usernameClaim?: string;
|
|
6308
6369
|
}
|
|
6309
6370
|
/**
|
|
6310
6371
|
* IdP Initiated login configuration
|
|
@@ -6527,6 +6588,7 @@ export interface SystemConfigurationResponse {
|
|
|
6527
6588
|
* @author Daniel DeGroff
|
|
6528
6589
|
*/
|
|
6529
6590
|
export interface SystemLogsExportRequest extends BaseExportRequest {
|
|
6591
|
+
includeArchived?: boolean;
|
|
6530
6592
|
lastNBytes?: number;
|
|
6531
6593
|
}
|
|
6532
6594
|
export interface Templates {
|
|
@@ -6558,6 +6620,8 @@ export interface Templates {
|
|
|
6558
6620
|
oauth2Register?: string;
|
|
6559
6621
|
oauth2StartIdPLink?: string;
|
|
6560
6622
|
oauth2TwoFactor?: string;
|
|
6623
|
+
oauth2TwoFactorEnable?: string;
|
|
6624
|
+
oauth2TwoFactorEnableComplete?: string;
|
|
6561
6625
|
oauth2TwoFactorMethods?: string;
|
|
6562
6626
|
oauth2Wait?: string;
|
|
6563
6627
|
oauth2WebAuthn?: string;
|
|
@@ -6962,11 +7026,13 @@ export interface TwoFactorRequest extends BaseEventRequest {
|
|
|
6962
7026
|
mobilePhone?: string;
|
|
6963
7027
|
secret?: string;
|
|
6964
7028
|
secretBase32Encoded?: string;
|
|
7029
|
+
twoFactorId?: string;
|
|
6965
7030
|
}
|
|
6966
7031
|
/**
|
|
6967
7032
|
* @author Daniel DeGroff
|
|
6968
7033
|
*/
|
|
6969
7034
|
export interface TwoFactorResponse {
|
|
7035
|
+
code?: string;
|
|
6970
7036
|
recoveryCodes?: Array<string>;
|
|
6971
7037
|
}
|
|
6972
7038
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
/*
|
|
3
|
-
* Copyright (c) 2019-
|
|
3
|
+
* Copyright (c) 2019-2023, FusionAuth, All Rights Reserved
|
|
4
4
|
*
|
|
5
5
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
6
6
|
* you may not use this file except in compliance with the License.
|
|
@@ -1278,11 +1278,11 @@ class FusionAuthClient {
|
|
|
1278
1278
|
.go();
|
|
1279
1279
|
}
|
|
1280
1280
|
/**
|
|
1281
|
-
* Disable
|
|
1281
|
+
* Disable two-factor authentication for a user.
|
|
1282
1282
|
*
|
|
1283
|
-
* @param {UUID} userId The Id of the User for which you're disabling
|
|
1283
|
+
* @param {UUID} userId The Id of the User for which you're disabling two-factor authentication.
|
|
1284
1284
|
* @param {string} methodId The two-factor method identifier you wish to disable
|
|
1285
|
-
* @param {string} code The
|
|
1285
|
+
* @param {string} code The two-factor code used verify the the caller knows the two-factor secret.
|
|
1286
1286
|
* @returns {Promise<ClientResponse<void>>}
|
|
1287
1287
|
*/
|
|
1288
1288
|
disableTwoFactor(userId, methodId, code) {
|
|
@@ -1295,9 +1295,9 @@ class FusionAuthClient {
|
|
|
1295
1295
|
.go();
|
|
1296
1296
|
}
|
|
1297
1297
|
/**
|
|
1298
|
-
* Disable
|
|
1298
|
+
* Disable two-factor authentication for a user using a JSON body rather than URL parameters.
|
|
1299
1299
|
*
|
|
1300
|
-
* @param {UUID} userId The Id of the User for which you're disabling
|
|
1300
|
+
* @param {UUID} userId The Id of the User for which you're disabling two-factor authentication.
|
|
1301
1301
|
* @param {TwoFactorDisableRequest} request The request information that contains the code and methodId along with any event information.
|
|
1302
1302
|
* @returns {Promise<ClientResponse<void>>}
|
|
1303
1303
|
*/
|
|
@@ -1310,10 +1310,10 @@ class FusionAuthClient {
|
|
|
1310
1310
|
.go();
|
|
1311
1311
|
}
|
|
1312
1312
|
/**
|
|
1313
|
-
* Enable
|
|
1313
|
+
* Enable two-factor authentication for a user.
|
|
1314
1314
|
*
|
|
1315
|
-
* @param {UUID} userId The Id of the user to enable
|
|
1316
|
-
* @param {TwoFactorRequest} request The two
|
|
1315
|
+
* @param {UUID} userId The Id of the user to enable two-factor authentication.
|
|
1316
|
+
* @param {TwoFactorRequest} request The two-factor enable request information.
|
|
1317
1317
|
* @returns {Promise<ClientResponse<TwoFactorResponse>>}
|
|
1318
1318
|
*/
|
|
1319
1319
|
enableTwoFactor(userId, request) {
|
|
@@ -1329,7 +1329,7 @@ class FusionAuthClient {
|
|
|
1329
1329
|
* Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint for an access token.
|
|
1330
1330
|
*
|
|
1331
1331
|
* @param {string} code The authorization code returned on the /oauth2/authorize response.
|
|
1332
|
-
* @param {string} client_id The unique client identifier. The client Id is the Id of the FusionAuth Application in which you
|
|
1332
|
+
* @param {string} client_id The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate.
|
|
1333
1333
|
* @param {string} client_secret (Optional) The client secret. This value will be required if client authentication is enabled.
|
|
1334
1334
|
* @param {string} redirect_uri The URI to redirect to upon a successful request.
|
|
1335
1335
|
* @returns {Promise<ClientResponse<AccessToken>>}
|
|
@@ -1352,7 +1352,7 @@ class FusionAuthClient {
|
|
|
1352
1352
|
* Makes a request to the Token endpoint to exchange the authorization code returned from the Authorize endpoint and a code_verifier for an access token.
|
|
1353
1353
|
*
|
|
1354
1354
|
* @param {string} code The authorization code returned on the /oauth2/authorize response.
|
|
1355
|
-
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you
|
|
1355
|
+
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
|
|
1356
1356
|
* @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
|
|
1357
1357
|
* @param {string} redirect_uri The URI to redirect to upon a successful request.
|
|
1358
1358
|
* @param {string} code_verifier The random string generated previously. Will be compared with the code_challenge sent previously, which allows the OAuth provider to authenticate your app.
|
|
@@ -1377,7 +1377,7 @@ class FusionAuthClient {
|
|
|
1377
1377
|
* If you will be using the Refresh Token Grant, you will make a request to the Token endpoint to exchange the user’s refresh token for an access token.
|
|
1378
1378
|
*
|
|
1379
1379
|
* @param {string} refresh_token The refresh token that you would like to use to exchange for an access token.
|
|
1380
|
-
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you
|
|
1380
|
+
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
|
|
1381
1381
|
* @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
|
|
1382
1382
|
* @param {string} scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
|
|
1383
1383
|
* @param {string} user_code (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
|
|
@@ -1416,7 +1416,7 @@ class FusionAuthClient {
|
|
|
1416
1416
|
*
|
|
1417
1417
|
* @param {string} username The login identifier of the user. The login identifier can be either the email or the username.
|
|
1418
1418
|
* @param {string} password The user’s password.
|
|
1419
|
-
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you
|
|
1419
|
+
* @param {string} client_id (Optional) The unique client identifier. The client Id is the Id of the FusionAuth Application in which you are attempting to authenticate. This parameter is optional when the Authorization header is provided.
|
|
1420
1420
|
* @param {string} client_secret (Optional) The client secret. This value may optionally be provided in the request body instead of the Authorization header.
|
|
1421
1421
|
* @param {string} scope (Optional) This parameter is optional and if omitted, the same scope requested during the authorization request will be used. If provided the scopes must match those requested during the initial authorization request.
|
|
1422
1422
|
* @param {string} user_code (Optional) The end-user verification code. This code is required if using this endpoint to approve the Device Authorization.
|
|
@@ -5262,6 +5262,7 @@ var LambdaType;
|
|
|
5262
5262
|
LambdaType["SCIMServerGroupResponseConverter"] = "SCIMServerGroupResponseConverter";
|
|
5263
5263
|
LambdaType["SCIMServerUserRequestConverter"] = "SCIMServerUserRequestConverter";
|
|
5264
5264
|
LambdaType["SCIMServerUserResponseConverter"] = "SCIMServerUserResponseConverter";
|
|
5265
|
+
LambdaType["SelfServiceRegistrationValidation"] = "SelfServiceRegistrationValidation";
|
|
5265
5266
|
})(LambdaType = exports.LambdaType || (exports.LambdaType = {}));
|
|
5266
5267
|
var LDAPSecurityMethod;
|
|
5267
5268
|
(function (LDAPSecurityMethod) {
|
|
@@ -5305,7 +5306,16 @@ var MultiFactorLoginPolicy;
|
|
|
5305
5306
|
(function (MultiFactorLoginPolicy) {
|
|
5306
5307
|
MultiFactorLoginPolicy["Disabled"] = "Disabled";
|
|
5307
5308
|
MultiFactorLoginPolicy["Enabled"] = "Enabled";
|
|
5309
|
+
MultiFactorLoginPolicy["Required"] = "Required";
|
|
5308
5310
|
})(MultiFactorLoginPolicy = exports.MultiFactorLoginPolicy || (exports.MultiFactorLoginPolicy = {}));
|
|
5311
|
+
/**
|
|
5312
|
+
* @author Johnathon Wood
|
|
5313
|
+
*/
|
|
5314
|
+
var Oauth2AuthorizedURLValidationPolicy;
|
|
5315
|
+
(function (Oauth2AuthorizedURLValidationPolicy) {
|
|
5316
|
+
Oauth2AuthorizedURLValidationPolicy["AllowWildcards"] = "AllowWildcards";
|
|
5317
|
+
Oauth2AuthorizedURLValidationPolicy["ExactMatch"] = "ExactMatch";
|
|
5318
|
+
})(Oauth2AuthorizedURLValidationPolicy = exports.Oauth2AuthorizedURLValidationPolicy || (exports.Oauth2AuthorizedURLValidationPolicy = {}));
|
|
5309
5319
|
var OAuthErrorReason;
|
|
5310
5320
|
(function (OAuthErrorReason) {
|
|
5311
5321
|
OAuthErrorReason["auth_code_not_found"] = "auth_code_not_found";
|
|
@@ -5469,6 +5479,15 @@ var SAMLLogoutBehavior;
|
|
|
5469
5479
|
SAMLLogoutBehavior["AllParticipants"] = "AllParticipants";
|
|
5470
5480
|
SAMLLogoutBehavior["OnlyOriginator"] = "OnlyOriginator";
|
|
5471
5481
|
})(SAMLLogoutBehavior = exports.SAMLLogoutBehavior || (exports.SAMLLogoutBehavior = {}));
|
|
5482
|
+
/**
|
|
5483
|
+
* @author Lyle Schemmerling
|
|
5484
|
+
*/
|
|
5485
|
+
var SAMLv2DestinationAssertionPolicy;
|
|
5486
|
+
(function (SAMLv2DestinationAssertionPolicy) {
|
|
5487
|
+
SAMLv2DestinationAssertionPolicy["Enabled"] = "Enabled";
|
|
5488
|
+
SAMLv2DestinationAssertionPolicy["Disabled"] = "Disabled";
|
|
5489
|
+
SAMLv2DestinationAssertionPolicy["AllowAlternates"] = "AllowAlternates";
|
|
5490
|
+
})(SAMLv2DestinationAssertionPolicy = exports.SAMLv2DestinationAssertionPolicy || (exports.SAMLv2DestinationAssertionPolicy = {}));
|
|
5472
5491
|
/**
|
|
5473
5492
|
* @author Daniel DeGroff
|
|
5474
5493
|
*/
|