2021-08-24 19:42:23 +02:00
{
"id" : "interactiveSetup" ,
"client" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"server" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
2021-09-08 23:50:25 +02:00
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.Certificate" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "Certificate" ,
"description" : [ ] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.Certificate.issuer" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "issuer" ,
"description" : [ ] ,
"signature" : [
"{ C?: string | undefined; ST?: string | undefined; L?: string | undefined; O?: string | undefined; OU?: string | undefined; CN?: string | undefined; }"
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.Certificate.valid_from" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "valid_from" ,
"description" : [ ] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.Certificate.valid_to" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "valid_to" ,
"description" : [ ] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.Certificate.subject" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "subject" ,
"description" : [ ] ,
"signature" : [
"{ C?: string | undefined; ST?: string | undefined; L?: string | undefined; O?: string | undefined; OU?: string | undefined; CN?: string | undefined; }"
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.Certificate.fingerprint256" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "fingerprint256" ,
"description" : [ ] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.Certificate.raw" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "raw" ,
"description" : [ ] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
2021-08-24 19:42:23 +02:00
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.EnrollmentToken" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "EnrollmentToken" ,
"description" : [
"\nThe token that allows one to configure Kibana instance to communicate with an existing Elasticsearch cluster that\nhas security features enabled."
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.EnrollmentToken.ver" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "ver" ,
"description" : [
"\nThe version of the Elasticsearch node that generated this enrollment token."
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.EnrollmentToken.adr" ,
"type" : "Object" ,
"tags" : [ ] ,
"label" : "adr" ,
"description" : [
"\nAn array of addresses in the form of `<hostname>:<port>` or `<ip_address>:<port>` where the Elasticsearch node is listening for HTTP connections."
] ,
"signature" : [
"readonly string[]"
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.EnrollmentToken.fgr" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "fgr" ,
"description" : [
"\nThe SHA-256 fingerprint of the CA certificate that is used to sign the certificate that the Elasticsearch node presents for HTTP over TLS connections."
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.EnrollmentToken.key" ,
"type" : "string" ,
"tags" : [ ] ,
"label" : "key" ,
"description" : [
"\nAn Elasticsearch API key (not encoded) that can be used as credentials authorized to call the enrollment related APIs in Elasticsearch."
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.InteractiveSetupViewState" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "InteractiveSetupViewState" ,
"description" : [
"\nA set of state details that interactive setup view retrieves from the Kibana server."
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.InteractiveSetupViewState.elasticsearchConnectionStatus" ,
"type" : "Enum" ,
"tags" : [ ] ,
"label" : "elasticsearchConnectionStatus" ,
"description" : [
"\nCurrent status of the Elasticsearch connection."
] ,
"signature" : [
{
"pluginId" : "interactiveSetup" ,
"scope" : "common" ,
"docId" : "kibInteractiveSetupPluginApi" ,
"section" : "def-common.ElasticsearchConnectionStatus" ,
"text" : "ElasticsearchConnectionStatus"
}
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
2021-09-08 23:50:25 +02:00
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.PingResult" ,
"type" : "Interface" ,
"tags" : [ ] ,
"label" : "PingResult" ,
"description" : [ ] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false ,
"children" : [
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.PingResult.authRequired" ,
"type" : "boolean" ,
"tags" : [ ] ,
"label" : "authRequired" ,
"description" : [
"\nIndicates whether the cluster requires authentication."
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
} ,
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.PingResult.certificateChain" ,
"type" : "Array" ,
"tags" : [ ] ,
"label" : "certificateChain" ,
"description" : [
"\nFull certificate chain of cluster at requested address. Only present if cluster uses HTTPS."
] ,
"signature" : [
{
"pluginId" : "interactiveSetup" ,
"scope" : "common" ,
"docId" : "kibInteractiveSetupPluginApi" ,
"section" : "def-common.Certificate" ,
"text" : "Certificate"
} ,
"[] | undefined"
] ,
"path" : "src/plugins/interactive_setup/common/types.ts" ,
"deprecated" : false
}
] ,
"initialIsOpen" : false
2021-08-24 19:42:23 +02:00
}
] ,
"enums" : [
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.ElasticsearchConnectionStatus" ,
"type" : "Enum" ,
"tags" : [ ] ,
"label" : "ElasticsearchConnectionStatus" ,
"description" : [
"\nDescribes current status of the Elasticsearch connection."
] ,
"path" : "src/plugins/interactive_setup/common/elasticsearch_connection_status.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
}
] ,
2021-09-08 23:50:25 +02:00
"misc" : [
{
"parentPluginId" : "interactiveSetup" ,
"id" : "def-common.VERIFICATION_CODE_LENGTH" ,
"type" : "number" ,
"tags" : [ ] ,
"label" : "VERIFICATION_CODE_LENGTH" ,
"description" : [ ] ,
"signature" : [
"6"
] ,
"path" : "src/plugins/interactive_setup/common/constants.ts" ,
"deprecated" : false ,
"initialIsOpen" : false
}
] ,
2021-08-24 19:42:23 +02:00
"objects" : [ ]
}
}