@logto/api 1.41.0 → 1.42.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/lib/generated-types/management.d.ts +760 -87
- package/package.json +1 -1
|
@@ -223,9 +223,7 @@ export interface paths {
|
|
|
223
223
|
post?: never;
|
|
224
224
|
/**
|
|
225
225
|
* Delete application legacy secret
|
|
226
|
-
* @description Delete the legacy secret for the application and replace it with
|
|
227
|
-
*
|
|
228
|
-
* Note: This operation does not "really" delete the legacy secret because it is still needed for internal validation. We may remove the display of the legacy secret (the `secret` field in the application response) in the future.
|
|
226
|
+
* @description Delete the legacy secret for the application and replace it with an internal secret used only by Logto. The internal secret is not returned by Management APIs and cannot be used for client authentication.
|
|
229
227
|
*/
|
|
230
228
|
delete: operations["DeleteApplicationLegacySecret"];
|
|
231
229
|
options?: never;
|
|
@@ -611,6 +609,78 @@ export interface paths {
|
|
|
611
609
|
patch?: never;
|
|
612
610
|
trace?: never;
|
|
613
611
|
};
|
|
612
|
+
"/api/configs/actions": {
|
|
613
|
+
parameters: {
|
|
614
|
+
query?: never;
|
|
615
|
+
header?: never;
|
|
616
|
+
path?: never;
|
|
617
|
+
cookie?: never;
|
|
618
|
+
};
|
|
619
|
+
/**
|
|
620
|
+
* Get all actions
|
|
621
|
+
* @description Get all action configurations for the tenant.
|
|
622
|
+
*/
|
|
623
|
+
get: operations["ListActions"];
|
|
624
|
+
put?: never;
|
|
625
|
+
post?: never;
|
|
626
|
+
delete?: never;
|
|
627
|
+
options?: never;
|
|
628
|
+
head?: never;
|
|
629
|
+
patch?: never;
|
|
630
|
+
trace?: never;
|
|
631
|
+
};
|
|
632
|
+
"/api/configs/actions/test": {
|
|
633
|
+
parameters: {
|
|
634
|
+
query?: never;
|
|
635
|
+
header?: never;
|
|
636
|
+
path?: never;
|
|
637
|
+
cookie?: never;
|
|
638
|
+
};
|
|
639
|
+
get?: never;
|
|
640
|
+
put?: never;
|
|
641
|
+
/**
|
|
642
|
+
* Test action
|
|
643
|
+
* @description Test an action script with a sample context.
|
|
644
|
+
*/
|
|
645
|
+
post: operations["TestAction"];
|
|
646
|
+
delete?: never;
|
|
647
|
+
options?: never;
|
|
648
|
+
head?: never;
|
|
649
|
+
patch?: never;
|
|
650
|
+
trace?: never;
|
|
651
|
+
};
|
|
652
|
+
"/api/configs/actions/{actionType}": {
|
|
653
|
+
parameters: {
|
|
654
|
+
query?: never;
|
|
655
|
+
header?: never;
|
|
656
|
+
path?: never;
|
|
657
|
+
cookie?: never;
|
|
658
|
+
};
|
|
659
|
+
/**
|
|
660
|
+
* Get action
|
|
661
|
+
* @description Get the action configuration for the given action type.
|
|
662
|
+
*/
|
|
663
|
+
get: operations["GetAction"];
|
|
664
|
+
/**
|
|
665
|
+
* Create or update action
|
|
666
|
+
* @description Create or update an action configuration for the given action type.
|
|
667
|
+
*/
|
|
668
|
+
put: operations["UpsertAction"];
|
|
669
|
+
post?: never;
|
|
670
|
+
/**
|
|
671
|
+
* Delete action
|
|
672
|
+
* @description Delete the action configuration for the given action type.
|
|
673
|
+
*/
|
|
674
|
+
delete: operations["DeleteAction"];
|
|
675
|
+
options?: never;
|
|
676
|
+
head?: never;
|
|
677
|
+
/**
|
|
678
|
+
* Update action
|
|
679
|
+
* @description Update the action configuration for the given action type.
|
|
680
|
+
*/
|
|
681
|
+
patch: operations["UpdateAction"];
|
|
682
|
+
trace?: never;
|
|
683
|
+
};
|
|
614
684
|
"/api/connectors": {
|
|
615
685
|
parameters: {
|
|
616
686
|
query?: never;
|
|
@@ -2111,6 +2181,30 @@ export interface paths {
|
|
|
2111
2181
|
patch?: never;
|
|
2112
2182
|
trace?: never;
|
|
2113
2183
|
};
|
|
2184
|
+
"/api/domains/{id}/verification-files": {
|
|
2185
|
+
parameters: {
|
|
2186
|
+
query?: never;
|
|
2187
|
+
header?: never;
|
|
2188
|
+
path?: never;
|
|
2189
|
+
cookie?: never;
|
|
2190
|
+
};
|
|
2191
|
+
/**
|
|
2192
|
+
* Get domain verification files
|
|
2193
|
+
* @description Get the verification files served from the custom domain.
|
|
2194
|
+
*/
|
|
2195
|
+
get: operations["ListDomainVerificationFiles"];
|
|
2196
|
+
/**
|
|
2197
|
+
* Replace domain verification files
|
|
2198
|
+
* @description Replace the verification files served from the custom domain.
|
|
2199
|
+
*/
|
|
2200
|
+
put: operations["ReplaceDomainVerificationFiles"];
|
|
2201
|
+
post?: never;
|
|
2202
|
+
delete?: never;
|
|
2203
|
+
options?: never;
|
|
2204
|
+
head?: never;
|
|
2205
|
+
patch?: never;
|
|
2206
|
+
trace?: never;
|
|
2207
|
+
};
|
|
2114
2208
|
"/api/domains/cleanup": {
|
|
2115
2209
|
parameters: {
|
|
2116
2210
|
query?: never;
|
|
@@ -3752,7 +3846,7 @@ export interface components {
|
|
|
3752
3846
|
Translation: string;
|
|
3753
3847
|
/**
|
|
3754
3848
|
* @deprecated
|
|
3755
|
-
* @description The
|
|
3849
|
+
* @description The legacy client secret. This field is omitted after the legacy secret has been replaced by an internal secret. Retrieve current application secrets from the `/api/applications/{id}/secrets` endpoints.
|
|
3756
3850
|
*/
|
|
3757
3851
|
ApplicationLegacySecret: string;
|
|
3758
3852
|
SamlApplicationResponse: {
|
|
@@ -3927,7 +4021,7 @@ export interface operations {
|
|
|
3927
4021
|
tenantId: string;
|
|
3928
4022
|
id: string;
|
|
3929
4023
|
name: string;
|
|
3930
|
-
secret
|
|
4024
|
+
secret?: components["schemas"]["ApplicationLegacySecret"];
|
|
3931
4025
|
description: string | null;
|
|
3932
4026
|
/** @enum {string} */
|
|
3933
4027
|
type: "Native" | "SPA" | "Traditional" | "MachineToMachine" | "Protected" | "SAML";
|
|
@@ -4083,7 +4177,7 @@ export interface operations {
|
|
|
4083
4177
|
tenantId: string;
|
|
4084
4178
|
id: string;
|
|
4085
4179
|
name: string;
|
|
4086
|
-
secret
|
|
4180
|
+
secret?: components["schemas"]["ApplicationLegacySecret"];
|
|
4087
4181
|
description: string | null;
|
|
4088
4182
|
/** @enum {string} */
|
|
4089
4183
|
type: "Native" | "SPA" | "Traditional" | "MachineToMachine" | "Protected" | "SAML";
|
|
@@ -4211,7 +4305,7 @@ export interface operations {
|
|
|
4211
4305
|
tenantId: string;
|
|
4212
4306
|
id: string;
|
|
4213
4307
|
name: string;
|
|
4214
|
-
secret
|
|
4308
|
+
secret?: components["schemas"]["ApplicationLegacySecret"];
|
|
4215
4309
|
description: string | null;
|
|
4216
4310
|
/** @enum {string} */
|
|
4217
4311
|
type: "Native" | "SPA" | "Traditional" | "MachineToMachine" | "Protected" | "SAML";
|
|
@@ -4436,7 +4530,7 @@ export interface operations {
|
|
|
4436
4530
|
tenantId: string;
|
|
4437
4531
|
id: string;
|
|
4438
4532
|
name: string;
|
|
4439
|
-
secret
|
|
4533
|
+
secret?: components["schemas"]["ApplicationLegacySecret"];
|
|
4440
4534
|
description: string | null;
|
|
4441
4535
|
/** @enum {string} */
|
|
4442
4536
|
type: "Native" | "SPA" | "Traditional" | "MachineToMachine" | "Protected" | "SAML";
|
|
@@ -5326,7 +5420,7 @@ export interface operations {
|
|
|
5326
5420
|
};
|
|
5327
5421
|
requestBody?: never;
|
|
5328
5422
|
responses: {
|
|
5329
|
-
/** @description
|
|
5423
|
+
/** @description The legacy secret was deleted successfully. */
|
|
5330
5424
|
200: {
|
|
5331
5425
|
headers: {
|
|
5332
5426
|
[name: string]: unknown;
|
|
@@ -5336,7 +5430,7 @@ export interface operations {
|
|
|
5336
5430
|
tenantId: string;
|
|
5337
5431
|
id: string;
|
|
5338
5432
|
name: string;
|
|
5339
|
-
secret
|
|
5433
|
+
secret?: string;
|
|
5340
5434
|
description: string | null;
|
|
5341
5435
|
/** @enum {string} */
|
|
5342
5436
|
type: "Native" | "SPA" | "Traditional" | "MachineToMachine" | "Protected" | "SAML";
|
|
@@ -5405,13 +5499,6 @@ export interface operations {
|
|
|
5405
5499
|
};
|
|
5406
5500
|
};
|
|
5407
5501
|
};
|
|
5408
|
-
/** @description The legacy secret was deleted successfully. */
|
|
5409
|
-
204: {
|
|
5410
|
-
headers: {
|
|
5411
|
-
[name: string]: unknown;
|
|
5412
|
-
};
|
|
5413
|
-
content?: never;
|
|
5414
|
-
};
|
|
5415
5502
|
/** @description The application does not have a legacy secret. */
|
|
5416
5503
|
400: {
|
|
5417
5504
|
headers: {
|
|
@@ -7081,6 +7168,8 @@ export interface operations {
|
|
|
7081
7168
|
};
|
|
7082
7169
|
oneTimeTokenContext?: {
|
|
7083
7170
|
jitOrganizationIds?: string[];
|
|
7171
|
+
/** @enum {string} */
|
|
7172
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
7084
7173
|
};
|
|
7085
7174
|
} | {
|
|
7086
7175
|
id: string;
|
|
@@ -7577,6 +7666,8 @@ export interface operations {
|
|
|
7577
7666
|
};
|
|
7578
7667
|
oneTimeTokenContext?: {
|
|
7579
7668
|
jitOrganizationIds?: string[];
|
|
7669
|
+
/** @enum {string} */
|
|
7670
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
7580
7671
|
};
|
|
7581
7672
|
} | {
|
|
7582
7673
|
id: string;
|
|
@@ -8016,6 +8107,8 @@ export interface operations {
|
|
|
8016
8107
|
};
|
|
8017
8108
|
oneTimeTokenContext?: {
|
|
8018
8109
|
jitOrganizationIds?: string[];
|
|
8110
|
+
/** @enum {string} */
|
|
8111
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
8019
8112
|
};
|
|
8020
8113
|
} | {
|
|
8021
8114
|
id: string;
|
|
@@ -8554,6 +8647,8 @@ export interface operations {
|
|
|
8554
8647
|
};
|
|
8555
8648
|
oneTimeTokenContext?: {
|
|
8556
8649
|
jitOrganizationIds?: string[];
|
|
8650
|
+
/** @enum {string} */
|
|
8651
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
8557
8652
|
};
|
|
8558
8653
|
} | {
|
|
8559
8654
|
id: string;
|
|
@@ -9035,6 +9130,8 @@ export interface operations {
|
|
|
9035
9130
|
};
|
|
9036
9131
|
oneTimeTokenContext?: {
|
|
9037
9132
|
jitOrganizationIds?: string[];
|
|
9133
|
+
/** @enum {string} */
|
|
9134
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
9038
9135
|
};
|
|
9039
9136
|
} | {
|
|
9040
9137
|
id: string;
|
|
@@ -9527,6 +9624,8 @@ export interface operations {
|
|
|
9527
9624
|
};
|
|
9528
9625
|
oneTimeTokenContext?: {
|
|
9529
9626
|
jitOrganizationIds?: string[];
|
|
9627
|
+
/** @enum {string} */
|
|
9628
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
9530
9629
|
};
|
|
9531
9630
|
} | {
|
|
9532
9631
|
id: string;
|
|
@@ -9709,44 +9808,436 @@ export interface operations {
|
|
|
9709
9808
|
createdAt?: number;
|
|
9710
9809
|
};
|
|
9711
9810
|
};
|
|
9712
|
-
});
|
|
9811
|
+
});
|
|
9812
|
+
};
|
|
9813
|
+
};
|
|
9814
|
+
responses: {
|
|
9815
|
+
/** @description The result of the JWT customizer script testing. */
|
|
9816
|
+
200: {
|
|
9817
|
+
headers: {
|
|
9818
|
+
[name: string]: unknown;
|
|
9819
|
+
};
|
|
9820
|
+
content: {
|
|
9821
|
+
"application/json": {
|
|
9822
|
+
[key: string]: unknown;
|
|
9823
|
+
};
|
|
9824
|
+
};
|
|
9825
|
+
};
|
|
9826
|
+
/** @description Zod errors in cloud service (data type does not match expectation, can be either request body or response body). */
|
|
9827
|
+
400: {
|
|
9828
|
+
headers: {
|
|
9829
|
+
[name: string]: unknown;
|
|
9830
|
+
};
|
|
9831
|
+
content?: never;
|
|
9832
|
+
};
|
|
9833
|
+
/** @description Unauthorized */
|
|
9834
|
+
401: {
|
|
9835
|
+
headers: {
|
|
9836
|
+
[name: string]: unknown;
|
|
9837
|
+
};
|
|
9838
|
+
content?: never;
|
|
9839
|
+
};
|
|
9840
|
+
/** @description Cloud connection does not have enough permission to perform the action. */
|
|
9841
|
+
403: {
|
|
9842
|
+
headers: {
|
|
9843
|
+
[name: string]: unknown;
|
|
9844
|
+
};
|
|
9845
|
+
content?: never;
|
|
9846
|
+
};
|
|
9847
|
+
/** @description Syntax errors in cloud service. */
|
|
9848
|
+
422: {
|
|
9849
|
+
headers: {
|
|
9850
|
+
[name: string]: unknown;
|
|
9851
|
+
};
|
|
9852
|
+
content?: never;
|
|
9853
|
+
};
|
|
9854
|
+
};
|
|
9855
|
+
};
|
|
9856
|
+
GetIdTokenConfig: {
|
|
9857
|
+
parameters: {
|
|
9858
|
+
query?: never;
|
|
9859
|
+
header?: never;
|
|
9860
|
+
path?: never;
|
|
9861
|
+
cookie?: never;
|
|
9862
|
+
};
|
|
9863
|
+
requestBody?: never;
|
|
9864
|
+
responses: {
|
|
9865
|
+
/** @description The ID token claims configuration. */
|
|
9866
|
+
200: {
|
|
9867
|
+
headers: {
|
|
9868
|
+
[name: string]: unknown;
|
|
9869
|
+
};
|
|
9870
|
+
content: {
|
|
9871
|
+
"application/json": {
|
|
9872
|
+
enabledExtendedClaims?: ("custom_data" | "identities" | "sso_identities" | "roles" | "organizations" | "organization_data" | "organization_roles")[];
|
|
9873
|
+
};
|
|
9874
|
+
};
|
|
9875
|
+
};
|
|
9876
|
+
/** @description Unauthorized */
|
|
9877
|
+
401: {
|
|
9878
|
+
headers: {
|
|
9879
|
+
[name: string]: unknown;
|
|
9880
|
+
};
|
|
9881
|
+
content?: never;
|
|
9882
|
+
};
|
|
9883
|
+
/** @description Forbidden */
|
|
9884
|
+
403: {
|
|
9885
|
+
headers: {
|
|
9886
|
+
[name: string]: unknown;
|
|
9887
|
+
};
|
|
9888
|
+
content?: never;
|
|
9889
|
+
};
|
|
9890
|
+
/** @description Configuration not found. */
|
|
9891
|
+
404: {
|
|
9892
|
+
headers: {
|
|
9893
|
+
[name: string]: unknown;
|
|
9894
|
+
};
|
|
9895
|
+
content?: never;
|
|
9896
|
+
};
|
|
9897
|
+
};
|
|
9898
|
+
};
|
|
9899
|
+
UpsertIdTokenConfig: {
|
|
9900
|
+
parameters: {
|
|
9901
|
+
query?: never;
|
|
9902
|
+
header?: never;
|
|
9903
|
+
path?: never;
|
|
9904
|
+
cookie?: never;
|
|
9905
|
+
};
|
|
9906
|
+
requestBody: {
|
|
9907
|
+
content: {
|
|
9908
|
+
"application/json": {
|
|
9909
|
+
/** @description An array of extended claims to include in ID tokens. Possible values: `custom_data`, `identities`, `sso_identities`, `roles`, `organizations`, `organization_data`, `organization_roles`. */
|
|
9910
|
+
enabledExtendedClaims?: ("custom_data" | "identities" | "sso_identities" | "roles" | "organizations" | "organization_data" | "organization_roles")[];
|
|
9911
|
+
};
|
|
9912
|
+
};
|
|
9913
|
+
};
|
|
9914
|
+
responses: {
|
|
9915
|
+
/** @description The updated ID token claims configuration. */
|
|
9916
|
+
200: {
|
|
9917
|
+
headers: {
|
|
9918
|
+
[name: string]: unknown;
|
|
9919
|
+
};
|
|
9920
|
+
content: {
|
|
9921
|
+
"application/json": {
|
|
9922
|
+
enabledExtendedClaims?: ("custom_data" | "identities" | "sso_identities" | "roles" | "organizations" | "organization_data" | "organization_roles")[];
|
|
9923
|
+
};
|
|
9924
|
+
};
|
|
9925
|
+
};
|
|
9926
|
+
/** @description Bad Request */
|
|
9927
|
+
400: {
|
|
9928
|
+
headers: {
|
|
9929
|
+
[name: string]: unknown;
|
|
9930
|
+
};
|
|
9931
|
+
content?: never;
|
|
9932
|
+
};
|
|
9933
|
+
/** @description Unauthorized */
|
|
9934
|
+
401: {
|
|
9935
|
+
headers: {
|
|
9936
|
+
[name: string]: unknown;
|
|
9937
|
+
};
|
|
9938
|
+
content?: never;
|
|
9939
|
+
};
|
|
9940
|
+
/** @description The tenant's subscription plan does not support this feature. */
|
|
9941
|
+
403: {
|
|
9942
|
+
headers: {
|
|
9943
|
+
[name: string]: unknown;
|
|
9944
|
+
};
|
|
9945
|
+
content?: never;
|
|
9946
|
+
};
|
|
9947
|
+
};
|
|
9948
|
+
};
|
|
9949
|
+
ListActions: {
|
|
9950
|
+
parameters: {
|
|
9951
|
+
query?: never;
|
|
9952
|
+
header?: never;
|
|
9953
|
+
path?: never;
|
|
9954
|
+
cookie?: never;
|
|
9955
|
+
};
|
|
9956
|
+
requestBody?: never;
|
|
9957
|
+
responses: {
|
|
9958
|
+
/** @description The action configurations. */
|
|
9959
|
+
200: {
|
|
9960
|
+
headers: {
|
|
9961
|
+
[name: string]: unknown;
|
|
9962
|
+
};
|
|
9963
|
+
content: {
|
|
9964
|
+
"application/json": {
|
|
9965
|
+
/** @enum {string} */
|
|
9966
|
+
key: "action.postFirstFactorVerification" | "action.postSignIn";
|
|
9967
|
+
value: {
|
|
9968
|
+
script: string;
|
|
9969
|
+
environmentVariables?: {
|
|
9970
|
+
[key: string]: string;
|
|
9971
|
+
};
|
|
9972
|
+
contextSample?: ({
|
|
9973
|
+
[key: string]: unknown;
|
|
9974
|
+
} | (string | number | boolean | (string | null) | {
|
|
9975
|
+
[key: string]: unknown;
|
|
9976
|
+
})[] | string | number | boolean) | null;
|
|
9977
|
+
enabled?: boolean;
|
|
9978
|
+
/** @enum {string} */
|
|
9979
|
+
onExecutionError?: "block" | "allow";
|
|
9980
|
+
};
|
|
9981
|
+
}[];
|
|
9982
|
+
};
|
|
9983
|
+
};
|
|
9984
|
+
/** @description Unauthorized */
|
|
9985
|
+
401: {
|
|
9986
|
+
headers: {
|
|
9987
|
+
[name: string]: unknown;
|
|
9988
|
+
};
|
|
9989
|
+
content?: never;
|
|
9990
|
+
};
|
|
9991
|
+
/** @description Forbidden */
|
|
9992
|
+
403: {
|
|
9993
|
+
headers: {
|
|
9994
|
+
[name: string]: unknown;
|
|
9995
|
+
};
|
|
9996
|
+
content?: never;
|
|
9997
|
+
};
|
|
9998
|
+
};
|
|
9999
|
+
};
|
|
10000
|
+
TestAction: {
|
|
10001
|
+
parameters: {
|
|
10002
|
+
query?: never;
|
|
10003
|
+
header?: never;
|
|
10004
|
+
path?: never;
|
|
10005
|
+
cookie?: never;
|
|
10006
|
+
};
|
|
10007
|
+
requestBody: {
|
|
10008
|
+
content: {
|
|
10009
|
+
"application/json": {
|
|
10010
|
+
/** @description The action script to test. */
|
|
10011
|
+
script: string;
|
|
10012
|
+
/**
|
|
10013
|
+
* @description The action type to test.
|
|
10014
|
+
* @enum {string}
|
|
10015
|
+
*/
|
|
10016
|
+
actionType: "action.postFirstFactorVerification" | "action.postSignIn";
|
|
10017
|
+
/** @description The sample event for action script testing. */
|
|
10018
|
+
event: ({
|
|
10019
|
+
[key: string]: unknown;
|
|
10020
|
+
} | (string | number | boolean | (string | null) | {
|
|
10021
|
+
[key: string]: unknown;
|
|
10022
|
+
})[] | string | number | boolean) | null;
|
|
10023
|
+
/** @description The environment variables for the action script. */
|
|
10024
|
+
environmentVariables?: {
|
|
10025
|
+
[key: string]: string;
|
|
10026
|
+
};
|
|
10027
|
+
};
|
|
10028
|
+
};
|
|
10029
|
+
};
|
|
10030
|
+
responses: {
|
|
10031
|
+
/** @description The result of the action script testing. */
|
|
10032
|
+
200: {
|
|
10033
|
+
headers: {
|
|
10034
|
+
[name: string]: unknown;
|
|
10035
|
+
};
|
|
10036
|
+
content: {
|
|
10037
|
+
"application/json": ({
|
|
10038
|
+
[key: string]: unknown;
|
|
10039
|
+
} | (string | number | boolean | (string | null) | {
|
|
10040
|
+
[key: string]: unknown;
|
|
10041
|
+
})[] | string | number | boolean) | null;
|
|
10042
|
+
};
|
|
10043
|
+
};
|
|
10044
|
+
/** @description The action script returned no result. */
|
|
10045
|
+
204: {
|
|
10046
|
+
headers: {
|
|
10047
|
+
[name: string]: unknown;
|
|
10048
|
+
};
|
|
10049
|
+
content?: never;
|
|
10050
|
+
};
|
|
10051
|
+
/** @description The request body or response body is invalid. */
|
|
10052
|
+
400: {
|
|
10053
|
+
headers: {
|
|
10054
|
+
[name: string]: unknown;
|
|
10055
|
+
};
|
|
10056
|
+
content?: never;
|
|
10057
|
+
};
|
|
10058
|
+
/** @description Unauthorized */
|
|
10059
|
+
401: {
|
|
10060
|
+
headers: {
|
|
10061
|
+
[name: string]: unknown;
|
|
10062
|
+
};
|
|
10063
|
+
content?: never;
|
|
10064
|
+
};
|
|
10065
|
+
/** @description Cloud connection does not have enough permission to perform the action or the tenant's subscription plan does not support this feature. */
|
|
10066
|
+
403: {
|
|
10067
|
+
headers: {
|
|
10068
|
+
[name: string]: unknown;
|
|
10069
|
+
};
|
|
10070
|
+
content?: never;
|
|
10071
|
+
};
|
|
10072
|
+
/** @description The action script failed to execute. */
|
|
10073
|
+
422: {
|
|
10074
|
+
headers: {
|
|
10075
|
+
[name: string]: unknown;
|
|
10076
|
+
};
|
|
10077
|
+
content?: never;
|
|
10078
|
+
};
|
|
10079
|
+
};
|
|
10080
|
+
};
|
|
10081
|
+
GetAction: {
|
|
10082
|
+
parameters: {
|
|
10083
|
+
query?: never;
|
|
10084
|
+
header?: never;
|
|
10085
|
+
path: {
|
|
10086
|
+
/** @description The action type to get. */
|
|
10087
|
+
actionType: "action.postFirstFactorVerification" | "action.postSignIn";
|
|
10088
|
+
};
|
|
10089
|
+
cookie?: never;
|
|
10090
|
+
};
|
|
10091
|
+
requestBody?: never;
|
|
10092
|
+
responses: {
|
|
10093
|
+
/** @description The action configuration. */
|
|
10094
|
+
200: {
|
|
10095
|
+
headers: {
|
|
10096
|
+
[name: string]: unknown;
|
|
10097
|
+
};
|
|
10098
|
+
content: {
|
|
10099
|
+
"application/json": {
|
|
10100
|
+
script: string;
|
|
10101
|
+
environmentVariables?: {
|
|
10102
|
+
[key: string]: string;
|
|
10103
|
+
};
|
|
10104
|
+
contextSample?: ({
|
|
10105
|
+
[key: string]: unknown;
|
|
10106
|
+
} | (string | number | boolean | (string | null) | {
|
|
10107
|
+
[key: string]: unknown;
|
|
10108
|
+
})[] | string | number | boolean) | null;
|
|
10109
|
+
enabled?: boolean;
|
|
10110
|
+
/** @enum {string} */
|
|
10111
|
+
onExecutionError?: "block" | "allow";
|
|
10112
|
+
};
|
|
10113
|
+
};
|
|
10114
|
+
};
|
|
10115
|
+
/** @description Bad Request */
|
|
10116
|
+
400: {
|
|
10117
|
+
headers: {
|
|
10118
|
+
[name: string]: unknown;
|
|
10119
|
+
};
|
|
10120
|
+
content?: never;
|
|
10121
|
+
};
|
|
10122
|
+
/** @description Unauthorized */
|
|
10123
|
+
401: {
|
|
10124
|
+
headers: {
|
|
10125
|
+
[name: string]: unknown;
|
|
10126
|
+
};
|
|
10127
|
+
content?: never;
|
|
10128
|
+
};
|
|
10129
|
+
/** @description Forbidden */
|
|
10130
|
+
403: {
|
|
10131
|
+
headers: {
|
|
10132
|
+
[name: string]: unknown;
|
|
10133
|
+
};
|
|
10134
|
+
content?: never;
|
|
10135
|
+
};
|
|
10136
|
+
/** @description The action configuration does not exist. */
|
|
10137
|
+
404: {
|
|
10138
|
+
headers: {
|
|
10139
|
+
[name: string]: unknown;
|
|
10140
|
+
};
|
|
10141
|
+
content?: never;
|
|
10142
|
+
};
|
|
10143
|
+
};
|
|
10144
|
+
};
|
|
10145
|
+
UpsertAction: {
|
|
10146
|
+
parameters: {
|
|
10147
|
+
query?: never;
|
|
10148
|
+
header?: never;
|
|
10149
|
+
path: {
|
|
10150
|
+
/** @description The action type to create or update. */
|
|
10151
|
+
actionType: "action.postFirstFactorVerification" | "action.postSignIn";
|
|
10152
|
+
};
|
|
10153
|
+
cookie?: never;
|
|
10154
|
+
};
|
|
10155
|
+
requestBody: {
|
|
10156
|
+
content: {
|
|
10157
|
+
"application/json": {
|
|
10158
|
+
/** @description The action script. */
|
|
10159
|
+
script: string;
|
|
10160
|
+
/** @description The environment variables for the action script. */
|
|
10161
|
+
environmentVariables?: {
|
|
10162
|
+
[key: string]: string;
|
|
10163
|
+
};
|
|
10164
|
+
/** @description The sample context for action script testing. */
|
|
10165
|
+
contextSample?: ({
|
|
10166
|
+
[key: string]: unknown;
|
|
10167
|
+
} | (string | number | boolean | (string | null) | {
|
|
10168
|
+
[key: string]: unknown;
|
|
10169
|
+
})[] | string | number | boolean) | null;
|
|
10170
|
+
/** @description Whether the action is enabled. */
|
|
10171
|
+
enabled?: boolean;
|
|
10172
|
+
/**
|
|
10173
|
+
* @description The action execution error handling policy.
|
|
10174
|
+
* @enum {string}
|
|
10175
|
+
*/
|
|
10176
|
+
onExecutionError?: "block" | "allow";
|
|
10177
|
+
};
|
|
9713
10178
|
};
|
|
9714
10179
|
};
|
|
9715
10180
|
responses: {
|
|
9716
|
-
/** @description The
|
|
10181
|
+
/** @description The updated action configuration. */
|
|
9717
10182
|
200: {
|
|
9718
10183
|
headers: {
|
|
9719
10184
|
[name: string]: unknown;
|
|
9720
10185
|
};
|
|
9721
10186
|
content: {
|
|
9722
10187
|
"application/json": {
|
|
9723
|
-
|
|
10188
|
+
script: string;
|
|
10189
|
+
environmentVariables?: {
|
|
10190
|
+
[key: string]: string;
|
|
10191
|
+
};
|
|
10192
|
+
contextSample?: ({
|
|
10193
|
+
[key: string]: unknown;
|
|
10194
|
+
} | (string | number | boolean | (string | null) | {
|
|
10195
|
+
[key: string]: unknown;
|
|
10196
|
+
})[] | string | number | boolean) | null;
|
|
10197
|
+
enabled?: boolean;
|
|
10198
|
+
/** @enum {string} */
|
|
10199
|
+
onExecutionError?: "block" | "allow";
|
|
9724
10200
|
};
|
|
9725
10201
|
};
|
|
9726
10202
|
};
|
|
9727
|
-
/** @description
|
|
9728
|
-
|
|
10203
|
+
/** @description The created action configuration. */
|
|
10204
|
+
201: {
|
|
9729
10205
|
headers: {
|
|
9730
10206
|
[name: string]: unknown;
|
|
9731
10207
|
};
|
|
9732
|
-
content
|
|
10208
|
+
content: {
|
|
10209
|
+
"application/json": {
|
|
10210
|
+
script: string;
|
|
10211
|
+
environmentVariables?: {
|
|
10212
|
+
[key: string]: string;
|
|
10213
|
+
};
|
|
10214
|
+
contextSample?: ({
|
|
10215
|
+
[key: string]: unknown;
|
|
10216
|
+
} | (string | number | boolean | (string | null) | {
|
|
10217
|
+
[key: string]: unknown;
|
|
10218
|
+
})[] | string | number | boolean) | null;
|
|
10219
|
+
enabled?: boolean;
|
|
10220
|
+
/** @enum {string} */
|
|
10221
|
+
onExecutionError?: "block" | "allow";
|
|
10222
|
+
};
|
|
10223
|
+
};
|
|
9733
10224
|
};
|
|
9734
|
-
/** @description
|
|
9735
|
-
|
|
10225
|
+
/** @description The request body is invalid. */
|
|
10226
|
+
400: {
|
|
9736
10227
|
headers: {
|
|
9737
10228
|
[name: string]: unknown;
|
|
9738
10229
|
};
|
|
9739
10230
|
content?: never;
|
|
9740
10231
|
};
|
|
9741
|
-
/** @description
|
|
9742
|
-
|
|
10232
|
+
/** @description Unauthorized */
|
|
10233
|
+
401: {
|
|
9743
10234
|
headers: {
|
|
9744
10235
|
[name: string]: unknown;
|
|
9745
10236
|
};
|
|
9746
10237
|
content?: never;
|
|
9747
10238
|
};
|
|
9748
|
-
/** @description
|
|
9749
|
-
|
|
10239
|
+
/** @description The tenant's subscription plan does not support this feature. */
|
|
10240
|
+
403: {
|
|
9750
10241
|
headers: {
|
|
9751
10242
|
[name: string]: unknown;
|
|
9752
10243
|
};
|
|
@@ -9754,25 +10245,31 @@ export interface operations {
|
|
|
9754
10245
|
};
|
|
9755
10246
|
};
|
|
9756
10247
|
};
|
|
9757
|
-
|
|
10248
|
+
DeleteAction: {
|
|
9758
10249
|
parameters: {
|
|
9759
10250
|
query?: never;
|
|
9760
10251
|
header?: never;
|
|
9761
|
-
path
|
|
10252
|
+
path: {
|
|
10253
|
+
/** @description The action type to delete. */
|
|
10254
|
+
actionType: "action.postFirstFactorVerification" | "action.postSignIn";
|
|
10255
|
+
};
|
|
9762
10256
|
cookie?: never;
|
|
9763
10257
|
};
|
|
9764
10258
|
requestBody?: never;
|
|
9765
10259
|
responses: {
|
|
9766
|
-
/** @description The
|
|
9767
|
-
|
|
10260
|
+
/** @description The action configuration was deleted successfully. */
|
|
10261
|
+
204: {
|
|
9768
10262
|
headers: {
|
|
9769
10263
|
[name: string]: unknown;
|
|
9770
10264
|
};
|
|
9771
|
-
content
|
|
9772
|
-
|
|
9773
|
-
|
|
9774
|
-
|
|
10265
|
+
content?: never;
|
|
10266
|
+
};
|
|
10267
|
+
/** @description Bad Request */
|
|
10268
|
+
400: {
|
|
10269
|
+
headers: {
|
|
10270
|
+
[name: string]: unknown;
|
|
9775
10271
|
};
|
|
10272
|
+
content?: never;
|
|
9776
10273
|
};
|
|
9777
10274
|
/** @description Unauthorized */
|
|
9778
10275
|
401: {
|
|
@@ -9788,7 +10285,7 @@ export interface operations {
|
|
|
9788
10285
|
};
|
|
9789
10286
|
content?: never;
|
|
9790
10287
|
};
|
|
9791
|
-
/** @description
|
|
10288
|
+
/** @description The action configuration does not exist. */
|
|
9792
10289
|
404: {
|
|
9793
10290
|
headers: {
|
|
9794
10291
|
[name: string]: unknown;
|
|
@@ -9797,34 +10294,65 @@ export interface operations {
|
|
|
9797
10294
|
};
|
|
9798
10295
|
};
|
|
9799
10296
|
};
|
|
9800
|
-
|
|
10297
|
+
UpdateAction: {
|
|
9801
10298
|
parameters: {
|
|
9802
10299
|
query?: never;
|
|
9803
10300
|
header?: never;
|
|
9804
|
-
path
|
|
10301
|
+
path: {
|
|
10302
|
+
/** @description The action type to update. */
|
|
10303
|
+
actionType: "action.postFirstFactorVerification" | "action.postSignIn";
|
|
10304
|
+
};
|
|
9805
10305
|
cookie?: never;
|
|
9806
10306
|
};
|
|
9807
10307
|
requestBody: {
|
|
9808
10308
|
content: {
|
|
9809
10309
|
"application/json": {
|
|
9810
|
-
/** @description
|
|
9811
|
-
|
|
10310
|
+
/** @description The action script. */
|
|
10311
|
+
script?: string;
|
|
10312
|
+
/** @description The environment variables for the action script. */
|
|
10313
|
+
environmentVariables?: {
|
|
10314
|
+
[key: string]: string;
|
|
10315
|
+
};
|
|
10316
|
+
/** @description The sample context for action script testing. */
|
|
10317
|
+
contextSample?: ({
|
|
10318
|
+
[key: string]: unknown;
|
|
10319
|
+
} | (string | number | boolean | (string | null) | {
|
|
10320
|
+
[key: string]: unknown;
|
|
10321
|
+
})[] | string | number | boolean) | null;
|
|
10322
|
+
/** @description Whether the action is enabled. */
|
|
10323
|
+
enabled?: boolean;
|
|
10324
|
+
/**
|
|
10325
|
+
* @description The action execution error handling policy.
|
|
10326
|
+
* @enum {string}
|
|
10327
|
+
*/
|
|
10328
|
+
onExecutionError?: "block" | "allow";
|
|
9812
10329
|
};
|
|
9813
10330
|
};
|
|
9814
10331
|
};
|
|
9815
10332
|
responses: {
|
|
9816
|
-
/** @description The updated
|
|
10333
|
+
/** @description The updated action configuration. */
|
|
9817
10334
|
200: {
|
|
9818
10335
|
headers: {
|
|
9819
10336
|
[name: string]: unknown;
|
|
9820
10337
|
};
|
|
9821
10338
|
content: {
|
|
9822
10339
|
"application/json": {
|
|
9823
|
-
|
|
10340
|
+
script: string;
|
|
10341
|
+
environmentVariables?: {
|
|
10342
|
+
[key: string]: string;
|
|
10343
|
+
};
|
|
10344
|
+
contextSample?: ({
|
|
10345
|
+
[key: string]: unknown;
|
|
10346
|
+
} | (string | number | boolean | (string | null) | {
|
|
10347
|
+
[key: string]: unknown;
|
|
10348
|
+
})[] | string | number | boolean) | null;
|
|
10349
|
+
enabled?: boolean;
|
|
10350
|
+
/** @enum {string} */
|
|
10351
|
+
onExecutionError?: "block" | "allow";
|
|
9824
10352
|
};
|
|
9825
10353
|
};
|
|
9826
10354
|
};
|
|
9827
|
-
/** @description
|
|
10355
|
+
/** @description The request body is invalid. */
|
|
9828
10356
|
400: {
|
|
9829
10357
|
headers: {
|
|
9830
10358
|
[name: string]: unknown;
|
|
@@ -9845,6 +10373,13 @@ export interface operations {
|
|
|
9845
10373
|
};
|
|
9846
10374
|
content?: never;
|
|
9847
10375
|
};
|
|
10376
|
+
/** @description The action configuration does not exist. */
|
|
10377
|
+
404: {
|
|
10378
|
+
headers: {
|
|
10379
|
+
[name: string]: unknown;
|
|
10380
|
+
};
|
|
10381
|
+
content?: never;
|
|
10382
|
+
};
|
|
9848
10383
|
};
|
|
9849
10384
|
};
|
|
9850
10385
|
ListConnectors: {
|
|
@@ -11769,15 +12304,16 @@ export interface operations {
|
|
|
11769
12304
|
maxAttempts?: number;
|
|
11770
12305
|
lockoutDuration?: number;
|
|
11771
12306
|
};
|
|
11772
|
-
/** @description Define email restriction policies
|
|
12307
|
+
/** @description Define email restriction policies for registering or linking email addresses. */
|
|
11773
12308
|
emailBlocklistPolicy: {
|
|
12309
|
+
/** @description Cloud only. Whether to block disposable email addresses. Once enabled, Logto will check the email domain against a list of known disposable email domains. If the domain is found in the list, the email address will be blocked. */
|
|
11774
12310
|
blockDisposableAddresses?: boolean;
|
|
11775
12311
|
/** @description Whether to block sub-addresses. (E.g., example+shopping@test.com) */
|
|
11776
12312
|
blockSubaddressing?: boolean;
|
|
11777
|
-
/** @description Custom
|
|
12313
|
+
/** @description Custom allowlist of email addresses, domains, or wildcard email address patterns. Examples: `bar@example.com`, `@example.com`, `foo*@example.com`, `@*.example.com`. */
|
|
12314
|
+
customAllowlist?: string[];
|
|
12315
|
+
/** @description Custom blocklist of email addresses, domains, or wildcard email address patterns. Examples: `bar@example.com`, `@example.com`, `foo*@example.com`, `@*.example.com`. */
|
|
11778
12316
|
customBlocklist?: string[];
|
|
11779
|
-
/** @description Cloud only. Whether to block disposable email addresses. Once enabled, Logto will check the email domain against a list of known disposable email domains. If the domain is found in the list, the email address will be blocked. */
|
|
11780
|
-
blockDisposableAddress?: unknown;
|
|
11781
12317
|
};
|
|
11782
12318
|
verificationCodePolicy: {
|
|
11783
12319
|
expirationDuration?: number;
|
|
@@ -11973,15 +12509,16 @@ export interface operations {
|
|
|
11973
12509
|
maxAttempts?: number;
|
|
11974
12510
|
lockoutDuration?: number;
|
|
11975
12511
|
};
|
|
11976
|
-
/** @description Define email restriction policies
|
|
12512
|
+
/** @description Define email restriction policies for registering or linking email addresses. */
|
|
11977
12513
|
emailBlocklistPolicy?: {
|
|
12514
|
+
/** @description Cloud only. Whether to block disposable email addresses. Once enabled, Logto will check the email domain against a list of known disposable email domains. If the domain is found in the list, the email address will be blocked. */
|
|
11978
12515
|
blockDisposableAddresses?: boolean;
|
|
11979
12516
|
/** @description Whether to block sub-addresses. (E.g., example+shopping@test.com) */
|
|
11980
12517
|
blockSubaddressing?: boolean;
|
|
11981
|
-
/** @description Custom
|
|
12518
|
+
/** @description Custom allowlist of email addresses, domains, or wildcard email address patterns. Examples: `bar@example.com`, `@example.com`, `foo*@example.com`, `@*.example.com`. */
|
|
12519
|
+
customAllowlist?: string[];
|
|
12520
|
+
/** @description Custom blocklist of email addresses, domains, or wildcard email address patterns. Examples: `bar@example.com`, `@example.com`, `foo*@example.com`, `@*.example.com`. */
|
|
11982
12521
|
customBlocklist?: string[];
|
|
11983
|
-
/** @description Cloud only. Whether to block disposable email addresses. Once enabled, Logto will check the email domain against a list of known disposable email domains. If the domain is found in the list, the email address will be blocked. */
|
|
11984
|
-
blockDisposableAddress?: unknown;
|
|
11985
12522
|
};
|
|
11986
12523
|
forgotPasswordMethods?: ("EmailVerificationCode" | "PhoneVerificationCode")[] | null;
|
|
11987
12524
|
passkeySignIn?: {
|
|
@@ -12149,6 +12686,7 @@ export interface operations {
|
|
|
12149
12686
|
emailBlocklistPolicy: {
|
|
12150
12687
|
blockDisposableAddresses?: boolean;
|
|
12151
12688
|
blockSubaddressing?: boolean;
|
|
12689
|
+
customAllowlist?: string[];
|
|
12152
12690
|
customBlocklist?: string[];
|
|
12153
12691
|
};
|
|
12154
12692
|
verificationCodePolicy: {
|
|
@@ -15640,6 +16178,8 @@ export interface operations {
|
|
|
15640
16178
|
};
|
|
15641
16179
|
oneTimeTokenContext?: {
|
|
15642
16180
|
jitOrganizationIds?: string[];
|
|
16181
|
+
/** @enum {string} */
|
|
16182
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
15643
16183
|
};
|
|
15644
16184
|
} | {
|
|
15645
16185
|
id: string;
|
|
@@ -15864,6 +16404,8 @@ export interface operations {
|
|
|
15864
16404
|
};
|
|
15865
16405
|
oneTimeTokenContext?: {
|
|
15866
16406
|
jitOrganizationIds?: string[];
|
|
16407
|
+
/** @enum {string} */
|
|
16408
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
15867
16409
|
};
|
|
15868
16410
|
} | {
|
|
15869
16411
|
id: string;
|
|
@@ -15994,9 +16536,9 @@ export interface operations {
|
|
|
15994
16536
|
logKey?: string;
|
|
15995
16537
|
/** @description When `true`, short-circuits the underlying `count(*)` query: any tenant with more than 10,000 matching logs saturates `Total-Number` at the sentinel value `10001` and the response emits `Total-Number-Is-Capped: true`. The `Link` header then omits `rel="last"` and `rel="next"` because the real total is unknown. Default `false`; recommended `true` for any client whose tenant volume may exceed 10,000 matching logs to avoid `statement_timeout`. */
|
|
15996
16538
|
enableCap?: string;
|
|
15997
|
-
/** @description
|
|
16539
|
+
/** @description Inclusive lower bound on `createdAt`, in unix milliseconds. When set, returns only logs where `createdAt >= start_time`. Recommended for clients paginating across very large log ranges to keep query latency consistent. Because the bound is inclusive, when resuming pagination from the last fetched log, pass its `createdAt + 1` as `start_time` (or de-duplicate by log `id`) to avoid re-fetching the boundary log. */
|
|
15998
16540
|
start_time?: string;
|
|
15999
|
-
/** @description
|
|
16541
|
+
/** @description Inclusive upper bound on `createdAt`, in unix milliseconds. When set, returns only logs where `createdAt <= end_time`. Returns `400` if `start_time > end_time` when both are present. */
|
|
16000
16542
|
end_time?: string;
|
|
16001
16543
|
/** @description Page number (starts from 1). */
|
|
16002
16544
|
page?: number;
|
|
@@ -16070,7 +16612,7 @@ export interface operations {
|
|
|
16070
16612
|
}[];
|
|
16071
16613
|
};
|
|
16072
16614
|
};
|
|
16073
|
-
/** @description Returned when `start_time` or `end_time` is not a finite number, or when `start_time
|
|
16615
|
+
/** @description Returned when `start_time` or `end_time` is not a finite number, or when `start_time > end_time`. */
|
|
16074
16616
|
400: {
|
|
16075
16617
|
headers: {
|
|
16076
16618
|
[name: string]: unknown;
|
|
@@ -16799,7 +17341,7 @@ export interface operations {
|
|
|
16799
17341
|
tenantId: string;
|
|
16800
17342
|
id: string;
|
|
16801
17343
|
name: string;
|
|
16802
|
-
secret
|
|
17344
|
+
secret?: string;
|
|
16803
17345
|
description: string | null;
|
|
16804
17346
|
/** @enum {string} */
|
|
16805
17347
|
type: "Native" | "SPA" | "Traditional" | "MachineToMachine" | "Protected" | "SAML";
|
|
@@ -17605,8 +18147,8 @@ export interface operations {
|
|
|
17605
18147
|
id: string;
|
|
17606
18148
|
name: string;
|
|
17607
18149
|
/** @enum {string|null} */
|
|
17608
|
-
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | null;
|
|
17609
|
-
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited")[];
|
|
18150
|
+
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded" | null;
|
|
18151
|
+
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded")[];
|
|
17610
18152
|
config: {
|
|
17611
18153
|
url: string;
|
|
17612
18154
|
headers?: {
|
|
@@ -17665,9 +18207,9 @@ export interface operations {
|
|
|
17665
18207
|
* @description Use `events` instead.
|
|
17666
18208
|
* @enum {string}
|
|
17667
18209
|
*/
|
|
17668
|
-
event?: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited";
|
|
18210
|
+
event?: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded";
|
|
17669
18211
|
/** @description An array of hook events. */
|
|
17670
|
-
events?: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited")[];
|
|
18212
|
+
events?: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded")[];
|
|
17671
18213
|
config: {
|
|
17672
18214
|
url: string;
|
|
17673
18215
|
headers?: {
|
|
@@ -17696,8 +18238,8 @@ export interface operations {
|
|
|
17696
18238
|
id: string;
|
|
17697
18239
|
name: string;
|
|
17698
18240
|
/** @enum {string|null} */
|
|
17699
|
-
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | null;
|
|
17700
|
-
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited")[];
|
|
18241
|
+
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded" | null;
|
|
18242
|
+
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded")[];
|
|
17701
18243
|
config: {
|
|
17702
18244
|
url: string;
|
|
17703
18245
|
headers?: {
|
|
@@ -17760,8 +18302,8 @@ export interface operations {
|
|
|
17760
18302
|
id: string;
|
|
17761
18303
|
name: string;
|
|
17762
18304
|
/** @enum {string|null} */
|
|
17763
|
-
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | null;
|
|
17764
|
-
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited")[];
|
|
18305
|
+
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded" | null;
|
|
18306
|
+
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded")[];
|
|
17765
18307
|
config: {
|
|
17766
18308
|
url: string;
|
|
17767
18309
|
headers?: {
|
|
@@ -17879,9 +18421,9 @@ export interface operations {
|
|
|
17879
18421
|
* @description Use `events` instead.
|
|
17880
18422
|
* @enum {string|null}
|
|
17881
18423
|
*/
|
|
17882
|
-
event?: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | null;
|
|
18424
|
+
event?: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded" | null;
|
|
17883
18425
|
/** @description An array of updated hook events. */
|
|
17884
|
-
events?: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited")[];
|
|
18426
|
+
events?: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded")[];
|
|
17885
18427
|
config?: {
|
|
17886
18428
|
url: string;
|
|
17887
18429
|
headers?: {
|
|
@@ -17910,8 +18452,8 @@ export interface operations {
|
|
|
17910
18452
|
id: string;
|
|
17911
18453
|
name: string;
|
|
17912
18454
|
/** @enum {string|null} */
|
|
17913
|
-
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | null;
|
|
17914
|
-
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited")[];
|
|
18455
|
+
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded" | null;
|
|
18456
|
+
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded")[];
|
|
17915
18457
|
config: {
|
|
17916
18458
|
url: string;
|
|
17917
18459
|
headers?: {
|
|
@@ -17962,9 +18504,9 @@ export interface operations {
|
|
|
17962
18504
|
logKey?: string;
|
|
17963
18505
|
/** @description When `true`, short-circuits the underlying `count(*)` query: results with more than 10,000 matching logs saturate `Total-Number` at the sentinel `10001` and emit `Total-Number-Is-Capped: true`; the `Link` header omits `rel="last"` and `rel="next"`. Default `false`. (This endpoint is already scoped to a single hook over the last 24 hours, so the cap rarely triggers in practice.) */
|
|
17964
18506
|
enableCap?: string;
|
|
17965
|
-
/** @description
|
|
18507
|
+
/** @description Inclusive lower bound on `createdAt`, in unix milliseconds. Supplying either `start_time` or `end_time` replaces the endpoint's default 24-hour lower bound, so callers can query an arbitrary historical window. Returns `400` if `start_time > end_time` when both are present. */
|
|
17966
18508
|
start_time?: string;
|
|
17967
|
-
/** @description
|
|
18509
|
+
/** @description Inclusive upper bound on `createdAt`, in unix milliseconds. Supplying either `start_time` or `end_time` replaces the endpoint's default 24-hour lower bound. */
|
|
17968
18510
|
end_time?: string;
|
|
17969
18511
|
/** @description Page number (starts from 1). */
|
|
17970
18512
|
page?: number;
|
|
@@ -18040,7 +18582,7 @@ export interface operations {
|
|
|
18040
18582
|
}[];
|
|
18041
18583
|
};
|
|
18042
18584
|
};
|
|
18043
|
-
/** @description Returned when `start_time` or `end_time` is not a finite number, or when `start_time
|
|
18585
|
+
/** @description Returned when `start_time` or `end_time` is not a finite number, or when `start_time > end_time`. */
|
|
18044
18586
|
400: {
|
|
18045
18587
|
headers: {
|
|
18046
18588
|
[name: string]: unknown;
|
|
@@ -18077,7 +18619,7 @@ export interface operations {
|
|
|
18077
18619
|
content: {
|
|
18078
18620
|
"application/json": {
|
|
18079
18621
|
/** @description An array of hook events for testing. */
|
|
18080
|
-
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited")[];
|
|
18622
|
+
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded")[];
|
|
18081
18623
|
/** @description The hook configuration for testing. */
|
|
18082
18624
|
config: {
|
|
18083
18625
|
url: string;
|
|
@@ -18166,8 +18708,8 @@ export interface operations {
|
|
|
18166
18708
|
id: string;
|
|
18167
18709
|
name: string;
|
|
18168
18710
|
/** @enum {string|null} */
|
|
18169
|
-
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | null;
|
|
18170
|
-
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited")[];
|
|
18711
|
+
event: "PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded" | null;
|
|
18712
|
+
events: ("PostRegister" | "PostSignIn" | "PostSignInAdaptiveMfaTriggered" | "PostResetPassword" | "User.Created" | "User.Deleted" | "User.Data.Updated" | "User.SuspensionStatus.Updated" | "Role.Created" | "Role.Deleted" | "Role.Data.Updated" | "Role.Scopes.Updated" | "Scope.Created" | "Scope.Deleted" | "Scope.Data.Updated" | "Organization.Created" | "Organization.Deleted" | "Organization.Data.Updated" | "Organization.Membership.Updated" | "OrganizationRole.Created" | "OrganizationRole.Deleted" | "OrganizationRole.Data.Updated" | "OrganizationRole.Scopes.Updated" | "OrganizationScope.Created" | "OrganizationScope.Deleted" | "OrganizationScope.Data.Updated" | "Identifier.Lockout" | "Message.RateLimited" | "Grant.LimitExceeded")[];
|
|
18171
18713
|
config: {
|
|
18172
18714
|
url: string;
|
|
18173
18715
|
headers?: {
|
|
@@ -18632,6 +19174,121 @@ export interface operations {
|
|
|
18632
19174
|
};
|
|
18633
19175
|
};
|
|
18634
19176
|
};
|
|
19177
|
+
ListDomainVerificationFiles: {
|
|
19178
|
+
parameters: {
|
|
19179
|
+
query?: never;
|
|
19180
|
+
header?: never;
|
|
19181
|
+
path: {
|
|
19182
|
+
/** @description The unique identifier of the domain. */
|
|
19183
|
+
id: components["parameters"]["domainId-root"];
|
|
19184
|
+
};
|
|
19185
|
+
cookie?: never;
|
|
19186
|
+
};
|
|
19187
|
+
requestBody?: never;
|
|
19188
|
+
responses: {
|
|
19189
|
+
/** @description The configured domain verification files. */
|
|
19190
|
+
200: {
|
|
19191
|
+
headers: {
|
|
19192
|
+
[name: string]: unknown;
|
|
19193
|
+
};
|
|
19194
|
+
content: {
|
|
19195
|
+
"application/json": {
|
|
19196
|
+
[key: string]: unknown;
|
|
19197
|
+
};
|
|
19198
|
+
};
|
|
19199
|
+
};
|
|
19200
|
+
/** @description Bad Request */
|
|
19201
|
+
400: {
|
|
19202
|
+
headers: {
|
|
19203
|
+
[name: string]: unknown;
|
|
19204
|
+
};
|
|
19205
|
+
content?: never;
|
|
19206
|
+
};
|
|
19207
|
+
/** @description Unauthorized */
|
|
19208
|
+
401: {
|
|
19209
|
+
headers: {
|
|
19210
|
+
[name: string]: unknown;
|
|
19211
|
+
};
|
|
19212
|
+
content?: never;
|
|
19213
|
+
};
|
|
19214
|
+
/** @description Forbidden */
|
|
19215
|
+
403: {
|
|
19216
|
+
headers: {
|
|
19217
|
+
[name: string]: unknown;
|
|
19218
|
+
};
|
|
19219
|
+
content?: never;
|
|
19220
|
+
};
|
|
19221
|
+
/** @description The domain with the specified ID was not found. */
|
|
19222
|
+
404: {
|
|
19223
|
+
headers: {
|
|
19224
|
+
[name: string]: unknown;
|
|
19225
|
+
};
|
|
19226
|
+
content?: never;
|
|
19227
|
+
};
|
|
19228
|
+
};
|
|
19229
|
+
};
|
|
19230
|
+
ReplaceDomainVerificationFiles: {
|
|
19231
|
+
parameters: {
|
|
19232
|
+
query?: never;
|
|
19233
|
+
header?: never;
|
|
19234
|
+
path: {
|
|
19235
|
+
/** @description The unique identifier of the domain. */
|
|
19236
|
+
id: components["parameters"]["domainId-root"];
|
|
19237
|
+
};
|
|
19238
|
+
cookie?: never;
|
|
19239
|
+
};
|
|
19240
|
+
requestBody: {
|
|
19241
|
+
content: {
|
|
19242
|
+
"application/json": {
|
|
19243
|
+
/** @description Up to 10 text or JSON verification files served as filenames with extensions at the domain root, or at paths under `/.well-known/`. */
|
|
19244
|
+
verificationFiles: {
|
|
19245
|
+
[key: string]: unknown;
|
|
19246
|
+
};
|
|
19247
|
+
};
|
|
19248
|
+
};
|
|
19249
|
+
};
|
|
19250
|
+
responses: {
|
|
19251
|
+
/** @description The domain verification files were replaced successfully. */
|
|
19252
|
+
200: {
|
|
19253
|
+
headers: {
|
|
19254
|
+
[name: string]: unknown;
|
|
19255
|
+
};
|
|
19256
|
+
content: {
|
|
19257
|
+
"application/json": {
|
|
19258
|
+
[key: string]: unknown;
|
|
19259
|
+
};
|
|
19260
|
+
};
|
|
19261
|
+
};
|
|
19262
|
+
/** @description Validation error. Please check the request body. */
|
|
19263
|
+
400: {
|
|
19264
|
+
headers: {
|
|
19265
|
+
[name: string]: unknown;
|
|
19266
|
+
};
|
|
19267
|
+
content?: never;
|
|
19268
|
+
};
|
|
19269
|
+
/** @description Unauthorized */
|
|
19270
|
+
401: {
|
|
19271
|
+
headers: {
|
|
19272
|
+
[name: string]: unknown;
|
|
19273
|
+
};
|
|
19274
|
+
content?: never;
|
|
19275
|
+
};
|
|
19276
|
+
/** @description Forbidden */
|
|
19277
|
+
403: {
|
|
19278
|
+
headers: {
|
|
19279
|
+
[name: string]: unknown;
|
|
19280
|
+
};
|
|
19281
|
+
content?: never;
|
|
19282
|
+
};
|
|
19283
|
+
/** @description The domain with the specified ID was not found. */
|
|
19284
|
+
404: {
|
|
19285
|
+
headers: {
|
|
19286
|
+
[name: string]: unknown;
|
|
19287
|
+
};
|
|
19288
|
+
content?: never;
|
|
19289
|
+
};
|
|
19290
|
+
};
|
|
19291
|
+
};
|
|
18635
19292
|
CleanupDomains: {
|
|
18636
19293
|
parameters: {
|
|
18637
19294
|
query?: never;
|
|
@@ -20375,6 +21032,13 @@ export interface operations {
|
|
|
20375
21032
|
};
|
|
20376
21033
|
content?: never;
|
|
20377
21034
|
};
|
|
21035
|
+
/** @description Unprocessable Content */
|
|
21036
|
+
422: {
|
|
21037
|
+
headers: {
|
|
21038
|
+
[name: string]: unknown;
|
|
21039
|
+
};
|
|
21040
|
+
content?: never;
|
|
21041
|
+
};
|
|
20378
21042
|
};
|
|
20379
21043
|
};
|
|
20380
21044
|
GetOrganization: {
|
|
@@ -20619,6 +21283,13 @@ export interface operations {
|
|
|
20619
21283
|
};
|
|
20620
21284
|
content?: never;
|
|
20621
21285
|
};
|
|
21286
|
+
/** @description Unprocessable Content */
|
|
21287
|
+
422: {
|
|
21288
|
+
headers: {
|
|
21289
|
+
[name: string]: unknown;
|
|
21290
|
+
};
|
|
21291
|
+
content?: never;
|
|
21292
|
+
};
|
|
20622
21293
|
};
|
|
20623
21294
|
};
|
|
20624
21295
|
ListOrganizationUsers: {
|
|
@@ -21306,7 +21977,7 @@ export interface operations {
|
|
|
21306
21977
|
tenantId: string;
|
|
21307
21978
|
id: string;
|
|
21308
21979
|
name: string;
|
|
21309
|
-
secret
|
|
21980
|
+
secret?: components["schemas"]["ApplicationLegacySecret"];
|
|
21310
21981
|
description: string | null;
|
|
21311
21982
|
/** @enum {string} */
|
|
21312
21983
|
type: "Native" | "SPA" | "Traditional" | "MachineToMachine" | "Protected" | "SAML";
|
|
@@ -24497,6 +25168,8 @@ export interface operations {
|
|
|
24497
25168
|
token: string;
|
|
24498
25169
|
context: {
|
|
24499
25170
|
jitOrganizationIds?: string[];
|
|
25171
|
+
/** @enum {string} */
|
|
25172
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
24500
25173
|
};
|
|
24501
25174
|
/** @enum {string} */
|
|
24502
25175
|
status: "active" | "consumed" | "revoked" | "expired";
|
|
@@ -24540,9 +25213,11 @@ export interface operations {
|
|
|
24540
25213
|
"application/json": {
|
|
24541
25214
|
/** @description The email address to associate with the one-time token. */
|
|
24542
25215
|
email: string;
|
|
24543
|
-
/** @description Additional context to store with the one-time token.
|
|
25216
|
+
/** @description Additional context to store with the one-time token. Set `interactionEvent` to scope the token to a specific flow, such as `ForgotPassword` for reset-password magic links. */
|
|
24544
25217
|
context?: {
|
|
24545
25218
|
jitOrganizationIds?: string[];
|
|
25219
|
+
/** @enum {string} */
|
|
25220
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
24546
25221
|
};
|
|
24547
25222
|
/** @description The expiration time in seconds. If not provided, defaults to 10 mins (600 seconds). */
|
|
24548
25223
|
expiresIn?: number;
|
|
@@ -24563,6 +25238,8 @@ export interface operations {
|
|
|
24563
25238
|
token: string;
|
|
24564
25239
|
context: {
|
|
24565
25240
|
jitOrganizationIds?: string[];
|
|
25241
|
+
/** @enum {string} */
|
|
25242
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
24566
25243
|
};
|
|
24567
25244
|
/** @enum {string} */
|
|
24568
25245
|
status: "active" | "consumed" | "revoked" | "expired";
|
|
@@ -24619,6 +25296,8 @@ export interface operations {
|
|
|
24619
25296
|
token: string;
|
|
24620
25297
|
context: {
|
|
24621
25298
|
jitOrganizationIds?: string[];
|
|
25299
|
+
/** @enum {string} */
|
|
25300
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
24622
25301
|
};
|
|
24623
25302
|
/** @enum {string} */
|
|
24624
25303
|
status: "active" | "consumed" | "revoked" | "expired";
|
|
@@ -24737,6 +25416,8 @@ export interface operations {
|
|
|
24737
25416
|
token: string;
|
|
24738
25417
|
context: {
|
|
24739
25418
|
jitOrganizationIds?: string[];
|
|
25419
|
+
/** @enum {string} */
|
|
25420
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
24740
25421
|
};
|
|
24741
25422
|
/** @enum {string} */
|
|
24742
25423
|
status: "active" | "consumed" | "revoked" | "expired";
|
|
@@ -24810,6 +25491,8 @@ export interface operations {
|
|
|
24810
25491
|
token: string;
|
|
24811
25492
|
context: {
|
|
24812
25493
|
jitOrganizationIds?: string[];
|
|
25494
|
+
/** @enum {string} */
|
|
25495
|
+
interactionEvent?: "SignIn" | "Register" | "ForgotPassword";
|
|
24813
25496
|
};
|
|
24814
25497
|
/** @enum {string} */
|
|
24815
25498
|
status: "active" | "consumed" | "revoked" | "expired";
|
|
@@ -26303,11 +26986,6 @@ export interface operations {
|
|
|
26303
26986
|
maxAttempts?: number;
|
|
26304
26987
|
lockoutDuration?: number;
|
|
26305
26988
|
};
|
|
26306
|
-
emailBlocklistPolicy: {
|
|
26307
|
-
blockDisposableAddresses?: boolean;
|
|
26308
|
-
blockSubaddressing?: boolean;
|
|
26309
|
-
customBlocklist?: string[];
|
|
26310
|
-
};
|
|
26311
26989
|
verificationCodePolicy: {
|
|
26312
26990
|
expirationDuration?: number;
|
|
26313
26991
|
maxRetryAttempts?: number;
|
|
@@ -26650,11 +27328,6 @@ export interface operations {
|
|
|
26650
27328
|
maxAttempts?: number;
|
|
26651
27329
|
lockoutDuration?: number;
|
|
26652
27330
|
};
|
|
26653
|
-
emailBlocklistPolicy: {
|
|
26654
|
-
blockDisposableAddresses?: boolean;
|
|
26655
|
-
blockSubaddressing?: boolean;
|
|
26656
|
-
customBlocklist?: string[];
|
|
26657
|
-
};
|
|
26658
27331
|
verificationCodePolicy: {
|
|
26659
27332
|
expirationDuration?: number;
|
|
26660
27333
|
maxRetryAttempts?: number;
|