Class GovernanceBestPracticeDefinition

The best practice associated with an insight. Populated with the first active best practice matched to the insight; null when no best practice is attached.

Hierarchy

  • GovernanceBestPracticeDefinition

Constructors

Properties

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
category: string

The value driver the best practice is grouped under, such as access_governance, security, compliance, or operational_hygiene.

deepLink: string

A relative link to the configuration page where the best practice can be acted upon.

description: string

The full rationale and guidance for the best practice.

detectionType?: string

An optional association to a control's detection type. null when not associated with a control.

id: string

The unique identifier of the best practice.

impact: string

The expected impact of following the best practice.

impactHint: number

A priority hint for ordering best practices by expected impact. Lower values indicate higher priority.

permissions: string[]

The permissions required for the user to act on the best practice.

status: string

Whether the best practice is currently active or deprecated.

summary: string

A one-line explanation of why this best practice matters.

title: string

A short, human-readable name for the best practice.

triggerCondition: string

The condition that surfaces the best practice. For an insight trigger, the insight slug; for a static trigger, a descriptive condition key.

triggerType: string

How the best practice is surfaced. insight ties it to an insight; static surfaces it unless its condition is met.

Generated using TypeDoc