@fusionauth/typescript-client 1.36.0 → 1.39.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 +268 -34
- package/build/src/FusionAuthClient.js +108 -11
- package/build/src/FusionAuthClient.js.map +1 -1
- package/dist/fusionauth-typescript-client.js +109 -12
- package/dist/fusionauth-typescript-client.min.js +1 -1
- package/dist/fusionauth-typescript-client.min.js.map +1 -1
- package/package.json +1 -1
|
@@ -78,9 +78,9 @@ export declare class FusionAuthClient {
|
|
|
78
78
|
/**
|
|
79
79
|
* Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
|
|
80
80
|
* When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
|
|
81
|
-
* your password, you must obtain a
|
|
81
|
+
* your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.
|
|
82
82
|
*
|
|
83
|
-
* An HTTP status code of
|
|
83
|
+
* An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
|
|
84
84
|
*
|
|
85
85
|
* @param {string} changePasswordId The change password Id used to find the user. This value is generated by FusionAuth once the change password workflow has been initiated.
|
|
86
86
|
* @returns {Promise<ClientResponse<void>>}
|
|
@@ -89,9 +89,9 @@ export declare class FusionAuthClient {
|
|
|
89
89
|
/**
|
|
90
90
|
* Check to see if the user must obtain a Trust Token Id in order to complete a change password request.
|
|
91
91
|
* When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
|
|
92
|
-
* your password, you must obtain a
|
|
92
|
+
* your password, you must obtain a Trust Token by completing a Two-Factor Step-Up authentication.
|
|
93
93
|
*
|
|
94
|
-
* An HTTP status code of
|
|
94
|
+
* An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
|
|
95
95
|
*
|
|
96
96
|
* @param {string} encodedJWT The encoded JWT (access token).
|
|
97
97
|
* @returns {Promise<ClientResponse<void>>}
|
|
@@ -100,9 +100,9 @@ export declare class FusionAuthClient {
|
|
|
100
100
|
/**
|
|
101
101
|
* Check to see if the user must obtain a Trust Request Id in order to complete a change password request.
|
|
102
102
|
* When a user has enabled Two-Factor authentication, before you are allowed to use the Change Password API to change
|
|
103
|
-
* your password, you must obtain a
|
|
103
|
+
* your password, you must obtain a Trust Request Id by completing a Two-Factor Step-Up authentication.
|
|
104
104
|
*
|
|
105
|
-
* An HTTP status code of
|
|
105
|
+
* An HTTP status code of 400 with a general error code of [TrustTokenRequired] indicates that a Trust Token is required to make a POST request to this API.
|
|
106
106
|
*
|
|
107
107
|
* @param {string} loginId The loginId of the User that you intend to change the password for.
|
|
108
108
|
* @returns {Promise<ClientResponse<void>>}
|
|
@@ -888,6 +888,16 @@ export declare class FusionAuthClient {
|
|
|
888
888
|
* @returns {Promise<ClientResponse<LoginResponse>>}
|
|
889
889
|
*/
|
|
890
890
|
loginPing(userId: UUID, applicationId: UUID, callerIPAddress: string): Promise<ClientResponse<LoginResponse>>;
|
|
891
|
+
/**
|
|
892
|
+
* Sends a ping to FusionAuth indicating that the user was automatically logged into an application. When using
|
|
893
|
+
* FusionAuth's SSO or your own, you should call this if the user is already logged in centrally, but accesses an
|
|
894
|
+
* application where they no longer have a session. This helps correctly track login counts, times and helps with
|
|
895
|
+
* reporting.
|
|
896
|
+
*
|
|
897
|
+
* @param {LoginPingRequest} request The login request that contains the user credentials used to log them in.
|
|
898
|
+
* @returns {Promise<ClientResponse<LoginResponse>>}
|
|
899
|
+
*/
|
|
900
|
+
loginPingWithRequest(request: LoginPingRequest): Promise<ClientResponse<LoginResponse>>;
|
|
891
901
|
/**
|
|
892
902
|
* The Logout API is intended to be used to remove the refresh token and access token cookies if they exist on the
|
|
893
903
|
* client and revoke the refresh token stored. This API does nothing if the request does not contain an access
|
|
@@ -1636,12 +1646,12 @@ export declare class FusionAuthClient {
|
|
|
1636
1646
|
*/
|
|
1637
1647
|
retrieveRecentLogins(offset: number, limit: number): Promise<ClientResponse<RecentLoginResponse>>;
|
|
1638
1648
|
/**
|
|
1639
|
-
* Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token
|
|
1649
|
+
* Retrieves a single refresh token by unique Id. This is not the same thing as the string value of the refresh token. If you have that, you already have what you need.
|
|
1640
1650
|
*
|
|
1641
|
-
* @param {UUID}
|
|
1651
|
+
* @param {UUID} tokenId The Id of the token.
|
|
1642
1652
|
* @returns {Promise<ClientResponse<RefreshTokenResponse>>}
|
|
1643
1653
|
*/
|
|
1644
|
-
retrieveRefreshTokenById(
|
|
1654
|
+
retrieveRefreshTokenById(tokenId: UUID): Promise<ClientResponse<RefreshTokenResponse>>;
|
|
1645
1655
|
/**
|
|
1646
1656
|
* Retrieves the refresh tokens that belong to the user with the given Id.
|
|
1647
1657
|
*
|
|
@@ -1720,6 +1730,18 @@ export declare class FusionAuthClient {
|
|
|
1720
1730
|
* @returns {Promise<ClientResponse<TwoFactorRecoveryCodeResponse>>}
|
|
1721
1731
|
*/
|
|
1722
1732
|
retrieveTwoFactorRecoveryCodes(userId: UUID): Promise<ClientResponse<TwoFactorRecoveryCodeResponse>>;
|
|
1733
|
+
/**
|
|
1734
|
+
* Retrieve a user's two-factor status.
|
|
1735
|
+
*
|
|
1736
|
+
* This can be used to see if a user will need to complete a two-factor challenge to complete a login,
|
|
1737
|
+
* and optionally identify the state of the two-factor trust across various applications.
|
|
1738
|
+
*
|
|
1739
|
+
* @param {UUID} userId The user Id to retrieve the Two-Factor status.
|
|
1740
|
+
* @param {UUID} applicationId The optional applicationId to verify.
|
|
1741
|
+
* @param {string} twoFactorTrustId The optional two-factor trust Id to verify.
|
|
1742
|
+
* @returns {Promise<ClientResponse<TwoFactorStatusResponse>>}
|
|
1743
|
+
*/
|
|
1744
|
+
retrieveTwoFactorStatus(userId: UUID, applicationId: UUID, twoFactorTrustId: string): Promise<ClientResponse<TwoFactorStatusResponse>>;
|
|
1723
1745
|
/**
|
|
1724
1746
|
* Retrieves the user for the given Id.
|
|
1725
1747
|
*
|
|
@@ -2026,6 +2048,13 @@ export declare class FusionAuthClient {
|
|
|
2026
2048
|
* @returns {Promise<ClientResponse<GroupMemberSearchResponse>>}
|
|
2027
2049
|
*/
|
|
2028
2050
|
searchGroupMembers(request: GroupMemberSearchRequest): Promise<ClientResponse<GroupMemberSearchResponse>>;
|
|
2051
|
+
/**
|
|
2052
|
+
* Searches groups with the specified criteria and pagination.
|
|
2053
|
+
*
|
|
2054
|
+
* @param {GroupSearchRequest} request The search criteria and pagination information.
|
|
2055
|
+
* @returns {Promise<ClientResponse<GroupSearchResponse>>}
|
|
2056
|
+
*/
|
|
2057
|
+
searchGroups(request: GroupSearchRequest): Promise<ClientResponse<GroupSearchResponse>>;
|
|
2029
2058
|
/**
|
|
2030
2059
|
* Searches the IP Access Control Lists with the specified criteria and pagination.
|
|
2031
2060
|
*
|
|
@@ -2459,6 +2488,15 @@ export declare class FusionAuthClient {
|
|
|
2459
2488
|
* @returns {Promise<ClientResponse<void>>}
|
|
2460
2489
|
*/
|
|
2461
2490
|
verifyEmailAddress(request: VerifyEmailRequest): Promise<ClientResponse<void>>;
|
|
2491
|
+
/**
|
|
2492
|
+
* Administratively verify a user's email address. Use this method to bypass email verification for the user.
|
|
2493
|
+
*
|
|
2494
|
+
* The request body will contain the userId to be verified. An API key is required when sending the userId in the request body.
|
|
2495
|
+
*
|
|
2496
|
+
* @param {VerifyEmailRequest} request The request that contains the userId to verify.
|
|
2497
|
+
* @returns {Promise<ClientResponse<void>>}
|
|
2498
|
+
*/
|
|
2499
|
+
verifyEmailAddressByUserId(request: VerifyEmailRequest): Promise<ClientResponse<void>>;
|
|
2462
2500
|
/**
|
|
2463
2501
|
* Confirms an application registration. The Id given is usually from an email sent to the user.
|
|
2464
2502
|
*
|
|
@@ -2502,6 +2540,7 @@ export interface AccessToken {
|
|
|
2502
2540
|
expires_in?: number;
|
|
2503
2541
|
id_token?: string;
|
|
2504
2542
|
refresh_token?: string;
|
|
2543
|
+
refresh_token_id?: UUID;
|
|
2505
2544
|
scope?: string;
|
|
2506
2545
|
token_type?: TokenType;
|
|
2507
2546
|
userId?: UUID;
|
|
@@ -2548,6 +2587,9 @@ export declare enum Algorithm {
|
|
|
2548
2587
|
HS256 = "HS256",
|
|
2549
2588
|
HS384 = "HS384",
|
|
2550
2589
|
HS512 = "HS512",
|
|
2590
|
+
PS256 = "PS256",
|
|
2591
|
+
PS384 = "PS384",
|
|
2592
|
+
PS512 = "PS512",
|
|
2551
2593
|
RS256 = "RS256",
|
|
2552
2594
|
RS384 = "RS384",
|
|
2553
2595
|
RS512 = "RS512",
|
|
@@ -2622,6 +2664,7 @@ export interface Application {
|
|
|
2622
2664
|
cleanSpeakConfiguration?: CleanSpeakConfiguration;
|
|
2623
2665
|
data?: Record<string, any>;
|
|
2624
2666
|
emailConfiguration?: ApplicationEmailConfiguration;
|
|
2667
|
+
externalIdentifierConfiguration?: ApplicationExternalIdentifierConfiguration;
|
|
2625
2668
|
formConfiguration?: ApplicationFormConfiguration;
|
|
2626
2669
|
id?: UUID;
|
|
2627
2670
|
insertInstant?: number;
|
|
@@ -2668,11 +2711,10 @@ export interface ApplicationEmailConfiguration {
|
|
|
2668
2711
|
twoFactorMethodRemoveEmailTemplateId?: UUID;
|
|
2669
2712
|
}
|
|
2670
2713
|
/**
|
|
2671
|
-
*
|
|
2672
|
-
*
|
|
2673
|
-
* @author Brian Pontarelli
|
|
2714
|
+
* @author Daniel DeGroff
|
|
2674
2715
|
*/
|
|
2675
|
-
export interface
|
|
2716
|
+
export interface ApplicationExternalIdentifierConfiguration {
|
|
2717
|
+
twoFactorTrustIdTimeToLiveInSeconds?: number;
|
|
2676
2718
|
}
|
|
2677
2719
|
/**
|
|
2678
2720
|
* @author Daniel DeGroff
|
|
@@ -2686,7 +2728,17 @@ export interface ApplicationFormConfiguration {
|
|
|
2686
2728
|
*/
|
|
2687
2729
|
export interface ApplicationMultiFactorConfiguration {
|
|
2688
2730
|
email?: MultiFactorEmailTemplate;
|
|
2731
|
+
loginPolicy?: MultiFactorLoginPolicy;
|
|
2689
2732
|
sms?: MultiFactorSMSTemplate;
|
|
2733
|
+
trustPolicy?: ApplicationMultiFactorTrustPolicy;
|
|
2734
|
+
}
|
|
2735
|
+
/**
|
|
2736
|
+
* @author Daniel DeGroff
|
|
2737
|
+
*/
|
|
2738
|
+
export declare enum ApplicationMultiFactorTrustPolicy {
|
|
2739
|
+
Any = "Any",
|
|
2740
|
+
This = "This",
|
|
2741
|
+
None = "None"
|
|
2690
2742
|
}
|
|
2691
2743
|
/**
|
|
2692
2744
|
* A Application-level policy for deleting Users.
|
|
@@ -2704,7 +2756,6 @@ export interface ApplicationRegistrationDeletePolicy {
|
|
|
2704
2756
|
export interface ApplicationRequest extends BaseEventRequest {
|
|
2705
2757
|
application?: Application;
|
|
2706
2758
|
role?: ApplicationRole;
|
|
2707
|
-
webhookIds?: Array<UUID>;
|
|
2708
2759
|
}
|
|
2709
2760
|
/**
|
|
2710
2761
|
* The Application API response.
|
|
@@ -3247,6 +3298,7 @@ export interface EmailAddress {
|
|
|
3247
3298
|
*/
|
|
3248
3299
|
export interface EmailConfiguration {
|
|
3249
3300
|
additionalHeaders?: Array<EmailHeader>;
|
|
3301
|
+
debug?: boolean;
|
|
3250
3302
|
defaultFromEmail?: string;
|
|
3251
3303
|
defaultFromName?: string;
|
|
3252
3304
|
emailUpdateEmailTemplateId?: UUID;
|
|
@@ -3692,6 +3744,18 @@ export declare enum EventType {
|
|
|
3692
3744
|
AuditLogCreate = "audit-log.create",
|
|
3693
3745
|
EventLogCreate = "event-log.create",
|
|
3694
3746
|
KickstartSuccess = "kickstart.success",
|
|
3747
|
+
GroupCreate = "group.create",
|
|
3748
|
+
GroupCreateComplete = "group.create.complete",
|
|
3749
|
+
GroupDelete = "group.delete",
|
|
3750
|
+
GroupDeleteComplete = "group.delete.complete",
|
|
3751
|
+
GroupMemberAdd = "group.member.add",
|
|
3752
|
+
GroupMemberAddComplete = "group.member.add.complete",
|
|
3753
|
+
GroupMemberRemove = "group.member.remove",
|
|
3754
|
+
GroupMemberRemoveComplete = "group.member.remove.complete",
|
|
3755
|
+
GroupMemberUpdate = "group.member.update",
|
|
3756
|
+
GroupMemberUpdateComplete = "group.member.update.complete",
|
|
3757
|
+
GroupUpdate = "group.update",
|
|
3758
|
+
GroupUpdateComplete = "group.update.complete",
|
|
3695
3759
|
UserAction = "user.action",
|
|
3696
3760
|
UserBulkCreate = "user.bulk.create",
|
|
3697
3761
|
UserCreate = "user.create",
|
|
@@ -4114,6 +4178,38 @@ export interface Group {
|
|
|
4114
4178
|
roles?: Record<UUID, Array<ApplicationRole>>;
|
|
4115
4179
|
tenantId?: UUID;
|
|
4116
4180
|
}
|
|
4181
|
+
/**
|
|
4182
|
+
* Models the Group Created Event.
|
|
4183
|
+
*
|
|
4184
|
+
* @author Daniel DeGroff
|
|
4185
|
+
*/
|
|
4186
|
+
export interface GroupCreateCompleteEvent extends BaseEvent {
|
|
4187
|
+
group?: Group;
|
|
4188
|
+
}
|
|
4189
|
+
/**
|
|
4190
|
+
* Models the Group Create Event.
|
|
4191
|
+
*
|
|
4192
|
+
* @author Daniel DeGroff
|
|
4193
|
+
*/
|
|
4194
|
+
export interface GroupCreateEvent extends BaseEvent {
|
|
4195
|
+
group?: Group;
|
|
4196
|
+
}
|
|
4197
|
+
/**
|
|
4198
|
+
* Models the Group Create Complete Event.
|
|
4199
|
+
*
|
|
4200
|
+
* @author Daniel DeGroff
|
|
4201
|
+
*/
|
|
4202
|
+
export interface GroupDeleteCompleteEvent extends BaseEvent {
|
|
4203
|
+
group?: Group;
|
|
4204
|
+
}
|
|
4205
|
+
/**
|
|
4206
|
+
* Models the Group Delete Event.
|
|
4207
|
+
*
|
|
4208
|
+
* @author Daniel DeGroff
|
|
4209
|
+
*/
|
|
4210
|
+
export interface GroupDeleteEvent extends BaseEvent {
|
|
4211
|
+
group?: Group;
|
|
4212
|
+
}
|
|
4117
4213
|
/**
|
|
4118
4214
|
* A User's membership into a Group
|
|
4119
4215
|
*
|
|
@@ -4127,6 +4223,42 @@ export interface GroupMember {
|
|
|
4127
4223
|
user?: User;
|
|
4128
4224
|
userId?: UUID;
|
|
4129
4225
|
}
|
|
4226
|
+
/**
|
|
4227
|
+
* Models the Group Member Add Complete Event.
|
|
4228
|
+
*
|
|
4229
|
+
* @author Daniel DeGroff
|
|
4230
|
+
*/
|
|
4231
|
+
export interface GroupMemberAddCompleteEvent extends BaseEvent {
|
|
4232
|
+
group?: Group;
|
|
4233
|
+
members?: Array<GroupMember>;
|
|
4234
|
+
}
|
|
4235
|
+
/**
|
|
4236
|
+
* Models the Group Member Add Event.
|
|
4237
|
+
*
|
|
4238
|
+
* @author Daniel DeGroff
|
|
4239
|
+
*/
|
|
4240
|
+
export interface GroupMemberAddEvent extends BaseEvent {
|
|
4241
|
+
group?: Group;
|
|
4242
|
+
members?: Array<GroupMember>;
|
|
4243
|
+
}
|
|
4244
|
+
/**
|
|
4245
|
+
* Models the Group Member Remove Complete Event.
|
|
4246
|
+
*
|
|
4247
|
+
* @author Daniel DeGroff
|
|
4248
|
+
*/
|
|
4249
|
+
export interface GroupMemberRemoveCompleteEvent extends BaseEvent {
|
|
4250
|
+
group?: Group;
|
|
4251
|
+
members?: Array<GroupMember>;
|
|
4252
|
+
}
|
|
4253
|
+
/**
|
|
4254
|
+
* Models the Group Member Remove Event.
|
|
4255
|
+
*
|
|
4256
|
+
* @author Daniel DeGroff
|
|
4257
|
+
*/
|
|
4258
|
+
export interface GroupMemberRemoveEvent extends BaseEvent {
|
|
4259
|
+
group?: Group;
|
|
4260
|
+
members?: Array<GroupMember>;
|
|
4261
|
+
}
|
|
4130
4262
|
/**
|
|
4131
4263
|
* Search criteria for Group Members
|
|
4132
4264
|
*
|
|
@@ -4134,6 +4266,7 @@ export interface GroupMember {
|
|
|
4134
4266
|
*/
|
|
4135
4267
|
export interface GroupMemberSearchCriteria extends BaseSearchCriteria {
|
|
4136
4268
|
groupId?: UUID;
|
|
4269
|
+
tenantId?: UUID;
|
|
4137
4270
|
userId?: UUID;
|
|
4138
4271
|
}
|
|
4139
4272
|
/**
|
|
@@ -4153,6 +4286,24 @@ export interface GroupMemberSearchResponse {
|
|
|
4153
4286
|
members?: Array<GroupMember>;
|
|
4154
4287
|
total?: number;
|
|
4155
4288
|
}
|
|
4289
|
+
/**
|
|
4290
|
+
* Models the Group Member Update Complete Event.
|
|
4291
|
+
*
|
|
4292
|
+
* @author Daniel DeGroff
|
|
4293
|
+
*/
|
|
4294
|
+
export interface GroupMemberUpdateCompleteEvent extends BaseEvent {
|
|
4295
|
+
group?: Group;
|
|
4296
|
+
members?: Array<GroupMember>;
|
|
4297
|
+
}
|
|
4298
|
+
/**
|
|
4299
|
+
* Models the Group Member Update Event.
|
|
4300
|
+
*
|
|
4301
|
+
* @author Daniel DeGroff
|
|
4302
|
+
*/
|
|
4303
|
+
export interface GroupMemberUpdateEvent extends BaseEvent {
|
|
4304
|
+
group?: Group;
|
|
4305
|
+
members?: Array<GroupMember>;
|
|
4306
|
+
}
|
|
4156
4307
|
/**
|
|
4157
4308
|
* Group API request object.
|
|
4158
4309
|
*
|
|
@@ -4171,6 +4322,51 @@ export interface GroupResponse {
|
|
|
4171
4322
|
group?: Group;
|
|
4172
4323
|
groups?: Array<Group>;
|
|
4173
4324
|
}
|
|
4325
|
+
/**
|
|
4326
|
+
* Search criteria for Groups
|
|
4327
|
+
*
|
|
4328
|
+
* @author Daniel DeGroff
|
|
4329
|
+
*/
|
|
4330
|
+
export interface GroupSearchCriteria extends BaseSearchCriteria {
|
|
4331
|
+
id?: UUID;
|
|
4332
|
+
name?: string;
|
|
4333
|
+
tenantId?: UUID;
|
|
4334
|
+
}
|
|
4335
|
+
/**
|
|
4336
|
+
* Search request for Groups.
|
|
4337
|
+
*
|
|
4338
|
+
* @author Daniel DeGroff
|
|
4339
|
+
*/
|
|
4340
|
+
export interface GroupSearchRequest {
|
|
4341
|
+
search?: GroupSearchCriteria;
|
|
4342
|
+
}
|
|
4343
|
+
/**
|
|
4344
|
+
* Search response for Groups
|
|
4345
|
+
*
|
|
4346
|
+
* @author Daniel DeGroff
|
|
4347
|
+
*/
|
|
4348
|
+
export interface GroupSearchResponse {
|
|
4349
|
+
groups?: Array<Group>;
|
|
4350
|
+
total?: number;
|
|
4351
|
+
}
|
|
4352
|
+
/**
|
|
4353
|
+
* Models the Group Update Complete Event.
|
|
4354
|
+
*
|
|
4355
|
+
* @author Daniel DeGroff
|
|
4356
|
+
*/
|
|
4357
|
+
export interface GroupUpdateCompleteEvent extends BaseEvent {
|
|
4358
|
+
group?: Group;
|
|
4359
|
+
original?: Group;
|
|
4360
|
+
}
|
|
4361
|
+
/**
|
|
4362
|
+
* Models the Group Update Event.
|
|
4363
|
+
*
|
|
4364
|
+
* @author Daniel DeGroff
|
|
4365
|
+
*/
|
|
4366
|
+
export interface GroupUpdateEvent extends BaseEvent {
|
|
4367
|
+
group?: Group;
|
|
4368
|
+
original?: Group;
|
|
4369
|
+
}
|
|
4174
4370
|
export interface HistoryItem {
|
|
4175
4371
|
actionerUserId?: UUID;
|
|
4176
4372
|
comment?: string;
|
|
@@ -4245,6 +4441,7 @@ export interface IdentityProviderLink {
|
|
|
4245
4441
|
*/
|
|
4246
4442
|
export declare enum IdentityProviderLinkingStrategy {
|
|
4247
4443
|
CreatePendingLink = "CreatePendingLink",
|
|
4444
|
+
Disabled = "Disabled",
|
|
4248
4445
|
LinkAnonymously = "LinkAnonymously",
|
|
4249
4446
|
LinkByEmail = "LinkByEmail",
|
|
4250
4447
|
LinkByEmailForExistingUser = "LinkByEmailForExistingUser",
|
|
@@ -4548,7 +4745,7 @@ export interface JWTConfiguration extends Enableable {
|
|
|
4548
4745
|
timeToLiveInSeconds?: number;
|
|
4549
4746
|
}
|
|
4550
4747
|
/**
|
|
4551
|
-
* Models the JWT public key Refresh Token Revoke Event
|
|
4748
|
+
* Models the JWT public key Refresh Token Revoke Event. This event might be for a single
|
|
4552
4749
|
* token, a user or an entire application.
|
|
4553
4750
|
*
|
|
4554
4751
|
* @author Brian Pontarelli
|
|
@@ -4571,16 +4768,18 @@ export interface JWTRefreshEvent extends BaseEvent {
|
|
|
4571
4768
|
/**
|
|
4572
4769
|
* API response for refreshing a JWT with a Refresh Token.
|
|
4573
4770
|
* <p>
|
|
4574
|
-
* Using a different response object from RefreshTokenResponse because the retrieve response will return an object for refreshToken, and this is a
|
|
4771
|
+
* Using a different response object from RefreshTokenResponse because the retrieve response will return an object for refreshToken, and this is a
|
|
4772
|
+
* string.
|
|
4575
4773
|
*
|
|
4576
4774
|
* @author Daniel DeGroff
|
|
4577
4775
|
*/
|
|
4578
4776
|
export interface JWTRefreshResponse {
|
|
4579
4777
|
refreshToken?: string;
|
|
4778
|
+
refreshTokenId?: UUID;
|
|
4580
4779
|
token?: string;
|
|
4581
4780
|
}
|
|
4582
4781
|
/**
|
|
4583
|
-
* Models the Refresh Token Revoke Event
|
|
4782
|
+
* Models the Refresh Token Revoke Event. This event might be for a single token, a user
|
|
4584
4783
|
* or an entire application.
|
|
4585
4784
|
*
|
|
4586
4785
|
* @author Brian Pontarelli
|
|
@@ -4588,6 +4787,7 @@ export interface JWTRefreshResponse {
|
|
|
4588
4787
|
export interface JWTRefreshTokenRevokeEvent extends BaseEvent {
|
|
4589
4788
|
applicationId?: UUID;
|
|
4590
4789
|
applicationTimeToLiveInSeconds?: Record<UUID, number>;
|
|
4790
|
+
refreshToken?: RefreshToken;
|
|
4591
4791
|
user?: User;
|
|
4592
4792
|
userId?: UUID;
|
|
4593
4793
|
}
|
|
@@ -4859,6 +5059,14 @@ export declare enum LoginIdType {
|
|
|
4859
5059
|
email = "email",
|
|
4860
5060
|
username = "username"
|
|
4861
5061
|
}
|
|
5062
|
+
/**
|
|
5063
|
+
* Login Ping API request object.
|
|
5064
|
+
*
|
|
5065
|
+
* @author Daniel DeGroff
|
|
5066
|
+
*/
|
|
5067
|
+
export interface LoginPingRequest extends BaseLoginRequest {
|
|
5068
|
+
userId?: UUID;
|
|
5069
|
+
}
|
|
4862
5070
|
/**
|
|
4863
5071
|
* The summary of the action that is preventing login to be returned on the login response.
|
|
4864
5072
|
*
|
|
@@ -4941,6 +5149,7 @@ export interface LoginResponse {
|
|
|
4941
5149
|
methods?: Array<TwoFactorMethod>;
|
|
4942
5150
|
pendingIdPLinkId?: string;
|
|
4943
5151
|
refreshToken?: string;
|
|
5152
|
+
refreshTokenId?: UUID;
|
|
4944
5153
|
registrationVerificationId?: string;
|
|
4945
5154
|
state?: Record<string, any>;
|
|
4946
5155
|
threatsDetected?: Array<AuthenticationThreats>;
|
|
@@ -5109,6 +5318,13 @@ export interface MultiFactorEmailMethod extends Enableable {
|
|
|
5109
5318
|
export interface MultiFactorEmailTemplate {
|
|
5110
5319
|
templateId?: UUID;
|
|
5111
5320
|
}
|
|
5321
|
+
/**
|
|
5322
|
+
* @author Daniel DeGroff
|
|
5323
|
+
*/
|
|
5324
|
+
export declare enum MultiFactorLoginPolicy {
|
|
5325
|
+
Disabled = "Disabled",
|
|
5326
|
+
Enabled = "Enabled"
|
|
5327
|
+
}
|
|
5112
5328
|
export interface MultiFactorSMSMethod extends Enableable {
|
|
5113
5329
|
messengerId?: UUID;
|
|
5114
5330
|
templateId?: UUID;
|
|
@@ -5532,11 +5748,13 @@ export interface ReactorStatus {
|
|
|
5532
5748
|
advancedLambdas?: ReactorFeatureStatus;
|
|
5533
5749
|
advancedMultiFactorAuthentication?: ReactorFeatureStatus;
|
|
5534
5750
|
advancedRegistration?: ReactorFeatureStatus;
|
|
5751
|
+
applicationMultiFactorAuthentication?: ReactorFeatureStatus;
|
|
5535
5752
|
applicationThemes?: ReactorFeatureStatus;
|
|
5536
5753
|
breachedPasswordDetection?: ReactorFeatureStatus;
|
|
5537
5754
|
connectors?: ReactorFeatureStatus;
|
|
5538
5755
|
entityManagement?: ReactorFeatureStatus;
|
|
5539
5756
|
expiration?: string;
|
|
5757
|
+
licenseAttributes?: Record<string, string>;
|
|
5540
5758
|
licensed?: boolean;
|
|
5541
5759
|
scimServer?: ReactorFeatureStatus;
|
|
5542
5760
|
threatDetection?: ReactorFeatureStatus;
|
|
@@ -6144,6 +6362,7 @@ export interface TenantLoginConfiguration {
|
|
|
6144
6362
|
export interface TenantMultiFactorConfiguration {
|
|
6145
6363
|
authenticator?: MultiFactorAuthenticatorMethod;
|
|
6146
6364
|
email?: MultiFactorEmailMethod;
|
|
6365
|
+
loginPolicy?: MultiFactorLoginPolicy;
|
|
6147
6366
|
sms?: MultiFactorSMSMethod;
|
|
6148
6367
|
}
|
|
6149
6368
|
export interface TenantOAuth2Configuration {
|
|
@@ -6172,6 +6391,7 @@ export interface TenantRegistrationConfiguration {
|
|
|
6172
6391
|
export interface TenantRequest extends BaseEventRequest {
|
|
6173
6392
|
sourceTenantId?: UUID;
|
|
6174
6393
|
tenant?: Tenant;
|
|
6394
|
+
webhookIds?: Array<UUID>;
|
|
6175
6395
|
}
|
|
6176
6396
|
/**
|
|
6177
6397
|
* @author Daniel DeGroff
|
|
@@ -6448,6 +6668,18 @@ export interface TwoFactorStartResponse {
|
|
|
6448
6668
|
methods?: Array<TwoFactorMethod>;
|
|
6449
6669
|
twoFactorId?: string;
|
|
6450
6670
|
}
|
|
6671
|
+
/**
|
|
6672
|
+
* @author Daniel DeGroff
|
|
6673
|
+
*/
|
|
6674
|
+
export interface TwoFactorStatusResponse {
|
|
6675
|
+
trusts?: Array<TwoFactorTrust>;
|
|
6676
|
+
twoFactorTrustId?: string;
|
|
6677
|
+
}
|
|
6678
|
+
export interface TwoFactorTrust {
|
|
6679
|
+
applicationId?: UUID;
|
|
6680
|
+
expiration?: number;
|
|
6681
|
+
startInstant?: number;
|
|
6682
|
+
}
|
|
6451
6683
|
export interface UIConfiguration {
|
|
6452
6684
|
headerColor?: string;
|
|
6453
6685
|
logoURL?: string;
|
|
@@ -6524,7 +6756,7 @@ export interface UserAction {
|
|
|
6524
6756
|
userNotificationsEnabled?: boolean;
|
|
6525
6757
|
}
|
|
6526
6758
|
/**
|
|
6527
|
-
* Models the user action
|
|
6759
|
+
* Models the user action Event.
|
|
6528
6760
|
*
|
|
6529
6761
|
* @author Brian Pontarelli
|
|
6530
6762
|
*/
|
|
@@ -6642,7 +6874,7 @@ export interface UserActionResponse {
|
|
|
6642
6874
|
userActions?: Array<UserAction>;
|
|
6643
6875
|
}
|
|
6644
6876
|
/**
|
|
6645
|
-
* Models the User Bulk Create Event
|
|
6877
|
+
* Models the User Bulk Create Event.
|
|
6646
6878
|
*
|
|
6647
6879
|
* @author Brian Pontarelli
|
|
6648
6880
|
*/
|
|
@@ -6711,7 +6943,7 @@ export interface UserConsentResponse {
|
|
|
6711
6943
|
userConsents?: Array<UserConsent>;
|
|
6712
6944
|
}
|
|
6713
6945
|
/**
|
|
6714
|
-
* Models the User Created Event
|
|
6946
|
+
* Models the User Created Event.
|
|
6715
6947
|
* <p>
|
|
6716
6948
|
* This is different than the user.create event in that it will be sent after the user has been created. This event cannot be made transactional.
|
|
6717
6949
|
*
|
|
@@ -6721,7 +6953,7 @@ export interface UserCreateCompleteEvent extends BaseEvent {
|
|
|
6721
6953
|
user?: User;
|
|
6722
6954
|
}
|
|
6723
6955
|
/**
|
|
6724
|
-
* Models the User Create Event
|
|
6956
|
+
* Models the User Create Event.
|
|
6725
6957
|
*
|
|
6726
6958
|
* @author Brian Pontarelli
|
|
6727
6959
|
*/
|
|
@@ -6729,7 +6961,7 @@ export interface UserCreateEvent extends BaseEvent {
|
|
|
6729
6961
|
user?: User;
|
|
6730
6962
|
}
|
|
6731
6963
|
/**
|
|
6732
|
-
* Models the User Deactivate Event
|
|
6964
|
+
* Models the User Deactivate Event.
|
|
6733
6965
|
*
|
|
6734
6966
|
* @author Brian Pontarelli
|
|
6735
6967
|
*/
|
|
@@ -6797,7 +7029,7 @@ export interface UserEmailUpdateEvent extends BaseEvent {
|
|
|
6797
7029
|
user?: User;
|
|
6798
7030
|
}
|
|
6799
7031
|
/**
|
|
6800
|
-
* Models the User Email Verify Event
|
|
7032
|
+
* Models the User Email Verify Event.
|
|
6801
7033
|
*
|
|
6802
7034
|
* @author Trevor Smith
|
|
6803
7035
|
*/
|
|
@@ -6929,7 +7161,7 @@ export interface UserPasswordUpdateEvent extends BaseEvent {
|
|
|
6929
7161
|
user?: User;
|
|
6930
7162
|
}
|
|
6931
7163
|
/**
|
|
6932
|
-
* Models the User Reactivate Event
|
|
7164
|
+
* Models the User Reactivate Event.
|
|
6933
7165
|
*
|
|
6934
7166
|
* @author Brian Pontarelli
|
|
6935
7167
|
*/
|
|
@@ -6959,9 +7191,10 @@ export interface UserRegistration {
|
|
|
6959
7191
|
verified?: boolean;
|
|
6960
7192
|
}
|
|
6961
7193
|
/**
|
|
6962
|
-
* Models the User Created Registration Event
|
|
7194
|
+
* Models the User Created Registration Event.
|
|
6963
7195
|
* <p>
|
|
6964
|
-
* This is different than the user.registration.create event in that it will be sent after the user has been created. This event cannot be made
|
|
7196
|
+
* This is different than the user.registration.create event in that it will be sent after the user has been created. This event cannot be made
|
|
7197
|
+
* transactional.
|
|
6965
7198
|
*
|
|
6966
7199
|
* @author Daniel DeGroff
|
|
6967
7200
|
*/
|
|
@@ -6971,7 +7204,7 @@ export interface UserRegistrationCreateCompleteEvent extends BaseEvent {
|
|
|
6971
7204
|
user?: User;
|
|
6972
7205
|
}
|
|
6973
7206
|
/**
|
|
6974
|
-
* Models the User Create Registration Event
|
|
7207
|
+
* Models the User Create Registration Event.
|
|
6975
7208
|
*
|
|
6976
7209
|
* @author Daniel DeGroff
|
|
6977
7210
|
*/
|
|
@@ -6981,7 +7214,7 @@ export interface UserRegistrationCreateEvent extends BaseEvent {
|
|
|
6981
7214
|
user?: User;
|
|
6982
7215
|
}
|
|
6983
7216
|
/**
|
|
6984
|
-
* Models the User Deleted Registration Event
|
|
7217
|
+
* Models the User Deleted Registration Event.
|
|
6985
7218
|
* <p>
|
|
6986
7219
|
* This is different than user.registration.delete in that it is sent after the TX has been committed. This event cannot be transactional.
|
|
6987
7220
|
*
|
|
@@ -6993,7 +7226,7 @@ export interface UserRegistrationDeleteCompleteEvent extends BaseEvent {
|
|
|
6993
7226
|
user?: User;
|
|
6994
7227
|
}
|
|
6995
7228
|
/**
|
|
6996
|
-
* Models the User Delete Registration Event
|
|
7229
|
+
* Models the User Delete Registration Event.
|
|
6997
7230
|
*
|
|
6998
7231
|
* @author Daniel DeGroff
|
|
6999
7232
|
*/
|
|
@@ -7003,7 +7236,7 @@ export interface UserRegistrationDeleteEvent extends BaseEvent {
|
|
|
7003
7236
|
user?: User;
|
|
7004
7237
|
}
|
|
7005
7238
|
/**
|
|
7006
|
-
* Models the User Update Registration Event
|
|
7239
|
+
* Models the User Update Registration Event.
|
|
7007
7240
|
* <p>
|
|
7008
7241
|
* This is different than user.registration.update in that it is sent after this event completes, this cannot be transactional.
|
|
7009
7242
|
*
|
|
@@ -7016,7 +7249,7 @@ export interface UserRegistrationUpdateCompleteEvent extends BaseEvent {
|
|
|
7016
7249
|
user?: User;
|
|
7017
7250
|
}
|
|
7018
7251
|
/**
|
|
7019
|
-
* Models the User Update Registration Event
|
|
7252
|
+
* Models the User Update Registration Event.
|
|
7020
7253
|
*
|
|
7021
7254
|
* @author Daniel DeGroff
|
|
7022
7255
|
*/
|
|
@@ -7027,7 +7260,7 @@ export interface UserRegistrationUpdateEvent extends BaseEvent {
|
|
|
7027
7260
|
user?: User;
|
|
7028
7261
|
}
|
|
7029
7262
|
/**
|
|
7030
|
-
* Models the User Registration Verified Event
|
|
7263
|
+
* Models the User Registration Verified Event.
|
|
7031
7264
|
*
|
|
7032
7265
|
* @author Trevor Smith
|
|
7033
7266
|
*/
|
|
@@ -7111,7 +7344,7 @@ export interface UserUpdateCompleteEvent extends BaseEvent {
|
|
|
7111
7344
|
user?: User;
|
|
7112
7345
|
}
|
|
7113
7346
|
/**
|
|
7114
|
-
* Models the User Update Event
|
|
7347
|
+
* Models the User Update Event.
|
|
7115
7348
|
*
|
|
7116
7349
|
* @author Brian Pontarelli
|
|
7117
7350
|
*/
|
|
@@ -7137,6 +7370,7 @@ export declare enum VerificationStrategy {
|
|
|
7137
7370
|
*/
|
|
7138
7371
|
export interface VerifyEmailRequest extends BaseEventRequest {
|
|
7139
7372
|
oneTimeCode?: string;
|
|
7373
|
+
userId?: UUID;
|
|
7140
7374
|
verificationId?: string;
|
|
7141
7375
|
}
|
|
7142
7376
|
/**
|
|
@@ -7172,7 +7406,6 @@ export interface VersionResponse {
|
|
|
7172
7406
|
* @author Brian Pontarelli
|
|
7173
7407
|
*/
|
|
7174
7408
|
export interface Webhook {
|
|
7175
|
-
applicationIds?: Array<UUID>;
|
|
7176
7409
|
connectTimeout?: number;
|
|
7177
7410
|
data?: Record<string, any>;
|
|
7178
7411
|
description?: string;
|
|
@@ -7186,6 +7419,7 @@ export interface Webhook {
|
|
|
7186
7419
|
lastUpdateInstant?: number;
|
|
7187
7420
|
readTimeout?: number;
|
|
7188
7421
|
sslCertificate?: string;
|
|
7422
|
+
tenantIds?: Array<UUID>;
|
|
7189
7423
|
url?: string;
|
|
7190
7424
|
}
|
|
7191
7425
|
/**
|