6b8ebbfa18
* Fix links to github * Fix links to github * Update docs to latest * Sort, remove unneccessary path info, reduce tags * Go back to having DocDef create the link to avoid backport conflicts * update api docs # Conflicts: # api_docs/actions.json # api_docs/advanced_settings.json # api_docs/alerting.json # api_docs/apm.json # api_docs/apm_oss.json # api_docs/banners.json # api_docs/beats_management.json # api_docs/bfetch.json # api_docs/canvas.json # api_docs/case.json # api_docs/charts.json # api_docs/cloud.json # api_docs/console.json # api_docs/core.json # api_docs/core_application.json # api_docs/core_chrome.json # api_docs/core_http.json # api_docs/core_saved_objects.json # api_docs/dashboard.json # api_docs/dashboard_enhanced.json # api_docs/dashboard_mode.json # api_docs/data.json # api_docs/data_autocomplete.json # api_docs/data_enhanced.json # api_docs/data_field_formats.json # api_docs/data_index_patterns.json # api_docs/data_query.json # api_docs/data_search.json # api_docs/data_ui.json # api_docs/dev_tools.json # api_docs/discover.json # api_docs/discover_enhanced.json # api_docs/embeddable.json # api_docs/embeddable_enhanced.json # api_docs/encrypted_saved_objects.json # api_docs/enterprise_search.json # api_docs/es_ui_shared.json # api_docs/event_log.json # api_docs/expressions.json # api_docs/features.json # api_docs/file_upload.json # api_docs/fleet.json # api_docs/global_search.json # api_docs/home.json # api_docs/index_lifecycle_management.json # api_docs/index_management.json # api_docs/index_pattern_field_editor.json # api_docs/index_pattern_management.json # api_docs/infra.json # api_docs/ingest_pipelines.json # api_docs/inspector.json # api_docs/kibana_legacy.json # api_docs/kibana_react.json # api_docs/kibana_utils.json # api_docs/lens.json # api_docs/license_management.json # api_docs/licensing.json # api_docs/lists.json # api_docs/management.json # api_docs/maps.json # api_docs/maps_legacy.json # api_docs/ml.json # api_docs/monitoring.json # api_docs/navigation.json # api_docs/newsfeed.json # api_docs/observability.json # api_docs/osquery.json # api_docs/presentation_util.json # api_docs/remote_clusters.json # api_docs/reporting.json # api_docs/rollup.json # api_docs/runtime_fields.json # api_docs/saved_objects.json # api_docs/saved_objects_management.json # api_docs/saved_objects_tagging.json # api_docs/saved_objects_tagging_oss.json # api_docs/security.json # api_docs/security_oss.json # api_docs/security_solution.json # api_docs/share.json # api_docs/snapshot_restore.json # api_docs/spaces.json # api_docs/spaces_oss.json # api_docs/stack_alerts.json # api_docs/task_manager.json # api_docs/telemetry.json # api_docs/telemetry_collection_manager.json # api_docs/telemetry_collection_xpack.json # api_docs/telemetry_management_section.json # api_docs/triggers_actions_ui.json # api_docs/ui_actions.json # api_docs/ui_actions_enhanced.json # api_docs/uptime.json # api_docs/url_forwarding.json # api_docs/usage_collection.json # api_docs/vis_type_timeseries.json # api_docs/visualizations.json
220 lines
No EOL
6.2 KiB
JSON
220 lines
No EOL
6.2 KiB
JSON
{
|
|
"id": "securityOss",
|
|
"client": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-public.SecurityOssPluginSetup",
|
|
"type": "Interface",
|
|
"label": "SecurityOssPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SecurityOssPluginSetup.insecureCluster",
|
|
"type": "Object",
|
|
"label": "insecureCluster",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/public/plugin.ts",
|
|
"lineNumber": 26
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "securityOss",
|
|
"scope": "public",
|
|
"docId": "kibSecurityOssPluginApi",
|
|
"section": "def-public.InsecureClusterServiceSetup",
|
|
"text": "InsecureClusterServiceSetup"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/public/plugin.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
},
|
|
"start": {
|
|
"id": "def-public.SecurityOssPluginStart",
|
|
"type": "Interface",
|
|
"label": "SecurityOssPluginStart",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SecurityOssPluginStart.insecureCluster",
|
|
"type": "Object",
|
|
"label": "insecureCluster",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/public/plugin.ts",
|
|
"lineNumber": 30
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "securityOss",
|
|
"scope": "public",
|
|
"docId": "kibSecurityOssPluginApi",
|
|
"section": "def-public.InsecureClusterServiceStart",
|
|
"text": "InsecureClusterServiceStart"
|
|
}
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-public.SecurityOssPluginStart.anonymousAccess",
|
|
"type": "Object",
|
|
"label": "anonymousAccess",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/public/plugin.ts",
|
|
"lineNumber": 31
|
|
},
|
|
"signature": [
|
|
"{ getAccessURLParameters: () => Promise<Record<string, string> | null>; getCapabilities: () => Promise<",
|
|
{
|
|
"pluginId": "core",
|
|
"scope": "common",
|
|
"docId": "kibCorePluginApi",
|
|
"section": "def-common.Capabilities",
|
|
"text": "Capabilities"
|
|
},
|
|
">; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/public/plugin.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"lifecycle": "start",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"server": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": [],
|
|
"setup": {
|
|
"id": "def-server.SecurityOssPluginSetup",
|
|
"type": "Interface",
|
|
"label": "SecurityOssPluginSetup",
|
|
"description": [],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.SecurityOssPluginSetup.showInsecureClusterWarning$",
|
|
"type": "Object",
|
|
"label": "showInsecureClusterWarning$",
|
|
"description": [
|
|
"\nAllows consumers to show/hide the insecure cluster warning."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/server/plugin.ts",
|
|
"lineNumber": 29
|
|
},
|
|
"signature": [
|
|
"BehaviorSubject",
|
|
"<boolean>"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-server.SecurityOssPluginSetup.setAnonymousAccessServiceProvider",
|
|
"type": "Function",
|
|
"label": "setAnonymousAccessServiceProvider",
|
|
"description": [
|
|
"\nSet the provider function that returns a service to deal with the anonymous access."
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/server/plugin.ts",
|
|
"lineNumber": 35
|
|
},
|
|
"signature": [
|
|
"(provider: () => ",
|
|
{
|
|
"pluginId": "securityOss",
|
|
"scope": "server",
|
|
"docId": "kibSecurityOssPluginApi",
|
|
"section": "def-server.AnonymousAccessService",
|
|
"text": "AnonymousAccessService"
|
|
},
|
|
") => void"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/server/plugin.ts",
|
|
"lineNumber": 25
|
|
},
|
|
"lifecycle": "setup",
|
|
"initialIsOpen": true
|
|
}
|
|
},
|
|
"common": {
|
|
"classes": [],
|
|
"functions": [],
|
|
"interfaces": [
|
|
{
|
|
"id": "def-common.AppState",
|
|
"type": "Interface",
|
|
"label": "AppState",
|
|
"description": [
|
|
"\nDefines Security OSS application state."
|
|
],
|
|
"tags": [],
|
|
"children": [
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AppState.insecureClusterAlert",
|
|
"type": "Object",
|
|
"label": "insecureClusterAlert",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/common/app_state.ts",
|
|
"lineNumber": 13
|
|
},
|
|
"signature": [
|
|
"{ displayAlert: boolean; }"
|
|
]
|
|
},
|
|
{
|
|
"tags": [],
|
|
"id": "def-common.AppState.anonymousAccess",
|
|
"type": "Object",
|
|
"label": "anonymousAccess",
|
|
"description": [],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/common/app_state.ts",
|
|
"lineNumber": 14
|
|
},
|
|
"signature": [
|
|
"{ isEnabled: boolean; accessURLParameters: Record<string, string> | null; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/common/app_state.ts",
|
|
"lineNumber": 12
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |