@datadog/datadog-api-client 1.56.0 → 1.58.0

package/dist/packages/datadog-api-client-v2/apis/ComplianceApi.d.ts

@@ -0,0 +1,66 @@
+import { BaseAPIRequestFactory } from "../../datadog-api-client-common/baseapi";
+import { Configuration } from "../../datadog-api-client-common/configuration";
+import { RequestContext, ResponseContext } from "../../datadog-api-client-common/http/http";
+import { RuleBasedViewResponse } from "../models/RuleBasedViewResponse";
+export declare class ComplianceApiRequestFactory extends BaseAPIRequestFactory {
+    getRuleBasedView(to: number, framework?: string, version?: string, queryFindingsWithoutFrameworkVersion?: boolean, includeRulesWithoutFindings?: boolean, isCustom?: boolean, query?: string, _options?: Configuration): Promise<RequestContext>;
+}
+export declare class ComplianceApiResponseProcessor {
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getRuleBasedView
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getRuleBasedView(response: ResponseContext): Promise<RuleBasedViewResponse>;
+}
+export interface ComplianceApiGetRuleBasedViewRequest {
+    /**
+     * Timestamp of the query end, in milliseconds since the Unix epoch.
+     * @type number
+     */
+    to: number;
+    /**
+     * Compliance framework handle to filter rules and findings by.
+     * @type string
+     */
+    framework?: string;
+    /**
+     * Version of the compliance framework to filter rules and findings by.
+     * @type string
+     */
+    version?: string;
+    /**
+     * When `true`, returns findings without a `framework_version` tag. Used for findings from custom frameworks or those created before framework versioning was introduced.
+     * @type boolean
+     */
+    queryFindingsWithoutFrameworkVersion?: boolean;
+    /**
+     * When `true`, includes rules in the response that have no associated findings.
+     * @type boolean
+     */
+    includeRulesWithoutFindings?: boolean;
+    /**
+     * Set to `true` when the requested `framework` is a custom framework.
+     * @type boolean
+     */
+    isCustom?: boolean;
+    /**
+     * Additional event-platform filters applied to the underlying findings query. For example, `scored:true project_id:datadog-prod-us5`.
+     * @type string
+     */
+    query?: string;
+}
+export declare class ComplianceApi {
+    private requestFactory;
+    private responseProcessor;
+    private configuration;
+    constructor(configuration: Configuration, requestFactory?: ComplianceApiRequestFactory, responseProcessor?: ComplianceApiResponseProcessor);
+    /**
+     * Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
+     * Supports filtering by compliance framework, framework version, and additional query filters.
+     * @param param The request object
+     */
+    getRuleBasedView(param: ComplianceApiGetRuleBasedViewRequest, options?: Configuration): Promise<RuleBasedViewResponse>;
+}

package/dist/packages/datadog-api-client-v2/apis/ComplianceApi.js

