@credibledata/cred-cli 0.1.1 → 0.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client/api.js +277 -277
- package/dist/client/api.js.map +1 -1
- package/dist/client/base.js +1 -1
- package/dist/client/common.js +1 -1
- package/dist/client/configuration.js +1 -1
- package/dist/client/index.js +1 -1
- package/dist/clientconfiguration.js +1 -1
- package/dist/clientconfiguration.js.map +1 -1
- package/dist/commands/add.js +3 -1
- package/dist/commands/add.js.map +1 -1
- package/dist/commands/connection/createconnections.js +13 -1
- package/dist/commands/connection/createconnections.js.map +1 -1
- package/generate-client.sh +22 -0
- package/package.json +2 -2
- package/src/client/api.ts +300 -282
- package/src/client/base.ts +1 -1
- package/src/client/common.ts +1 -1
- package/src/client/configuration.ts +1 -1
- package/src/client/index.ts +1 -1
- package/src/clientconfiguration.ts +1 -1
- package/src/commands/add.ts +10 -0
- package/src/commands/connection/createconnections.ts +17 -0
package/src/client/api.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
/* eslint-disable */
|
|
3
3
|
/**
|
|
4
4
|
* Credible Admin API
|
|
5
|
-
* The Credible Admin API is a comprehensive REST API that empowers organizations to manage their Malloy data modeling ecosystem with enterprise-grade security and governance. This API provides programmatic access to all administrative functions, enabling seamless integration with existing workflows and automation systems. ## Key Features - **Organization Management**: Create and manage organizations with fine-grained access controls - **Project & Package Lifecycle**: Full CRUD operations for projects, packages, and versions - **Connection Management**: Secure database connection configuration and management - **Permission Management**: Granular role-based access control (RBAC) at organization, project, package, workspace, and document levels - **Workspace Management**: Collaborative workspaces for data modeling and analysis - **User & Group Management**: Comprehensive user administration with group-based permissions ## Resource Hierarchy The API follows a hierarchical resource structure with fine-grained permission management at each level: ``` Organizations ├── Permissions ├── Projects
|
|
5
|
+
* The Credible Admin API is a comprehensive REST API that empowers organizations to manage their Malloy data modeling ecosystem with enterprise-grade security and governance. This API provides programmatic access to all administrative functions, enabling seamless integration with existing workflows and automation systems. ## Key Features - **Organization Management**: Create and manage organizations with fine-grained access controls - **Project & Package Lifecycle**: Full CRUD operations for projects, packages, and versions - **Connection Management**: Secure database connection configuration and management - **Permission Management**: Granular role-based access control (RBAC) at organization, project, package, workspace, and document levels - **Workspace Management**: Collaborative workspaces for data modeling and analysis - **User & Group Management**: Comprehensive user administration with group-based permissions ## Resource Hierarchy The API follows a hierarchical resource structure with fine-grained permission management at each level: ``` Organizations ├── Permissions ├── Projects │ ├── Permissions │ ├── Packages │ │ ├── Permissions │ │ └── Versions │ └── Connections ├── Workspaces │ ├── Permissions │ └── Documents │ └── Permissions └── Groups ├── Permissions └── Members System-Level Resources: ├── Users ├── System Permissions └── Demo Operations ``` ## Authentication & Authorization All API endpoints require proper authentication. The API implements fine-grained authorization using role-based permissions: - **Admin**: Full access to all resources within scope - **Modeler**: Can create and modify data models and packages - **Viewer**: Read-only access to resources - **Manager**: Workspace management capabilities - **Editor**: Document editing permissions ## Rate Limiting & Best Practices - API requests are rate-limited to ensure system stability - Implement proper error handling and retry logic - Cache responses when appropriate to reduce API calls ## Support & Documentation For additional support, examples, and integration guides, visit our developer documentation or contact our support team.
|
|
6
6
|
*
|
|
7
7
|
* The version of the OpenAPI document: v0
|
|
8
8
|
* Contact: support@credibledata.com
|
|
@@ -96,6 +96,18 @@ export interface Connection {
|
|
|
96
96
|
* @memberof Connection
|
|
97
97
|
*/
|
|
98
98
|
'mysqlConnection'?: ConnectionMysqlConnection;
|
|
99
|
+
/**
|
|
100
|
+
* The list of tables to include, in the format `{dataset/schema}.{table}`. The first part represents the dataset or schema, and the second part is the table name. The second part can be a literal `*` to include all tables.
|
|
101
|
+
* @type {Array<string>}
|
|
102
|
+
* @memberof Connection
|
|
103
|
+
*/
|
|
104
|
+
'includeTables'?: Array<string>;
|
|
105
|
+
/**
|
|
106
|
+
* The list of tables to exclude, in the format `{dataset/schema}.{table}`. The first part represents the dataset or schema, and the second part is the table name. The second part can be a literal `*` to exclude all tables.
|
|
107
|
+
* @type {Array<string>}
|
|
108
|
+
* @memberof Connection
|
|
109
|
+
*/
|
|
110
|
+
'excludeTables'?: Array<string>;
|
|
99
111
|
}
|
|
100
112
|
|
|
101
113
|
export const ConnectionTypeEnum = {
|
|
@@ -304,6 +316,12 @@ export interface ConnectionSnowflakeConnection {
|
|
|
304
316
|
* @memberof ConnectionSnowflakeConnection
|
|
305
317
|
*/
|
|
306
318
|
'schema'?: string;
|
|
319
|
+
/**
|
|
320
|
+
*
|
|
321
|
+
* @type {string}
|
|
322
|
+
* @memberof ConnectionSnowflakeConnection
|
|
323
|
+
*/
|
|
324
|
+
'role'?: string;
|
|
307
325
|
/**
|
|
308
326
|
*
|
|
309
327
|
* @type {number}
|
|
@@ -459,13 +477,13 @@ export type DocumentPermissionInheritedPermissionEnum = typeof DocumentPermissio
|
|
|
459
477
|
/**
|
|
460
478
|
*
|
|
461
479
|
* @export
|
|
462
|
-
* @interface
|
|
480
|
+
* @interface GetGroupMembersResponse
|
|
463
481
|
*/
|
|
464
|
-
export interface
|
|
482
|
+
export interface GetGroupMembersResponse {
|
|
465
483
|
/**
|
|
466
484
|
* List of all group members (users and groups) with their status and CredibleResourceUri
|
|
467
485
|
* @type {Array<GroupMember>}
|
|
468
|
-
* @memberof
|
|
486
|
+
* @memberof GetGroupMembersResponse
|
|
469
487
|
*/
|
|
470
488
|
'members'?: Array<GroupMember>;
|
|
471
489
|
}
|
|
@@ -1172,7 +1190,7 @@ export type WorkspacePermissionPermissionEnum = typeof WorkspacePermissionPermis
|
|
|
1172
1190
|
export const ConnectionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1173
1191
|
return {
|
|
1174
1192
|
/**
|
|
1175
|
-
* Creates a new database connection for the specified project with secure credential
|
|
1193
|
+
* Creates a new database connection for the specified project with secure credential storage and connection validation. **Authorization**: Requires project admin permissions. **Validation**: Tests connection before saving if dryRun is false. **Security**: Credentials are encrypted and stored securely.
|
|
1176
1194
|
* @summary Create database connection
|
|
1177
1195
|
* @param {string} organizationName The unique identifier of the organization
|
|
1178
1196
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1221,7 +1239,7 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1221
1239
|
};
|
|
1222
1240
|
},
|
|
1223
1241
|
/**
|
|
1224
|
-
* Permanently deletes a database connection and removes all associated credentials.
|
|
1242
|
+
* Permanently deletes a database connection and removes all associated credentials. This operation is irreversible. **Authorization**: Requires project admin permissions. **Warning**: This operation will remove access to the associated database. **Side Effects**: Removes all connection configuration and credentials.
|
|
1225
1243
|
* @summary Delete database connection
|
|
1226
1244
|
* @param {string} organizationName The unique identifier of the organization
|
|
1227
1245
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1263,7 +1281,7 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1263
1281
|
};
|
|
1264
1282
|
},
|
|
1265
1283
|
/**
|
|
1266
|
-
* Retrieves detailed information about a specific database connection including
|
|
1284
|
+
* Retrieves detailed information about a specific database connection including configuration, status, and metadata (credentials are not included for security). **Authorization**: Requires project admin permissions. **Security**: Sensitive credential data is excluded from the response.
|
|
1267
1285
|
* @summary Get connection details
|
|
1268
1286
|
* @param {string} organizationName The unique identifier of the organization
|
|
1269
1287
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1305,7 +1323,7 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1305
1323
|
};
|
|
1306
1324
|
},
|
|
1307
1325
|
/**
|
|
1308
|
-
* Retrieves all database connections configured for the specified project, including
|
|
1326
|
+
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions. **Response**: Returns array of connection objects with configuration details.
|
|
1309
1327
|
* @summary List database connections
|
|
1310
1328
|
* @param {string} organizationName The unique identifier of the organization
|
|
1311
1329
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1343,7 +1361,7 @@ export const ConnectionsApiAxiosParamCreator = function (configuration?: Configu
|
|
|
1343
1361
|
};
|
|
1344
1362
|
},
|
|
1345
1363
|
/**
|
|
1346
|
-
* Updates the configuration of an existing database connection, including credentials,
|
|
1364
|
+
* Updates the configuration of an existing database connection, including credentials, settings, and connection parameters. **Authorization**: Requires project admin permissions. **Security**: Credentials are encrypted and stored securely. **Validation**: Tests connection before saving changes.
|
|
1347
1365
|
* @summary Update database connection
|
|
1348
1366
|
* @param {string} organizationName The unique identifier of the organization
|
|
1349
1367
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1399,7 +1417,7 @@ export const ConnectionsApiFp = function(configuration?: Configuration) {
|
|
|
1399
1417
|
const localVarAxiosParamCreator = ConnectionsApiAxiosParamCreator(configuration)
|
|
1400
1418
|
return {
|
|
1401
1419
|
/**
|
|
1402
|
-
* Creates a new database connection for the specified project with secure credential
|
|
1420
|
+
* Creates a new database connection for the specified project with secure credential storage and connection validation. **Authorization**: Requires project admin permissions. **Validation**: Tests connection before saving if dryRun is false. **Security**: Credentials are encrypted and stored securely.
|
|
1403
1421
|
* @summary Create database connection
|
|
1404
1422
|
* @param {string} organizationName The unique identifier of the organization
|
|
1405
1423
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1415,7 +1433,7 @@ export const ConnectionsApiFp = function(configuration?: Configuration) {
|
|
|
1415
1433
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1416
1434
|
},
|
|
1417
1435
|
/**
|
|
1418
|
-
* Permanently deletes a database connection and removes all associated credentials.
|
|
1436
|
+
* Permanently deletes a database connection and removes all associated credentials. This operation is irreversible. **Authorization**: Requires project admin permissions. **Warning**: This operation will remove access to the associated database. **Side Effects**: Removes all connection configuration and credentials.
|
|
1419
1437
|
* @summary Delete database connection
|
|
1420
1438
|
* @param {string} organizationName The unique identifier of the organization
|
|
1421
1439
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1430,7 +1448,7 @@ export const ConnectionsApiFp = function(configuration?: Configuration) {
|
|
|
1430
1448
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1431
1449
|
},
|
|
1432
1450
|
/**
|
|
1433
|
-
* Retrieves detailed information about a specific database connection including
|
|
1451
|
+
* Retrieves detailed information about a specific database connection including configuration, status, and metadata (credentials are not included for security). **Authorization**: Requires project admin permissions. **Security**: Sensitive credential data is excluded from the response.
|
|
1434
1452
|
* @summary Get connection details
|
|
1435
1453
|
* @param {string} organizationName The unique identifier of the organization
|
|
1436
1454
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1445,7 +1463,7 @@ export const ConnectionsApiFp = function(configuration?: Configuration) {
|
|
|
1445
1463
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1446
1464
|
},
|
|
1447
1465
|
/**
|
|
1448
|
-
* Retrieves all database connections configured for the specified project, including
|
|
1466
|
+
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions. **Response**: Returns array of connection objects with configuration details.
|
|
1449
1467
|
* @summary List database connections
|
|
1450
1468
|
* @param {string} organizationName The unique identifier of the organization
|
|
1451
1469
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1459,7 +1477,7 @@ export const ConnectionsApiFp = function(configuration?: Configuration) {
|
|
|
1459
1477
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1460
1478
|
},
|
|
1461
1479
|
/**
|
|
1462
|
-
* Updates the configuration of an existing database connection, including credentials,
|
|
1480
|
+
* Updates the configuration of an existing database connection, including credentials, settings, and connection parameters. **Authorization**: Requires project admin permissions. **Security**: Credentials are encrypted and stored securely. **Validation**: Tests connection before saving changes.
|
|
1463
1481
|
* @summary Update database connection
|
|
1464
1482
|
* @param {string} organizationName The unique identifier of the organization
|
|
1465
1483
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1485,7 +1503,7 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
1485
1503
|
const localVarFp = ConnectionsApiFp(configuration)
|
|
1486
1504
|
return {
|
|
1487
1505
|
/**
|
|
1488
|
-
* Creates a new database connection for the specified project with secure credential
|
|
1506
|
+
* Creates a new database connection for the specified project with secure credential storage and connection validation. **Authorization**: Requires project admin permissions. **Validation**: Tests connection before saving if dryRun is false. **Security**: Credentials are encrypted and stored securely.
|
|
1489
1507
|
* @summary Create database connection
|
|
1490
1508
|
* @param {string} organizationName The unique identifier of the organization
|
|
1491
1509
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1498,7 +1516,7 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
1498
1516
|
return localVarFp.createConnection(organizationName, projectName, connection, dryRun, options).then((request) => request(axios, basePath));
|
|
1499
1517
|
},
|
|
1500
1518
|
/**
|
|
1501
|
-
* Permanently deletes a database connection and removes all associated credentials.
|
|
1519
|
+
* Permanently deletes a database connection and removes all associated credentials. This operation is irreversible. **Authorization**: Requires project admin permissions. **Warning**: This operation will remove access to the associated database. **Side Effects**: Removes all connection configuration and credentials.
|
|
1502
1520
|
* @summary Delete database connection
|
|
1503
1521
|
* @param {string} organizationName The unique identifier of the organization
|
|
1504
1522
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1510,7 +1528,7 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
1510
1528
|
return localVarFp.deleteConnection(organizationName, projectName, connectionName, options).then((request) => request(axios, basePath));
|
|
1511
1529
|
},
|
|
1512
1530
|
/**
|
|
1513
|
-
* Retrieves detailed information about a specific database connection including
|
|
1531
|
+
* Retrieves detailed information about a specific database connection including configuration, status, and metadata (credentials are not included for security). **Authorization**: Requires project admin permissions. **Security**: Sensitive credential data is excluded from the response.
|
|
1514
1532
|
* @summary Get connection details
|
|
1515
1533
|
* @param {string} organizationName The unique identifier of the organization
|
|
1516
1534
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1522,7 +1540,7 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
1522
1540
|
return localVarFp.getConnection(organizationName, projectName, connectionName, options).then((request) => request(axios, basePath));
|
|
1523
1541
|
},
|
|
1524
1542
|
/**
|
|
1525
|
-
* Retrieves all database connections configured for the specified project, including
|
|
1543
|
+
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions. **Response**: Returns array of connection objects with configuration details.
|
|
1526
1544
|
* @summary List database connections
|
|
1527
1545
|
* @param {string} organizationName The unique identifier of the organization
|
|
1528
1546
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1533,7 +1551,7 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
1533
1551
|
return localVarFp.listConnections(organizationName, projectName, options).then((request) => request(axios, basePath));
|
|
1534
1552
|
},
|
|
1535
1553
|
/**
|
|
1536
|
-
* Updates the configuration of an existing database connection, including credentials,
|
|
1554
|
+
* Updates the configuration of an existing database connection, including credentials, settings, and connection parameters. **Authorization**: Requires project admin permissions. **Security**: Credentials are encrypted and stored securely. **Validation**: Tests connection before saving changes.
|
|
1537
1555
|
* @summary Update database connection
|
|
1538
1556
|
* @param {string} organizationName The unique identifier of the organization
|
|
1539
1557
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1556,7 +1574,7 @@ export const ConnectionsApiFactory = function (configuration?: Configuration, ba
|
|
|
1556
1574
|
*/
|
|
1557
1575
|
export class ConnectionsApi extends BaseAPI {
|
|
1558
1576
|
/**
|
|
1559
|
-
* Creates a new database connection for the specified project with secure credential
|
|
1577
|
+
* Creates a new database connection for the specified project with secure credential storage and connection validation. **Authorization**: Requires project admin permissions. **Validation**: Tests connection before saving if dryRun is false. **Security**: Credentials are encrypted and stored securely.
|
|
1560
1578
|
* @summary Create database connection
|
|
1561
1579
|
* @param {string} organizationName The unique identifier of the organization
|
|
1562
1580
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1571,7 +1589,7 @@ export class ConnectionsApi extends BaseAPI {
|
|
|
1571
1589
|
}
|
|
1572
1590
|
|
|
1573
1591
|
/**
|
|
1574
|
-
* Permanently deletes a database connection and removes all associated credentials.
|
|
1592
|
+
* Permanently deletes a database connection and removes all associated credentials. This operation is irreversible. **Authorization**: Requires project admin permissions. **Warning**: This operation will remove access to the associated database. **Side Effects**: Removes all connection configuration and credentials.
|
|
1575
1593
|
* @summary Delete database connection
|
|
1576
1594
|
* @param {string} organizationName The unique identifier of the organization
|
|
1577
1595
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1585,7 +1603,7 @@ export class ConnectionsApi extends BaseAPI {
|
|
|
1585
1603
|
}
|
|
1586
1604
|
|
|
1587
1605
|
/**
|
|
1588
|
-
* Retrieves detailed information about a specific database connection including
|
|
1606
|
+
* Retrieves detailed information about a specific database connection including configuration, status, and metadata (credentials are not included for security). **Authorization**: Requires project admin permissions. **Security**: Sensitive credential data is excluded from the response.
|
|
1589
1607
|
* @summary Get connection details
|
|
1590
1608
|
* @param {string} organizationName The unique identifier of the organization
|
|
1591
1609
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1599,7 +1617,7 @@ export class ConnectionsApi extends BaseAPI {
|
|
|
1599
1617
|
}
|
|
1600
1618
|
|
|
1601
1619
|
/**
|
|
1602
|
-
* Retrieves all database connections configured for the specified project, including
|
|
1620
|
+
* Retrieves all database connections configured for the specified project, including connection metadata, status, and configuration details. **Authorization**: Requires project admin or modeler permissions. **Response**: Returns array of connection objects with configuration details.
|
|
1603
1621
|
* @summary List database connections
|
|
1604
1622
|
* @param {string} organizationName The unique identifier of the organization
|
|
1605
1623
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1612,7 +1630,7 @@ export class ConnectionsApi extends BaseAPI {
|
|
|
1612
1630
|
}
|
|
1613
1631
|
|
|
1614
1632
|
/**
|
|
1615
|
-
* Updates the configuration of an existing database connection, including credentials,
|
|
1633
|
+
* Updates the configuration of an existing database connection, including credentials, settings, and connection parameters. **Authorization**: Requires project admin permissions. **Security**: Credentials are encrypted and stored securely. **Validation**: Tests connection before saving changes.
|
|
1616
1634
|
* @summary Update database connection
|
|
1617
1635
|
* @param {string} organizationName The unique identifier of the organization
|
|
1618
1636
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -1636,7 +1654,7 @@ export class ConnectionsApi extends BaseAPI {
|
|
|
1636
1654
|
export const DemoApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1637
1655
|
return {
|
|
1638
1656
|
/**
|
|
1639
|
-
* Creates a demo project with sample data and configurations for testing and
|
|
1657
|
+
* Creates a demo project with sample data and configurations for testing and demonstration purposes. **Authorization**: No authentication required for demo purposes. **Purpose**: Provides a quick way to set up a sample project for evaluation. **Content**: Includes sample packages, connections, and data models.
|
|
1640
1658
|
* @summary Create demo project
|
|
1641
1659
|
* @param {*} [options] Override http request option.
|
|
1642
1660
|
* @throws {RequiredError}
|
|
@@ -1666,7 +1684,7 @@ export const DemoApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
1666
1684
|
};
|
|
1667
1685
|
},
|
|
1668
1686
|
/**
|
|
1669
|
-
* Creates a new organization through self-service registration, allowing users to
|
|
1687
|
+
* Creates a new organization through self-service registration, allowing users to quickly set up their own organizational environment. **Authorization**: No authentication required for self-service registration. **Purpose**: Enables quick onboarding and organization setup. **Features**: Creates organization with default permissions and initial structure.
|
|
1670
1688
|
* @summary Create self-service organization
|
|
1671
1689
|
* @param {Organization} [organization]
|
|
1672
1690
|
* @param {*} [options] Override http request option.
|
|
@@ -1710,7 +1728,7 @@ export const DemoApiFp = function(configuration?: Configuration) {
|
|
|
1710
1728
|
const localVarAxiosParamCreator = DemoApiAxiosParamCreator(configuration)
|
|
1711
1729
|
return {
|
|
1712
1730
|
/**
|
|
1713
|
-
* Creates a demo project with sample data and configurations for testing and
|
|
1731
|
+
* Creates a demo project with sample data and configurations for testing and demonstration purposes. **Authorization**: No authentication required for demo purposes. **Purpose**: Provides a quick way to set up a sample project for evaluation. **Content**: Includes sample packages, connections, and data models.
|
|
1714
1732
|
* @summary Create demo project
|
|
1715
1733
|
* @param {*} [options] Override http request option.
|
|
1716
1734
|
* @throws {RequiredError}
|
|
@@ -1722,7 +1740,7 @@ export const DemoApiFp = function(configuration?: Configuration) {
|
|
|
1722
1740
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
1723
1741
|
},
|
|
1724
1742
|
/**
|
|
1725
|
-
* Creates a new organization through self-service registration, allowing users to
|
|
1743
|
+
* Creates a new organization through self-service registration, allowing users to quickly set up their own organizational environment. **Authorization**: No authentication required for self-service registration. **Purpose**: Enables quick onboarding and organization setup. **Features**: Creates organization with default permissions and initial structure.
|
|
1726
1744
|
* @summary Create self-service organization
|
|
1727
1745
|
* @param {Organization} [organization]
|
|
1728
1746
|
* @param {*} [options] Override http request option.
|
|
@@ -1745,7 +1763,7 @@ export const DemoApiFactory = function (configuration?: Configuration, basePath?
|
|
|
1745
1763
|
const localVarFp = DemoApiFp(configuration)
|
|
1746
1764
|
return {
|
|
1747
1765
|
/**
|
|
1748
|
-
* Creates a demo project with sample data and configurations for testing and
|
|
1766
|
+
* Creates a demo project with sample data and configurations for testing and demonstration purposes. **Authorization**: No authentication required for demo purposes. **Purpose**: Provides a quick way to set up a sample project for evaluation. **Content**: Includes sample packages, connections, and data models.
|
|
1749
1767
|
* @summary Create demo project
|
|
1750
1768
|
* @param {*} [options] Override http request option.
|
|
1751
1769
|
* @throws {RequiredError}
|
|
@@ -1754,7 +1772,7 @@ export const DemoApiFactory = function (configuration?: Configuration, basePath?
|
|
|
1754
1772
|
return localVarFp.createDemoProject(options).then((request) => request(axios, basePath));
|
|
1755
1773
|
},
|
|
1756
1774
|
/**
|
|
1757
|
-
* Creates a new organization through self-service registration, allowing users to
|
|
1775
|
+
* Creates a new organization through self-service registration, allowing users to quickly set up their own organizational environment. **Authorization**: No authentication required for self-service registration. **Purpose**: Enables quick onboarding and organization setup. **Features**: Creates organization with default permissions and initial structure.
|
|
1758
1776
|
* @summary Create self-service organization
|
|
1759
1777
|
* @param {Organization} [organization]
|
|
1760
1778
|
* @param {*} [options] Override http request option.
|
|
@@ -1774,7 +1792,7 @@ export const DemoApiFactory = function (configuration?: Configuration, basePath?
|
|
|
1774
1792
|
*/
|
|
1775
1793
|
export class DemoApi extends BaseAPI {
|
|
1776
1794
|
/**
|
|
1777
|
-
* Creates a demo project with sample data and configurations for testing and
|
|
1795
|
+
* Creates a demo project with sample data and configurations for testing and demonstration purposes. **Authorization**: No authentication required for demo purposes. **Purpose**: Provides a quick way to set up a sample project for evaluation. **Content**: Includes sample packages, connections, and data models.
|
|
1778
1796
|
* @summary Create demo project
|
|
1779
1797
|
* @param {*} [options] Override http request option.
|
|
1780
1798
|
* @throws {RequiredError}
|
|
@@ -1785,7 +1803,7 @@ export class DemoApi extends BaseAPI {
|
|
|
1785
1803
|
}
|
|
1786
1804
|
|
|
1787
1805
|
/**
|
|
1788
|
-
* Creates a new organization through self-service registration, allowing users to
|
|
1806
|
+
* Creates a new organization through self-service registration, allowing users to quickly set up their own organizational environment. **Authorization**: No authentication required for self-service registration. **Purpose**: Enables quick onboarding and organization setup. **Features**: Creates organization with default permissions and initial structure.
|
|
1789
1807
|
* @summary Create self-service organization
|
|
1790
1808
|
* @param {Organization} [organization]
|
|
1791
1809
|
* @param {*} [options] Override http request option.
|
|
@@ -1806,7 +1824,7 @@ export class DemoApi extends BaseAPI {
|
|
|
1806
1824
|
export const DocumentPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
1807
1825
|
return {
|
|
1808
1826
|
/**
|
|
1809
|
-
* Creates a new permission assignment for a user or group within the document,
|
|
1827
|
+
* Creates a new permission assignment for a user or group within the document, granting them specific roles and access levels. Can also be used to request access to the document when the user doesn\'t have editor or workspace manager permissions. **Authorization**: Requires document editor or workspace manager permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports editor and viewer roles.
|
|
1810
1828
|
* @summary Create document permission
|
|
1811
1829
|
* @param {string} organizationName The unique identifier of the organization
|
|
1812
1830
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -1857,7 +1875,7 @@ export const DocumentPermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
1857
1875
|
};
|
|
1858
1876
|
},
|
|
1859
1877
|
/**
|
|
1860
|
-
* Removes the permission assignment for a user or group within the document,
|
|
1878
|
+
* Removes the permission assignment for a user or group within the document, revoking their access to document resources. **Authorization**: Requires document editor or workspace manager permissions. **Side Effects**: User/group loses access to document resources.
|
|
1861
1879
|
* @summary Delete document permission
|
|
1862
1880
|
* @param {string} organizationName The unique identifier of the organization
|
|
1863
1881
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -1903,7 +1921,7 @@ export const DocumentPermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
1903
1921
|
};
|
|
1904
1922
|
},
|
|
1905
1923
|
/**
|
|
1906
|
-
* Retrieves the permission details for a specific user or group within the document,
|
|
1924
|
+
* Retrieves the permission details for a specific user or group within the document, including their role and access level. **Authorization**: Requires document editor or workspace manager permissions. **Response**: Returns permission object with role and metadata.
|
|
1907
1925
|
* @summary Get document permission
|
|
1908
1926
|
* @param {string} organizationName The unique identifier of the organization
|
|
1909
1927
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -1949,7 +1967,7 @@ export const DocumentPermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
1949
1967
|
};
|
|
1950
1968
|
},
|
|
1951
1969
|
/**
|
|
1952
|
-
* Retrieves all permission assignments for the specified document, including user and group
|
|
1970
|
+
* Retrieves all permission assignments for the specified document, including user and group permissions with their roles and access levels. **Authorization**: Requires document editor or workspace manager permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
1953
1971
|
* @summary List document permissions
|
|
1954
1972
|
* @param {string} organizationName The unique identifier of the organization
|
|
1955
1973
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -1991,7 +2009,7 @@ export const DocumentPermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
1991
2009
|
};
|
|
1992
2010
|
},
|
|
1993
2011
|
/**
|
|
1994
|
-
* Updates the permission assignment for a user or group within the document,
|
|
2012
|
+
* Updates the permission assignment for a user or group within the document, modifying their role and access level. **Authorization**: Requires document editor or workspace manager permissions. **Validation**: Role changes are validated against document constraints.
|
|
1995
2013
|
* @summary Update document permission
|
|
1996
2014
|
* @param {string} organizationName The unique identifier of the organization
|
|
1997
2015
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2051,7 +2069,7 @@ export const DocumentPermissionsApiFp = function(configuration?: Configuration)
|
|
|
2051
2069
|
const localVarAxiosParamCreator = DocumentPermissionsApiAxiosParamCreator(configuration)
|
|
2052
2070
|
return {
|
|
2053
2071
|
/**
|
|
2054
|
-
* Creates a new permission assignment for a user or group within the document,
|
|
2072
|
+
* Creates a new permission assignment for a user or group within the document, granting them specific roles and access levels. Can also be used to request access to the document when the user doesn\'t have editor or workspace manager permissions. **Authorization**: Requires document editor or workspace manager permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports editor and viewer roles.
|
|
2055
2073
|
* @summary Create document permission
|
|
2056
2074
|
* @param {string} organizationName The unique identifier of the organization
|
|
2057
2075
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2068,7 +2086,7 @@ export const DocumentPermissionsApiFp = function(configuration?: Configuration)
|
|
|
2068
2086
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2069
2087
|
},
|
|
2070
2088
|
/**
|
|
2071
|
-
* Removes the permission assignment for a user or group within the document,
|
|
2089
|
+
* Removes the permission assignment for a user or group within the document, revoking their access to document resources. **Authorization**: Requires document editor or workspace manager permissions. **Side Effects**: User/group loses access to document resources.
|
|
2072
2090
|
* @summary Delete document permission
|
|
2073
2091
|
* @param {string} organizationName The unique identifier of the organization
|
|
2074
2092
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2084,7 +2102,7 @@ export const DocumentPermissionsApiFp = function(configuration?: Configuration)
|
|
|
2084
2102
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2085
2103
|
},
|
|
2086
2104
|
/**
|
|
2087
|
-
* Retrieves the permission details for a specific user or group within the document,
|
|
2105
|
+
* Retrieves the permission details for a specific user or group within the document, including their role and access level. **Authorization**: Requires document editor or workspace manager permissions. **Response**: Returns permission object with role and metadata.
|
|
2088
2106
|
* @summary Get document permission
|
|
2089
2107
|
* @param {string} organizationName The unique identifier of the organization
|
|
2090
2108
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2100,7 +2118,7 @@ export const DocumentPermissionsApiFp = function(configuration?: Configuration)
|
|
|
2100
2118
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2101
2119
|
},
|
|
2102
2120
|
/**
|
|
2103
|
-
* Retrieves all permission assignments for the specified document, including user and group
|
|
2121
|
+
* Retrieves all permission assignments for the specified document, including user and group permissions with their roles and access levels. **Authorization**: Requires document editor or workspace manager permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
2104
2122
|
* @summary List document permissions
|
|
2105
2123
|
* @param {string} organizationName The unique identifier of the organization
|
|
2106
2124
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2115,7 +2133,7 @@ export const DocumentPermissionsApiFp = function(configuration?: Configuration)
|
|
|
2115
2133
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2116
2134
|
},
|
|
2117
2135
|
/**
|
|
2118
|
-
* Updates the permission assignment for a user or group within the document,
|
|
2136
|
+
* Updates the permission assignment for a user or group within the document, modifying their role and access level. **Authorization**: Requires document editor or workspace manager permissions. **Validation**: Role changes are validated against document constraints.
|
|
2119
2137
|
* @summary Update document permission
|
|
2120
2138
|
* @param {string} organizationName The unique identifier of the organization
|
|
2121
2139
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2142,7 +2160,7 @@ export const DocumentPermissionsApiFactory = function (configuration?: Configura
|
|
|
2142
2160
|
const localVarFp = DocumentPermissionsApiFp(configuration)
|
|
2143
2161
|
return {
|
|
2144
2162
|
/**
|
|
2145
|
-
* Creates a new permission assignment for a user or group within the document,
|
|
2163
|
+
* Creates a new permission assignment for a user or group within the document, granting them specific roles and access levels. Can also be used to request access to the document when the user doesn\'t have editor or workspace manager permissions. **Authorization**: Requires document editor or workspace manager permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports editor and viewer roles.
|
|
2146
2164
|
* @summary Create document permission
|
|
2147
2165
|
* @param {string} organizationName The unique identifier of the organization
|
|
2148
2166
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2156,7 +2174,7 @@ export const DocumentPermissionsApiFactory = function (configuration?: Configura
|
|
|
2156
2174
|
return localVarFp.createDocumentPermission(organizationName, workspaceName, documentPath, requestPermission, documentPermission, options).then((request) => request(axios, basePath));
|
|
2157
2175
|
},
|
|
2158
2176
|
/**
|
|
2159
|
-
* Removes the permission assignment for a user or group within the document,
|
|
2177
|
+
* Removes the permission assignment for a user or group within the document, revoking their access to document resources. **Authorization**: Requires document editor or workspace manager permissions. **Side Effects**: User/group loses access to document resources.
|
|
2160
2178
|
* @summary Delete document permission
|
|
2161
2179
|
* @param {string} organizationName The unique identifier of the organization
|
|
2162
2180
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2169,7 +2187,7 @@ export const DocumentPermissionsApiFactory = function (configuration?: Configura
|
|
|
2169
2187
|
return localVarFp.deleteDocumentPermission(organizationName, workspaceName, documentPath, userGroupId, options).then((request) => request(axios, basePath));
|
|
2170
2188
|
},
|
|
2171
2189
|
/**
|
|
2172
|
-
* Retrieves the permission details for a specific user or group within the document,
|
|
2190
|
+
* Retrieves the permission details for a specific user or group within the document, including their role and access level. **Authorization**: Requires document editor or workspace manager permissions. **Response**: Returns permission object with role and metadata.
|
|
2173
2191
|
* @summary Get document permission
|
|
2174
2192
|
* @param {string} organizationName The unique identifier of the organization
|
|
2175
2193
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2182,7 +2200,7 @@ export const DocumentPermissionsApiFactory = function (configuration?: Configura
|
|
|
2182
2200
|
return localVarFp.getDocumentPermission(organizationName, workspaceName, documentPath, userGroupId, options).then((request) => request(axios, basePath));
|
|
2183
2201
|
},
|
|
2184
2202
|
/**
|
|
2185
|
-
* Retrieves all permission assignments for the specified document, including user and group
|
|
2203
|
+
* Retrieves all permission assignments for the specified document, including user and group permissions with their roles and access levels. **Authorization**: Requires document editor or workspace manager permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
2186
2204
|
* @summary List document permissions
|
|
2187
2205
|
* @param {string} organizationName The unique identifier of the organization
|
|
2188
2206
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2194,7 +2212,7 @@ export const DocumentPermissionsApiFactory = function (configuration?: Configura
|
|
|
2194
2212
|
return localVarFp.listDocumentPermissions(organizationName, workspaceName, documentPath, options).then((request) => request(axios, basePath));
|
|
2195
2213
|
},
|
|
2196
2214
|
/**
|
|
2197
|
-
* Updates the permission assignment for a user or group within the document,
|
|
2215
|
+
* Updates the permission assignment for a user or group within the document, modifying their role and access level. **Authorization**: Requires document editor or workspace manager permissions. **Validation**: Role changes are validated against document constraints.
|
|
2198
2216
|
* @summary Update document permission
|
|
2199
2217
|
* @param {string} organizationName The unique identifier of the organization
|
|
2200
2218
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2218,7 +2236,7 @@ export const DocumentPermissionsApiFactory = function (configuration?: Configura
|
|
|
2218
2236
|
*/
|
|
2219
2237
|
export class DocumentPermissionsApi extends BaseAPI {
|
|
2220
2238
|
/**
|
|
2221
|
-
* Creates a new permission assignment for a user or group within the document,
|
|
2239
|
+
* Creates a new permission assignment for a user or group within the document, granting them specific roles and access levels. Can also be used to request access to the document when the user doesn\'t have editor or workspace manager permissions. **Authorization**: Requires document editor or workspace manager permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports editor and viewer roles.
|
|
2222
2240
|
* @summary Create document permission
|
|
2223
2241
|
* @param {string} organizationName The unique identifier of the organization
|
|
2224
2242
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2234,7 +2252,7 @@ export class DocumentPermissionsApi extends BaseAPI {
|
|
|
2234
2252
|
}
|
|
2235
2253
|
|
|
2236
2254
|
/**
|
|
2237
|
-
* Removes the permission assignment for a user or group within the document,
|
|
2255
|
+
* Removes the permission assignment for a user or group within the document, revoking their access to document resources. **Authorization**: Requires document editor or workspace manager permissions. **Side Effects**: User/group loses access to document resources.
|
|
2238
2256
|
* @summary Delete document permission
|
|
2239
2257
|
* @param {string} organizationName The unique identifier of the organization
|
|
2240
2258
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2249,7 +2267,7 @@ export class DocumentPermissionsApi extends BaseAPI {
|
|
|
2249
2267
|
}
|
|
2250
2268
|
|
|
2251
2269
|
/**
|
|
2252
|
-
* Retrieves the permission details for a specific user or group within the document,
|
|
2270
|
+
* Retrieves the permission details for a specific user or group within the document, including their role and access level. **Authorization**: Requires document editor or workspace manager permissions. **Response**: Returns permission object with role and metadata.
|
|
2253
2271
|
* @summary Get document permission
|
|
2254
2272
|
* @param {string} organizationName The unique identifier of the organization
|
|
2255
2273
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2264,7 +2282,7 @@ export class DocumentPermissionsApi extends BaseAPI {
|
|
|
2264
2282
|
}
|
|
2265
2283
|
|
|
2266
2284
|
/**
|
|
2267
|
-
* Retrieves all permission assignments for the specified document, including user and group
|
|
2285
|
+
* Retrieves all permission assignments for the specified document, including user and group permissions with their roles and access levels. **Authorization**: Requires document editor or workspace manager permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
2268
2286
|
* @summary List document permissions
|
|
2269
2287
|
* @param {string} organizationName The unique identifier of the organization
|
|
2270
2288
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2278,7 +2296,7 @@ export class DocumentPermissionsApi extends BaseAPI {
|
|
|
2278
2296
|
}
|
|
2279
2297
|
|
|
2280
2298
|
/**
|
|
2281
|
-
* Updates the permission assignment for a user or group within the document,
|
|
2299
|
+
* Updates the permission assignment for a user or group within the document, modifying their role and access level. **Authorization**: Requires document editor or workspace manager permissions. **Validation**: Role changes are validated against document constraints.
|
|
2282
2300
|
* @summary Update document permission
|
|
2283
2301
|
* @param {string} organizationName The unique identifier of the organization
|
|
2284
2302
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2392,7 +2410,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2392
2410
|
};
|
|
2393
2411
|
},
|
|
2394
2412
|
/**
|
|
2395
|
-
* Retrieves detailed information about a specific document including content, metadata,
|
|
2413
|
+
* Retrieves detailed information about a specific document including content, metadata, and configuration details. **Authorization**: Requires read access to the document. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
2396
2414
|
* @summary Get document details
|
|
2397
2415
|
* @param {string} organizationName The unique identifier of the organization
|
|
2398
2416
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2439,7 +2457,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
2439
2457
|
};
|
|
2440
2458
|
},
|
|
2441
2459
|
/**
|
|
2442
|
-
* Retrieves all documents within the specified workspace, including workbooks, dashboards,
|
|
2460
|
+
* Retrieves all documents within the specified workspace, including workbooks, dashboards, and other content files. **Authorization**: Requires read access to the workspace. **Response**: Returns array of document objects with metadata and content information.
|
|
2443
2461
|
* @summary List workspace documents
|
|
2444
2462
|
* @param {string} organizationName The unique identifier of the organization
|
|
2445
2463
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2564,7 +2582,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
2564
2582
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2565
2583
|
},
|
|
2566
2584
|
/**
|
|
2567
|
-
* Retrieves detailed information about a specific document including content, metadata,
|
|
2585
|
+
* Retrieves detailed information about a specific document including content, metadata, and configuration details. **Authorization**: Requires read access to the document. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
2568
2586
|
* @summary Get document details
|
|
2569
2587
|
* @param {string} organizationName The unique identifier of the organization
|
|
2570
2588
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2580,7 +2598,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
2580
2598
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
2581
2599
|
},
|
|
2582
2600
|
/**
|
|
2583
|
-
* Retrieves all documents within the specified workspace, including workbooks, dashboards,
|
|
2601
|
+
* Retrieves all documents within the specified workspace, including workbooks, dashboards, and other content files. **Authorization**: Requires read access to the workspace. **Response**: Returns array of document objects with metadata and content information.
|
|
2584
2602
|
* @summary List workspace documents
|
|
2585
2603
|
* @param {string} organizationName The unique identifier of the organization
|
|
2586
2604
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2645,7 +2663,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
2645
2663
|
return localVarFp.deleteDocument(organizationName, workspaceName, documentPath, options).then((request) => request(axios, basePath));
|
|
2646
2664
|
},
|
|
2647
2665
|
/**
|
|
2648
|
-
* Retrieves detailed information about a specific document including content, metadata,
|
|
2666
|
+
* Retrieves detailed information about a specific document including content, metadata, and configuration details. **Authorization**: Requires read access to the document. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
2649
2667
|
* @summary Get document details
|
|
2650
2668
|
* @param {string} organizationName The unique identifier of the organization
|
|
2651
2669
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2658,7 +2676,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
2658
2676
|
return localVarFp.getDocument(organizationName, workspaceName, documentPath, checkAdmin, options).then((request) => request(axios, basePath));
|
|
2659
2677
|
},
|
|
2660
2678
|
/**
|
|
2661
|
-
* Retrieves all documents within the specified workspace, including workbooks, dashboards,
|
|
2679
|
+
* Retrieves all documents within the specified workspace, including workbooks, dashboards, and other content files. **Authorization**: Requires read access to the workspace. **Response**: Returns array of document objects with metadata and content information.
|
|
2662
2680
|
* @summary List workspace documents
|
|
2663
2681
|
* @param {string} organizationName The unique identifier of the organization
|
|
2664
2682
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2721,7 +2739,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
2721
2739
|
}
|
|
2722
2740
|
|
|
2723
2741
|
/**
|
|
2724
|
-
* Retrieves detailed information about a specific document including content, metadata,
|
|
2742
|
+
* Retrieves detailed information about a specific document including content, metadata, and configuration details. **Authorization**: Requires read access to the document. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
2725
2743
|
* @summary Get document details
|
|
2726
2744
|
* @param {string} organizationName The unique identifier of the organization
|
|
2727
2745
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2736,7 +2754,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
2736
2754
|
}
|
|
2737
2755
|
|
|
2738
2756
|
/**
|
|
2739
|
-
* Retrieves all documents within the specified workspace, including workbooks, dashboards,
|
|
2757
|
+
* Retrieves all documents within the specified workspace, including workbooks, dashboards, and other content files. **Authorization**: Requires read access to the workspace. **Response**: Returns array of document objects with metadata and content information.
|
|
2740
2758
|
* @summary List workspace documents
|
|
2741
2759
|
* @param {string} organizationName The unique identifier of the organization
|
|
2742
2760
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -2773,7 +2791,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
2773
2791
|
export const GroupsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
2774
2792
|
return {
|
|
2775
2793
|
/**
|
|
2776
|
-
* Adds new members to a group, including users and nested groups with their
|
|
2794
|
+
* Adds new members to a group, including users and nested groups with their specified roles and status. **Authorization**: Requires group admin permissions. **Members**: Supports adding users and other groups as members. **Roles**: Members can be assigned admin or member status.
|
|
2777
2795
|
* @summary Add group members
|
|
2778
2796
|
* @param {string} organizationName The unique identifier of the organization
|
|
2779
2797
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -2815,7 +2833,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2815
2833
|
};
|
|
2816
2834
|
},
|
|
2817
2835
|
/**
|
|
2818
|
-
* Creates a new user group within the organization for organizing users and
|
|
2836
|
+
* Creates a new user group within the organization for organizing users and managing group-based permissions. **Authorization**: Requires organization admin permissions. **Validation**: Group names must be unique within the organization.
|
|
2819
2837
|
* @summary Create user group
|
|
2820
2838
|
* @param {string} organizationName The unique identifier of the organization
|
|
2821
2839
|
* @param {Group} [group]
|
|
@@ -2853,7 +2871,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2853
2871
|
};
|
|
2854
2872
|
},
|
|
2855
2873
|
/**
|
|
2856
|
-
* Creates a new access token for the specified group. The token secret
|
|
2874
|
+
* Creates a new access token for the specified group. The token secret is only returned in the response to this creation request and cannot be retrieved later. **Authorization**: Requires group admin permissions. **Security**: Store the returned secret securely as it cannot be retrieved again.
|
|
2857
2875
|
* @summary Create a new group token
|
|
2858
2876
|
* @param {string} organizationName The unique identifier of the organization
|
|
2859
2877
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -2905,7 +2923,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2905
2923
|
};
|
|
2906
2924
|
},
|
|
2907
2925
|
/**
|
|
2908
|
-
* Permanently deletes a user group and removes all associated permissions.
|
|
2926
|
+
* Permanently deletes a user group and removes all associated permissions. This operation is irreversible. **Authorization**: Requires group admin or organization modeler permissions. **Warning**: This operation will remove all group permissions and memberships. **Side Effects**: Removes group from all permission assignments.
|
|
2909
2927
|
* @summary Delete user group
|
|
2910
2928
|
* @param {string} organizationName The unique identifier of the organization
|
|
2911
2929
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -2943,7 +2961,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2943
2961
|
};
|
|
2944
2962
|
},
|
|
2945
2963
|
/**
|
|
2946
|
-
* Deletes an existing group token. This action is irreversible and will
|
|
2964
|
+
* Deletes an existing group token. This action is irreversible and will immediately invalidate the token. **Authorization**: Requires group admin permissions. **Warning**: This operation cannot be undone and will immediately revoke access.
|
|
2947
2965
|
* @summary Delete a group token
|
|
2948
2966
|
* @param {string} organizationName The unique identifier of the organization
|
|
2949
2967
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -2985,7 +3003,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
2985
3003
|
};
|
|
2986
3004
|
},
|
|
2987
3005
|
/**
|
|
2988
|
-
* Retrieves detailed information about a specific group including metadata,
|
|
3006
|
+
* Retrieves detailed information about a specific group including metadata, description, and configuration details. **Authorization**: Requires read access to the group. **Response**: Returns complete group object with all metadata.
|
|
2989
3007
|
* @summary Get group details
|
|
2990
3008
|
* @param {string} organizationName The unique identifier of the organization
|
|
2991
3009
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3023,7 +3041,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3023
3041
|
};
|
|
3024
3042
|
},
|
|
3025
3043
|
/**
|
|
3026
|
-
* Retrieves all members of a group from FGA (Fine-Grained Authorization), including
|
|
3044
|
+
* Retrieves all members of a group from FGA (Fine-Grained Authorization), including users and nested groups with their membership status and roles. **Authorization**: Requires read access to the group. **Response**: Returns array of group members with status and resource identifiers.
|
|
3027
3045
|
* @summary Get group members
|
|
3028
3046
|
* @param {string} organizationName The unique identifier of the organization
|
|
3029
3047
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3061,7 +3079,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3061
3079
|
};
|
|
3062
3080
|
},
|
|
3063
3081
|
/**
|
|
3064
|
-
* Retrieves all access tokens for the specified group. Token secrets are
|
|
3082
|
+
* Retrieves all access tokens for the specified group. Token secrets are not included in the response for security reasons. **Authorization**: Requires group admin permissions. **Security**: Secrets are never returned in list operations.
|
|
3065
3083
|
* @summary List group tokens
|
|
3066
3084
|
* @param {string} organizationName The unique identifier of the organization
|
|
3067
3085
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3099,7 +3117,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3099
3117
|
};
|
|
3100
3118
|
},
|
|
3101
3119
|
/**
|
|
3102
|
-
* Retrieves all groups within the specified organization, including metadata such as
|
|
3120
|
+
* Retrieves all groups within the specified organization, including metadata such as names, descriptions, and member counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of group objects with full metadata.
|
|
3103
3121
|
* @summary List organization groups
|
|
3104
3122
|
* @param {string} organizationName The unique identifier of the organization
|
|
3105
3123
|
* @param {*} [options] Override http request option.
|
|
@@ -3133,7 +3151,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3133
3151
|
};
|
|
3134
3152
|
},
|
|
3135
3153
|
/**
|
|
3136
|
-
* Removes members from a group, revoking their group membership and associated
|
|
3154
|
+
* Removes members from a group, revoking their group membership and associated permissions. **Authorization**: Requires group admin permissions. **Members**: Supports removing users and nested groups from membership. **Side Effects**: Removed members lose group-based permissions.
|
|
3137
3155
|
* @summary Remove group members
|
|
3138
3156
|
* @param {string} organizationName The unique identifier of the organization
|
|
3139
3157
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3175,7 +3193,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3175
3193
|
};
|
|
3176
3194
|
},
|
|
3177
3195
|
/**
|
|
3178
|
-
* Updates the configuration and metadata of an existing group, including description
|
|
3196
|
+
* Updates the configuration and metadata of an existing group, including description and other group-level properties. **Authorization**: Requires group admin or organization modeler permissions. **Validation**: Updates are validated against group constraints.
|
|
3179
3197
|
* @summary Update group configuration
|
|
3180
3198
|
* @param {string} organizationName The unique identifier of the organization
|
|
3181
3199
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3217,7 +3235,7 @@ export const GroupsApiAxiosParamCreator = function (configuration?: Configuratio
|
|
|
3217
3235
|
};
|
|
3218
3236
|
},
|
|
3219
3237
|
/**
|
|
3220
|
-
* Updates a member\'s status (admin/member) in a group. This operation manages group
|
|
3238
|
+
* Updates a member\'s status (admin/member) in a group. This operation manages group membership through FGA (Fine-Grained Authorization) and affects the member\'s permissions within the group. **Authorization**: Requires group admin permissions. **Status**: Supports changing between admin and member roles. **Side Effects**: Status changes affect member permissions and capabilities.
|
|
3221
3239
|
* @summary Update group member status
|
|
3222
3240
|
* @param {string} organizationName The unique identifier of the organization
|
|
3223
3241
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3273,7 +3291,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3273
3291
|
const localVarAxiosParamCreator = GroupsApiAxiosParamCreator(configuration)
|
|
3274
3292
|
return {
|
|
3275
3293
|
/**
|
|
3276
|
-
* Adds new members to a group, including users and nested groups with their
|
|
3294
|
+
* Adds new members to a group, including users and nested groups with their specified roles and status. **Authorization**: Requires group admin permissions. **Members**: Supports adding users and other groups as members. **Roles**: Members can be assigned admin or member status.
|
|
3277
3295
|
* @summary Add group members
|
|
3278
3296
|
* @param {string} organizationName The unique identifier of the organization
|
|
3279
3297
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3288,7 +3306,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3288
3306
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3289
3307
|
},
|
|
3290
3308
|
/**
|
|
3291
|
-
* Creates a new user group within the organization for organizing users and
|
|
3309
|
+
* Creates a new user group within the organization for organizing users and managing group-based permissions. **Authorization**: Requires organization admin permissions. **Validation**: Group names must be unique within the organization.
|
|
3292
3310
|
* @summary Create user group
|
|
3293
3311
|
* @param {string} organizationName The unique identifier of the organization
|
|
3294
3312
|
* @param {Group} [group]
|
|
@@ -3302,7 +3320,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3302
3320
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3303
3321
|
},
|
|
3304
3322
|
/**
|
|
3305
|
-
* Creates a new access token for the specified group. The token secret
|
|
3323
|
+
* Creates a new access token for the specified group. The token secret is only returned in the response to this creation request and cannot be retrieved later. **Authorization**: Requires group admin permissions. **Security**: Store the returned secret securely as it cannot be retrieved again.
|
|
3306
3324
|
* @summary Create a new group token
|
|
3307
3325
|
* @param {string} organizationName The unique identifier of the organization
|
|
3308
3326
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3318,7 +3336,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3318
3336
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3319
3337
|
},
|
|
3320
3338
|
/**
|
|
3321
|
-
* Permanently deletes a user group and removes all associated permissions.
|
|
3339
|
+
* Permanently deletes a user group and removes all associated permissions. This operation is irreversible. **Authorization**: Requires group admin or organization modeler permissions. **Warning**: This operation will remove all group permissions and memberships. **Side Effects**: Removes group from all permission assignments.
|
|
3322
3340
|
* @summary Delete user group
|
|
3323
3341
|
* @param {string} organizationName The unique identifier of the organization
|
|
3324
3342
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3332,7 +3350,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3332
3350
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3333
3351
|
},
|
|
3334
3352
|
/**
|
|
3335
|
-
* Deletes an existing group token. This action is irreversible and will
|
|
3353
|
+
* Deletes an existing group token. This action is irreversible and will immediately invalidate the token. **Authorization**: Requires group admin permissions. **Warning**: This operation cannot be undone and will immediately revoke access.
|
|
3336
3354
|
* @summary Delete a group token
|
|
3337
3355
|
* @param {string} organizationName The unique identifier of the organization
|
|
3338
3356
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3347,7 +3365,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3347
3365
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3348
3366
|
},
|
|
3349
3367
|
/**
|
|
3350
|
-
* Retrieves detailed information about a specific group including metadata,
|
|
3368
|
+
* Retrieves detailed information about a specific group including metadata, description, and configuration details. **Authorization**: Requires read access to the group. **Response**: Returns complete group object with all metadata.
|
|
3351
3369
|
* @summary Get group details
|
|
3352
3370
|
* @param {string} organizationName The unique identifier of the organization
|
|
3353
3371
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3361,21 +3379,21 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3361
3379
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3362
3380
|
},
|
|
3363
3381
|
/**
|
|
3364
|
-
* Retrieves all members of a group from FGA (Fine-Grained Authorization), including
|
|
3382
|
+
* Retrieves all members of a group from FGA (Fine-Grained Authorization), including users and nested groups with their membership status and roles. **Authorization**: Requires read access to the group. **Response**: Returns array of group members with status and resource identifiers.
|
|
3365
3383
|
* @summary Get group members
|
|
3366
3384
|
* @param {string} organizationName The unique identifier of the organization
|
|
3367
3385
|
* @param {string} groupName The unique identifier of the group
|
|
3368
3386
|
* @param {*} [options] Override http request option.
|
|
3369
3387
|
* @throws {RequiredError}
|
|
3370
3388
|
*/
|
|
3371
|
-
async getGroupMembers(organizationName: string, groupName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
3389
|
+
async getGroupMembers(organizationName: string, groupName: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetGroupMembersResponse>> {
|
|
3372
3390
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getGroupMembers(organizationName, groupName, options);
|
|
3373
3391
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
3374
3392
|
const localVarOperationServerBasePath = operationServerMap['GroupsApi.getGroupMembers']?.[localVarOperationServerIndex]?.url;
|
|
3375
3393
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3376
3394
|
},
|
|
3377
3395
|
/**
|
|
3378
|
-
* Retrieves all access tokens for the specified group. Token secrets are
|
|
3396
|
+
* Retrieves all access tokens for the specified group. Token secrets are not included in the response for security reasons. **Authorization**: Requires group admin permissions. **Security**: Secrets are never returned in list operations.
|
|
3379
3397
|
* @summary List group tokens
|
|
3380
3398
|
* @param {string} organizationName The unique identifier of the organization
|
|
3381
3399
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3389,7 +3407,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3389
3407
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3390
3408
|
},
|
|
3391
3409
|
/**
|
|
3392
|
-
* Retrieves all groups within the specified organization, including metadata such as
|
|
3410
|
+
* Retrieves all groups within the specified organization, including metadata such as names, descriptions, and member counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of group objects with full metadata.
|
|
3393
3411
|
* @summary List organization groups
|
|
3394
3412
|
* @param {string} organizationName The unique identifier of the organization
|
|
3395
3413
|
* @param {*} [options] Override http request option.
|
|
@@ -3402,7 +3420,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3402
3420
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3403
3421
|
},
|
|
3404
3422
|
/**
|
|
3405
|
-
* Removes members from a group, revoking their group membership and associated
|
|
3423
|
+
* Removes members from a group, revoking their group membership and associated permissions. **Authorization**: Requires group admin permissions. **Members**: Supports removing users and nested groups from membership. **Side Effects**: Removed members lose group-based permissions.
|
|
3406
3424
|
* @summary Remove group members
|
|
3407
3425
|
* @param {string} organizationName The unique identifier of the organization
|
|
3408
3426
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3417,7 +3435,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3417
3435
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3418
3436
|
},
|
|
3419
3437
|
/**
|
|
3420
|
-
* Updates the configuration and metadata of an existing group, including description
|
|
3438
|
+
* Updates the configuration and metadata of an existing group, including description and other group-level properties. **Authorization**: Requires group admin or organization modeler permissions. **Validation**: Updates are validated against group constraints.
|
|
3421
3439
|
* @summary Update group configuration
|
|
3422
3440
|
* @param {string} organizationName The unique identifier of the organization
|
|
3423
3441
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3432,7 +3450,7 @@ export const GroupsApiFp = function(configuration?: Configuration) {
|
|
|
3432
3450
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
3433
3451
|
},
|
|
3434
3452
|
/**
|
|
3435
|
-
* Updates a member\'s status (admin/member) in a group. This operation manages group
|
|
3453
|
+
* Updates a member\'s status (admin/member) in a group. This operation manages group membership through FGA (Fine-Grained Authorization) and affects the member\'s permissions within the group. **Authorization**: Requires group admin permissions. **Status**: Supports changing between admin and member roles. **Side Effects**: Status changes affect member permissions and capabilities.
|
|
3436
3454
|
* @summary Update group member status
|
|
3437
3455
|
* @param {string} organizationName The unique identifier of the organization
|
|
3438
3456
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3458,7 +3476,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3458
3476
|
const localVarFp = GroupsApiFp(configuration)
|
|
3459
3477
|
return {
|
|
3460
3478
|
/**
|
|
3461
|
-
* Adds new members to a group, including users and nested groups with their
|
|
3479
|
+
* Adds new members to a group, including users and nested groups with their specified roles and status. **Authorization**: Requires group admin permissions. **Members**: Supports adding users and other groups as members. **Roles**: Members can be assigned admin or member status.
|
|
3462
3480
|
* @summary Add group members
|
|
3463
3481
|
* @param {string} organizationName The unique identifier of the organization
|
|
3464
3482
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3470,7 +3488,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3470
3488
|
return localVarFp.addGroupMembers(organizationName, groupName, addGroupMembersRequest, options).then((request) => request(axios, basePath));
|
|
3471
3489
|
},
|
|
3472
3490
|
/**
|
|
3473
|
-
* Creates a new user group within the organization for organizing users and
|
|
3491
|
+
* Creates a new user group within the organization for organizing users and managing group-based permissions. **Authorization**: Requires organization admin permissions. **Validation**: Group names must be unique within the organization.
|
|
3474
3492
|
* @summary Create user group
|
|
3475
3493
|
* @param {string} organizationName The unique identifier of the organization
|
|
3476
3494
|
* @param {Group} [group]
|
|
@@ -3481,7 +3499,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3481
3499
|
return localVarFp.createGroup(organizationName, group, options).then((request) => request(axios, basePath));
|
|
3482
3500
|
},
|
|
3483
3501
|
/**
|
|
3484
|
-
* Creates a new access token for the specified group. The token secret
|
|
3502
|
+
* Creates a new access token for the specified group. The token secret is only returned in the response to this creation request and cannot be retrieved later. **Authorization**: Requires group admin permissions. **Security**: Store the returned secret securely as it cannot be retrieved again.
|
|
3485
3503
|
* @summary Create a new group token
|
|
3486
3504
|
* @param {string} organizationName The unique identifier of the organization
|
|
3487
3505
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3494,7 +3512,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3494
3512
|
return localVarFp.createGroupAccessToken(organizationName, groupName, name, expiresAt, options).then((request) => request(axios, basePath));
|
|
3495
3513
|
},
|
|
3496
3514
|
/**
|
|
3497
|
-
* Permanently deletes a user group and removes all associated permissions.
|
|
3515
|
+
* Permanently deletes a user group and removes all associated permissions. This operation is irreversible. **Authorization**: Requires group admin or organization modeler permissions. **Warning**: This operation will remove all group permissions and memberships. **Side Effects**: Removes group from all permission assignments.
|
|
3498
3516
|
* @summary Delete user group
|
|
3499
3517
|
* @param {string} organizationName The unique identifier of the organization
|
|
3500
3518
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3505,7 +3523,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3505
3523
|
return localVarFp.deleteGroup(organizationName, groupName, options).then((request) => request(axios, basePath));
|
|
3506
3524
|
},
|
|
3507
3525
|
/**
|
|
3508
|
-
* Deletes an existing group token. This action is irreversible and will
|
|
3526
|
+
* Deletes an existing group token. This action is irreversible and will immediately invalidate the token. **Authorization**: Requires group admin permissions. **Warning**: This operation cannot be undone and will immediately revoke access.
|
|
3509
3527
|
* @summary Delete a group token
|
|
3510
3528
|
* @param {string} organizationName The unique identifier of the organization
|
|
3511
3529
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3517,7 +3535,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3517
3535
|
return localVarFp.deleteGroupAccessToken(organizationName, groupName, tokenName, options).then((request) => request(axios, basePath));
|
|
3518
3536
|
},
|
|
3519
3537
|
/**
|
|
3520
|
-
* Retrieves detailed information about a specific group including metadata,
|
|
3538
|
+
* Retrieves detailed information about a specific group including metadata, description, and configuration details. **Authorization**: Requires read access to the group. **Response**: Returns complete group object with all metadata.
|
|
3521
3539
|
* @summary Get group details
|
|
3522
3540
|
* @param {string} organizationName The unique identifier of the organization
|
|
3523
3541
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3528,18 +3546,18 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3528
3546
|
return localVarFp.getGroup(organizationName, groupName, options).then((request) => request(axios, basePath));
|
|
3529
3547
|
},
|
|
3530
3548
|
/**
|
|
3531
|
-
* Retrieves all members of a group from FGA (Fine-Grained Authorization), including
|
|
3549
|
+
* Retrieves all members of a group from FGA (Fine-Grained Authorization), including users and nested groups with their membership status and roles. **Authorization**: Requires read access to the group. **Response**: Returns array of group members with status and resource identifiers.
|
|
3532
3550
|
* @summary Get group members
|
|
3533
3551
|
* @param {string} organizationName The unique identifier of the organization
|
|
3534
3552
|
* @param {string} groupName The unique identifier of the group
|
|
3535
3553
|
* @param {*} [options] Override http request option.
|
|
3536
3554
|
* @throws {RequiredError}
|
|
3537
3555
|
*/
|
|
3538
|
-
getGroupMembers(organizationName: string, groupName: string, options?: RawAxiosRequestConfig): AxiosPromise<
|
|
3556
|
+
getGroupMembers(organizationName: string, groupName: string, options?: RawAxiosRequestConfig): AxiosPromise<GetGroupMembersResponse> {
|
|
3539
3557
|
return localVarFp.getGroupMembers(organizationName, groupName, options).then((request) => request(axios, basePath));
|
|
3540
3558
|
},
|
|
3541
3559
|
/**
|
|
3542
|
-
* Retrieves all access tokens for the specified group. Token secrets are
|
|
3560
|
+
* Retrieves all access tokens for the specified group. Token secrets are not included in the response for security reasons. **Authorization**: Requires group admin permissions. **Security**: Secrets are never returned in list operations.
|
|
3543
3561
|
* @summary List group tokens
|
|
3544
3562
|
* @param {string} organizationName The unique identifier of the organization
|
|
3545
3563
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3550,7 +3568,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3550
3568
|
return localVarFp.listGroupAccessTokens(organizationName, groupName, options).then((request) => request(axios, basePath));
|
|
3551
3569
|
},
|
|
3552
3570
|
/**
|
|
3553
|
-
* Retrieves all groups within the specified organization, including metadata such as
|
|
3571
|
+
* Retrieves all groups within the specified organization, including metadata such as names, descriptions, and member counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of group objects with full metadata.
|
|
3554
3572
|
* @summary List organization groups
|
|
3555
3573
|
* @param {string} organizationName The unique identifier of the organization
|
|
3556
3574
|
* @param {*} [options] Override http request option.
|
|
@@ -3560,7 +3578,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3560
3578
|
return localVarFp.listGroups(organizationName, options).then((request) => request(axios, basePath));
|
|
3561
3579
|
},
|
|
3562
3580
|
/**
|
|
3563
|
-
* Removes members from a group, revoking their group membership and associated
|
|
3581
|
+
* Removes members from a group, revoking their group membership and associated permissions. **Authorization**: Requires group admin permissions. **Members**: Supports removing users and nested groups from membership. **Side Effects**: Removed members lose group-based permissions.
|
|
3564
3582
|
* @summary Remove group members
|
|
3565
3583
|
* @param {string} organizationName The unique identifier of the organization
|
|
3566
3584
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3572,7 +3590,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3572
3590
|
return localVarFp.removeGroupMembers(organizationName, groupName, removeGroupMembersRequest, options).then((request) => request(axios, basePath));
|
|
3573
3591
|
},
|
|
3574
3592
|
/**
|
|
3575
|
-
* Updates the configuration and metadata of an existing group, including description
|
|
3593
|
+
* Updates the configuration and metadata of an existing group, including description and other group-level properties. **Authorization**: Requires group admin or organization modeler permissions. **Validation**: Updates are validated against group constraints.
|
|
3576
3594
|
* @summary Update group configuration
|
|
3577
3595
|
* @param {string} organizationName The unique identifier of the organization
|
|
3578
3596
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3584,7 +3602,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3584
3602
|
return localVarFp.updateGroup(organizationName, groupName, group, options).then((request) => request(axios, basePath));
|
|
3585
3603
|
},
|
|
3586
3604
|
/**
|
|
3587
|
-
* Updates a member\'s status (admin/member) in a group. This operation manages group
|
|
3605
|
+
* Updates a member\'s status (admin/member) in a group. This operation manages group membership through FGA (Fine-Grained Authorization) and affects the member\'s permissions within the group. **Authorization**: Requires group admin permissions. **Status**: Supports changing between admin and member roles. **Side Effects**: Status changes affect member permissions and capabilities.
|
|
3588
3606
|
* @summary Update group member status
|
|
3589
3607
|
* @param {string} organizationName The unique identifier of the organization
|
|
3590
3608
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3607,7 +3625,7 @@ export const GroupsApiFactory = function (configuration?: Configuration, basePat
|
|
|
3607
3625
|
*/
|
|
3608
3626
|
export class GroupsApi extends BaseAPI {
|
|
3609
3627
|
/**
|
|
3610
|
-
* Adds new members to a group, including users and nested groups with their
|
|
3628
|
+
* Adds new members to a group, including users and nested groups with their specified roles and status. **Authorization**: Requires group admin permissions. **Members**: Supports adding users and other groups as members. **Roles**: Members can be assigned admin or member status.
|
|
3611
3629
|
* @summary Add group members
|
|
3612
3630
|
* @param {string} organizationName The unique identifier of the organization
|
|
3613
3631
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3621,7 +3639,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3621
3639
|
}
|
|
3622
3640
|
|
|
3623
3641
|
/**
|
|
3624
|
-
* Creates a new user group within the organization for organizing users and
|
|
3642
|
+
* Creates a new user group within the organization for organizing users and managing group-based permissions. **Authorization**: Requires organization admin permissions. **Validation**: Group names must be unique within the organization.
|
|
3625
3643
|
* @summary Create user group
|
|
3626
3644
|
* @param {string} organizationName The unique identifier of the organization
|
|
3627
3645
|
* @param {Group} [group]
|
|
@@ -3634,7 +3652,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3634
3652
|
}
|
|
3635
3653
|
|
|
3636
3654
|
/**
|
|
3637
|
-
* Creates a new access token for the specified group. The token secret
|
|
3655
|
+
* Creates a new access token for the specified group. The token secret is only returned in the response to this creation request and cannot be retrieved later. **Authorization**: Requires group admin permissions. **Security**: Store the returned secret securely as it cannot be retrieved again.
|
|
3638
3656
|
* @summary Create a new group token
|
|
3639
3657
|
* @param {string} organizationName The unique identifier of the organization
|
|
3640
3658
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3649,7 +3667,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3649
3667
|
}
|
|
3650
3668
|
|
|
3651
3669
|
/**
|
|
3652
|
-
* Permanently deletes a user group and removes all associated permissions.
|
|
3670
|
+
* Permanently deletes a user group and removes all associated permissions. This operation is irreversible. **Authorization**: Requires group admin or organization modeler permissions. **Warning**: This operation will remove all group permissions and memberships. **Side Effects**: Removes group from all permission assignments.
|
|
3653
3671
|
* @summary Delete user group
|
|
3654
3672
|
* @param {string} organizationName The unique identifier of the organization
|
|
3655
3673
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3662,7 +3680,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3662
3680
|
}
|
|
3663
3681
|
|
|
3664
3682
|
/**
|
|
3665
|
-
* Deletes an existing group token. This action is irreversible and will
|
|
3683
|
+
* Deletes an existing group token. This action is irreversible and will immediately invalidate the token. **Authorization**: Requires group admin permissions. **Warning**: This operation cannot be undone and will immediately revoke access.
|
|
3666
3684
|
* @summary Delete a group token
|
|
3667
3685
|
* @param {string} organizationName The unique identifier of the organization
|
|
3668
3686
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3676,7 +3694,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3676
3694
|
}
|
|
3677
3695
|
|
|
3678
3696
|
/**
|
|
3679
|
-
* Retrieves detailed information about a specific group including metadata,
|
|
3697
|
+
* Retrieves detailed information about a specific group including metadata, description, and configuration details. **Authorization**: Requires read access to the group. **Response**: Returns complete group object with all metadata.
|
|
3680
3698
|
* @summary Get group details
|
|
3681
3699
|
* @param {string} organizationName The unique identifier of the organization
|
|
3682
3700
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3689,7 +3707,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3689
3707
|
}
|
|
3690
3708
|
|
|
3691
3709
|
/**
|
|
3692
|
-
* Retrieves all members of a group from FGA (Fine-Grained Authorization), including
|
|
3710
|
+
* Retrieves all members of a group from FGA (Fine-Grained Authorization), including users and nested groups with their membership status and roles. **Authorization**: Requires read access to the group. **Response**: Returns array of group members with status and resource identifiers.
|
|
3693
3711
|
* @summary Get group members
|
|
3694
3712
|
* @param {string} organizationName The unique identifier of the organization
|
|
3695
3713
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3702,7 +3720,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3702
3720
|
}
|
|
3703
3721
|
|
|
3704
3722
|
/**
|
|
3705
|
-
* Retrieves all access tokens for the specified group. Token secrets are
|
|
3723
|
+
* Retrieves all access tokens for the specified group. Token secrets are not included in the response for security reasons. **Authorization**: Requires group admin permissions. **Security**: Secrets are never returned in list operations.
|
|
3706
3724
|
* @summary List group tokens
|
|
3707
3725
|
* @param {string} organizationName The unique identifier of the organization
|
|
3708
3726
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3715,7 +3733,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3715
3733
|
}
|
|
3716
3734
|
|
|
3717
3735
|
/**
|
|
3718
|
-
* Retrieves all groups within the specified organization, including metadata such as
|
|
3736
|
+
* Retrieves all groups within the specified organization, including metadata such as names, descriptions, and member counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of group objects with full metadata.
|
|
3719
3737
|
* @summary List organization groups
|
|
3720
3738
|
* @param {string} organizationName The unique identifier of the organization
|
|
3721
3739
|
* @param {*} [options] Override http request option.
|
|
@@ -3727,7 +3745,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3727
3745
|
}
|
|
3728
3746
|
|
|
3729
3747
|
/**
|
|
3730
|
-
* Removes members from a group, revoking their group membership and associated
|
|
3748
|
+
* Removes members from a group, revoking their group membership and associated permissions. **Authorization**: Requires group admin permissions. **Members**: Supports removing users and nested groups from membership. **Side Effects**: Removed members lose group-based permissions.
|
|
3731
3749
|
* @summary Remove group members
|
|
3732
3750
|
* @param {string} organizationName The unique identifier of the organization
|
|
3733
3751
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3741,7 +3759,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3741
3759
|
}
|
|
3742
3760
|
|
|
3743
3761
|
/**
|
|
3744
|
-
* Updates the configuration and metadata of an existing group, including description
|
|
3762
|
+
* Updates the configuration and metadata of an existing group, including description and other group-level properties. **Authorization**: Requires group admin or organization modeler permissions. **Validation**: Updates are validated against group constraints.
|
|
3745
3763
|
* @summary Update group configuration
|
|
3746
3764
|
* @param {string} organizationName The unique identifier of the organization
|
|
3747
3765
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3755,7 +3773,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3755
3773
|
}
|
|
3756
3774
|
|
|
3757
3775
|
/**
|
|
3758
|
-
* Updates a member\'s status (admin/member) in a group. This operation manages group
|
|
3776
|
+
* Updates a member\'s status (admin/member) in a group. This operation manages group membership through FGA (Fine-Grained Authorization) and affects the member\'s permissions within the group. **Authorization**: Requires group admin permissions. **Status**: Supports changing between admin and member roles. **Side Effects**: Status changes affect member permissions and capabilities.
|
|
3759
3777
|
* @summary Update group member status
|
|
3760
3778
|
* @param {string} organizationName The unique identifier of the organization
|
|
3761
3779
|
* @param {string} groupName The unique identifier of the group
|
|
@@ -3779,7 +3797,7 @@ export class GroupsApi extends BaseAPI {
|
|
|
3779
3797
|
export const OrganizationPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
3780
3798
|
return {
|
|
3781
3799
|
/**
|
|
3782
|
-
* Creates a new permission assignment for a user or group within the organization,
|
|
3800
|
+
* Creates a new permission assignment for a user or group within the organization, granting them specific roles and access levels. Can also be used to request access to the organization when the user doesn\'t have admin permissions. **Authorization**: Requires organization admin permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports admin, modeler, and member roles.
|
|
3783
3801
|
* @summary Create organization permission
|
|
3784
3802
|
* @param {string} organizationName The unique identifier of the organization
|
|
3785
3803
|
* @param {boolean} [requestPermission] Indicates that the user is requesting access to the resource
|
|
@@ -3822,7 +3840,7 @@ export const OrganizationPermissionsApiAxiosParamCreator = function (configurati
|
|
|
3822
3840
|
};
|
|
3823
3841
|
},
|
|
3824
3842
|
/**
|
|
3825
|
-
* Removes the permission assignment for a user or group within the organization,
|
|
3843
|
+
* Removes the permission assignment for a user or group within the organization, revoking their access to organizational resources. **Authorization**: Requires organization admin permissions. **Side Effects**: User/group loses access to organization resources.
|
|
3826
3844
|
* @summary Delete organization permission
|
|
3827
3845
|
* @param {string} organizationName The unique identifier of the organization
|
|
3828
3846
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -3860,7 +3878,7 @@ export const OrganizationPermissionsApiAxiosParamCreator = function (configurati
|
|
|
3860
3878
|
};
|
|
3861
3879
|
},
|
|
3862
3880
|
/**
|
|
3863
|
-
* Retrieves the permission details for a specific user or group within the organization,
|
|
3881
|
+
* Retrieves the permission details for a specific user or group within the organization, including their role and access level. **Authorization**: Requires organization admin or modeler permissions. **Response**: Returns permission object with role and metadata.
|
|
3864
3882
|
* @summary Get organization permission
|
|
3865
3883
|
* @param {string} organizationName The unique identifier of the organization
|
|
3866
3884
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -3898,7 +3916,7 @@ export const OrganizationPermissionsApiAxiosParamCreator = function (configurati
|
|
|
3898
3916
|
};
|
|
3899
3917
|
},
|
|
3900
3918
|
/**
|
|
3901
|
-
* Retrieves all permission assignments for the specified organization, including user and group
|
|
3919
|
+
* Retrieves all permission assignments for the specified organization, including user and group permissions with their roles and access levels. **Authorization**: Requires organization admin or modeler permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
3902
3920
|
* @summary List organization permissions
|
|
3903
3921
|
* @param {string} organizationName The unique identifier of the organization
|
|
3904
3922
|
* @param {*} [options] Override http request option.
|
|
@@ -3932,7 +3950,7 @@ export const OrganizationPermissionsApiAxiosParamCreator = function (configurati
|
|
|
3932
3950
|
};
|
|
3933
3951
|
},
|
|
3934
3952
|
/**
|
|
3935
|
-
* Updates the permission assignment for a user or group within the organization,
|
|
3953
|
+
* Updates the permission assignment for a user or group within the organization, modifying their role and access level. **Authorization**: Requires organization admin permissions. **Validation**: Role changes are validated against organizational policies.
|
|
3936
3954
|
* @summary Update organization permission
|
|
3937
3955
|
* @param {string} organizationName The unique identifier of the organization
|
|
3938
3956
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -3984,7 +4002,7 @@ export const OrganizationPermissionsApiFp = function(configuration?: Configurati
|
|
|
3984
4002
|
const localVarAxiosParamCreator = OrganizationPermissionsApiAxiosParamCreator(configuration)
|
|
3985
4003
|
return {
|
|
3986
4004
|
/**
|
|
3987
|
-
* Creates a new permission assignment for a user or group within the organization,
|
|
4005
|
+
* Creates a new permission assignment for a user or group within the organization, granting them specific roles and access levels. Can also be used to request access to the organization when the user doesn\'t have admin permissions. **Authorization**: Requires organization admin permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports admin, modeler, and member roles.
|
|
3988
4006
|
* @summary Create organization permission
|
|
3989
4007
|
* @param {string} organizationName The unique identifier of the organization
|
|
3990
4008
|
* @param {boolean} [requestPermission] Indicates that the user is requesting access to the resource
|
|
@@ -3999,7 +4017,7 @@ export const OrganizationPermissionsApiFp = function(configuration?: Configurati
|
|
|
3999
4017
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4000
4018
|
},
|
|
4001
4019
|
/**
|
|
4002
|
-
* Removes the permission assignment for a user or group within the organization,
|
|
4020
|
+
* Removes the permission assignment for a user or group within the organization, revoking their access to organizational resources. **Authorization**: Requires organization admin permissions. **Side Effects**: User/group loses access to organization resources.
|
|
4003
4021
|
* @summary Delete organization permission
|
|
4004
4022
|
* @param {string} organizationName The unique identifier of the organization
|
|
4005
4023
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4013,7 +4031,7 @@ export const OrganizationPermissionsApiFp = function(configuration?: Configurati
|
|
|
4013
4031
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4014
4032
|
},
|
|
4015
4033
|
/**
|
|
4016
|
-
* Retrieves the permission details for a specific user or group within the organization,
|
|
4034
|
+
* Retrieves the permission details for a specific user or group within the organization, including their role and access level. **Authorization**: Requires organization admin or modeler permissions. **Response**: Returns permission object with role and metadata.
|
|
4017
4035
|
* @summary Get organization permission
|
|
4018
4036
|
* @param {string} organizationName The unique identifier of the organization
|
|
4019
4037
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4027,7 +4045,7 @@ export const OrganizationPermissionsApiFp = function(configuration?: Configurati
|
|
|
4027
4045
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4028
4046
|
},
|
|
4029
4047
|
/**
|
|
4030
|
-
* Retrieves all permission assignments for the specified organization, including user and group
|
|
4048
|
+
* Retrieves all permission assignments for the specified organization, including user and group permissions with their roles and access levels. **Authorization**: Requires organization admin or modeler permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
4031
4049
|
* @summary List organization permissions
|
|
4032
4050
|
* @param {string} organizationName The unique identifier of the organization
|
|
4033
4051
|
* @param {*} [options] Override http request option.
|
|
@@ -4040,7 +4058,7 @@ export const OrganizationPermissionsApiFp = function(configuration?: Configurati
|
|
|
4040
4058
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4041
4059
|
},
|
|
4042
4060
|
/**
|
|
4043
|
-
* Updates the permission assignment for a user or group within the organization,
|
|
4061
|
+
* Updates the permission assignment for a user or group within the organization, modifying their role and access level. **Authorization**: Requires organization admin permissions. **Validation**: Role changes are validated against organizational policies.
|
|
4044
4062
|
* @summary Update organization permission
|
|
4045
4063
|
* @param {string} organizationName The unique identifier of the organization
|
|
4046
4064
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4065,7 +4083,7 @@ export const OrganizationPermissionsApiFactory = function (configuration?: Confi
|
|
|
4065
4083
|
const localVarFp = OrganizationPermissionsApiFp(configuration)
|
|
4066
4084
|
return {
|
|
4067
4085
|
/**
|
|
4068
|
-
* Creates a new permission assignment for a user or group within the organization,
|
|
4086
|
+
* Creates a new permission assignment for a user or group within the organization, granting them specific roles and access levels. Can also be used to request access to the organization when the user doesn\'t have admin permissions. **Authorization**: Requires organization admin permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports admin, modeler, and member roles.
|
|
4069
4087
|
* @summary Create organization permission
|
|
4070
4088
|
* @param {string} organizationName The unique identifier of the organization
|
|
4071
4089
|
* @param {boolean} [requestPermission] Indicates that the user is requesting access to the resource
|
|
@@ -4077,7 +4095,7 @@ export const OrganizationPermissionsApiFactory = function (configuration?: Confi
|
|
|
4077
4095
|
return localVarFp.createOrganizationPermission(organizationName, requestPermission, organizationPermission, options).then((request) => request(axios, basePath));
|
|
4078
4096
|
},
|
|
4079
4097
|
/**
|
|
4080
|
-
* Removes the permission assignment for a user or group within the organization,
|
|
4098
|
+
* Removes the permission assignment for a user or group within the organization, revoking their access to organizational resources. **Authorization**: Requires organization admin permissions. **Side Effects**: User/group loses access to organization resources.
|
|
4081
4099
|
* @summary Delete organization permission
|
|
4082
4100
|
* @param {string} organizationName The unique identifier of the organization
|
|
4083
4101
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4088,7 +4106,7 @@ export const OrganizationPermissionsApiFactory = function (configuration?: Confi
|
|
|
4088
4106
|
return localVarFp.deleteOrganizationPermission(organizationName, userGroupId, options).then((request) => request(axios, basePath));
|
|
4089
4107
|
},
|
|
4090
4108
|
/**
|
|
4091
|
-
* Retrieves the permission details for a specific user or group within the organization,
|
|
4109
|
+
* Retrieves the permission details for a specific user or group within the organization, including their role and access level. **Authorization**: Requires organization admin or modeler permissions. **Response**: Returns permission object with role and metadata.
|
|
4092
4110
|
* @summary Get organization permission
|
|
4093
4111
|
* @param {string} organizationName The unique identifier of the organization
|
|
4094
4112
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4099,7 +4117,7 @@ export const OrganizationPermissionsApiFactory = function (configuration?: Confi
|
|
|
4099
4117
|
return localVarFp.getOrganizationPermission(organizationName, userGroupId, options).then((request) => request(axios, basePath));
|
|
4100
4118
|
},
|
|
4101
4119
|
/**
|
|
4102
|
-
* Retrieves all permission assignments for the specified organization, including user and group
|
|
4120
|
+
* Retrieves all permission assignments for the specified organization, including user and group permissions with their roles and access levels. **Authorization**: Requires organization admin or modeler permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
4103
4121
|
* @summary List organization permissions
|
|
4104
4122
|
* @param {string} organizationName The unique identifier of the organization
|
|
4105
4123
|
* @param {*} [options] Override http request option.
|
|
@@ -4109,7 +4127,7 @@ export const OrganizationPermissionsApiFactory = function (configuration?: Confi
|
|
|
4109
4127
|
return localVarFp.listOrganizationPermissions(organizationName, options).then((request) => request(axios, basePath));
|
|
4110
4128
|
},
|
|
4111
4129
|
/**
|
|
4112
|
-
* Updates the permission assignment for a user or group within the organization,
|
|
4130
|
+
* Updates the permission assignment for a user or group within the organization, modifying their role and access level. **Authorization**: Requires organization admin permissions. **Validation**: Role changes are validated against organizational policies.
|
|
4113
4131
|
* @summary Update organization permission
|
|
4114
4132
|
* @param {string} organizationName The unique identifier of the organization
|
|
4115
4133
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4131,7 +4149,7 @@ export const OrganizationPermissionsApiFactory = function (configuration?: Confi
|
|
|
4131
4149
|
*/
|
|
4132
4150
|
export class OrganizationPermissionsApi extends BaseAPI {
|
|
4133
4151
|
/**
|
|
4134
|
-
* Creates a new permission assignment for a user or group within the organization,
|
|
4152
|
+
* Creates a new permission assignment for a user or group within the organization, granting them specific roles and access levels. Can also be used to request access to the organization when the user doesn\'t have admin permissions. **Authorization**: Requires organization admin permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports admin, modeler, and member roles.
|
|
4135
4153
|
* @summary Create organization permission
|
|
4136
4154
|
* @param {string} organizationName The unique identifier of the organization
|
|
4137
4155
|
* @param {boolean} [requestPermission] Indicates that the user is requesting access to the resource
|
|
@@ -4145,7 +4163,7 @@ export class OrganizationPermissionsApi extends BaseAPI {
|
|
|
4145
4163
|
}
|
|
4146
4164
|
|
|
4147
4165
|
/**
|
|
4148
|
-
* Removes the permission assignment for a user or group within the organization,
|
|
4166
|
+
* Removes the permission assignment for a user or group within the organization, revoking their access to organizational resources. **Authorization**: Requires organization admin permissions. **Side Effects**: User/group loses access to organization resources.
|
|
4149
4167
|
* @summary Delete organization permission
|
|
4150
4168
|
* @param {string} organizationName The unique identifier of the organization
|
|
4151
4169
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4158,7 +4176,7 @@ export class OrganizationPermissionsApi extends BaseAPI {
|
|
|
4158
4176
|
}
|
|
4159
4177
|
|
|
4160
4178
|
/**
|
|
4161
|
-
* Retrieves the permission details for a specific user or group within the organization,
|
|
4179
|
+
* Retrieves the permission details for a specific user or group within the organization, including their role and access level. **Authorization**: Requires organization admin or modeler permissions. **Response**: Returns permission object with role and metadata.
|
|
4162
4180
|
* @summary Get organization permission
|
|
4163
4181
|
* @param {string} organizationName The unique identifier of the organization
|
|
4164
4182
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4171,7 +4189,7 @@ export class OrganizationPermissionsApi extends BaseAPI {
|
|
|
4171
4189
|
}
|
|
4172
4190
|
|
|
4173
4191
|
/**
|
|
4174
|
-
* Retrieves all permission assignments for the specified organization, including user and group
|
|
4192
|
+
* Retrieves all permission assignments for the specified organization, including user and group permissions with their roles and access levels. **Authorization**: Requires organization admin or modeler permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
4175
4193
|
* @summary List organization permissions
|
|
4176
4194
|
* @param {string} organizationName The unique identifier of the organization
|
|
4177
4195
|
* @param {*} [options] Override http request option.
|
|
@@ -4183,7 +4201,7 @@ export class OrganizationPermissionsApi extends BaseAPI {
|
|
|
4183
4201
|
}
|
|
4184
4202
|
|
|
4185
4203
|
/**
|
|
4186
|
-
* Updates the permission assignment for a user or group within the organization,
|
|
4204
|
+
* Updates the permission assignment for a user or group within the organization, modifying their role and access level. **Authorization**: Requires organization admin permissions. **Validation**: Role changes are validated against organizational policies.
|
|
4187
4205
|
* @summary Update organization permission
|
|
4188
4206
|
* @param {string} organizationName The unique identifier of the organization
|
|
4189
4207
|
* @param {string} userGroupId The unique identifier of the user or group
|
|
@@ -4206,7 +4224,7 @@ export class OrganizationPermissionsApi extends BaseAPI {
|
|
|
4206
4224
|
export const OrganizationsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
4207
4225
|
return {
|
|
4208
4226
|
/**
|
|
4209
|
-
* Creates a new organization with the specified configuration. Organizations serve as the top-level
|
|
4227
|
+
* Creates a new organization with the specified configuration. Organizations serve as the top-level container for all resources including projects, packages, workspaces, and user groups. **Authorization**: Requires system-level admin permissions or appropriate organizational creation rights. **Validation**: Organization names must be unique and follow naming conventions. **Side Effects**: Creates default permissions and initializes organizational structure.
|
|
4210
4228
|
* @summary Create a new organization
|
|
4211
4229
|
* @param {Organization} organization
|
|
4212
4230
|
* @param {*} [options] Override http request option.
|
|
@@ -4242,7 +4260,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4242
4260
|
};
|
|
4243
4261
|
},
|
|
4244
4262
|
/**
|
|
4245
|
-
* Permanently deletes an organization and all associated resources including projects,
|
|
4263
|
+
* Permanently deletes an organization and all associated resources including projects, packages, workspaces, and user groups. This operation is irreversible. **Authorization**: Requires organization admin permissions. **Warning**: This operation will cascade delete all child resources. **Side Effects**: Removes all data associated with the organization.
|
|
4246
4264
|
* @summary Delete an organization
|
|
4247
4265
|
* @param {string} organizationName The unique identifier of the organization to delete
|
|
4248
4266
|
* @param {*} [options] Override http request option.
|
|
@@ -4276,7 +4294,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4276
4294
|
};
|
|
4277
4295
|
},
|
|
4278
4296
|
/**
|
|
4279
|
-
* Retrieves detailed information about a specific organization including metadata,
|
|
4297
|
+
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details. **Authorization**: Requires read access to the specified organization. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
4280
4298
|
* @summary Get organization details
|
|
4281
4299
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4282
4300
|
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
@@ -4315,7 +4333,7 @@ export const OrganizationsApiAxiosParamCreator = function (configuration?: Confi
|
|
|
4315
4333
|
};
|
|
4316
4334
|
},
|
|
4317
4335
|
/**
|
|
4318
|
-
* Retrieves a comprehensive list of all organizations accessible to the authenticated user.
|
|
4336
|
+
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations. **Rate Limiting**: Standard rate limits apply.
|
|
4319
4337
|
* @summary List all organizations
|
|
4320
4338
|
* @param {*} [options] Override http request option.
|
|
4321
4339
|
* @throws {RequiredError}
|
|
@@ -4395,7 +4413,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
4395
4413
|
const localVarAxiosParamCreator = OrganizationsApiAxiosParamCreator(configuration)
|
|
4396
4414
|
return {
|
|
4397
4415
|
/**
|
|
4398
|
-
* Creates a new organization with the specified configuration. Organizations serve as the top-level
|
|
4416
|
+
* Creates a new organization with the specified configuration. Organizations serve as the top-level container for all resources including projects, packages, workspaces, and user groups. **Authorization**: Requires system-level admin permissions or appropriate organizational creation rights. **Validation**: Organization names must be unique and follow naming conventions. **Side Effects**: Creates default permissions and initializes organizational structure.
|
|
4399
4417
|
* @summary Create a new organization
|
|
4400
4418
|
* @param {Organization} organization
|
|
4401
4419
|
* @param {*} [options] Override http request option.
|
|
@@ -4408,7 +4426,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
4408
4426
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4409
4427
|
},
|
|
4410
4428
|
/**
|
|
4411
|
-
* Permanently deletes an organization and all associated resources including projects,
|
|
4429
|
+
* Permanently deletes an organization and all associated resources including projects, packages, workspaces, and user groups. This operation is irreversible. **Authorization**: Requires organization admin permissions. **Warning**: This operation will cascade delete all child resources. **Side Effects**: Removes all data associated with the organization.
|
|
4412
4430
|
* @summary Delete an organization
|
|
4413
4431
|
* @param {string} organizationName The unique identifier of the organization to delete
|
|
4414
4432
|
* @param {*} [options] Override http request option.
|
|
@@ -4421,7 +4439,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
4421
4439
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4422
4440
|
},
|
|
4423
4441
|
/**
|
|
4424
|
-
* Retrieves detailed information about a specific organization including metadata,
|
|
4442
|
+
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details. **Authorization**: Requires read access to the specified organization. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
4425
4443
|
* @summary Get organization details
|
|
4426
4444
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4427
4445
|
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
@@ -4435,7 +4453,7 @@ export const OrganizationsApiFp = function(configuration?: Configuration) {
|
|
|
4435
4453
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4436
4454
|
},
|
|
4437
4455
|
/**
|
|
4438
|
-
* Retrieves a comprehensive list of all organizations accessible to the authenticated user.
|
|
4456
|
+
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations. **Rate Limiting**: Standard rate limits apply.
|
|
4439
4457
|
* @summary List all organizations
|
|
4440
4458
|
* @param {*} [options] Override http request option.
|
|
4441
4459
|
* @throws {RequiredError}
|
|
@@ -4471,7 +4489,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
4471
4489
|
const localVarFp = OrganizationsApiFp(configuration)
|
|
4472
4490
|
return {
|
|
4473
4491
|
/**
|
|
4474
|
-
* Creates a new organization with the specified configuration. Organizations serve as the top-level
|
|
4492
|
+
* Creates a new organization with the specified configuration. Organizations serve as the top-level container for all resources including projects, packages, workspaces, and user groups. **Authorization**: Requires system-level admin permissions or appropriate organizational creation rights. **Validation**: Organization names must be unique and follow naming conventions. **Side Effects**: Creates default permissions and initializes organizational structure.
|
|
4475
4493
|
* @summary Create a new organization
|
|
4476
4494
|
* @param {Organization} organization
|
|
4477
4495
|
* @param {*} [options] Override http request option.
|
|
@@ -4481,7 +4499,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
4481
4499
|
return localVarFp.createOrganization(organization, options).then((request) => request(axios, basePath));
|
|
4482
4500
|
},
|
|
4483
4501
|
/**
|
|
4484
|
-
* Permanently deletes an organization and all associated resources including projects,
|
|
4502
|
+
* Permanently deletes an organization and all associated resources including projects, packages, workspaces, and user groups. This operation is irreversible. **Authorization**: Requires organization admin permissions. **Warning**: This operation will cascade delete all child resources. **Side Effects**: Removes all data associated with the organization.
|
|
4485
4503
|
* @summary Delete an organization
|
|
4486
4504
|
* @param {string} organizationName The unique identifier of the organization to delete
|
|
4487
4505
|
* @param {*} [options] Override http request option.
|
|
@@ -4491,7 +4509,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
4491
4509
|
return localVarFp.deleteOrganization(organizationName, options).then((request) => request(axios, basePath));
|
|
4492
4510
|
},
|
|
4493
4511
|
/**
|
|
4494
|
-
* Retrieves detailed information about a specific organization including metadata,
|
|
4512
|
+
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details. **Authorization**: Requires read access to the specified organization. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
4495
4513
|
* @summary Get organization details
|
|
4496
4514
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4497
4515
|
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
@@ -4502,7 +4520,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
4502
4520
|
return localVarFp.getOrganization(organizationName, checkAdmin, options).then((request) => request(axios, basePath));
|
|
4503
4521
|
},
|
|
4504
4522
|
/**
|
|
4505
|
-
* Retrieves a comprehensive list of all organizations accessible to the authenticated user.
|
|
4523
|
+
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations. **Rate Limiting**: Standard rate limits apply.
|
|
4506
4524
|
* @summary List all organizations
|
|
4507
4525
|
* @param {*} [options] Override http request option.
|
|
4508
4526
|
* @throws {RequiredError}
|
|
@@ -4532,7 +4550,7 @@ export const OrganizationsApiFactory = function (configuration?: Configuration,
|
|
|
4532
4550
|
*/
|
|
4533
4551
|
export class OrganizationsApi extends BaseAPI {
|
|
4534
4552
|
/**
|
|
4535
|
-
* Creates a new organization with the specified configuration. Organizations serve as the top-level
|
|
4553
|
+
* Creates a new organization with the specified configuration. Organizations serve as the top-level container for all resources including projects, packages, workspaces, and user groups. **Authorization**: Requires system-level admin permissions or appropriate organizational creation rights. **Validation**: Organization names must be unique and follow naming conventions. **Side Effects**: Creates default permissions and initializes organizational structure.
|
|
4536
4554
|
* @summary Create a new organization
|
|
4537
4555
|
* @param {Organization} organization
|
|
4538
4556
|
* @param {*} [options] Override http request option.
|
|
@@ -4544,7 +4562,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
4544
4562
|
}
|
|
4545
4563
|
|
|
4546
4564
|
/**
|
|
4547
|
-
* Permanently deletes an organization and all associated resources including projects,
|
|
4565
|
+
* Permanently deletes an organization and all associated resources including projects, packages, workspaces, and user groups. This operation is irreversible. **Authorization**: Requires organization admin permissions. **Warning**: This operation will cascade delete all child resources. **Side Effects**: Removes all data associated with the organization.
|
|
4548
4566
|
* @summary Delete an organization
|
|
4549
4567
|
* @param {string} organizationName The unique identifier of the organization to delete
|
|
4550
4568
|
* @param {*} [options] Override http request option.
|
|
@@ -4556,7 +4574,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
4556
4574
|
}
|
|
4557
4575
|
|
|
4558
4576
|
/**
|
|
4559
|
-
* Retrieves detailed information about a specific organization including metadata,
|
|
4577
|
+
* Retrieves detailed information about a specific organization including metadata, configuration, and administrative details. **Authorization**: Requires read access to the specified organization. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
4560
4578
|
* @summary Get organization details
|
|
4561
4579
|
* @param {string} organizationName The unique identifier of the organization to retrieve
|
|
4562
4580
|
* @param {boolean} [checkAdmin] If true, includes admin privilege verification in the response
|
|
@@ -4569,7 +4587,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
4569
4587
|
}
|
|
4570
4588
|
|
|
4571
4589
|
/**
|
|
4572
|
-
* Retrieves a comprehensive list of all organizations accessible to the authenticated user.
|
|
4590
|
+
* Retrieves a comprehensive list of all organizations accessible to the authenticated user. This endpoint returns organization metadata including names, display names, and timestamps. **Authorization**: Requires appropriate permissions to view organizations. **Rate Limiting**: Standard rate limits apply.
|
|
4573
4591
|
* @summary List all organizations
|
|
4574
4592
|
* @param {*} [options] Override http request option.
|
|
4575
4593
|
* @throws {RequiredError}
|
|
@@ -4602,7 +4620,7 @@ export class OrganizationsApi extends BaseAPI {
|
|
|
4602
4620
|
export const PackagePermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
4603
4621
|
return {
|
|
4604
4622
|
/**
|
|
4605
|
-
* Creates a new permission assignment for a user, group, or workspace within the package,
|
|
4623
|
+
* Creates a new permission assignment for a user, group, or workspace within the package, granting them specific roles and access levels. Can also be used to request access to the package when the user doesn\'t have admin or modeler permissions. **Authorization**: Requires package admin or modeler permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Notification**: Use `notifyPeople` to send email notifications to affected users.
|
|
4606
4624
|
* @summary Create package permission
|
|
4607
4625
|
* @param {string} organizationName The unique identifier of the organization
|
|
4608
4626
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4658,7 +4676,7 @@ export const PackagePermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
4658
4676
|
};
|
|
4659
4677
|
},
|
|
4660
4678
|
/**
|
|
4661
|
-
* Removes the permission assignment for a user, group, or workspace within the package,
|
|
4679
|
+
* Removes the permission assignment for a user, group, or workspace within the package, revoking their access to package resources. **Authorization**: Requires package admin or modeler permissions. **Side Effects**: User/group/workspace loses access to package resources.
|
|
4662
4680
|
* @summary Delete package permission
|
|
4663
4681
|
* @param {string} organizationName The unique identifier of the organization
|
|
4664
4682
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4704,7 +4722,7 @@ export const PackagePermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
4704
4722
|
};
|
|
4705
4723
|
},
|
|
4706
4724
|
/**
|
|
4707
|
-
* Retrieves the permission details for a specific user, group within the package,
|
|
4725
|
+
* Retrieves the permission details for a specific user, group within the package, including their role and access level. **Authorization**: Requires package admin or modeler permissions. **Response**: Returns permission object with role and metadata.
|
|
4708
4726
|
* @summary Get package permission
|
|
4709
4727
|
* @param {string} organizationName The unique identifier of the organization
|
|
4710
4728
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4750,7 +4768,7 @@ export const PackagePermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
4750
4768
|
};
|
|
4751
4769
|
},
|
|
4752
4770
|
/**
|
|
4753
|
-
* Retrieves all permission assignments for the specified package, including user and group
|
|
4771
|
+
* Retrieves all permission assignments for the specified package, including user and group permissions with their roles and access levels. **Authorization**: Requires package admin or modeler permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
4754
4772
|
* @summary List package permissions
|
|
4755
4773
|
* @param {string} organizationName The unique identifier of the organization
|
|
4756
4774
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4792,7 +4810,7 @@ export const PackagePermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
4792
4810
|
};
|
|
4793
4811
|
},
|
|
4794
4812
|
/**
|
|
4795
|
-
* Updates the permission assignment for a user, group, or workspace within the package,
|
|
4813
|
+
* Updates the permission assignment for a user, group, or workspace within the package, modifying their role and access level. **Authorization**: Requires package admin or modeler permissions. **Validation**: Role changes are validated against package constraints.
|
|
4796
4814
|
* @summary Update package permission
|
|
4797
4815
|
* @param {string} organizationName The unique identifier of the organization
|
|
4798
4816
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4852,7 +4870,7 @@ export const PackagePermissionsApiFp = function(configuration?: Configuration) {
|
|
|
4852
4870
|
const localVarAxiosParamCreator = PackagePermissionsApiAxiosParamCreator(configuration)
|
|
4853
4871
|
return {
|
|
4854
4872
|
/**
|
|
4855
|
-
* Creates a new permission assignment for a user, group, or workspace within the package,
|
|
4873
|
+
* Creates a new permission assignment for a user, group, or workspace within the package, granting them specific roles and access levels. Can also be used to request access to the package when the user doesn\'t have admin or modeler permissions. **Authorization**: Requires package admin or modeler permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Notification**: Use `notifyPeople` to send email notifications to affected users.
|
|
4856
4874
|
* @summary Create package permission
|
|
4857
4875
|
* @param {string} organizationName The unique identifier of the organization
|
|
4858
4876
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4870,7 +4888,7 @@ export const PackagePermissionsApiFp = function(configuration?: Configuration) {
|
|
|
4870
4888
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4871
4889
|
},
|
|
4872
4890
|
/**
|
|
4873
|
-
* Removes the permission assignment for a user, group, or workspace within the package,
|
|
4891
|
+
* Removes the permission assignment for a user, group, or workspace within the package, revoking their access to package resources. **Authorization**: Requires package admin or modeler permissions. **Side Effects**: User/group/workspace loses access to package resources.
|
|
4874
4892
|
* @summary Delete package permission
|
|
4875
4893
|
* @param {string} organizationName The unique identifier of the organization
|
|
4876
4894
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4886,7 +4904,7 @@ export const PackagePermissionsApiFp = function(configuration?: Configuration) {
|
|
|
4886
4904
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4887
4905
|
},
|
|
4888
4906
|
/**
|
|
4889
|
-
* Retrieves the permission details for a specific user, group within the package,
|
|
4907
|
+
* Retrieves the permission details for a specific user, group within the package, including their role and access level. **Authorization**: Requires package admin or modeler permissions. **Response**: Returns permission object with role and metadata.
|
|
4890
4908
|
* @summary Get package permission
|
|
4891
4909
|
* @param {string} organizationName The unique identifier of the organization
|
|
4892
4910
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4902,7 +4920,7 @@ export const PackagePermissionsApiFp = function(configuration?: Configuration) {
|
|
|
4902
4920
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4903
4921
|
},
|
|
4904
4922
|
/**
|
|
4905
|
-
* Retrieves all permission assignments for the specified package, including user and group
|
|
4923
|
+
* Retrieves all permission assignments for the specified package, including user and group permissions with their roles and access levels. **Authorization**: Requires package admin or modeler permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
4906
4924
|
* @summary List package permissions
|
|
4907
4925
|
* @param {string} organizationName The unique identifier of the organization
|
|
4908
4926
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4917,7 +4935,7 @@ export const PackagePermissionsApiFp = function(configuration?: Configuration) {
|
|
|
4917
4935
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
4918
4936
|
},
|
|
4919
4937
|
/**
|
|
4920
|
-
* Updates the permission assignment for a user, group, or workspace within the package,
|
|
4938
|
+
* Updates the permission assignment for a user, group, or workspace within the package, modifying their role and access level. **Authorization**: Requires package admin or modeler permissions. **Validation**: Role changes are validated against package constraints.
|
|
4921
4939
|
* @summary Update package permission
|
|
4922
4940
|
* @param {string} organizationName The unique identifier of the organization
|
|
4923
4941
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4944,7 +4962,7 @@ export const PackagePermissionsApiFactory = function (configuration?: Configurat
|
|
|
4944
4962
|
const localVarFp = PackagePermissionsApiFp(configuration)
|
|
4945
4963
|
return {
|
|
4946
4964
|
/**
|
|
4947
|
-
* Creates a new permission assignment for a user, group, or workspace within the package,
|
|
4965
|
+
* Creates a new permission assignment for a user, group, or workspace within the package, granting them specific roles and access levels. Can also be used to request access to the package when the user doesn\'t have admin or modeler permissions. **Authorization**: Requires package admin or modeler permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Notification**: Use `notifyPeople` to send email notifications to affected users.
|
|
4948
4966
|
* @summary Create package permission
|
|
4949
4967
|
* @param {string} organizationName The unique identifier of the organization
|
|
4950
4968
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4959,7 +4977,7 @@ export const PackagePermissionsApiFactory = function (configuration?: Configurat
|
|
|
4959
4977
|
return localVarFp.createPackagePermission(organizationName, projectName, packageName, requestPermission, notifyPeople, packagePermission, options).then((request) => request(axios, basePath));
|
|
4960
4978
|
},
|
|
4961
4979
|
/**
|
|
4962
|
-
* Removes the permission assignment for a user, group, or workspace within the package,
|
|
4980
|
+
* Removes the permission assignment for a user, group, or workspace within the package, revoking their access to package resources. **Authorization**: Requires package admin or modeler permissions. **Side Effects**: User/group/workspace loses access to package resources.
|
|
4963
4981
|
* @summary Delete package permission
|
|
4964
4982
|
* @param {string} organizationName The unique identifier of the organization
|
|
4965
4983
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4972,7 +4990,7 @@ export const PackagePermissionsApiFactory = function (configuration?: Configurat
|
|
|
4972
4990
|
return localVarFp.deletePackagePermission(organizationName, projectName, packageName, userGroupId, options).then((request) => request(axios, basePath));
|
|
4973
4991
|
},
|
|
4974
4992
|
/**
|
|
4975
|
-
* Retrieves the permission details for a specific user, group within the package,
|
|
4993
|
+
* Retrieves the permission details for a specific user, group within the package, including their role and access level. **Authorization**: Requires package admin or modeler permissions. **Response**: Returns permission object with role and metadata.
|
|
4976
4994
|
* @summary Get package permission
|
|
4977
4995
|
* @param {string} organizationName The unique identifier of the organization
|
|
4978
4996
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4985,7 +5003,7 @@ export const PackagePermissionsApiFactory = function (configuration?: Configurat
|
|
|
4985
5003
|
return localVarFp.getPackagePermission(organizationName, projectName, packageName, userGroupId, options).then((request) => request(axios, basePath));
|
|
4986
5004
|
},
|
|
4987
5005
|
/**
|
|
4988
|
-
* Retrieves all permission assignments for the specified package, including user and group
|
|
5006
|
+
* Retrieves all permission assignments for the specified package, including user and group permissions with their roles and access levels. **Authorization**: Requires package admin or modeler permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
4989
5007
|
* @summary List package permissions
|
|
4990
5008
|
* @param {string} organizationName The unique identifier of the organization
|
|
4991
5009
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -4997,7 +5015,7 @@ export const PackagePermissionsApiFactory = function (configuration?: Configurat
|
|
|
4997
5015
|
return localVarFp.listPackagePermissions(organizationName, projectName, packageName, options).then((request) => request(axios, basePath));
|
|
4998
5016
|
},
|
|
4999
5017
|
/**
|
|
5000
|
-
* Updates the permission assignment for a user, group, or workspace within the package,
|
|
5018
|
+
* Updates the permission assignment for a user, group, or workspace within the package, modifying their role and access level. **Authorization**: Requires package admin or modeler permissions. **Validation**: Role changes are validated against package constraints.
|
|
5001
5019
|
* @summary Update package permission
|
|
5002
5020
|
* @param {string} organizationName The unique identifier of the organization
|
|
5003
5021
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5021,7 +5039,7 @@ export const PackagePermissionsApiFactory = function (configuration?: Configurat
|
|
|
5021
5039
|
*/
|
|
5022
5040
|
export class PackagePermissionsApi extends BaseAPI {
|
|
5023
5041
|
/**
|
|
5024
|
-
* Creates a new permission assignment for a user, group, or workspace within the package,
|
|
5042
|
+
* Creates a new permission assignment for a user, group, or workspace within the package, granting them specific roles and access levels. Can also be used to request access to the package when the user doesn\'t have admin or modeler permissions. **Authorization**: Requires package admin or modeler permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Notification**: Use `notifyPeople` to send email notifications to affected users.
|
|
5025
5043
|
* @summary Create package permission
|
|
5026
5044
|
* @param {string} organizationName The unique identifier of the organization
|
|
5027
5045
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5038,7 +5056,7 @@ export class PackagePermissionsApi extends BaseAPI {
|
|
|
5038
5056
|
}
|
|
5039
5057
|
|
|
5040
5058
|
/**
|
|
5041
|
-
* Removes the permission assignment for a user, group, or workspace within the package,
|
|
5059
|
+
* Removes the permission assignment for a user, group, or workspace within the package, revoking their access to package resources. **Authorization**: Requires package admin or modeler permissions. **Side Effects**: User/group/workspace loses access to package resources.
|
|
5042
5060
|
* @summary Delete package permission
|
|
5043
5061
|
* @param {string} organizationName The unique identifier of the organization
|
|
5044
5062
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5053,7 +5071,7 @@ export class PackagePermissionsApi extends BaseAPI {
|
|
|
5053
5071
|
}
|
|
5054
5072
|
|
|
5055
5073
|
/**
|
|
5056
|
-
* Retrieves the permission details for a specific user, group within the package,
|
|
5074
|
+
* Retrieves the permission details for a specific user, group within the package, including their role and access level. **Authorization**: Requires package admin or modeler permissions. **Response**: Returns permission object with role and metadata.
|
|
5057
5075
|
* @summary Get package permission
|
|
5058
5076
|
* @param {string} organizationName The unique identifier of the organization
|
|
5059
5077
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5068,7 +5086,7 @@ export class PackagePermissionsApi extends BaseAPI {
|
|
|
5068
5086
|
}
|
|
5069
5087
|
|
|
5070
5088
|
/**
|
|
5071
|
-
* Retrieves all permission assignments for the specified package, including user and group
|
|
5089
|
+
* Retrieves all permission assignments for the specified package, including user and group permissions with their roles and access levels. **Authorization**: Requires package admin or modeler permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
5072
5090
|
* @summary List package permissions
|
|
5073
5091
|
* @param {string} organizationName The unique identifier of the organization
|
|
5074
5092
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5082,7 +5100,7 @@ export class PackagePermissionsApi extends BaseAPI {
|
|
|
5082
5100
|
}
|
|
5083
5101
|
|
|
5084
5102
|
/**
|
|
5085
|
-
* Updates the permission assignment for a user, group, or workspace within the package,
|
|
5103
|
+
* Updates the permission assignment for a user, group, or workspace within the package, modifying their role and access level. **Authorization**: Requires package admin or modeler permissions. **Validation**: Role changes are validated against package constraints.
|
|
5086
5104
|
* @summary Update package permission
|
|
5087
5105
|
* @param {string} organizationName The unique identifier of the organization
|
|
5088
5106
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5107,7 +5125,7 @@ export class PackagePermissionsApi extends BaseAPI {
|
|
|
5107
5125
|
export const PackagesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
5108
5126
|
return {
|
|
5109
5127
|
/**
|
|
5110
|
-
* Creates a new package or updates an existing one with a new version. This endpoint
|
|
5128
|
+
* Creates a new package or updates an existing one with a new version. This endpoint handles both package metadata and file uploads for package content. **Authorization**: Requires package admin or modeler permissions. **Content**: Accepts multipart form data with package metadata and binary file content. **Validation**: Validates package structure and file integrity using MD5 hash.
|
|
5111
5129
|
* @summary Create or update package
|
|
5112
5130
|
* @param {string} organizationName The unique identifier of the organization
|
|
5113
5131
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5215,7 +5233,7 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5215
5233
|
};
|
|
5216
5234
|
},
|
|
5217
5235
|
/**
|
|
5218
|
-
* Retrieves detailed information about a specific package including metadata, version
|
|
5236
|
+
* Retrieves detailed information about a specific package including metadata, version information, and configuration details. **Authorization**: Requires read access to the package. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
5219
5237
|
* @summary Get package details
|
|
5220
5238
|
* @param {string} organizationName The unique identifier of the organization
|
|
5221
5239
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5262,7 +5280,7 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5262
5280
|
};
|
|
5263
5281
|
},
|
|
5264
5282
|
/**
|
|
5265
|
-
* Retrieves all packages within the specified project, including metadata such as names,
|
|
5283
|
+
* Retrieves all packages within the specified project, including metadata such as names, descriptions, latest versions, and creation timestamps. **Authorization**: Requires read access to the project. **Response**: Returns array of package objects with full metadata.
|
|
5266
5284
|
* @summary List packages in project
|
|
5267
5285
|
* @param {string} organizationName The unique identifier of the organization
|
|
5268
5286
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5335,7 +5353,7 @@ export const PackagesApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
5335
5353
|
};
|
|
5336
5354
|
},
|
|
5337
5355
|
/**
|
|
5338
|
-
* Updates the metadata and configuration of an existing package, including description,
|
|
5356
|
+
* Updates the metadata and configuration of an existing package, including description, settings, and other package-level properties. **Authorization**: Requires package admin or modeler permissions. **Validation**: Updates are validated against package constraints and naming rules.
|
|
5339
5357
|
* @summary Update package metadata
|
|
5340
5358
|
* @param {string} organizationName The unique identifier of the organization
|
|
5341
5359
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5393,7 +5411,7 @@ export const PackagesApiFp = function(configuration?: Configuration) {
|
|
|
5393
5411
|
const localVarAxiosParamCreator = PackagesApiAxiosParamCreator(configuration)
|
|
5394
5412
|
return {
|
|
5395
5413
|
/**
|
|
5396
|
-
* Creates a new package or updates an existing one with a new version. This endpoint
|
|
5414
|
+
* Creates a new package or updates an existing one with a new version. This endpoint handles both package metadata and file uploads for package content. **Authorization**: Requires package admin or modeler permissions. **Content**: Accepts multipart form data with package metadata and binary file content. **Validation**: Validates package structure and file integrity using MD5 hash.
|
|
5397
5415
|
* @summary Create or update package
|
|
5398
5416
|
* @param {string} organizationName The unique identifier of the organization
|
|
5399
5417
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5427,7 +5445,7 @@ export const PackagesApiFp = function(configuration?: Configuration) {
|
|
|
5427
5445
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5428
5446
|
},
|
|
5429
5447
|
/**
|
|
5430
|
-
* Retrieves detailed information about a specific package including metadata, version
|
|
5448
|
+
* Retrieves detailed information about a specific package including metadata, version information, and configuration details. **Authorization**: Requires read access to the package. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
5431
5449
|
* @summary Get package details
|
|
5432
5450
|
* @param {string} organizationName The unique identifier of the organization
|
|
5433
5451
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5443,7 +5461,7 @@ export const PackagesApiFp = function(configuration?: Configuration) {
|
|
|
5443
5461
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5444
5462
|
},
|
|
5445
5463
|
/**
|
|
5446
|
-
* Retrieves all packages within the specified project, including metadata such as names,
|
|
5464
|
+
* Retrieves all packages within the specified project, including metadata such as names, descriptions, latest versions, and creation timestamps. **Authorization**: Requires read access to the project. **Response**: Returns array of package objects with full metadata.
|
|
5447
5465
|
* @summary List packages in project
|
|
5448
5466
|
* @param {string} organizationName The unique identifier of the organization
|
|
5449
5467
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5471,7 +5489,7 @@ export const PackagesApiFp = function(configuration?: Configuration) {
|
|
|
5471
5489
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
5472
5490
|
},
|
|
5473
5491
|
/**
|
|
5474
|
-
* Updates the metadata and configuration of an existing package, including description,
|
|
5492
|
+
* Updates the metadata and configuration of an existing package, including description, settings, and other package-level properties. **Authorization**: Requires package admin or modeler permissions. **Validation**: Updates are validated against package constraints and naming rules.
|
|
5475
5493
|
* @summary Update package metadata
|
|
5476
5494
|
* @param {string} organizationName The unique identifier of the organization
|
|
5477
5495
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5497,7 +5515,7 @@ export const PackagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
5497
5515
|
const localVarFp = PackagesApiFp(configuration)
|
|
5498
5516
|
return {
|
|
5499
5517
|
/**
|
|
5500
|
-
* Creates a new package or updates an existing one with a new version. This endpoint
|
|
5518
|
+
* Creates a new package or updates an existing one with a new version. This endpoint handles both package metadata and file uploads for package content. **Authorization**: Requires package admin or modeler permissions. **Content**: Accepts multipart form data with package metadata and binary file content. **Validation**: Validates package structure and file integrity using MD5 hash.
|
|
5501
5519
|
* @summary Create or update package
|
|
5502
5520
|
* @param {string} organizationName The unique identifier of the organization
|
|
5503
5521
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5525,7 +5543,7 @@ export const PackagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
5525
5543
|
return localVarFp.deletePackage(organizationName, projectName, packageName, options).then((request) => request(axios, basePath));
|
|
5526
5544
|
},
|
|
5527
5545
|
/**
|
|
5528
|
-
* Retrieves detailed information about a specific package including metadata, version
|
|
5546
|
+
* Retrieves detailed information about a specific package including metadata, version information, and configuration details. **Authorization**: Requires read access to the package. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
5529
5547
|
* @summary Get package details
|
|
5530
5548
|
* @param {string} organizationName The unique identifier of the organization
|
|
5531
5549
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5538,7 +5556,7 @@ export const PackagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
5538
5556
|
return localVarFp.getPackage(organizationName, projectName, packageName, checkAdmin, options).then((request) => request(axios, basePath));
|
|
5539
5557
|
},
|
|
5540
5558
|
/**
|
|
5541
|
-
* Retrieves all packages within the specified project, including metadata such as names,
|
|
5559
|
+
* Retrieves all packages within the specified project, including metadata such as names, descriptions, latest versions, and creation timestamps. **Authorization**: Requires read access to the project. **Response**: Returns array of package objects with full metadata.
|
|
5542
5560
|
* @summary List packages in project
|
|
5543
5561
|
* @param {string} organizationName The unique identifier of the organization
|
|
5544
5562
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5560,7 +5578,7 @@ export const PackagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
5560
5578
|
return localVarFp.listShareablePackages(organizationName, options).then((request) => request(axios, basePath));
|
|
5561
5579
|
},
|
|
5562
5580
|
/**
|
|
5563
|
-
* Updates the metadata and configuration of an existing package, including description,
|
|
5581
|
+
* Updates the metadata and configuration of an existing package, including description, settings, and other package-level properties. **Authorization**: Requires package admin or modeler permissions. **Validation**: Updates are validated against package constraints and naming rules.
|
|
5564
5582
|
* @summary Update package metadata
|
|
5565
5583
|
* @param {string} organizationName The unique identifier of the organization
|
|
5566
5584
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5583,7 +5601,7 @@ export const PackagesApiFactory = function (configuration?: Configuration, baseP
|
|
|
5583
5601
|
*/
|
|
5584
5602
|
export class PackagesApi extends BaseAPI {
|
|
5585
5603
|
/**
|
|
5586
|
-
* Creates a new package or updates an existing one with a new version. This endpoint
|
|
5604
|
+
* Creates a new package or updates an existing one with a new version. This endpoint handles both package metadata and file uploads for package content. **Authorization**: Requires package admin or modeler permissions. **Content**: Accepts multipart form data with package metadata and binary file content. **Validation**: Validates package structure and file integrity using MD5 hash.
|
|
5587
5605
|
* @summary Create or update package
|
|
5588
5606
|
* @param {string} organizationName The unique identifier of the organization
|
|
5589
5607
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5615,7 +5633,7 @@ export class PackagesApi extends BaseAPI {
|
|
|
5615
5633
|
}
|
|
5616
5634
|
|
|
5617
5635
|
/**
|
|
5618
|
-
* Retrieves detailed information about a specific package including metadata, version
|
|
5636
|
+
* Retrieves detailed information about a specific package including metadata, version information, and configuration details. **Authorization**: Requires read access to the package. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
5619
5637
|
* @summary Get package details
|
|
5620
5638
|
* @param {string} organizationName The unique identifier of the organization
|
|
5621
5639
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5630,7 +5648,7 @@ export class PackagesApi extends BaseAPI {
|
|
|
5630
5648
|
}
|
|
5631
5649
|
|
|
5632
5650
|
/**
|
|
5633
|
-
* Retrieves all packages within the specified project, including metadata such as names,
|
|
5651
|
+
* Retrieves all packages within the specified project, including metadata such as names, descriptions, latest versions, and creation timestamps. **Authorization**: Requires read access to the project. **Response**: Returns array of package objects with full metadata.
|
|
5634
5652
|
* @summary List packages in project
|
|
5635
5653
|
* @param {string} organizationName The unique identifier of the organization
|
|
5636
5654
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5656,7 +5674,7 @@ export class PackagesApi extends BaseAPI {
|
|
|
5656
5674
|
}
|
|
5657
5675
|
|
|
5658
5676
|
/**
|
|
5659
|
-
* Updates the metadata and configuration of an existing package, including description,
|
|
5677
|
+
* Updates the metadata and configuration of an existing package, including description, settings, and other package-level properties. **Authorization**: Requires package admin or modeler permissions. **Validation**: Updates are validated against package constraints and naming rules.
|
|
5660
5678
|
* @summary Update package metadata
|
|
5661
5679
|
* @param {string} organizationName The unique identifier of the organization
|
|
5662
5680
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5680,7 +5698,7 @@ export class PackagesApi extends BaseAPI {
|
|
|
5680
5698
|
export const PermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
5681
5699
|
return {
|
|
5682
5700
|
/**
|
|
5683
|
-
* Creates a system-level permission assignment for administrative functions,
|
|
5701
|
+
* Creates a system-level permission assignment for administrative functions, granting users elevated privileges across the platform. **Authorization**: Requires system admin permissions. **Scope**: System permissions affect access across all organizations and resources. **Roles**: Currently supports admin role for full system access.
|
|
5684
5702
|
* @summary Create system permission
|
|
5685
5703
|
* @param {SystemPermission} [systemPermission]
|
|
5686
5704
|
* @param {*} [options] Override http request option.
|
|
@@ -5724,7 +5742,7 @@ export const PermissionsApiFp = function(configuration?: Configuration) {
|
|
|
5724
5742
|
const localVarAxiosParamCreator = PermissionsApiAxiosParamCreator(configuration)
|
|
5725
5743
|
return {
|
|
5726
5744
|
/**
|
|
5727
|
-
* Creates a system-level permission assignment for administrative functions,
|
|
5745
|
+
* Creates a system-level permission assignment for administrative functions, granting users elevated privileges across the platform. **Authorization**: Requires system admin permissions. **Scope**: System permissions affect access across all organizations and resources. **Roles**: Currently supports admin role for full system access.
|
|
5728
5746
|
* @summary Create system permission
|
|
5729
5747
|
* @param {SystemPermission} [systemPermission]
|
|
5730
5748
|
* @param {*} [options] Override http request option.
|
|
@@ -5747,7 +5765,7 @@ export const PermissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
5747
5765
|
const localVarFp = PermissionsApiFp(configuration)
|
|
5748
5766
|
return {
|
|
5749
5767
|
/**
|
|
5750
|
-
* Creates a system-level permission assignment for administrative functions,
|
|
5768
|
+
* Creates a system-level permission assignment for administrative functions, granting users elevated privileges across the platform. **Authorization**: Requires system admin permissions. **Scope**: System permissions affect access across all organizations and resources. **Roles**: Currently supports admin role for full system access.
|
|
5751
5769
|
* @summary Create system permission
|
|
5752
5770
|
* @param {SystemPermission} [systemPermission]
|
|
5753
5771
|
* @param {*} [options] Override http request option.
|
|
@@ -5767,7 +5785,7 @@ export const PermissionsApiFactory = function (configuration?: Configuration, ba
|
|
|
5767
5785
|
*/
|
|
5768
5786
|
export class PermissionsApi extends BaseAPI {
|
|
5769
5787
|
/**
|
|
5770
|
-
* Creates a system-level permission assignment for administrative functions,
|
|
5788
|
+
* Creates a system-level permission assignment for administrative functions, granting users elevated privileges across the platform. **Authorization**: Requires system admin permissions. **Scope**: System permissions affect access across all organizations and resources. **Roles**: Currently supports admin role for full system access.
|
|
5771
5789
|
* @summary Create system permission
|
|
5772
5790
|
* @param {SystemPermission} [systemPermission]
|
|
5773
5791
|
* @param {*} [options] Override http request option.
|
|
@@ -5788,7 +5806,7 @@ export class PermissionsApi extends BaseAPI {
|
|
|
5788
5806
|
export const ProjectPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
5789
5807
|
return {
|
|
5790
5808
|
/**
|
|
5791
|
-
* Creates a new permission assignment for a user or group within the project,
|
|
5809
|
+
* Creates a new permission assignment for a user or group within the project, granting them specific roles and access levels. Can also be used to request access to the project when the user doesn\'t have admin permissions. **Authorization**: Requires project admin permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Notification**: Use `notifyPeople` to send email notifications to affected users.
|
|
5792
5810
|
* @summary Create project permission
|
|
5793
5811
|
* @param {string} organizationName The unique identifier of the organization
|
|
5794
5812
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5840,7 +5858,7 @@ export const ProjectPermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
5840
5858
|
};
|
|
5841
5859
|
},
|
|
5842
5860
|
/**
|
|
5843
|
-
* Removes the permission assignment for a user or group within the project,
|
|
5861
|
+
* Removes the permission assignment for a user or group within the project, revoking their access to project resources. **Authorization**: Requires project admin permissions. **Side Effects**: User/group loses access to project resources.
|
|
5844
5862
|
* @summary Delete project permission
|
|
5845
5863
|
* @param {string} organizationName The unique identifier of the organization
|
|
5846
5864
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5882,7 +5900,7 @@ export const ProjectPermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
5882
5900
|
};
|
|
5883
5901
|
},
|
|
5884
5902
|
/**
|
|
5885
|
-
* Retrieves the permission details for a specific user or group within the project,
|
|
5903
|
+
* Retrieves the permission details for a specific user or group within the project, including their role and access level. **Authorization**: Requires project admin, modeler, or viewer permissions. **Response**: Returns permission object with role and metadata.
|
|
5886
5904
|
* @summary Get project permission
|
|
5887
5905
|
* @param {string} organizationName The unique identifier of the organization
|
|
5888
5906
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5924,7 +5942,7 @@ export const ProjectPermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
5924
5942
|
};
|
|
5925
5943
|
},
|
|
5926
5944
|
/**
|
|
5927
|
-
* Retrieves all permission assignments for the specified project, including user and group
|
|
5945
|
+
* Retrieves all permission assignments for the specified project, including user and group permissions with their roles and access levels. **Authorization**: Requires project admin, modeler, or viewer permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
5928
5946
|
* @summary List project permissions
|
|
5929
5947
|
* @param {string} organizationName The unique identifier of the organization
|
|
5930
5948
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -5962,7 +5980,7 @@ export const ProjectPermissionsApiAxiosParamCreator = function (configuration?:
|
|
|
5962
5980
|
};
|
|
5963
5981
|
},
|
|
5964
5982
|
/**
|
|
5965
|
-
* Updates the permission assignment for a user or group within the project,
|
|
5983
|
+
* Updates the permission assignment for a user or group within the project, modifying their role and access level. **Authorization**: Requires project admin permissions. **Validation**: Role changes are validated against project constraints.
|
|
5966
5984
|
* @summary Update project permission
|
|
5967
5985
|
* @param {string} organizationName The unique identifier of the organization
|
|
5968
5986
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6018,7 +6036,7 @@ export const ProjectPermissionsApiFp = function(configuration?: Configuration) {
|
|
|
6018
6036
|
const localVarAxiosParamCreator = ProjectPermissionsApiAxiosParamCreator(configuration)
|
|
6019
6037
|
return {
|
|
6020
6038
|
/**
|
|
6021
|
-
* Creates a new permission assignment for a user or group within the project,
|
|
6039
|
+
* Creates a new permission assignment for a user or group within the project, granting them specific roles and access levels. Can also be used to request access to the project when the user doesn\'t have admin permissions. **Authorization**: Requires project admin permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Notification**: Use `notifyPeople` to send email notifications to affected users.
|
|
6022
6040
|
* @summary Create project permission
|
|
6023
6041
|
* @param {string} organizationName The unique identifier of the organization
|
|
6024
6042
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6035,7 +6053,7 @@ export const ProjectPermissionsApiFp = function(configuration?: Configuration) {
|
|
|
6035
6053
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6036
6054
|
},
|
|
6037
6055
|
/**
|
|
6038
|
-
* Removes the permission assignment for a user or group within the project,
|
|
6056
|
+
* Removes the permission assignment for a user or group within the project, revoking their access to project resources. **Authorization**: Requires project admin permissions. **Side Effects**: User/group loses access to project resources.
|
|
6039
6057
|
* @summary Delete project permission
|
|
6040
6058
|
* @param {string} organizationName The unique identifier of the organization
|
|
6041
6059
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6050,7 +6068,7 @@ export const ProjectPermissionsApiFp = function(configuration?: Configuration) {
|
|
|
6050
6068
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6051
6069
|
},
|
|
6052
6070
|
/**
|
|
6053
|
-
* Retrieves the permission details for a specific user or group within the project,
|
|
6071
|
+
* Retrieves the permission details for a specific user or group within the project, including their role and access level. **Authorization**: Requires project admin, modeler, or viewer permissions. **Response**: Returns permission object with role and metadata.
|
|
6054
6072
|
* @summary Get project permission
|
|
6055
6073
|
* @param {string} organizationName The unique identifier of the organization
|
|
6056
6074
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6065,7 +6083,7 @@ export const ProjectPermissionsApiFp = function(configuration?: Configuration) {
|
|
|
6065
6083
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6066
6084
|
},
|
|
6067
6085
|
/**
|
|
6068
|
-
* Retrieves all permission assignments for the specified project, including user and group
|
|
6086
|
+
* Retrieves all permission assignments for the specified project, including user and group permissions with their roles and access levels. **Authorization**: Requires project admin, modeler, or viewer permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
6069
6087
|
* @summary List project permissions
|
|
6070
6088
|
* @param {string} organizationName The unique identifier of the organization
|
|
6071
6089
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6079,7 +6097,7 @@ export const ProjectPermissionsApiFp = function(configuration?: Configuration) {
|
|
|
6079
6097
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6080
6098
|
},
|
|
6081
6099
|
/**
|
|
6082
|
-
* Updates the permission assignment for a user or group within the project,
|
|
6100
|
+
* Updates the permission assignment for a user or group within the project, modifying their role and access level. **Authorization**: Requires project admin permissions. **Validation**: Role changes are validated against project constraints.
|
|
6083
6101
|
* @summary Update project permission
|
|
6084
6102
|
* @param {string} organizationName The unique identifier of the organization
|
|
6085
6103
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6105,7 +6123,7 @@ export const ProjectPermissionsApiFactory = function (configuration?: Configurat
|
|
|
6105
6123
|
const localVarFp = ProjectPermissionsApiFp(configuration)
|
|
6106
6124
|
return {
|
|
6107
6125
|
/**
|
|
6108
|
-
* Creates a new permission assignment for a user or group within the project,
|
|
6126
|
+
* Creates a new permission assignment for a user or group within the project, granting them specific roles and access levels. Can also be used to request access to the project when the user doesn\'t have admin permissions. **Authorization**: Requires project admin permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Notification**: Use `notifyPeople` to send email notifications to affected users.
|
|
6109
6127
|
* @summary Create project permission
|
|
6110
6128
|
* @param {string} organizationName The unique identifier of the organization
|
|
6111
6129
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6119,7 +6137,7 @@ export const ProjectPermissionsApiFactory = function (configuration?: Configurat
|
|
|
6119
6137
|
return localVarFp.createProjectPermission(organizationName, projectName, requestPermission, notifyPeople, projectPermission, options).then((request) => request(axios, basePath));
|
|
6120
6138
|
},
|
|
6121
6139
|
/**
|
|
6122
|
-
* Removes the permission assignment for a user or group within the project,
|
|
6140
|
+
* Removes the permission assignment for a user or group within the project, revoking their access to project resources. **Authorization**: Requires project admin permissions. **Side Effects**: User/group loses access to project resources.
|
|
6123
6141
|
* @summary Delete project permission
|
|
6124
6142
|
* @param {string} organizationName The unique identifier of the organization
|
|
6125
6143
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6131,7 +6149,7 @@ export const ProjectPermissionsApiFactory = function (configuration?: Configurat
|
|
|
6131
6149
|
return localVarFp.deleteProjectPermission(organizationName, projectName, userGroupId, options).then((request) => request(axios, basePath));
|
|
6132
6150
|
},
|
|
6133
6151
|
/**
|
|
6134
|
-
* Retrieves the permission details for a specific user or group within the project,
|
|
6152
|
+
* Retrieves the permission details for a specific user or group within the project, including their role and access level. **Authorization**: Requires project admin, modeler, or viewer permissions. **Response**: Returns permission object with role and metadata.
|
|
6135
6153
|
* @summary Get project permission
|
|
6136
6154
|
* @param {string} organizationName The unique identifier of the organization
|
|
6137
6155
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6143,7 +6161,7 @@ export const ProjectPermissionsApiFactory = function (configuration?: Configurat
|
|
|
6143
6161
|
return localVarFp.getProjectPermission(organizationName, projectName, userGroupId, options).then((request) => request(axios, basePath));
|
|
6144
6162
|
},
|
|
6145
6163
|
/**
|
|
6146
|
-
* Retrieves all permission assignments for the specified project, including user and group
|
|
6164
|
+
* Retrieves all permission assignments for the specified project, including user and group permissions with their roles and access levels. **Authorization**: Requires project admin, modeler, or viewer permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
6147
6165
|
* @summary List project permissions
|
|
6148
6166
|
* @param {string} organizationName The unique identifier of the organization
|
|
6149
6167
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6154,7 +6172,7 @@ export const ProjectPermissionsApiFactory = function (configuration?: Configurat
|
|
|
6154
6172
|
return localVarFp.listProjectPermissions(organizationName, projectName, options).then((request) => request(axios, basePath));
|
|
6155
6173
|
},
|
|
6156
6174
|
/**
|
|
6157
|
-
* Updates the permission assignment for a user or group within the project,
|
|
6175
|
+
* Updates the permission assignment for a user or group within the project, modifying their role and access level. **Authorization**: Requires project admin permissions. **Validation**: Role changes are validated against project constraints.
|
|
6158
6176
|
* @summary Update project permission
|
|
6159
6177
|
* @param {string} organizationName The unique identifier of the organization
|
|
6160
6178
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6177,7 +6195,7 @@ export const ProjectPermissionsApiFactory = function (configuration?: Configurat
|
|
|
6177
6195
|
*/
|
|
6178
6196
|
export class ProjectPermissionsApi extends BaseAPI {
|
|
6179
6197
|
/**
|
|
6180
|
-
* Creates a new permission assignment for a user or group within the project,
|
|
6198
|
+
* Creates a new permission assignment for a user or group within the project, granting them specific roles and access levels. Can also be used to request access to the project when the user doesn\'t have admin permissions. **Authorization**: Requires project admin permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Notification**: Use `notifyPeople` to send email notifications to affected users.
|
|
6181
6199
|
* @summary Create project permission
|
|
6182
6200
|
* @param {string} organizationName The unique identifier of the organization
|
|
6183
6201
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6193,7 +6211,7 @@ export class ProjectPermissionsApi extends BaseAPI {
|
|
|
6193
6211
|
}
|
|
6194
6212
|
|
|
6195
6213
|
/**
|
|
6196
|
-
* Removes the permission assignment for a user or group within the project,
|
|
6214
|
+
* Removes the permission assignment for a user or group within the project, revoking their access to project resources. **Authorization**: Requires project admin permissions. **Side Effects**: User/group loses access to project resources.
|
|
6197
6215
|
* @summary Delete project permission
|
|
6198
6216
|
* @param {string} organizationName The unique identifier of the organization
|
|
6199
6217
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6207,7 +6225,7 @@ export class ProjectPermissionsApi extends BaseAPI {
|
|
|
6207
6225
|
}
|
|
6208
6226
|
|
|
6209
6227
|
/**
|
|
6210
|
-
* Retrieves the permission details for a specific user or group within the project,
|
|
6228
|
+
* Retrieves the permission details for a specific user or group within the project, including their role and access level. **Authorization**: Requires project admin, modeler, or viewer permissions. **Response**: Returns permission object with role and metadata.
|
|
6211
6229
|
* @summary Get project permission
|
|
6212
6230
|
* @param {string} organizationName The unique identifier of the organization
|
|
6213
6231
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6221,7 +6239,7 @@ export class ProjectPermissionsApi extends BaseAPI {
|
|
|
6221
6239
|
}
|
|
6222
6240
|
|
|
6223
6241
|
/**
|
|
6224
|
-
* Retrieves all permission assignments for the specified project, including user and group
|
|
6242
|
+
* Retrieves all permission assignments for the specified project, including user and group permissions with their roles and access levels. **Authorization**: Requires project admin, modeler, or viewer permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
6225
6243
|
* @summary List project permissions
|
|
6226
6244
|
* @param {string} organizationName The unique identifier of the organization
|
|
6227
6245
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6234,7 +6252,7 @@ export class ProjectPermissionsApi extends BaseAPI {
|
|
|
6234
6252
|
}
|
|
6235
6253
|
|
|
6236
6254
|
/**
|
|
6237
|
-
* Updates the permission assignment for a user or group within the project,
|
|
6255
|
+
* Updates the permission assignment for a user or group within the project, modifying their role and access level. **Authorization**: Requires project admin permissions. **Validation**: Role changes are validated against project constraints.
|
|
6238
6256
|
* @summary Update project permission
|
|
6239
6257
|
* @param {string} organizationName The unique identifier of the organization
|
|
6240
6258
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6258,7 +6276,7 @@ export class ProjectPermissionsApi extends BaseAPI {
|
|
|
6258
6276
|
export const ProjectsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
6259
6277
|
return {
|
|
6260
6278
|
/**
|
|
6261
|
-
* Creates a new project within the specified organization. Projects serve as containers
|
|
6279
|
+
* Creates a new project within the specified organization. Projects serve as containers for packages and provide a logical grouping for related data models. **Authorization**: Requires organization admin permissions. **Validation**: Project names must be unique within the organization. **Side Effects**: Creates default project permissions and initializes project structure.
|
|
6262
6280
|
* @summary Create a new project
|
|
6263
6281
|
* @param {string} organizationName The unique identifier of the organization
|
|
6264
6282
|
* @param {Project} project
|
|
@@ -6298,7 +6316,7 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6298
6316
|
};
|
|
6299
6317
|
},
|
|
6300
6318
|
/**
|
|
6301
|
-
* Permanently deletes a project and all associated packages, versions, and connections.
|
|
6319
|
+
* Permanently deletes a project and all associated packages, versions, and connections. This operation is irreversible. **Authorization**: Requires project admin permissions. **Warning**: This operation will cascade delete all child resources. **Side Effects**: Removes all packages, versions, and connections within the project.
|
|
6302
6320
|
* @summary Delete project
|
|
6303
6321
|
* @param {string} organizationName The unique identifier of the organization
|
|
6304
6322
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6336,7 +6354,7 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6336
6354
|
};
|
|
6337
6355
|
},
|
|
6338
6356
|
/**
|
|
6339
|
-
* Retrieves detailed information about a specific project including metadata,
|
|
6357
|
+
* Retrieves detailed information about a specific project including metadata, configuration, and administrative details. **Authorization**: Requires read access to the project. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
6340
6358
|
* @summary Get project details
|
|
6341
6359
|
* @param {string} organizationName The unique identifier of the organization
|
|
6342
6360
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6379,7 +6397,7 @@ export const ProjectsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
6379
6397
|
};
|
|
6380
6398
|
},
|
|
6381
6399
|
/**
|
|
6382
|
-
* Retrieves all projects within the specified organization, including metadata such as
|
|
6400
|
+
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata.
|
|
6383
6401
|
* @summary List projects in organization
|
|
6384
6402
|
* @param {string} organizationName The unique identifier of the organization
|
|
6385
6403
|
* @param {*} [options] Override http request option.
|
|
@@ -6467,7 +6485,7 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
6467
6485
|
const localVarAxiosParamCreator = ProjectsApiAxiosParamCreator(configuration)
|
|
6468
6486
|
return {
|
|
6469
6487
|
/**
|
|
6470
|
-
* Creates a new project within the specified organization. Projects serve as containers
|
|
6488
|
+
* Creates a new project within the specified organization. Projects serve as containers for packages and provide a logical grouping for related data models. **Authorization**: Requires organization admin permissions. **Validation**: Project names must be unique within the organization. **Side Effects**: Creates default project permissions and initializes project structure.
|
|
6471
6489
|
* @summary Create a new project
|
|
6472
6490
|
* @param {string} organizationName The unique identifier of the organization
|
|
6473
6491
|
* @param {Project} project
|
|
@@ -6481,7 +6499,7 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
6481
6499
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6482
6500
|
},
|
|
6483
6501
|
/**
|
|
6484
|
-
* Permanently deletes a project and all associated packages, versions, and connections.
|
|
6502
|
+
* Permanently deletes a project and all associated packages, versions, and connections. This operation is irreversible. **Authorization**: Requires project admin permissions. **Warning**: This operation will cascade delete all child resources. **Side Effects**: Removes all packages, versions, and connections within the project.
|
|
6485
6503
|
* @summary Delete project
|
|
6486
6504
|
* @param {string} organizationName The unique identifier of the organization
|
|
6487
6505
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6495,7 +6513,7 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
6495
6513
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6496
6514
|
},
|
|
6497
6515
|
/**
|
|
6498
|
-
* Retrieves detailed information about a specific project including metadata,
|
|
6516
|
+
* Retrieves detailed information about a specific project including metadata, configuration, and administrative details. **Authorization**: Requires read access to the project. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
6499
6517
|
* @summary Get project details
|
|
6500
6518
|
* @param {string} organizationName The unique identifier of the organization
|
|
6501
6519
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6510,7 +6528,7 @@ export const ProjectsApiFp = function(configuration?: Configuration) {
|
|
|
6510
6528
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6511
6529
|
},
|
|
6512
6530
|
/**
|
|
6513
|
-
* Retrieves all projects within the specified organization, including metadata such as
|
|
6531
|
+
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata.
|
|
6514
6532
|
* @summary List projects in organization
|
|
6515
6533
|
* @param {string} organizationName The unique identifier of the organization
|
|
6516
6534
|
* @param {*} [options] Override http request option.
|
|
@@ -6548,7 +6566,7 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
6548
6566
|
const localVarFp = ProjectsApiFp(configuration)
|
|
6549
6567
|
return {
|
|
6550
6568
|
/**
|
|
6551
|
-
* Creates a new project within the specified organization. Projects serve as containers
|
|
6569
|
+
* Creates a new project within the specified organization. Projects serve as containers for packages and provide a logical grouping for related data models. **Authorization**: Requires organization admin permissions. **Validation**: Project names must be unique within the organization. **Side Effects**: Creates default project permissions and initializes project structure.
|
|
6552
6570
|
* @summary Create a new project
|
|
6553
6571
|
* @param {string} organizationName The unique identifier of the organization
|
|
6554
6572
|
* @param {Project} project
|
|
@@ -6559,7 +6577,7 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
6559
6577
|
return localVarFp.createProject(organizationName, project, options).then((request) => request(axios, basePath));
|
|
6560
6578
|
},
|
|
6561
6579
|
/**
|
|
6562
|
-
* Permanently deletes a project and all associated packages, versions, and connections.
|
|
6580
|
+
* Permanently deletes a project and all associated packages, versions, and connections. This operation is irreversible. **Authorization**: Requires project admin permissions. **Warning**: This operation will cascade delete all child resources. **Side Effects**: Removes all packages, versions, and connections within the project.
|
|
6563
6581
|
* @summary Delete project
|
|
6564
6582
|
* @param {string} organizationName The unique identifier of the organization
|
|
6565
6583
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6570,7 +6588,7 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
6570
6588
|
return localVarFp.deleteProject(organizationName, projectName, options).then((request) => request(axios, basePath));
|
|
6571
6589
|
},
|
|
6572
6590
|
/**
|
|
6573
|
-
* Retrieves detailed information about a specific project including metadata,
|
|
6591
|
+
* Retrieves detailed information about a specific project including metadata, configuration, and administrative details. **Authorization**: Requires read access to the project. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
6574
6592
|
* @summary Get project details
|
|
6575
6593
|
* @param {string} organizationName The unique identifier of the organization
|
|
6576
6594
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6582,7 +6600,7 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
6582
6600
|
return localVarFp.getProject(organizationName, projectName, checkAdmin, options).then((request) => request(axios, basePath));
|
|
6583
6601
|
},
|
|
6584
6602
|
/**
|
|
6585
|
-
* Retrieves all projects within the specified organization, including metadata such as
|
|
6603
|
+
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata.
|
|
6586
6604
|
* @summary List projects in organization
|
|
6587
6605
|
* @param {string} organizationName The unique identifier of the organization
|
|
6588
6606
|
* @param {*} [options] Override http request option.
|
|
@@ -6614,7 +6632,7 @@ export const ProjectsApiFactory = function (configuration?: Configuration, baseP
|
|
|
6614
6632
|
*/
|
|
6615
6633
|
export class ProjectsApi extends BaseAPI {
|
|
6616
6634
|
/**
|
|
6617
|
-
* Creates a new project within the specified organization. Projects serve as containers
|
|
6635
|
+
* Creates a new project within the specified organization. Projects serve as containers for packages and provide a logical grouping for related data models. **Authorization**: Requires organization admin permissions. **Validation**: Project names must be unique within the organization. **Side Effects**: Creates default project permissions and initializes project structure.
|
|
6618
6636
|
* @summary Create a new project
|
|
6619
6637
|
* @param {string} organizationName The unique identifier of the organization
|
|
6620
6638
|
* @param {Project} project
|
|
@@ -6627,7 +6645,7 @@ export class ProjectsApi extends BaseAPI {
|
|
|
6627
6645
|
}
|
|
6628
6646
|
|
|
6629
6647
|
/**
|
|
6630
|
-
* Permanently deletes a project and all associated packages, versions, and connections.
|
|
6648
|
+
* Permanently deletes a project and all associated packages, versions, and connections. This operation is irreversible. **Authorization**: Requires project admin permissions. **Warning**: This operation will cascade delete all child resources. **Side Effects**: Removes all packages, versions, and connections within the project.
|
|
6631
6649
|
* @summary Delete project
|
|
6632
6650
|
* @param {string} organizationName The unique identifier of the organization
|
|
6633
6651
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6640,7 +6658,7 @@ export class ProjectsApi extends BaseAPI {
|
|
|
6640
6658
|
}
|
|
6641
6659
|
|
|
6642
6660
|
/**
|
|
6643
|
-
* Retrieves detailed information about a specific project including metadata,
|
|
6661
|
+
* Retrieves detailed information about a specific project including metadata, configuration, and administrative details. **Authorization**: Requires read access to the project. **Parameters**: The `checkAdmin` parameter can be used to verify admin privileges.
|
|
6644
6662
|
* @summary Get project details
|
|
6645
6663
|
* @param {string} organizationName The unique identifier of the organization
|
|
6646
6664
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -6654,7 +6672,7 @@ export class ProjectsApi extends BaseAPI {
|
|
|
6654
6672
|
}
|
|
6655
6673
|
|
|
6656
6674
|
/**
|
|
6657
|
-
* Retrieves all projects within the specified organization, including metadata such as
|
|
6675
|
+
* Retrieves all projects within the specified organization, including metadata such as names, descriptions, creation dates, and replication counts. **Authorization**: Requires read access to the organization. **Response**: Returns array of project objects with full metadata.
|
|
6658
6676
|
* @summary List projects in organization
|
|
6659
6677
|
* @param {string} organizationName The unique identifier of the organization
|
|
6660
6678
|
* @param {*} [options] Override http request option.
|
|
@@ -6723,7 +6741,7 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
6723
6741
|
};
|
|
6724
6742
|
},
|
|
6725
6743
|
/**
|
|
6726
|
-
* Permanently deletes a user account and removes all associated data.
|
|
6744
|
+
* Permanently deletes a user account and removes all associated data. This operation is irreversible. **Authorization**: Requires system admin permissions. **Warning**: This operation will remove all user data and permissions. **Side Effects**: Removes user from all groups and revokes all permissions.
|
|
6727
6745
|
* @summary Delete user account
|
|
6728
6746
|
* @param {string} userName The unique identifier of the user
|
|
6729
6747
|
* @param {*} [options] Override http request option.
|
|
@@ -6757,7 +6775,7 @@ export const UsersApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
6757
6775
|
};
|
|
6758
6776
|
},
|
|
6759
6777
|
/**
|
|
6760
|
-
* Retrieves detailed information about a specific user including profile data,
|
|
6778
|
+
* Retrieves detailed information about a specific user including profile data, tutorial status, and account configuration. **Authorization**: Requires read access to user information. **Security**: Password is never included in responses.
|
|
6761
6779
|
* @summary Get user details
|
|
6762
6780
|
* @param {string} userName The unique identifier of the user
|
|
6763
6781
|
* @param {*} [options] Override http request option.
|
|
@@ -6852,7 +6870,7 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
6852
6870
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6853
6871
|
},
|
|
6854
6872
|
/**
|
|
6855
|
-
* Permanently deletes a user account and removes all associated data.
|
|
6873
|
+
* Permanently deletes a user account and removes all associated data. This operation is irreversible. **Authorization**: Requires system admin permissions. **Warning**: This operation will remove all user data and permissions. **Side Effects**: Removes user from all groups and revokes all permissions.
|
|
6856
6874
|
* @summary Delete user account
|
|
6857
6875
|
* @param {string} userName The unique identifier of the user
|
|
6858
6876
|
* @param {*} [options] Override http request option.
|
|
@@ -6865,7 +6883,7 @@ export const UsersApiFp = function(configuration?: Configuration) {
|
|
|
6865
6883
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
6866
6884
|
},
|
|
6867
6885
|
/**
|
|
6868
|
-
* Retrieves detailed information about a specific user including profile data,
|
|
6886
|
+
* Retrieves detailed information about a specific user including profile data, tutorial status, and account configuration. **Authorization**: Requires read access to user information. **Security**: Password is never included in responses.
|
|
6869
6887
|
* @summary Get user details
|
|
6870
6888
|
* @param {string} userName The unique identifier of the user
|
|
6871
6889
|
* @param {*} [options] Override http request option.
|
|
@@ -6912,7 +6930,7 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
6912
6930
|
return localVarFp.createUser(user, options).then((request) => request(axios, basePath));
|
|
6913
6931
|
},
|
|
6914
6932
|
/**
|
|
6915
|
-
* Permanently deletes a user account and removes all associated data.
|
|
6933
|
+
* Permanently deletes a user account and removes all associated data. This operation is irreversible. **Authorization**: Requires system admin permissions. **Warning**: This operation will remove all user data and permissions. **Side Effects**: Removes user from all groups and revokes all permissions.
|
|
6916
6934
|
* @summary Delete user account
|
|
6917
6935
|
* @param {string} userName The unique identifier of the user
|
|
6918
6936
|
* @param {*} [options] Override http request option.
|
|
@@ -6922,7 +6940,7 @@ export const UsersApiFactory = function (configuration?: Configuration, basePath
|
|
|
6922
6940
|
return localVarFp.deleteUser(userName, options).then((request) => request(axios, basePath));
|
|
6923
6941
|
},
|
|
6924
6942
|
/**
|
|
6925
|
-
* Retrieves detailed information about a specific user including profile data,
|
|
6943
|
+
* Retrieves detailed information about a specific user including profile data, tutorial status, and account configuration. **Authorization**: Requires read access to user information. **Security**: Password is never included in responses.
|
|
6926
6944
|
* @summary Get user details
|
|
6927
6945
|
* @param {string} userName The unique identifier of the user
|
|
6928
6946
|
* @param {*} [options] Override http request option.
|
|
@@ -6965,7 +6983,7 @@ export class UsersApi extends BaseAPI {
|
|
|
6965
6983
|
}
|
|
6966
6984
|
|
|
6967
6985
|
/**
|
|
6968
|
-
* Permanently deletes a user account and removes all associated data.
|
|
6986
|
+
* Permanently deletes a user account and removes all associated data. This operation is irreversible. **Authorization**: Requires system admin permissions. **Warning**: This operation will remove all user data and permissions. **Side Effects**: Removes user from all groups and revokes all permissions.
|
|
6969
6987
|
* @summary Delete user account
|
|
6970
6988
|
* @param {string} userName The unique identifier of the user
|
|
6971
6989
|
* @param {*} [options] Override http request option.
|
|
@@ -6977,7 +6995,7 @@ export class UsersApi extends BaseAPI {
|
|
|
6977
6995
|
}
|
|
6978
6996
|
|
|
6979
6997
|
/**
|
|
6980
|
-
* Retrieves detailed information about a specific user including profile data,
|
|
6998
|
+
* Retrieves detailed information about a specific user including profile data, tutorial status, and account configuration. **Authorization**: Requires read access to user information. **Security**: Password is never included in responses.
|
|
6981
6999
|
* @summary Get user details
|
|
6982
7000
|
* @param {string} userName The unique identifier of the user
|
|
6983
7001
|
* @param {*} [options] Override http request option.
|
|
@@ -7011,7 +7029,7 @@ export class UsersApi extends BaseAPI {
|
|
|
7011
7029
|
export const VersionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
7012
7030
|
return {
|
|
7013
7031
|
/**
|
|
7014
|
-
* Retrieves detailed information about a specific package version including metadata,
|
|
7032
|
+
* Retrieves detailed information about a specific package version including metadata, archive status, and creation details. **Authorization**: Requires read access to the package. **Response**: Returns complete version object with all metadata.
|
|
7015
7033
|
* @summary Get version details
|
|
7016
7034
|
* @param {string} organizationName The unique identifier of the organization
|
|
7017
7035
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7057,7 +7075,7 @@ export const VersionsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
7057
7075
|
};
|
|
7058
7076
|
},
|
|
7059
7077
|
/**
|
|
7060
|
-
* Retrieves all versions of a specific package, including version identifiers, creation
|
|
7078
|
+
* Retrieves all versions of a specific package, including version identifiers, creation timestamps, and archive status information. **Authorization**: Requires read access to the package. **Response**: Returns array of version objects ordered by creation date.
|
|
7061
7079
|
* @summary List package versions
|
|
7062
7080
|
* @param {string} organizationName The unique identifier of the organization
|
|
7063
7081
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7099,7 +7117,7 @@ export const VersionsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
7099
7117
|
};
|
|
7100
7118
|
},
|
|
7101
7119
|
/**
|
|
7102
|
-
* Updates the status of a specific package version, typically used for archiving or
|
|
7120
|
+
* Updates the status of a specific package version, typically used for archiving or unarchiving versions to control their availability. **Authorization**: Requires package admin or modeler permissions. **Operations**: Supports archiving and unarchiving version status changes.
|
|
7103
7121
|
* @summary Update version status
|
|
7104
7122
|
* @param {string} organizationName The unique identifier of the organization
|
|
7105
7123
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7161,7 +7179,7 @@ export const VersionsApiFp = function(configuration?: Configuration) {
|
|
|
7161
7179
|
const localVarAxiosParamCreator = VersionsApiAxiosParamCreator(configuration)
|
|
7162
7180
|
return {
|
|
7163
7181
|
/**
|
|
7164
|
-
* Retrieves detailed information about a specific package version including metadata,
|
|
7182
|
+
* Retrieves detailed information about a specific package version including metadata, archive status, and creation details. **Authorization**: Requires read access to the package. **Response**: Returns complete version object with all metadata.
|
|
7165
7183
|
* @summary Get version details
|
|
7166
7184
|
* @param {string} organizationName The unique identifier of the organization
|
|
7167
7185
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7177,7 +7195,7 @@ export const VersionsApiFp = function(configuration?: Configuration) {
|
|
|
7177
7195
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7178
7196
|
},
|
|
7179
7197
|
/**
|
|
7180
|
-
* Retrieves all versions of a specific package, including version identifiers, creation
|
|
7198
|
+
* Retrieves all versions of a specific package, including version identifiers, creation timestamps, and archive status information. **Authorization**: Requires read access to the package. **Response**: Returns array of version objects ordered by creation date.
|
|
7181
7199
|
* @summary List package versions
|
|
7182
7200
|
* @param {string} organizationName The unique identifier of the organization
|
|
7183
7201
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7192,7 +7210,7 @@ export const VersionsApiFp = function(configuration?: Configuration) {
|
|
|
7192
7210
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7193
7211
|
},
|
|
7194
7212
|
/**
|
|
7195
|
-
* Updates the status of a specific package version, typically used for archiving or
|
|
7213
|
+
* Updates the status of a specific package version, typically used for archiving or unarchiving versions to control their availability. **Authorization**: Requires package admin or modeler permissions. **Operations**: Supports archiving and unarchiving version status changes.
|
|
7196
7214
|
* @summary Update version status
|
|
7197
7215
|
* @param {string} organizationName The unique identifier of the organization
|
|
7198
7216
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7219,7 +7237,7 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP
|
|
|
7219
7237
|
const localVarFp = VersionsApiFp(configuration)
|
|
7220
7238
|
return {
|
|
7221
7239
|
/**
|
|
7222
|
-
* Retrieves detailed information about a specific package version including metadata,
|
|
7240
|
+
* Retrieves detailed information about a specific package version including metadata, archive status, and creation details. **Authorization**: Requires read access to the package. **Response**: Returns complete version object with all metadata.
|
|
7223
7241
|
* @summary Get version details
|
|
7224
7242
|
* @param {string} organizationName The unique identifier of the organization
|
|
7225
7243
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7232,7 +7250,7 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP
|
|
|
7232
7250
|
return localVarFp.getVersion(organizationName, projectName, packageName, versionId, options).then((request) => request(axios, basePath));
|
|
7233
7251
|
},
|
|
7234
7252
|
/**
|
|
7235
|
-
* Retrieves all versions of a specific package, including version identifiers, creation
|
|
7253
|
+
* Retrieves all versions of a specific package, including version identifiers, creation timestamps, and archive status information. **Authorization**: Requires read access to the package. **Response**: Returns array of version objects ordered by creation date.
|
|
7236
7254
|
* @summary List package versions
|
|
7237
7255
|
* @param {string} organizationName The unique identifier of the organization
|
|
7238
7256
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7244,7 +7262,7 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP
|
|
|
7244
7262
|
return localVarFp.listVersions(organizationName, projectName, packageName, options).then((request) => request(axios, basePath));
|
|
7245
7263
|
},
|
|
7246
7264
|
/**
|
|
7247
|
-
* Updates the status of a specific package version, typically used for archiving or
|
|
7265
|
+
* Updates the status of a specific package version, typically used for archiving or unarchiving versions to control their availability. **Authorization**: Requires package admin or modeler permissions. **Operations**: Supports archiving and unarchiving version status changes.
|
|
7248
7266
|
* @summary Update version status
|
|
7249
7267
|
* @param {string} organizationName The unique identifier of the organization
|
|
7250
7268
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7268,7 +7286,7 @@ export const VersionsApiFactory = function (configuration?: Configuration, baseP
|
|
|
7268
7286
|
*/
|
|
7269
7287
|
export class VersionsApi extends BaseAPI {
|
|
7270
7288
|
/**
|
|
7271
|
-
* Retrieves detailed information about a specific package version including metadata,
|
|
7289
|
+
* Retrieves detailed information about a specific package version including metadata, archive status, and creation details. **Authorization**: Requires read access to the package. **Response**: Returns complete version object with all metadata.
|
|
7272
7290
|
* @summary Get version details
|
|
7273
7291
|
* @param {string} organizationName The unique identifier of the organization
|
|
7274
7292
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7283,7 +7301,7 @@ export class VersionsApi extends BaseAPI {
|
|
|
7283
7301
|
}
|
|
7284
7302
|
|
|
7285
7303
|
/**
|
|
7286
|
-
* Retrieves all versions of a specific package, including version identifiers, creation
|
|
7304
|
+
* Retrieves all versions of a specific package, including version identifiers, creation timestamps, and archive status information. **Authorization**: Requires read access to the package. **Response**: Returns array of version objects ordered by creation date.
|
|
7287
7305
|
* @summary List package versions
|
|
7288
7306
|
* @param {string} organizationName The unique identifier of the organization
|
|
7289
7307
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7297,7 +7315,7 @@ export class VersionsApi extends BaseAPI {
|
|
|
7297
7315
|
}
|
|
7298
7316
|
|
|
7299
7317
|
/**
|
|
7300
|
-
* Updates the status of a specific package version, typically used for archiving or
|
|
7318
|
+
* Updates the status of a specific package version, typically used for archiving or unarchiving versions to control their availability. **Authorization**: Requires package admin or modeler permissions. **Operations**: Supports archiving and unarchiving version status changes.
|
|
7301
7319
|
* @summary Update version status
|
|
7302
7320
|
* @param {string} organizationName The unique identifier of the organization
|
|
7303
7321
|
* @param {string} projectName The unique identifier of the project
|
|
@@ -7374,7 +7392,7 @@ export const WorkspacePermissionsApiAxiosParamCreator = function (configuration?
|
|
|
7374
7392
|
};
|
|
7375
7393
|
},
|
|
7376
7394
|
/**
|
|
7377
|
-
* Creates a new permission assignment for a user or group within the workspace,
|
|
7395
|
+
* Creates a new permission assignment for a user or group within the workspace, granting them specific roles and access levels. Can also be used to request access to the workspace when the user doesn\'t have manager permissions. **Authorization**: Requires workspace manager permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports manager and viewer roles.
|
|
7378
7396
|
* @summary Create workspace permission
|
|
7379
7397
|
* @param {string} organizationName The unique identifier of the organization
|
|
7380
7398
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7421,7 +7439,7 @@ export const WorkspacePermissionsApiAxiosParamCreator = function (configuration?
|
|
|
7421
7439
|
};
|
|
7422
7440
|
},
|
|
7423
7441
|
/**
|
|
7424
|
-
* Removes the permission assignment for a user or group within the workspace,
|
|
7442
|
+
* Removes the permission assignment for a user or group within the workspace, revoking their access to workspace resources. **Authorization**: Requires workspace manager permissions. **Side Effects**: User/group loses access to workspace resources.
|
|
7425
7443
|
* @summary Delete workspace permission
|
|
7426
7444
|
* @param {string} organizationName The unique identifier of the organization
|
|
7427
7445
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7463,7 +7481,7 @@ export const WorkspacePermissionsApiAxiosParamCreator = function (configuration?
|
|
|
7463
7481
|
};
|
|
7464
7482
|
},
|
|
7465
7483
|
/**
|
|
7466
|
-
* Retrieves the permission details for a specific user or group within the workspace,
|
|
7484
|
+
* Retrieves the permission details for a specific user or group within the workspace, including their role and access level. **Authorization**: Requires workspace manager permissions. **Response**: Returns permission object with role and metadata.
|
|
7467
7485
|
* @summary Get workspace permission
|
|
7468
7486
|
* @param {string} organizationName The unique identifier of the organization
|
|
7469
7487
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7505,7 +7523,7 @@ export const WorkspacePermissionsApiAxiosParamCreator = function (configuration?
|
|
|
7505
7523
|
};
|
|
7506
7524
|
},
|
|
7507
7525
|
/**
|
|
7508
|
-
* Retrieves all permission assignments for the specified workspace, including user and group
|
|
7526
|
+
* Retrieves all permission assignments for the specified workspace, including user and group permissions with their roles and access levels. **Authorization**: Requires workspace manager permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
7509
7527
|
* @summary List workspace permissions
|
|
7510
7528
|
* @param {string} organizationName The unique identifier of the organization
|
|
7511
7529
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7595,7 +7613,7 @@ export const WorkspacePermissionsApiAxiosParamCreator = function (configuration?
|
|
|
7595
7613
|
};
|
|
7596
7614
|
},
|
|
7597
7615
|
/**
|
|
7598
|
-
* Updates the permission assignment for a user or group within the workspace,
|
|
7616
|
+
* Updates the permission assignment for a user or group within the workspace, modifying their role and access level. **Authorization**: Requires workspace manager permissions. **Validation**: Role changes are validated against workspace constraints.
|
|
7599
7617
|
* @summary Update workspace permission
|
|
7600
7618
|
* @param {string} organizationName The unique identifier of the organization
|
|
7601
7619
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7667,7 +7685,7 @@ export const WorkspacePermissionsApiFp = function(configuration?: Configuration)
|
|
|
7667
7685
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7668
7686
|
},
|
|
7669
7687
|
/**
|
|
7670
|
-
* Creates a new permission assignment for a user or group within the workspace,
|
|
7688
|
+
* Creates a new permission assignment for a user or group within the workspace, granting them specific roles and access levels. Can also be used to request access to the workspace when the user doesn\'t have manager permissions. **Authorization**: Requires workspace manager permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports manager and viewer roles.
|
|
7671
7689
|
* @summary Create workspace permission
|
|
7672
7690
|
* @param {string} organizationName The unique identifier of the organization
|
|
7673
7691
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7683,7 +7701,7 @@ export const WorkspacePermissionsApiFp = function(configuration?: Configuration)
|
|
|
7683
7701
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7684
7702
|
},
|
|
7685
7703
|
/**
|
|
7686
|
-
* Removes the permission assignment for a user or group within the workspace,
|
|
7704
|
+
* Removes the permission assignment for a user or group within the workspace, revoking their access to workspace resources. **Authorization**: Requires workspace manager permissions. **Side Effects**: User/group loses access to workspace resources.
|
|
7687
7705
|
* @summary Delete workspace permission
|
|
7688
7706
|
* @param {string} organizationName The unique identifier of the organization
|
|
7689
7707
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7698,7 +7716,7 @@ export const WorkspacePermissionsApiFp = function(configuration?: Configuration)
|
|
|
7698
7716
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7699
7717
|
},
|
|
7700
7718
|
/**
|
|
7701
|
-
* Retrieves the permission details for a specific user or group within the workspace,
|
|
7719
|
+
* Retrieves the permission details for a specific user or group within the workspace, including their role and access level. **Authorization**: Requires workspace manager permissions. **Response**: Returns permission object with role and metadata.
|
|
7702
7720
|
* @summary Get workspace permission
|
|
7703
7721
|
* @param {string} organizationName The unique identifier of the organization
|
|
7704
7722
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7713,7 +7731,7 @@ export const WorkspacePermissionsApiFp = function(configuration?: Configuration)
|
|
|
7713
7731
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7714
7732
|
},
|
|
7715
7733
|
/**
|
|
7716
|
-
* Retrieves all permission assignments for the specified workspace, including user and group
|
|
7734
|
+
* Retrieves all permission assignments for the specified workspace, including user and group permissions with their roles and access levels. **Authorization**: Requires workspace manager permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
7717
7735
|
* @summary List workspace permissions
|
|
7718
7736
|
* @param {string} organizationName The unique identifier of the organization
|
|
7719
7737
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7743,7 +7761,7 @@ export const WorkspacePermissionsApiFp = function(configuration?: Configuration)
|
|
|
7743
7761
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
7744
7762
|
},
|
|
7745
7763
|
/**
|
|
7746
|
-
* Updates the permission assignment for a user or group within the workspace,
|
|
7764
|
+
* Updates the permission assignment for a user or group within the workspace, modifying their role and access level. **Authorization**: Requires workspace manager permissions. **Validation**: Role changes are validated against workspace constraints.
|
|
7747
7765
|
* @summary Update workspace permission
|
|
7748
7766
|
* @param {string} organizationName The unique identifier of the organization
|
|
7749
7767
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7782,7 +7800,7 @@ export const WorkspacePermissionsApiFactory = function (configuration?: Configur
|
|
|
7782
7800
|
return localVarFp.createWorkspacePackagePermission(organizationName, workspaceName, projectName, packageName, options).then((request) => request(axios, basePath));
|
|
7783
7801
|
},
|
|
7784
7802
|
/**
|
|
7785
|
-
* Creates a new permission assignment for a user or group within the workspace,
|
|
7803
|
+
* Creates a new permission assignment for a user or group within the workspace, granting them specific roles and access levels. Can also be used to request access to the workspace when the user doesn\'t have manager permissions. **Authorization**: Requires workspace manager permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports manager and viewer roles.
|
|
7786
7804
|
* @summary Create workspace permission
|
|
7787
7805
|
* @param {string} organizationName The unique identifier of the organization
|
|
7788
7806
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7795,7 +7813,7 @@ export const WorkspacePermissionsApiFactory = function (configuration?: Configur
|
|
|
7795
7813
|
return localVarFp.createWorkspacePermission(organizationName, workspaceName, requestPermission, workspacePermission, options).then((request) => request(axios, basePath));
|
|
7796
7814
|
},
|
|
7797
7815
|
/**
|
|
7798
|
-
* Removes the permission assignment for a user or group within the workspace,
|
|
7816
|
+
* Removes the permission assignment for a user or group within the workspace, revoking their access to workspace resources. **Authorization**: Requires workspace manager permissions. **Side Effects**: User/group loses access to workspace resources.
|
|
7799
7817
|
* @summary Delete workspace permission
|
|
7800
7818
|
* @param {string} organizationName The unique identifier of the organization
|
|
7801
7819
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7807,7 +7825,7 @@ export const WorkspacePermissionsApiFactory = function (configuration?: Configur
|
|
|
7807
7825
|
return localVarFp.deleteWorkspacePermission(organizationName, workspaceName, userGroupId, options).then((request) => request(axios, basePath));
|
|
7808
7826
|
},
|
|
7809
7827
|
/**
|
|
7810
|
-
* Retrieves the permission details for a specific user or group within the workspace,
|
|
7828
|
+
* Retrieves the permission details for a specific user or group within the workspace, including their role and access level. **Authorization**: Requires workspace manager permissions. **Response**: Returns permission object with role and metadata.
|
|
7811
7829
|
* @summary Get workspace permission
|
|
7812
7830
|
* @param {string} organizationName The unique identifier of the organization
|
|
7813
7831
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7819,7 +7837,7 @@ export const WorkspacePermissionsApiFactory = function (configuration?: Configur
|
|
|
7819
7837
|
return localVarFp.getWorkspacePermission(organizationName, workspaceName, userGroupId, options).then((request) => request(axios, basePath));
|
|
7820
7838
|
},
|
|
7821
7839
|
/**
|
|
7822
|
-
* Retrieves all permission assignments for the specified workspace, including user and group
|
|
7840
|
+
* Retrieves all permission assignments for the specified workspace, including user and group permissions with their roles and access levels. **Authorization**: Requires workspace manager permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
7823
7841
|
* @summary List workspace permissions
|
|
7824
7842
|
* @param {string} organizationName The unique identifier of the organization
|
|
7825
7843
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7843,7 +7861,7 @@ export const WorkspacePermissionsApiFactory = function (configuration?: Configur
|
|
|
7843
7861
|
return localVarFp.removeWorkspacePackagePermission(organizationName, workspaceName, projectName, packageName, options).then((request) => request(axios, basePath));
|
|
7844
7862
|
},
|
|
7845
7863
|
/**
|
|
7846
|
-
* Updates the permission assignment for a user or group within the workspace,
|
|
7864
|
+
* Updates the permission assignment for a user or group within the workspace, modifying their role and access level. **Authorization**: Requires workspace manager permissions. **Validation**: Role changes are validated against workspace constraints.
|
|
7847
7865
|
* @summary Update workspace permission
|
|
7848
7866
|
* @param {string} organizationName The unique identifier of the organization
|
|
7849
7867
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7881,7 +7899,7 @@ export class WorkspacePermissionsApi extends BaseAPI {
|
|
|
7881
7899
|
}
|
|
7882
7900
|
|
|
7883
7901
|
/**
|
|
7884
|
-
* Creates a new permission assignment for a user or group within the workspace,
|
|
7902
|
+
* Creates a new permission assignment for a user or group within the workspace, granting them specific roles and access levels. Can also be used to request access to the workspace when the user doesn\'t have manager permissions. **Authorization**: Requires workspace manager permissions, unless `requestPermission` is true. **Parameters**: Use `requestPermission` to indicate the user is requesting access to the resource. **Roles**: Supports manager and viewer roles.
|
|
7885
7903
|
* @summary Create workspace permission
|
|
7886
7904
|
* @param {string} organizationName The unique identifier of the organization
|
|
7887
7905
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7896,7 +7914,7 @@ export class WorkspacePermissionsApi extends BaseAPI {
|
|
|
7896
7914
|
}
|
|
7897
7915
|
|
|
7898
7916
|
/**
|
|
7899
|
-
* Removes the permission assignment for a user or group within the workspace,
|
|
7917
|
+
* Removes the permission assignment for a user or group within the workspace, revoking their access to workspace resources. **Authorization**: Requires workspace manager permissions. **Side Effects**: User/group loses access to workspace resources.
|
|
7900
7918
|
* @summary Delete workspace permission
|
|
7901
7919
|
* @param {string} organizationName The unique identifier of the organization
|
|
7902
7920
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7910,7 +7928,7 @@ export class WorkspacePermissionsApi extends BaseAPI {
|
|
|
7910
7928
|
}
|
|
7911
7929
|
|
|
7912
7930
|
/**
|
|
7913
|
-
* Retrieves the permission details for a specific user or group within the workspace,
|
|
7931
|
+
* Retrieves the permission details for a specific user or group within the workspace, including their role and access level. **Authorization**: Requires workspace manager permissions. **Response**: Returns permission object with role and metadata.
|
|
7914
7932
|
* @summary Get workspace permission
|
|
7915
7933
|
* @param {string} organizationName The unique identifier of the organization
|
|
7916
7934
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7924,7 +7942,7 @@ export class WorkspacePermissionsApi extends BaseAPI {
|
|
|
7924
7942
|
}
|
|
7925
7943
|
|
|
7926
7944
|
/**
|
|
7927
|
-
* Retrieves all permission assignments for the specified workspace, including user and group
|
|
7945
|
+
* Retrieves all permission assignments for the specified workspace, including user and group permissions with their roles and access levels. **Authorization**: Requires workspace manager permissions. **Response**: Returns array of permission objects with user/group identifiers and roles.
|
|
7928
7946
|
* @summary List workspace permissions
|
|
7929
7947
|
* @param {string} organizationName The unique identifier of the organization
|
|
7930
7948
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7952,7 +7970,7 @@ export class WorkspacePermissionsApi extends BaseAPI {
|
|
|
7952
7970
|
}
|
|
7953
7971
|
|
|
7954
7972
|
/**
|
|
7955
|
-
* Updates the permission assignment for a user or group within the workspace,
|
|
7973
|
+
* Updates the permission assignment for a user or group within the workspace, modifying their role and access level. **Authorization**: Requires workspace manager permissions. **Validation**: Role changes are validated against workspace constraints.
|
|
7956
7974
|
* @summary Update workspace permission
|
|
7957
7975
|
* @param {string} organizationName The unique identifier of the organization
|
|
7958
7976
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -7976,7 +7994,7 @@ export class WorkspacePermissionsApi extends BaseAPI {
|
|
|
7976
7994
|
export const WorkspacesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
7977
7995
|
return {
|
|
7978
7996
|
/**
|
|
7979
|
-
* Creates a new collaborative workspace within the organization for team-based data
|
|
7997
|
+
* Creates a new collaborative workspace within the organization for team-based data modeling and analysis activities. **Authorization**: Requires organization admin permissions. **Features**: Workspaces support document management and package access control.
|
|
7980
7998
|
* @summary Create a new workspace
|
|
7981
7999
|
* @param {string} organizationName The unique identifier of the organization
|
|
7982
8000
|
* @param {Workspace} [workspace]
|
|
@@ -8014,7 +8032,7 @@ export const WorkspacesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
8014
8032
|
};
|
|
8015
8033
|
},
|
|
8016
8034
|
/**
|
|
8017
|
-
* Permanently deletes a workspace and all its associated data, including packages,
|
|
8035
|
+
* Permanently deletes a workspace and all its associated data, including packages, permissions, and configuration. This action cannot be undone.
|
|
8018
8036
|
* @summary Delete workspace
|
|
8019
8037
|
* @param {string} organizationName The unique identifier of the organization
|
|
8020
8038
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8052,7 +8070,7 @@ export const WorkspacesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
8052
8070
|
};
|
|
8053
8071
|
},
|
|
8054
8072
|
/**
|
|
8055
|
-
* Retrieves detailed information about a specific workspace, including its metadata,
|
|
8073
|
+
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8056
8074
|
* @summary Get workspace details
|
|
8057
8075
|
* @param {string} organizationName The unique identifier of the organization
|
|
8058
8076
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8095,7 +8113,7 @@ export const WorkspacesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
8095
8113
|
};
|
|
8096
8114
|
},
|
|
8097
8115
|
/**
|
|
8098
|
-
* Retrieves all workspaces within the specified organization, optionally filtered to
|
|
8116
|
+
* Retrieves all workspaces within the specified organization, optionally filtered to show only writable workspaces for the current user. **Authorization**: Requires read access to the organization. **Filtering**: Use `onlyWritable` parameter to filter for workspaces with write access.
|
|
8099
8117
|
* @summary List workspaces in organization
|
|
8100
8118
|
* @param {string} organizationName The unique identifier of the organization
|
|
8101
8119
|
* @param {boolean} [onlyWritable] Whether to filter for workspaces with write access only
|
|
@@ -8134,7 +8152,7 @@ export const WorkspacesApiAxiosParamCreator = function (configuration?: Configur
|
|
|
8134
8152
|
};
|
|
8135
8153
|
},
|
|
8136
8154
|
/**
|
|
8137
|
-
* Partially updates a workspace\'s details, including description and configuration settings.
|
|
8155
|
+
* Partially updates a workspace\'s details, including description and configuration settings. Only the provided fields will be updated. **Authorization**: Requires workspace manager permissions. **Fields**: Can update description and other workspace metadata.
|
|
8138
8156
|
* @summary Update workspace details
|
|
8139
8157
|
* @param {string} organizationName The unique identifier of the organization
|
|
8140
8158
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8188,7 +8206,7 @@ export const WorkspacesApiFp = function(configuration?: Configuration) {
|
|
|
8188
8206
|
const localVarAxiosParamCreator = WorkspacesApiAxiosParamCreator(configuration)
|
|
8189
8207
|
return {
|
|
8190
8208
|
/**
|
|
8191
|
-
* Creates a new collaborative workspace within the organization for team-based data
|
|
8209
|
+
* Creates a new collaborative workspace within the organization for team-based data modeling and analysis activities. **Authorization**: Requires organization admin permissions. **Features**: Workspaces support document management and package access control.
|
|
8192
8210
|
* @summary Create a new workspace
|
|
8193
8211
|
* @param {string} organizationName The unique identifier of the organization
|
|
8194
8212
|
* @param {Workspace} [workspace]
|
|
@@ -8202,7 +8220,7 @@ export const WorkspacesApiFp = function(configuration?: Configuration) {
|
|
|
8202
8220
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8203
8221
|
},
|
|
8204
8222
|
/**
|
|
8205
|
-
* Permanently deletes a workspace and all its associated data, including packages,
|
|
8223
|
+
* Permanently deletes a workspace and all its associated data, including packages, permissions, and configuration. This action cannot be undone.
|
|
8206
8224
|
* @summary Delete workspace
|
|
8207
8225
|
* @param {string} organizationName The unique identifier of the organization
|
|
8208
8226
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8216,7 +8234,7 @@ export const WorkspacesApiFp = function(configuration?: Configuration) {
|
|
|
8216
8234
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8217
8235
|
},
|
|
8218
8236
|
/**
|
|
8219
|
-
* Retrieves detailed information about a specific workspace, including its metadata,
|
|
8237
|
+
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8220
8238
|
* @summary Get workspace details
|
|
8221
8239
|
* @param {string} organizationName The unique identifier of the organization
|
|
8222
8240
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8231,7 +8249,7 @@ export const WorkspacesApiFp = function(configuration?: Configuration) {
|
|
|
8231
8249
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8232
8250
|
},
|
|
8233
8251
|
/**
|
|
8234
|
-
* Retrieves all workspaces within the specified organization, optionally filtered to
|
|
8252
|
+
* Retrieves all workspaces within the specified organization, optionally filtered to show only writable workspaces for the current user. **Authorization**: Requires read access to the organization. **Filtering**: Use `onlyWritable` parameter to filter for workspaces with write access.
|
|
8235
8253
|
* @summary List workspaces in organization
|
|
8236
8254
|
* @param {string} organizationName The unique identifier of the organization
|
|
8237
8255
|
* @param {boolean} [onlyWritable] Whether to filter for workspaces with write access only
|
|
@@ -8245,7 +8263,7 @@ export const WorkspacesApiFp = function(configuration?: Configuration) {
|
|
|
8245
8263
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
8246
8264
|
},
|
|
8247
8265
|
/**
|
|
8248
|
-
* Partially updates a workspace\'s details, including description and configuration settings.
|
|
8266
|
+
* Partially updates a workspace\'s details, including description and configuration settings. Only the provided fields will be updated. **Authorization**: Requires workspace manager permissions. **Fields**: Can update description and other workspace metadata.
|
|
8249
8267
|
* @summary Update workspace details
|
|
8250
8268
|
* @param {string} organizationName The unique identifier of the organization
|
|
8251
8269
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8270,7 +8288,7 @@ export const WorkspacesApiFactory = function (configuration?: Configuration, bas
|
|
|
8270
8288
|
const localVarFp = WorkspacesApiFp(configuration)
|
|
8271
8289
|
return {
|
|
8272
8290
|
/**
|
|
8273
|
-
* Creates a new collaborative workspace within the organization for team-based data
|
|
8291
|
+
* Creates a new collaborative workspace within the organization for team-based data modeling and analysis activities. **Authorization**: Requires organization admin permissions. **Features**: Workspaces support document management and package access control.
|
|
8274
8292
|
* @summary Create a new workspace
|
|
8275
8293
|
* @param {string} organizationName The unique identifier of the organization
|
|
8276
8294
|
* @param {Workspace} [workspace]
|
|
@@ -8281,7 +8299,7 @@ export const WorkspacesApiFactory = function (configuration?: Configuration, bas
|
|
|
8281
8299
|
return localVarFp.createWorkspace(organizationName, workspace, options).then((request) => request(axios, basePath));
|
|
8282
8300
|
},
|
|
8283
8301
|
/**
|
|
8284
|
-
* Permanently deletes a workspace and all its associated data, including packages,
|
|
8302
|
+
* Permanently deletes a workspace and all its associated data, including packages, permissions, and configuration. This action cannot be undone.
|
|
8285
8303
|
* @summary Delete workspace
|
|
8286
8304
|
* @param {string} organizationName The unique identifier of the organization
|
|
8287
8305
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8292,7 +8310,7 @@ export const WorkspacesApiFactory = function (configuration?: Configuration, bas
|
|
|
8292
8310
|
return localVarFp.deleteWorkspace(organizationName, workspaceName, options).then((request) => request(axios, basePath));
|
|
8293
8311
|
},
|
|
8294
8312
|
/**
|
|
8295
|
-
* Retrieves detailed information about a specific workspace, including its metadata,
|
|
8313
|
+
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8296
8314
|
* @summary Get workspace details
|
|
8297
8315
|
* @param {string} organizationName The unique identifier of the organization
|
|
8298
8316
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8304,7 +8322,7 @@ export const WorkspacesApiFactory = function (configuration?: Configuration, bas
|
|
|
8304
8322
|
return localVarFp.getWorkspace(organizationName, workspaceName, checkAdmin, options).then((request) => request(axios, basePath));
|
|
8305
8323
|
},
|
|
8306
8324
|
/**
|
|
8307
|
-
* Retrieves all workspaces within the specified organization, optionally filtered to
|
|
8325
|
+
* Retrieves all workspaces within the specified organization, optionally filtered to show only writable workspaces for the current user. **Authorization**: Requires read access to the organization. **Filtering**: Use `onlyWritable` parameter to filter for workspaces with write access.
|
|
8308
8326
|
* @summary List workspaces in organization
|
|
8309
8327
|
* @param {string} organizationName The unique identifier of the organization
|
|
8310
8328
|
* @param {boolean} [onlyWritable] Whether to filter for workspaces with write access only
|
|
@@ -8315,7 +8333,7 @@ export const WorkspacesApiFactory = function (configuration?: Configuration, bas
|
|
|
8315
8333
|
return localVarFp.listWorkspaces(organizationName, onlyWritable, options).then((request) => request(axios, basePath));
|
|
8316
8334
|
},
|
|
8317
8335
|
/**
|
|
8318
|
-
* Partially updates a workspace\'s details, including description and configuration settings.
|
|
8336
|
+
* Partially updates a workspace\'s details, including description and configuration settings. Only the provided fields will be updated. **Authorization**: Requires workspace manager permissions. **Fields**: Can update description and other workspace metadata.
|
|
8319
8337
|
* @summary Update workspace details
|
|
8320
8338
|
* @param {string} organizationName The unique identifier of the organization
|
|
8321
8339
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8337,7 +8355,7 @@ export const WorkspacesApiFactory = function (configuration?: Configuration, bas
|
|
|
8337
8355
|
*/
|
|
8338
8356
|
export class WorkspacesApi extends BaseAPI {
|
|
8339
8357
|
/**
|
|
8340
|
-
* Creates a new collaborative workspace within the organization for team-based data
|
|
8358
|
+
* Creates a new collaborative workspace within the organization for team-based data modeling and analysis activities. **Authorization**: Requires organization admin permissions. **Features**: Workspaces support document management and package access control.
|
|
8341
8359
|
* @summary Create a new workspace
|
|
8342
8360
|
* @param {string} organizationName The unique identifier of the organization
|
|
8343
8361
|
* @param {Workspace} [workspace]
|
|
@@ -8350,7 +8368,7 @@ export class WorkspacesApi extends BaseAPI {
|
|
|
8350
8368
|
}
|
|
8351
8369
|
|
|
8352
8370
|
/**
|
|
8353
|
-
* Permanently deletes a workspace and all its associated data, including packages,
|
|
8371
|
+
* Permanently deletes a workspace and all its associated data, including packages, permissions, and configuration. This action cannot be undone.
|
|
8354
8372
|
* @summary Delete workspace
|
|
8355
8373
|
* @param {string} organizationName The unique identifier of the organization
|
|
8356
8374
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8363,7 +8381,7 @@ export class WorkspacesApi extends BaseAPI {
|
|
|
8363
8381
|
}
|
|
8364
8382
|
|
|
8365
8383
|
/**
|
|
8366
|
-
* Retrieves detailed information about a specific workspace, including its metadata,
|
|
8384
|
+
* Retrieves detailed information about a specific workspace, including its metadata, associated packages, and configuration settings.
|
|
8367
8385
|
* @summary Get workspace details
|
|
8368
8386
|
* @param {string} organizationName The unique identifier of the organization
|
|
8369
8387
|
* @param {string} workspaceName The unique identifier of the workspace
|
|
@@ -8377,7 +8395,7 @@ export class WorkspacesApi extends BaseAPI {
|
|
|
8377
8395
|
}
|
|
8378
8396
|
|
|
8379
8397
|
/**
|
|
8380
|
-
* Retrieves all workspaces within the specified organization, optionally filtered to
|
|
8398
|
+
* Retrieves all workspaces within the specified organization, optionally filtered to show only writable workspaces for the current user. **Authorization**: Requires read access to the organization. **Filtering**: Use `onlyWritable` parameter to filter for workspaces with write access.
|
|
8381
8399
|
* @summary List workspaces in organization
|
|
8382
8400
|
* @param {string} organizationName The unique identifier of the organization
|
|
8383
8401
|
* @param {boolean} [onlyWritable] Whether to filter for workspaces with write access only
|
|
@@ -8390,7 +8408,7 @@ export class WorkspacesApi extends BaseAPI {
|
|
|
8390
8408
|
}
|
|
8391
8409
|
|
|
8392
8410
|
/**
|
|
8393
|
-
* Partially updates a workspace\'s details, including description and configuration settings.
|
|
8411
|
+
* Partially updates a workspace\'s details, including description and configuration settings. Only the provided fields will be updated. **Authorization**: Requires workspace manager permissions. **Fields**: Can update description and other workspace metadata.
|
|
8394
8412
|
* @summary Update workspace details
|
|
8395
8413
|
* @param {string} organizationName The unique identifier of the organization
|
|
8396
8414
|
* @param {string} workspaceName The unique identifier of the workspace
|