Class ObservabilityPipelineHttpServerSourceValidToken

An accepted token used to authenticate incoming HTTP server requests.

Hierarchy

  • ObservabilityPipelineHttpServerSourceValidToken

Constructors

constructor

Properties

additionalProperties? enabled? fieldToAdd? pathToToken? tokenKey

Constructors

constructor

Properties

Optional additionalProperties

additionalProperties?: {
    [key: string]: any;
}

A container for additional, undeclared properties. This is a holder for any undeclared properties as specified with the 'additionalProperties' keyword in the OAS document.

Type declaration

  • [key: string]: any

Optional enabled

enabled?: boolean

Indicates whether this token is currently accepted. Disabled tokens are rejected without being removed from the configuration.

Optional fieldToAdd

fieldToAdd?: ObservabilityPipelineSourceValidTokenFieldToAdd

An optional metadata field that is attached to every event authenticated by the associated token. Both key and value must match ^[A-Za-z0-9_]+$.

Optional pathToToken

pathToToken?: ObservabilityPipelineHttpServerSourceValidTokenPathToToken

Specifies where the worker extracts the token from in the incoming HTTP request. This can be either a built-in location (path or address) or an HTTP header object.

tokenKey

tokenKey: string

Name of the environment variable or secret that holds the expected token value.

Settings

Member Visibility

Theme

Generated using TypeDoc