@dynatrace-sdk/client-platform-management-service

@dynatrace-sdk/client-platform-management-service

Overview

Basic read-only information (e.g. basic license settings) about the currently logged-in environment

Installation

npm install @dynatrace-sdk/client-platform-management-service

Getting help

• Visit SDK for Typescript guide in the Dynatrace Developer
• Ask a question in the Dynatrace Community

License

This SDK is distributed under the Apache License, Version 2.0, see LICENSE for more information.

API reference

Full API reference for the latest version of the SDK is also available at the Dynatrace Developer.

effectivePermissionsClient

import { effectivePermissionsClient } from '@dynatrace-sdk/client-platform-management-service';

resolveEffectivePermissions

effectivePermissionsClient.resolveEffectivePermissions(config): Promise<EffectivePermissions>

Get the effective permissions of the calling user in the environment

One of the following scopes is required:

• app-engine:apps:run
• app-engine:functions:run

This endpoint resolves the requested permissions based on the auth token used to call this endpoint. It resolves the permission via IAM and uses the provided context to evaluate conditional results. For 2nd gen environment API v2 scopes (i.e. scopes starting with environment-api:) 2nd gen roles on the environment and management zone level will also be considered.

Parameters

Name	Type
config.body*required	ResolutionRequest

Returns

Success

Code example

import { effectivePermissionsClient } from "@dynatrace-sdk/client-platform-management-service";

const data =
  await effectivePermissionsClient.resolveEffectivePermissions(
    { body: { permissions: [{ permission: "..." }] } },
  );

environmentInformationClient

import { environmentInformationClient } from '@dynatrace-sdk/client-platform-management-service';

getEnvironmentInformation

environmentInformationClient.getEnvironmentInformation(abortSignal?): Promise<EnvironmentInfo>

Get basic environment information

One of the following scopes is required:

• app-engine:apps:run
• app-engine:functions:run

Get basic information about the current environment.

Returns

Info about the requested environment.

Code example

import { environmentInformationClient } from "@dynatrace-sdk/client-platform-management-service";

const data =
  await environmentInformationClient.getEnvironmentInformation();

environmentSettingsClient

import { environmentSettingsClient } from '@dynatrace-sdk/client-platform-management-service';

getEnvironmentSettings

environmentSettingsClient.getEnvironmentSettings(abortSignal?): Promise<SettingsResponse>

Get settings for the environment

One of the following scopes is required:

• app-engine:apps:run
• app-engine:functions:run

Gets settings for environment.

Returns

The settings for the requested environment

Code example

import { environmentSettingsClient } from "@dynatrace-sdk/client-platform-management-service";

const data =
  await environmentSettingsClient.getEnvironmentSettings();

licenseInformationClient

import { licenseInformationClient } from '@dynatrace-sdk/client-platform-management-service';

getLicense

licenseInformationClient.getLicense(abortSignal?): Promise<License>

Get basic license information

One of the following scopes is required:

• app-engine:apps:run
• app-engine:functions:run

Get basic license information about the current environment.

Returns

The license info of the requested environment.

Code example

import { licenseInformationClient } from "@dynatrace-sdk/client-platform-management-service";

const data = await licenseInformationClient.getLicense();

getLicenseSettings

licenseInformationClient.getLicenseSettings(config): Promise<LicenseSettingsResponse>

Get basic license settings information

One of the following scopes is required:

• app-engine:apps:run
• app-engine:functions:run

Get basic license settings information about the current environment

Parameters

Name	Type
config.keys	Array<string>

Returns

The license settings info of the requested environment.

Code example

import { licenseInformationClient } from "@dynatrace-sdk/client-platform-management-service";

const data =
  await licenseInformationClient.getLicenseSettings();

Types

EffectivePermission

Name	Type
granted*required	EffectivePermissionGranted
permission*required	string

EffectivePermissions

extends Array<EffectivePermission>

Name	Type	Description
[unscopables]*required	Object	Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.
length*required	number	Gets or sets the length of the array. This is a number one higher than the highest index in the array.

EnvironmentInfo

Name	Type
blockTime	Date
createTime*required	Date
environmentId*required	string
state*required	EnvironmentState
type*required	EnvironmentInfoType

Error

Standard error response

Name	Type
code*required	number
message*required	string

License

Name	Type
platformSubscription*required	boolean
trial*required	boolean

LicenseSetting

Name	Type
key*required	string
value*required	string

LicenseSettingsResponse

Name	Type
settings*required	Array<LicenseSetting>

PermissionContext

Name	Type
key*required	string
value*required	string

ResolutionRequest

Name	Type
permissions*required	Array<SinglePermissionRequest>

SettingsResponse

Name	Type	Description
chatEnabled*required	boolean
countryCode	string	ISO3166-1 alpha-2 two letter country code. See: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2

SinglePermissionRequest

Optional generic set of context data

Name	Type
context	Array<PermissionContext>
permission*required	string

Enums

EffectivePermissionGranted

true: The caller has the permission false: The caller does not have the permission condition: The caller conditionally has the permission or in case of scopes starting with 'environment-api:' the caller only has the permission for specific management zones.

Enum keys

Condition | False | True

EnvironmentInfoType

Enum keys

Customer | Internal | SelfMonitoring

EnvironmentState

Enum keys

Active | BeingCreated | BeingDeleted | Blocked | Deactivated | DeletionFailed | PreAllocated