@logto/api 1.32.0 → 1.33.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.
|
@@ -909,6 +909,30 @@ export interface paths {
|
|
|
909
909
|
patch: operations["UpdateUserCustomData"];
|
|
910
910
|
trace?: never;
|
|
911
911
|
};
|
|
912
|
+
"/api/users/{userId}/logto-configs": {
|
|
913
|
+
parameters: {
|
|
914
|
+
query?: never;
|
|
915
|
+
header?: never;
|
|
916
|
+
path?: never;
|
|
917
|
+
cookie?: never;
|
|
918
|
+
};
|
|
919
|
+
/**
|
|
920
|
+
* Get user logto config
|
|
921
|
+
* @description Retrieve the exposed portion of a user's logto config. This endpoint currently includes only the MFA skip state.
|
|
922
|
+
*/
|
|
923
|
+
get: operations["ListUserLogtoConfigs"];
|
|
924
|
+
put?: never;
|
|
925
|
+
post?: never;
|
|
926
|
+
delete?: never;
|
|
927
|
+
options?: never;
|
|
928
|
+
head?: never;
|
|
929
|
+
/**
|
|
930
|
+
* Update user logto config
|
|
931
|
+
* @description Update the exposed portion of a user's logto config. This endpoint currently allows updating only the MFA skip state.
|
|
932
|
+
*/
|
|
933
|
+
patch: operations["UpdateUserLogtoConfigs"];
|
|
934
|
+
trace?: never;
|
|
935
|
+
};
|
|
912
936
|
"/api/users/{userId}/profile": {
|
|
913
937
|
parameters: {
|
|
914
938
|
query?: never;
|
|
@@ -1220,7 +1244,11 @@ export interface paths {
|
|
|
1220
1244
|
delete?: never;
|
|
1221
1245
|
options?: never;
|
|
1222
1246
|
head?: never;
|
|
1223
|
-
|
|
1247
|
+
/**
|
|
1248
|
+
* Update personal access token
|
|
1249
|
+
* @description Update a token for the user by name.
|
|
1250
|
+
*/
|
|
1251
|
+
patch: operations["UpdatePersonalAccessTokenName"];
|
|
1224
1252
|
trace?: never;
|
|
1225
1253
|
};
|
|
1226
1254
|
"/api/users/{userId}/personal-access-tokens/{name}": {
|
|
@@ -1235,18 +1263,38 @@ export interface paths {
|
|
|
1235
1263
|
post?: never;
|
|
1236
1264
|
/**
|
|
1237
1265
|
* Delete personal access token
|
|
1238
|
-
* @description Delete a token for the user by name.
|
|
1266
|
+
* @description Delete a token for the user by name using the legacy path parameter. Deprecated: use the POST /delete endpoint instead to avoid url name encoding issues.
|
|
1239
1267
|
*/
|
|
1240
1268
|
delete: operations["DeleteUserPersonalAccessToken"];
|
|
1241
1269
|
options?: never;
|
|
1242
1270
|
head?: never;
|
|
1243
1271
|
/**
|
|
1244
1272
|
* Update personal access token
|
|
1245
|
-
* @description Update a token for the user by name.
|
|
1273
|
+
* @description Update a token for the user by name using the legacy path parameter. Deprecated: use the PATCH /personal-access-tokens endpoint instead to avoid url name encoding issues.
|
|
1246
1274
|
*/
|
|
1247
1275
|
patch: operations["UpdateUserPersonalAccessToken"];
|
|
1248
1276
|
trace?: never;
|
|
1249
1277
|
};
|
|
1278
|
+
"/api/users/{userId}/personal-access-tokens/delete": {
|
|
1279
|
+
parameters: {
|
|
1280
|
+
query?: never;
|
|
1281
|
+
header?: never;
|
|
1282
|
+
path?: never;
|
|
1283
|
+
cookie?: never;
|
|
1284
|
+
};
|
|
1285
|
+
get?: never;
|
|
1286
|
+
put?: never;
|
|
1287
|
+
/**
|
|
1288
|
+
* Delete personal access token
|
|
1289
|
+
* @description Delete a token for the user by name.
|
|
1290
|
+
*/
|
|
1291
|
+
post: operations["DeletePersonalAccessTokenPost"];
|
|
1292
|
+
delete?: never;
|
|
1293
|
+
options?: never;
|
|
1294
|
+
head?: never;
|
|
1295
|
+
patch?: never;
|
|
1296
|
+
trace?: never;
|
|
1297
|
+
};
|
|
1250
1298
|
"/api/users/{userId}/sso-identities/{ssoConnectorId}": {
|
|
1251
1299
|
parameters: {
|
|
1252
1300
|
query?: never;
|
|
@@ -9657,6 +9705,8 @@ export interface operations {
|
|
|
9657
9705
|
/** Format: url */
|
|
9658
9706
|
darkFavicon?: string;
|
|
9659
9707
|
};
|
|
9708
|
+
/** @description Cloud only. Whether to hide the Logto branding on hosted sign-in pages. */
|
|
9709
|
+
hideLogtoBranding: boolean;
|
|
9660
9710
|
/** @description The language detection policy for the sign-in page. */
|
|
9661
9711
|
languageInfo: {
|
|
9662
9712
|
autoDetect: boolean;
|
|
@@ -9825,6 +9875,8 @@ export interface operations {
|
|
|
9825
9875
|
/** Format: url */
|
|
9826
9876
|
darkFavicon?: string;
|
|
9827
9877
|
};
|
|
9878
|
+
/** @description Cloud only. Whether to hide the Logto branding on hosted sign-in pages. */
|
|
9879
|
+
hideLogtoBranding?: boolean;
|
|
9828
9880
|
/** @description Control the language detection policy for the sign-in page. */
|
|
9829
9881
|
languageInfo?: {
|
|
9830
9882
|
autoDetect: boolean;
|
|
@@ -9964,6 +10016,7 @@ export interface operations {
|
|
|
9964
10016
|
/** Format: url */
|
|
9965
10017
|
darkFavicon?: string;
|
|
9966
10018
|
};
|
|
10019
|
+
hideLogtoBranding: boolean;
|
|
9967
10020
|
languageInfo: {
|
|
9968
10021
|
autoDetect: boolean;
|
|
9969
10022
|
/** @enum {string} */
|
|
@@ -10625,6 +10678,125 @@ export interface operations {
|
|
|
10625
10678
|
};
|
|
10626
10679
|
};
|
|
10627
10680
|
};
|
|
10681
|
+
ListUserLogtoConfigs: {
|
|
10682
|
+
parameters: {
|
|
10683
|
+
query?: never;
|
|
10684
|
+
header?: never;
|
|
10685
|
+
path: {
|
|
10686
|
+
/** @description The unique identifier of the user. */
|
|
10687
|
+
userId: components["parameters"]["userId"];
|
|
10688
|
+
};
|
|
10689
|
+
cookie?: never;
|
|
10690
|
+
};
|
|
10691
|
+
requestBody?: never;
|
|
10692
|
+
responses: {
|
|
10693
|
+
/** @description Returns the exposed user logto config fields. Currently, only the MFA skip state is available. */
|
|
10694
|
+
200: {
|
|
10695
|
+
headers: {
|
|
10696
|
+
[name: string]: unknown;
|
|
10697
|
+
};
|
|
10698
|
+
content: {
|
|
10699
|
+
"application/json": {
|
|
10700
|
+
mfa: {
|
|
10701
|
+
skipped: boolean;
|
|
10702
|
+
};
|
|
10703
|
+
};
|
|
10704
|
+
};
|
|
10705
|
+
};
|
|
10706
|
+
/** @description Bad Request */
|
|
10707
|
+
400: {
|
|
10708
|
+
headers: {
|
|
10709
|
+
[name: string]: unknown;
|
|
10710
|
+
};
|
|
10711
|
+
content?: never;
|
|
10712
|
+
};
|
|
10713
|
+
/** @description Unauthorized */
|
|
10714
|
+
401: {
|
|
10715
|
+
headers: {
|
|
10716
|
+
[name: string]: unknown;
|
|
10717
|
+
};
|
|
10718
|
+
content?: never;
|
|
10719
|
+
};
|
|
10720
|
+
/** @description Forbidden */
|
|
10721
|
+
403: {
|
|
10722
|
+
headers: {
|
|
10723
|
+
[name: string]: unknown;
|
|
10724
|
+
};
|
|
10725
|
+
content?: never;
|
|
10726
|
+
};
|
|
10727
|
+
/** @description Not Found */
|
|
10728
|
+
404: {
|
|
10729
|
+
headers: {
|
|
10730
|
+
[name: string]: unknown;
|
|
10731
|
+
};
|
|
10732
|
+
content?: never;
|
|
10733
|
+
};
|
|
10734
|
+
};
|
|
10735
|
+
};
|
|
10736
|
+
UpdateUserLogtoConfigs: {
|
|
10737
|
+
parameters: {
|
|
10738
|
+
query?: never;
|
|
10739
|
+
header?: never;
|
|
10740
|
+
path: {
|
|
10741
|
+
/** @description The unique identifier of the user. */
|
|
10742
|
+
userId: components["parameters"]["userId"];
|
|
10743
|
+
};
|
|
10744
|
+
cookie?: never;
|
|
10745
|
+
};
|
|
10746
|
+
requestBody: {
|
|
10747
|
+
content: {
|
|
10748
|
+
"application/json": {
|
|
10749
|
+
mfa: {
|
|
10750
|
+
/** @description Set whether the user is marked as having skipped MFA binding. */
|
|
10751
|
+
skipped: boolean;
|
|
10752
|
+
};
|
|
10753
|
+
};
|
|
10754
|
+
};
|
|
10755
|
+
};
|
|
10756
|
+
responses: {
|
|
10757
|
+
/** @description The exposed logto config fields were updated successfully. */
|
|
10758
|
+
200: {
|
|
10759
|
+
headers: {
|
|
10760
|
+
[name: string]: unknown;
|
|
10761
|
+
};
|
|
10762
|
+
content: {
|
|
10763
|
+
"application/json": {
|
|
10764
|
+
mfa: {
|
|
10765
|
+
skipped: boolean;
|
|
10766
|
+
};
|
|
10767
|
+
};
|
|
10768
|
+
};
|
|
10769
|
+
};
|
|
10770
|
+
/** @description Bad Request */
|
|
10771
|
+
400: {
|
|
10772
|
+
headers: {
|
|
10773
|
+
[name: string]: unknown;
|
|
10774
|
+
};
|
|
10775
|
+
content?: never;
|
|
10776
|
+
};
|
|
10777
|
+
/** @description Unauthorized */
|
|
10778
|
+
401: {
|
|
10779
|
+
headers: {
|
|
10780
|
+
[name: string]: unknown;
|
|
10781
|
+
};
|
|
10782
|
+
content?: never;
|
|
10783
|
+
};
|
|
10784
|
+
/** @description Forbidden */
|
|
10785
|
+
403: {
|
|
10786
|
+
headers: {
|
|
10787
|
+
[name: string]: unknown;
|
|
10788
|
+
};
|
|
10789
|
+
content?: never;
|
|
10790
|
+
};
|
|
10791
|
+
/** @description Not Found */
|
|
10792
|
+
404: {
|
|
10793
|
+
headers: {
|
|
10794
|
+
[name: string]: unknown;
|
|
10795
|
+
};
|
|
10796
|
+
content?: never;
|
|
10797
|
+
};
|
|
10798
|
+
};
|
|
10799
|
+
};
|
|
10628
10800
|
UpdateUserProfile: {
|
|
10629
10801
|
parameters: {
|
|
10630
10802
|
query?: never;
|
|
@@ -12342,6 +12514,73 @@ export interface operations {
|
|
|
12342
12514
|
};
|
|
12343
12515
|
};
|
|
12344
12516
|
};
|
|
12517
|
+
UpdatePersonalAccessTokenName: {
|
|
12518
|
+
parameters: {
|
|
12519
|
+
query?: never;
|
|
12520
|
+
header?: never;
|
|
12521
|
+
path: {
|
|
12522
|
+
/** @description The unique identifier of the user. */
|
|
12523
|
+
userId: components["parameters"]["userId"];
|
|
12524
|
+
};
|
|
12525
|
+
cookie?: never;
|
|
12526
|
+
};
|
|
12527
|
+
requestBody: {
|
|
12528
|
+
content: {
|
|
12529
|
+
"application/json": {
|
|
12530
|
+
/** @description The new token name. Must be unique within the user. */
|
|
12531
|
+
name: string;
|
|
12532
|
+
/** @description The current name of the token to update. */
|
|
12533
|
+
currentName?: string;
|
|
12534
|
+
};
|
|
12535
|
+
};
|
|
12536
|
+
};
|
|
12537
|
+
responses: {
|
|
12538
|
+
/** @description The token was updated successfully. */
|
|
12539
|
+
200: {
|
|
12540
|
+
headers: {
|
|
12541
|
+
[name: string]: unknown;
|
|
12542
|
+
};
|
|
12543
|
+
content: {
|
|
12544
|
+
"application/json": {
|
|
12545
|
+
tenantId: string;
|
|
12546
|
+
userId: string;
|
|
12547
|
+
name: string;
|
|
12548
|
+
value: string;
|
|
12549
|
+
createdAt: number;
|
|
12550
|
+
expiresAt: number | null;
|
|
12551
|
+
};
|
|
12552
|
+
};
|
|
12553
|
+
};
|
|
12554
|
+
/** @description Bad Request */
|
|
12555
|
+
400: {
|
|
12556
|
+
headers: {
|
|
12557
|
+
[name: string]: unknown;
|
|
12558
|
+
};
|
|
12559
|
+
content?: never;
|
|
12560
|
+
};
|
|
12561
|
+
/** @description Unauthorized */
|
|
12562
|
+
401: {
|
|
12563
|
+
headers: {
|
|
12564
|
+
[name: string]: unknown;
|
|
12565
|
+
};
|
|
12566
|
+
content?: never;
|
|
12567
|
+
};
|
|
12568
|
+
/** @description Forbidden */
|
|
12569
|
+
403: {
|
|
12570
|
+
headers: {
|
|
12571
|
+
[name: string]: unknown;
|
|
12572
|
+
};
|
|
12573
|
+
content?: never;
|
|
12574
|
+
};
|
|
12575
|
+
/** @description Not Found */
|
|
12576
|
+
404: {
|
|
12577
|
+
headers: {
|
|
12578
|
+
[name: string]: unknown;
|
|
12579
|
+
};
|
|
12580
|
+
content?: never;
|
|
12581
|
+
};
|
|
12582
|
+
};
|
|
12583
|
+
};
|
|
12345
12584
|
DeleteUserPersonalAccessToken: {
|
|
12346
12585
|
parameters: {
|
|
12347
12586
|
query?: never;
|
|
@@ -12400,7 +12639,7 @@ export interface operations {
|
|
|
12400
12639
|
path: {
|
|
12401
12640
|
/** @description The unique identifier of the user. */
|
|
12402
12641
|
userId: components["parameters"]["userId"];
|
|
12403
|
-
/** @description The name of the token. */
|
|
12642
|
+
/** @description The current name of the token. */
|
|
12404
12643
|
name: string;
|
|
12405
12644
|
};
|
|
12406
12645
|
cookie?: never;
|
|
@@ -12408,13 +12647,13 @@ export interface operations {
|
|
|
12408
12647
|
requestBody: {
|
|
12409
12648
|
content: {
|
|
12410
12649
|
"application/json": {
|
|
12411
|
-
/** @description The token name
|
|
12650
|
+
/** @description The new token name. Must be unique within the user. */
|
|
12412
12651
|
name: string;
|
|
12413
12652
|
};
|
|
12414
12653
|
};
|
|
12415
12654
|
};
|
|
12416
12655
|
responses: {
|
|
12417
|
-
/** @description
|
|
12656
|
+
/** @description The token was updated successfully. */
|
|
12418
12657
|
200: {
|
|
12419
12658
|
headers: {
|
|
12420
12659
|
[name: string]: unknown;
|
|
@@ -12430,7 +12669,56 @@ export interface operations {
|
|
|
12430
12669
|
};
|
|
12431
12670
|
};
|
|
12432
12671
|
};
|
|
12433
|
-
/** @description
|
|
12672
|
+
/** @description Bad Request */
|
|
12673
|
+
400: {
|
|
12674
|
+
headers: {
|
|
12675
|
+
[name: string]: unknown;
|
|
12676
|
+
};
|
|
12677
|
+
content?: never;
|
|
12678
|
+
};
|
|
12679
|
+
/** @description Unauthorized */
|
|
12680
|
+
401: {
|
|
12681
|
+
headers: {
|
|
12682
|
+
[name: string]: unknown;
|
|
12683
|
+
};
|
|
12684
|
+
content?: never;
|
|
12685
|
+
};
|
|
12686
|
+
/** @description Forbidden */
|
|
12687
|
+
403: {
|
|
12688
|
+
headers: {
|
|
12689
|
+
[name: string]: unknown;
|
|
12690
|
+
};
|
|
12691
|
+
content?: never;
|
|
12692
|
+
};
|
|
12693
|
+
/** @description Not Found */
|
|
12694
|
+
404: {
|
|
12695
|
+
headers: {
|
|
12696
|
+
[name: string]: unknown;
|
|
12697
|
+
};
|
|
12698
|
+
content?: never;
|
|
12699
|
+
};
|
|
12700
|
+
};
|
|
12701
|
+
};
|
|
12702
|
+
DeletePersonalAccessTokenPost: {
|
|
12703
|
+
parameters: {
|
|
12704
|
+
query?: never;
|
|
12705
|
+
header?: never;
|
|
12706
|
+
path: {
|
|
12707
|
+
/** @description The unique identifier of the user. */
|
|
12708
|
+
userId: components["parameters"]["userId"];
|
|
12709
|
+
};
|
|
12710
|
+
cookie?: never;
|
|
12711
|
+
};
|
|
12712
|
+
requestBody: {
|
|
12713
|
+
content: {
|
|
12714
|
+
"application/json": {
|
|
12715
|
+
/** @description The name of the token to delete. */
|
|
12716
|
+
name: string;
|
|
12717
|
+
};
|
|
12718
|
+
};
|
|
12719
|
+
};
|
|
12720
|
+
responses: {
|
|
12721
|
+
/** @description The token was deleted successfully. */
|
|
12434
12722
|
204: {
|
|
12435
12723
|
headers: {
|
|
12436
12724
|
[name: string]: unknown;
|
|
@@ -22587,6 +22875,7 @@ export interface operations {
|
|
|
22587
22875
|
/** Format: url */
|
|
22588
22876
|
darkFavicon?: string;
|
|
22589
22877
|
};
|
|
22878
|
+
hideLogtoBranding: boolean;
|
|
22590
22879
|
languageInfo: {
|
|
22591
22880
|
autoDetect: boolean;
|
|
22592
22881
|
/** @enum {string} */
|
|
@@ -22846,6 +23135,7 @@ export interface operations {
|
|
|
22846
23135
|
/** Format: url */
|
|
22847
23136
|
darkFavicon?: string;
|
|
22848
23137
|
};
|
|
23138
|
+
hideLogtoBranding: boolean;
|
|
22849
23139
|
languageInfo: {
|
|
22850
23140
|
autoDetect: boolean;
|
|
22851
23141
|
/** @enum {string} */
|