@cosmotech/api-ts 5.1.0-rc2 → 5.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.github/workflows/publish.yaml +2 -2
- package/.openapi-generator/FILES +19 -0
- package/.openapi-generator/VERSION +1 -1
- package/README.md +27 -2
- package/api.ts +839 -16
- package/base.ts +1 -1
- package/common.ts +3 -3
- package/configuration.ts +2 -1
- package/dist/api.d.ts +620 -102
- package/dist/api.js +715 -5
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +2 -2
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/DatasetApi.md +59 -0
- package/docs/DatasetMemberGroup.md +25 -0
- package/docs/DatasetMemberUser.md +23 -0
- package/docs/DatasetMembers.md +23 -0
- package/docs/IAMInfoApi.md +95 -0
- package/docs/MemberGroup.md +25 -0
- package/docs/MemberUser.md +23 -0
- package/docs/Members.md +23 -0
- package/docs/OrganizationApi.md +52 -0
- package/docs/OrganizationMemberGroup.md +25 -0
- package/docs/OrganizationMemberUser.md +23 -0
- package/docs/OrganizationMembers.md +23 -0
- package/docs/RunnerApi.md +59 -0
- package/docs/RunnerMemberGroup.md +25 -0
- package/docs/RunnerMemberUser.md +23 -0
- package/docs/RunnerMembers.md +23 -0
- package/docs/SolutionApi.md +56 -0
- package/docs/SolutionMemberGroup.md +25 -0
- package/docs/SolutionMemberUser.md +23 -0
- package/docs/SolutionMembers.md +23 -0
- package/docs/WorkspaceApi.md +56 -0
- package/docs/WorkspaceMemberGroup.md +25 -0
- package/docs/WorkspaceMemberUser.md +23 -0
- package/docs/WorkspaceMembers.md +23 -0
- package/git_push.sh +14 -17
- package/index.ts +1 -1
- package/package.json +2 -2
package/dist/base.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.0
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/base.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.
|
|
8
|
+
* The version of the OpenAPI document: 5.2.0
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.0
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/common.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.
|
|
8
|
+
* The version of the OpenAPI document: 5.2.0
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.0
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/configuration.js
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
* Cosmo Tech Platform API
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
*
|
|
7
|
-
* The version of the OpenAPI document: 5.
|
|
7
|
+
* The version of the OpenAPI document: 5.2.0
|
|
8
8
|
* Contact: platform@cosmotech.com
|
|
9
9
|
*
|
|
10
10
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
@@ -35,7 +35,7 @@ var Configuration = /** @class */ (function () {
|
|
|
35
35
|
this.awsv4 = param.awsv4;
|
|
36
36
|
this.basePath = param.basePath;
|
|
37
37
|
this.serverIndex = param.serverIndex;
|
|
38
|
-
this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign({}, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
38
|
+
this.baseOptions = __assign(__assign({}, param.baseOptions), { headers: __assign({ 'User-Agent': "cosmotech-api-typescript/5.2.0" }, (_a = param.baseOptions) === null || _a === void 0 ? void 0 : _a.headers) });
|
|
39
39
|
this.formDataCtor = param.formDataCtor;
|
|
40
40
|
}
|
|
41
41
|
/**
|
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
* Cosmo Tech Platform API
|
|
3
3
|
* Cosmo Tech Platform API
|
|
4
4
|
*
|
|
5
|
-
* The version of the OpenAPI document: 5.
|
|
5
|
+
* The version of the OpenAPI document: 5.2.0
|
|
6
6
|
* Contact: platform@cosmotech.com
|
|
7
7
|
*
|
|
8
8
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/dist/index.js
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
* Cosmo Tech Platform API
|
|
6
6
|
* Cosmo Tech Platform API
|
|
7
7
|
*
|
|
8
|
-
* The version of the OpenAPI document: 5.
|
|
8
|
+
* The version of the OpenAPI document: 5.2.0
|
|
9
9
|
* Contact: platform@cosmotech.com
|
|
10
10
|
*
|
|
11
11
|
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
package/docs/DatasetApi.md
CHANGED
|
@@ -13,6 +13,7 @@ All URIs are relative to *http://localhost:8080*
|
|
|
13
13
|
|[**downloadDatasetPart**](#downloaddatasetpart) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id}/download | Download data from a dataset part|
|
|
14
14
|
|[**getDataset**](#getdataset) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id} | Retrieve a Dataset|
|
|
15
15
|
|[**getDatasetAccessControl**](#getdatasetaccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/access/{identity_id} | Get a control access for the Dataset|
|
|
16
|
+
|[**getDatasetMembers**](#getdatasetmembers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/members | Get the members of a Dataset|
|
|
16
17
|
|[**getDatasetPart**](#getdatasetpart) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts/{dataset_part_id} | Retrieve a data part of a Dataset|
|
|
17
18
|
|[**listDatasetParts**](#listdatasetparts) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/parts | Retrieve all dataset parts of a Dataset|
|
|
18
19
|
|[**listDatasetSecurityUsers**](#listdatasetsecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/datasets/{dataset_id}/security/users | Get the Dataset security users list|
|
|
@@ -581,6 +582,64 @@ const { status, data } = await apiInstance.getDatasetAccessControl(
|
|
|
581
582
|
|
|
582
583
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
583
584
|
|
|
585
|
+
# **getDatasetMembers**
|
|
586
|
+
> DatasetMembers getDatasetMembers()
|
|
587
|
+
|
|
588
|
+
Retrieve detailed information about members of a dataset.
|
|
589
|
+
|
|
590
|
+
### Example
|
|
591
|
+
|
|
592
|
+
```typescript
|
|
593
|
+
import {
|
|
594
|
+
DatasetApi,
|
|
595
|
+
Configuration
|
|
596
|
+
} from '@cosmotech/api-ts';
|
|
597
|
+
|
|
598
|
+
const configuration = new Configuration();
|
|
599
|
+
const apiInstance = new DatasetApi(configuration);
|
|
600
|
+
|
|
601
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
602
|
+
let workspaceId: string; //the Workspace identifier (default to undefined)
|
|
603
|
+
let datasetId: string; //the Dataset identifier (default to undefined)
|
|
604
|
+
|
|
605
|
+
const { status, data } = await apiInstance.getDatasetMembers(
|
|
606
|
+
organizationId,
|
|
607
|
+
workspaceId,
|
|
608
|
+
datasetId
|
|
609
|
+
);
|
|
610
|
+
```
|
|
611
|
+
|
|
612
|
+
### Parameters
|
|
613
|
+
|
|
614
|
+
|Name | Type | Description | Notes|
|
|
615
|
+
|------------- | ------------- | ------------- | -------------|
|
|
616
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
617
|
+
| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
|
|
618
|
+
| **datasetId** | [**string**] | the Dataset identifier | defaults to undefined|
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
### Return type
|
|
622
|
+
|
|
623
|
+
**DatasetMembers**
|
|
624
|
+
|
|
625
|
+
### Authorization
|
|
626
|
+
|
|
627
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
628
|
+
|
|
629
|
+
### HTTP request headers
|
|
630
|
+
|
|
631
|
+
- **Content-Type**: Not defined
|
|
632
|
+
- **Accept**: application/json, application/yaml
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
### HTTP response details
|
|
636
|
+
| Status code | Description | Response headers |
|
|
637
|
+
|-------------|-------------|------------------|
|
|
638
|
+
|**200** | The Dataset members | - |
|
|
639
|
+
|**404** | The Dataset specified is unknown or you don\'t have access to it | - |
|
|
640
|
+
|
|
641
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
642
|
+
|
|
584
643
|
# **getDatasetPart**
|
|
585
644
|
> DatasetPart getDatasetPart()
|
|
586
645
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# DatasetMemberGroup
|
|
2
|
+
|
|
3
|
+
A group member of the dataset
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The group id | [default to undefined]
|
|
10
|
+
**role** | **string** | The group role in the dataset | [default to undefined]
|
|
11
|
+
**users** | **Array<string>** | The list of users in the group | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { DatasetMemberGroup } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: DatasetMemberGroup = {
|
|
19
|
+
id,
|
|
20
|
+
role,
|
|
21
|
+
users,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# DatasetMemberUser
|
|
2
|
+
|
|
3
|
+
A user member of the dataset
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The user id | [default to undefined]
|
|
10
|
+
**role** | **string** | The user role in the dataset | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { DatasetMemberUser } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: DatasetMemberUser = {
|
|
18
|
+
id,
|
|
19
|
+
role,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# DatasetMembers
|
|
2
|
+
|
|
3
|
+
The Dataset members, including users and groups
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**users** | [**Array<DatasetMemberUser>**](DatasetMemberUser.md) | The list of users in the dataset | [default to undefined]
|
|
10
|
+
**groups** | [**Array<DatasetMemberGroup>**](DatasetMemberGroup.md) | The list of groups in the dataset | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { DatasetMembers } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: DatasetMembers = {
|
|
18
|
+
users,
|
|
19
|
+
groups,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
# IAMInfoApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost:8080*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**listIAMGroups**](#listiamgroups) | **GET** /iaminfo/groups | Get the list of all groups|
|
|
8
|
+
|[**listIAMMembers**](#listiammembers) | **GET** /iaminfo/members | Get ALL IAM members list|
|
|
9
|
+
|
|
10
|
+
# **listIAMGroups**
|
|
11
|
+
> Array<string> listIAMGroups()
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import {
|
|
18
|
+
IAMInfoApi,
|
|
19
|
+
Configuration
|
|
20
|
+
} from '@cosmotech/api-ts';
|
|
21
|
+
|
|
22
|
+
const configuration = new Configuration();
|
|
23
|
+
const apiInstance = new IAMInfoApi(configuration);
|
|
24
|
+
|
|
25
|
+
const { status, data } = await apiInstance.listIAMGroups();
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Parameters
|
|
29
|
+
This endpoint does not have any parameters.
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
### Return type
|
|
33
|
+
|
|
34
|
+
**Array<string>**
|
|
35
|
+
|
|
36
|
+
### Authorization
|
|
37
|
+
|
|
38
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
39
|
+
|
|
40
|
+
### HTTP request headers
|
|
41
|
+
|
|
42
|
+
- **Content-Type**: Not defined
|
|
43
|
+
- **Accept**: application/json, application/yaml
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### HTTP response details
|
|
47
|
+
| Status code | Description | Response headers |
|
|
48
|
+
|-------------|-------------|------------------|
|
|
49
|
+
|**200** | The list of all groups | - |
|
|
50
|
+
|
|
51
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
52
|
+
|
|
53
|
+
# **listIAMMembers**
|
|
54
|
+
> Members listIAMMembers()
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### Example
|
|
58
|
+
|
|
59
|
+
```typescript
|
|
60
|
+
import {
|
|
61
|
+
IAMInfoApi,
|
|
62
|
+
Configuration
|
|
63
|
+
} from '@cosmotech/api-ts';
|
|
64
|
+
|
|
65
|
+
const configuration = new Configuration();
|
|
66
|
+
const apiInstance = new IAMInfoApi(configuration);
|
|
67
|
+
|
|
68
|
+
const { status, data } = await apiInstance.listIAMMembers();
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
### Parameters
|
|
72
|
+
This endpoint does not have any parameters.
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
### Return type
|
|
76
|
+
|
|
77
|
+
**Members**
|
|
78
|
+
|
|
79
|
+
### Authorization
|
|
80
|
+
|
|
81
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
82
|
+
|
|
83
|
+
### HTTP request headers
|
|
84
|
+
|
|
85
|
+
- **Content-Type**: Not defined
|
|
86
|
+
- **Accept**: application/json, application/yaml
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
### HTTP response details
|
|
90
|
+
| Status code | Description | Response headers |
|
|
91
|
+
|-------------|-------------|------------------|
|
|
92
|
+
|**200** | The ALL members list | - |
|
|
93
|
+
|
|
94
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
95
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# MemberGroup
|
|
2
|
+
|
|
3
|
+
A group member of the IAM
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The group id | [default to undefined]
|
|
10
|
+
**role** | **string** | The user role in the IAM | [default to undefined]
|
|
11
|
+
**users** | **Array<string>** | The list of users in the group | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { MemberGroup } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: MemberGroup = {
|
|
19
|
+
id,
|
|
20
|
+
role,
|
|
21
|
+
users,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# MemberUser
|
|
2
|
+
|
|
3
|
+
A user member of the IAM
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The user id | [default to undefined]
|
|
10
|
+
**role** | **string** | The user role in the IAM | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MemberUser } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: MemberUser = {
|
|
18
|
+
id,
|
|
19
|
+
role,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Members.md
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# Members
|
|
2
|
+
|
|
3
|
+
The members, including users and groups
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**users** | [**Array<MemberUser>**](MemberUser.md) | The list of users in the IAM | [default to undefined]
|
|
10
|
+
**groups** | [**Array<MemberGroup>**](MemberGroup.md) | The list of groups in the IAM | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { Members } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: Members = {
|
|
18
|
+
users,
|
|
19
|
+
groups,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/OrganizationApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost:8080*
|
|
|
10
10
|
|[**deleteOrganizationAccessControl**](#deleteorganizationaccesscontrol) | **DELETE** /organizations/{organization_id}/security/access/{identity_id} | Remove the specified access from the given Organization|
|
|
11
11
|
|[**getOrganization**](#getorganization) | **GET** /organizations/{organization_id} | Get the details of an Organization|
|
|
12
12
|
|[**getOrganizationAccessControl**](#getorganizationaccesscontrol) | **GET** /organizations/{organization_id}/security/access/{identity_id} | Get a control access for the Organization|
|
|
13
|
+
|[**getOrganizationMembers**](#getorganizationmembers) | **GET** /organizations/{organization_id}/members | Get the members of an Organization|
|
|
13
14
|
|[**getOrganizationPermissions**](#getorganizationpermissions) | **GET** /organizations/{organization_id}/permissions/{role} | Get the Organization permissions by given role|
|
|
14
15
|
|[**getOrganizationSecurity**](#getorganizationsecurity) | **GET** /organizations/{organization_id}/security | Get the Organization security information|
|
|
15
16
|
|[**listOrganizationSecurityUsers**](#listorganizationsecurityusers) | **GET** /organizations/{organization_id}/security/users | Get the Organization security users list|
|
|
@@ -340,6 +341,57 @@ const { status, data } = await apiInstance.getOrganizationAccessControl(
|
|
|
340
341
|
|
|
341
342
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
342
343
|
|
|
344
|
+
# **getOrganizationMembers**
|
|
345
|
+
> OrganizationMembers getOrganizationMembers()
|
|
346
|
+
|
|
347
|
+
Retrieve detailed information about members of an organization.
|
|
348
|
+
|
|
349
|
+
### Example
|
|
350
|
+
|
|
351
|
+
```typescript
|
|
352
|
+
import {
|
|
353
|
+
OrganizationApi,
|
|
354
|
+
Configuration
|
|
355
|
+
} from '@cosmotech/api-ts';
|
|
356
|
+
|
|
357
|
+
const configuration = new Configuration();
|
|
358
|
+
const apiInstance = new OrganizationApi(configuration);
|
|
359
|
+
|
|
360
|
+
let organizationId: string; //The Organization identifier (default to undefined)
|
|
361
|
+
|
|
362
|
+
const { status, data } = await apiInstance.getOrganizationMembers(
|
|
363
|
+
organizationId
|
|
364
|
+
);
|
|
365
|
+
```
|
|
366
|
+
|
|
367
|
+
### Parameters
|
|
368
|
+
|
|
369
|
+
|Name | Type | Description | Notes|
|
|
370
|
+
|------------- | ------------- | ------------- | -------------|
|
|
371
|
+
| **organizationId** | [**string**] | The Organization identifier | defaults to undefined|
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
### Return type
|
|
375
|
+
|
|
376
|
+
**OrganizationMembers**
|
|
377
|
+
|
|
378
|
+
### Authorization
|
|
379
|
+
|
|
380
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
381
|
+
|
|
382
|
+
### HTTP request headers
|
|
383
|
+
|
|
384
|
+
- **Content-Type**: Not defined
|
|
385
|
+
- **Accept**: application/json, application/yaml
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
### HTTP response details
|
|
389
|
+
| Status code | Description | Response headers |
|
|
390
|
+
|-------------|-------------|------------------|
|
|
391
|
+
|**200** | The Organization details | - |
|
|
392
|
+
|
|
393
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
394
|
+
|
|
343
395
|
# **getOrganizationPermissions**
|
|
344
396
|
> Array<string> getOrganizationPermissions()
|
|
345
397
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# OrganizationMemberGroup
|
|
2
|
+
|
|
3
|
+
A group member of the organization
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The group id | [default to undefined]
|
|
10
|
+
**role** | **string** | The user role in the organization | [default to undefined]
|
|
11
|
+
**users** | **Array<string>** | The list of users in the group | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { OrganizationMemberGroup } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: OrganizationMemberGroup = {
|
|
19
|
+
id,
|
|
20
|
+
role,
|
|
21
|
+
users,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# OrganizationMemberUser
|
|
2
|
+
|
|
3
|
+
A user member of the organization
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The user id | [default to undefined]
|
|
10
|
+
**role** | **string** | The user role in the organization | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { OrganizationMemberUser } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: OrganizationMemberUser = {
|
|
18
|
+
id,
|
|
19
|
+
role,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# OrganizationMembers
|
|
2
|
+
|
|
3
|
+
The Organization members, including users and groups
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**users** | [**Array<OrganizationMemberUser>**](OrganizationMemberUser.md) | The list of users in the organization | [default to undefined]
|
|
10
|
+
**groups** | [**Array<OrganizationMemberGroup>**](OrganizationMemberGroup.md) | The list of groups in the organization | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { OrganizationMembers } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: OrganizationMembers = {
|
|
18
|
+
users,
|
|
19
|
+
groups,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/RunnerApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost:8080*
|
|
|
10
10
|
|[**deleteRunnerAccessControl**](#deleterunneraccesscontrol) | **DELETE** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Remove the specified access from the given Runner|
|
|
11
11
|
|[**getRunner**](#getrunner) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id} | Get the details of a runner|
|
|
12
12
|
|[**getRunnerAccessControl**](#getrunneraccesscontrol) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/access/{identity_id} | Get a control access for the Runner|
|
|
13
|
+
|[**getRunnerMembers**](#getrunnermembers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/members | Get the members of a Runner|
|
|
13
14
|
|[**getRunnerSecurity**](#getrunnersecurity) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security | Get the Runner security information|
|
|
14
15
|
|[**listRunnerPermissions**](#listrunnerpermissions) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/permissions/{role} | Get the Runner permission by given role|
|
|
15
16
|
|[**listRunnerSecurityUsers**](#listrunnersecurityusers) | **GET** /organizations/{organization_id}/workspaces/{workspace_id}/runners/{runner_id}/security/users | Get the Runner security users list|
|
|
@@ -377,6 +378,64 @@ const { status, data } = await apiInstance.getRunnerAccessControl(
|
|
|
377
378
|
|
|
378
379
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
379
380
|
|
|
381
|
+
# **getRunnerMembers**
|
|
382
|
+
> RunnerMembers getRunnerMembers()
|
|
383
|
+
|
|
384
|
+
Retrieve detailed information about members of a runner.
|
|
385
|
+
|
|
386
|
+
### Example
|
|
387
|
+
|
|
388
|
+
```typescript
|
|
389
|
+
import {
|
|
390
|
+
RunnerApi,
|
|
391
|
+
Configuration
|
|
392
|
+
} from '@cosmotech/api-ts';
|
|
393
|
+
|
|
394
|
+
const configuration = new Configuration();
|
|
395
|
+
const apiInstance = new RunnerApi(configuration);
|
|
396
|
+
|
|
397
|
+
let organizationId: string; //the Organization identifier (default to undefined)
|
|
398
|
+
let workspaceId: string; //the Workspace identifier (default to undefined)
|
|
399
|
+
let runnerId: string; //the Runner identifier (default to undefined)
|
|
400
|
+
|
|
401
|
+
const { status, data } = await apiInstance.getRunnerMembers(
|
|
402
|
+
organizationId,
|
|
403
|
+
workspaceId,
|
|
404
|
+
runnerId
|
|
405
|
+
);
|
|
406
|
+
```
|
|
407
|
+
|
|
408
|
+
### Parameters
|
|
409
|
+
|
|
410
|
+
|Name | Type | Description | Notes|
|
|
411
|
+
|------------- | ------------- | ------------- | -------------|
|
|
412
|
+
| **organizationId** | [**string**] | the Organization identifier | defaults to undefined|
|
|
413
|
+
| **workspaceId** | [**string**] | the Workspace identifier | defaults to undefined|
|
|
414
|
+
| **runnerId** | [**string**] | the Runner identifier | defaults to undefined|
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
### Return type
|
|
418
|
+
|
|
419
|
+
**RunnerMembers**
|
|
420
|
+
|
|
421
|
+
### Authorization
|
|
422
|
+
|
|
423
|
+
[oAuth2AuthCode](../README.md#oAuth2AuthCode)
|
|
424
|
+
|
|
425
|
+
### HTTP request headers
|
|
426
|
+
|
|
427
|
+
- **Content-Type**: Not defined
|
|
428
|
+
- **Accept**: application/json, application/yaml
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
### HTTP response details
|
|
432
|
+
| Status code | Description | Response headers |
|
|
433
|
+
|-------------|-------------|------------------|
|
|
434
|
+
|**200** | The Runner members | - |
|
|
435
|
+
|**404** | the Runner specified is unknown or you don\'t have access to it | - |
|
|
436
|
+
|
|
437
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
438
|
+
|
|
380
439
|
# **getRunnerSecurity**
|
|
381
440
|
> RunnerSecurity getRunnerSecurity()
|
|
382
441
|
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# RunnerMemberGroup
|
|
2
|
+
|
|
3
|
+
A group member of the runner
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The group id | [default to undefined]
|
|
10
|
+
**role** | **string** | The group role in the runner | [default to undefined]
|
|
11
|
+
**users** | **Array<string>** | The list of users in the group | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { RunnerMemberGroup } from '@cosmotech/api-ts';
|
|
17
|
+
|
|
18
|
+
const instance: RunnerMemberGroup = {
|
|
19
|
+
id,
|
|
20
|
+
role,
|
|
21
|
+
users,
|
|
22
|
+
};
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# RunnerMemberUser
|
|
2
|
+
|
|
3
|
+
A user member of the runner
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**id** | **string** | The user id | [default to undefined]
|
|
10
|
+
**role** | **string** | The user role in the runner | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { RunnerMemberUser } from '@cosmotech/api-ts';
|
|
16
|
+
|
|
17
|
+
const instance: RunnerMemberUser = {
|
|
18
|
+
id,
|
|
19
|
+
role,
|
|
20
|
+
};
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|