CIA Compliance Manager API Documentation - v0.8.22

    Class ComplianceServiceAdapter

    Adapter for compliance service functionality

    Hierarchy (View Summary, Expand)

    Index

    Constructors

    Properties

    frameworkRequirements: Record<
        string,
        {
            availability: SecurityLevel;
            confidentiality: SecurityLevel;
            integrity: SecurityLevel;
        },
    > = ...

    Methods

    • Get compliance status text based on security levels

      Parameters

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel = availabilityLevel

        Integrity security level (optional, defaults to availabilityLevel)

      • confidentialityLevel: SecurityLevel = availabilityLevel

        Confidentiality security level (optional, defaults to availabilityLevel)

      Returns string

      Compliance status text

    • Get compliant frameworks

      Parameters

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel = availabilityLevel

        Integrity security level (optional, defaults to availabilityLevel)

      • confidentialityLevel: SecurityLevel = availabilityLevel

        Confidentiality security level (optional, defaults to availabilityLevel)

      Returns string[]

      Array of compliant framework names

    • Get description of a compliance framework

      Parameters

      • framework: string

        Framework name

      Returns string

      Framework description

    • Get framework status (compliant, partially-compliant, non-compliant)

      Parameters

      • framework: string

        Framework name

      • availabilityLevel: SecurityLevel

        Availability security level

      • integrityLevel: SecurityLevel

        Integrity security level

      • confidentialityLevel: SecurityLevel

        Confidentiality security level

      Returns { status: string }

      Compliance status for the framework

    • Check if a framework is applicable to an industry/region

      Parameters

      • framework: string

        Framework name

      • Optionalindustry: string

        Industry (optional)

      • Optionalregion: string

        Region (optional)

      Returns boolean

      True if the framework is applicable

    MMNEPVFCICPMFPCPTTAAATR