@meeco/svx-api-sdk 1.0.0-stage.20240502114933.d123429 → 1.0.0-stage.20240624095554.3e253ce
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/.openapi-generator/FILES +2 -0
- package/lib/esm/apis/ConnectionsApi.js +69 -69
- package/lib/esm/apis/HelpersApi.js +14 -8
- package/lib/esm/apis/ItemsApi.js +24 -24
- package/lib/esm/apis/OrganisationsApi.js +176 -176
- package/lib/esm/apis/SecurityRightsApi.js +80 -80
- package/lib/esm/apis/SharesApi.js +24 -24
- package/lib/esm/apis/TenantsApi.js +174 -174
- package/lib/esm/apis/VerifiableCredentialsApi.js +12 -6
- package/lib/esm/apis/VerifiablePresentationsApi.js +1 -0
- package/lib/esm/models/ATOMBlobInfo.js +8 -0
- package/lib/esm/models/ATOMBlobPublicInfo.js +6 -0
- package/lib/esm/models/ATOMFileStorageBackend.js +45 -0
- package/lib/esm/models/ATOMFileStorageConfiguration.js +46 -0
- package/lib/esm/models/VCCredentialTypeModelDtoSchema.js +6 -0
- package/lib/esm/models/VCCredentialTypeSchemaDto.js +6 -0
- package/lib/esm/models/VCInputDescriptorsDto.js +3 -0
- package/lib/esm/models/VCPresentationDefinitionDto.js +0 -3
- package/lib/esm/models/VCPresentationDefinitionToSchemaModel.js +3 -0
- package/lib/esm/models/VCVerifyPresentationRequestResponseDto.js +3 -2
- package/lib/esm/models/index.js +2 -0
- package/lib/types/apis/ConnectionsApi.d.ts +36 -36
- package/lib/types/apis/HelpersApi.d.ts +8 -7
- package/lib/types/apis/ItemsApi.d.ts +18 -18
- package/lib/types/apis/OrganisationsApi.d.ts +82 -82
- package/lib/types/apis/SecurityRightsApi.d.ts +28 -28
- package/lib/types/apis/SharesApi.d.ts +16 -16
- package/lib/types/apis/TenantsApi.d.ts +82 -82
- package/lib/types/apis/VerifiableCredentialsApi.d.ts +6 -4
- package/lib/types/apis/VerifiablePresentationsApi.d.ts +1 -0
- package/lib/types/models/ATOMBlobInfo.d.ts +18 -0
- package/lib/types/models/ATOMBlobPublicInfo.d.ts +12 -0
- package/lib/types/models/ATOMFileStorageBackend.d.ts +37 -0
- package/lib/types/models/ATOMFileStorageConfiguration.d.ts +38 -0
- package/lib/types/models/VCCredentialTypeModelDtoSchema.d.ts +12 -0
- package/lib/types/models/VCCredentialTypeSchemaDto.d.ts +12 -0
- package/lib/types/models/VCInputDescriptorsDto.d.ts +7 -0
- package/lib/types/models/VCPresentationDefinitionDto.d.ts +0 -7
- package/lib/types/models/VCPresentationDefinitionToSchemaModel.d.ts +6 -0
- package/lib/types/models/VCVerifyPresentationRequestResponseDto.d.ts +7 -1
- package/lib/types/models/index.d.ts +2 -0
- package/lib/umd/apis/ConnectionsApi.js +69 -69
- package/lib/umd/apis/HelpersApi.js +14 -8
- package/lib/umd/apis/ItemsApi.js +24 -24
- package/lib/umd/apis/OrganisationsApi.js +176 -176
- package/lib/umd/apis/SecurityRightsApi.js +80 -80
- package/lib/umd/apis/SharesApi.js +24 -24
- package/lib/umd/apis/TenantsApi.js +174 -174
- package/lib/umd/apis/VerifiableCredentialsApi.js +12 -6
- package/lib/umd/apis/VerifiablePresentationsApi.js +1 -0
- package/lib/umd/models/ATOMBlobInfo.js +8 -0
- package/lib/umd/models/ATOMBlobPublicInfo.js +6 -0
- package/lib/umd/models/ATOMFileStorageBackend.js +52 -0
- package/lib/umd/models/ATOMFileStorageConfiguration.js +53 -0
- package/lib/umd/models/VCCredentialTypeModelDtoSchema.js +6 -0
- package/lib/umd/models/VCCredentialTypeSchemaDto.js +6 -0
- package/lib/umd/models/VCInputDescriptorsDto.js +3 -0
- package/lib/umd/models/VCPresentationDefinitionDto.js +0 -3
- package/lib/umd/models/VCPresentationDefinitionToSchemaModel.js +3 -0
- package/lib/umd/models/VCVerifyPresentationRequestResponseDto.js +3 -2
- package/lib/umd/models/index.js +2 -0
- package/package.json +1 -1
|
@@ -116,18 +116,18 @@ export interface ItemsGetRequest {
|
|
|
116
116
|
meecoDelegationId?: string;
|
|
117
117
|
meecoOrganisationId?: string;
|
|
118
118
|
}
|
|
119
|
-
export interface
|
|
120
|
-
|
|
119
|
+
export interface ItemsItemIdDeleteRequest {
|
|
120
|
+
itemId: string;
|
|
121
121
|
meecoDelegationId?: string;
|
|
122
122
|
meecoOrganisationId?: string;
|
|
123
123
|
}
|
|
124
|
-
export interface
|
|
125
|
-
|
|
124
|
+
export interface ItemsItemIdGetRequest {
|
|
125
|
+
itemId: string;
|
|
126
126
|
meecoDelegationId?: string;
|
|
127
127
|
meecoOrganisationId?: string;
|
|
128
128
|
}
|
|
129
|
-
export interface
|
|
130
|
-
|
|
129
|
+
export interface ItemsItemIdPutRequest {
|
|
130
|
+
itemId: string;
|
|
131
131
|
meecoDelegationId?: string;
|
|
132
132
|
meecoOrganisationId?: string;
|
|
133
133
|
putItemsRequest?: PutItemsRequest;
|
|
@@ -316,32 +316,32 @@ export declare class ItemsApi extends runtime.BaseAPI {
|
|
|
316
316
|
* Delete an item. If the item is an item shared with the current user, the corresponding share is deleted together with the item.
|
|
317
317
|
* Delete an item
|
|
318
318
|
*/
|
|
319
|
-
|
|
319
|
+
itemsItemIdDeleteRaw(requestParameters: ItemsItemIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
320
320
|
/**
|
|
321
321
|
* Delete an item. If the item is an item shared with the current user, the corresponding share is deleted together with the item.
|
|
322
322
|
* Delete an item
|
|
323
323
|
*/
|
|
324
|
-
|
|
324
|
+
itemsItemIdDelete(itemId: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
325
325
|
/**
|
|
326
|
-
* Retrieve a specific Item by `
|
|
327
|
-
* Get
|
|
326
|
+
* Retrieve a specific Item by `item_id`.
|
|
327
|
+
* Get item
|
|
328
328
|
*/
|
|
329
|
-
|
|
329
|
+
itemsItemIdGetRaw(requestParameters: ItemsItemIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultItemResponse>>;
|
|
330
330
|
/**
|
|
331
|
-
* Retrieve a specific Item by `
|
|
332
|
-
* Get
|
|
331
|
+
* Retrieve a specific Item by `item_id`.
|
|
332
|
+
* Get item
|
|
333
333
|
*/
|
|
334
|
-
|
|
334
|
+
itemsItemIdGet(itemId: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultItemResponse>;
|
|
335
335
|
/**
|
|
336
|
-
* Update an
|
|
336
|
+
* Update an item specified by `item_id` with fields provided in the JSON body. --- ### Classifications In this endpoint it is possible to link the item and its slots to classification nodes, unlink the item and its slots from classification nodes, and to create classification nodes in user-owned classification schemes if they do not exist yet. There are 2 types of classification schemes: * owned by users - each user can create their own classification nodes * global - nodes are created by the system There are 5 parameters for classification of slots and items in `POST /items`: * `node_id` * `node_name` * `scheme_id` * `scheme_name` * `_destroy` Both a classification scheme and a classification node can be referred to by their name or their ID. If `id` is used, `scheme_id` and `scheme` may be omitted. Flag `_destroy` is used to unlink a classification node from a slot or the item. Example payload classifications: ``` classification_nodes_attributes: [ {id: \"c1b1d2b3-a887-4cc2-86e8-285268df598a\"}, {scheme: \"region\", id: \"315e4e30-93f0-4232-b977-b51f90b18288\"}, {scheme: \"region\", name: \"france\", \"_destroy\": true}, {scheme_id: \"34c8c951-aa25-4d9a-9a9a-dbb5f43b821b\", name: \"netherlands\"}, {scheme_id: \"34c8c951-aa25-4d9a-9a9a-dbb5f43b821b\", id: \"16557bff-21fe-4bb1-8b0a-0a7847dfc7d6\"}, {scheme: \"tag\", name: \"my-own-cool-tag\"} ] ``` If node `france` is missing in scheme region, the service will return an error, because scheme `region` is a global scheme. `(owned_by_user=false)`. If node `my-own-cool-tag` is missing in scheme `tag`, it will be created, because scheme `tag` is a user owned scheme. ---
|
|
337
337
|
* Update an item
|
|
338
338
|
*/
|
|
339
|
-
|
|
339
|
+
itemsItemIdPutRaw(requestParameters: ItemsItemIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultItemResponse>>;
|
|
340
340
|
/**
|
|
341
|
-
* Update an
|
|
341
|
+
* Update an item specified by `item_id` with fields provided in the JSON body. --- ### Classifications In this endpoint it is possible to link the item and its slots to classification nodes, unlink the item and its slots from classification nodes, and to create classification nodes in user-owned classification schemes if they do not exist yet. There are 2 types of classification schemes: * owned by users - each user can create their own classification nodes * global - nodes are created by the system There are 5 parameters for classification of slots and items in `POST /items`: * `node_id` * `node_name` * `scheme_id` * `scheme_name` * `_destroy` Both a classification scheme and a classification node can be referred to by their name or their ID. If `id` is used, `scheme_id` and `scheme` may be omitted. Flag `_destroy` is used to unlink a classification node from a slot or the item. Example payload classifications: ``` classification_nodes_attributes: [ {id: \"c1b1d2b3-a887-4cc2-86e8-285268df598a\"}, {scheme: \"region\", id: \"315e4e30-93f0-4232-b977-b51f90b18288\"}, {scheme: \"region\", name: \"france\", \"_destroy\": true}, {scheme_id: \"34c8c951-aa25-4d9a-9a9a-dbb5f43b821b\", name: \"netherlands\"}, {scheme_id: \"34c8c951-aa25-4d9a-9a9a-dbb5f43b821b\", id: \"16557bff-21fe-4bb1-8b0a-0a7847dfc7d6\"}, {scheme: \"tag\", name: \"my-own-cool-tag\"} ] ``` If node `france` is missing in scheme region, the service will return an error, because scheme `region` is a global scheme. `(owned_by_user=false)`. If node `my-own-cool-tag` is missing in scheme `tag`, it will be created, because scheme `tag` is a user owned scheme. ---
|
|
342
342
|
* Update an item
|
|
343
343
|
*/
|
|
344
|
-
|
|
344
|
+
itemsItemIdPut(itemId: string, meecoDelegationId?: string, meecoOrganisationId?: string, putItemsRequest?: PutItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultItemResponse>;
|
|
345
345
|
/**
|
|
346
346
|
* Create an item populated with slots. There are 3 top-level parameters: * `item` - input data to create an item and its slots. * `template_name`. Each item is cloned from an item template. The name of the item template must be present in this field. In addition to data copied from the item template, template slots become item slots. * `skip_empty_template_slots`. If true, then only those template slots will be created for which incoming parameters are present. Otherwise all template slots become item slots. The parameters in `item` are as follows: * `label` is a human-readable name. `label` is mandatory * `name` is a machine reference. It can be skipped, in that case `name` from the template will be used * `description` can be skipped, in that case `description` from the template will be used * `slots_attributes`. Parameters in `slots_attributes` can be used either to create new slots or update slots cloned from the template slots. `slots_attributes` can be empty, in this case the newly created item will only contain slots cloned from the template * `classification_nodes_attributes` --- ### Matching incoming slot parameters to slots cloned from the template There are 2 cases when slot parameters are used to update an already existing slot cloned from the template: 1. If `slot_type_id` inside parameters for a slot matches `slot_type_id` of a cloned slot, the parameters will be used to update the matched slot. 2. If `name` inside parameters for a slot matches `name` of a cloned slot, the parameters will be used to update the matched slot. In all other cases slot parameters will be used to create a new slot. --- ### Classifications In this endpoint it is possible to link the item and its slots to classification nodes, and to create classification nodes in user-owned classification schemes if they do not exist yet. There are 2 types of classification schemes: * owned by users - each user can create their own classification nodes * global - nodes are created by the system There are 5 parameters for classification of slots and items in `POST /items`: * `id` * `name` * `scheme` * `scheme_name` * `label` Both a classification scheme and a classification node can be referred to by their name or their ID. If `id` is used, `scheme_id` and `scheme` may be omitted. Example payload classifications: ``` classification_nodes_attributes: [ {id: \"c1b1d2b3-a887-4cc2-86e8-285268df598a\"}, {scheme: \"region\", id: \"315e4e30-93f0-4232-b977-b51f90b18288\"}, {scheme: \"region\", name: \"france\"}, {scheme: \"tag\", name: \"Holiday Locations\"}, {scheme_id: \"34c8c951-aa25-4d9a-9a9a-dbb5f43b821b\", name: \"netherlands\"}, {scheme_id: \"34c8c951-aa25-4d9a-9a9a-dbb5f43b821b\", id: \"16557bff-21fe-4bb1-8b0a-0a7847dfc7d6\"}, {scheme: \"tag\", name: \"my-own-cool-tag\"} ] ``` If node `france` is missing in scheme region, the service will return an error, because scheme `region` is a global scheme. `(owned_by_user=false)`. If node `my-own-cool-tag` is missing in scheme `tag`, it will be created, because scheme `tag` is a user owned scheme. --- Here is an example of a minimalistic POST request to this endpoint: ``` { \"template_name\": \"template-name\", \"item\": { \"label\": \"new-item-label\" } } ``` With one slot: ``` { \"template_name\": \"template-name\", \"item\": { \"label\": \"new-item-label\", \"slots_attributes\": [ \"label\": \"a label\", \"encrypted_value\": \"user-encrypted-value\" ] } } ```
|
|
347
347
|
* Create an item
|
|
@@ -31,22 +31,6 @@ export interface ApplicationsPostOperationRequest {
|
|
|
31
31
|
meecoOrganisationId: string;
|
|
32
32
|
applicationsPostRequest?: ApplicationsPostRequest;
|
|
33
33
|
}
|
|
34
|
-
export interface OrgsIdArchivePostRequest {
|
|
35
|
-
id: string;
|
|
36
|
-
}
|
|
37
|
-
export interface OrgsIdDeleteRequest {
|
|
38
|
-
id: string;
|
|
39
|
-
}
|
|
40
|
-
export interface OrgsIdGetRequest {
|
|
41
|
-
id: string;
|
|
42
|
-
}
|
|
43
|
-
export interface OrgsIdPutRequest {
|
|
44
|
-
id: string;
|
|
45
|
-
aTOMCreateOrUpdateOrgRequest: ATOMCreateOrUpdateOrgRequest;
|
|
46
|
-
}
|
|
47
|
-
export interface OrgsIdRestorePostRequest {
|
|
48
|
-
id: string;
|
|
49
|
-
}
|
|
50
34
|
export interface OrgsOrgIdAdminsGetRequest {
|
|
51
35
|
orgId: string;
|
|
52
36
|
status?: OrgsOrgIdAdminsGetStatusEnum;
|
|
@@ -56,21 +40,21 @@ export interface OrgsOrgIdAdminsGetRequest {
|
|
|
56
40
|
order?: OrgsOrgIdAdminsGetOrderEnum;
|
|
57
41
|
nextPageAfter?: string;
|
|
58
42
|
}
|
|
59
|
-
export interface
|
|
43
|
+
export interface OrgsOrgIdAdminsOrgAdminIdArchivePostRequest {
|
|
60
44
|
orgId: string;
|
|
61
|
-
|
|
45
|
+
orgAdminId: string;
|
|
62
46
|
}
|
|
63
|
-
export interface
|
|
47
|
+
export interface OrgsOrgIdAdminsOrgAdminIdDeleteRequest {
|
|
64
48
|
orgId: string;
|
|
65
|
-
|
|
49
|
+
orgAdminId: string;
|
|
66
50
|
}
|
|
67
|
-
export interface
|
|
51
|
+
export interface OrgsOrgIdAdminsOrgAdminIdGetRequest {
|
|
68
52
|
orgId: string;
|
|
69
|
-
|
|
53
|
+
orgAdminId: string;
|
|
70
54
|
}
|
|
71
|
-
export interface
|
|
55
|
+
export interface OrgsOrgIdAdminsOrgAdminIdRestorePostRequest {
|
|
72
56
|
orgId: string;
|
|
73
|
-
|
|
57
|
+
orgAdminId: string;
|
|
74
58
|
}
|
|
75
59
|
export interface OrgsOrgIdAdminsOrgAdminIdSecurityRightsGetRequest {
|
|
76
60
|
orgId: string;
|
|
@@ -81,6 +65,22 @@ export interface OrgsOrgIdAdminsOrgAdminIdSecurityRightsPostRequest {
|
|
|
81
65
|
orgAdminId: string;
|
|
82
66
|
aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
|
|
83
67
|
}
|
|
68
|
+
export interface OrgsOrgIdArchivePostRequest {
|
|
69
|
+
orgId: string;
|
|
70
|
+
}
|
|
71
|
+
export interface OrgsOrgIdDeleteRequest {
|
|
72
|
+
orgId: string;
|
|
73
|
+
}
|
|
74
|
+
export interface OrgsOrgIdGetRequest {
|
|
75
|
+
orgId: string;
|
|
76
|
+
}
|
|
77
|
+
export interface OrgsOrgIdPutRequest {
|
|
78
|
+
orgId: string;
|
|
79
|
+
aTOMCreateOrUpdateOrgRequest: ATOMCreateOrUpdateOrgRequest;
|
|
80
|
+
}
|
|
81
|
+
export interface OrgsOrgIdRestorePostRequest {
|
|
82
|
+
orgId: string;
|
|
83
|
+
}
|
|
84
84
|
export interface OrgsOrgIdSecurityRightsPostRequest {
|
|
85
85
|
orgId: string;
|
|
86
86
|
aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
|
|
@@ -151,56 +151,6 @@ export declare class OrganisationsApi extends runtime.BaseAPI {
|
|
|
151
151
|
* Create application agent
|
|
152
152
|
*/
|
|
153
153
|
applicationsPost(meecoOrganisationId: string, applicationsPostRequest?: ApplicationsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ApplicationsPost201Response>;
|
|
154
|
-
/**
|
|
155
|
-
* Archive an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
156
|
-
* Archive an organisation
|
|
157
|
-
*/
|
|
158
|
-
orgsIdArchivePostRaw(requestParameters: OrgsIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
|
|
159
|
-
/**
|
|
160
|
-
* Archive an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
161
|
-
* Archive an organisation
|
|
162
|
-
*/
|
|
163
|
-
orgsIdArchivePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
|
|
164
|
-
/**
|
|
165
|
-
* Delete an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
166
|
-
* Delete an organisation
|
|
167
|
-
*/
|
|
168
|
-
orgsIdDeleteRaw(requestParameters: OrgsIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
169
|
-
/**
|
|
170
|
-
* Delete an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
171
|
-
* Delete an organisation
|
|
172
|
-
*/
|
|
173
|
-
orgsIdDelete(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
174
|
-
/**
|
|
175
|
-
* Show an organisation. In order to execute this action the current user must have * global security `atom:global:view_all_orgs` or * security right `atom:tenant:view_tenant_orgs` for the tenant * security right `atom:org:view_org` for the org with the ID in parameter `org_id`
|
|
176
|
-
* View an organisation
|
|
177
|
-
*/
|
|
178
|
-
orgsIdGetRaw(requestParameters: OrgsIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
|
|
179
|
-
/**
|
|
180
|
-
* Show an organisation. In order to execute this action the current user must have * global security `atom:global:view_all_orgs` or * security right `atom:tenant:view_tenant_orgs` for the tenant * security right `atom:org:view_org` for the org with the ID in parameter `org_id`
|
|
181
|
-
* View an organisation
|
|
182
|
-
*/
|
|
183
|
-
orgsIdGet(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
|
|
184
|
-
/**
|
|
185
|
-
* Update an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.
|
|
186
|
-
* Update an organisation
|
|
187
|
-
*/
|
|
188
|
-
orgsIdPutRaw(requestParameters: OrgsIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
|
|
189
|
-
/**
|
|
190
|
-
* Update an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.
|
|
191
|
-
* Update an organisation
|
|
192
|
-
*/
|
|
193
|
-
orgsIdPut(id: string, aTOMCreateOrUpdateOrgRequest: ATOMCreateOrUpdateOrgRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
|
|
194
|
-
/**
|
|
195
|
-
* Restore an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
196
|
-
* Restore an organisation
|
|
197
|
-
*/
|
|
198
|
-
orgsIdRestorePostRaw(requestParameters: OrgsIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
|
|
199
|
-
/**
|
|
200
|
-
* Restore an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
201
|
-
* Restore an organisation
|
|
202
|
-
*/
|
|
203
|
-
orgsIdRestorePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
|
|
204
154
|
/**
|
|
205
155
|
* List admins of an organisation. It is also possible to request a list of archived admins of the organisation, that is, users who used to have organisation security rights for the given organisation, but do not have them now. In order to execute this action the current user must have * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or * global security right `atom:global:list_admins_of_all_orgs
|
|
206
156
|
* List admins of an organisation
|
|
@@ -215,42 +165,42 @@ export declare class OrganisationsApi extends runtime.BaseAPI {
|
|
|
215
165
|
* Remove a user from admins of the given organisation, and put the admin into the registry of former admins of that organisation. In order to execute this action the current user must one of the following security rights: * `atom:global:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:org:assign_org_sr_to_user`
|
|
216
166
|
* Archive an organisation admin
|
|
217
167
|
*/
|
|
218
|
-
|
|
168
|
+
orgsOrgIdAdminsOrgAdminIdArchivePostRaw(requestParameters: OrgsOrgIdAdminsOrgAdminIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
219
169
|
/**
|
|
220
170
|
* Remove a user from admins of the given organisation, and put the admin into the registry of former admins of that organisation. In order to execute this action the current user must one of the following security rights: * `atom:global:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:org:assign_org_sr_to_user`
|
|
221
171
|
* Archive an organisation admin
|
|
222
172
|
*/
|
|
223
|
-
|
|
173
|
+
orgsOrgIdAdminsOrgAdminIdArchivePost(orgId: string, orgAdminId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
224
174
|
/**
|
|
225
175
|
* Remove a user from organisation admins. In order to execute this action the current user must one of the following security rights: * `atom:global:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:org:assign_org_sr_to_user`
|
|
226
176
|
* Remove a user from organisation admins
|
|
227
177
|
*/
|
|
228
|
-
|
|
178
|
+
orgsOrgIdAdminsOrgAdminIdDeleteRaw(requestParameters: OrgsOrgIdAdminsOrgAdminIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
229
179
|
/**
|
|
230
180
|
* Remove a user from organisation admins. In order to execute this action the current user must one of the following security rights: * `atom:global:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:org:assign_org_sr_to_user`
|
|
231
181
|
* Remove a user from organisation admins
|
|
232
182
|
*/
|
|
233
|
-
|
|
183
|
+
orgsOrgIdAdminsOrgAdminIdDelete(orgId: string, orgAdminId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
234
184
|
/**
|
|
235
185
|
* Show an admin of a given organisation. In order to execute this action the current user must have * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or * global security right `atom:global:list_admins_of_all_orgs
|
|
236
186
|
* Show an admin of a given organisation
|
|
237
187
|
*/
|
|
238
|
-
|
|
188
|
+
orgsOrgIdAdminsOrgAdminIdGetRaw(requestParameters: OrgsOrgIdAdminsOrgAdminIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMAdmin>>;
|
|
239
189
|
/**
|
|
240
190
|
* Show an admin of a given organisation. In order to execute this action the current user must have * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or * global security right `atom:global:list_admins_of_all_orgs
|
|
241
191
|
* Show an admin of a given organisation
|
|
242
192
|
*/
|
|
243
|
-
|
|
193
|
+
orgsOrgIdAdminsOrgAdminIdGet(orgId: string, orgAdminId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
|
|
244
194
|
/**
|
|
245
195
|
* Reinstate an archived user and make him/her a org admin again. In order to execute this action the current user must one of the following security rights: * `atom:org:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:global:assign_org_sr_to_user`
|
|
246
196
|
* Restore an archived organisation admin
|
|
247
197
|
*/
|
|
248
|
-
|
|
198
|
+
orgsOrgIdAdminsOrgAdminIdRestorePostRaw(requestParameters: OrgsOrgIdAdminsOrgAdminIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMAdmin>>;
|
|
249
199
|
/**
|
|
250
200
|
* Reinstate an archived user and make him/her a org admin again. In order to execute this action the current user must one of the following security rights: * `atom:org:assign_org_sr_to_user` * `atom:tenant:assign_org_sr_to_user` * `atom:global:assign_org_sr_to_user`
|
|
251
201
|
* Restore an archived organisation admin
|
|
252
202
|
*/
|
|
253
|
-
|
|
203
|
+
orgsOrgIdAdminsOrgAdminIdRestorePost(orgId: string, orgAdminId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
|
|
254
204
|
/**
|
|
255
205
|
* List organisation security rights of a organisation admin. In order to execute this action the current user must have security right `atom:org:list_org_admin_sr` for the organisation with the ID in parameter `org_id` or `atom:tenant:list_org_admin_sr` for the tenant that the organisation belongs to, or global security right `atom:global:list_admin_sr_of_any_admin`\"
|
|
256
206
|
* List security rights of an organisation admin
|
|
@@ -271,6 +221,56 @@ export declare class OrganisationsApi extends runtime.BaseAPI {
|
|
|
271
221
|
* Assign organisation security rights to an organisation admin
|
|
272
222
|
*/
|
|
273
223
|
orgsOrgIdAdminsOrgAdminIdSecurityRightsPost(orgId: string, orgAdminId: string, aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
224
|
+
/**
|
|
225
|
+
* Archive an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
226
|
+
* Archive an organisation
|
|
227
|
+
*/
|
|
228
|
+
orgsOrgIdArchivePostRaw(requestParameters: OrgsOrgIdArchivePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
|
|
229
|
+
/**
|
|
230
|
+
* Archive an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
231
|
+
* Archive an organisation
|
|
232
|
+
*/
|
|
233
|
+
orgsOrgIdArchivePost(orgId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
|
|
234
|
+
/**
|
|
235
|
+
* Delete an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
236
|
+
* Delete an organisation
|
|
237
|
+
*/
|
|
238
|
+
orgsOrgIdDeleteRaw(requestParameters: OrgsOrgIdDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
239
|
+
/**
|
|
240
|
+
* Delete an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
241
|
+
* Delete an organisation
|
|
242
|
+
*/
|
|
243
|
+
orgsOrgIdDelete(orgId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
244
|
+
/**
|
|
245
|
+
* Show an organisation. In order to execute this action the current user must have * global security `atom:global:view_all_orgs` or * security right `atom:tenant:view_tenant_orgs` for the tenant * security right `atom:org:view_org` for the org with the ID in parameter `org_id`
|
|
246
|
+
* View an organisation
|
|
247
|
+
*/
|
|
248
|
+
orgsOrgIdGetRaw(requestParameters: OrgsOrgIdGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
|
|
249
|
+
/**
|
|
250
|
+
* Show an organisation. In order to execute this action the current user must have * global security `atom:global:view_all_orgs` or * security right `atom:tenant:view_tenant_orgs` for the tenant * security right `atom:org:view_org` for the org with the ID in parameter `org_id`
|
|
251
|
+
* View an organisation
|
|
252
|
+
*/
|
|
253
|
+
orgsOrgIdGet(orgId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
|
|
254
|
+
/**
|
|
255
|
+
* Update an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.
|
|
256
|
+
* Update an organisation
|
|
257
|
+
*/
|
|
258
|
+
orgsOrgIdPutRaw(requestParameters: OrgsOrgIdPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
|
|
259
|
+
/**
|
|
260
|
+
* Update an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.
|
|
261
|
+
* Update an organisation
|
|
262
|
+
*/
|
|
263
|
+
orgsOrgIdPut(orgId: string, aTOMCreateOrUpdateOrgRequest: ATOMCreateOrUpdateOrgRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
|
|
264
|
+
/**
|
|
265
|
+
* Restore an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
266
|
+
* Restore an organisation
|
|
267
|
+
*/
|
|
268
|
+
orgsOrgIdRestorePostRaw(requestParameters: OrgsOrgIdRestorePostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ATOMOneOrg>>;
|
|
269
|
+
/**
|
|
270
|
+
* Restore an organisation. In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.
|
|
271
|
+
* Restore an organisation
|
|
272
|
+
*/
|
|
273
|
+
orgsOrgIdRestorePost(orgId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMOneOrg>;
|
|
274
274
|
/**
|
|
275
275
|
* Add security rights to an organisation. In order to execute this action the current user must have security right `atom:tenant:assign_sr_to_org` for the tenant which the organisation belongs to.
|
|
276
276
|
* Add security rights to an organisation
|
|
@@ -11,14 +11,6 @@
|
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
13
|
import type { ATOMAdmin, ATOMAssignSecurityRightsRequest, ATOMPaginatedAdminList, ATOMSecurityRightsOfUser, ATOMSecurityRightsRegistry } from '../models';
|
|
14
|
-
export interface GlobalAdminsAdminIdSecurityRightsPostRequest {
|
|
15
|
-
adminId: string;
|
|
16
|
-
aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
|
|
17
|
-
}
|
|
18
|
-
export interface GlobalAdminsAdminIdSecurityRightsSecurityRightsDeleteRequest {
|
|
19
|
-
adminId: string;
|
|
20
|
-
securityRights: string;
|
|
21
|
-
}
|
|
22
14
|
export interface GlobalAdminsGetRequest {
|
|
23
15
|
email?: string;
|
|
24
16
|
status?: GlobalAdminsGetStatusEnum;
|
|
@@ -39,6 +31,14 @@ export interface GlobalAdminsIdGetRequest {
|
|
|
39
31
|
export interface GlobalAdminsIdRestorePostRequest {
|
|
40
32
|
id: string;
|
|
41
33
|
}
|
|
34
|
+
export interface GlobalAdminsIdSecurityRightsPostRequest {
|
|
35
|
+
id: string;
|
|
36
|
+
aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest;
|
|
37
|
+
}
|
|
38
|
+
export interface GlobalAdminsIdSecurityRightsSecurityRightsDeleteRequest {
|
|
39
|
+
id: string;
|
|
40
|
+
securityRights: string;
|
|
41
|
+
}
|
|
42
42
|
export interface SecurityRightsRegistryGetRequest {
|
|
43
43
|
withInactive?: boolean;
|
|
44
44
|
}
|
|
@@ -46,26 +46,6 @@ export interface SecurityRightsRegistryGetRequest {
|
|
|
46
46
|
*
|
|
47
47
|
*/
|
|
48
48
|
export declare class SecurityRightsApi extends runtime.BaseAPI {
|
|
49
|
-
/**
|
|
50
|
-
* Assign global security rights to a user. The user we are assigning security rights to does not need to be known by ATOM. In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
|
|
51
|
-
* Assign global security rights to a user
|
|
52
|
-
*/
|
|
53
|
-
globalAdminsAdminIdSecurityRightsPostRaw(requestParameters: GlobalAdminsAdminIdSecurityRightsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
54
|
-
/**
|
|
55
|
-
* Assign global security rights to a user. The user we are assigning security rights to does not need to be known by ATOM. In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
|
|
56
|
-
* Assign global security rights to a user
|
|
57
|
-
*/
|
|
58
|
-
globalAdminsAdminIdSecurityRightsPost(adminId: string, aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
59
|
-
/**
|
|
60
|
-
* Remove global security rights from a user. In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
|
|
61
|
-
* Remove global security rights from a user
|
|
62
|
-
*/
|
|
63
|
-
globalAdminsAdminIdSecurityRightsSecurityRightsDeleteRaw(requestParameters: GlobalAdminsAdminIdSecurityRightsSecurityRightsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
64
|
-
/**
|
|
65
|
-
* Remove global security rights from a user. In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
|
|
66
|
-
* Remove global security rights from a user
|
|
67
|
-
*/
|
|
68
|
-
globalAdminsAdminIdSecurityRightsSecurityRightsDelete(adminId: string, securityRights: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
69
49
|
/**
|
|
70
50
|
* List all users with global security rights. It is also possible to request a list of archived global admins, that is, users who used to have global security rights, but do not have them now. In order to execute this action the current user must have \"security right `atom:global:assign_global_sr_to_user`.
|
|
71
51
|
* List all users with global security rights
|
|
@@ -116,6 +96,26 @@ export declare class SecurityRightsApi extends runtime.BaseAPI {
|
|
|
116
96
|
* Restore an archived global admin
|
|
117
97
|
*/
|
|
118
98
|
globalAdminsIdRestorePost(id: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ATOMAdmin>;
|
|
99
|
+
/**
|
|
100
|
+
* Assign global security rights to a user. The user we are assigning security rights to does not need to be known by ATOM. In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
|
|
101
|
+
* Assign global security rights to a user
|
|
102
|
+
*/
|
|
103
|
+
globalAdminsIdSecurityRightsPostRaw(requestParameters: GlobalAdminsIdSecurityRightsPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
104
|
+
/**
|
|
105
|
+
* Assign global security rights to a user. The user we are assigning security rights to does not need to be known by ATOM. In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
|
|
106
|
+
* Assign global security rights to a user
|
|
107
|
+
*/
|
|
108
|
+
globalAdminsIdSecurityRightsPost(id: string, aTOMAssignSecurityRightsRequest: ATOMAssignSecurityRightsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
109
|
+
/**
|
|
110
|
+
* Remove global security rights from a user. In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
|
|
111
|
+
* Remove global security rights from a user
|
|
112
|
+
*/
|
|
113
|
+
globalAdminsIdSecurityRightsSecurityRightsDeleteRaw(requestParameters: GlobalAdminsIdSecurityRightsSecurityRightsDeleteRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
114
|
+
/**
|
|
115
|
+
* Remove global security rights from a user. In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.
|
|
116
|
+
* Remove global security rights from a user
|
|
117
|
+
*/
|
|
118
|
+
globalAdminsIdSecurityRightsSecurityRightsDelete(id: string, securityRights: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
119
119
|
/**
|
|
120
120
|
* Show all security rights of the current user for all active tenants and organizations
|
|
121
121
|
* All security rights of the current user
|
|
@@ -42,25 +42,25 @@ export interface InvitationsInvitationIdShareIntentsPostRequest {
|
|
|
42
42
|
meecoOrganisationId?: string;
|
|
43
43
|
shareIntentRequest?: ShareIntentRequest;
|
|
44
44
|
}
|
|
45
|
-
export interface
|
|
46
|
-
|
|
45
|
+
export interface ItemsItemIdEncryptPostRequest {
|
|
46
|
+
itemId: string;
|
|
47
47
|
meecoDelegationId?: string;
|
|
48
48
|
meecoOrganisationId?: string;
|
|
49
49
|
postItemEncryptRequest?: PostItemEncryptRequest;
|
|
50
50
|
}
|
|
51
|
-
export interface
|
|
52
|
-
|
|
51
|
+
export interface ItemsItemIdSharesGetRequest {
|
|
52
|
+
itemId: string;
|
|
53
53
|
meecoDelegationId?: string;
|
|
54
54
|
meecoOrganisationId?: string;
|
|
55
55
|
}
|
|
56
|
-
export interface
|
|
57
|
-
|
|
56
|
+
export interface ItemsItemIdSharesPostRequest {
|
|
57
|
+
itemId: string;
|
|
58
58
|
meecoDelegationId?: string;
|
|
59
59
|
meecoOrganisationId?: string;
|
|
60
60
|
postItemSharesRequest?: PostItemSharesRequest;
|
|
61
61
|
}
|
|
62
|
-
export interface
|
|
63
|
-
|
|
62
|
+
export interface ItemsItemIdSharesPutRequest {
|
|
63
|
+
itemId: string;
|
|
64
64
|
meecoDelegationId?: string;
|
|
65
65
|
meecoOrganisationId?: string;
|
|
66
66
|
putItemSharesRequest?: PutItemSharesRequest;
|
|
@@ -166,42 +166,42 @@ export declare class SharesApi extends runtime.BaseAPI {
|
|
|
166
166
|
* Re-encrypt share data Data in shared slots is initially encrypted with the share DEK. The share DEK is encrypted with the public key of the share recipient. When processing a share the client application is expected to decrypt the slot data as well as `encrypted_value_verification_key` and re-encrypt with them private DEK with this endpoint.
|
|
167
167
|
* Re-encrypt share data
|
|
168
168
|
*/
|
|
169
|
-
|
|
169
|
+
itemsItemIdEncryptPostRaw(requestParameters: ItemsItemIdEncryptPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultItemResponse>>;
|
|
170
170
|
/**
|
|
171
171
|
* Re-encrypt share data Data in shared slots is initially encrypted with the share DEK. The share DEK is encrypted with the public key of the share recipient. When processing a share the client application is expected to decrypt the slot data as well as `encrypted_value_verification_key` and re-encrypt with them private DEK with this endpoint.
|
|
172
172
|
* Re-encrypt share data
|
|
173
173
|
*/
|
|
174
|
-
|
|
174
|
+
itemsItemIdEncryptPost(itemId: string, meecoDelegationId?: string, meecoOrganisationId?: string, postItemEncryptRequest?: PostItemEncryptRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultItemResponse>;
|
|
175
175
|
/**
|
|
176
176
|
* Updating all shares of one item is done by the item owner in one go. A share DEK is encrypted with a public key of the recipient. In order to update shares the owner needs a public key of the recipient of each share. But some shares may be created by users different from the owner, and thus the owner might have no connection to recipients of those shares, and no access to those shares. This problem is solved by * Putting a public key of the recipient and an identification of the keypair to which the public key belongs into each share record. * Providing a list of all public keys and share IDs for all shares of the given item via this endpoint Getting this list is the first step in updating all shares of the item.
|
|
177
177
|
* Prepare an update of all shares of one item
|
|
178
178
|
*/
|
|
179
|
-
|
|
179
|
+
itemsItemIdSharesGetRaw(requestParameters: ItemsItemIdSharesGetRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetItemSharesResponse>>;
|
|
180
180
|
/**
|
|
181
181
|
* Updating all shares of one item is done by the item owner in one go. A share DEK is encrypted with a public key of the recipient. In order to update shares the owner needs a public key of the recipient of each share. But some shares may be created by users different from the owner, and thus the owner might have no connection to recipients of those shares, and no access to those shares. This problem is solved by * Putting a public key of the recipient and an identification of the keypair to which the public key belongs into each share record. * Providing a list of all public keys and share IDs for all shares of the given item via this endpoint Getting this list is the first step in updating all shares of the item.
|
|
182
182
|
* Prepare an update of all shares of one item
|
|
183
183
|
*/
|
|
184
|
-
|
|
184
|
+
itemsItemIdSharesGet(itemId: string, meecoDelegationId?: string, meecoOrganisationId?: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetItemSharesResponse>;
|
|
185
185
|
/**
|
|
186
186
|
* Share your item with connected users. Each share can be a share of all slots of the item, in that case `slot_id` is `NULL`, or it can be a share of just one slot. In this case `slot_id` references one of the slots of the item. There are 3 users involved in each share: * owner - the owner of the shared item * sender - the user who shares data. Can be the owner or one of the recipients * recipient - the user who recieves the shared data. Whether a non-owner may on-share a shared slot is defined in field `onsharing_permitted`. Only the owner of the item can set `onsharing_permitted` to `true`. If `onsharing_permitted` is `false`, the recipient may on-share the item, but when that recipient creates an on-share, `onsharing_permitted` in that on-share is forced to be `false`. In other words, the depth of on-sharing in limited to 3: OWNER ==> RECIPIENT AND SENDER ==> RECIPIENT Some shares require that the recipient accepts the terms of the share. Until the terms are not accepted the share DEK is hidden. Data in slots is initially encrypted with the DEK in field `encrypted_dek`. The DEK in `encrypted_dek` is encrypted with the public key of the share recipient. When processing a share the client application is expected to decrypt the slot data and re-encrypt with the private DEK. A public key of the recipient is needed to encrypt the share DEK. Updating all shares of the same item is performed by the owner in one go. In a situation when a share has been created by a recipient, not the owner, and there is no connection between the owner and the recipient, the owner has no access to a public key of the recipient. In order to address this problem when a share is created we also add fields `public_key` and `keypair_external_id` from the connection record between the recipient and the sender. `keypair_external_id` identifies the keypair that the public key belongs to. When a recipient of a share on-shares the data with someone else, nothing prevents him/her to encrypt some other data instead of the original data. We need a way to enforce integrity of on-shares. We do this with help of HMAC - hash-based message authentication code obtained by running a cryptographic hash function over the data and a shared secret key. Two fields in each slot are used for this purpose: * `encrypted_value_verification_key` - is a value verification key encrypted in the same way as the value itself: with the share DEK * `value_verification_hash` - the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. `value_verification_hash` is stored as-is, unencrypted. Only the owner of the data may send `value_verification_hash` when creating or updating the share. When other senders create a share, `value_verification_hash` must be `NULL`. `encrypted_value_verification_key` may and should be sent by every sender, owner or not, because `encrypted_value_verification_key` must be re-encrypted with the share DEK for each share. If the sender replaces `encrypted_value_verification_key` and/or the slot value, this will break the client-side verification against `encrypted_value_verification_key`. Field `encrypted_value` may be `NULL`. If `encrypted_value` is `NULL`, then `encrypted_value_verification_key` and `value_verification_hash` may also be `NULL`. If `encrypted_value` is present, then `encrypted_value_verification_key` and `value_verification_hash` are mandatory.
|
|
187
187
|
* Share your item with connected users
|
|
188
188
|
*/
|
|
189
|
-
|
|
189
|
+
itemsItemIdSharesPostRaw(requestParameters: ItemsItemIdSharesPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<VaultSharesCreateResponse>>;
|
|
190
190
|
/**
|
|
191
191
|
* Share your item with connected users. Each share can be a share of all slots of the item, in that case `slot_id` is `NULL`, or it can be a share of just one slot. In this case `slot_id` references one of the slots of the item. There are 3 users involved in each share: * owner - the owner of the shared item * sender - the user who shares data. Can be the owner or one of the recipients * recipient - the user who recieves the shared data. Whether a non-owner may on-share a shared slot is defined in field `onsharing_permitted`. Only the owner of the item can set `onsharing_permitted` to `true`. If `onsharing_permitted` is `false`, the recipient may on-share the item, but when that recipient creates an on-share, `onsharing_permitted` in that on-share is forced to be `false`. In other words, the depth of on-sharing in limited to 3: OWNER ==> RECIPIENT AND SENDER ==> RECIPIENT Some shares require that the recipient accepts the terms of the share. Until the terms are not accepted the share DEK is hidden. Data in slots is initially encrypted with the DEK in field `encrypted_dek`. The DEK in `encrypted_dek` is encrypted with the public key of the share recipient. When processing a share the client application is expected to decrypt the slot data and re-encrypt with the private DEK. A public key of the recipient is needed to encrypt the share DEK. Updating all shares of the same item is performed by the owner in one go. In a situation when a share has been created by a recipient, not the owner, and there is no connection between the owner and the recipient, the owner has no access to a public key of the recipient. In order to address this problem when a share is created we also add fields `public_key` and `keypair_external_id` from the connection record between the recipient and the sender. `keypair_external_id` identifies the keypair that the public key belongs to. When a recipient of a share on-shares the data with someone else, nothing prevents him/her to encrypt some other data instead of the original data. We need a way to enforce integrity of on-shares. We do this with help of HMAC - hash-based message authentication code obtained by running a cryptographic hash function over the data and a shared secret key. Two fields in each slot are used for this purpose: * `encrypted_value_verification_key` - is a value verification key encrypted in the same way as the value itself: with the share DEK * `value_verification_hash` - the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. `value_verification_hash` is stored as-is, unencrypted. Only the owner of the data may send `value_verification_hash` when creating or updating the share. When other senders create a share, `value_verification_hash` must be `NULL`. `encrypted_value_verification_key` may and should be sent by every sender, owner or not, because `encrypted_value_verification_key` must be re-encrypted with the share DEK for each share. If the sender replaces `encrypted_value_verification_key` and/or the slot value, this will break the client-side verification against `encrypted_value_verification_key`. Field `encrypted_value` may be `NULL`. If `encrypted_value` is `NULL`, then `encrypted_value_verification_key` and `value_verification_hash` may also be `NULL`. If `encrypted_value` is present, then `encrypted_value_verification_key` and `value_verification_hash` are mandatory.
|
|
192
192
|
* Share your item with connected users
|
|
193
193
|
*/
|
|
194
|
-
|
|
194
|
+
itemsItemIdSharesPost(itemId: string, meecoDelegationId?: string, meecoOrganisationId?: string, postItemSharesRequest?: PostItemSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<VaultSharesCreateResponse>;
|
|
195
195
|
/**
|
|
196
196
|
* Updating all shares of one item is done by the item owner in one go. Before calling this endpoint the client application is expected to retrieve the list of shares IDs and public keys via `GET /items/{id}/shares`. The POST body of this endpoint contains * a list of share DEKs encrypted with public keys of share recipients * a list of slot values for each slot and each share, each encrypted with the DEK of the share that the slot belongs to * Optionally: a list of completed `ClientTask` tasks When a recipient of a share on-shares the data with someone else, nothing prevents him/her to encrypt some other data instead of the original data. We need a way to enforce integrity of on-shares. We do this with help of HMAC - hash-based message authentication code obtained by running a cryptographic hash function over the data and a shared secret key. Two fields in each slot are used for this purpose: * `encrypted_value_verification_key` - is a value verification key encrypted in the same way as the value itself: with the share DEK * `value_verification_hash` - the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. `value_verification_hash` is stored as-is, unencrypted. Only the owner of the data may send `value_verification_hash` when creating or updating the share. When other senders create a share, `value_verification_hash` must be `NULL`. `encrypted_value_verification_key` may and should be sent by every sender, owner or not, because `encrypted_value_verification_key` must be re-encrypted with the share DEK for each share. If the sender replaces `encrypted_value_verification_key` and/or the slot value, this will break the client-side verification against `encrypted_value_verification_key`. Field `encrypted_value` may be `NULL`. If `encrypted_value` is `NULL`, then `encrypted_value_verification_key` and `value_verification_hash` may also be `NULL`. If `encrypted_value` is present, then `encrypted_value_verification_key` and `value_verification_hash` are mandatory.
|
|
197
197
|
* Update all shares of one item
|
|
198
198
|
*/
|
|
199
|
-
|
|
199
|
+
itemsItemIdSharesPutRaw(requestParameters: ItemsItemIdSharesPutRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ItemSharesUpdateResponse>>;
|
|
200
200
|
/**
|
|
201
201
|
* Updating all shares of one item is done by the item owner in one go. Before calling this endpoint the client application is expected to retrieve the list of shares IDs and public keys via `GET /items/{id}/shares`. The POST body of this endpoint contains * a list of share DEKs encrypted with public keys of share recipients * a list of slot values for each slot and each share, each encrypted with the DEK of the share that the slot belongs to * Optionally: a list of completed `ClientTask` tasks When a recipient of a share on-shares the data with someone else, nothing prevents him/her to encrypt some other data instead of the original data. We need a way to enforce integrity of on-shares. We do this with help of HMAC - hash-based message authentication code obtained by running a cryptographic hash function over the data and a shared secret key. Two fields in each slot are used for this purpose: * `encrypted_value_verification_key` - is a value verification key encrypted in the same way as the value itself: with the share DEK * `value_verification_hash` - the result of the HMAC function run on the slot value using `encrypted_value_verification_key`. `value_verification_hash` is stored as-is, unencrypted. Only the owner of the data may send `value_verification_hash` when creating or updating the share. When other senders create a share, `value_verification_hash` must be `NULL`. `encrypted_value_verification_key` may and should be sent by every sender, owner or not, because `encrypted_value_verification_key` must be re-encrypted with the share DEK for each share. If the sender replaces `encrypted_value_verification_key` and/or the slot value, this will break the client-side verification against `encrypted_value_verification_key`. Field `encrypted_value` may be `NULL`. If `encrypted_value` is `NULL`, then `encrypted_value_verification_key` and `value_verification_hash` may also be `NULL`. If `encrypted_value` is present, then `encrypted_value_verification_key` and `value_verification_hash` are mandatory.
|
|
202
202
|
* Update all shares of one item
|
|
203
203
|
*/
|
|
204
|
-
|
|
204
|
+
itemsItemIdSharesPut(itemId: string, meecoDelegationId?: string, meecoOrganisationId?: string, putItemSharesRequest?: PutItemSharesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ItemSharesUpdateResponse>;
|
|
205
205
|
/**
|
|
206
206
|
* Read outgoing shares. That is, all shares the current user has created, including on-shares. Only share records are fetched.
|
|
207
207
|
* Read outgoing shares
|