@@ -0,0 +1,147 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ComplianceApi = exports.ComplianceApiResponseProcessor = exports.ComplianceApiRequestFactory = void 0;
+const baseapi_1 = require("../../datadog-api-client-common/baseapi");
+const configuration_1 = require("../../datadog-api-client-common/configuration");
+const http_1 = require("../../datadog-api-client-common/http/http");
+const logger_1 = require("../../../logger");
+const ObjectSerializer_1 = require("../models/ObjectSerializer");
+const exception_1 = require("../../datadog-api-client-common/exception");
+class ComplianceApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
+    getRuleBasedView(to, framework, version, queryFindingsWithoutFrameworkVersion, includeRulesWithoutFindings, isCustom, query, _options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            logger_1.logger.warn("Using unstable operation 'getRuleBasedView'");
+            if (!_config.unstableOperations["v2.getRuleBasedView"]) {
+                throw new Error("Unstable operation 'getRuleBasedView' is disabled");
+            }
+            // verify required parameter 'to' is not null or undefined
+            if (to === null || to === undefined) {
+                throw new baseapi_1.RequiredError("to", "getRuleBasedView");
+            }
+            // Path Params
+            const localVarPath = "/api/v2/compliance_findings/rule_based_view";
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.ComplianceApi.getRuleBasedView")
+                .makeRequestContext(localVarPath, http_1.HttpMethod.GET);
+            requestContext.setHeaderParam("Accept", "application/json");
+            requestContext.setHttpConfig(_config.httpConfig);
+            // Query Params
+            if (to !== undefined) {
+                requestContext.setQueryParam("to", ObjectSerializer_1.ObjectSerializer.serialize(to, "number", "int64"), "");
+            }
+            if (framework !== undefined) {
+                requestContext.setQueryParam("framework", ObjectSerializer_1.ObjectSerializer.serialize(framework, "string", ""), "");
+            }
+            if (version !== undefined) {
+                requestContext.setQueryParam("version", ObjectSerializer_1.ObjectSerializer.serialize(version, "string", ""), "");
+            }
+            if (queryFindingsWithoutFrameworkVersion !== undefined) {
+                requestContext.setQueryParam("query_findings_without_framework_version", ObjectSerializer_1.ObjectSerializer.serialize(queryFindingsWithoutFrameworkVersion, "boolean", ""), "");
+            }
+            if (includeRulesWithoutFindings !== undefined) {
+                requestContext.setQueryParam("include_rules_without_findings", ObjectSerializer_1.ObjectSerializer.serialize(includeRulesWithoutFindings, "boolean", ""), "");
+            }
+            if (isCustom !== undefined) {
+                requestContext.setQueryParam("is_custom", ObjectSerializer_1.ObjectSerializer.serialize(isCustom, "boolean", ""), "");
+            }
+            if (query !== undefined) {
+                requestContext.setQueryParam("query", ObjectSerializer_1.ObjectSerializer.serialize(query, "string", ""), "");
+            }
+            // Apply auth methods
+            (0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
+                "apiKeyAuth",
+                "appKeyAuth",
+                "AuthZ",
+            ]);
+            return requestContext;
+        });
+    }
+}
+exports.ComplianceApiRequestFactory = ComplianceApiRequestFactory;
+class ComplianceApiResponseProcessor {
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getRuleBasedView
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getRuleBasedView(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contentType = ObjectSerializer_1.ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+            if (response.httpStatusCode === 200) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "RuleBasedViewResponse");
+                return body;
+            }
+            if (response.httpStatusCode === 400 || response.httpStatusCode === 503) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "JSONAPIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            if (response.httpStatusCode === 403 || response.httpStatusCode === 429) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "APIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            // Work around for missing responses in specification, e.g. for petstore.yaml
+            if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "RuleBasedViewResponse", "");
+                return body;
+            }
+            const body = (yield response.body.text()) || "";
+            throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
+        });
+    }
+}
+exports.ComplianceApiResponseProcessor = ComplianceApiResponseProcessor;
+class ComplianceApi {
+    constructor(configuration, requestFactory, responseProcessor) {
+        this.configuration = configuration;
+        this.requestFactory =
+            requestFactory || new ComplianceApiRequestFactory(configuration);
+        this.responseProcessor =
+            responseProcessor || new ComplianceApiResponseProcessor();
+    }
+    /**
+     * Get an aggregated view of compliance rules with their pass, fail, and muted finding counts.
+     * Supports filtering by compliance framework, framework version, and additional query filters.
+     * @param param The request object
+     */
+    getRuleBasedView(param, options) {
+        const requestContextPromise = this.requestFactory.getRuleBasedView(param.to, param.framework, param.version, param.queryFindingsWithoutFrameworkVersion, param.includeRulesWithoutFindings, param.isCustom, param.query, options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.getRuleBasedView(responseContext);
+            });
+        });
+    }
+}
+exports.ComplianceApi = ComplianceApi;
+//# sourceMappingURL=ComplianceApi.js.map

