87a5b22626
* update api_docs from gitignore * api doc files * Update api_welcome.mdx * Pretty print json * Add new lines and extra frontmatter to warn github viewers * update api_docs with new lines and frontmatter * Remove all apis tagged @internal and add tests * Update docs with all internal APIs removed * fix typescript error in test fixtures * Update core.json Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
231 lines
7.4 KiB
JSON
231 lines
7.4 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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/public/plugin.ts#L26"
|
|
},
|
|
"signature": [
|
|
{
|
|
"pluginId": "securityOss",
|
|
"scope": "public",
|
|
"docId": "kibSecurityOssPluginApi",
|
|
"section": "def-public.InsecureClusterServiceSetup",
|
|
"text": "InsecureClusterServiceSetup"
|
|
}
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/public/plugin.ts",
|
|
"lineNumber": 25,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/public/plugin.ts#L25"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/public/plugin.ts#L30"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/public/plugin.ts#L31"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/public/plugin.ts#L29"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/server/plugin.ts#L29"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/server/plugin.ts#L35"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/server/plugin.ts#L25"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/common/app_state.ts#L13"
|
|
},
|
|
"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,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/common/app_state.ts#L14"
|
|
},
|
|
"signature": [
|
|
"{ isEnabled: boolean; accessURLParameters: Record<string, string> | null; }"
|
|
]
|
|
}
|
|
],
|
|
"source": {
|
|
"path": "src/plugins/security_oss/common/app_state.ts",
|
|
"lineNumber": 12,
|
|
"link": "https://github.com/elastic/kibana/tree/mastersrc/plugins/security_oss/common/app_state.ts#L12"
|
|
},
|
|
"initialIsOpen": false
|
|
}
|
|
],
|
|
"enums": [],
|
|
"misc": [],
|
|
"objects": []
|
|
}
|
|
} |