@flowcore/cli-plugin-iam 1.3.1 → 1.5.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/CHANGELOG.md +25 -0
- package/README.md +32 -5
- package/dist/commands/edit/policy.d.ts +16 -0
- package/dist/commands/edit/policy.js +118 -0
- package/dist/commands/get/policy.js +5 -2
- package/dist/commands/get/role.js +1 -0
- package/dist/utils/clients/iam/Api.d.ts +757 -189
- package/dist/utils/clients/iam/Api.js +717 -189
- package/dist/utils/clients/iam/Health.d.ts +1 -0
- package/dist/utils/clients/iam/Health.js +1 -0
- package/dist/utils/clients/iam/Transformers.d.ts +92 -28
- package/dist/utils/clients/iam/Transformers.js +92 -28
- package/dist/utils/clients/iam/http-client.d.ts +2 -2
- package/dist/utils/clients/iam/http-client.js +18 -6
- package/oclif.manifest.json +49 -1
- package/package.json +1 -1
|
@@ -1,13 +1,43 @@
|
|
|
1
1
|
import { HttpClient, type RequestParams } from "./http-client.js";
|
|
2
2
|
export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
|
|
3
3
|
/**
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
4
|
+
* @description Get all policies for the current user
|
|
5
|
+
*
|
|
6
|
+
* @tags policies
|
|
7
|
+
* @name GetApiV1Policies
|
|
8
|
+
* @request GET:/api/v1/policies/
|
|
9
|
+
* @secure
|
|
10
|
+
* @response `200` `(({
|
|
11
|
+
\** The id of the organization *\
|
|
12
|
+
organizationId: string,
|
|
13
|
+
\** The name of the policy *\
|
|
14
|
+
name: string,
|
|
15
|
+
\** The version of the policy *\
|
|
16
|
+
version: string,
|
|
17
|
+
policyDocuments: ({
|
|
18
|
+
\** The id of the statement *\
|
|
19
|
+
statementId?: string,
|
|
20
|
+
\** The resource of the statement *\
|
|
21
|
+
resource: string,
|
|
22
|
+
\** The action of the statement *\
|
|
23
|
+
action: (string | (string)[]),
|
|
24
|
+
|
|
25
|
+
})[],
|
|
26
|
+
\** The description of the policy *\
|
|
27
|
+
description?: string,
|
|
28
|
+
\** The principal role that can access the resource *\
|
|
29
|
+
principal?: string,
|
|
30
|
+
\** If the policy is managed by flowcore *\
|
|
31
|
+
flowcoreManaged?: boolean,
|
|
32
|
+
|
|
33
|
+
} & {
|
|
34
|
+
\** The id of the policy *\
|
|
35
|
+
id: string,
|
|
36
|
+
\** The frn of the policy *\
|
|
37
|
+
frn: string,
|
|
38
|
+
|
|
39
|
+
}))[]`
|
|
40
|
+
*/
|
|
11
41
|
getApiV1Policies: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
|
|
12
42
|
/** The id of the organization */
|
|
13
43
|
organizationId: string;
|
|
@@ -32,6 +62,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
32
62
|
} & {
|
|
33
63
|
/** The id of the policy */
|
|
34
64
|
id: string;
|
|
65
|
+
/** The frn of the policy */
|
|
66
|
+
frn: string;
|
|
35
67
|
})[], any>>;
|
|
36
68
|
/**
|
|
37
69
|
* @description Create a new policy
|
|
@@ -40,6 +72,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
40
72
|
* @name PostApiV1Policies
|
|
41
73
|
* @request POST:/api/v1/policies/
|
|
42
74
|
* @secure
|
|
75
|
+
* @response `200` `object`
|
|
43
76
|
*/
|
|
44
77
|
postApiV1Policies: (data: {
|
|
45
78
|
/** The id of the organization */
|
|
@@ -70,6 +103,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
70
103
|
* @name GetApiV1PoliciesById
|
|
71
104
|
* @request GET:/api/v1/policies/{id}
|
|
72
105
|
* @secure
|
|
106
|
+
* @response `200` `object`
|
|
73
107
|
*/
|
|
74
108
|
getApiV1PoliciesById: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<object, any>>;
|
|
75
109
|
/**
|
|
@@ -79,6 +113,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
79
113
|
* @name PatchApiV1PoliciesById
|
|
80
114
|
* @request PATCH:/api/v1/policies/{id}
|
|
81
115
|
* @secure
|
|
116
|
+
* @response `200` `object`
|
|
82
117
|
*/
|
|
83
118
|
patchApiV1PoliciesById: (id: string, data: {
|
|
84
119
|
/** The id of the organization */
|
|
@@ -99,27 +134,51 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
99
134
|
description?: string;
|
|
100
135
|
/** The principal role that can access the resource */
|
|
101
136
|
principal?: string;
|
|
137
|
+
/** If the policy is managed by flowcore */
|
|
138
|
+
flowcoreManaged?: boolean;
|
|
102
139
|
}, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<object, any>>;
|
|
103
140
|
/**
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
141
|
+
* @description Archive a policy by id
|
|
142
|
+
*
|
|
143
|
+
* @tags policies
|
|
144
|
+
* @name DeleteApiV1PoliciesById
|
|
145
|
+
* @request DELETE:/api/v1/policies/{id}
|
|
146
|
+
* @secure
|
|
147
|
+
* @response `200` `{
|
|
148
|
+
\** The message of the archive policy *\
|
|
149
|
+
message: string,
|
|
150
|
+
|
|
151
|
+
}`
|
|
152
|
+
*/
|
|
111
153
|
deleteApiV1PoliciesById: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
|
|
112
154
|
/** The message of the archive policy */
|
|
113
155
|
message: string;
|
|
114
156
|
}, any>>;
|
|
115
157
|
/**
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
158
|
+
* @description Get all roles for the current user
|
|
159
|
+
*
|
|
160
|
+
* @tags roles
|
|
161
|
+
* @name GetApiV1Roles
|
|
162
|
+
* @request GET:/api/v1/roles/
|
|
163
|
+
* @secure
|
|
164
|
+
* @response `200` `(({
|
|
165
|
+
\** Organization ID *\
|
|
166
|
+
organizationId: string,
|
|
167
|
+
\** Role name *\
|
|
168
|
+
name: string,
|
|
169
|
+
\** Role description *\
|
|
170
|
+
description?: string,
|
|
171
|
+
\** Flowcore managed role *\
|
|
172
|
+
flowcoreManaged?: boolean,
|
|
173
|
+
|
|
174
|
+
} & {
|
|
175
|
+
\** The id of the role *\
|
|
176
|
+
id: string,
|
|
177
|
+
\** The frn of the role *\
|
|
178
|
+
frn?: string,
|
|
179
|
+
|
|
180
|
+
}))[]`
|
|
181
|
+
*/
|
|
123
182
|
getApiV1Roles: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
|
|
124
183
|
/** Organization ID */
|
|
125
184
|
organizationId: string;
|
|
@@ -132,6 +191,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
132
191
|
} & {
|
|
133
192
|
/** The id of the role */
|
|
134
193
|
id: string;
|
|
194
|
+
/** The frn of the role */
|
|
195
|
+
frn?: string;
|
|
135
196
|
})[], any>>;
|
|
136
197
|
/**
|
|
137
198
|
* @description Create a new role
|
|
@@ -140,6 +201,7 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
140
201
|
* @name PostApiV1Roles
|
|
141
202
|
* @request POST:/api/v1/roles/
|
|
142
203
|
* @secure
|
|
204
|
+
* @response `200` `object`
|
|
143
205
|
*/
|
|
144
206
|
postApiV1Roles: (data: {
|
|
145
207
|
/** Organization ID */
|
|
@@ -152,13 +214,40 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
152
214
|
flowcoreManaged?: boolean;
|
|
153
215
|
}, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<object, any>>;
|
|
154
216
|
/**
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
217
|
+
* @description Get a role by ID
|
|
218
|
+
*
|
|
219
|
+
* @tags roles
|
|
220
|
+
* @name GetApiV1RolesById
|
|
221
|
+
* @request GET:/api/v1/roles/{id}
|
|
222
|
+
* @secure
|
|
223
|
+
* @response `200` `(({
|
|
224
|
+
\** Organization ID *\
|
|
225
|
+
organizationId: string,
|
|
226
|
+
\** Role name *\
|
|
227
|
+
name: string,
|
|
228
|
+
\** Role description *\
|
|
229
|
+
description?: string,
|
|
230
|
+
\** Flowcore managed role *\
|
|
231
|
+
flowcoreManaged?: boolean,
|
|
232
|
+
|
|
233
|
+
} & {
|
|
234
|
+
\** Role ID *\
|
|
235
|
+
id: string,
|
|
236
|
+
\** The archived status of the role *\
|
|
237
|
+
archived: boolean,
|
|
238
|
+
\** The frn of the role *\
|
|
239
|
+
frn?: string,
|
|
240
|
+
|
|
241
|
+
}) & {
|
|
242
|
+
\** Role ID *\
|
|
243
|
+
id: string,
|
|
244
|
+
\** The archived status of the role *\
|
|
245
|
+
archived: boolean,
|
|
246
|
+
\** The frn of the role *\
|
|
247
|
+
frn: string,
|
|
248
|
+
|
|
249
|
+
})`
|
|
250
|
+
*/
|
|
162
251
|
getApiV1RolesById: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
|
|
163
252
|
/** Organization ID */
|
|
164
253
|
organizationId: string;
|
|
@@ -173,20 +262,45 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
173
262
|
id: string;
|
|
174
263
|
/** The archived status of the role */
|
|
175
264
|
archived: boolean;
|
|
265
|
+
/** The frn of the role */
|
|
266
|
+
frn?: string;
|
|
176
267
|
} & {
|
|
177
268
|
/** Role ID */
|
|
178
269
|
id: string;
|
|
179
270
|
/** The archived status of the role */
|
|
180
271
|
archived: boolean;
|
|
272
|
+
/** The frn of the role */
|
|
273
|
+
frn: string;
|
|
181
274
|
}, any>>;
|
|
182
275
|
/**
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
276
|
+
* @description Update a role by ID
|
|
277
|
+
*
|
|
278
|
+
* @tags roles
|
|
279
|
+
* @name PatchApiV1RolesById
|
|
280
|
+
* @request PATCH:/api/v1/roles/{id}
|
|
281
|
+
* @secure
|
|
282
|
+
* @response `200` `(({
|
|
283
|
+
\** Organization ID *\
|
|
284
|
+
organizationId: string,
|
|
285
|
+
\** Role name *\
|
|
286
|
+
name: string,
|
|
287
|
+
\** Role description *\
|
|
288
|
+
description?: string,
|
|
289
|
+
\** Flowcore managed role *\
|
|
290
|
+
flowcoreManaged?: boolean,
|
|
291
|
+
|
|
292
|
+
} & {
|
|
293
|
+
\** Role ID *\
|
|
294
|
+
id: string,
|
|
295
|
+
|
|
296
|
+
}) & {
|
|
297
|
+
\** The archived status of the role *\
|
|
298
|
+
archived: boolean,
|
|
299
|
+
\** The frn of the role *\
|
|
300
|
+
frn: string,
|
|
301
|
+
|
|
302
|
+
})`
|
|
303
|
+
*/
|
|
190
304
|
patchApiV1RolesById: (id: string, data: {
|
|
191
305
|
/** Organization ID */
|
|
192
306
|
organizationId: string;
|
|
@@ -194,6 +308,8 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
194
308
|
name: string;
|
|
195
309
|
/** Role description */
|
|
196
310
|
description?: string;
|
|
311
|
+
/** Flowcore managed role */
|
|
312
|
+
flowcoreManaged?: boolean;
|
|
197
313
|
} & {
|
|
198
314
|
/** Role ID */
|
|
199
315
|
id: string;
|
|
@@ -204,33 +320,72 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
204
320
|
name: string;
|
|
205
321
|
/** Role description */
|
|
206
322
|
description?: string;
|
|
323
|
+
/** Flowcore managed role */
|
|
324
|
+
flowcoreManaged?: boolean;
|
|
207
325
|
} & {
|
|
208
326
|
/** Role ID */
|
|
209
327
|
id: string;
|
|
210
328
|
} & {
|
|
211
329
|
/** The archived status of the role */
|
|
212
330
|
archived: boolean;
|
|
331
|
+
/** The frn of the role */
|
|
332
|
+
frn: string;
|
|
213
333
|
}, any>>;
|
|
214
334
|
/**
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
335
|
+
* @description Archive a role by ID
|
|
336
|
+
*
|
|
337
|
+
* @tags roles
|
|
338
|
+
* @name DeleteApiV1RolesById
|
|
339
|
+
* @request DELETE:/api/v1/roles/{id}
|
|
340
|
+
* @secure
|
|
341
|
+
* @response `200` `{
|
|
342
|
+
\** The message of the archive role *\
|
|
343
|
+
message: string,
|
|
344
|
+
|
|
345
|
+
}`
|
|
346
|
+
*/
|
|
222
347
|
deleteApiV1RolesById: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
|
|
223
348
|
/** The message of the archive role */
|
|
224
349
|
message: string;
|
|
225
350
|
}, any>>;
|
|
226
351
|
/**
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
352
|
+
* @description Fetch associations for a policy
|
|
353
|
+
*
|
|
354
|
+
* @tags policy-associations
|
|
355
|
+
* @name GetApiV1PolicyAssociationsByPolicyId
|
|
356
|
+
* @request GET:/api/v1/policy-associations/{policyId}
|
|
357
|
+
* @secure
|
|
358
|
+
* @response `200` `{
|
|
359
|
+
keys: ({
|
|
360
|
+
\** The ID of the policy *\
|
|
361
|
+
policyId: string,
|
|
362
|
+
\** The ID of the organization *\
|
|
363
|
+
organizationId: string,
|
|
364
|
+
\** The ID of the key *\
|
|
365
|
+
keyId: string,
|
|
366
|
+
|
|
367
|
+
})[],
|
|
368
|
+
users: ({
|
|
369
|
+
\** The ID of the policy *\
|
|
370
|
+
policyId: string,
|
|
371
|
+
\** The ID of the organization *\
|
|
372
|
+
organizationId: string,
|
|
373
|
+
\** The ID of the user *\
|
|
374
|
+
userId: string,
|
|
375
|
+
|
|
376
|
+
})[],
|
|
377
|
+
roles: ({
|
|
378
|
+
\** The ID of the policy *\
|
|
379
|
+
policyId: string,
|
|
380
|
+
\** The ID of the organization *\
|
|
381
|
+
organizationId: string,
|
|
382
|
+
\** The ID of the role *\
|
|
383
|
+
roleId: string,
|
|
384
|
+
|
|
385
|
+
})[],
|
|
386
|
+
|
|
387
|
+
}`
|
|
388
|
+
*/
|
|
234
389
|
getApiV1PolicyAssociationsByPolicyId: (policyId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
|
|
235
390
|
keys: {
|
|
236
391
|
/** The ID of the policy */
|
|
@@ -258,13 +413,43 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
258
413
|
}[];
|
|
259
414
|
}, any>>;
|
|
260
415
|
/**
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
416
|
+
* @description Fetch policies for an organization
|
|
417
|
+
*
|
|
418
|
+
* @tags policy-associations
|
|
419
|
+
* @name GetApiV1PolicyAssociationsOrganizationByOrganizationId
|
|
420
|
+
* @request GET:/api/v1/policy-associations/organization/{organizationId}
|
|
421
|
+
* @secure
|
|
422
|
+
* @response `200` `(({
|
|
423
|
+
\** The id of the organization *\
|
|
424
|
+
organizationId: string,
|
|
425
|
+
\** The name of the policy *\
|
|
426
|
+
name: string,
|
|
427
|
+
\** The version of the policy *\
|
|
428
|
+
version: string,
|
|
429
|
+
policyDocuments: ({
|
|
430
|
+
\** The id of the statement *\
|
|
431
|
+
statementId?: string,
|
|
432
|
+
\** The resource of the statement *\
|
|
433
|
+
resource: string,
|
|
434
|
+
\** The action of the statement *\
|
|
435
|
+
action: (string | (string)[]),
|
|
436
|
+
|
|
437
|
+
})[],
|
|
438
|
+
\** The description of the policy *\
|
|
439
|
+
description?: string,
|
|
440
|
+
\** The principal role that can access the resource *\
|
|
441
|
+
principal?: string,
|
|
442
|
+
\** If the policy is managed by flowcore *\
|
|
443
|
+
flowcoreManaged?: boolean,
|
|
444
|
+
|
|
445
|
+
} & {
|
|
446
|
+
\** The id of the policy *\
|
|
447
|
+
id: string,
|
|
448
|
+
\** The frn of the policy *\
|
|
449
|
+
frn: string,
|
|
450
|
+
|
|
451
|
+
}))[]`
|
|
452
|
+
*/
|
|
268
453
|
getApiV1PolicyAssociationsOrganizationByOrganizationId: (organizationId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
|
|
269
454
|
/** The id of the organization */
|
|
270
455
|
organizationId: string;
|
|
@@ -289,15 +474,52 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
289
474
|
} & {
|
|
290
475
|
/** The id of the policy */
|
|
291
476
|
id: string;
|
|
477
|
+
/** The frn of the policy */
|
|
478
|
+
frn: string;
|
|
292
479
|
})[], any>>;
|
|
293
480
|
/**
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
481
|
+
* @description Fetch policies for a user
|
|
482
|
+
*
|
|
483
|
+
* @tags policy-associations
|
|
484
|
+
* @name GetApiV1PolicyAssociationsUserByUserId
|
|
485
|
+
* @request GET:/api/v1/policy-associations/user/{userId}/
|
|
486
|
+
* @secure
|
|
487
|
+
* @response `200` `((({
|
|
488
|
+
\** The id of the organization *\
|
|
489
|
+
organizationId: string,
|
|
490
|
+
\** The name of the policy *\
|
|
491
|
+
name: string,
|
|
492
|
+
\** The version of the policy *\
|
|
493
|
+
version: string,
|
|
494
|
+
policyDocuments: ({
|
|
495
|
+
\** The id of the statement *\
|
|
496
|
+
statementId?: string,
|
|
497
|
+
\** The resource of the statement *\
|
|
498
|
+
resource: string,
|
|
499
|
+
\** The action of the statement *\
|
|
500
|
+
action: (string | (string)[]),
|
|
501
|
+
|
|
502
|
+
})[],
|
|
503
|
+
\** The description of the policy *\
|
|
504
|
+
description?: string,
|
|
505
|
+
\** The principal role that can access the resource *\
|
|
506
|
+
principal?: string,
|
|
507
|
+
\** If the policy is managed by flowcore *\
|
|
508
|
+
flowcoreManaged?: boolean,
|
|
509
|
+
|
|
510
|
+
} & {
|
|
511
|
+
\** The id of the policy *\
|
|
512
|
+
id: string,
|
|
513
|
+
\** The archived status of the policy *\
|
|
514
|
+
archived: boolean,
|
|
515
|
+
\** The frn of the policy *\
|
|
516
|
+
frn: string,
|
|
517
|
+
|
|
518
|
+
}) & {
|
|
519
|
+
frn: string,
|
|
520
|
+
|
|
521
|
+
}))[]`
|
|
522
|
+
*/
|
|
301
523
|
getApiV1PolicyAssociationsUserByUserId: (userId: string, query?: {
|
|
302
524
|
/** The ID of the organization */
|
|
303
525
|
organizationId?: string;
|
|
@@ -327,15 +549,28 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
327
549
|
id: string;
|
|
328
550
|
/** The archived status of the policy */
|
|
329
551
|
archived: boolean;
|
|
552
|
+
/** The frn of the policy */
|
|
553
|
+
frn: string;
|
|
554
|
+
} & {
|
|
555
|
+
frn: string;
|
|
330
556
|
})[], any>>;
|
|
331
557
|
/**
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
558
|
+
* @description Link a policy to a user
|
|
559
|
+
*
|
|
560
|
+
* @tags policy-associations
|
|
561
|
+
* @name PostApiV1PolicyAssociationsUserByUserId
|
|
562
|
+
* @request POST:/api/v1/policy-associations/user/{userId}/
|
|
563
|
+
* @secure
|
|
564
|
+
* @response `200` `{
|
|
565
|
+
\** The ID of the policy *\
|
|
566
|
+
policyId: string,
|
|
567
|
+
\** The ID of the organization *\
|
|
568
|
+
organizationId: string,
|
|
569
|
+
\** The ID of the user *\
|
|
570
|
+
userId: string,
|
|
571
|
+
|
|
572
|
+
}`
|
|
573
|
+
*/
|
|
339
574
|
postApiV1PolicyAssociationsUserByUserId: (userId: string, data: {
|
|
340
575
|
/** The ID of the policy */
|
|
341
576
|
policyId: string;
|
|
@@ -348,13 +583,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
348
583
|
userId: string;
|
|
349
584
|
}, any>>;
|
|
350
585
|
/**
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
586
|
+
* @description Unlink a policy from a user
|
|
587
|
+
*
|
|
588
|
+
* @tags policy-associations
|
|
589
|
+
* @name DeleteApiV1PolicyAssociationsUserByUserId
|
|
590
|
+
* @request DELETE:/api/v1/policy-associations/user/{userId}/
|
|
591
|
+
* @secure
|
|
592
|
+
* @response `200` `{
|
|
593
|
+
\** The ID of the policy *\
|
|
594
|
+
policyId: string,
|
|
595
|
+
\** The ID of the organization *\
|
|
596
|
+
organizationId: string,
|
|
597
|
+
\** The ID of the user *\
|
|
598
|
+
userId: string,
|
|
599
|
+
|
|
600
|
+
}`
|
|
601
|
+
*/
|
|
358
602
|
deleteApiV1PolicyAssociationsUserByUserId: (userId: string, data: {
|
|
359
603
|
/** The ID of the policy */
|
|
360
604
|
policyId: string;
|
|
@@ -367,13 +611,48 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
367
611
|
userId: string;
|
|
368
612
|
}, any>>;
|
|
369
613
|
/**
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
614
|
+
* @description Fetch policies for a key
|
|
615
|
+
*
|
|
616
|
+
* @tags policy-associations
|
|
617
|
+
* @name GetApiV1PolicyAssociationsKeyByKeyId
|
|
618
|
+
* @request GET:/api/v1/policy-associations/key/{keyId}/
|
|
619
|
+
* @secure
|
|
620
|
+
* @response `200` `((({
|
|
621
|
+
\** The id of the organization *\
|
|
622
|
+
organizationId: string,
|
|
623
|
+
\** The name of the policy *\
|
|
624
|
+
name: string,
|
|
625
|
+
\** The version of the policy *\
|
|
626
|
+
version: string,
|
|
627
|
+
policyDocuments: ({
|
|
628
|
+
\** The id of the statement *\
|
|
629
|
+
statementId?: string,
|
|
630
|
+
\** The resource of the statement *\
|
|
631
|
+
resource: string,
|
|
632
|
+
\** The action of the statement *\
|
|
633
|
+
action: (string | (string)[]),
|
|
634
|
+
|
|
635
|
+
})[],
|
|
636
|
+
\** The description of the policy *\
|
|
637
|
+
description?: string,
|
|
638
|
+
\** The principal role that can access the resource *\
|
|
639
|
+
principal?: string,
|
|
640
|
+
\** If the policy is managed by flowcore *\
|
|
641
|
+
flowcoreManaged?: boolean,
|
|
642
|
+
|
|
643
|
+
} & {
|
|
644
|
+
\** The id of the policy *\
|
|
645
|
+
id: string,
|
|
646
|
+
\** The archived status of the policy *\
|
|
647
|
+
archived: boolean,
|
|
648
|
+
\** The frn of the policy *\
|
|
649
|
+
frn: string,
|
|
650
|
+
|
|
651
|
+
}) & {
|
|
652
|
+
frn: string,
|
|
653
|
+
|
|
654
|
+
}))[]`
|
|
655
|
+
*/
|
|
377
656
|
getApiV1PolicyAssociationsKeyByKeyId: (keyId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
|
|
378
657
|
/** The id of the organization */
|
|
379
658
|
organizationId: string;
|
|
@@ -400,15 +679,28 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
400
679
|
id: string;
|
|
401
680
|
/** The archived status of the policy */
|
|
402
681
|
archived: boolean;
|
|
682
|
+
/** The frn of the policy */
|
|
683
|
+
frn: string;
|
|
684
|
+
} & {
|
|
685
|
+
frn: string;
|
|
403
686
|
})[], any>>;
|
|
404
687
|
/**
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
688
|
+
* @description Link a policy to a key
|
|
689
|
+
*
|
|
690
|
+
* @tags policy-associations
|
|
691
|
+
* @name PostApiV1PolicyAssociationsKeyByKeyId
|
|
692
|
+
* @request POST:/api/v1/policy-associations/key/{keyId}/
|
|
693
|
+
* @secure
|
|
694
|
+
* @response `200` `{
|
|
695
|
+
\** The ID of the policy *\
|
|
696
|
+
policyId: string,
|
|
697
|
+
\** The ID of the organization *\
|
|
698
|
+
organizationId: string,
|
|
699
|
+
\** The ID of the key *\
|
|
700
|
+
keyId: string,
|
|
701
|
+
|
|
702
|
+
}`
|
|
703
|
+
*/
|
|
412
704
|
postApiV1PolicyAssociationsKeyByKeyId: (keyId: string, data: {
|
|
413
705
|
/** The ID of the policy */
|
|
414
706
|
policyId: string;
|
|
@@ -421,13 +713,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
421
713
|
keyId: string;
|
|
422
714
|
}, any>>;
|
|
423
715
|
/**
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
716
|
+
* @description Unlink a policy from a key
|
|
717
|
+
*
|
|
718
|
+
* @tags policy-associations
|
|
719
|
+
* @name DeleteApiV1PolicyAssociationsKeyByKeyId
|
|
720
|
+
* @request DELETE:/api/v1/policy-associations/key/{keyId}/
|
|
721
|
+
* @secure
|
|
722
|
+
* @response `200` `{
|
|
723
|
+
\** The ID of the policy *\
|
|
724
|
+
policyId: string,
|
|
725
|
+
\** The ID of the organization *\
|
|
726
|
+
organizationId: string,
|
|
727
|
+
\** The ID of the key *\
|
|
728
|
+
keyId: string,
|
|
729
|
+
|
|
730
|
+
}`
|
|
731
|
+
*/
|
|
431
732
|
deleteApiV1PolicyAssociationsKeyByKeyId: (keyId: string, data: {
|
|
432
733
|
/** The ID of the policy */
|
|
433
734
|
policyId: string;
|
|
@@ -440,13 +741,48 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
440
741
|
keyId: string;
|
|
441
742
|
}, any>>;
|
|
442
743
|
/**
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
744
|
+
* @description Fetch policies for a role
|
|
745
|
+
*
|
|
746
|
+
* @tags policy-associations
|
|
747
|
+
* @name GetApiV1PolicyAssociationsRoleByRoleId
|
|
748
|
+
* @request GET:/api/v1/policy-associations/role/{roleId}/
|
|
749
|
+
* @secure
|
|
750
|
+
* @response `200` `((({
|
|
751
|
+
\** The id of the organization *\
|
|
752
|
+
organizationId: string,
|
|
753
|
+
\** The name of the policy *\
|
|
754
|
+
name: string,
|
|
755
|
+
\** The version of the policy *\
|
|
756
|
+
version: string,
|
|
757
|
+
policyDocuments: ({
|
|
758
|
+
\** The id of the statement *\
|
|
759
|
+
statementId?: string,
|
|
760
|
+
\** The resource of the statement *\
|
|
761
|
+
resource: string,
|
|
762
|
+
\** The action of the statement *\
|
|
763
|
+
action: (string | (string)[]),
|
|
764
|
+
|
|
765
|
+
})[],
|
|
766
|
+
\** The description of the policy *\
|
|
767
|
+
description?: string,
|
|
768
|
+
\** The principal role that can access the resource *\
|
|
769
|
+
principal?: string,
|
|
770
|
+
\** If the policy is managed by flowcore *\
|
|
771
|
+
flowcoreManaged?: boolean,
|
|
772
|
+
|
|
773
|
+
} & {
|
|
774
|
+
\** The id of the policy *\
|
|
775
|
+
id: string,
|
|
776
|
+
\** The archived status of the policy *\
|
|
777
|
+
archived: boolean,
|
|
778
|
+
\** The frn of the policy *\
|
|
779
|
+
frn: string,
|
|
780
|
+
|
|
781
|
+
}) & {
|
|
782
|
+
frn: string,
|
|
783
|
+
|
|
784
|
+
}))[]`
|
|
785
|
+
*/
|
|
450
786
|
getApiV1PolicyAssociationsRoleByRoleId: (roleId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
|
|
451
787
|
/** The id of the organization */
|
|
452
788
|
organizationId: string;
|
|
@@ -473,15 +809,28 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
473
809
|
id: string;
|
|
474
810
|
/** The archived status of the policy */
|
|
475
811
|
archived: boolean;
|
|
812
|
+
/** The frn of the policy */
|
|
813
|
+
frn: string;
|
|
814
|
+
} & {
|
|
815
|
+
frn: string;
|
|
476
816
|
})[], any>>;
|
|
477
817
|
/**
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
818
|
+
* @description Link a policy to a role
|
|
819
|
+
*
|
|
820
|
+
* @tags policy-associations
|
|
821
|
+
* @name PostApiV1PolicyAssociationsRoleByRoleId
|
|
822
|
+
* @request POST:/api/v1/policy-associations/role/{roleId}/
|
|
823
|
+
* @secure
|
|
824
|
+
* @response `200` `{
|
|
825
|
+
\** The ID of the policy *\
|
|
826
|
+
policyId: string,
|
|
827
|
+
\** The ID of the organization *\
|
|
828
|
+
organizationId: string,
|
|
829
|
+
\** The ID of the role *\
|
|
830
|
+
roleId: string,
|
|
831
|
+
|
|
832
|
+
}`
|
|
833
|
+
*/
|
|
485
834
|
postApiV1PolicyAssociationsRoleByRoleId: (roleId: string, data: {
|
|
486
835
|
/** The ID of the policy */
|
|
487
836
|
policyId: string;
|
|
@@ -494,13 +843,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
494
843
|
roleId: string;
|
|
495
844
|
}, any>>;
|
|
496
845
|
/**
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
846
|
+
* @description Unlink a policy from a role
|
|
847
|
+
*
|
|
848
|
+
* @tags policy-associations
|
|
849
|
+
* @name DeleteApiV1PolicyAssociationsRoleByRoleId
|
|
850
|
+
* @request DELETE:/api/v1/policy-associations/role/{roleId}/
|
|
851
|
+
* @secure
|
|
852
|
+
* @response `200` `{
|
|
853
|
+
\** The ID of the policy *\
|
|
854
|
+
policyId: string,
|
|
855
|
+
\** The ID of the organization *\
|
|
856
|
+
organizationId: string,
|
|
857
|
+
\** The ID of the role *\
|
|
858
|
+
roleId: string,
|
|
859
|
+
|
|
860
|
+
}`
|
|
861
|
+
*/
|
|
504
862
|
deleteApiV1PolicyAssociationsRoleByRoleId: (roleId: string, data: {
|
|
505
863
|
/** The ID of the policy */
|
|
506
864
|
policyId: string;
|
|
@@ -513,13 +871,34 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
513
871
|
roleId: string;
|
|
514
872
|
}, any>>;
|
|
515
873
|
/**
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
874
|
+
* @description Fetch associations for a role
|
|
875
|
+
*
|
|
876
|
+
* @tags role-associations
|
|
877
|
+
* @name GetApiV1RoleAssociationsByRoleId
|
|
878
|
+
* @request GET:/api/v1/role-associations/{roleId}
|
|
879
|
+
* @secure
|
|
880
|
+
* @response `200` `{
|
|
881
|
+
keys: ({
|
|
882
|
+
\** The ID of the role *\
|
|
883
|
+
roleId: string,
|
|
884
|
+
\** The ID of the organization *\
|
|
885
|
+
organizationId: string,
|
|
886
|
+
\** The ID of the key *\
|
|
887
|
+
keyId: string,
|
|
888
|
+
|
|
889
|
+
})[],
|
|
890
|
+
users: ({
|
|
891
|
+
\** The ID of the role *\
|
|
892
|
+
roleId: string,
|
|
893
|
+
\** The ID of the organization *\
|
|
894
|
+
organizationId: string,
|
|
895
|
+
\** The ID of the user *\
|
|
896
|
+
userId: string,
|
|
897
|
+
|
|
898
|
+
})[],
|
|
899
|
+
|
|
900
|
+
}`
|
|
901
|
+
*/
|
|
523
902
|
getApiV1RoleAssociationsByRoleId: (roleId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
|
|
524
903
|
keys: {
|
|
525
904
|
/** The ID of the role */
|
|
@@ -539,13 +918,30 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
539
918
|
}[];
|
|
540
919
|
}, any>>;
|
|
541
920
|
/**
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
921
|
+
* @description Fetch roles for an organization
|
|
922
|
+
*
|
|
923
|
+
* @tags role-associations
|
|
924
|
+
* @name GetApiV1RoleAssociationsOrganizationByOrganizationId
|
|
925
|
+
* @request GET:/api/v1/role-associations/organization/{organizationId}
|
|
926
|
+
* @secure
|
|
927
|
+
* @response `200` `(({
|
|
928
|
+
\** Organization ID *\
|
|
929
|
+
organizationId: string,
|
|
930
|
+
\** Role name *\
|
|
931
|
+
name: string,
|
|
932
|
+
\** Role description *\
|
|
933
|
+
description?: string,
|
|
934
|
+
\** Flowcore managed role *\
|
|
935
|
+
flowcoreManaged?: boolean,
|
|
936
|
+
|
|
937
|
+
} & {
|
|
938
|
+
\** The id of the role *\
|
|
939
|
+
id: string,
|
|
940
|
+
\** The frn of the role *\
|
|
941
|
+
frn?: string,
|
|
942
|
+
|
|
943
|
+
}))[]`
|
|
944
|
+
*/
|
|
549
945
|
getApiV1RoleAssociationsOrganizationByOrganizationId: (organizationId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
|
|
550
946
|
/** Organization ID */
|
|
551
947
|
organizationId: string;
|
|
@@ -558,15 +954,39 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
558
954
|
} & {
|
|
559
955
|
/** The id of the role */
|
|
560
956
|
id: string;
|
|
957
|
+
/** The frn of the role */
|
|
958
|
+
frn?: string;
|
|
561
959
|
})[], any>>;
|
|
562
960
|
/**
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
961
|
+
* @description Fetch roles for a user
|
|
962
|
+
*
|
|
963
|
+
* @tags role-associations
|
|
964
|
+
* @name GetApiV1RoleAssociationsUserByUserId
|
|
965
|
+
* @request GET:/api/v1/role-associations/user/{userId}/
|
|
966
|
+
* @secure
|
|
967
|
+
* @response `200` `((({
|
|
968
|
+
\** Organization ID *\
|
|
969
|
+
organizationId: string,
|
|
970
|
+
\** Role name *\
|
|
971
|
+
name: string,
|
|
972
|
+
\** Role description *\
|
|
973
|
+
description?: string,
|
|
974
|
+
\** Flowcore managed role *\
|
|
975
|
+
flowcoreManaged?: boolean,
|
|
976
|
+
|
|
977
|
+
} & {
|
|
978
|
+
\** Role ID *\
|
|
979
|
+
id: string,
|
|
980
|
+
\** The archived status of the role *\
|
|
981
|
+
archived: boolean,
|
|
982
|
+
\** The frn of the role *\
|
|
983
|
+
frn?: string,
|
|
984
|
+
|
|
985
|
+
}) & {
|
|
986
|
+
frn: string,
|
|
987
|
+
|
|
988
|
+
}))[]`
|
|
989
|
+
*/
|
|
570
990
|
getApiV1RoleAssociationsUserByUserId: (userId: string, query?: {
|
|
571
991
|
/** The ID of the organization */
|
|
572
992
|
organizationId?: string;
|
|
@@ -584,15 +1004,28 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
584
1004
|
id: string;
|
|
585
1005
|
/** The archived status of the role */
|
|
586
1006
|
archived: boolean;
|
|
1007
|
+
/** The frn of the role */
|
|
1008
|
+
frn?: string;
|
|
1009
|
+
} & {
|
|
1010
|
+
frn: string;
|
|
587
1011
|
})[], any>>;
|
|
588
1012
|
/**
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
1013
|
+
* @description Link a role to a user
|
|
1014
|
+
*
|
|
1015
|
+
* @tags role-associations
|
|
1016
|
+
* @name PostApiV1RoleAssociationsUserByUserId
|
|
1017
|
+
* @request POST:/api/v1/role-associations/user/{userId}/
|
|
1018
|
+
* @secure
|
|
1019
|
+
* @response `200` `{
|
|
1020
|
+
\** The ID of the role *\
|
|
1021
|
+
roleId: string,
|
|
1022
|
+
\** The ID of the organization *\
|
|
1023
|
+
organizationId: string,
|
|
1024
|
+
\** The ID of the user *\
|
|
1025
|
+
userId: string,
|
|
1026
|
+
|
|
1027
|
+
}`
|
|
1028
|
+
*/
|
|
596
1029
|
postApiV1RoleAssociationsUserByUserId: (userId: string, data: {
|
|
597
1030
|
/** The ID of the role */
|
|
598
1031
|
roleId: string;
|
|
@@ -605,13 +1038,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
605
1038
|
userId: string;
|
|
606
1039
|
}, any>>;
|
|
607
1040
|
/**
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
1041
|
+
* @description Unlink a role from a user
|
|
1042
|
+
*
|
|
1043
|
+
* @tags role-associations
|
|
1044
|
+
* @name DeleteApiV1RoleAssociationsUserByUserId
|
|
1045
|
+
* @request DELETE:/api/v1/role-associations/user/{userId}/
|
|
1046
|
+
* @secure
|
|
1047
|
+
* @response `200` `{
|
|
1048
|
+
\** The ID of the role *\
|
|
1049
|
+
roleId: string,
|
|
1050
|
+
\** The ID of the organization *\
|
|
1051
|
+
organizationId: string,
|
|
1052
|
+
\** The ID of the user *\
|
|
1053
|
+
userId: string,
|
|
1054
|
+
|
|
1055
|
+
}`
|
|
1056
|
+
*/
|
|
615
1057
|
deleteApiV1RoleAssociationsUserByUserId: (userId: string, data: {
|
|
616
1058
|
/** The ID of the role */
|
|
617
1059
|
roleId: string;
|
|
@@ -624,13 +1066,35 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
624
1066
|
userId: string;
|
|
625
1067
|
}, any>>;
|
|
626
1068
|
/**
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
1069
|
+
* @description Fetch roles for a key
|
|
1070
|
+
*
|
|
1071
|
+
* @tags role-associations
|
|
1072
|
+
* @name GetApiV1RoleAssociationsKeyByKeyId
|
|
1073
|
+
* @request GET:/api/v1/role-associations/key/{keyId}/
|
|
1074
|
+
* @secure
|
|
1075
|
+
* @response `200` `((({
|
|
1076
|
+
\** Organization ID *\
|
|
1077
|
+
organizationId: string,
|
|
1078
|
+
\** Role name *\
|
|
1079
|
+
name: string,
|
|
1080
|
+
\** Role description *\
|
|
1081
|
+
description?: string,
|
|
1082
|
+
\** Flowcore managed role *\
|
|
1083
|
+
flowcoreManaged?: boolean,
|
|
1084
|
+
|
|
1085
|
+
} & {
|
|
1086
|
+
\** Role ID *\
|
|
1087
|
+
id: string,
|
|
1088
|
+
\** The archived status of the role *\
|
|
1089
|
+
archived: boolean,
|
|
1090
|
+
\** The frn of the role *\
|
|
1091
|
+
frn?: string,
|
|
1092
|
+
|
|
1093
|
+
}) & {
|
|
1094
|
+
frn: string,
|
|
1095
|
+
|
|
1096
|
+
}))[]`
|
|
1097
|
+
*/
|
|
634
1098
|
getApiV1RoleAssociationsKeyByKeyId: (keyId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
|
|
635
1099
|
/** Organization ID */
|
|
636
1100
|
organizationId: string;
|
|
@@ -645,15 +1109,28 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
645
1109
|
id: string;
|
|
646
1110
|
/** The archived status of the role */
|
|
647
1111
|
archived: boolean;
|
|
1112
|
+
/** The frn of the role */
|
|
1113
|
+
frn?: string;
|
|
1114
|
+
} & {
|
|
1115
|
+
frn: string;
|
|
648
1116
|
})[], any>>;
|
|
649
1117
|
/**
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
1118
|
+
* @description Link a role to a key
|
|
1119
|
+
*
|
|
1120
|
+
* @tags role-associations
|
|
1121
|
+
* @name PostApiV1RoleAssociationsKeyByKeyId
|
|
1122
|
+
* @request POST:/api/v1/role-associations/key/{keyId}/
|
|
1123
|
+
* @secure
|
|
1124
|
+
* @response `200` `{
|
|
1125
|
+
\** The ID of the role *\
|
|
1126
|
+
roleId: string,
|
|
1127
|
+
\** The ID of the organization *\
|
|
1128
|
+
organizationId: string,
|
|
1129
|
+
\** The ID of the key *\
|
|
1130
|
+
keyId: string,
|
|
1131
|
+
|
|
1132
|
+
}`
|
|
1133
|
+
*/
|
|
657
1134
|
postApiV1RoleAssociationsKeyByKeyId: (keyId: string, data: {
|
|
658
1135
|
/** The ID of the role */
|
|
659
1136
|
roleId: string;
|
|
@@ -666,13 +1143,22 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
666
1143
|
keyId: string;
|
|
667
1144
|
}, any>>;
|
|
668
1145
|
/**
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
|
|
675
|
-
|
|
1146
|
+
* @description Unlink a role from a key
|
|
1147
|
+
*
|
|
1148
|
+
* @tags role-associations
|
|
1149
|
+
* @name DeleteApiV1RoleAssociationsKeyByKeyId
|
|
1150
|
+
* @request DELETE:/api/v1/role-associations/key/{keyId}/
|
|
1151
|
+
* @secure
|
|
1152
|
+
* @response `200` `{
|
|
1153
|
+
\** The ID of the role *\
|
|
1154
|
+
roleId: string,
|
|
1155
|
+
\** The ID of the organization *\
|
|
1156
|
+
organizationId: string,
|
|
1157
|
+
\** The ID of the key *\
|
|
1158
|
+
keyId: string,
|
|
1159
|
+
|
|
1160
|
+
}`
|
|
1161
|
+
*/
|
|
676
1162
|
deleteApiV1RoleAssociationsKeyByKeyId: (keyId: string, data: {
|
|
677
1163
|
/** The ID of the role */
|
|
678
1164
|
roleId: string;
|
|
@@ -685,13 +1171,54 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
685
1171
|
keyId: string;
|
|
686
1172
|
}, any>>;
|
|
687
1173
|
/**
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
1174
|
+
* @description Validate if a user can perform actions
|
|
1175
|
+
*
|
|
1176
|
+
* @tags validate
|
|
1177
|
+
* @name PostApiV1ValidateUsersById
|
|
1178
|
+
* @request POST:/api/v1/validate/users/{id}
|
|
1179
|
+
* @secure
|
|
1180
|
+
* @response `200` `{
|
|
1181
|
+
\**
|
|
1182
|
+
* The action is valid
|
|
1183
|
+
* @default true
|
|
1184
|
+
*\
|
|
1185
|
+
valid: true,
|
|
1186
|
+
\** The hash of the policy/key/user/role association that was validated *\
|
|
1187
|
+
checksum: string,
|
|
1188
|
+
validPolicies: ({
|
|
1189
|
+
\** The frn of the policy *\
|
|
1190
|
+
policyFrn: string,
|
|
1191
|
+
\** The statement id of the policy *\
|
|
1192
|
+
statementId: string,
|
|
1193
|
+
|
|
1194
|
+
})[],
|
|
1195
|
+
|
|
1196
|
+
}`
|
|
1197
|
+
* @response `403` `{
|
|
1198
|
+
\** The error message *\
|
|
1199
|
+
message: string,
|
|
1200
|
+
\**
|
|
1201
|
+
* The action is invalid
|
|
1202
|
+
* @default false
|
|
1203
|
+
*\
|
|
1204
|
+
valid: false,
|
|
1205
|
+
validPolicies: ({
|
|
1206
|
+
\** The frn of the policy *\
|
|
1207
|
+
policyFrn: string,
|
|
1208
|
+
\** The statement id of the policy *\
|
|
1209
|
+
statementId: string,
|
|
1210
|
+
|
|
1211
|
+
})[],
|
|
1212
|
+
invalidRequest: ({
|
|
1213
|
+
\** The resource to validate, in order of granularity. First match wins. *\
|
|
1214
|
+
resource: (string)[],
|
|
1215
|
+
\** The action or actions to validate against *\
|
|
1216
|
+
action: (string | (string)[]),
|
|
1217
|
+
|
|
1218
|
+
})[],
|
|
1219
|
+
|
|
1220
|
+
}`
|
|
1221
|
+
*/
|
|
695
1222
|
postApiV1ValidateUsersById: (id: string, data: {
|
|
696
1223
|
/** The mode of validation of the flowcore resource notation, either by tenant or organization id */
|
|
697
1224
|
mode: "tenant" | "organization";
|
|
@@ -737,13 +1264,54 @@ export declare class Api<SecurityDataType = unknown> extends HttpClient<Security
|
|
|
737
1264
|
}[];
|
|
738
1265
|
}>>;
|
|
739
1266
|
/**
|
|
740
|
-
|
|
741
|
-
|
|
742
|
-
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
746
|
-
|
|
1267
|
+
* @description Validate if a key can perform actions
|
|
1268
|
+
*
|
|
1269
|
+
* @tags validate
|
|
1270
|
+
* @name PostApiV1ValidateKeysById
|
|
1271
|
+
* @request POST:/api/v1/validate/keys/{id}
|
|
1272
|
+
* @secure
|
|
1273
|
+
* @response `200` `{
|
|
1274
|
+
\**
|
|
1275
|
+
* The action is valid
|
|
1276
|
+
* @default true
|
|
1277
|
+
*\
|
|
1278
|
+
valid: true,
|
|
1279
|
+
\** The hash of the policy/key/user/role association that was validated *\
|
|
1280
|
+
checksum: string,
|
|
1281
|
+
validPolicies: ({
|
|
1282
|
+
\** The frn of the policy *\
|
|
1283
|
+
policyFrn: string,
|
|
1284
|
+
\** The statement id of the policy *\
|
|
1285
|
+
statementId: string,
|
|
1286
|
+
|
|
1287
|
+
})[],
|
|
1288
|
+
|
|
1289
|
+
}`
|
|
1290
|
+
* @response `403` `{
|
|
1291
|
+
\** The error message *\
|
|
1292
|
+
message: string,
|
|
1293
|
+
\**
|
|
1294
|
+
* The action is invalid
|
|
1295
|
+
* @default false
|
|
1296
|
+
*\
|
|
1297
|
+
valid: false,
|
|
1298
|
+
validPolicies: ({
|
|
1299
|
+
\** The frn of the policy *\
|
|
1300
|
+
policyFrn: string,
|
|
1301
|
+
\** The statement id of the policy *\
|
|
1302
|
+
statementId: string,
|
|
1303
|
+
|
|
1304
|
+
})[],
|
|
1305
|
+
invalidRequest: ({
|
|
1306
|
+
\** The resource to validate, in order of granularity. First match wins. *\
|
|
1307
|
+
resource: (string)[],
|
|
1308
|
+
\** The action or actions to validate against *\
|
|
1309
|
+
action: (string | (string)[]),
|
|
1310
|
+
|
|
1311
|
+
})[],
|
|
1312
|
+
|
|
1313
|
+
}`
|
|
1314
|
+
*/
|
|
747
1315
|
postApiV1ValidateKeysById: (id: string, data: {
|
|
748
1316
|
/** The mode of validation of the flowcore resource notation, either by tenant or organization id */
|
|
749
1317
|
mode: "tenant" | "organization";
|