package/dist/packages/datadog-api-client-v2/apis/ComplianceApi.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ComplianceApi.js","sourceRoot":"","sources":["../../../../packages/datadog-api-client-v2/apis/ComplianceApi.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,qEAGiD;AACjD,iFAGuD;AACvD,oEAImD;AAEnD,4CAAyC;AACzC,iEAA8D;AAC9D,yEAAyE;AAMzE,MAAa,2BAA4B,SAAQ,+BAAqB;IACvD,gBAAgB,CAC3B,EAAU,EACV,SAAkB,EAClB,OAAgB,EAChB,oCAA8C,EAC9C,2BAAqC,EACrC,QAAkB,EAClB,KAAc,EACd,QAAwB;;YAExB,MAAM,OAAO,GAAG,QAAQ,IAAI,IAAI,CAAC,aAAa,CAAC;YAE/C,eAAM,CAAC,IAAI,CAAC,6CAA6C,CAAC,CAAC;YAC3D,IAAI,CAAC,OAAO,CAAC,kBAAkB,CAAC,qBAAqB,CAAC,EAAE;gBACtD,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;aACtE;YAED,0DAA0D;YAC1D,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,SAAS,EAAE;gBACnC,MAAM,IAAI,uBAAa,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;aACnD;YAED,cAAc;YACd,MAAM,YAAY,GAAG,6CAA6C,CAAC;YAEnE,uBAAuB;YACvB,MAAM,cAAc,GAAG,OAAO;iBAC3B,SAAS,CAAC,mCAAmC,CAAC;iBAC9C,kBAAkB,CAAC,YAAY,EAAE,iBAAU,CAAC,GAAG,CAAC,CAAC;YACpD,cAAc,CAAC,cAAc,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC;YAC5D,cAAc,CAAC,aAAa,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;YAEjD,eAAe;YACf,IAAI,EAAE,KAAK,SAAS,EAAE;gBACpB,cAAc,CAAC,aAAa,CAC1B,IAAI,EACJ,mCAAgB,CAAC,SAAS,CAAC,EAAE,EAAE,QAAQ,EAAE,OAAO,CAAC,EACjD,EAAE,CACH,CAAC;aACH;YACD,IAAI,SAAS,KAAK,SAAS,EAAE;gBAC3B,cAAc,CAAC,aAAa,CAC1B,WAAW,EACX,mCAAgB,CAAC,SAAS,CAAC,SAAS,EAAE,QAAQ,EAAE,EAAE,CAAC,EACnD,EAAE,CACH,CAAC;aACH;YACD,IAAI,OAAO,KAAK,SAAS,EAAE;gBACzB,cAAc,CAAC,aAAa,CAC1B,SAAS,EACT,mCAAgB,CAAC,SAAS,CAAC,OAAO,EAAE,QAAQ,EAAE,EAAE,CAAC,EACjD,EAAE,CACH,CAAC;aACH;YACD,IAAI,oCAAoC,KAAK,SAAS,EAAE;gBACtD,cAAc,CAAC,aAAa,CAC1B,0CAA0C,EAC1C,mCAAgB,CAAC,SAAS,CACxB,oCAAoC,EACpC,SAAS,EACT,EAAE,CACH,EACD,EAAE,CACH,CAAC;aACH;YACD,IAAI,2BAA2B,KAAK,SAAS,EAAE;gBAC7C,cAAc,CAAC,aAAa,CAC1B,gCAAgC,EAChC,mCAAgB,CAAC,SAAS,CAAC,2BAA2B,EAAE,SAAS,EAAE,EAAE,CAAC,EACtE,EAAE,CACH,CAAC;aACH;YACD,IAAI,QAAQ,KAAK,SAAS,EAAE;gBAC1B,cAAc,CAAC,aAAa,CAC1B,WAAW,EACX,mCAAgB,CAAC,SAAS,CAAC,QAAQ,EAAE,SAAS,EAAE,EAAE,CAAC,EACnD,EAAE,CACH,CAAC;aACH;YACD,IAAI,KAAK,KAAK,SAAS,EAAE;gBACvB,cAAc,CAAC,aAAa,CAC1B,OAAO,EACP,mCAAgB,CAAC,SAAS,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,CAAC,EAC/C,EAAE,CACH,CAAC;aACH;YAED,qBAAqB;YACrB,IAAA,2CAA2B,EAAC,OAAO,EAAE,cAAc,EAAE;gBACnD,YAAY;gBACZ,YAAY;gBACZ,OAAO;aACR,CAAC,CAAC;YAEH,OAAO,cAAc,CAAC;QACxB,CAAC;KAAA;CACF;AAjGD,kEAiGC;AAED,MAAa,8BAA8B;IACzC;;;;;;OAMG;IACU,gBAAgB,CAC3B,QAAyB;;YAEzB,MAAM,WAAW,GAAG,mCAAgB,CAAC,kBAAkB,CACrD,QAAQ,CAAC,OAAO,CAAC,cAAc,CAAC,CACjC,CAAC;YACF,IAAI,QAAQ,CAAC,cAAc,KAAK,GAAG,EAAE;gBACnC,MAAM,IAAI,GAA0B,mCAAgB,CAAC,WAAW,CAC9D,mCAAgB,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,EAC/D,uBAAuB,CACC,CAAC;gBAC3B,OAAO,IAAI,CAAC;aACb;YACD,IAAI,QAAQ,CAAC,cAAc,KAAK,GAAG,IAAI,QAAQ,CAAC,cAAc,KAAK,GAAG,EAAE;gBACtE,MAAM,QAAQ,GAAG,mCAAgB,CAAC,KAAK,CACrC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAC1B,WAAW,CACZ,CAAC;gBACF,IAAI,IAA0B,CAAC;gBAC/B,IAAI;oBACF,IAAI,GAAG,mCAAgB,CAAC,WAAW,CACjC,QAAQ,EACR,sBAAsB,CACC,CAAC;iBAC3B;gBAAC,OAAO,KAAK,EAAE;oBACd,eAAM,CAAC,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;oBACxD,MAAM,IAAI,wBAAY,CACpB,QAAQ,CAAC,cAAc,EACvB,QAAQ,CACT,CAAC;iBACH;gBACD,MAAM,IAAI,wBAAY,CACpB,QAAQ,CAAC,cAAc,EACvB,IAAI,CACL,CAAC;aACH;YACD,IAAI,QAAQ,CAAC,cAAc,KAAK,GAAG,IAAI,QAAQ,CAAC,cAAc,KAAK,GAAG,EAAE;gBACtE,MAAM,QAAQ,GAAG,mCAAgB,CAAC,KAAK,CACrC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAC1B,WAAW,CACZ,CAAC;gBACF,IAAI,IAAsB,CAAC;gBAC3B,IAAI;oBACF,IAAI,GAAG,mCAAgB,CAAC,WAAW,CACjC,QAAQ,EACR,kBAAkB,CACC,CAAC;iBACvB;gBAAC,OAAO,KAAK,EAAE;oBACd,eAAM,CAAC,KAAK,CAAC,kCAAkC,KAAK,EAAE,CAAC,CAAC;oBACxD,MAAM,IAAI,wBAAY,CACpB,QAAQ,CAAC,cAAc,EACvB,QAAQ,CACT,CAAC;iBACH;gBACD,MAAM,IAAI,wBAAY,CAAmB,QAAQ,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC;aACzE;YAED,6EAA6E;YAC7E,IAAI,QAAQ,CAAC,cAAc,IAAI,GAAG,IAAI,QAAQ,CAAC,cAAc,IAAI,GAAG,EAAE;gBACpE,MAAM,IAAI,GAA0B,mCAAgB,CAAC,WAAW,CAC9D,mCAAgB,CAAC,KAAK,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,WAAW,CAAC,EAC/D,uBAAuB,EACvB,EAAE,CACsB,CAAC;gBAC3B,OAAO,IAAI,CAAC;aACb;YAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC;YAChD,MAAM,IAAI,wBAAY,CACpB,QAAQ,CAAC,cAAc,EACvB,mCAAmC,GAAG,IAAI,GAAG,GAAG,CACjD,CAAC;QACJ,CAAC;KAAA;CACF;AAjFD,wEAiFC;AAwCD,MAAa,aAAa;IAKxB,YACE,aAA4B,EAC5B,cAA4C,EAC5C,iBAAkD;QAElD,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,cAAc;YACjB,cAAc,IAAI,IAAI,2BAA2B,CAAC,aAAa,CAAC,CAAC;QACnE,IAAI,CAAC,iBAAiB;YACpB,iBAAiB,IAAI,IAAI,8BAA8B,EAAE,CAAC;IAC9D,CAAC;IAED;;;;OAIG;IACI,gBAAgB,CACrB,KAA2C,EAC3C,OAAuB;QAEvB,MAAM,qBAAqB,GAAG,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAChE,KAAK,CAAC,EAAE,EACR,KAAK,CAAC,SAAS,EACf,KAAK,CAAC,OAAO,EACb,KAAK,CAAC,oCAAoC,EAC1C,KAAK,CAAC,2BAA2B,EACjC,KAAK,CAAC,QAAQ,EACd,KAAK,CAAC,KAAK,EACX,OAAO,CACR,CAAC;QACF,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,EAAE;YACnD,OAAO,IAAI,CAAC,aAAa,CAAC,OAAO;iBAC9B,IAAI,CAAC,cAAc,CAAC;iBACpB,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;gBACxB,OAAO,IAAI,CAAC,iBAAiB,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC;YAClE,CAAC,CAAC,CAAC;QACP,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA5CD,sCA4CC"}

