kibana/api_docs/security_oss.json

{
  "id": "securityOss",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "securityOss",
      "id": "def-public.SecurityOssPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "SecurityOssPluginSetup",
      "description": [],
      "path": "src/plugins/security_oss/public/plugin.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "securityOss",
          "id": "def-public.SecurityOssPluginSetup.insecureCluster",
          "type": "Object",
          "tags": [],
          "label": "insecureCluster",
          "description": [],
          "signature": [
            "InsecureClusterServiceSetup"
          ],
          "path": "src/plugins/security_oss/public/plugin.ts",
          "deprecated": false
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "securityOss",
      "id": "def-public.SecurityOssPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "SecurityOssPluginStart",
      "description": [],
      "path": "src/plugins/security_oss/public/plugin.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "securityOss",
          "id": "def-public.SecurityOssPluginStart.insecureCluster",
          "type": "Object",
          "tags": [],
          "label": "insecureCluster",
          "description": [],
          "signature": [
            "InsecureClusterServiceStart"
          ],
          "path": "src/plugins/security_oss/public/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "securityOss",
          "id": "def-public.SecurityOssPluginStart.anonymousAccess",
          "type": "Object",
          "tags": [],
          "label": "anonymousAccess",
          "description": [],
          "signature": [
            "{ getAccessURLParameters: () => Promise<Record<string, string> | null>; getCapabilities: () => Promise<",
            "Capabilities",
            ">; }"
          ],
          "path": "src/plugins/security_oss/public/plugin.ts",
          "deprecated": false
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "parentPluginId": "securityOss",
      "id": "def-server.SecurityOssPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "SecurityOssPluginSetup",
      "description": [],
      "path": "src/plugins/security_oss/server/plugin.ts",
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "securityOss",
          "id": "def-server.SecurityOssPluginSetup.showInsecureClusterWarning$",
          "type": "Object",
          "tags": [],
          "label": "showInsecureClusterWarning$",
          "description": [
            "\nAllows consumers to show/hide the insecure cluster warning."
          ],
          "signature": [
            "BehaviorSubject",
            "<boolean>"
          ],
          "path": "src/plugins/security_oss/server/plugin.ts",
          "deprecated": false
        },
        {
          "parentPluginId": "securityOss",
          "id": "def-server.SecurityOssPluginSetup.setAnonymousAccessServiceProvider",
          "type": "Function",
          "tags": [],
          "label": "setAnonymousAccessServiceProvider",
          "description": [
            "\nSet the provider function that returns a service to deal with the anonymous access."
          ],
          "signature": [
            "(provider: () => ",
            "AnonymousAccessService",
            ") => void"
          ],
          "path": "src/plugins/security_oss/server/plugin.ts",
          "deprecated": false,
          "returnComment": [],
          "children": [
            {
              "parentPluginId": "securityOss",
              "id": "def-server.provider",
              "type": "Function",
              "tags": [],
              "label": "provider",
              "description": [],
              "signature": [
                "() => ",
                "AnonymousAccessService"
              ],
              "path": "src/plugins/security_oss/server/plugin.ts",
              "deprecated": false
            }
          ]
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "parentPluginId": "securityOss",
        "id": "def-common.AppState",
        "type": "Interface",
        "tags": [],
        "label": "AppState",
        "description": [
          "\nDefines Security OSS application state."
        ],
        "path": "src/plugins/security_oss/common/app_state.ts",
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "securityOss",
            "id": "def-common.AppState.insecureClusterAlert",
            "type": "Object",
            "tags": [],
            "label": "insecureClusterAlert",
            "description": [],
            "signature": [
              "{ displayAlert: boolean; }"
            ],
            "path": "src/plugins/security_oss/common/app_state.ts",
            "deprecated": false
          },
          {
            "parentPluginId": "securityOss",
            "id": "def-common.AppState.anonymousAccess",
            "type": "Object",
            "tags": [],
            "label": "anonymousAccess",
            "description": [],
            "signature": [
              "{ isEnabled: boolean; accessURLParameters: Record<string, string> | null; }"
            ],
            "path": "src/plugins/security_oss/common/app_state.ts",
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": []
  }
}