@datadog/datadog-api-client
Version:
OpenAPI client for Datadog APIs
69 lines (68 loc) • 2.12 kB
TypeScript
/**
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
* This product includes software developed at Datadog (https://www.datadoghq.com/).
* Copyright 2020-Present Datadog, Inc.
*/
import { SyntheticsBasicAuthJWTAddClaims } from "./SyntheticsBasicAuthJWTAddClaims";
import { SyntheticsBasicAuthJWTAlgorithm } from "./SyntheticsBasicAuthJWTAlgorithm";
import { SyntheticsBasicAuthJWTType } from "./SyntheticsBasicAuthJWTType";
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
/**
* Object to handle JWT authentication when performing the test.
*/
export declare class SyntheticsBasicAuthJWT {
/**
* Standard JWT claims to automatically inject.
*/
"addClaims"?: SyntheticsBasicAuthJWTAddClaims;
/**
* Algorithm to use for the JWT authentication.
*/
"algorithm": SyntheticsBasicAuthJWTAlgorithm;
/**
* Token time-to-live in seconds.
*/
"expiresIn"?: number;
/**
* Custom JWT header as a JSON string.
*/
"header"?: string;
/**
* JWT claims as a JSON string.
*/
"payload": string;
/**
* Signing key for the JWT authentication. Use the shared secret for `HS256`
* or the private key (PEM format) for `RS256` and `ES256`.
*/
"secret": string;
/**
* Prefix added before the token in the `Authorization` header. Defaults to `Bearer`.
*/
"tokenPrefix"?: string;
/**
* The type of authentication to use when performing the test.
*/
"type": SyntheticsBasicAuthJWTType;
/**
* A container for additional, undeclared properties.
* This is a holder for any undeclared properties as specified with
* the 'additionalProperties' keyword in the OAS document.
*/
"additionalProperties"?: {
[key: string]: any;
};
/**
* @ignore
*/
"_unparsed"?: boolean;
/**
* @ignore
*/
static readonly attributeTypeMap: AttributeTypeMap;
/**
* @ignore
*/
static getAttributeTypeMap(): AttributeTypeMap;
constructor();
}