package/dist/packages/datadog-api-client-v2/apis/KeyManagementApi.d.ts

@@ -17,6 +17,8 @@ import { PersonalAccessTokenCreateResponse } from "../models/PersonalAccessToken
 import { PersonalAccessTokenResponse } from "../models/PersonalAccessTokenResponse";
 import { PersonalAccessTokensSort } from "../models/PersonalAccessTokensSort";
 import { PersonalAccessTokenUpdateRequest } from "../models/PersonalAccessTokenUpdateRequest";
+import { ValidateAPIKeyResponse } from "../models/ValidateAPIKeyResponse";
+import { ValidateV2Response } from "../models/ValidateV2Response";
 export declare class KeyManagementApiRequestFactory extends BaseAPIRequestFactory {
     createAPIKey(body: APIKeyCreateRequest, _options?: Configuration): Promise<RequestContext>;
     createCurrentUserApplicationKey(body: ApplicationKeyCreateRequest, _options?: Configuration): Promise<RequestContext>;
@@ -27,16 +29,18 @@ export declare class KeyManagementApiRequestFactory extends BaseAPIRequestFactor
     getAPIKey(apiKeyId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     getApplicationKey(appKeyId: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     getCurrentUserApplicationKey(appKeyId: string, _options?: Configuration): Promise<RequestContext>;
-    getPersonalAccessToken(patUuid: string, _options?: Configuration): Promise<RequestContext>;
+    getPersonalAccessToken(patId: string, _options?: Configuration): Promise<RequestContext>;
     listAPIKeys(pageSize?: number, pageNumber?: number, sort?: APIKeysSort, filter?: string, filterCreatedAtStart?: string, filterCreatedAtEnd?: string, filterModifiedAtStart?: string, filterModifiedAtEnd?: string, include?: string, filterRemoteConfigReadEnabled?: boolean, filterCategory?: string, _options?: Configuration): Promise<RequestContext>;
     listApplicationKeys(pageSize?: number, pageNumber?: number, sort?: ApplicationKeysSort, filter?: string, filterCreatedAtStart?: string, filterCreatedAtEnd?: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     listCurrentUserApplicationKeys(pageSize?: number, pageNumber?: number, sort?: ApplicationKeysSort, filter?: string, filterCreatedAtStart?: string, filterCreatedAtEnd?: string, include?: string, _options?: Configuration): Promise<RequestContext>;
     listPersonalAccessTokens(pageSize?: number, pageNumber?: number, sort?: PersonalAccessTokensSort, filter?: string, filterOwnerUuid?: Array<string>, _options?: Configuration): Promise<RequestContext>;
-    revokePersonalAccessToken(patUuid: string, _options?: Configuration): Promise<RequestContext>;
+    revokePersonalAccessToken(patId: string, _options?: Configuration): Promise<RequestContext>;
     updateAPIKey(apiKeyId: string, body: APIKeyUpdateRequest, _options?: Configuration): Promise<RequestContext>;
     updateApplicationKey(appKeyId: string, body: ApplicationKeyUpdateRequest, _options?: Configuration): Promise<RequestContext>;
     updateCurrentUserApplicationKey(appKeyId: string, body: ApplicationKeyUpdateRequest, _options?: Configuration): Promise<RequestContext>;
-    updatePersonalAccessToken(patUuid: string, body: PersonalAccessTokenUpdateRequest, _options?: Configuration): Promise<RequestContext>;
+    updatePersonalAccessToken(patId: string, body: PersonalAccessTokenUpdateRequest, _options?: Configuration): Promise<RequestContext>;
+    validate(_options?: Configuration): Promise<RequestContext>;
+    validateAPIKey(_options?: Configuration): Promise<RequestContext>;
 }
 export declare class KeyManagementApiResponseProcessor {
     /**
@@ -191,6 +195,22 @@ export declare class KeyManagementApiResponseProcessor {
      * @throws ApiException if the response code was not in [200, 299]
      */
     updatePersonalAccessToken(response: ResponseContext): Promise<PersonalAccessTokenResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to validate
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    validate(response: ResponseContext): Promise<ValidateV2Response>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to validateAPIKey
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    validateAPIKey(response: ResponseContext): Promise<ValidateAPIKeyResponse>;
 }
 export interface KeyManagementApiCreateAPIKeyRequest {
     /**
@@ -264,10 +284,10 @@ export interface KeyManagementApiGetCurrentUserApplicationKeyRequest {
 }
 export interface KeyManagementApiGetPersonalAccessTokenRequest {
     /**
-     * The UUID of the personal access token.
+     * The ID of the personal access token.
      * @type string
      */
-    patUuid: string;
+    patId: string;
 }
 export interface KeyManagementApiListAPIKeysRequest {
     /**
@@ -437,10 +457,10 @@ export interface KeyManagementApiListPersonalAccessTokensRequest {
 }
 export interface KeyManagementApiRevokePersonalAccessTokenRequest {
     /**
-     * The UUID of the personal access token.
+     * The ID of the personal access token.
      * @type string
      */
-    patUuid: string;
+    patId: string;
 }
 export interface KeyManagementApiUpdateAPIKeyRequest {
     /**
@@ -477,10 +497,10 @@ export interface KeyManagementApiUpdateCurrentUserApplicationKeyRequest {
 }
 export interface KeyManagementApiUpdatePersonalAccessTokenRequest {
     /**
-     * The UUID of the personal access token.
+     * The ID of the personal access token.
      * @type string
      */
-    patUuid: string;
+    patId: string;
     /**
      * @type PersonalAccessTokenUpdateRequest
      */
@@ -588,4 +608,17 @@ export declare class KeyManagementApi {
      * @param param The request object
      */
     updatePersonalAccessToken(param: KeyManagementApiUpdatePersonalAccessTokenRequest, options?: Configuration): Promise<PersonalAccessTokenResponse>;
+    /**
+     * Check if the API key is valid. Returns the organization UUID, API key ID, and associated scopes.
+     * @param param The request object
+     */
+    validate(options?: Configuration): Promise<ValidateV2Response>;
+    /**
+     * Check that the API key and application key used for the request are both valid.
+     * Returns `{"status": "ok"}` on success, `401` or `403` otherwise. Useful as a
+     * lightweight authentication probe before issuing other API calls that require
+     * full credentials.
+     * @param param The request object
+     */
+    validateAPIKey(options?: Configuration): Promise<ValidateAPIKeyResponse>;
 }

package/dist/packages/datadog-api-client-v2/apis/KeyManagementApi.js

@@ -253,15 +253,15 @@ class KeyManagementApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
             return requestContext;
         });
     }
-    getPersonalAccessToken(patUuid, _options) {
+    getPersonalAccessToken(patId, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
-            // verify required parameter 'patUuid' is not null or undefined
-            if (patUuid === null || patUuid === undefined) {
-                throw new baseapi_1.RequiredError("patUuid", "getPersonalAccessToken");
+            // verify required parameter 'patId' is not null or undefined
+            if (patId === null || patId === undefined) {
+                throw new baseapi_1.RequiredError("patId", "getPersonalAccessToken");
             }
             // Path Params
-            const localVarPath = "/api/v2/personal_access_tokens/{pat_uuid}".replace("{pat_uuid}", encodeURIComponent(String(patUuid)));
+            const localVarPath = "/api/v2/personal_access_tokens/{pat_id}".replace("{pat_id}", encodeURIComponent(String(patId)));
             // Make Request Context
             const requestContext = _config
                 .getServer("v2.KeyManagementApi.getPersonalAccessToken")
@@ -446,15 +446,15 @@ class KeyManagementApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
             return requestContext;
         });
     }
-    revokePersonalAccessToken(patUuid, _options) {
+    revokePersonalAccessToken(patId, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
-            // verify required parameter 'patUuid' is not null or undefined
-            if (patUuid === null || patUuid === undefined) {
-                throw new baseapi_1.RequiredError("patUuid", "revokePersonalAccessToken");
+            // verify required parameter 'patId' is not null or undefined
+            if (patId === null || patId === undefined) {
+                throw new baseapi_1.RequiredError("patId", "revokePersonalAccessToken");
             }
             // Path Params
-            const localVarPath = "/api/v2/personal_access_tokens/{pat_uuid}".replace("{pat_uuid}", encodeURIComponent(String(patUuid)));
+            const localVarPath = "/api/v2/personal_access_tokens/{pat_id}".replace("{pat_id}", encodeURIComponent(String(patId)));
             // Make Request Context
             const requestContext = _config
                 .getServer("v2.KeyManagementApi.revokePersonalAccessToken")
@@ -571,19 +571,19 @@ class KeyManagementApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
             return requestContext;
         });
     }
-    updatePersonalAccessToken(patUuid, body, _options) {
+    updatePersonalAccessToken(patId, body, _options) {
         return __awaiter(this, void 0, void 0, function* () {
             const _config = _options || this.configuration;
-            // verify required parameter 'patUuid' is not null or undefined
-            if (patUuid === null || patUuid === undefined) {
-                throw new baseapi_1.RequiredError("patUuid", "updatePersonalAccessToken");
+            // verify required parameter 'patId' is not null or undefined
+            if (patId === null || patId === undefined) {
+                throw new baseapi_1.RequiredError("patId", "updatePersonalAccessToken");
             }
             // verify required parameter 'body' is not null or undefined
             if (body === null || body === undefined) {
                 throw new baseapi_1.RequiredError("body", "updatePersonalAccessToken");
             }
             // Path Params
-            const localVarPath = "/api/v2/personal_access_tokens/{pat_uuid}".replace("{pat_uuid}", encodeURIComponent(String(patUuid)));
+            const localVarPath = "/api/v2/personal_access_tokens/{pat_id}".replace("{pat_id}", encodeURIComponent(String(patId)));
             // Make Request Context
             const requestContext = _config
                 .getServer("v2.KeyManagementApi.updatePersonalAccessToken")
@@ -605,6 +605,45 @@ class KeyManagementApiRequestFactory extends baseapi_1.BaseAPIRequestFactory {
             return requestContext;
         });
     }
+    validate(_options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            logger_1.logger.warn("Using unstable operation 'validate'");
+            if (!_config.unstableOperations["v2.validate"]) {
+                throw new Error("Unstable operation 'validate' is disabled");
+            }
+            // Path Params
+            const localVarPath = "/api/v2/validate";
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.KeyManagementApi.validate")
+                .makeRequestContext(localVarPath, http_1.HttpMethod.GET);
+            requestContext.setHeaderParam("Accept", "application/json");
+            requestContext.setHttpConfig(_config.httpConfig);
+            // Apply auth methods
+            (0, configuration_1.applySecurityAuthentication)(_config, requestContext, ["apiKeyAuth"]);
+            return requestContext;
+        });
+    }
+    validateAPIKey(_options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const _config = _options || this.configuration;
+            // Path Params
+            const localVarPath = "/api/v2/validate_keys";
+            // Make Request Context
+            const requestContext = _config
+                .getServer("v2.KeyManagementApi.validateAPIKey")
+                .makeRequestContext(localVarPath, http_1.HttpMethod.GET);
+            requestContext.setHeaderParam("Accept", "application/json");
+            requestContext.setHttpConfig(_config.httpConfig);
+            // Apply auth methods
+            (0, configuration_1.applySecurityAuthentication)(_config, requestContext, [
+                "apiKeyAuth",
+                "appKeyAuth",
+            ]);
+            return requestContext;
+        });
+    }
 }
 exports.KeyManagementApiRequestFactory = KeyManagementApiRequestFactory;
 class KeyManagementApiResponseProcessor {
@@ -1310,6 +1349,90 @@ class KeyManagementApiResponseProcessor {
             throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
         });
     }
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to validate
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    validate(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contentType = ObjectSerializer_1.ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+            if (response.httpStatusCode === 200) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "ValidateV2Response");
+                return body;
+            }
+            if (response.httpStatusCode === 403) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "JSONAPIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            if (response.httpStatusCode === 429) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "APIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            // Work around for missing responses in specification, e.g. for petstore.yaml
+            if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "ValidateV2Response", "");
+                return body;
+            }
+            const body = (yield response.body.text()) || "";
+            throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
+        });
+    }
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to validateAPIKey
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    validateAPIKey(response) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const contentType = ObjectSerializer_1.ObjectSerializer.normalizeMediaType(response.headers["content-type"]);
+            if (response.httpStatusCode === 200) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "ValidateAPIKeyResponse");
+                return body;
+            }
+            if (response.httpStatusCode === 401 ||
+                response.httpStatusCode === 403 ||
+                response.httpStatusCode === 429) {
+                const bodyText = ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType);
+                let body;
+                try {
+                    body = ObjectSerializer_1.ObjectSerializer.deserialize(bodyText, "APIErrorResponse");
+                }
+                catch (error) {
+                    logger_1.logger.debug(`Got error deserializing error: ${error}`);
+                    throw new exception_1.ApiException(response.httpStatusCode, bodyText);
+                }
+                throw new exception_1.ApiException(response.httpStatusCode, body);
+            }
+            // Work around for missing responses in specification, e.g. for petstore.yaml
+            if (response.httpStatusCode >= 200 && response.httpStatusCode <= 299) {
+                const body = ObjectSerializer_1.ObjectSerializer.deserialize(ObjectSerializer_1.ObjectSerializer.parse(yield response.body.text(), contentType), "ValidateAPIKeyResponse", "");
+                return body;
+            }
+            const body = (yield response.body.text()) || "";
+            throw new exception_1.ApiException(response.httpStatusCode, 'Unknown API Status Code!\nBody: "' + body + '"');
+        });
+    }
 }
 exports.KeyManagementApiResponseProcessor = KeyManagementApiResponseProcessor;
 class KeyManagementApi {
@@ -1452,7 +1575,7 @@ class KeyManagementApi {
      * @param param The request object
      */
     getPersonalAccessToken(param, options) {
-        const requestContextPromise = this.requestFactory.getPersonalAccessToken(param.patUuid, options);
+        const requestContextPromise = this.requestFactory.getPersonalAccessToken(param.patId, options);
         return requestContextPromise.then((requestContext) => {
             return this.configuration.httpApi
                 .send(requestContext)
@@ -1522,7 +1645,7 @@ class KeyManagementApi {
      * @param param The request object
      */
     revokePersonalAccessToken(param, options) {
-        const requestContextPromise = this.requestFactory.revokePersonalAccessToken(param.patUuid, options);
+        const requestContextPromise = this.requestFactory.revokePersonalAccessToken(param.patId, options);
         return requestContextPromise.then((requestContext) => {
             return this.configuration.httpApi
                 .send(requestContext)
@@ -1579,7 +1702,7 @@ class KeyManagementApi {
      * @param param The request object
      */
     updatePersonalAccessToken(param, options) {
-        const requestContextPromise = this.requestFactory.updatePersonalAccessToken(param.patUuid, param.body, options);
+        const requestContextPromise = this.requestFactory.updatePersonalAccessToken(param.patId, param.body, options);
         return requestContextPromise.then((requestContext) => {
             return this.configuration.httpApi
                 .send(requestContext)
@@ -1588,6 +1711,37 @@ class KeyManagementApi {
             });
         });
     }
+    /**
+     * Check if the API key is valid. Returns the organization UUID, API key ID, and associated scopes.
+     * @param param The request object
+     */
+    validate(options) {
+        const requestContextPromise = this.requestFactory.validate(options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.validate(responseContext);
+            });
+        });
+    }
+    /**
+     * Check that the API key and application key used for the request are both valid.
+     * Returns `{"status": "ok"}` on success, `401` or `403` otherwise. Useful as a
+     * lightweight authentication probe before issuing other API calls that require
+     * full credentials.
+     * @param param The request object
+     */
+    validateAPIKey(options) {
+        const requestContextPromise = this.requestFactory.validateAPIKey(options);
+        return requestContextPromise.then((requestContext) => {
+            return this.configuration.httpApi
+                .send(requestContext)
+                .then((responseContext) => {
+                return this.responseProcessor.validateAPIKey(responseContext);
+            });
+        });
+    }
 }
 exports.KeyManagementApi = KeyManagementApi;
 //# sourceMappingURL=KeyManagementApi.js.map