kibana/api_docs/kbn_security_solution_features.devdocs.json

{
  "id": "@kbn/security-solution-features",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppFeatureParams",
        "type": "Interface",
        "tags": [],
        "label": "AppFeatureParams",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/security-solution-features",
            "scope": "common",
            "docId": "kibKbnSecuritySolutionFeaturesPluginApi",
            "section": "def-common.AppFeatureParams",
            "text": "AppFeatureParams"
          },
          "<T>"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "children": [
          {
            "parentPluginId": "@kbn/security-solution-features",
            "id": "def-common.AppFeatureParams.baseKibanaFeature",
            "type": "Object",
            "tags": [],
            "label": "baseKibanaFeature",
            "description": [],
            "signature": [
              "{ id: string; order?: number | undefined; name: string; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; description?: string | undefined; category: ",
              {
                "pluginId": "@kbn/core-application-common",
                "scope": "common",
                "docId": "kibKbnCoreApplicationCommonPluginApi",
                "section": "def-common.AppCategory",
                "text": "AppCategory"
              },
              "; management?: { [sectionId: string]: readonly string[]; } | undefined; privileges: { all: ",
              {
                "pluginId": "features",
                "scope": "common",
                "docId": "kibFeaturesPluginApi",
                "section": "def-common.FeatureKibanaPrivileges",
                "text": "FeatureKibanaPrivileges"
              },
              "; read: ",
              {
                "pluginId": "features",
                "scope": "common",
                "docId": "kibFeaturesPluginApi",
                "section": "def-common.FeatureKibanaPrivileges",
                "text": "FeatureKibanaPrivileges"
              },
              "; } | null; catalogue?: readonly string[] | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; privilegesTooltip?: string | undefined; reserved?: { description: string; privileges: readonly ",
              "ReservedKibanaPrivilege",
              "[]; } | undefined; }"
            ],
            "path": "x-pack/packages/security-solution/features/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/security-solution-features",
            "id": "def-common.AppFeatureParams.baseKibanaSubFeatureIds",
            "type": "Array",
            "tags": [],
            "label": "baseKibanaSubFeatureIds",
            "description": [],
            "signature": [
              "T[]"
            ],
            "path": "x-pack/packages/security-solution/features/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          },
          {
            "parentPluginId": "@kbn/security-solution-features",
            "id": "def-common.AppFeatureParams.subFeaturesMap",
            "type": "Object",
            "tags": [],
            "label": "subFeaturesMap",
            "description": [],
            "signature": [
              "Map<T, ",
              {
                "pluginId": "features",
                "scope": "common",
                "docId": "kibFeaturesPluginApi",
                "section": "def-common.SubFeatureConfig",
                "text": "SubFeatureConfig"
              },
              ">"
            ],
            "path": "x-pack/packages/security-solution/features/src/types.ts",
            "deprecated": false,
            "trackAdoption": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppFeatureKeys",
        "type": "Type",
        "tags": [],
        "label": "AppFeatureKeys",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/security-solution-features",
            "scope": "common",
            "docId": "kibKbnSecuritySolutionFeaturesPluginApi",
            "section": "def-common.AppFeatureKeyType",
            "text": "AppFeatureKeyType"
          },
          "[]"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppFeatureKeyType",
        "type": "Type",
        "tags": [],
        "label": "AppFeatureKeyType",
        "description": [],
        "signature": [
          "AppFeatureSecurityKey",
          " | ",
          "AppFeatureCasesKey",
          " | ",
          "AppFeatureAssistantKey"
        ],
        "path": "x-pack/packages/security-solution/features/src/app_features_keys.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppFeatureKibanaConfig",
        "type": "Type",
        "tags": [],
        "label": "AppFeatureKibanaConfig",
        "description": [],
        "signature": [
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<",
          {
            "pluginId": "@kbn/security-solution-features",
            "scope": "common",
            "docId": "kibKbnSecuritySolutionFeaturesPluginApi",
            "section": "def-common.BaseKibanaFeatureConfig",
            "text": "BaseKibanaFeatureConfig"
          },
          "> & { subFeatureIds?: T[] | undefined; subFeaturesPrivileges?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<",
          {
            "pluginId": "features",
            "scope": "common",
            "docId": "kibFeaturesPluginApi",
            "section": "def-common.SubFeaturePrivilegeConfig",
            "text": "SubFeaturePrivilegeConfig"
          },
          ">[] | undefined; }"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppFeaturesAssistantConfig",
        "type": "Type",
        "tags": [],
        "label": "AppFeaturesAssistantConfig",
        "description": [],
        "signature": [
          "Map<",
          "AppFeatureAssistantKey",
          ", ",
          {
            "pluginId": "@kbn/security-solution-features",
            "scope": "common",
            "docId": "kibKbnSecuritySolutionFeaturesPluginApi",
            "section": "def-common.AppFeatureKibanaConfig",
            "text": "AppFeatureKibanaConfig"
          },
          "<",
          "AssistantSubFeatureId",
          ">>"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppFeaturesCasesConfig",
        "type": "Type",
        "tags": [],
        "label": "AppFeaturesCasesConfig",
        "description": [],
        "signature": [
          "Map<",
          "AppFeatureCasesKey",
          ", ",
          {
            "pluginId": "@kbn/security-solution-features",
            "scope": "common",
            "docId": "kibKbnSecuritySolutionFeaturesPluginApi",
            "section": "def-common.AppFeatureKibanaConfig",
            "text": "AppFeatureKibanaConfig"
          },
          "<",
          "CasesSubFeatureId",
          ">>"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppFeaturesConfig",
        "type": "Type",
        "tags": [],
        "label": "AppFeaturesConfig",
        "description": [],
        "signature": [
          "Map<",
          {
            "pluginId": "@kbn/security-solution-features",
            "scope": "common",
            "docId": "kibKbnSecuritySolutionFeaturesPluginApi",
            "section": "def-common.AppFeatureKeyType",
            "text": "AppFeatureKeyType"
          },
          ", ",
          {
            "pluginId": "@kbn/security-solution-features",
            "scope": "common",
            "docId": "kibKbnSecuritySolutionFeaturesPluginApi",
            "section": "def-common.AppFeatureKibanaConfig",
            "text": "AppFeatureKibanaConfig"
          },
          "<T>>"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppFeaturesSecurityConfig",
        "type": "Type",
        "tags": [],
        "label": "AppFeaturesSecurityConfig",
        "description": [],
        "signature": [
          "Map<",
          "AppFeatureSecurityKey",
          ", ",
          {
            "pluginId": "@kbn/security-solution-features",
            "scope": "common",
            "docId": "kibKbnSecuritySolutionFeaturesPluginApi",
            "section": "def-common.AppFeatureKibanaConfig",
            "text": "AppFeatureKibanaConfig"
          },
          "<",
          "SecuritySubFeatureId",
          ">>"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.AppSubFeaturesMap",
        "type": "Type",
        "tags": [],
        "label": "AppSubFeaturesMap",
        "description": [],
        "signature": [
          "Map<T, ",
          {
            "pluginId": "features",
            "scope": "common",
            "docId": "kibFeaturesPluginApi",
            "section": "def-common.SubFeatureConfig",
            "text": "SubFeatureConfig"
          },
          ">"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.BaseKibanaFeatureConfig",
        "type": "Type",
        "tags": [],
        "label": "BaseKibanaFeatureConfig",
        "description": [],
        "signature": [
          "{ id: string; order?: number | undefined; name: string; alerting?: readonly string[] | undefined; cases?: readonly string[] | undefined; description?: string | undefined; category: ",
          {
            "pluginId": "@kbn/core-application-common",
            "scope": "common",
            "docId": "kibKbnCoreApplicationCommonPluginApi",
            "section": "def-common.AppCategory",
            "text": "AppCategory"
          },
          "; management?: { [sectionId: string]: readonly string[]; } | undefined; privileges: { all: ",
          {
            "pluginId": "features",
            "scope": "common",
            "docId": "kibFeaturesPluginApi",
            "section": "def-common.FeatureKibanaPrivileges",
            "text": "FeatureKibanaPrivileges"
          },
          "; read: ",
          {
            "pluginId": "features",
            "scope": "common",
            "docId": "kibFeaturesPluginApi",
            "section": "def-common.FeatureKibanaPrivileges",
            "text": "FeatureKibanaPrivileges"
          },
          "; } | null; catalogue?: readonly string[] | undefined; excludeFromBasePrivileges?: boolean | undefined; minimumLicense?: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; app: readonly string[]; privilegesTooltip?: string | undefined; reserved?: { description: string; privileges: readonly ",
          "ReservedKibanaPrivilege",
          "[]; } | undefined; }"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "@kbn/security-solution-features",
        "id": "def-common.SubFeaturesPrivileges",
        "type": "Type",
        "tags": [],
        "label": "SubFeaturesPrivileges",
        "description": [],
        "signature": [
          "{ id?: string | undefined; name?: string | undefined; includeIn?: \"none\" | \"read\" | \"all\" | undefined; minimumLicense?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined>; alerting?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<{ rule?: { all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined; alert?: { all?: readonly string[] | undefined; read?: readonly string[] | undefined; } | undefined; } | undefined>; cases?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<{ all?: readonly string[] | undefined; push?: readonly string[] | undefined; create?: readonly string[] | undefined; read?: readonly string[] | undefined; update?: readonly string[] | undefined; delete?: readonly string[] | undefined; } | undefined>; disabled?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<boolean | undefined>; management?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<{ [sectionId: string]: readonly string[]; } | undefined>; ui?: readonly string[] | undefined; catalogue?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<readonly string[] | undefined>; app?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<readonly string[] | undefined>; requireAllSpaces?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<boolean | undefined>; api?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<readonly string[] | undefined>; savedObject?: ",
          {
            "pluginId": "@kbn/utility-types",
            "scope": "common",
            "docId": "kibKbnUtilityTypesPluginApi",
            "section": "def-common.RecursivePartial",
            "text": "RecursivePartial"
          },
          "<{ all: readonly string[]; read: readonly string[]; }> | undefined; }"
        ],
        "path": "x-pack/packages/security-solution/features/src/types.ts",
        "deprecated": false,
        "trackAdoption": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}