@dynatrace-sdk/client-classic-environment-v2 3.5.0 → 3.6.1
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 +19 -0
- package/README.md +994 -246
- package/cjs/index.js +5325 -3529
- package/dynatrace-metadata.json +2 -2
- package/esm/index.js +3388 -1600
- package/package.json +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/active-gates-api.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/apis/extensions-2-0-api.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/settings-objects-api.d.ts +251 -1
- package/types/packages/client/classic-environment-v2/src/lib/apis/synthetic-locations-nodes-and-configuration-api.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/index.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions-list.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions-list.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions-permissions-item.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions-permissions-item.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions.d.ts +14 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/accessor-permissions.transformation.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-category.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry-category.transformation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/audit-log-entry.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-permission.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/effective-permission.transformation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/get-permission-path-accessor-type.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/get-permission-path-accessor-type.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/index.d.ts +182 -162
- package/types/packages/client/classic-environment-v2/src/lib/models/log-message-json.d.ts +8 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states-state.transformation.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/monitored-entity-states.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location-node-names.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location-node-names.transformation.d.ts +6 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.d.ts +5 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/private-synthetic-location.transformation.d.ts +2 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remove-permission-path-accessor-type.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/remove-permission-path-accessor-type.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/resolution-request.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/resolution-request.transformation.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/revision-diff.d.ts +1 -1
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-create.d.ts +2 -2
- package/types/packages/client/classic-environment-v2/src/lib/models/settings-object-update.d.ts +6 -6
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.d.ts +4 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/slo.transformation.d.ts +1 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/transfer-ownership-request.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/transfer-ownership-request.transformation.d.ts +10 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permission-path-accessor-type.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permission-path-accessor-type.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permissions-request-permissions-item.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permissions-request-permissions-item.transformation.d.ts +3 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permissions-request.d.ts +9 -0
- package/types/packages/client/classic-environment-v2/src/lib/models/update-permissions-request.transformation.d.ts +7 -0
- package/types/packages/client/classic-environment-v2/src/lib/error-envelopes/error-serializer.d.ts +0 -3
package/package.json
CHANGED
|
@@ -71,8 +71,8 @@ export declare class ActiveGatesClient {
|
|
|
71
71
|
* You can specify a partial name. In that case, the `CONTAINS` operator is used.
|
|
72
72
|
*/ group?: string;
|
|
73
73
|
/** Filters the resulting set of ActiveGates by the communication status. */ online?: boolean;
|
|
74
|
-
/** Filters the resulting set of ActiveGates by the enabled modules. */ enabledModule?: 'AWS' | 'AZURE' | 'BEACON_FORWARDER' | 'CLOUD_FOUNDRY' | 'DB_INSIGHT' | 'EXTENSIONS_V1' | 'EXTENSIONS_V2' | 'KUBERNETES' | 'LOGS' | 'MEMORY_DUMPS' | 'METRIC_API' | 'ONE_AGENT_ROUTING' | 'OTLP_INGEST' | 'REST_API' | 'SYNTHETIC' | 'VMWARE' | 'Z_OS';
|
|
75
|
-
/** Filters the resulting set of ActiveGates by the disabled modules. */ disabledModule?: 'AWS' | 'AZURE' | 'BEACON_FORWARDER' | 'CLOUD_FOUNDRY' | 'DB_INSIGHT' | 'EXTENSIONS_V1' | 'EXTENSIONS_V2' | 'KUBERNETES' | 'LOGS' | 'MEMORY_DUMPS' | 'METRIC_API' | 'ONE_AGENT_ROUTING' | 'OTLP_INGEST' | 'REST_API' | 'SYNTHETIC' | 'VMWARE' | 'Z_OS';
|
|
74
|
+
/** Filters the resulting set of ActiveGates by the enabled modules. */ enabledModule?: ('AWS' | 'AZURE' | 'BEACON_FORWARDER' | 'CLOUD_FOUNDRY' | 'DB_INSIGHT' | 'EXTENSIONS_V1' | 'EXTENSIONS_V2' | 'KUBERNETES' | 'LOGS' | 'MEMORY_DUMPS' | 'METRIC_API' | 'ONE_AGENT_ROUTING' | 'OTLP_INGEST' | 'REST_API' | 'SYNTHETIC' | 'VMWARE' | 'Z_OS')[];
|
|
75
|
+
/** Filters the resulting set of ActiveGates by the disabled modules. */ disabledModule?: ('AWS' | 'AZURE' | 'BEACON_FORWARDER' | 'CLOUD_FOUNDRY' | 'DB_INSIGHT' | 'EXTENSIONS_V1' | 'EXTENSIONS_V2' | 'KUBERNETES' | 'LOGS' | 'MEMORY_DUMPS' | 'METRIC_API' | 'ONE_AGENT_ROUTING' | 'OTLP_INGEST' | 'REST_API' | 'SYNTHETIC' | 'VMWARE' | 'Z_OS')[];
|
|
76
76
|
/** Filters the resulting set of ActiveGates to those which are running in container (`true`) or not (`false`). */ containerized?: boolean;
|
|
77
77
|
/** Filters the resulting set of ActiveGates to those with authorization token in specified state. */ tokenState?: 'ABSENT' | 'EXPIRING' | 'INVALID' | 'UNKNOWN' | 'UNSUPPORTED' | 'VALID';
|
|
78
78
|
/** Filters the resulting set of ActiveGates to those with set expiration date for authorization token. */ tokenExpirationSet?: boolean;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { AbortSignal,
|
|
1
|
+
import { AbortSignal, Binary, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
2
|
import { ActiveGateGroupsInfoDto } from '../models/active-gate-groups-info-dto';
|
|
3
3
|
import { ErrorEnvelope } from '../models/error-envelope';
|
|
4
4
|
import { ExecuteActionsDto } from '../models/execute-actions-dto';
|
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
|
|
2
|
+
import { AccessorPermissions } from '../models/accessor-permissions';
|
|
3
|
+
import { AccessorPermissionsList } from '../models/accessor-permissions-list';
|
|
2
4
|
import { EffectivePermission } from '../models/effective-permission';
|
|
3
5
|
import { EffectiveSettingsValuesList } from '../models/effective-settings-values-list';
|
|
4
6
|
import { ObjectsList } from '../models/objects-list';
|
|
@@ -8,6 +10,8 @@ import { SettingsObjectByObjectIdResponse } from '../models/settings-object-by-o
|
|
|
8
10
|
import { SettingsObjectCreate } from '../models/settings-object-create';
|
|
9
11
|
import { SettingsObjectResponse } from '../models/settings-object-response';
|
|
10
12
|
import { SettingsObjectUpdate } from '../models/settings-object-update';
|
|
13
|
+
import { TransferOwnershipRequest } from '../models/transfer-ownership-request';
|
|
14
|
+
import { UpdatePermissionsRequest } from '../models/update-permissions-request';
|
|
11
15
|
/**
|
|
12
16
|
* Manage settings objects
|
|
13
17
|
*/
|
|
@@ -38,7 +42,17 @@ export declare class SettingsObjectsClient {
|
|
|
38
42
|
*
|
|
39
43
|
* const data =
|
|
40
44
|
* await settingsObjectsClient.resolveEffectivePermissions({
|
|
41
|
-
* body: {
|
|
45
|
+
* body: {
|
|
46
|
+
* permissions: [
|
|
47
|
+
* {
|
|
48
|
+
* context: {
|
|
49
|
+
* schemaId: "service:schema",
|
|
50
|
+
* scope: "environment",
|
|
51
|
+
* },
|
|
52
|
+
* permission: "settings:objects:write",
|
|
53
|
+
* },
|
|
54
|
+
* ],
|
|
55
|
+
* },
|
|
42
56
|
* });
|
|
43
57
|
*
|
|
44
58
|
* @throws {ErrorEnvelopeError} Failed. Forbidden. No access to any settings. | Client side error. | Server side error.
|
|
@@ -110,6 +124,7 @@ export declare class SettingsObjectsClient {
|
|
|
110
124
|
*
|
|
111
125
|
* If not set, 100 is used.
|
|
112
126
|
*/ pageSize?: number;
|
|
127
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
113
128
|
abortSignal?: AbortSignal;
|
|
114
129
|
}): Promise<EffectiveSettingsValuesList>;
|
|
115
130
|
/**
|
|
@@ -167,6 +182,7 @@ export declare class SettingsObjectsClient {
|
|
|
167
182
|
*
|
|
168
183
|
* If not set, 100 is used.
|
|
169
184
|
*/ pageSize?: number;
|
|
185
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
170
186
|
abortSignal?: AbortSignal;
|
|
171
187
|
}): Promise<RevisionDiffPage>;
|
|
172
188
|
/**
|
|
@@ -268,6 +284,7 @@ export declare class SettingsObjectsClient {
|
|
|
268
284
|
*
|
|
269
285
|
* If not set, 100 is used.
|
|
270
286
|
*/ pageSize?: number;
|
|
287
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
271
288
|
abortSignal?: AbortSignal;
|
|
272
289
|
}): Promise<ObjectsList>;
|
|
273
290
|
/**
|
|
@@ -305,6 +322,7 @@ export declare class SettingsObjectsClient {
|
|
|
305
322
|
postSettingsObjects(config: {
|
|
306
323
|
body: SettingsObjectCreate[];
|
|
307
324
|
/** If `true`, the request runs only validation of the submitted settings objects, without saving them. */ validateOnly?: boolean;
|
|
325
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
308
326
|
abortSignal?: AbortSignal;
|
|
309
327
|
}): Promise<SettingsObjectResponse[]>;
|
|
310
328
|
/**
|
|
@@ -331,6 +349,7 @@ export declare class SettingsObjectsClient {
|
|
|
331
349
|
*/
|
|
332
350
|
getSettingsObjectByObjectId(config: {
|
|
333
351
|
/** The ID of the required settings object. */ objectId: string;
|
|
352
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
334
353
|
abortSignal?: AbortSignal;
|
|
335
354
|
}): Promise<SettingsObjectByObjectIdResponse>;
|
|
336
355
|
/**
|
|
@@ -365,6 +384,7 @@ export declare class SettingsObjectsClient {
|
|
|
365
384
|
body: SettingsObjectUpdate;
|
|
366
385
|
/** The ID of the required settings object. */ objectId: string;
|
|
367
386
|
/** If `true`, the request runs only validation of the submitted settings object, without saving it. */ validateOnly?: boolean;
|
|
387
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
368
388
|
abortSignal?: AbortSignal;
|
|
369
389
|
}): Promise<SettingsObjectResponse>;
|
|
370
390
|
/**
|
|
@@ -397,6 +417,236 @@ export declare class SettingsObjectsClient {
|
|
|
397
417
|
*
|
|
398
418
|
* If omitted on update/deletion, the operation overrides the current value or deletes it without any checks.
|
|
399
419
|
*/ updateToken?: string;
|
|
420
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
421
|
+
abortSignal?: AbortSignal;
|
|
422
|
+
}): Promise<void>;
|
|
423
|
+
/**
|
|
424
|
+
* Get current permissions on this object.
|
|
425
|
+
*
|
|
426
|
+
* **Required scope:** settings:objects:read<br/>**Required permission:** settings:objects:read<br/><br/>Get current permissions on this object.
|
|
427
|
+
*
|
|
428
|
+
* @returns {Promise<AccessorPermissionsList[]>} Success
|
|
429
|
+
*
|
|
430
|
+
* @example <caption>Code example</caption>
|
|
431
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
432
|
+
*
|
|
433
|
+
* const data = await settingsObjectsClient.getPermissions({
|
|
434
|
+
* objectId: "...",
|
|
435
|
+
* });
|
|
436
|
+
*
|
|
437
|
+
* @throws {ErrorEnvelopeError} No object available for the given objectId. | Client side error. | Server side error.
|
|
438
|
+
* @throws {InvalidResponseError}
|
|
439
|
+
* @throws {ApiClientError}
|
|
440
|
+
* @throws {ClientRequestError}
|
|
441
|
+
*/
|
|
442
|
+
getPermissions(config: {
|
|
443
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
444
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
445
|
+
abortSignal?: AbortSignal;
|
|
446
|
+
}): Promise<AccessorPermissionsList[]>;
|
|
447
|
+
/**
|
|
448
|
+
* Add the permissions for a single accessor on this object.
|
|
449
|
+
*
|
|
450
|
+
* **Required scope:** settings:objects:write<br/>**Required permission:** settings:objects:write<br/><br/>Add the permissions for a single accessor on this object, anyone with read/write permissions is allowed to add more permissions.
|
|
451
|
+
*
|
|
452
|
+
* @returns {Promise<AccessorPermissions>} Created
|
|
453
|
+
*
|
|
454
|
+
* @example <caption>Code example</caption>
|
|
455
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
456
|
+
*
|
|
457
|
+
* const data = await settingsObjectsClient.addPermission({
|
|
458
|
+
* objectId: "...",
|
|
459
|
+
* body: { accessor: { type: IdentityType.User } },
|
|
460
|
+
* });
|
|
461
|
+
*
|
|
462
|
+
* @throws {ErrorEnvelopeError} If accessor id already exists. | Failed. Forbidden. | No object available for the given objectId. | Client side error. | Server side error.
|
|
463
|
+
* @throws {InvalidResponseError}
|
|
464
|
+
* @throws {ApiClientError}
|
|
465
|
+
* @throws {ClientRequestError}
|
|
466
|
+
*/
|
|
467
|
+
addPermission(config: {
|
|
468
|
+
body: AccessorPermissions;
|
|
469
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
470
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
471
|
+
abortSignal?: AbortSignal;
|
|
472
|
+
}): Promise<AccessorPermissions>;
|
|
473
|
+
/**
|
|
474
|
+
* Get current permissions of the all-users accessor on this object.
|
|
475
|
+
*
|
|
476
|
+
* **Required scope:** settings:objects:read<br/>**Required permission:** settings:objects:read<br/><br/>Get current permissions of the all-users accessor on this object.
|
|
477
|
+
*
|
|
478
|
+
* @returns {Promise<AccessorPermissions>} Success
|
|
479
|
+
*
|
|
480
|
+
* @example <caption>Code example</caption>
|
|
481
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
482
|
+
*
|
|
483
|
+
* const data =
|
|
484
|
+
* await settingsObjectsClient.getPermissionAllUsers({
|
|
485
|
+
* objectId: "...",
|
|
486
|
+
* });
|
|
487
|
+
*
|
|
488
|
+
* @throws {ErrorEnvelopeError} No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. | Client side error. | Server side error.
|
|
489
|
+
* @throws {InvalidResponseError}
|
|
490
|
+
* @throws {ApiClientError}
|
|
491
|
+
* @throws {ClientRequestError}
|
|
492
|
+
*/
|
|
493
|
+
getPermissionAllUsers(config: {
|
|
494
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
495
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
496
|
+
abortSignal?: AbortSignal;
|
|
497
|
+
}): Promise<AccessorPermissions>;
|
|
498
|
+
/**
|
|
499
|
+
* Update the permissions for an existing all-users accessor on this object.
|
|
500
|
+
*
|
|
501
|
+
* **Required scope:** settings:objects:write<br/>**Required permission:** settings:objects:write<br/><br/>Update the permissions for an existing all-users accessor on this object, anyone with read/write permissions is allowed to update permissions.
|
|
502
|
+
*
|
|
503
|
+
* @example <caption>Code example</caption>
|
|
504
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
505
|
+
*
|
|
506
|
+
* const data =
|
|
507
|
+
* await settingsObjectsClient.updatePermissionAllUsers({
|
|
508
|
+
* objectId: "...",
|
|
509
|
+
* body: {},
|
|
510
|
+
* });
|
|
511
|
+
*
|
|
512
|
+
* @throws {ErrorEnvelopeError} If permission list is empty, contains unsupported entries or unsupported combinations of entries. | No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. | Client side error. | Server side error.
|
|
513
|
+
* @throws {InvalidResponseError}
|
|
514
|
+
* @throws {ApiClientError}
|
|
515
|
+
* @throws {ClientRequestError}
|
|
516
|
+
*/
|
|
517
|
+
updatePermissionAllUsers(config: {
|
|
518
|
+
body: UpdatePermissionsRequest;
|
|
519
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
520
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
521
|
+
abortSignal?: AbortSignal;
|
|
522
|
+
}): Promise<void>;
|
|
523
|
+
/**
|
|
524
|
+
* Remove the permissions for an existing all-users accessor on this object.
|
|
525
|
+
*
|
|
526
|
+
* **Required scope:** settings:objects:write<br/>**Required permission:** settings:objects:write<br/><br/>Remove the permissions for an existing all-users accessor on this object, anyone with read/write permissions is allowed to delete permissions.
|
|
527
|
+
*
|
|
528
|
+
* @example <caption>Code example</caption>
|
|
529
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
530
|
+
*
|
|
531
|
+
* const data =
|
|
532
|
+
* await settingsObjectsClient.removePermissionAllUsers({
|
|
533
|
+
* objectId: "...",
|
|
534
|
+
* });
|
|
535
|
+
*
|
|
536
|
+
* @throws {ErrorEnvelopeError} No object available for the given objectId or the all-users accessor doesn't have any permissions on this object. | Client side error. | Server side error.
|
|
537
|
+
* @throws {InvalidResponseError}
|
|
538
|
+
* @throws {ApiClientError}
|
|
539
|
+
* @throws {ClientRequestError}
|
|
540
|
+
*/
|
|
541
|
+
removePermissionAllUsers(config: {
|
|
542
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
543
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
544
|
+
abortSignal?: AbortSignal;
|
|
545
|
+
}): Promise<void>;
|
|
546
|
+
/**
|
|
547
|
+
* Get current permissions of the accessor on this object.
|
|
548
|
+
*
|
|
549
|
+
* **Required scope:** settings:objects:read<br/>**Required permission:** settings:objects:read<br/><br/>Get current permissions of the accessor on this object.
|
|
550
|
+
*
|
|
551
|
+
* @returns {Promise<AccessorPermissions>} Success
|
|
552
|
+
*
|
|
553
|
+
* @example <caption>Code example</caption>
|
|
554
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
555
|
+
*
|
|
556
|
+
* const data = await settingsObjectsClient.getPermission({
|
|
557
|
+
* objectId: "...",
|
|
558
|
+
* accessorType: GetPermissionPathAccessorType.Group,
|
|
559
|
+
* accessorId: "...",
|
|
560
|
+
* });
|
|
561
|
+
*
|
|
562
|
+
* @throws {ErrorEnvelopeError} No object available for the given objectId or the accessor doesn't have any permissions on this object. | Client side error. | Server side error.
|
|
563
|
+
* @throws {InvalidResponseError}
|
|
564
|
+
* @throws {ApiClientError}
|
|
565
|
+
* @throws {ClientRequestError}
|
|
566
|
+
*/
|
|
567
|
+
getPermission(config: {
|
|
568
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
569
|
+
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
570
|
+
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
571
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
572
|
+
abortSignal?: AbortSignal;
|
|
573
|
+
}): Promise<AccessorPermissions>;
|
|
574
|
+
/**
|
|
575
|
+
* Update the permissions for an existing accessor on this object.
|
|
576
|
+
*
|
|
577
|
+
* **Required scope:** settings:objects:write<br/>**Required permission:** settings:objects:write<br/><br/>Update the permissions for an existing accessor on this object, anyone with read/write permissions is allowed to update permissions.
|
|
578
|
+
*
|
|
579
|
+
* @example <caption>Code example</caption>
|
|
580
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
581
|
+
*
|
|
582
|
+
* const data = await settingsObjectsClient.updatePermission({
|
|
583
|
+
* objectId: "...",
|
|
584
|
+
* accessorType: UpdatePermissionPathAccessorType.Group,
|
|
585
|
+
* accessorId: "...",
|
|
586
|
+
* body: {},
|
|
587
|
+
* });
|
|
588
|
+
*
|
|
589
|
+
* @throws {ErrorEnvelopeError} If permission list is empty, contains unsupported entries or unsupported combinations of entries. | No object available for the given objectId or the accessor doesn't have any permissions on this object. | Client side error. | Server side error.
|
|
590
|
+
* @throws {InvalidResponseError}
|
|
591
|
+
* @throws {ApiClientError}
|
|
592
|
+
* @throws {ClientRequestError}
|
|
593
|
+
*/
|
|
594
|
+
updatePermission(config: {
|
|
595
|
+
body: UpdatePermissionsRequest;
|
|
596
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
597
|
+
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
598
|
+
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
599
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
600
|
+
abortSignal?: AbortSignal;
|
|
601
|
+
}): Promise<void>;
|
|
602
|
+
/**
|
|
603
|
+
* Remove the permissions for an existing accessor on this object.
|
|
604
|
+
*
|
|
605
|
+
* **Required scope:** settings:objects:write<br/>**Required permission:** settings:objects:write<br/><br/>Remove the permissions for an existing accessor on this object, anyone with read/write permissions is allowed to delete permissions.
|
|
606
|
+
*
|
|
607
|
+
* @example <caption>Code example</caption>
|
|
608
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
609
|
+
*
|
|
610
|
+
* const data = await settingsObjectsClient.removePermission({
|
|
611
|
+
* objectId: "...",
|
|
612
|
+
* accessorType: RemovePermissionPathAccessorType.Group,
|
|
613
|
+
* accessorId: "...",
|
|
614
|
+
* });
|
|
615
|
+
*
|
|
616
|
+
* @throws {ErrorEnvelopeError} No object available for the given objectId or the accessor doesn't have any permissions on this object. | Client side error. | Server side error.
|
|
617
|
+
* @throws {InvalidResponseError}
|
|
618
|
+
* @throws {ApiClientError}
|
|
619
|
+
* @throws {ClientRequestError}
|
|
620
|
+
*/
|
|
621
|
+
removePermission(config: {
|
|
622
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
623
|
+
/** The type of the accessor. */ accessorType: 'group' | 'user';
|
|
624
|
+
/** The user uuid or group uuid of the accessor, depending on the type. */ accessorId: string;
|
|
625
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
626
|
+
abortSignal?: AbortSignal;
|
|
627
|
+
}): Promise<void>;
|
|
628
|
+
/**
|
|
629
|
+
* Transfer ownership of the object.
|
|
630
|
+
*
|
|
631
|
+
* **Required scope:** settings:objects:write<br/>**Required permission:** settings:objects:write<br/><br/>Transfer ownership of the object, only the owner or the main admin is allowed to transfer the ownership (IAM permission needed).
|
|
632
|
+
*
|
|
633
|
+
* @example <caption>Code example</caption>
|
|
634
|
+
* import { settingsObjectsClient } from "@dynatrace-sdk/client-classic-environment-v2";
|
|
635
|
+
*
|
|
636
|
+
* const data = await settingsObjectsClient.transferOwnership({
|
|
637
|
+
* objectId: "...",
|
|
638
|
+
* body: { newOwner: { type: IdentityType.User } },
|
|
639
|
+
* });
|
|
640
|
+
*
|
|
641
|
+
* @throws {ErrorEnvelopeError} Failed. The input is invalid. | Failed. Forbidden. | No object available for the given objectId. | Client side error. | Server side error.
|
|
642
|
+
* @throws {InvalidResponseError}
|
|
643
|
+
* @throws {ApiClientError}
|
|
644
|
+
* @throws {ClientRequestError}
|
|
645
|
+
*/
|
|
646
|
+
transferOwnership(config: {
|
|
647
|
+
body: TransferOwnershipRequest;
|
|
648
|
+
/** The ID of the required settings object. */ objectId: string;
|
|
649
|
+
/** If set to true and user has settings:objects:admin permission, the endpoint will act as if the user is the owner of all objects */ adminAccess?: boolean;
|
|
400
650
|
abortSignal?: AbortSignal;
|
|
401
651
|
}): Promise<void>;
|
|
402
652
|
}
|
|
@@ -333,6 +333,7 @@ export declare class SyntheticLocationsNodesAndConfigurationClient {
|
|
|
333
333
|
*/
|
|
334
334
|
getNodes(config?: {
|
|
335
335
|
/** Filters the resulting set of nodes to those which are assigned to a synthetic location or not. */ assignedToLocation?: 'TRUE' | 'FALSE';
|
|
336
|
+
/** If set to true, returns only containerized nodes. */ isContainerized?: boolean;
|
|
336
337
|
abortSignal?: AbortSignal;
|
|
337
338
|
}): Promise<Nodes>;
|
|
338
339
|
/**
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
export { ApiClientError, ApiGatewayError, ClientRequestError, InvalidResponseError, isApiClientError, isApiGatewayError, isClientRequestError, isInvalidResponseError, } from '@dynatrace-sdk/shared-errors';
|
|
2
|
-
export { ErrorEnvelopeError, isErrorEnvelopeError } from './error-envelope-error';
|
|
3
2
|
export { BizEventIngestResultError, isBizEventIngestResultError } from './biz-event-ingest-result-error';
|
|
4
|
-
export {
|
|
3
|
+
export { ErrorEnvelopeError, isErrorEnvelopeError } from './error-envelope-error';
|
|
5
4
|
export { SettingsObjectResponseArrayError, isSettingsObjectResponseArrayError, } from './settings-object-response-array-error';
|
|
6
5
|
export { SettingsObjectResponseError, isSettingsObjectResponseError } from './settings-object-response-error';
|
|
6
|
+
export { ValidationResponseError, isValidationResponseError } from './validation-response-error';
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { AccessorPermissionsList } from './accessor-permissions-list';
|
|
2
|
+
import * as _AccessorPermissionsTransformation from './accessor-permissions.transformation';
|
|
3
|
+
export interface AsJson {
|
|
4
|
+
accessors?: _AccessorPermissionsTransformation.AsJson[];
|
|
5
|
+
}
|
|
6
|
+
export declare function fromJson($model: AsJson): AccessorPermissionsList;
|
|
7
|
+
export declare function toJson($model: AccessorPermissionsList): AsJson;
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { Identity } from './identity';
|
|
2
|
+
/**
|
|
3
|
+
* An accessor identity and it's associated permissions.
|
|
4
|
+
*/
|
|
5
|
+
export interface AccessorPermissions {
|
|
6
|
+
/**
|
|
7
|
+
* An Identity describing either a user, a group, or the all-users group (applying to all users).
|
|
8
|
+
*/
|
|
9
|
+
accessor?: Identity;
|
|
10
|
+
/**
|
|
11
|
+
* The permissions associated with the accessor.
|
|
12
|
+
*/
|
|
13
|
+
permissions?: Array<'r' | 'w'>;
|
|
14
|
+
}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { AccessorPermissions } from './accessor-permissions';
|
|
2
|
+
import * as _AccessorPermissionsPermissionsItemTransformation from './accessor-permissions-permissions-item.transformation';
|
|
3
|
+
import * as _IdentityTransformation from './identity.transformation';
|
|
4
|
+
export interface AsJson {
|
|
5
|
+
accessor?: _IdentityTransformation.AsJson;
|
|
6
|
+
permissions?: _AccessorPermissionsPermissionsItemTransformation.AsJson[];
|
|
7
|
+
}
|
|
8
|
+
export declare function fromJson($model: AsJson): AccessorPermissions;
|
|
9
|
+
export declare function toJson($model: AccessorPermissions): AsJson;
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export type AsJson = string;
|
|
2
|
-
export declare function fromJson($model: AsJson): 'ACTIVEGATE_TOKEN' | 'CONFIG' | 'MANUAL_TAGGING_SERVICE' | 'TOKEN' | 'WEB_UI';
|
|
3
|
-
export declare function toJson($model: 'ACTIVEGATE_TOKEN' | 'CONFIG' | 'MANUAL_TAGGING_SERVICE' | 'TOKEN' | 'WEB_UI'): AsJson;
|
|
2
|
+
export declare function fromJson($model: AsJson): 'ACTIVEGATE_TOKEN' | 'CONFIG' | 'MANUAL_TAGGING_SERVICE' | 'TENANT_LIFECYCLE' | 'TOKEN' | 'WEB_UI';
|
|
3
|
+
export declare function toJson($model: 'ACTIVEGATE_TOKEN' | 'CONFIG' | 'MANUAL_TAGGING_SERVICE' | 'TENANT_LIFECYCLE' | 'TOKEN' | 'WEB_UI'): AsJson;
|
|
@@ -6,7 +6,7 @@ export interface AuditLogEntry {
|
|
|
6
6
|
/**
|
|
7
7
|
* The category of the recorded operation.
|
|
8
8
|
*/
|
|
9
|
-
category: 'ACTIVEGATE_TOKEN' | 'CONFIG' | 'MANUAL_TAGGING_SERVICE' | 'TOKEN' | 'WEB_UI';
|
|
9
|
+
category: 'ACTIVEGATE_TOKEN' | 'CONFIG' | 'MANUAL_TAGGING_SERVICE' | 'TENANT_LIFECYCLE' | 'TOKEN' | 'WEB_UI';
|
|
10
10
|
/**
|
|
11
11
|
* The key of the affected object of a setting for entries of category `CONFIG`.
|
|
12
12
|
*/
|
|
@@ -3,8 +3,8 @@ import * as _EffectivePermissionGrantedTransformation from './effective-permissi
|
|
|
3
3
|
import * as _PermissionContextTransformation from './permission-context.transformation';
|
|
4
4
|
export interface AsJson {
|
|
5
5
|
context?: _PermissionContextTransformation.AsJson;
|
|
6
|
-
granted
|
|
7
|
-
permission
|
|
6
|
+
granted: _EffectivePermissionGrantedTransformation.AsJson;
|
|
7
|
+
permission: string;
|
|
8
8
|
}
|
|
9
9
|
export declare function fromJson($model: AsJson): EffectivePermission;
|
|
10
10
|
export declare function toJson($model: EffectivePermission): AsJson;
|