aspera-cli 4.27.2 → 4.27.4
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.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/CHANGELOG.md +133 -0
- data/CONTRIBUTING.md +5 -2
- data/bin/ascli +3 -1
- data/docs/README.md +1006 -766
- data/lib/aspera/agent/base.rb +7 -2
- data/lib/aspera/agent/connect.rb +6 -8
- data/lib/aspera/agent/desktop.rb +2 -6
- data/lib/aspera/agent/direct.rb +52 -22
- data/lib/aspera/agent/node.rb +9 -8
- data/lib/aspera/agent/transferd.rb +2 -2
- data/lib/aspera/api/alee.rb +1 -1
- data/lib/aspera/api/aoc.rb +14 -12
- data/lib/aspera/api/ats.rb +1 -1
- data/lib/aspera/api/cos_node.rb +2 -2
- data/lib/aspera/api/faspex.rb +11 -7
- data/lib/aspera/api/httpgw.rb +38 -35
- data/lib/aspera/api/node.rb +39 -34
- data/lib/aspera/ascmd.rb +3 -1
- data/lib/aspera/ascp/installation.rb +63 -28
- data/lib/aspera/ascp/management.rb +1 -0
- data/lib/aspera/assert.rb +4 -0
- data/lib/aspera/cli/ascp_actions.rb +20 -41
- data/lib/aspera/cli/async_transfer_store.rb +12 -11
- data/lib/aspera/cli/bootstrapper.rb +14 -16
- data/lib/aspera/cli/command_line.rb +252 -0
- data/lib/aspera/cli/command_registry.rb +215 -37
- data/lib/aspera/cli/command_spec.rb +104 -15
- data/lib/aspera/cli/completion/ascli.bash +12 -0
- data/lib/aspera/cli/completion/ascli.fish +16 -0
- data/lib/aspera/cli/completion/ascli.zsh +19 -0
- data/lib/aspera/cli/context.rb +3 -0
- data/lib/aspera/cli/deprecation.rb +37 -0
- data/lib/aspera/cli/extended_value.rb +6 -3
- data/lib/aspera/cli/formatter.rb +94 -80
- data/lib/aspera/cli/gem_checker.rb +1 -1
- data/lib/aspera/cli/hints.rb +7 -6
- data/lib/aspera/cli/http.rb +22 -34
- data/lib/aspera/cli/info.rb +3 -0
- data/lib/aspera/cli/mcp_tool.rb +47 -83
- data/lib/aspera/cli/option_declarator.rb +33 -42
- data/lib/aspera/cli/option_registry.rb +69 -0
- data/lib/aspera/cli/option_types.rb +105 -0
- data/lib/aspera/cli/option_value.rb +278 -0
- data/lib/aspera/cli/options.schema.yaml +124 -15
- data/lib/aspera/cli/parser.rb +333 -862
- data/lib/aspera/cli/plugins/alee.rb +7 -4
- data/lib/aspera/cli/plugins/aoc.rb +545 -518
- data/lib/aspera/cli/plugins/ats.rb +59 -80
- data/lib/aspera/cli/plugins/base.rb +221 -265
- data/lib/aspera/cli/plugins/basic_auth.rb +2 -10
- data/lib/aspera/cli/plugins/config.rb +263 -184
- data/lib/aspera/cli/plugins/console.rb +103 -39
- data/lib/aspera/cli/plugins/cos.rb +6 -23
- data/lib/aspera/cli/plugins/factory.rb +3 -0
- data/lib/aspera/cli/plugins/faspex5.rb +204 -182
- data/lib/aspera/cli/plugins/faspio.rb +6 -11
- data/lib/aspera/cli/plugins/httpgw.rb +8 -11
- data/lib/aspera/cli/plugins/mcp.rb +20 -55
- data/lib/aspera/cli/plugins/node.rb +300 -327
- data/lib/aspera/cli/plugins/orchestrator.rb +152 -110
- data/lib/aspera/cli/plugins/preview.rb +96 -105
- data/lib/aspera/cli/plugins/server.rb +78 -53
- data/lib/aspera/cli/plugins/shares.rb +80 -131
- data/lib/aspera/cli/preset_actions.rb +44 -27
- data/lib/aspera/cli/preset_manager.rb +44 -19
- data/lib/aspera/cli/prompt.rb +36 -0
- data/lib/aspera/cli/result.rb +42 -36
- data/lib/aspera/cli/runner.rb +32 -59
- data/lib/aspera/cli/special_values.rb +5 -0
- data/lib/aspera/cli/sync_actions.rb +51 -46
- data/lib/aspera/cli/terminal_formatter.rb +9 -3
- data/lib/aspera/cli/transfer_actions.rb +14 -9
- data/lib/aspera/cli/transfer_agent.rb +34 -38
- data/lib/aspera/cli/transfer_progress.rb +290 -55
- data/lib/aspera/cli/vault_manager.rb +0 -17
- data/lib/aspera/cli/version.rb +1 -1
- data/lib/aspera/cli/wizard.rb +5 -3
- data/lib/aspera/coverage.rb +1 -1
- data/lib/aspera/environment.rb +35 -5
- data/lib/aspera/faspex_gw.rb +2 -1
- data/lib/aspera/faspex_postproc.rb +1 -0
- data/lib/aspera/graphql.rb +5 -5
- data/lib/aspera/json_rpc/client.rb +5 -5
- data/lib/aspera/keychain/encrypted_hash.rb +2 -2
- data/lib/aspera/keychain/factory.rb +2 -1
- data/lib/aspera/keychain/one_password_api.rb +1 -1
- data/lib/aspera/link_header.rb +2 -2
- data/lib/aspera/log.rb +47 -27
- data/lib/aspera/markdown.rb +2 -0
- data/lib/aspera/mime.rb +25 -0
- data/lib/aspera/node_emulator.rb +759 -0
- data/lib/aspera/oauth/base.rb +37 -26
- data/lib/aspera/oauth/factory.rb +7 -3
- data/lib/aspera/oauth/generic.rb +1 -1
- data/lib/aspera/oauth/json_credentials.rb +34 -0
- data/lib/aspera/oauth/jwt.rb +4 -5
- data/lib/aspera/oauth/web.rb +9 -8
- data/lib/aspera/oauth.rb +1 -0
- data/lib/aspera/persistency_folder.rb +1 -3
- data/lib/aspera/preview/file_types.rb +4 -4
- data/lib/aspera/preview/generator.rb +11 -1
- data/lib/aspera/preview/options.schema.yaml +119 -0
- data/lib/aspera/preview/terminal.rb +4 -3
- data/lib/aspera/preview/utils.rb +9 -6
- data/lib/aspera/products/connect.rb +1 -1
- data/lib/aspera/rainbow.rb +7 -0
- data/lib/aspera/rest/aspera_errors.rb +72 -0
- data/lib/aspera/rest/call_error.rb +27 -0
- data/lib/aspera/rest/client.rb +523 -0
- data/lib/aspera/rest/error_analyzer.rb +113 -0
- data/lib/aspera/rest/list.rb +149 -0
- data/lib/aspera/rest/parameters.rb +55 -0
- data/lib/aspera/rest/util.rb +176 -0
- data/lib/aspera/rest.rb +7 -621
- data/lib/aspera/schema/IBM Aspera Console-enhanced.yaml +1125 -0
- data/lib/aspera/schema/IBM Aspera Faspex API-5.0-enhanced.yaml +0 -20
- data/lib/aspera/schema/IBM Aspera Orchestrator API-v1.yaml +1784 -0
- data/lib/aspera/schema/IBM Aspera on Cloud API-0.2.6-enhanced.yaml +1230 -137
- data/lib/aspera/schema/IBM Aspera on Cloud Automation API-1.0.5-enhanced.yaml +2395 -0
- data/lib/aspera/schema/IBM_Aspera_Shares.yaml +14 -13
- data/lib/aspera/schema/documentation.rb +13 -3
- data/lib/aspera/schema/reader.rb +12 -18
- data/lib/aspera/schema/registry.rb +23 -1
- data/lib/aspera/schema/validator.rb +92 -0
- data/lib/aspera/secret_hider.rb +36 -25
- data/lib/aspera/string_ext.rb +15 -0
- data/lib/aspera/temp_file_manager.rb +6 -5
- data/lib/aspera/transfer/parameters.rb +2 -0
- data/lib/aspera/transfer/spec.rb +1 -0
- data/lib/aspera/uri_reader.rb +11 -11
- data/lib/aspera/web_auth/index.html +147 -0
- data/lib/aspera/web_auth/server.rb +81 -0
- data.tar.gz.sig +0 -0
- metadata +43 -9
- metadata.gz.sig +0 -0
- data/lib/aspera/colors.rb +0 -79
- data/lib/aspera/node_simulator.rb +0 -344
- data/lib/aspera/preview/options.rb +0 -45
- data/lib/aspera/rest_call_error.rb +0 -25
- data/lib/aspera/rest_error_analyzer.rb +0 -111
- data/lib/aspera/rest_errors_aspera.rb +0 -58
- data/lib/aspera/rest_list.rb +0 -136
- data/lib/aspera/web_auth.rb +0 -211
|
@@ -754,6 +754,10 @@ paths:
|
|
|
754
754
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
755
755
|
'500':
|
|
756
756
|
description: Internal Server Error
|
|
757
|
+
content:
|
|
758
|
+
application/json:
|
|
759
|
+
schema:
|
|
760
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
757
761
|
tags:
|
|
758
762
|
- App Memberships
|
|
759
763
|
/apps/app_memberships/{id}:
|
|
@@ -788,6 +792,10 @@ paths:
|
|
|
788
792
|
$ref: '#/components/schemas/NotFoundError'
|
|
789
793
|
'500':
|
|
790
794
|
description: Internal Server Error
|
|
795
|
+
content:
|
|
796
|
+
application/json:
|
|
797
|
+
schema:
|
|
798
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
791
799
|
tags:
|
|
792
800
|
- App Memberships
|
|
793
801
|
get:
|
|
@@ -825,6 +833,10 @@ paths:
|
|
|
825
833
|
$ref: '#/components/schemas/NotFoundError'
|
|
826
834
|
'500':
|
|
827
835
|
description: Internal Server Error
|
|
836
|
+
content:
|
|
837
|
+
application/json:
|
|
838
|
+
schema:
|
|
839
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
828
840
|
tags:
|
|
829
841
|
- App Memberships
|
|
830
842
|
/apps/{aspera_app_type}/app_memberships:
|
|
@@ -878,6 +890,10 @@ paths:
|
|
|
878
890
|
description: Unprocessable Entity
|
|
879
891
|
'500':
|
|
880
892
|
description: Internal Server Error
|
|
893
|
+
content:
|
|
894
|
+
application/json:
|
|
895
|
+
schema:
|
|
896
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
881
897
|
tags:
|
|
882
898
|
- App Memberships
|
|
883
899
|
get:
|
|
@@ -949,6 +965,10 @@ paths:
|
|
|
949
965
|
$ref: '#/components/schemas/NotFoundError'
|
|
950
966
|
'500':
|
|
951
967
|
description: Internal Server Error
|
|
968
|
+
content:
|
|
969
|
+
application/json:
|
|
970
|
+
schema:
|
|
971
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
952
972
|
tags:
|
|
953
973
|
- App Memberships
|
|
954
974
|
/apps/{aspera_app_type}/app_memberships/{id}:
|
|
@@ -998,6 +1018,10 @@ paths:
|
|
|
998
1018
|
$ref: '#/components/schemas/NotFoundError'
|
|
999
1019
|
'500':
|
|
1000
1020
|
description: Internal Server Error
|
|
1021
|
+
content:
|
|
1022
|
+
application/json:
|
|
1023
|
+
schema:
|
|
1024
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1001
1025
|
tags:
|
|
1002
1026
|
- App Memberships
|
|
1003
1027
|
put:
|
|
@@ -1049,6 +1073,10 @@ paths:
|
|
|
1049
1073
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
1050
1074
|
'403':
|
|
1051
1075
|
description: Forbidden
|
|
1076
|
+
content:
|
|
1077
|
+
application/json:
|
|
1078
|
+
schema:
|
|
1079
|
+
$ref: '#/components/schemas/ForbiddenError'
|
|
1052
1080
|
'404':
|
|
1053
1081
|
description: Not Found
|
|
1054
1082
|
content:
|
|
@@ -1059,6 +1087,10 @@ paths:
|
|
|
1059
1087
|
description: Unprocessable Entity
|
|
1060
1088
|
'500':
|
|
1061
1089
|
description: Internal Server Error
|
|
1090
|
+
content:
|
|
1091
|
+
application/json:
|
|
1092
|
+
schema:
|
|
1093
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1062
1094
|
tags:
|
|
1063
1095
|
- App Memberships
|
|
1064
1096
|
/client_access_keys:
|
|
@@ -1106,6 +1138,10 @@ paths:
|
|
|
1106
1138
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
1107
1139
|
'500':
|
|
1108
1140
|
description: Internal Server Error
|
|
1141
|
+
content:
|
|
1142
|
+
application/json:
|
|
1143
|
+
schema:
|
|
1144
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1109
1145
|
tags:
|
|
1110
1146
|
- Client Access Keys
|
|
1111
1147
|
post:
|
|
@@ -1139,6 +1175,10 @@ paths:
|
|
|
1139
1175
|
description: Unprocessable Entity
|
|
1140
1176
|
'500':
|
|
1141
1177
|
description: Internal Server Error
|
|
1178
|
+
content:
|
|
1179
|
+
application/json:
|
|
1180
|
+
schema:
|
|
1181
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1142
1182
|
tags:
|
|
1143
1183
|
- Client Access Keys
|
|
1144
1184
|
/client_access_keys/{id}:
|
|
@@ -1172,6 +1212,10 @@ paths:
|
|
|
1172
1212
|
$ref: '#/components/schemas/NotFoundError'
|
|
1173
1213
|
'500':
|
|
1174
1214
|
description: Internal Server Error
|
|
1215
|
+
content:
|
|
1216
|
+
application/json:
|
|
1217
|
+
schema:
|
|
1218
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1175
1219
|
tags:
|
|
1176
1220
|
- Client Access Keys
|
|
1177
1221
|
get:
|
|
@@ -1209,6 +1253,10 @@ paths:
|
|
|
1209
1253
|
$ref: '#/components/schemas/NotFoundError'
|
|
1210
1254
|
'500':
|
|
1211
1255
|
description: Internal Server Error
|
|
1256
|
+
content:
|
|
1257
|
+
application/json:
|
|
1258
|
+
schema:
|
|
1259
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1212
1260
|
tags:
|
|
1213
1261
|
- Client Access Keys
|
|
1214
1262
|
put:
|
|
@@ -1257,6 +1305,10 @@ paths:
|
|
|
1257
1305
|
description: Unprocessable Entity
|
|
1258
1306
|
'500':
|
|
1259
1307
|
description: Internal Server Error
|
|
1308
|
+
content:
|
|
1309
|
+
application/json:
|
|
1310
|
+
schema:
|
|
1311
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1260
1312
|
tags:
|
|
1261
1313
|
- Client Access Keys
|
|
1262
1314
|
/client_authorizations:
|
|
@@ -1314,6 +1366,10 @@ paths:
|
|
|
1314
1366
|
description: Unprocessable Entity
|
|
1315
1367
|
'500':
|
|
1316
1368
|
description: Internal Server Error
|
|
1369
|
+
content:
|
|
1370
|
+
application/json:
|
|
1371
|
+
schema:
|
|
1372
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1317
1373
|
tags:
|
|
1318
1374
|
- Client Authorizations
|
|
1319
1375
|
post:
|
|
@@ -1353,6 +1409,10 @@ paths:
|
|
|
1353
1409
|
description: Unprocessable Entity
|
|
1354
1410
|
'500':
|
|
1355
1411
|
description: Internal Server Error
|
|
1412
|
+
content:
|
|
1413
|
+
application/json:
|
|
1414
|
+
schema:
|
|
1415
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1356
1416
|
tags:
|
|
1357
1417
|
- Client Authorizations
|
|
1358
1418
|
/client_authorizations/{id}:
|
|
@@ -1390,6 +1450,10 @@ paths:
|
|
|
1390
1450
|
description: Unprocessable Entity
|
|
1391
1451
|
'500':
|
|
1392
1452
|
description: Internal Server Error
|
|
1453
|
+
content:
|
|
1454
|
+
application/json:
|
|
1455
|
+
schema:
|
|
1456
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1393
1457
|
tags:
|
|
1394
1458
|
- Client Authorizations
|
|
1395
1459
|
get:
|
|
@@ -1435,6 +1499,10 @@ paths:
|
|
|
1435
1499
|
description: Unprocessable Entity
|
|
1436
1500
|
'500':
|
|
1437
1501
|
description: Internal Server Error
|
|
1502
|
+
content:
|
|
1503
|
+
application/json:
|
|
1504
|
+
schema:
|
|
1505
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1438
1506
|
tags:
|
|
1439
1507
|
- Client Authorizations
|
|
1440
1508
|
/clients:
|
|
@@ -1471,6 +1539,10 @@ paths:
|
|
|
1471
1539
|
description: Unprocessable Entity
|
|
1472
1540
|
'500':
|
|
1473
1541
|
description: Internal Server Error
|
|
1542
|
+
content:
|
|
1543
|
+
application/json:
|
|
1544
|
+
schema:
|
|
1545
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1474
1546
|
tags:
|
|
1475
1547
|
- Clients
|
|
1476
1548
|
post:
|
|
@@ -1506,6 +1578,10 @@ paths:
|
|
|
1506
1578
|
description: Unprocessable Entity
|
|
1507
1579
|
'500':
|
|
1508
1580
|
description: Internal Server Error
|
|
1581
|
+
content:
|
|
1582
|
+
application/json:
|
|
1583
|
+
schema:
|
|
1584
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1509
1585
|
tags:
|
|
1510
1586
|
- Clients
|
|
1511
1587
|
/clients/{id}:
|
|
@@ -1543,6 +1619,10 @@ paths:
|
|
|
1543
1619
|
description: Unprocessable Entity
|
|
1544
1620
|
'500':
|
|
1545
1621
|
description: Internal Server Error
|
|
1622
|
+
content:
|
|
1623
|
+
application/json:
|
|
1624
|
+
schema:
|
|
1625
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1546
1626
|
tags:
|
|
1547
1627
|
- Clients
|
|
1548
1628
|
get:
|
|
@@ -1583,6 +1663,10 @@ paths:
|
|
|
1583
1663
|
description: Unprocessable Entity
|
|
1584
1664
|
'500':
|
|
1585
1665
|
description: Internal Server Error
|
|
1666
|
+
content:
|
|
1667
|
+
application/json:
|
|
1668
|
+
schema:
|
|
1669
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1586
1670
|
tags:
|
|
1587
1671
|
- Clients
|
|
1588
1672
|
put:
|
|
@@ -1625,6 +1709,10 @@ paths:
|
|
|
1625
1709
|
description: Unprocessable Entity
|
|
1626
1710
|
'500':
|
|
1627
1711
|
description: Internal Server Error
|
|
1712
|
+
content:
|
|
1713
|
+
application/json:
|
|
1714
|
+
schema:
|
|
1715
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1628
1716
|
tags:
|
|
1629
1717
|
- Clients
|
|
1630
1718
|
/dropbox_memberships:
|
|
@@ -1753,6 +1841,10 @@ paths:
|
|
|
1753
1841
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
1754
1842
|
'500':
|
|
1755
1843
|
description: Internal Server Error
|
|
1844
|
+
content:
|
|
1845
|
+
application/json:
|
|
1846
|
+
schema:
|
|
1847
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1756
1848
|
tags:
|
|
1757
1849
|
- Dropbox Memberships
|
|
1758
1850
|
post:
|
|
@@ -1786,6 +1878,10 @@ paths:
|
|
|
1786
1878
|
description: Unprocessable Entity
|
|
1787
1879
|
'500':
|
|
1788
1880
|
description: Internal Server Error
|
|
1881
|
+
content:
|
|
1882
|
+
application/json:
|
|
1883
|
+
schema:
|
|
1884
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1789
1885
|
tags:
|
|
1790
1886
|
- Dropbox Memberships
|
|
1791
1887
|
/dropbox_memberships/{id}:
|
|
@@ -1821,6 +1917,10 @@ paths:
|
|
|
1821
1917
|
$ref: '#/components/schemas/NotFoundError'
|
|
1822
1918
|
'500':
|
|
1823
1919
|
description: Internal Server Error
|
|
1920
|
+
content:
|
|
1921
|
+
application/json:
|
|
1922
|
+
schema:
|
|
1923
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1824
1924
|
tags:
|
|
1825
1925
|
- Dropbox Memberships
|
|
1826
1926
|
get:
|
|
@@ -1863,6 +1963,10 @@ paths:
|
|
|
1863
1963
|
$ref: '#/components/schemas/NotFoundError'
|
|
1864
1964
|
'500':
|
|
1865
1965
|
description: Internal Server Error
|
|
1966
|
+
content:
|
|
1967
|
+
application/json:
|
|
1968
|
+
schema:
|
|
1969
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1866
1970
|
tags:
|
|
1867
1971
|
- Dropbox Memberships
|
|
1868
1972
|
put:
|
|
@@ -1899,6 +2003,10 @@ paths:
|
|
|
1899
2003
|
description: Unprocessable Entity
|
|
1900
2004
|
'500':
|
|
1901
2005
|
description: Internal Server Error
|
|
2006
|
+
content:
|
|
2007
|
+
application/json:
|
|
2008
|
+
schema:
|
|
2009
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1902
2010
|
tags:
|
|
1903
2011
|
- Dropbox Memberships
|
|
1904
2012
|
/dropboxes:
|
|
@@ -1954,6 +2062,10 @@ paths:
|
|
|
1954
2062
|
$ref: '#/components/schemas/NotFoundError'
|
|
1955
2063
|
'500':
|
|
1956
2064
|
description: Internal Server Error
|
|
2065
|
+
content:
|
|
2066
|
+
application/json:
|
|
2067
|
+
schema:
|
|
2068
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1957
2069
|
tags:
|
|
1958
2070
|
- Dropboxes
|
|
1959
2071
|
post:
|
|
@@ -1989,6 +2101,10 @@ paths:
|
|
|
1989
2101
|
description: Unprocessable Entity
|
|
1990
2102
|
'500':
|
|
1991
2103
|
description: Internal Server Error
|
|
2104
|
+
content:
|
|
2105
|
+
application/json:
|
|
2106
|
+
schema:
|
|
2107
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
1992
2108
|
tags:
|
|
1993
2109
|
- Dropboxes
|
|
1994
2110
|
/dropboxes/{id}:
|
|
@@ -2024,6 +2140,10 @@ paths:
|
|
|
2024
2140
|
description: Unprocessable Entity
|
|
2025
2141
|
'500':
|
|
2026
2142
|
description: Internal Server Error
|
|
2143
|
+
content:
|
|
2144
|
+
application/json:
|
|
2145
|
+
schema:
|
|
2146
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2027
2147
|
tags:
|
|
2028
2148
|
- Dropboxes
|
|
2029
2149
|
get:
|
|
@@ -2060,6 +2180,10 @@ paths:
|
|
|
2060
2180
|
$ref: '#/components/schemas/NotFoundError'
|
|
2061
2181
|
'500':
|
|
2062
2182
|
description: Internal Server Error
|
|
2183
|
+
content:
|
|
2184
|
+
application/json:
|
|
2185
|
+
schema:
|
|
2186
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2063
2187
|
tags:
|
|
2064
2188
|
- Dropboxes
|
|
2065
2189
|
put:
|
|
@@ -2102,6 +2226,10 @@ paths:
|
|
|
2102
2226
|
description: Unprocessable Entity
|
|
2103
2227
|
'500':
|
|
2104
2228
|
description: Internal Server Error
|
|
2229
|
+
content:
|
|
2230
|
+
application/json:
|
|
2231
|
+
schema:
|
|
2232
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2105
2233
|
tags:
|
|
2106
2234
|
- Dropboxes
|
|
2107
2235
|
/nodes:
|
|
@@ -2164,6 +2292,10 @@ paths:
|
|
|
2164
2292
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
2165
2293
|
'500':
|
|
2166
2294
|
description: Internal Server Error
|
|
2295
|
+
content:
|
|
2296
|
+
application/json:
|
|
2297
|
+
schema:
|
|
2298
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2167
2299
|
tags:
|
|
2168
2300
|
- Nodes
|
|
2169
2301
|
post:
|
|
@@ -2193,6 +2325,10 @@ paths:
|
|
|
2193
2325
|
description: Unprocessable Entity
|
|
2194
2326
|
'500':
|
|
2195
2327
|
description: Internal Server Error
|
|
2328
|
+
content:
|
|
2329
|
+
application/json:
|
|
2330
|
+
schema:
|
|
2331
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2196
2332
|
tags:
|
|
2197
2333
|
- Nodes
|
|
2198
2334
|
/nodes/{id}:
|
|
@@ -2222,6 +2358,10 @@ paths:
|
|
|
2222
2358
|
description: Unprocessable Entity
|
|
2223
2359
|
'500':
|
|
2224
2360
|
description: Internal Server Error
|
|
2361
|
+
content:
|
|
2362
|
+
application/json:
|
|
2363
|
+
schema:
|
|
2364
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2225
2365
|
tags:
|
|
2226
2366
|
- Nodes
|
|
2227
2367
|
get:
|
|
@@ -2258,6 +2398,10 @@ paths:
|
|
|
2258
2398
|
$ref: '#/components/schemas/NotFoundError'
|
|
2259
2399
|
'500':
|
|
2260
2400
|
description: Internal Server Error
|
|
2401
|
+
content:
|
|
2402
|
+
application/json:
|
|
2403
|
+
schema:
|
|
2404
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2261
2405
|
tags:
|
|
2262
2406
|
- Nodes
|
|
2263
2407
|
put:
|
|
@@ -2294,6 +2438,10 @@ paths:
|
|
|
2294
2438
|
description: Unprocessable Entity
|
|
2295
2439
|
'500':
|
|
2296
2440
|
description: Internal Server Error
|
|
2441
|
+
content:
|
|
2442
|
+
application/json:
|
|
2443
|
+
schema:
|
|
2444
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2297
2445
|
tags:
|
|
2298
2446
|
- Nodes
|
|
2299
2447
|
/nodes/{id}/update_status:
|
|
@@ -2331,6 +2479,10 @@ paths:
|
|
|
2331
2479
|
$ref: '#/components/schemas/NotFoundError'
|
|
2332
2480
|
'500':
|
|
2333
2481
|
description: Internal Server Error
|
|
2482
|
+
content:
|
|
2483
|
+
application/json:
|
|
2484
|
+
schema:
|
|
2485
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2334
2486
|
tags:
|
|
2335
2487
|
- Nodes
|
|
2336
2488
|
/organizations/{id}:
|
|
@@ -2368,6 +2520,10 @@ paths:
|
|
|
2368
2520
|
$ref: '#/components/schemas/NotFoundError'
|
|
2369
2521
|
'500':
|
|
2370
2522
|
description: Internal Server Error
|
|
2523
|
+
content:
|
|
2524
|
+
application/json:
|
|
2525
|
+
schema:
|
|
2526
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2371
2527
|
tags:
|
|
2372
2528
|
- Organizations
|
|
2373
2529
|
put:
|
|
@@ -2399,6 +2555,10 @@ paths:
|
|
|
2399
2555
|
description: Unprocessable Entity
|
|
2400
2556
|
'500':
|
|
2401
2557
|
description: Internal Server Error
|
|
2558
|
+
content:
|
|
2559
|
+
application/json:
|
|
2560
|
+
schema:
|
|
2561
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2402
2562
|
tags:
|
|
2403
2563
|
- Organizations
|
|
2404
2564
|
/packages:
|
|
@@ -2579,6 +2739,10 @@ paths:
|
|
|
2579
2739
|
description: Unprocessable Entity
|
|
2580
2740
|
'500':
|
|
2581
2741
|
description: Internal Server Error
|
|
2742
|
+
content:
|
|
2743
|
+
application/json:
|
|
2744
|
+
schema:
|
|
2745
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2582
2746
|
tags:
|
|
2583
2747
|
- Packages
|
|
2584
2748
|
post:
|
|
@@ -2614,6 +2778,10 @@ paths:
|
|
|
2614
2778
|
description: Unprocessable Entity
|
|
2615
2779
|
'500':
|
|
2616
2780
|
description: Internal Server Error
|
|
2781
|
+
content:
|
|
2782
|
+
application/json:
|
|
2783
|
+
schema:
|
|
2784
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2617
2785
|
tags:
|
|
2618
2786
|
- Packages
|
|
2619
2787
|
/packages/{id}:
|
|
@@ -2654,6 +2822,10 @@ paths:
|
|
|
2654
2822
|
description: Unprocessable Entity
|
|
2655
2823
|
'500':
|
|
2656
2824
|
description: Internal Server Error
|
|
2825
|
+
content:
|
|
2826
|
+
application/json:
|
|
2827
|
+
schema:
|
|
2828
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2657
2829
|
tags:
|
|
2658
2830
|
- Packages
|
|
2659
2831
|
get:
|
|
@@ -2699,6 +2871,10 @@ paths:
|
|
|
2699
2871
|
description: Unprocessable Entity
|
|
2700
2872
|
'500':
|
|
2701
2873
|
description: Internal Server Error
|
|
2874
|
+
content:
|
|
2875
|
+
application/json:
|
|
2876
|
+
schema:
|
|
2877
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2702
2878
|
tags:
|
|
2703
2879
|
- Packages
|
|
2704
2880
|
put:
|
|
@@ -2744,6 +2920,10 @@ paths:
|
|
|
2744
2920
|
description: Unprocessable Entity
|
|
2745
2921
|
'500':
|
|
2746
2922
|
description: Internal Server Error
|
|
2923
|
+
content:
|
|
2924
|
+
application/json:
|
|
2925
|
+
schema:
|
|
2926
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2747
2927
|
tags:
|
|
2748
2928
|
- Packages
|
|
2749
2929
|
/usage_reports:
|
|
@@ -2793,6 +2973,10 @@ paths:
|
|
|
2793
2973
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
2794
2974
|
'500':
|
|
2795
2975
|
description: Internal Server Error
|
|
2976
|
+
content:
|
|
2977
|
+
application/json:
|
|
2978
|
+
schema:
|
|
2979
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2796
2980
|
tags:
|
|
2797
2981
|
- Usage Reports
|
|
2798
2982
|
/users:
|
|
@@ -2883,6 +3067,10 @@ paths:
|
|
|
2883
3067
|
description: Unprocessable Entity
|
|
2884
3068
|
'500':
|
|
2885
3069
|
description: Internal Server Error
|
|
3070
|
+
content:
|
|
3071
|
+
application/json:
|
|
3072
|
+
schema:
|
|
3073
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2886
3074
|
tags:
|
|
2887
3075
|
- Users
|
|
2888
3076
|
post:
|
|
@@ -2918,6 +3106,10 @@ paths:
|
|
|
2918
3106
|
description: Unprocessable Entity
|
|
2919
3107
|
'500':
|
|
2920
3108
|
description: Internal Server Error
|
|
3109
|
+
content:
|
|
3110
|
+
application/json:
|
|
3111
|
+
schema:
|
|
3112
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2921
3113
|
tags:
|
|
2922
3114
|
- Users
|
|
2923
3115
|
/users/{id}:
|
|
@@ -2955,6 +3147,10 @@ paths:
|
|
|
2955
3147
|
description: Unprocessable Entity
|
|
2956
3148
|
'500':
|
|
2957
3149
|
description: Internal Server Error
|
|
3150
|
+
content:
|
|
3151
|
+
application/json:
|
|
3152
|
+
schema:
|
|
3153
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
2958
3154
|
tags:
|
|
2959
3155
|
- Users
|
|
2960
3156
|
get:
|
|
@@ -3000,6 +3196,10 @@ paths:
|
|
|
3000
3196
|
description: Unprocessable Entity
|
|
3001
3197
|
'500':
|
|
3002
3198
|
description: Internal Server Error
|
|
3199
|
+
content:
|
|
3200
|
+
application/json:
|
|
3201
|
+
schema:
|
|
3202
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3003
3203
|
tags:
|
|
3004
3204
|
- Users
|
|
3005
3205
|
put:
|
|
@@ -3042,6 +3242,10 @@ paths:
|
|
|
3042
3242
|
description: Unprocessable Entity
|
|
3043
3243
|
'500':
|
|
3044
3244
|
description: Internal Server Error
|
|
3245
|
+
content:
|
|
3246
|
+
application/json:
|
|
3247
|
+
schema:
|
|
3248
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3045
3249
|
tags:
|
|
3046
3250
|
- Users
|
|
3047
3251
|
/users/{id}/user_interaction_preferences:
|
|
@@ -3073,6 +3277,10 @@ paths:
|
|
|
3073
3277
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
3074
3278
|
'403':
|
|
3075
3279
|
description: Forbidden - User can only access their own preferences unless they are an organization admin
|
|
3280
|
+
content:
|
|
3281
|
+
application/json:
|
|
3282
|
+
schema:
|
|
3283
|
+
$ref: '#/components/schemas/ForbiddenError'
|
|
3076
3284
|
'404':
|
|
3077
3285
|
description: Not Found
|
|
3078
3286
|
content:
|
|
@@ -3081,6 +3289,10 @@ paths:
|
|
|
3081
3289
|
$ref: '#/components/schemas/NotFoundError'
|
|
3082
3290
|
'500':
|
|
3083
3291
|
description: Internal Server Error
|
|
3292
|
+
content:
|
|
3293
|
+
application/json:
|
|
3294
|
+
schema:
|
|
3295
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3084
3296
|
tags:
|
|
3085
3297
|
- Users
|
|
3086
3298
|
put:
|
|
@@ -3114,6 +3326,10 @@ paths:
|
|
|
3114
3326
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
3115
3327
|
'403':
|
|
3116
3328
|
description: Forbidden - User can only update their own preferences unless they are an organization admin
|
|
3329
|
+
content:
|
|
3330
|
+
application/json:
|
|
3331
|
+
schema:
|
|
3332
|
+
$ref: '#/components/schemas/ForbiddenError'
|
|
3117
3333
|
'404':
|
|
3118
3334
|
description: Not Found
|
|
3119
3335
|
content:
|
|
@@ -3124,6 +3340,10 @@ paths:
|
|
|
3124
3340
|
description: Unprocessable Entity
|
|
3125
3341
|
'500':
|
|
3126
3342
|
description: Internal Server Error
|
|
3343
|
+
content:
|
|
3344
|
+
application/json:
|
|
3345
|
+
schema:
|
|
3346
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3127
3347
|
tags:
|
|
3128
3348
|
- Users
|
|
3129
3349
|
/workspace_memberships:
|
|
@@ -3188,6 +3408,10 @@ paths:
|
|
|
3188
3408
|
description: Unprocessable Entity
|
|
3189
3409
|
'500':
|
|
3190
3410
|
description: Internal Server Error
|
|
3411
|
+
content:
|
|
3412
|
+
application/json:
|
|
3413
|
+
schema:
|
|
3414
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3191
3415
|
tags:
|
|
3192
3416
|
- Workspace Memberships
|
|
3193
3417
|
post:
|
|
@@ -3227,6 +3451,10 @@ paths:
|
|
|
3227
3451
|
description: Unprocessable Entity
|
|
3228
3452
|
'500':
|
|
3229
3453
|
description: Internal Server Error
|
|
3454
|
+
content:
|
|
3455
|
+
application/json:
|
|
3456
|
+
schema:
|
|
3457
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3230
3458
|
tags:
|
|
3231
3459
|
- Workspace Memberships
|
|
3232
3460
|
/workspace_memberships/{id}:
|
|
@@ -3266,6 +3494,10 @@ paths:
|
|
|
3266
3494
|
description: Unprocessable Entity
|
|
3267
3495
|
'500':
|
|
3268
3496
|
description: Internal Server Error
|
|
3497
|
+
content:
|
|
3498
|
+
application/json:
|
|
3499
|
+
schema:
|
|
3500
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3269
3501
|
tags:
|
|
3270
3502
|
- Workspace Memberships
|
|
3271
3503
|
get:
|
|
@@ -3313,6 +3545,10 @@ paths:
|
|
|
3313
3545
|
description: Unprocessable Entity
|
|
3314
3546
|
'500':
|
|
3315
3547
|
description: Internal Server Error
|
|
3548
|
+
content:
|
|
3549
|
+
application/json:
|
|
3550
|
+
schema:
|
|
3551
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3316
3552
|
tags:
|
|
3317
3553
|
- Workspace Memberships
|
|
3318
3554
|
put:
|
|
@@ -3355,6 +3591,10 @@ paths:
|
|
|
3355
3591
|
description: Unprocessable Entity
|
|
3356
3592
|
'500':
|
|
3357
3593
|
description: Internal Server Error
|
|
3594
|
+
content:
|
|
3595
|
+
application/json:
|
|
3596
|
+
schema:
|
|
3597
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3358
3598
|
tags:
|
|
3359
3599
|
- Workspace Memberships
|
|
3360
3600
|
/workspaces:
|
|
@@ -3424,6 +3664,10 @@ paths:
|
|
|
3424
3664
|
description: Unprocessable Entity
|
|
3425
3665
|
'500':
|
|
3426
3666
|
description: Internal Server Error
|
|
3667
|
+
content:
|
|
3668
|
+
application/json:
|
|
3669
|
+
schema:
|
|
3670
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3427
3671
|
tags:
|
|
3428
3672
|
- Workspaces
|
|
3429
3673
|
post:
|
|
@@ -3459,6 +3703,10 @@ paths:
|
|
|
3459
3703
|
description: Unprocessable Entity
|
|
3460
3704
|
'500':
|
|
3461
3705
|
description: Internal Server Error
|
|
3706
|
+
content:
|
|
3707
|
+
application/json:
|
|
3708
|
+
schema:
|
|
3709
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
3462
3710
|
tags:
|
|
3463
3711
|
- Workspaces
|
|
3464
3712
|
/workspaces/{id}:
|
|
@@ -3570,6 +3818,13 @@ paths:
|
|
|
3570
3818
|
- $ref: '#/components/schemas/app_settings_packages'
|
|
3571
3819
|
- $ref: '#/components/schemas/app_settings_activity'
|
|
3572
3820
|
- $ref: '#/components/schemas/app_settings_automation'
|
|
3821
|
+
discriminator:
|
|
3822
|
+
propertyName: app_type
|
|
3823
|
+
mapping:
|
|
3824
|
+
files: '#/components/schemas/app_settings_files'
|
|
3825
|
+
packages: '#/components/schemas/app_settings_packages'
|
|
3826
|
+
activity: '#/components/schemas/app_settings_activity'
|
|
3827
|
+
automation: '#/components/schemas/app_settings_automation'
|
|
3573
3828
|
examples:
|
|
3574
3829
|
files:
|
|
3575
3830
|
summary: Files application settings
|
|
@@ -3652,7 +3907,7 @@ paths:
|
|
|
3652
3907
|
content:
|
|
3653
3908
|
application/json:
|
|
3654
3909
|
schema:
|
|
3655
|
-
|
|
3910
|
+
anyOf:
|
|
3656
3911
|
- $ref: '#/components/schemas/app_settings_files_update'
|
|
3657
3912
|
- $ref: '#/components/schemas/app_settings_packages_update'
|
|
3658
3913
|
- $ref: '#/components/schemas/app_settings_activity_update'
|
|
@@ -3680,6 +3935,13 @@ paths:
|
|
|
3680
3935
|
- $ref: '#/components/schemas/app_settings_packages'
|
|
3681
3936
|
- $ref: '#/components/schemas/app_settings_activity'
|
|
3682
3937
|
- $ref: '#/components/schemas/app_settings_automation'
|
|
3938
|
+
discriminator:
|
|
3939
|
+
propertyName: app_type
|
|
3940
|
+
mapping:
|
|
3941
|
+
files: '#/components/schemas/app_settings_files'
|
|
3942
|
+
packages: '#/components/schemas/app_settings_packages'
|
|
3943
|
+
activity: '#/components/schemas/app_settings_activity'
|
|
3944
|
+
automation: '#/components/schemas/app_settings_automation'
|
|
3683
3945
|
'204':
|
|
3684
3946
|
description: No Content
|
|
3685
3947
|
'400':
|
|
@@ -4643,6 +4905,20 @@ paths:
|
|
|
4643
4905
|
type: array
|
|
4644
4906
|
items:
|
|
4645
4907
|
$ref: '#/components/schemas/feature_flags_response'
|
|
4908
|
+
'400':
|
|
4909
|
+
description: Bad Request
|
|
4910
|
+
'401':
|
|
4911
|
+
description: Unauthorized
|
|
4912
|
+
content:
|
|
4913
|
+
application/json:
|
|
4914
|
+
schema:
|
|
4915
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
4916
|
+
'500':
|
|
4917
|
+
description: Internal Server Error
|
|
4918
|
+
content:
|
|
4919
|
+
application/json:
|
|
4920
|
+
schema:
|
|
4921
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4646
4922
|
tags:
|
|
4647
4923
|
- Feature Flags
|
|
4648
4924
|
post:
|
|
@@ -4663,6 +4939,20 @@ paths:
|
|
|
4663
4939
|
application/json:
|
|
4664
4940
|
schema:
|
|
4665
4941
|
$ref: '#/components/schemas/feature_flags_response'
|
|
4942
|
+
'400':
|
|
4943
|
+
description: Bad Request
|
|
4944
|
+
'401':
|
|
4945
|
+
description: Unauthorized
|
|
4946
|
+
content:
|
|
4947
|
+
application/json:
|
|
4948
|
+
schema:
|
|
4949
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
4950
|
+
'500':
|
|
4951
|
+
description: Internal Server Error
|
|
4952
|
+
content:
|
|
4953
|
+
application/json:
|
|
4954
|
+
schema:
|
|
4955
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4666
4956
|
tags:
|
|
4667
4957
|
- Feature Flags
|
|
4668
4958
|
/feature_flags/{id}:
|
|
@@ -4684,6 +4974,26 @@ paths:
|
|
|
4684
4974
|
application/json:
|
|
4685
4975
|
schema:
|
|
4686
4976
|
$ref: '#/components/schemas/feature_flags_response'
|
|
4977
|
+
'400':
|
|
4978
|
+
description: Bad Request
|
|
4979
|
+
'401':
|
|
4980
|
+
description: Unauthorized
|
|
4981
|
+
content:
|
|
4982
|
+
application/json:
|
|
4983
|
+
schema:
|
|
4984
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
4985
|
+
'404':
|
|
4986
|
+
description: Not Found
|
|
4987
|
+
content:
|
|
4988
|
+
application/json:
|
|
4989
|
+
schema:
|
|
4990
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
4991
|
+
'500':
|
|
4992
|
+
description: Internal Server Error
|
|
4993
|
+
content:
|
|
4994
|
+
application/json:
|
|
4995
|
+
schema:
|
|
4996
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4687
4997
|
tags:
|
|
4688
4998
|
- Feature Flags
|
|
4689
4999
|
put:
|
|
@@ -4711,6 +5021,26 @@ paths:
|
|
|
4711
5021
|
application/json:
|
|
4712
5022
|
schema:
|
|
4713
5023
|
$ref: '#/components/schemas/feature_flags_response'
|
|
5024
|
+
'400':
|
|
5025
|
+
description: Bad Request
|
|
5026
|
+
'401':
|
|
5027
|
+
description: Unauthorized
|
|
5028
|
+
content:
|
|
5029
|
+
application/json:
|
|
5030
|
+
schema:
|
|
5031
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5032
|
+
'404':
|
|
5033
|
+
description: Not Found
|
|
5034
|
+
content:
|
|
5035
|
+
application/json:
|
|
5036
|
+
schema:
|
|
5037
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5038
|
+
'500':
|
|
5039
|
+
description: Internal Server Error
|
|
5040
|
+
content:
|
|
5041
|
+
application/json:
|
|
5042
|
+
schema:
|
|
5043
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4714
5044
|
tags:
|
|
4715
5045
|
- Feature Flags
|
|
4716
5046
|
delete:
|
|
@@ -4727,16 +5057,50 @@ paths:
|
|
|
4727
5057
|
responses:
|
|
4728
5058
|
'204':
|
|
4729
5059
|
description: No Content
|
|
4730
|
-
|
|
4731
|
-
|
|
4732
|
-
|
|
4733
|
-
|
|
4734
|
-
|
|
4735
|
-
|
|
5060
|
+
'400':
|
|
5061
|
+
description: Bad Request
|
|
5062
|
+
'401':
|
|
5063
|
+
description: Unauthorized
|
|
5064
|
+
content:
|
|
5065
|
+
application/json:
|
|
5066
|
+
schema:
|
|
5067
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5068
|
+
'404':
|
|
5069
|
+
description: Not Found
|
|
5070
|
+
content:
|
|
5071
|
+
application/json:
|
|
5072
|
+
schema:
|
|
5073
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5074
|
+
'500':
|
|
5075
|
+
description: Internal Server Error
|
|
5076
|
+
content:
|
|
5077
|
+
application/json:
|
|
5078
|
+
schema:
|
|
5079
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5080
|
+
tags:
|
|
5081
|
+
- Feature Flags
|
|
5082
|
+
/file_upload_notifications:
|
|
5083
|
+
get:
|
|
5084
|
+
operationId: get_file_upload_notifications
|
|
5085
|
+
summary: Get File Upload Notifications
|
|
4736
5086
|
description: List file upload notifications for the current user.
|
|
4737
5087
|
responses:
|
|
4738
5088
|
'200':
|
|
4739
5089
|
description: OK
|
|
5090
|
+
'400':
|
|
5091
|
+
description: Bad Request
|
|
5092
|
+
'401':
|
|
5093
|
+
description: Unauthorized
|
|
5094
|
+
content:
|
|
5095
|
+
application/json:
|
|
5096
|
+
schema:
|
|
5097
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5098
|
+
'500':
|
|
5099
|
+
description: Internal Server Error
|
|
5100
|
+
content:
|
|
5101
|
+
application/json:
|
|
5102
|
+
schema:
|
|
5103
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4740
5104
|
tags:
|
|
4741
5105
|
- File Upload Notifications
|
|
4742
5106
|
post:
|
|
@@ -4753,6 +5117,20 @@ paths:
|
|
|
4753
5117
|
responses:
|
|
4754
5118
|
'201':
|
|
4755
5119
|
description: Created
|
|
5120
|
+
'400':
|
|
5121
|
+
description: Bad Request
|
|
5122
|
+
'401':
|
|
5123
|
+
description: Unauthorized
|
|
5124
|
+
content:
|
|
5125
|
+
application/json:
|
|
5126
|
+
schema:
|
|
5127
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5128
|
+
'500':
|
|
5129
|
+
description: Internal Server Error
|
|
5130
|
+
content:
|
|
5131
|
+
application/json:
|
|
5132
|
+
schema:
|
|
5133
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4756
5134
|
tags:
|
|
4757
5135
|
- File Upload Notifications
|
|
4758
5136
|
/file_upload_notifications/{id}:
|
|
@@ -4779,6 +5157,26 @@ paths:
|
|
|
4779
5157
|
description: OK
|
|
4780
5158
|
'204':
|
|
4781
5159
|
description: No Content
|
|
5160
|
+
'400':
|
|
5161
|
+
description: Bad Request
|
|
5162
|
+
'401':
|
|
5163
|
+
description: Unauthorized
|
|
5164
|
+
content:
|
|
5165
|
+
application/json:
|
|
5166
|
+
schema:
|
|
5167
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5168
|
+
'404':
|
|
5169
|
+
description: Not Found
|
|
5170
|
+
content:
|
|
5171
|
+
application/json:
|
|
5172
|
+
schema:
|
|
5173
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5174
|
+
'500':
|
|
5175
|
+
description: Internal Server Error
|
|
5176
|
+
content:
|
|
5177
|
+
application/json:
|
|
5178
|
+
schema:
|
|
5179
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4782
5180
|
tags:
|
|
4783
5181
|
- File Upload Notifications
|
|
4784
5182
|
delete:
|
|
@@ -4795,6 +5193,26 @@ paths:
|
|
|
4795
5193
|
responses:
|
|
4796
5194
|
'204':
|
|
4797
5195
|
description: No Content
|
|
5196
|
+
'400':
|
|
5197
|
+
description: Bad Request
|
|
5198
|
+
'401':
|
|
5199
|
+
description: Unauthorized
|
|
5200
|
+
content:
|
|
5201
|
+
application/json:
|
|
5202
|
+
schema:
|
|
5203
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5204
|
+
'404':
|
|
5205
|
+
description: Not Found
|
|
5206
|
+
content:
|
|
5207
|
+
application/json:
|
|
5208
|
+
schema:
|
|
5209
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5210
|
+
'500':
|
|
5211
|
+
description: Internal Server Error
|
|
5212
|
+
content:
|
|
5213
|
+
application/json:
|
|
5214
|
+
schema:
|
|
5215
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4798
5216
|
tags:
|
|
4799
5217
|
- File Upload Notifications
|
|
4800
5218
|
/file_upload_notifications/get_toggle_state:
|
|
@@ -4817,6 +5235,26 @@ paths:
|
|
|
4817
5235
|
responses:
|
|
4818
5236
|
'200':
|
|
4819
5237
|
description: OK
|
|
5238
|
+
'400':
|
|
5239
|
+
description: Bad Request
|
|
5240
|
+
'401':
|
|
5241
|
+
description: Unauthorized
|
|
5242
|
+
content:
|
|
5243
|
+
application/json:
|
|
5244
|
+
schema:
|
|
5245
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5246
|
+
'403':
|
|
5247
|
+
description: Forbidden. Also returned when neither `node_id` nor `file_id` is provided.
|
|
5248
|
+
content:
|
|
5249
|
+
application/json:
|
|
5250
|
+
schema:
|
|
5251
|
+
$ref: '#/components/schemas/ForbiddenError'
|
|
5252
|
+
'500':
|
|
5253
|
+
description: Internal Server Error
|
|
5254
|
+
content:
|
|
5255
|
+
application/json:
|
|
5256
|
+
schema:
|
|
5257
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4820
5258
|
tags:
|
|
4821
5259
|
- File Upload Notifications
|
|
4822
5260
|
/operations:
|
|
@@ -4876,6 +5314,20 @@ paths:
|
|
|
4876
5314
|
type: array
|
|
4877
5315
|
items:
|
|
4878
5316
|
$ref: '#/components/schemas/operations_response'
|
|
5317
|
+
'400':
|
|
5318
|
+
description: Bad Request
|
|
5319
|
+
'401':
|
|
5320
|
+
description: Unauthorized
|
|
5321
|
+
content:
|
|
5322
|
+
application/json:
|
|
5323
|
+
schema:
|
|
5324
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5325
|
+
'500':
|
|
5326
|
+
description: Internal Server Error
|
|
5327
|
+
content:
|
|
5328
|
+
application/json:
|
|
5329
|
+
schema:
|
|
5330
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4879
5331
|
tags:
|
|
4880
5332
|
- Operations
|
|
4881
5333
|
/operations/{id}:
|
|
@@ -4897,6 +5349,26 @@ paths:
|
|
|
4897
5349
|
application/json:
|
|
4898
5350
|
schema:
|
|
4899
5351
|
$ref: '#/components/schemas/operations_response'
|
|
5352
|
+
'400':
|
|
5353
|
+
description: Bad Request
|
|
5354
|
+
'401':
|
|
5355
|
+
description: Unauthorized
|
|
5356
|
+
content:
|
|
5357
|
+
application/json:
|
|
5358
|
+
schema:
|
|
5359
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5360
|
+
'404':
|
|
5361
|
+
description: Not Found
|
|
5362
|
+
content:
|
|
5363
|
+
application/json:
|
|
5364
|
+
schema:
|
|
5365
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5366
|
+
'500':
|
|
5367
|
+
description: Internal Server Error
|
|
5368
|
+
content:
|
|
5369
|
+
application/json:
|
|
5370
|
+
schema:
|
|
5371
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4900
5372
|
tags:
|
|
4901
5373
|
- Operations
|
|
4902
5374
|
put:
|
|
@@ -4942,6 +5414,20 @@ paths:
|
|
|
4942
5414
|
application/json:
|
|
4943
5415
|
schema:
|
|
4944
5416
|
$ref: '#/components/schemas/organizations_response'
|
|
5417
|
+
'400':
|
|
5418
|
+
description: Bad Request
|
|
5419
|
+
'401':
|
|
5420
|
+
description: Unauthorized
|
|
5421
|
+
content:
|
|
5422
|
+
application/json:
|
|
5423
|
+
schema:
|
|
5424
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5425
|
+
'500':
|
|
5426
|
+
description: Internal Server Error
|
|
5427
|
+
content:
|
|
5428
|
+
application/json:
|
|
5429
|
+
schema:
|
|
5430
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4945
5431
|
tags:
|
|
4946
5432
|
- Organizations
|
|
4947
5433
|
put:
|
|
@@ -4963,6 +5449,20 @@ paths:
|
|
|
4963
5449
|
$ref: '#/components/schemas/organizations_response'
|
|
4964
5450
|
'204':
|
|
4965
5451
|
description: No Content
|
|
5452
|
+
'400':
|
|
5453
|
+
description: Bad Request
|
|
5454
|
+
'401':
|
|
5455
|
+
description: Unauthorized
|
|
5456
|
+
content:
|
|
5457
|
+
application/json:
|
|
5458
|
+
schema:
|
|
5459
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5460
|
+
'500':
|
|
5461
|
+
description: Internal Server Error
|
|
5462
|
+
content:
|
|
5463
|
+
application/json:
|
|
5464
|
+
schema:
|
|
5465
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4966
5466
|
tags:
|
|
4967
5467
|
- Organizations
|
|
4968
5468
|
/packages_count:
|
|
@@ -4979,6 +5479,20 @@ paths:
|
|
|
4979
5479
|
type: integer
|
|
4980
5480
|
description: Total number of packages visible to the current caller.
|
|
4981
5481
|
example: 6982
|
|
5482
|
+
'400':
|
|
5483
|
+
description: Bad Request
|
|
5484
|
+
'401':
|
|
5485
|
+
description: Unauthorized
|
|
5486
|
+
content:
|
|
5487
|
+
application/json:
|
|
5488
|
+
schema:
|
|
5489
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5490
|
+
'500':
|
|
5491
|
+
description: Internal Server Error
|
|
5492
|
+
content:
|
|
5493
|
+
application/json:
|
|
5494
|
+
schema:
|
|
5495
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
4982
5496
|
tags:
|
|
4983
5497
|
- Packages
|
|
4984
5498
|
/self:
|
|
@@ -5000,13 +5514,73 @@ paths:
|
|
|
5000
5514
|
application/json:
|
|
5001
5515
|
schema:
|
|
5002
5516
|
$ref: '#/components/schemas/users_response'
|
|
5517
|
+
'400':
|
|
5518
|
+
description: Bad Request
|
|
5519
|
+
'401':
|
|
5520
|
+
description: Unauthorized
|
|
5521
|
+
content:
|
|
5522
|
+
application/json:
|
|
5523
|
+
schema:
|
|
5524
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5525
|
+
'500':
|
|
5526
|
+
description: Internal Server Error
|
|
5527
|
+
content:
|
|
5528
|
+
application/json:
|
|
5529
|
+
schema:
|
|
5530
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5003
5531
|
tags:
|
|
5004
5532
|
- Self
|
|
5005
5533
|
/short_links:
|
|
5006
5534
|
get:
|
|
5007
5535
|
operationId: get_short_links
|
|
5008
5536
|
summary: Get Short Links
|
|
5009
|
-
description: List short links visible to the current caller.
|
|
5537
|
+
description: List short links of a shared resource (shared folder or shared inbox) visible to the current caller.
|
|
5538
|
+
parameters:
|
|
5539
|
+
- name: json_query
|
|
5540
|
+
in: query
|
|
5541
|
+
description: >-
|
|
5542
|
+
JSON-encoded shared resource of the links. Public link: `{"url_token_data":{"data":<resource>,"purpose":<token purpose>}}`
|
|
5543
|
+
(see `short_link_url_token_data`). Private link: `{"node_id":..,"file_id":..,"workspace_id":..}`
|
|
5544
|
+
schema:
|
|
5545
|
+
type: string
|
|
5546
|
+
- name: purpose
|
|
5547
|
+
in: query
|
|
5548
|
+
description: Purpose of the short links (see `short_link_purpose`)
|
|
5549
|
+
schema:
|
|
5550
|
+
type: string
|
|
5551
|
+
enum:
|
|
5552
|
+
- token_auth_redirection
|
|
5553
|
+
- shared_folder_auth_link
|
|
5554
|
+
- name: edit_access
|
|
5555
|
+
in: query
|
|
5556
|
+
description: Check edit access on the shared folder given by `node_id` and `file_id` in `json_query` (shared folder links only, rejected for shared inbox links)
|
|
5557
|
+
schema:
|
|
5558
|
+
type: boolean
|
|
5559
|
+
- name: admin
|
|
5560
|
+
in: query
|
|
5561
|
+
description: Act as organization administrator (sent by the web UI for an administrator)
|
|
5562
|
+
schema:
|
|
5563
|
+
type: boolean
|
|
5564
|
+
- name: embed
|
|
5565
|
+
in: query
|
|
5566
|
+
description: Embed related resources (e.g. `updated_by_user`)
|
|
5567
|
+
schema:
|
|
5568
|
+
type: string
|
|
5569
|
+
- name: sort
|
|
5570
|
+
in: query
|
|
5571
|
+
description: Sort order (e.g. `-created_at`)
|
|
5572
|
+
schema:
|
|
5573
|
+
type: string
|
|
5574
|
+
- name: page
|
|
5575
|
+
in: query
|
|
5576
|
+
description: Page number
|
|
5577
|
+
schema:
|
|
5578
|
+
type: integer
|
|
5579
|
+
- name: per_page
|
|
5580
|
+
in: query
|
|
5581
|
+
description: Number of items per page
|
|
5582
|
+
schema:
|
|
5583
|
+
type: integer
|
|
5010
5584
|
responses:
|
|
5011
5585
|
'200':
|
|
5012
5586
|
description: OK
|
|
@@ -5016,19 +5590,38 @@ paths:
|
|
|
5016
5590
|
type: array
|
|
5017
5591
|
items:
|
|
5018
5592
|
$ref: '#/components/schemas/short_links_response'
|
|
5593
|
+
'400':
|
|
5594
|
+
description: Bad Request
|
|
5595
|
+
'401':
|
|
5596
|
+
description: Unauthorized
|
|
5597
|
+
content:
|
|
5598
|
+
application/json:
|
|
5599
|
+
schema:
|
|
5600
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5601
|
+
'500':
|
|
5602
|
+
description: Internal Server Error
|
|
5603
|
+
content:
|
|
5604
|
+
application/json:
|
|
5605
|
+
schema:
|
|
5606
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5019
5607
|
tags:
|
|
5020
5608
|
- Short Links
|
|
5021
5609
|
post:
|
|
5022
5610
|
operationId: add_short_link
|
|
5023
5611
|
summary: Create a Short Link
|
|
5024
|
-
description: Create a short link.
|
|
5612
|
+
description: Create a short link to a shared folder or a shared inbox.
|
|
5613
|
+
parameters:
|
|
5614
|
+
- name: admin
|
|
5615
|
+
in: query
|
|
5616
|
+
description: Act as organization administrator (sent by the web UI for an administrator)
|
|
5617
|
+
schema:
|
|
5618
|
+
type: boolean
|
|
5025
5619
|
requestBody:
|
|
5026
5620
|
required: true
|
|
5027
5621
|
content:
|
|
5028
5622
|
application/json:
|
|
5029
5623
|
schema:
|
|
5030
|
-
|
|
5031
|
-
additionalProperties: true
|
|
5624
|
+
$ref: '#/components/schemas/short_link_create_params'
|
|
5032
5625
|
responses:
|
|
5033
5626
|
'201':
|
|
5034
5627
|
description: Created
|
|
@@ -5036,13 +5629,27 @@ paths:
|
|
|
5036
5629
|
application/json:
|
|
5037
5630
|
schema:
|
|
5038
5631
|
$ref: '#/components/schemas/short_links_response'
|
|
5632
|
+
'400':
|
|
5633
|
+
description: Bad Request
|
|
5634
|
+
'401':
|
|
5635
|
+
description: Unauthorized
|
|
5636
|
+
content:
|
|
5637
|
+
application/json:
|
|
5638
|
+
schema:
|
|
5639
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5640
|
+
'500':
|
|
5641
|
+
description: Internal Server Error
|
|
5642
|
+
content:
|
|
5643
|
+
application/json:
|
|
5644
|
+
schema:
|
|
5645
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5039
5646
|
tags:
|
|
5040
5647
|
- Short Links
|
|
5041
5648
|
/short_links/{id}:
|
|
5042
5649
|
put:
|
|
5043
5650
|
operationId: update_short_link
|
|
5044
5651
|
summary: Update a Short Link
|
|
5045
|
-
description: Update a short link.
|
|
5652
|
+
description: Update a short link (expiration, password).
|
|
5046
5653
|
parameters:
|
|
5047
5654
|
- name: id
|
|
5048
5655
|
in: path
|
|
@@ -5050,13 +5657,17 @@ paths:
|
|
|
5050
5657
|
schema:
|
|
5051
5658
|
type: string
|
|
5052
5659
|
description: Unique identifier of the resource.
|
|
5660
|
+
- name: admin
|
|
5661
|
+
in: query
|
|
5662
|
+
description: Act as organization administrator (sent by the web UI for an administrator)
|
|
5663
|
+
schema:
|
|
5664
|
+
type: boolean
|
|
5053
5665
|
requestBody:
|
|
5054
5666
|
required: true
|
|
5055
5667
|
content:
|
|
5056
5668
|
application/json:
|
|
5057
5669
|
schema:
|
|
5058
|
-
|
|
5059
|
-
additionalProperties: true
|
|
5670
|
+
$ref: '#/components/schemas/short_link_update_params'
|
|
5060
5671
|
responses:
|
|
5061
5672
|
'200':
|
|
5062
5673
|
description: OK
|
|
@@ -5064,6 +5675,26 @@ paths:
|
|
|
5064
5675
|
application/json:
|
|
5065
5676
|
schema:
|
|
5066
5677
|
$ref: '#/components/schemas/short_links_response'
|
|
5678
|
+
'400':
|
|
5679
|
+
description: Bad Request
|
|
5680
|
+
'401':
|
|
5681
|
+
description: Unauthorized
|
|
5682
|
+
content:
|
|
5683
|
+
application/json:
|
|
5684
|
+
schema:
|
|
5685
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5686
|
+
'404':
|
|
5687
|
+
description: Not Found
|
|
5688
|
+
content:
|
|
5689
|
+
application/json:
|
|
5690
|
+
schema:
|
|
5691
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5692
|
+
'500':
|
|
5693
|
+
description: Internal Server Error
|
|
5694
|
+
content:
|
|
5695
|
+
application/json:
|
|
5696
|
+
schema:
|
|
5697
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5067
5698
|
tags:
|
|
5068
5699
|
- Short Links
|
|
5069
5700
|
delete:
|
|
@@ -5077,9 +5708,44 @@ paths:
|
|
|
5077
5708
|
schema:
|
|
5078
5709
|
type: string
|
|
5079
5710
|
description: Unique identifier of the resource.
|
|
5711
|
+
- name: json_query
|
|
5712
|
+
in: query
|
|
5713
|
+
description: JSON-encoded shared folder of the link, with `edit_access` (shared folder links only)
|
|
5714
|
+
schema:
|
|
5715
|
+
type: string
|
|
5716
|
+
- name: edit_access
|
|
5717
|
+
in: query
|
|
5718
|
+
description: Check edit access on the shared folder given by `node_id` and `file_id` in `json_query` (shared folder links only, rejected for shared inbox links)
|
|
5719
|
+
schema:
|
|
5720
|
+
type: boolean
|
|
5721
|
+
- name: admin
|
|
5722
|
+
in: query
|
|
5723
|
+
description: Act as organization administrator (sent by the web UI for an administrator)
|
|
5724
|
+
schema:
|
|
5725
|
+
type: boolean
|
|
5080
5726
|
responses:
|
|
5081
5727
|
'204':
|
|
5082
5728
|
description: No Content
|
|
5729
|
+
'400':
|
|
5730
|
+
description: Bad Request
|
|
5731
|
+
'401':
|
|
5732
|
+
description: Unauthorized
|
|
5733
|
+
content:
|
|
5734
|
+
application/json:
|
|
5735
|
+
schema:
|
|
5736
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5737
|
+
'404':
|
|
5738
|
+
description: Not Found
|
|
5739
|
+
content:
|
|
5740
|
+
application/json:
|
|
5741
|
+
schema:
|
|
5742
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5743
|
+
'500':
|
|
5744
|
+
description: Internal Server Error
|
|
5745
|
+
content:
|
|
5746
|
+
application/json:
|
|
5747
|
+
schema:
|
|
5748
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5083
5749
|
tags:
|
|
5084
5750
|
- Short Links
|
|
5085
5751
|
/tier_restrictions:
|
|
@@ -5154,6 +5820,20 @@ paths:
|
|
|
5154
5820
|
application/json:
|
|
5155
5821
|
schema:
|
|
5156
5822
|
$ref: '#/components/schemas/transfer_report_response'
|
|
5823
|
+
'400':
|
|
5824
|
+
description: Bad Request
|
|
5825
|
+
'401':
|
|
5826
|
+
description: Unauthorized
|
|
5827
|
+
content:
|
|
5828
|
+
application/json:
|
|
5829
|
+
schema:
|
|
5830
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5831
|
+
'500':
|
|
5832
|
+
description: Internal Server Error
|
|
5833
|
+
content:
|
|
5834
|
+
application/json:
|
|
5835
|
+
schema:
|
|
5836
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5157
5837
|
tags:
|
|
5158
5838
|
- Transfer Analytics
|
|
5159
5839
|
/transfers:
|
|
@@ -5170,6 +5850,20 @@ paths:
|
|
|
5170
5850
|
type: array
|
|
5171
5851
|
items:
|
|
5172
5852
|
$ref: '#/components/schemas/transfers_response'
|
|
5853
|
+
'400':
|
|
5854
|
+
description: Bad Request
|
|
5855
|
+
'401':
|
|
5856
|
+
description: Unauthorized
|
|
5857
|
+
content:
|
|
5858
|
+
application/json:
|
|
5859
|
+
schema:
|
|
5860
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5861
|
+
'500':
|
|
5862
|
+
description: Internal Server Error
|
|
5863
|
+
content:
|
|
5864
|
+
application/json:
|
|
5865
|
+
schema:
|
|
5866
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5173
5867
|
tags:
|
|
5174
5868
|
- Transfers
|
|
5175
5869
|
delete:
|
|
@@ -5179,6 +5873,20 @@ paths:
|
|
|
5179
5873
|
responses:
|
|
5180
5874
|
'204':
|
|
5181
5875
|
description: No Content
|
|
5876
|
+
'400':
|
|
5877
|
+
description: Bad Request
|
|
5878
|
+
'401':
|
|
5879
|
+
description: Unauthorized
|
|
5880
|
+
content:
|
|
5881
|
+
application/json:
|
|
5882
|
+
schema:
|
|
5883
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5884
|
+
'500':
|
|
5885
|
+
description: Internal Server Error
|
|
5886
|
+
content:
|
|
5887
|
+
application/json:
|
|
5888
|
+
schema:
|
|
5889
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5182
5890
|
tags:
|
|
5183
5891
|
- Transfers
|
|
5184
5892
|
/transfers/{id}:
|
|
@@ -5200,6 +5908,26 @@ paths:
|
|
|
5200
5908
|
application/json:
|
|
5201
5909
|
schema:
|
|
5202
5910
|
$ref: '#/components/schemas/transfers_response'
|
|
5911
|
+
'400':
|
|
5912
|
+
description: Bad Request
|
|
5913
|
+
'401':
|
|
5914
|
+
description: Unauthorized
|
|
5915
|
+
content:
|
|
5916
|
+
application/json:
|
|
5917
|
+
schema:
|
|
5918
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5919
|
+
'404':
|
|
5920
|
+
description: Not Found
|
|
5921
|
+
content:
|
|
5922
|
+
application/json:
|
|
5923
|
+
schema:
|
|
5924
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5925
|
+
'500':
|
|
5926
|
+
description: Internal Server Error
|
|
5927
|
+
content:
|
|
5928
|
+
application/json:
|
|
5929
|
+
schema:
|
|
5930
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5203
5931
|
tags:
|
|
5204
5932
|
- Transfers
|
|
5205
5933
|
delete:
|
|
@@ -5216,6 +5944,26 @@ paths:
|
|
|
5216
5944
|
responses:
|
|
5217
5945
|
'204':
|
|
5218
5946
|
description: No Content
|
|
5947
|
+
'400':
|
|
5948
|
+
description: Bad Request
|
|
5949
|
+
'401':
|
|
5950
|
+
description: Unauthorized
|
|
5951
|
+
content:
|
|
5952
|
+
application/json:
|
|
5953
|
+
schema:
|
|
5954
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5955
|
+
'404':
|
|
5956
|
+
description: Not Found
|
|
5957
|
+
content:
|
|
5958
|
+
application/json:
|
|
5959
|
+
schema:
|
|
5960
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
5961
|
+
'500':
|
|
5962
|
+
description: Internal Server Error
|
|
5963
|
+
content:
|
|
5964
|
+
application/json:
|
|
5965
|
+
schema:
|
|
5966
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5219
5967
|
tags:
|
|
5220
5968
|
- Transfers
|
|
5221
5969
|
/workspace_collaborators:
|
|
@@ -5226,6 +5974,20 @@ paths:
|
|
|
5226
5974
|
responses:
|
|
5227
5975
|
'200':
|
|
5228
5976
|
description: OK
|
|
5977
|
+
'400':
|
|
5978
|
+
description: Bad Request
|
|
5979
|
+
'401':
|
|
5980
|
+
description: Unauthorized
|
|
5981
|
+
content:
|
|
5982
|
+
application/json:
|
|
5983
|
+
schema:
|
|
5984
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
5985
|
+
'500':
|
|
5986
|
+
description: Internal Server Error
|
|
5987
|
+
content:
|
|
5988
|
+
application/json:
|
|
5989
|
+
schema:
|
|
5990
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5229
5991
|
tags:
|
|
5230
5992
|
- Workspace Collaborators
|
|
5231
5993
|
post:
|
|
@@ -5242,6 +6004,20 @@ paths:
|
|
|
5242
6004
|
responses:
|
|
5243
6005
|
'201':
|
|
5244
6006
|
description: Created
|
|
6007
|
+
'400':
|
|
6008
|
+
description: Bad Request
|
|
6009
|
+
'401':
|
|
6010
|
+
description: Unauthorized
|
|
6011
|
+
content:
|
|
6012
|
+
application/json:
|
|
6013
|
+
schema:
|
|
6014
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
6015
|
+
'500':
|
|
6016
|
+
description: Internal Server Error
|
|
6017
|
+
content:
|
|
6018
|
+
application/json:
|
|
6019
|
+
schema:
|
|
6020
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5245
6021
|
tags:
|
|
5246
6022
|
- Workspace Collaborators
|
|
5247
6023
|
/workspace_collaborators/{id}:
|
|
@@ -5259,6 +6035,26 @@ paths:
|
|
|
5259
6035
|
responses:
|
|
5260
6036
|
'200':
|
|
5261
6037
|
description: OK
|
|
6038
|
+
'400':
|
|
6039
|
+
description: Bad Request
|
|
6040
|
+
'401':
|
|
6041
|
+
description: Unauthorized
|
|
6042
|
+
content:
|
|
6043
|
+
application/json:
|
|
6044
|
+
schema:
|
|
6045
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
6046
|
+
'404':
|
|
6047
|
+
description: Not Found
|
|
6048
|
+
content:
|
|
6049
|
+
application/json:
|
|
6050
|
+
schema:
|
|
6051
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
6052
|
+
'500':
|
|
6053
|
+
description: Internal Server Error
|
|
6054
|
+
content:
|
|
6055
|
+
application/json:
|
|
6056
|
+
schema:
|
|
6057
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5262
6058
|
tags:
|
|
5263
6059
|
- Workspace Collaborators
|
|
5264
6060
|
delete:
|
|
@@ -5275,6 +6071,26 @@ paths:
|
|
|
5275
6071
|
responses:
|
|
5276
6072
|
'204':
|
|
5277
6073
|
description: No Content
|
|
6074
|
+
'400':
|
|
6075
|
+
description: Bad Request
|
|
6076
|
+
'401':
|
|
6077
|
+
description: Unauthorized
|
|
6078
|
+
content:
|
|
6079
|
+
application/json:
|
|
6080
|
+
schema:
|
|
6081
|
+
$ref: '#/components/schemas/UnauthorizedError'
|
|
6082
|
+
'404':
|
|
6083
|
+
description: Not Found
|
|
6084
|
+
content:
|
|
6085
|
+
application/json:
|
|
6086
|
+
schema:
|
|
6087
|
+
$ref: '#/components/schemas/NotFoundError'
|
|
6088
|
+
'500':
|
|
6089
|
+
description: Internal Server Error
|
|
6090
|
+
content:
|
|
6091
|
+
application/json:
|
|
6092
|
+
schema:
|
|
6093
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5278
6094
|
tags:
|
|
5279
6095
|
- Workspace Collaborators
|
|
5280
6096
|
/contacts:
|
|
@@ -5401,6 +6217,10 @@ paths:
|
|
|
5401
6217
|
$ref: '#/components/schemas/NotFoundError'
|
|
5402
6218
|
'500':
|
|
5403
6219
|
description: Internal Server Error
|
|
6220
|
+
content:
|
|
6221
|
+
application/json:
|
|
6222
|
+
schema:
|
|
6223
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5404
6224
|
tags:
|
|
5405
6225
|
- Contacts
|
|
5406
6226
|
post:
|
|
@@ -5477,6 +6297,10 @@ paths:
|
|
|
5477
6297
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
5478
6298
|
'403':
|
|
5479
6299
|
description: Forbidden
|
|
6300
|
+
content:
|
|
6301
|
+
application/json:
|
|
6302
|
+
schema:
|
|
6303
|
+
$ref: '#/components/schemas/ForbiddenError'
|
|
5480
6304
|
'404':
|
|
5481
6305
|
description: Not Found
|
|
5482
6306
|
content:
|
|
@@ -5491,6 +6315,10 @@ paths:
|
|
|
5491
6315
|
$ref: '#/components/schemas/ValidationError'
|
|
5492
6316
|
'500':
|
|
5493
6317
|
description: Internal Server Error
|
|
6318
|
+
content:
|
|
6319
|
+
application/json:
|
|
6320
|
+
schema:
|
|
6321
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5494
6322
|
tags:
|
|
5495
6323
|
- Contacts
|
|
5496
6324
|
- Contacts
|
|
@@ -5516,6 +6344,10 @@ paths:
|
|
|
5516
6344
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
5517
6345
|
'500':
|
|
5518
6346
|
description: Internal Server Error
|
|
6347
|
+
content:
|
|
6348
|
+
application/json:
|
|
6349
|
+
schema:
|
|
6350
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5519
6351
|
tags:
|
|
5520
6352
|
- Configuration Policies
|
|
5521
6353
|
post:
|
|
@@ -5547,6 +6379,10 @@ paths:
|
|
|
5547
6379
|
description: Unprocessable Entity
|
|
5548
6380
|
'500':
|
|
5549
6381
|
description: Internal Server Error
|
|
6382
|
+
content:
|
|
6383
|
+
application/json:
|
|
6384
|
+
schema:
|
|
6385
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5550
6386
|
tags:
|
|
5551
6387
|
- Configuration Policies
|
|
5552
6388
|
/configuration_policies/{id}:
|
|
@@ -5578,6 +6414,10 @@ paths:
|
|
|
5578
6414
|
$ref: '#/components/schemas/NotFoundError'
|
|
5579
6415
|
'500':
|
|
5580
6416
|
description: Internal Server Error
|
|
6417
|
+
content:
|
|
6418
|
+
application/json:
|
|
6419
|
+
schema:
|
|
6420
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5581
6421
|
tags:
|
|
5582
6422
|
- Configuration Policies
|
|
5583
6423
|
get:
|
|
@@ -5612,6 +6452,10 @@ paths:
|
|
|
5612
6452
|
$ref: '#/components/schemas/NotFoundError'
|
|
5613
6453
|
'500':
|
|
5614
6454
|
description: Internal Server Error
|
|
6455
|
+
content:
|
|
6456
|
+
application/json:
|
|
6457
|
+
schema:
|
|
6458
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5615
6459
|
tags:
|
|
5616
6460
|
- Configuration Policies
|
|
5617
6461
|
put:
|
|
@@ -5656,6 +6500,10 @@ paths:
|
|
|
5656
6500
|
description: Unprocessable Entity
|
|
5657
6501
|
'500':
|
|
5658
6502
|
description: Internal Server Error
|
|
6503
|
+
content:
|
|
6504
|
+
application/json:
|
|
6505
|
+
schema:
|
|
6506
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5659
6507
|
tags:
|
|
5660
6508
|
- Configuration Policies
|
|
5661
6509
|
/network_policies:
|
|
@@ -5680,6 +6528,10 @@ paths:
|
|
|
5680
6528
|
$ref: '#/components/schemas/UnauthorizedError'
|
|
5681
6529
|
'500':
|
|
5682
6530
|
description: Internal Server Error
|
|
6531
|
+
content:
|
|
6532
|
+
application/json:
|
|
6533
|
+
schema:
|
|
6534
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5683
6535
|
tags:
|
|
5684
6536
|
- Network Policies
|
|
5685
6537
|
post:
|
|
@@ -5711,6 +6563,10 @@ paths:
|
|
|
5711
6563
|
description: Unprocessable Entity
|
|
5712
6564
|
'500':
|
|
5713
6565
|
description: Internal Server Error
|
|
6566
|
+
content:
|
|
6567
|
+
application/json:
|
|
6568
|
+
schema:
|
|
6569
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5714
6570
|
tags:
|
|
5715
6571
|
- Network Policies
|
|
5716
6572
|
/network_policies/{id}:
|
|
@@ -5742,6 +6598,10 @@ paths:
|
|
|
5742
6598
|
$ref: '#/components/schemas/NotFoundError'
|
|
5743
6599
|
'500':
|
|
5744
6600
|
description: Internal Server Error
|
|
6601
|
+
content:
|
|
6602
|
+
application/json:
|
|
6603
|
+
schema:
|
|
6604
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5745
6605
|
tags:
|
|
5746
6606
|
- Network Policies
|
|
5747
6607
|
get:
|
|
@@ -5776,6 +6636,10 @@ paths:
|
|
|
5776
6636
|
$ref: '#/components/schemas/NotFoundError'
|
|
5777
6637
|
'500':
|
|
5778
6638
|
description: Internal Server Error
|
|
6639
|
+
content:
|
|
6640
|
+
application/json:
|
|
6641
|
+
schema:
|
|
6642
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5779
6643
|
tags:
|
|
5780
6644
|
- Network Policies
|
|
5781
6645
|
put:
|
|
@@ -5820,6 +6684,10 @@ paths:
|
|
|
5820
6684
|
description: Unprocessable Entity
|
|
5821
6685
|
'500':
|
|
5822
6686
|
description: Internal Server Error
|
|
6687
|
+
content:
|
|
6688
|
+
application/json:
|
|
6689
|
+
schema:
|
|
6690
|
+
$ref: '#/components/schemas/InternalServerError'
|
|
5823
6691
|
tags:
|
|
5824
6692
|
- Network Policies
|
|
5825
6693
|
components:
|
|
@@ -5862,8 +6730,9 @@ components:
|
|
|
5862
6730
|
description: Human-readable error description providing additional context about the error
|
|
5863
6731
|
example: invalid URL token
|
|
5864
6732
|
state:
|
|
5865
|
-
type:
|
|
5866
|
-
|
|
6733
|
+
type:
|
|
6734
|
+
- string
|
|
6735
|
+
- 'null'
|
|
5867
6736
|
description: >-
|
|
5868
6737
|
State parameter from the authorization request, if present. Used to maintain state between request and
|
|
5869
6738
|
callback.
|
|
@@ -5949,6 +6818,62 @@ components:
|
|
|
5949
6818
|
code: not_found
|
|
5950
6819
|
message: The resource you were looking for does not exist
|
|
5951
6820
|
request_id: 58825f7f-42bb-4f4e-90bc-a6deb9b999db
|
|
6821
|
+
ForbiddenError:
|
|
6822
|
+
type: object
|
|
6823
|
+
description: |
|
|
6824
|
+
Standard error response for 403 Forbidden.
|
|
6825
|
+
properties:
|
|
6826
|
+
code:
|
|
6827
|
+
type: string
|
|
6828
|
+
description: Error code identifying the type of error
|
|
6829
|
+
enum:
|
|
6830
|
+
- forbidden
|
|
6831
|
+
example: forbidden
|
|
6832
|
+
message:
|
|
6833
|
+
type: string
|
|
6834
|
+
description: Human-readable error message
|
|
6835
|
+
example: "You are not authorized to perform the requested action"
|
|
6836
|
+
request_id:
|
|
6837
|
+
type: string
|
|
6838
|
+
format: uuid
|
|
6839
|
+
description: Unique identifier for the request, useful for debugging and support
|
|
6840
|
+
example: 4387db5b-d84b-43f8-b5c1-0d9d878714d6
|
|
6841
|
+
required:
|
|
6842
|
+
- code
|
|
6843
|
+
- message
|
|
6844
|
+
- request_id
|
|
6845
|
+
example:
|
|
6846
|
+
code: forbidden
|
|
6847
|
+
message: "You are not authorized to perform the requested action"
|
|
6848
|
+
request_id: 4387db5b-d84b-43f8-b5c1-0d9d878714d6
|
|
6849
|
+
InternalServerError:
|
|
6850
|
+
type: object
|
|
6851
|
+
description: |
|
|
6852
|
+
Standard error response for 500 Internal Server Error.
|
|
6853
|
+
properties:
|
|
6854
|
+
code:
|
|
6855
|
+
type: string
|
|
6856
|
+
description: Error code identifying the type of error
|
|
6857
|
+
enum:
|
|
6858
|
+
- internal_server_error
|
|
6859
|
+
example: internal_server_error
|
|
6860
|
+
message:
|
|
6861
|
+
type: string
|
|
6862
|
+
description: Human-readable error message
|
|
6863
|
+
example: "We're sorry, but something went wrong. We've been notified about this issue and we'll take a look at it shortly."
|
|
6864
|
+
request_id:
|
|
6865
|
+
type: string
|
|
6866
|
+
format: uuid
|
|
6867
|
+
description: Unique identifier for the request, useful for debugging and support
|
|
6868
|
+
example: 17a835e7-17d0-40f9-8ac3-ff23a45d461e
|
|
6869
|
+
required:
|
|
6870
|
+
- code
|
|
6871
|
+
- message
|
|
6872
|
+
- request_id
|
|
6873
|
+
example:
|
|
6874
|
+
code: internal_server_error
|
|
6875
|
+
message: "We're sorry, but something went wrong. We've been notified about this issue and we'll take a look at it shortly."
|
|
6876
|
+
request_id: 17a835e7-17d0-40f9-8ac3-ff23a45d461e
|
|
5952
6877
|
ClientRegistrationToken:
|
|
5953
6878
|
type: object
|
|
5954
6879
|
description: Client registration token with metadata
|
|
@@ -6509,7 +7434,7 @@ components:
|
|
|
6509
7434
|
app_name:
|
|
6510
7435
|
example: Files
|
|
6511
7436
|
app_type:
|
|
6512
|
-
|
|
7437
|
+
const: files
|
|
6513
7438
|
- $ref: '#/components/schemas/app_settings_base'
|
|
6514
7439
|
- $ref: '#/components/schemas/app_settings_files_specific'
|
|
6515
7440
|
description: Complete settings for the Files application (includes read-only fields)
|
|
@@ -6521,7 +7446,7 @@ components:
|
|
|
6521
7446
|
app_name:
|
|
6522
7447
|
example: Packages
|
|
6523
7448
|
app_type:
|
|
6524
|
-
|
|
7449
|
+
const: packages
|
|
6525
7450
|
- $ref: '#/components/schemas/app_settings_base'
|
|
6526
7451
|
- $ref: '#/components/schemas/app_settings_packages_specific'
|
|
6527
7452
|
description: Complete settings for the Packages application (includes read-only fields)
|
|
@@ -6533,7 +7458,7 @@ components:
|
|
|
6533
7458
|
app_name:
|
|
6534
7459
|
example: Activity
|
|
6535
7460
|
app_type:
|
|
6536
|
-
|
|
7461
|
+
const: activity
|
|
6537
7462
|
- $ref: '#/components/schemas/app_settings_base'
|
|
6538
7463
|
description: Complete settings for the Activity application (includes read-only fields)
|
|
6539
7464
|
app_settings_automation:
|
|
@@ -6544,7 +7469,7 @@ components:
|
|
|
6544
7469
|
app_name:
|
|
6545
7470
|
example: Automation
|
|
6546
7471
|
app_type:
|
|
6547
|
-
|
|
7472
|
+
const: automation
|
|
6548
7473
|
- $ref: '#/components/schemas/app_settings_base'
|
|
6549
7474
|
description: Complete settings for the Automation application (includes read-only fields)
|
|
6550
7475
|
app_memberships_params:
|
|
@@ -6781,6 +7706,9 @@ components:
|
|
|
6781
7706
|
- packages
|
|
6782
7707
|
- activity
|
|
6783
7708
|
- automation
|
|
7709
|
+
required:
|
|
7710
|
+
- app_name
|
|
7711
|
+
- app_type
|
|
6784
7712
|
client_access_keys_params:
|
|
6785
7713
|
type: object
|
|
6786
7714
|
properties:
|
|
@@ -7491,7 +8419,9 @@ components:
|
|
|
7491
8419
|
this parameter, draft package contents are deleted. If this parameter is null, it defaults to the workspace
|
|
7492
8420
|
setting. To set a time-based expiration policy for non-draft packages, see content_retention_duration.
|
|
7493
8421
|
Units: seconds. POST: Admin or Manager permission required. PUT: Admin or Manager permission required.
|
|
7494
|
-
type:
|
|
8422
|
+
type:
|
|
8423
|
+
- integer
|
|
8424
|
+
- 'null'
|
|
7495
8425
|
examples:
|
|
7496
8426
|
- null
|
|
7497
8427
|
dropbox_notification_recipients:
|
|
@@ -7521,14 +8451,18 @@ components:
|
|
|
7521
8451
|
description: >
|
|
7522
8452
|
Amount of time in seconds it takes for packages in this shared inbox to be deleted once their transfers
|
|
7523
8453
|
complete. If null, packages will not be deleted on a timer. Read-only.
|
|
7524
|
-
type:
|
|
8454
|
+
type:
|
|
8455
|
+
- integer
|
|
8456
|
+
- 'null'
|
|
7525
8457
|
examples:
|
|
7526
8458
|
- null
|
|
7527
8459
|
effective_delete_package_content_after_download_duration:
|
|
7528
8460
|
description: >
|
|
7529
8461
|
Amount of time in seconds it takes a package in this shared inbox to be deleted once all recipients have
|
|
7530
8462
|
downloaded the entire package. If null, packages will not be deleted on a timer. Read-only.
|
|
7531
|
-
type:
|
|
8463
|
+
type:
|
|
8464
|
+
- integer
|
|
8465
|
+
- 'null'
|
|
7532
8466
|
examples:
|
|
7533
8467
|
- null
|
|
7534
8468
|
email_notification_settings:
|
|
@@ -7915,7 +8849,9 @@ components:
|
|
|
7915
8849
|
ats_storage_type:
|
|
7916
8850
|
description: |
|
|
7917
8851
|
For Aspera Transfer Service nodes, this field defines which type of storage is used.
|
|
7918
|
-
type:
|
|
8852
|
+
type:
|
|
8853
|
+
- string
|
|
8854
|
+
- 'null'
|
|
7919
8855
|
examples:
|
|
7920
8856
|
- null
|
|
7921
8857
|
enum:
|
|
@@ -7926,6 +8862,7 @@ components:
|
|
|
7926
8862
|
- google-gcs
|
|
7927
8863
|
- ibm-s3
|
|
7928
8864
|
- softlayer_swift
|
|
8865
|
+
- null
|
|
7929
8866
|
capabilities:
|
|
7930
8867
|
type: array
|
|
7931
8868
|
items:
|
|
@@ -8002,7 +8939,9 @@ components:
|
|
|
8002
8939
|
ssh_fingerprint:
|
|
8003
8940
|
description: |
|
|
8004
8941
|
If your node has SSH capabilities, used for verifying SSH connections.
|
|
8005
|
-
type:
|
|
8942
|
+
type:
|
|
8943
|
+
- string
|
|
8944
|
+
- 'null'
|
|
8006
8945
|
examples:
|
|
8007
8946
|
- null
|
|
8008
8947
|
status:
|
|
@@ -8593,8 +9532,9 @@ components:
|
|
|
8593
9532
|
examples:
|
|
8594
9533
|
- false
|
|
8595
9534
|
bcc_recipients:
|
|
8596
|
-
type:
|
|
8597
|
-
|
|
9535
|
+
type:
|
|
9536
|
+
- array
|
|
9537
|
+
- 'null'
|
|
8598
9538
|
items:
|
|
8599
9539
|
$ref: '#/components/schemas/senders_recipients_object'
|
|
8600
9540
|
content_retention_duration:
|
|
@@ -8615,8 +9555,9 @@ components:
|
|
|
8615
9555
|
examples:
|
|
8616
9556
|
- 604800
|
|
8617
9557
|
download_notification_recipients:
|
|
8618
|
-
type:
|
|
8619
|
-
|
|
9558
|
+
type:
|
|
9559
|
+
- array
|
|
9560
|
+
- 'null'
|
|
8620
9561
|
items:
|
|
8621
9562
|
$ref: '#/components/schemas/senders_recipients_object'
|
|
8622
9563
|
draft:
|
|
@@ -8662,7 +9603,6 @@ components:
|
|
|
8662
9603
|
- false
|
|
8663
9604
|
recipients:
|
|
8664
9605
|
type: array
|
|
8665
|
-
nullable: false
|
|
8666
9606
|
items:
|
|
8667
9607
|
$ref: '#/components/schemas/senders_recipients_object'
|
|
8668
9608
|
sent:
|
|
@@ -8693,7 +9633,6 @@ components:
|
|
|
8693
9633
|
- 3
|
|
8694
9634
|
upload_notification_recipients:
|
|
8695
9635
|
type: array
|
|
8696
|
-
nullable: false
|
|
8697
9636
|
items:
|
|
8698
9637
|
$ref: '#/components/schemas/senders_recipients_object'
|
|
8699
9638
|
workspace_id:
|
|
@@ -8729,7 +9668,6 @@ components:
|
|
|
8729
9668
|
- true
|
|
8730
9669
|
bcc_recipients:
|
|
8731
9670
|
type: array
|
|
8732
|
-
nullable: false
|
|
8733
9671
|
items:
|
|
8734
9672
|
$ref: '#/components/schemas/senders_recipients_object'
|
|
8735
9673
|
bytes_transferred:
|
|
@@ -8765,7 +9703,9 @@ components:
|
|
|
8765
9703
|
When a time-based content expiration value is set for this package, the duration to retain packages
|
|
8766
9704
|
contents. When this duration passes, the packages contents are deleted. Valid values are null - 10 years.
|
|
8767
9705
|
Units are seconds.
|
|
8768
|
-
type:
|
|
9706
|
+
type:
|
|
9707
|
+
- integer
|
|
9708
|
+
- 'null'
|
|
8769
9709
|
examples:
|
|
8770
9710
|
- null
|
|
8771
9711
|
contents_file_id:
|
|
@@ -8792,7 +9732,9 @@ components:
|
|
|
8792
9732
|
which the package contents will be retained even after all recipients have downloaded the package. The timer
|
|
8793
9733
|
for this setting begins when all recipients have downloaded the package; when the timer expires, the package
|
|
8794
9734
|
contents are deleted. Valid values are null - 10 years. Units are seconds.
|
|
8795
|
-
type:
|
|
9735
|
+
type:
|
|
9736
|
+
- integer
|
|
9737
|
+
- 'null'
|
|
8796
9738
|
examples:
|
|
8797
9739
|
- null
|
|
8798
9740
|
deleted:
|
|
@@ -9174,14 +10116,13 @@ components:
|
|
|
9174
10116
|
type: boolean
|
|
9175
10117
|
description: Whether the short link has expired.
|
|
9176
10118
|
expires_at:
|
|
9177
|
-
type:
|
|
10119
|
+
type:
|
|
10120
|
+
- string
|
|
10121
|
+
- 'null'
|
|
9178
10122
|
format: date-time
|
|
9179
|
-
nullable: true
|
|
9180
10123
|
description: Expiry date-time, or null if the link does not expire.
|
|
9181
10124
|
data:
|
|
9182
|
-
|
|
9183
|
-
description: Arbitrary metadata associated with the short link.
|
|
9184
|
-
additionalProperties: true
|
|
10125
|
+
$ref: '#/components/schemas/short_link_data'
|
|
9185
10126
|
updated_by_user_id:
|
|
9186
10127
|
type: string
|
|
9187
10128
|
description: ID of the user who last updated the short link.
|
|
@@ -9193,6 +10134,115 @@ components:
|
|
|
9193
10134
|
type: string
|
|
9194
10135
|
format: date-time
|
|
9195
10136
|
description: Time at which the short link was last updated.
|
|
10137
|
+
short_link_purpose:
|
|
10138
|
+
type: string
|
|
10139
|
+
description: >-
|
|
10140
|
+
Purpose of a short link: `token_auth_redirection` for a public link (URL token, shared folder or shared inbox),
|
|
10141
|
+
`shared_folder_auth_link` for a private link (authentication required, shared folder only)
|
|
10142
|
+
enum:
|
|
10143
|
+
- token_auth_redirection
|
|
10144
|
+
- shared_folder_auth_link
|
|
10145
|
+
short_link_url_token_data:
|
|
10146
|
+
type: object
|
|
10147
|
+
description: URL token of a public short link
|
|
10148
|
+
properties:
|
|
10149
|
+
data:
|
|
10150
|
+
type: object
|
|
10151
|
+
description: >-
|
|
10152
|
+
Shared resource: shared inbox (`dropbox_id`, `name`) or shared folder (`node_id`, `file_id`), and `workspace_id`
|
|
10153
|
+
properties:
|
|
10154
|
+
workspace_id:
|
|
10155
|
+
type: string
|
|
10156
|
+
description: Workspace of the shared resource
|
|
10157
|
+
dropbox_id:
|
|
10158
|
+
type: string
|
|
10159
|
+
description: Shared inbox (token purpose `send_package_to_dropbox`)
|
|
10160
|
+
name:
|
|
10161
|
+
type: string
|
|
10162
|
+
description: Empty string for a shared inbox
|
|
10163
|
+
node_id:
|
|
10164
|
+
type: string
|
|
10165
|
+
description: Node of the shared folder (token purpose `view_shared_file`)
|
|
10166
|
+
file_id:
|
|
10167
|
+
type: string
|
|
10168
|
+
description: File identifier of the shared folder on the node
|
|
10169
|
+
additionalProperties: true
|
|
10170
|
+
purpose:
|
|
10171
|
+
type: string
|
|
10172
|
+
description: Purpose of the URL token, depends on the shared resource
|
|
10173
|
+
enum:
|
|
10174
|
+
- send_package_to_dropbox
|
|
10175
|
+
- view_shared_file
|
|
10176
|
+
password:
|
|
10177
|
+
type: string
|
|
10178
|
+
description: Password to follow the link (write only, with `password_enabled`)
|
|
10179
|
+
expires_at:
|
|
10180
|
+
type:
|
|
10181
|
+
- string
|
|
10182
|
+
- 'null'
|
|
10183
|
+
format: date-time
|
|
10184
|
+
description: Expiry date-time of the URL token
|
|
10185
|
+
short_link_data:
|
|
10186
|
+
type: object
|
|
10187
|
+
description: >-
|
|
10188
|
+
Public link (purpose `token_auth_redirection`): `aoc` and `url_token_data`.
|
|
10189
|
+
Private link (purpose `shared_folder_auth_link`): the shared folder (`node_id`, `file_id`, `workspace_id`)
|
|
10190
|
+
properties:
|
|
10191
|
+
aoc:
|
|
10192
|
+
type: boolean
|
|
10193
|
+
description: Link to an Aspera on Cloud resource (public link)
|
|
10194
|
+
url_token_data:
|
|
10195
|
+
$ref: '#/components/schemas/short_link_url_token_data'
|
|
10196
|
+
additionalProperties: true
|
|
10197
|
+
short_link_create_params:
|
|
10198
|
+
type: object
|
|
10199
|
+
description: Short link creation
|
|
10200
|
+
required:
|
|
10201
|
+
- purpose
|
|
10202
|
+
- data
|
|
10203
|
+
properties:
|
|
10204
|
+
purpose:
|
|
10205
|
+
$ref: '#/components/schemas/short_link_purpose'
|
|
10206
|
+
data:
|
|
10207
|
+
$ref: '#/components/schemas/short_link_data'
|
|
10208
|
+
password_enabled:
|
|
10209
|
+
type: boolean
|
|
10210
|
+
description: Password required to follow the link (password in `data.url_token_data.password`)
|
|
10211
|
+
expires_at:
|
|
10212
|
+
type:
|
|
10213
|
+
- string
|
|
10214
|
+
- 'null'
|
|
10215
|
+
format: date-time
|
|
10216
|
+
description: Expiry date-time, or null if the link does not expire
|
|
10217
|
+
user_selected_name:
|
|
10218
|
+
type:
|
|
10219
|
+
- string
|
|
10220
|
+
- 'null'
|
|
10221
|
+
description: Name of the link chosen by the user
|
|
10222
|
+
short_link_update_params:
|
|
10223
|
+
type: object
|
|
10224
|
+
description: >-
|
|
10225
|
+
Short link modification. Shared inbox link: `data.url_token_data.data` is `{"dropbox_id":..}`.
|
|
10226
|
+
Shared folder link: also `edit_access` and `json_query`
|
|
10227
|
+
properties:
|
|
10228
|
+
password_enabled:
|
|
10229
|
+
type: boolean
|
|
10230
|
+
description: Password required to follow the link (password in `data.url_token_data.password`)
|
|
10231
|
+
expires_at:
|
|
10232
|
+
type:
|
|
10233
|
+
- string
|
|
10234
|
+
- 'null'
|
|
10235
|
+
format: date-time
|
|
10236
|
+
description: Expiry date-time, or null if the link does not expire
|
|
10237
|
+
data:
|
|
10238
|
+
$ref: '#/components/schemas/short_link_data'
|
|
10239
|
+
edit_access:
|
|
10240
|
+
type: boolean
|
|
10241
|
+
description: Check edit access on the shared folder given in `json_query` (shared folder links only)
|
|
10242
|
+
json_query:
|
|
10243
|
+
type: object
|
|
10244
|
+
description: Shared folder of the link (`node_id`, `file_id`), with `edit_access`
|
|
10245
|
+
additionalProperties: true
|
|
9196
10246
|
transfer_report_response:
|
|
9197
10247
|
type: object
|
|
9198
10248
|
description: >
|
|
@@ -9280,8 +10330,9 @@ components:
|
|
|
9280
10330
|
type: boolean
|
|
9281
10331
|
description: Whether Trend Micro antivirus scanning is enabled.
|
|
9282
10332
|
user_limit:
|
|
9283
|
-
type:
|
|
9284
|
-
|
|
10333
|
+
type:
|
|
10334
|
+
- integer
|
|
10335
|
+
- 'null'
|
|
9285
10336
|
description: Maximum number of users allowed. Null means unlimited.
|
|
9286
10337
|
watermarking_enabled:
|
|
9287
10338
|
type: boolean
|
|
@@ -9552,33 +10603,39 @@ components:
|
|
|
9552
10603
|
properties:
|
|
9553
10604
|
autofill_shared_inbox_sending:
|
|
9554
10605
|
description: Whether to automatically fill the shared inbox when sending packages
|
|
9555
|
-
type:
|
|
9556
|
-
|
|
10606
|
+
type:
|
|
10607
|
+
- boolean
|
|
10608
|
+
- 'null'
|
|
9557
10609
|
example: true
|
|
9558
10610
|
default_aoc_app:
|
|
9559
10611
|
description: The default Aspera on Cloud application to display on login (e.g., "packages", "files", "activity")
|
|
9560
|
-
type:
|
|
9561
|
-
|
|
10612
|
+
type:
|
|
10613
|
+
- string
|
|
10614
|
+
- 'null'
|
|
9562
10615
|
example: packages
|
|
9563
10616
|
default_language:
|
|
9564
10617
|
description: The user's preferred language for the UI (e.g., "en-us", "fr-fr", "de-de")
|
|
9565
|
-
type:
|
|
9566
|
-
|
|
10618
|
+
type:
|
|
10619
|
+
- string
|
|
10620
|
+
- 'null'
|
|
9567
10621
|
example: en-us
|
|
9568
10622
|
first_connect_transfer:
|
|
9569
10623
|
description: Whether this is the user's first time connecting for a transfer (used for onboarding)
|
|
9570
|
-
type:
|
|
9571
|
-
|
|
10624
|
+
type:
|
|
10625
|
+
- boolean
|
|
10626
|
+
- 'null'
|
|
9572
10627
|
example: true
|
|
9573
10628
|
first_connect_download:
|
|
9574
10629
|
description: Whether this is the user's first time connecting for a download (used for onboarding)
|
|
9575
|
-
type:
|
|
9576
|
-
|
|
10630
|
+
type:
|
|
10631
|
+
- boolean
|
|
10632
|
+
- 'null'
|
|
9577
10633
|
example: true
|
|
9578
10634
|
pinned_dropbox_ids:
|
|
9579
10635
|
description: Array of dropbox IDs that the user has pinned for quick access
|
|
9580
|
-
type:
|
|
9581
|
-
|
|
10636
|
+
type:
|
|
10637
|
+
- array
|
|
10638
|
+
- 'null'
|
|
9582
10639
|
items:
|
|
9583
10640
|
type: integer
|
|
9584
10641
|
example:
|
|
@@ -9587,8 +10644,9 @@ components:
|
|
|
9587
10644
|
- 3
|
|
9588
10645
|
pinned_workspace_ids:
|
|
9589
10646
|
description: Array of workspace IDs that the user has pinned for quick access
|
|
9590
|
-
type:
|
|
9591
|
-
|
|
10647
|
+
type:
|
|
10648
|
+
- array
|
|
10649
|
+
- 'null'
|
|
9592
10650
|
items:
|
|
9593
10651
|
type: integer
|
|
9594
10652
|
example:
|
|
@@ -9596,34 +10654,40 @@ components:
|
|
|
9596
10654
|
- 20
|
|
9597
10655
|
auto_workflow_view:
|
|
9598
10656
|
description: The default view mode for automation workflows
|
|
9599
|
-
type:
|
|
9600
|
-
|
|
10657
|
+
type:
|
|
10658
|
+
- string
|
|
10659
|
+
- 'null'
|
|
9601
10660
|
example: ''
|
|
9602
10661
|
grid_view_workspaces:
|
|
9603
10662
|
description: The view mode for workspaces display (e.g., "list", "grid")
|
|
9604
|
-
type:
|
|
9605
|
-
|
|
10663
|
+
type:
|
|
10664
|
+
- string
|
|
10665
|
+
- 'null'
|
|
9606
10666
|
example: list
|
|
9607
10667
|
last_read_coming_soon:
|
|
9608
10668
|
description: Timestamp of the last time the user viewed the "Coming Soon" announcements
|
|
9609
|
-
type:
|
|
9610
|
-
|
|
10669
|
+
type:
|
|
10670
|
+
- string
|
|
10671
|
+
- 'null'
|
|
9611
10672
|
example: 03/19/2021_1
|
|
9612
10673
|
last_read_whats_new:
|
|
9613
10674
|
description: Timestamp of the last time the user viewed the "What's New" announcements
|
|
9614
|
-
type:
|
|
9615
|
-
|
|
10675
|
+
type:
|
|
10676
|
+
- string
|
|
10677
|
+
- 'null'
|
|
9616
10678
|
example: 03/30/2021_1
|
|
9617
10679
|
recent_transfers:
|
|
9618
10680
|
description: Object storing information about recent transfers for quick access
|
|
9619
|
-
type:
|
|
9620
|
-
|
|
10681
|
+
type:
|
|
10682
|
+
- object
|
|
10683
|
+
- 'null'
|
|
9621
10684
|
additionalProperties: true
|
|
9622
10685
|
example: {}
|
|
9623
10686
|
help_recent:
|
|
9624
10687
|
description: Array of recently accessed help topics for quick reference
|
|
9625
|
-
type:
|
|
9626
|
-
|
|
10688
|
+
type:
|
|
10689
|
+
- array
|
|
10690
|
+
- 'null'
|
|
9627
10691
|
items:
|
|
9628
10692
|
type: string
|
|
9629
10693
|
example:
|
|
@@ -9631,8 +10695,9 @@ components:
|
|
|
9631
10695
|
- creating_a_new_workspace
|
|
9632
10696
|
tableDataStore:
|
|
9633
10697
|
description: JSON string containing table configuration and sizing preferences for various UI tables
|
|
9634
|
-
type:
|
|
9635
|
-
|
|
10698
|
+
type:
|
|
10699
|
+
- string
|
|
10700
|
+
- 'null'
|
|
9636
10701
|
example: '[{"id":"files-table"},{"id":"user-list","tableSizing":"{\"displayUserStatus\":198}"}]'
|
|
9637
10702
|
additionalProperties: true
|
|
9638
10703
|
example:
|
|
@@ -9652,73 +10717,86 @@ components:
|
|
|
9652
10717
|
properties:
|
|
9653
10718
|
autofill_shared_inbox_sending:
|
|
9654
10719
|
description: Whether to automatically fill the shared inbox when sending packages
|
|
9655
|
-
type:
|
|
9656
|
-
|
|
10720
|
+
type:
|
|
10721
|
+
- boolean
|
|
10722
|
+
- 'null'
|
|
9657
10723
|
example: true
|
|
9658
10724
|
default_aoc_app:
|
|
9659
10725
|
description: The default Aspera on Cloud application to display on login
|
|
9660
|
-
type:
|
|
9661
|
-
|
|
10726
|
+
type:
|
|
10727
|
+
- string
|
|
10728
|
+
- 'null'
|
|
9662
10729
|
example: packages
|
|
9663
10730
|
default_language:
|
|
9664
10731
|
description: The user's preferred language for the UI
|
|
9665
|
-
type:
|
|
9666
|
-
|
|
10732
|
+
type:
|
|
10733
|
+
- string
|
|
10734
|
+
- 'null'
|
|
9667
10735
|
example: en-us
|
|
9668
10736
|
first_connect_transfer:
|
|
9669
10737
|
description: Whether this is the user's first time connecting for a transfer
|
|
9670
|
-
type:
|
|
9671
|
-
|
|
10738
|
+
type:
|
|
10739
|
+
- boolean
|
|
10740
|
+
- 'null'
|
|
9672
10741
|
example: null
|
|
9673
10742
|
first_connect_download:
|
|
9674
10743
|
description: Whether this is the user's first time connecting for a download
|
|
9675
|
-
type:
|
|
9676
|
-
|
|
10744
|
+
type:
|
|
10745
|
+
- boolean
|
|
10746
|
+
- 'null'
|
|
9677
10747
|
example: null
|
|
9678
10748
|
pinned_dropbox_ids:
|
|
9679
10749
|
description: Array of pinned dropbox IDs
|
|
9680
|
-
type:
|
|
9681
|
-
|
|
10750
|
+
type:
|
|
10751
|
+
- array
|
|
10752
|
+
- 'null'
|
|
9682
10753
|
items:
|
|
9683
10754
|
type: integer
|
|
9684
10755
|
example: null
|
|
9685
10756
|
pinned_workspace_ids:
|
|
9686
10757
|
description: Array of pinned workspace IDs
|
|
9687
|
-
type:
|
|
9688
|
-
|
|
10758
|
+
type:
|
|
10759
|
+
- array
|
|
10760
|
+
- 'null'
|
|
9689
10761
|
items:
|
|
9690
10762
|
type: integer
|
|
9691
10763
|
example: []
|
|
9692
10764
|
auto_workflow_view:
|
|
9693
10765
|
description: Default view mode for automation workflows
|
|
9694
|
-
type:
|
|
9695
|
-
|
|
10766
|
+
type:
|
|
10767
|
+
- string
|
|
10768
|
+
- 'null'
|
|
9696
10769
|
example: ''
|
|
9697
10770
|
grid_view_workspaces:
|
|
9698
10771
|
description: View mode for workspaces display
|
|
9699
|
-
type:
|
|
9700
|
-
|
|
10772
|
+
type:
|
|
10773
|
+
- string
|
|
10774
|
+
- 'null'
|
|
9701
10775
|
example: list
|
|
9702
10776
|
last_read_coming_soon:
|
|
9703
10777
|
description: Last viewed "Coming Soon" timestamp
|
|
9704
|
-
type:
|
|
9705
|
-
|
|
10778
|
+
type:
|
|
10779
|
+
- string
|
|
10780
|
+
- 'null'
|
|
9706
10781
|
example: 03/19/2021_1
|
|
9707
10782
|
last_read_whats_new:
|
|
9708
10783
|
description: Last viewed "What's New" timestamp
|
|
9709
|
-
type:
|
|
9710
|
-
|
|
10784
|
+
type:
|
|
10785
|
+
- string
|
|
10786
|
+
- 'null'
|
|
9711
10787
|
example: 03/30/2021_1
|
|
9712
10788
|
recent_transfers:
|
|
9713
10789
|
description: Recent transfers information
|
|
9714
|
-
type:
|
|
9715
|
-
|
|
10790
|
+
type:
|
|
10791
|
+
- object
|
|
10792
|
+
- 'null'
|
|
9716
10793
|
additionalProperties: true
|
|
9717
10794
|
example: {}
|
|
9718
10795
|
help_recent:
|
|
9719
10796
|
description: Recently accessed help topics
|
|
9720
|
-
type:
|
|
9721
|
-
|
|
10797
|
+
type:
|
|
10798
|
+
- array
|
|
10799
|
+
- 'null'
|
|
9722
10800
|
items:
|
|
9723
10801
|
type: string
|
|
9724
10802
|
example:
|
|
@@ -9727,8 +10805,9 @@ components:
|
|
|
9727
10805
|
- attach_azure_blob_storage
|
|
9728
10806
|
tableDataStore:
|
|
9729
10807
|
description: Table configuration and sizing preferences (JSON string)
|
|
9730
|
-
type:
|
|
9731
|
-
|
|
10808
|
+
type:
|
|
10809
|
+
- string
|
|
10810
|
+
- 'null'
|
|
9732
10811
|
example: '[{"id":"files-table"},{"id":"user-list","tableSizing":"{\"displayUserStatus\":198}"}]'
|
|
9733
10812
|
additionalProperties: true
|
|
9734
10813
|
example:
|
|
@@ -9853,22 +10932,6 @@ components:
|
|
|
9853
10932
|
type: integer
|
|
9854
10933
|
examples:
|
|
9855
10934
|
- 0
|
|
9856
|
-
workspace_query_params:
|
|
9857
|
-
type: object
|
|
9858
|
-
properties:
|
|
9859
|
-
created_at:
|
|
9860
|
-
type: string
|
|
9861
|
-
format: date-time
|
|
9862
|
-
manager:
|
|
9863
|
-
type: boolean
|
|
9864
|
-
name:
|
|
9865
|
-
description: full text search
|
|
9866
|
-
type: string
|
|
9867
|
-
node_id:
|
|
9868
|
-
type: integer
|
|
9869
|
-
updated_at:
|
|
9870
|
-
type: string
|
|
9871
|
-
format: date-time
|
|
9872
10935
|
workspaces_params:
|
|
9873
10936
|
type: object
|
|
9874
10937
|
properties:
|
|
@@ -9921,7 +10984,9 @@ components:
|
|
|
9921
10984
|
delete_package_content_after_download_duration. Valid values: null - 10 years. Units: seconds. POST: Admin
|
|
9922
10985
|
permission required. PUT Manager or Admin permission required. RESPONSE User scope. RESPONSE Admin scope
|
|
9923
10986
|
(org admin).
|
|
9924
|
-
type:
|
|
10987
|
+
type:
|
|
10988
|
+
- integer
|
|
10989
|
+
- 'null'
|
|
9925
10990
|
examples:
|
|
9926
10991
|
- null
|
|
9927
10992
|
default_ear_setting:
|
|
@@ -9947,7 +11012,9 @@ components:
|
|
|
9947
11012
|
time-based expiration policy, refer to content_retention_duration. Valid values: null - 10 years. Units:
|
|
9948
11013
|
seconds. POST: Admin permission required. PUT: Manager or Admin permission required. RESPONSE User scope.
|
|
9949
11014
|
RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
|
|
9950
|
-
type:
|
|
11015
|
+
type:
|
|
11016
|
+
- integer
|
|
11017
|
+
- 'null'
|
|
9951
11018
|
examples:
|
|
9952
11019
|
- null
|
|
9953
11020
|
description:
|
|
@@ -9965,7 +11032,9 @@ components:
|
|
|
9965
11032
|
deleted based on time. To set a time-based expiration policy for non-draft packages in this workspace, refer
|
|
9966
11033
|
to content_retention_duration. POST: Admin permission required. PUT Manager or Admin permission required.
|
|
9967
11034
|
RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
|
|
9968
|
-
type:
|
|
11035
|
+
type:
|
|
11036
|
+
- integer
|
|
11037
|
+
- 'null'
|
|
9969
11038
|
examples:
|
|
9970
11039
|
- null
|
|
9971
11040
|
email_footer:
|
|
@@ -9973,7 +11042,9 @@ components:
|
|
|
9973
11042
|
If 'inherit_email_templates' is set to false, configure the footer for email notifications for this
|
|
9974
11043
|
workspace. The footer you configure is common to all email notifications for this workspace. POST: Admin
|
|
9975
11044
|
permission required. PUT: Manager or Admin permission required. RESPONSE Admin scope (org admin).
|
|
9976
|
-
type:
|
|
11045
|
+
type:
|
|
11046
|
+
- string
|
|
11047
|
+
- 'null'
|
|
9977
11048
|
examples:
|
|
9978
11049
|
- null
|
|
9979
11050
|
email_notification_settings:
|
|
@@ -10010,7 +11081,9 @@ components:
|
|
|
10010
11081
|
The URI to collect event and activity reports. If this parameter is not null, you can use the
|
|
10011
11082
|
event_reporting_headers parameter to configure acceptable JSON headers. POST Admin permission required. PUT
|
|
10012
11083
|
Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).
|
|
10013
|
-
type:
|
|
11084
|
+
type:
|
|
11085
|
+
- string
|
|
11086
|
+
- 'null'
|
|
10014
11087
|
examples:
|
|
10015
11088
|
- null
|
|
10016
11089
|
external_package_authentication_required:
|
|
@@ -10203,7 +11276,9 @@ components:
|
|
|
10203
11276
|
description: >-
|
|
10204
11277
|
The file ID of the root folder containing packages for this workspace. POST Admin permission required. PUT
|
|
10205
11278
|
Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).
|
|
10206
|
-
type:
|
|
11279
|
+
type:
|
|
11280
|
+
- string
|
|
11281
|
+
- 'null'
|
|
10207
11282
|
examples:
|
|
10208
11283
|
- null
|
|
10209
11284
|
spool_file_id:
|
|
@@ -10294,7 +11369,9 @@ components:
|
|
|
10294
11369
|
delete_package_content_after_download_duration. Valid values (null - 10 years) Units (seconds) POST Admin
|
|
10295
11370
|
permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE User scope.
|
|
10296
11371
|
RESPONSE Admin scope (org admin).
|
|
10297
|
-
type:
|
|
11372
|
+
type:
|
|
11373
|
+
- integer
|
|
11374
|
+
- 'null'
|
|
10298
11375
|
examples:
|
|
10299
11376
|
- null
|
|
10300
11377
|
created_at:
|
|
@@ -10326,7 +11403,9 @@ components:
|
|
|
10326
11403
|
time-based expiration policy, refer to content_retention_duration. Valid values (null - 10 years) Units
|
|
10327
11404
|
(seconds) POST Admin permission required. PUT Manager permission required. or PUT Admin permission required.
|
|
10328
11405
|
RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope (org admin).
|
|
10329
|
-
type:
|
|
11406
|
+
type:
|
|
11407
|
+
- integer
|
|
11408
|
+
- 'null'
|
|
10330
11409
|
examples:
|
|
10331
11410
|
- null
|
|
10332
11411
|
description:
|
|
@@ -10345,7 +11424,9 @@ components:
|
|
|
10345
11424
|
to content_retention_duration. POST Admin permission required. PUT Manager permission required or PUT Admin
|
|
10346
11425
|
permission required. RESPONSE User scope. RESPONSE Admin scope (could be ws manager). RESPONSE Admin scope
|
|
10347
11426
|
(org admin).
|
|
10348
|
-
type:
|
|
11427
|
+
type:
|
|
11428
|
+
- integer
|
|
11429
|
+
- 'null'
|
|
10349
11430
|
examples:
|
|
10350
11431
|
- null
|
|
10351
11432
|
effective_default_ear_setting:
|
|
@@ -10364,7 +11445,9 @@ components:
|
|
|
10364
11445
|
workspace. The footer you configure is common to all email notifications for this workspace. POST Admin
|
|
10365
11446
|
permission required. PUT Manager permission required or PUT Admin permission required. RESPONSE Admin scope
|
|
10366
11447
|
(org admin).
|
|
10367
|
-
type:
|
|
11448
|
+
type:
|
|
11449
|
+
- string
|
|
11450
|
+
- 'null'
|
|
10368
11451
|
examples:
|
|
10369
11452
|
- null
|
|
10370
11453
|
email_notification_settings:
|
|
@@ -10403,7 +11486,9 @@ components:
|
|
|
10403
11486
|
The URI to collect event and activity reports. If this parameter is not null, you can use the
|
|
10404
11487
|
event_reporting_headers parameter to configure acceptable JSON headers. POST Admin permission required. PUT
|
|
10405
11488
|
Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).
|
|
10406
|
-
type:
|
|
11489
|
+
type:
|
|
11490
|
+
- string
|
|
11491
|
+
- 'null'
|
|
10407
11492
|
examples:
|
|
10408
11493
|
- null
|
|
10409
11494
|
external_package_authentication_required:
|
|
@@ -10640,7 +11725,9 @@ components:
|
|
|
10640
11725
|
description: >-
|
|
10641
11726
|
The file ID of the root folder containing packages for this workspace. POST Admin permission required. PUT
|
|
10642
11727
|
Manager permission required or PUT Admin permission required. RESPONSE Admin scope (org admin).
|
|
10643
|
-
type:
|
|
11728
|
+
type:
|
|
11729
|
+
- string
|
|
11730
|
+
- 'null'
|
|
10644
11731
|
examples:
|
|
10645
11732
|
- null
|
|
10646
11733
|
spool_file_id:
|
|
@@ -10741,9 +11828,10 @@ components:
|
|
|
10741
11828
|
- true
|
|
10742
11829
|
aggressiveness:
|
|
10743
11830
|
description: Transfer aggressiveness factor (0.0 to 1.0). Null means use node default.
|
|
10744
|
-
type:
|
|
11831
|
+
type:
|
|
11832
|
+
- number
|
|
11833
|
+
- 'null'
|
|
10745
11834
|
format: float
|
|
10746
|
-
nullable: true
|
|
10747
11835
|
examples:
|
|
10748
11836
|
- 0.15
|
|
10749
11837
|
cipher:
|
|
@@ -10757,14 +11845,16 @@ components:
|
|
|
10757
11845
|
- aes-128
|
|
10758
11846
|
content_protection_secret:
|
|
10759
11847
|
description: Secret used for content protection (server-side encryption at rest). Null if not set.
|
|
10760
|
-
type:
|
|
10761
|
-
|
|
11848
|
+
type:
|
|
11849
|
+
- string
|
|
11850
|
+
- 'null'
|
|
10762
11851
|
examples:
|
|
10763
11852
|
- aspera-1
|
|
10764
11853
|
default_target_rate_kbps:
|
|
10765
11854
|
description: Default target transfer rate in kbps. Null means no limit.
|
|
10766
|
-
type:
|
|
10767
|
-
|
|
11855
|
+
type:
|
|
11856
|
+
- integer
|
|
11857
|
+
- 'null'
|
|
10768
11858
|
examples:
|
|
10769
11859
|
- 150000
|
|
10770
11860
|
enable_iteration_token_pagination:
|
|
@@ -10816,9 +11906,10 @@ components:
|
|
|
10816
11906
|
- true
|
|
10817
11907
|
aggressiveness:
|
|
10818
11908
|
description: Transfer aggressiveness factor (0.0 to 1.0). Null means use node default.
|
|
10819
|
-
type:
|
|
11909
|
+
type:
|
|
11910
|
+
- number
|
|
11911
|
+
- 'null'
|
|
10820
11912
|
format: float
|
|
10821
|
-
nullable: true
|
|
10822
11913
|
examples:
|
|
10823
11914
|
- 0.15
|
|
10824
11915
|
cipher:
|
|
@@ -10832,14 +11923,16 @@ components:
|
|
|
10832
11923
|
- aes-128
|
|
10833
11924
|
content_protection_secret:
|
|
10834
11925
|
description: Secret used for content protection (server-side encryption at rest). Null if not set.
|
|
10835
|
-
type:
|
|
10836
|
-
|
|
11926
|
+
type:
|
|
11927
|
+
- string
|
|
11928
|
+
- 'null'
|
|
10837
11929
|
examples:
|
|
10838
11930
|
- aspera-1
|
|
10839
11931
|
default_target_rate_kbps:
|
|
10840
11932
|
description: Default target transfer rate in kbps. Null means no limit.
|
|
10841
|
-
type:
|
|
10842
|
-
|
|
11933
|
+
type:
|
|
11934
|
+
- integer
|
|
11935
|
+
- 'null'
|
|
10843
11936
|
examples:
|
|
10844
11937
|
- 150000
|
|
10845
11938
|
enable_iteration_token_pagination:
|