kibana/api_docs/spaces.json

{
  "id": "spaces",
  "client": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "spaces",
        "id": "def-public.getSpaceColor",
        "type": "Function",
        "tags": [],
        "label": "getSpaceColor",
        "description": [
          "\nDetermines the color for the provided space.\nIf a color is present on the Space itself, then that is used.\nOtherwise, a color is provided from EUI's Visualization Colors based on the space name.\n"
        ],
        "signature": [
          "(space: Partial<",
          {
            "pluginId": "spacesOss",
            "scope": "common",
            "docId": "kibSpacesOssPluginApi",
            "section": "def-common.Space",
            "text": "Space"
          },
          ">) => string"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
          "lineNumber": 24
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-public.getSpaceColor.$1",
            "type": "Object",
            "tags": [],
            "label": "space",
            "description": [
              "the space."
            ],
            "signature": [
              "Partial<",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ">"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
              "lineNumber": 24
            },
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-public.getSpaceImageUrl",
        "type": "Function",
        "tags": [],
        "label": "getSpaceImageUrl",
        "description": [
          "\nDetermines the avatar image for the provided space.\n"
        ],
        "signature": [
          "(space: Partial<",
          {
            "pluginId": "spacesOss",
            "scope": "common",
            "docId": "kibSpacesOssPluginApi",
            "section": "def-common.Space",
            "text": "Space"
          },
          ">) => string"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
          "lineNumber": 64
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-public.getSpaceImageUrl.$1",
            "type": "Object",
            "tags": [],
            "label": "space",
            "description": [
              "the space."
            ],
            "signature": [
              "Partial<",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ">"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
              "lineNumber": 64
            },
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-public.getSpaceInitials",
        "type": "Function",
        "tags": [],
        "label": "getSpaceInitials",
        "description": [
          "\nDetermines the initials for the provided space.\nIf initials are present on the Space itself, then that is used.\nOtherwise, the initials are calculated based off the words in the space name, with a max length of 2 characters.\n"
        ],
        "signature": [
          "(space: Partial<",
          {
            "pluginId": "spacesOss",
            "scope": "common",
            "docId": "kibSpacesOssPluginApi",
            "section": "def-common.Space",
            "text": "Space"
          },
          ">) => string"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
          "lineNumber": 43
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-public.getSpaceInitials.$1",
            "type": "Object",
            "tags": [],
            "label": "space",
            "description": [
              "the space."
            ],
            "signature": [
              "Partial<",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ">"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/public/space_avatar/space_attributes.ts",
              "lineNumber": 43
            },
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "spaces",
        "id": "def-public.GetSpaceResult",
        "type": "Interface",
        "tags": [],
        "label": "GetSpaceResult",
        "description": [
          "\nResponse format when querying for spaces."
        ],
        "signature": [
          {
            "pluginId": "spaces",
            "scope": "common",
            "docId": "kibSpacesPluginApi",
            "section": "def-common.GetSpaceResult",
            "text": "GetSpaceResult"
          },
          " extends ",
          {
            "pluginId": "spacesOss",
            "scope": "common",
            "docId": "kibSpacesOssPluginApi",
            "section": "def-common.Space",
            "text": "Space"
          }
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 47
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-public.GetSpaceResult.authorizedPurposes",
            "type": "Object",
            "tags": [],
            "label": "authorizedPurposes",
            "description": [
              "\nA set of flags indicating which purposes the user is authorized for."
            ],
            "signature": [
              "Record<",
              {
                "pluginId": "spaces",
                "scope": "common",
                "docId": "kibSpacesPluginApi",
                "section": "def-common.GetAllSpacesPurpose",
                "text": "GetAllSpacesPurpose"
              },
              ", boolean> | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 51
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-public.Space",
        "type": "Interface",
        "tags": [],
        "label": "Space",
        "description": [
          "\nA Space."
        ],
        "source": {
          "path": "src/plugins/spaces_oss/common/types.ts",
          "lineNumber": 12
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-public.Space.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [
              "\nThe unique identifier for this space.\nThe id becomes part of the \"URL Identifier\" of the space.\n\nExample: an id of `marketing` would result in the URL identifier of `/s/marketing`."
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 19
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-public.Space.name",
            "type": "string",
            "tags": [],
            "label": "name",
            "description": [
              "\nDisplay name for this space."
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 24
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-public.Space.description",
            "type": "string",
            "tags": [],
            "label": "description",
            "description": [
              "\nOptional description for this space."
            ],
            "signature": [
              "string | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 29
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-public.Space.color",
            "type": "string",
            "tags": [],
            "label": "color",
            "description": [
              "\nOptional color (hex code) for this space.\nIf neither `color` nor `imageUrl` is specified, then a color will be automatically generated."
            ],
            "signature": [
              "string | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 35
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-public.Space.initials",
            "type": "string",
            "tags": [],
            "label": "initials",
            "description": [
              "\nOptional display initials for this space's avatar. Supports a maximum of 2 characters.\nIf initials are not provided, then they will be derived from the space name automatically.\n\nInitials are not displayed if an `imageUrl` has been specified."
            ],
            "signature": [
              "string | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 43
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-public.Space.imageUrl",
            "type": "string",
            "tags": [],
            "label": "imageUrl",
            "description": [
              "\nOptional base-64 encoded data image url to show as this space's avatar.\nThis setting takes precedence over any configured `color` or `initials`."
            ],
            "signature": [
              "string | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 49
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-public.Space.disabledFeatures",
            "type": "Array",
            "tags": [],
            "label": "disabledFeatures",
            "description": [
              "\nThe set of feature ids that should be hidden within this space."
            ],
            "signature": [
              "string[]"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 54
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-public.Space._reserved",
            "type": "CompoundType",
            "tags": [
              "private"
            ],
            "label": "_reserved",
            "description": [
              "\nIndicates that this space is reserved (system controlled).\nReserved spaces cannot be created or deleted by end-users."
            ],
            "signature": [
              "boolean | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 61
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "spaces",
        "id": "def-public.GetAllSpacesPurpose",
        "type": "Type",
        "tags": [],
        "label": "GetAllSpacesPurpose",
        "description": [
          "\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
        ],
        "signature": [
          "\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 38
        },
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "spaces",
      "id": "def-public.SpacesPluginSetup",
      "type": "Type",
      "tags": [],
      "label": "SpacesPluginSetup",
      "description": [
        "\nSetup contract for the Spaces plugin."
      ],
      "signature": [
        "{}"
      ],
      "source": {
        "path": "x-pack/plugins/spaces/public/plugin.tsx",
        "lineNumber": 42
      },
      "deprecated": false,
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "spaces",
      "id": "def-public.SpacesPluginStart",
      "type": "Type",
      "tags": [],
      "label": "SpacesPluginStart",
      "description": [
        "\nStart contract for the Spaces plugin."
      ],
      "signature": [
        {
          "pluginId": "spacesOss",
          "scope": "public",
          "docId": "kibSpacesOssPluginApi",
          "section": "def-public.SpacesApi",
          "text": "SpacesApi"
        }
      ],
      "source": {
        "path": "x-pack/plugins/spaces/public/plugin.tsx",
        "lineNumber": 47
      },
      "deprecated": false,
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "spaces",
        "id": "def-server.addSpaceIdToPath",
        "type": "Function",
        "tags": [],
        "label": "addSpaceIdToPath",
        "description": [
          "\nGiven a server base path, space id, and requested resource, this will construct a space-aware path\nthat includes a URL identifier with the space id.\n"
        ],
        "signature": [
          "(basePath: string, spaceId: string, requestedPath: string) => string"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
          "lineNumber": 61
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-server.addSpaceIdToPath.$1",
            "type": "string",
            "tags": [],
            "label": "basePath",
            "description": [
              "the server's base path."
            ],
            "signature": [
              "string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
              "lineNumber": 62
            },
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.addSpaceIdToPath.$2",
            "type": "string",
            "tags": [],
            "label": "spaceId",
            "description": [
              "the space id."
            ],
            "signature": [
              "string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
              "lineNumber": 63
            },
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.addSpaceIdToPath.$3",
            "type": "string",
            "tags": [],
            "label": "requestedPath",
            "description": [
              "the requested path (e.g. `/app/dashboard`)."
            ],
            "signature": [
              "string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
              "lineNumber": 64
            },
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [
          "the space-aware version of the requested path, inclusive of the server's base path."
        ],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "spaces",
        "id": "def-server.GetAllSpacesOptions",
        "type": "Interface",
        "tags": [],
        "label": "GetAllSpacesOptions",
        "description": [
          "\nControls how spaces are retrieved."
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 13
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-server.GetAllSpacesOptions.purpose",
            "type": "CompoundType",
            "tags": [
              "see"
            ],
            "label": "purpose",
            "description": [
              "\nAn optional purpose describing how the set of spaces will be used.\nThe default purpose (`any`) will retrieve all spaces the user is authorized to see,\nwhereas a more specific purpose will retrieve all spaces the user is authorized to perform a specific action within.\n"
            ],
            "signature": [
              "\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 21
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.GetAllSpacesOptions.includeAuthorizedPurposes",
            "type": "CompoundType",
            "tags": [
              "see"
            ],
            "label": "includeAuthorizedPurposes",
            "description": [
              "\nSet to true to return a set of flags indicating which purposes the user is authorized for.\n"
            ],
            "signature": [
              "boolean | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 28
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-server.GetSpaceResult",
        "type": "Interface",
        "tags": [],
        "label": "GetSpaceResult",
        "description": [
          "\nResponse format when querying for spaces."
        ],
        "signature": [
          {
            "pluginId": "spaces",
            "scope": "common",
            "docId": "kibSpacesPluginApi",
            "section": "def-common.GetSpaceResult",
            "text": "GetSpaceResult"
          },
          " extends ",
          {
            "pluginId": "spacesOss",
            "scope": "common",
            "docId": "kibSpacesOssPluginApi",
            "section": "def-common.Space",
            "text": "Space"
          }
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 47
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-server.GetSpaceResult.authorizedPurposes",
            "type": "Object",
            "tags": [],
            "label": "authorizedPurposes",
            "description": [
              "\nA set of flags indicating which purposes the user is authorized for."
            ],
            "signature": [
              "Record<",
              {
                "pluginId": "spaces",
                "scope": "common",
                "docId": "kibSpacesPluginApi",
                "section": "def-common.GetAllSpacesPurpose",
                "text": "GetAllSpacesPurpose"
              },
              ", boolean> | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 51
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-server.ISpacesClient",
        "type": "Interface",
        "tags": [],
        "label": "ISpacesClient",
        "description": [
          "\nClient interface for interacting with spaces."
        ],
        "source": {
          "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
          "lineNumber": 35
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-server.ISpacesClient.getAll",
            "type": "Function",
            "tags": [],
            "label": "getAll",
            "description": [
              "\nRetrieve all available spaces."
            ],
            "signature": [
              "(options?: ",
              {
                "pluginId": "spaces",
                "scope": "common",
                "docId": "kibSpacesPluginApi",
                "section": "def-common.GetAllSpacesOptions",
                "text": "GetAllSpacesOptions"
              },
              " | undefined) => Promise<",
              {
                "pluginId": "spaces",
                "scope": "common",
                "docId": "kibSpacesPluginApi",
                "section": "def-common.GetSpaceResult",
                "text": "GetSpaceResult"
              },
              "[]>"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
              "lineNumber": 40
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.ISpacesClient.getAll.$1",
                "type": "Object",
                "tags": [],
                "label": "options",
                "description": [
                  "controls which spaces are retrieved."
                ],
                "signature": [
                  {
                    "pluginId": "spaces",
                    "scope": "common",
                    "docId": "kibSpacesPluginApi",
                    "section": "def-common.GetAllSpacesOptions",
                    "text": "GetAllSpacesOptions"
                  },
                  " | undefined"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
                  "lineNumber": 40
                },
                "deprecated": false,
                "isRequired": false
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.ISpacesClient.get",
            "type": "Function",
            "tags": [],
            "label": "get",
            "description": [
              "\nRetrieve a space by its id."
            ],
            "signature": [
              "(id: string) => Promise<",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ">"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
              "lineNumber": 46
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.ISpacesClient.get.$1",
                "type": "string",
                "tags": [],
                "label": "id",
                "description": [
                  "the space id."
                ],
                "signature": [
                  "string"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
                  "lineNumber": 46
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.ISpacesClient.create",
            "type": "Function",
            "tags": [],
            "label": "create",
            "description": [
              "\nCreates a space."
            ],
            "signature": [
              "(space: ",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ") => Promise<",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ">"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
              "lineNumber": 52
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.ISpacesClient.create.$1",
                "type": "Object",
                "tags": [],
                "label": "space",
                "description": [
                  "the space to create."
                ],
                "signature": [
                  {
                    "pluginId": "spacesOss",
                    "scope": "common",
                    "docId": "kibSpacesOssPluginApi",
                    "section": "def-common.Space",
                    "text": "Space"
                  }
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
                  "lineNumber": 52
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.ISpacesClient.update",
            "type": "Function",
            "tags": [],
            "label": "update",
            "description": [
              "\nUpdates a space."
            ],
            "signature": [
              "(id: string, space: ",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ") => Promise<",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ">"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
              "lineNumber": 59
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.ISpacesClient.update.$1",
                "type": "string",
                "tags": [],
                "label": "id",
                "description": [
                  "the id of the space to update."
                ],
                "signature": [
                  "string"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
                  "lineNumber": 59
                },
                "deprecated": false,
                "isRequired": true
              },
              {
                "parentPluginId": "spaces",
                "id": "def-server.ISpacesClient.update.$2",
                "type": "Object",
                "tags": [],
                "label": "space",
                "description": [
                  "the updated space."
                ],
                "signature": [
                  {
                    "pluginId": "spacesOss",
                    "scope": "common",
                    "docId": "kibSpacesOssPluginApi",
                    "section": "def-common.Space",
                    "text": "Space"
                  }
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
                  "lineNumber": 59
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.ISpacesClient.delete",
            "type": "Function",
            "tags": [],
            "label": "delete",
            "description": [
              "\nDeletes a space, and all saved objects belonging to that space."
            ],
            "signature": [
              "(id: string) => Promise<void>"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
              "lineNumber": 65
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.ISpacesClient.delete.$1",
                "type": "string",
                "tags": [],
                "label": "id",
                "description": [
                  "the id of the space to delete."
                ],
                "signature": [
                  "string"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
                  "lineNumber": 65
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.ISpacesClient.disableLegacyUrlAliases",
            "type": "Function",
            "tags": [],
            "label": "disableLegacyUrlAliases",
            "description": [
              "\nDisables the specified legacy URL aliases."
            ],
            "signature": [
              "(aliases: ",
              {
                "pluginId": "spaces",
                "scope": "common",
                "docId": "kibSpacesPluginApi",
                "section": "def-common.LegacyUrlAliasTarget",
                "text": "LegacyUrlAliasTarget"
              },
              "[]) => Promise<void>"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
              "lineNumber": 71
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.ISpacesClient.disableLegacyUrlAliases.$1",
                "type": "Array",
                "tags": [],
                "label": "aliases",
                "description": [
                  "the aliases to disable."
                ],
                "signature": [
                  {
                    "pluginId": "spaces",
                    "scope": "common",
                    "docId": "kibSpacesPluginApi",
                    "section": "def-common.LegacyUrlAliasTarget",
                    "text": "LegacyUrlAliasTarget"
                  },
                  "[]"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client.ts",
                  "lineNumber": 71
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-server.LegacyUrlAliasTarget",
        "type": "Interface",
        "tags": [],
        "label": "LegacyUrlAliasTarget",
        "description": [
          "\nClient interface for interacting with legacy URL aliases."
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 57
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-server.LegacyUrlAliasTarget.targetSpace",
            "type": "string",
            "tags": [],
            "label": "targetSpace",
            "description": [
              "\nThe namespace that the object existed in when it was converted."
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 61
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.LegacyUrlAliasTarget.targetType",
            "type": "string",
            "tags": [],
            "label": "targetType",
            "description": [
              "\nThe type of the object when it was converted."
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 65
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.LegacyUrlAliasTarget.sourceId",
            "type": "string",
            "tags": [],
            "label": "sourceId",
            "description": [
              "\nThe original ID of the object, before it was converted."
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 69
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-server.Space",
        "type": "Interface",
        "tags": [],
        "label": "Space",
        "description": [
          "\nA Space."
        ],
        "source": {
          "path": "src/plugins/spaces_oss/common/types.ts",
          "lineNumber": 12
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-server.Space.id",
            "type": "string",
            "tags": [],
            "label": "id",
            "description": [
              "\nThe unique identifier for this space.\nThe id becomes part of the \"URL Identifier\" of the space.\n\nExample: an id of `marketing` would result in the URL identifier of `/s/marketing`."
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 19
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.Space.name",
            "type": "string",
            "tags": [],
            "label": "name",
            "description": [
              "\nDisplay name for this space."
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 24
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.Space.description",
            "type": "string",
            "tags": [],
            "label": "description",
            "description": [
              "\nOptional description for this space."
            ],
            "signature": [
              "string | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 29
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.Space.color",
            "type": "string",
            "tags": [],
            "label": "color",
            "description": [
              "\nOptional color (hex code) for this space.\nIf neither `color` nor `imageUrl` is specified, then a color will be automatically generated."
            ],
            "signature": [
              "string | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 35
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.Space.initials",
            "type": "string",
            "tags": [],
            "label": "initials",
            "description": [
              "\nOptional display initials for this space's avatar. Supports a maximum of 2 characters.\nIf initials are not provided, then they will be derived from the space name automatically.\n\nInitials are not displayed if an `imageUrl` has been specified."
            ],
            "signature": [
              "string | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 43
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.Space.imageUrl",
            "type": "string",
            "tags": [],
            "label": "imageUrl",
            "description": [
              "\nOptional base-64 encoded data image url to show as this space's avatar.\nThis setting takes precedence over any configured `color` or `initials`."
            ],
            "signature": [
              "string | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 49
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.Space.disabledFeatures",
            "type": "Array",
            "tags": [],
            "label": "disabledFeatures",
            "description": [
              "\nThe set of feature ids that should be hidden within this space."
            ],
            "signature": [
              "string[]"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 54
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.Space._reserved",
            "type": "CompoundType",
            "tags": [
              "private"
            ],
            "label": "_reserved",
            "description": [
              "\nIndicates that this space is reserved (system controlled).\nReserved spaces cannot be created or deleted by end-users."
            ],
            "signature": [
              "boolean | undefined"
            ],
            "source": {
              "path": "src/plugins/spaces_oss/common/types.ts",
              "lineNumber": 61
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-server.SpacesServiceSetup",
        "type": "Interface",
        "tags": [],
        "label": "SpacesServiceSetup",
        "description": [
          "\nThe Spaces service setup contract."
        ],
        "source": {
          "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
          "lineNumber": 19
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceSetup.getSpaceId",
            "type": "Function",
            "tags": [
              "deprecated"
            ],
            "label": "getSpaceId",
            "description": [
              "\nRetrieves the space id associated with the provided request."
            ],
            "signature": [
              "(request: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreHttpPluginApi",
                "section": "def-server.KibanaRequest",
                "text": "KibanaRequest"
              },
              "<unknown, unknown, unknown, any>) => string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 27
            },
            "deprecated": true,
            "removeBy": "7.16",
            "references": [
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/audit/audit_service.ts",
                  "lineNumber": 56
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_privileges_dynamically.ts",
                  "lineNumber": 34
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/plugin.ts",
                  "lineNumber": 266
                }
              },
              {
                "plugin": "reporting",
                "link": {
                  "path": "x-pack/plugins/reporting/server/core.ts",
                  "lineNumber": 269
                }
              },
              {
                "plugin": "apm",
                "link": {
                  "path": "x-pack/plugins/apm/server/routes/index_pattern.ts",
                  "lineNumber": 33
                }
              },
              {
                "plugin": "infra",
                "link": {
                  "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts",
                  "lineNumber": 239
                }
              },
              {
                "plugin": "infra",
                "link": {
                  "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts",
                  "lineNumber": 241
                }
              },
              {
                "plugin": "infra",
                "link": {
                  "path": "x-pack/plugins/infra/server/plugin.ts",
                  "lineNumber": 174
                }
              },
              {
                "plugin": "securitySolution",
                "link": {
                  "path": "x-pack/plugins/security_solution/server/plugin.ts",
                  "lineNumber": 191
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_privileges_dynamically.test.ts",
                  "lineNumber": 24
                }
              }
            ],
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.SpacesServiceSetup.getSpaceId.$1",
                "type": "Object",
                "tags": [],
                "label": "request",
                "description": [
                  "the request."
                ],
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCoreHttpPluginApi",
                    "section": "def-server.KibanaRequest",
                    "text": "KibanaRequest"
                  },
                  "<unknown, unknown, unknown, any>"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 27
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceSetup.spaceIdToNamespace",
            "type": "Function",
            "tags": [
              "deprecated"
            ],
            "label": "spaceIdToNamespace",
            "description": [
              "\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
            ],
            "signature": [
              "(spaceId: string) => string | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 36
            },
            "deprecated": true,
            "removeBy": "7.16",
            "references": [],
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.SpacesServiceSetup.spaceIdToNamespace.$1",
                "type": "string",
                "tags": [],
                "label": "spaceId",
                "description": [
                  "the space id to convert."
                ],
                "signature": [
                  "string"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 36
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceSetup.namespaceToSpaceId",
            "type": "Function",
            "tags": [
              "deprecated"
            ],
            "label": "namespaceToSpaceId",
            "description": [
              "\nConverts the provided namespace into the corresponding space id."
            ],
            "signature": [
              "(namespace: string | undefined) => string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 45
            },
            "deprecated": true,
            "removeBy": "7.16",
            "references": [
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.ts",
                  "lineNumber": 48
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.ts",
                  "lineNumber": 56
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts",
                  "lineNumber": 1004
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/saved_objects/secure_saved_objects_client_wrapper.ts",
                  "lineNumber": 1031
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_privileges_dynamically.test.ts",
                  "lineNumber": 25
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 66
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 67
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 68
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 72
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 85
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 86
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 87
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 88
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 89
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 94
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 95
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 142
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 143
                }
              },
              {
                "plugin": "security",
                "link": {
                  "path": "x-pack/plugins/security/server/authorization/check_saved_objects_privileges.test.ts",
                  "lineNumber": 147
                }
              }
            ],
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.SpacesServiceSetup.namespaceToSpaceId.$1",
                "type": "string",
                "tags": [],
                "label": "namespace",
                "description": [
                  "the namespace to convert."
                ],
                "signature": [
                  "string | undefined"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 45
                },
                "deprecated": false,
                "isRequired": false
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-server.SpacesServiceStart",
        "type": "Interface",
        "tags": [],
        "label": "SpacesServiceStart",
        "description": [
          "\nThe Spaces service start contract."
        ],
        "source": {
          "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
          "lineNumber": 51
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceStart.createSpacesClient",
            "type": "Function",
            "tags": [],
            "label": "createSpacesClient",
            "description": [
              "\nCreates a scoped instance of the SpacesClient."
            ],
            "signature": [
              "(request: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreHttpPluginApi",
                "section": "def-server.KibanaRequest",
                "text": "KibanaRequest"
              },
              "<unknown, unknown, unknown, any>) => ",
              {
                "pluginId": "spaces",
                "scope": "server",
                "docId": "kibSpacesPluginApi",
                "section": "def-server.ISpacesClient",
                "text": "ISpacesClient"
              }
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 56
            },
            "deprecated": false,
            "returnComment": [],
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.request",
                "type": "Object",
                "tags": [],
                "label": "request",
                "description": [
                  "the request."
                ],
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCoreHttpPluginApi",
                    "section": "def-server.KibanaRequest",
                    "text": "KibanaRequest"
                  },
                  "<unknown, unknown, unknown, any>"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 56
                },
                "deprecated": false
              }
            ]
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceStart.getSpaceId",
            "type": "Function",
            "tags": [],
            "label": "getSpaceId",
            "description": [
              "\nRetrieves the space id associated with the provided request."
            ],
            "signature": [
              "(request: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreHttpPluginApi",
                "section": "def-server.KibanaRequest",
                "text": "KibanaRequest"
              },
              "<unknown, unknown, unknown, any>) => string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 62
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.SpacesServiceStart.getSpaceId.$1",
                "type": "Object",
                "tags": [],
                "label": "request",
                "description": [
                  "the request."
                ],
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCoreHttpPluginApi",
                    "section": "def-server.KibanaRequest",
                    "text": "KibanaRequest"
                  },
                  "<unknown, unknown, unknown, any>"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 62
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceStart.isInDefaultSpace",
            "type": "Function",
            "tags": [],
            "label": "isInDefaultSpace",
            "description": [
              "\nIndicates if the provided request is executing within the context of the `default` space."
            ],
            "signature": [
              "(request: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreHttpPluginApi",
                "section": "def-server.KibanaRequest",
                "text": "KibanaRequest"
              },
              "<unknown, unknown, unknown, any>) => boolean"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 68
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.SpacesServiceStart.isInDefaultSpace.$1",
                "type": "Object",
                "tags": [],
                "label": "request",
                "description": [
                  "the request."
                ],
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCoreHttpPluginApi",
                    "section": "def-server.KibanaRequest",
                    "text": "KibanaRequest"
                  },
                  "<unknown, unknown, unknown, any>"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 68
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceStart.getActiveSpace",
            "type": "Function",
            "tags": [],
            "label": "getActiveSpace",
            "description": [
              "\nRetrieves the Space associated with the provided request."
            ],
            "signature": [
              "(request: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreHttpPluginApi",
                "section": "def-server.KibanaRequest",
                "text": "KibanaRequest"
              },
              "<unknown, unknown, unknown, any>) => Promise<",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              ">"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 74
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.SpacesServiceStart.getActiveSpace.$1",
                "type": "Object",
                "tags": [],
                "label": "request",
                "description": [
                  "the request."
                ],
                "signature": [
                  {
                    "pluginId": "core",
                    "scope": "server",
                    "docId": "kibCoreHttpPluginApi",
                    "section": "def-server.KibanaRequest",
                    "text": "KibanaRequest"
                  },
                  "<unknown, unknown, unknown, any>"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 74
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceStart.spaceIdToNamespace",
            "type": "Function",
            "tags": [],
            "label": "spaceIdToNamespace",
            "description": [
              "\nConverts the provided space id into the corresponding Saved Objects `namespace` id."
            ],
            "signature": [
              "(spaceId: string) => string | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 80
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.SpacesServiceStart.spaceIdToNamespace.$1",
                "type": "string",
                "tags": [],
                "label": "spaceId",
                "description": [
                  "the space id to convert."
                ],
                "signature": [
                  "string"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 80
                },
                "deprecated": false,
                "isRequired": true
              }
            ],
            "returnComment": []
          },
          {
            "parentPluginId": "spaces",
            "id": "def-server.SpacesServiceStart.namespaceToSpaceId",
            "type": "Function",
            "tags": [],
            "label": "namespaceToSpaceId",
            "description": [
              "\nConverts the provided namespace into the corresponding space id."
            ],
            "signature": [
              "(namespace: string | undefined) => string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
              "lineNumber": 86
            },
            "deprecated": false,
            "children": [
              {
                "parentPluginId": "spaces",
                "id": "def-server.SpacesServiceStart.namespaceToSpaceId.$1",
                "type": "string",
                "tags": [],
                "label": "namespace",
                "description": [
                  "the namespace to convert."
                ],
                "signature": [
                  "string | undefined"
                ],
                "source": {
                  "path": "x-pack/plugins/spaces/server/spaces_service/spaces_service.ts",
                  "lineNumber": 86
                },
                "deprecated": false,
                "isRequired": false
              }
            ],
            "returnComment": []
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "spaces",
        "id": "def-server.GetAllSpacesPurpose",
        "type": "Type",
        "tags": [],
        "label": "GetAllSpacesPurpose",
        "description": [
          "\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
        ],
        "signature": [
          "\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 38
        },
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-server.SpacesClientRepositoryFactory",
        "type": "Type",
        "tags": [
          "private"
        ],
        "label": "SpacesClientRepositoryFactory",
        "description": [
          "\nFor consumption by the security plugin only."
        ],
        "signature": [
          "(request: ",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCoreHttpPluginApi",
            "section": "def-server.KibanaRequest",
            "text": "KibanaRequest"
          },
          "<unknown, unknown, unknown, any>, savedObjectsStart: ",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCoreSavedObjectsPluginApi",
            "section": "def-server.SavedObjectsServiceStart",
            "text": "SavedObjectsServiceStart"
          },
          ") => Pick<",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCoreSavedObjectsPluginApi",
            "section": "def-server.SavedObjectsRepository",
            "text": "SavedObjectsRepository"
          },
          ", \"get\" | \"delete\" | \"create\" | \"bulkCreate\" | \"checkConflicts\" | \"deleteByNamespace\" | \"find\" | \"bulkGet\" | \"resolve\" | \"update\" | \"collectMultiNamespaceReferences\" | \"updateObjectsSpaces\" | \"bulkUpdate\" | \"removeReferencesTo\" | \"incrementCounter\" | \"openPointInTimeForType\" | \"closePointInTime\" | \"createPointInTimeFinder\">"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts",
          "lineNumber": 34
        },
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-server.SpacesClientWrapper",
        "type": "Type",
        "tags": [
          "private"
        ],
        "label": "SpacesClientWrapper",
        "description": [
          "\nFor consumption by the security plugin only."
        ],
        "signature": [
          "(request: ",
          {
            "pluginId": "core",
            "scope": "server",
            "docId": "kibCoreHttpPluginApi",
            "section": "def-server.KibanaRequest",
            "text": "KibanaRequest"
          },
          "<unknown, unknown, unknown, any>, baseClient: ",
          {
            "pluginId": "spaces",
            "scope": "server",
            "docId": "kibSpacesPluginApi",
            "section": "def-server.ISpacesClient",
            "text": "ISpacesClient"
          },
          ") => ",
          {
            "pluginId": "spaces",
            "scope": "server",
            "docId": "kibSpacesPluginApi",
            "section": "def-server.ISpacesClient",
            "text": "ISpacesClient"
          }
        ],
        "source": {
          "path": "x-pack/plugins/spaces/server/spaces_client/spaces_client_service.ts",
          "lineNumber": 25
        },
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": [],
    "setup": {
      "parentPluginId": "spaces",
      "id": "def-server.SpacesPluginSetup",
      "type": "Interface",
      "tags": [],
      "label": "SpacesPluginSetup",
      "description": [
        "\nSetup contract for the Spaces plugin."
      ],
      "source": {
        "path": "x-pack/plugins/spaces/server/plugin.ts",
        "lineNumber": 57
      },
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "spaces",
          "id": "def-server.SpacesPluginSetup.spacesService",
          "type": "Object",
          "tags": [
            "deprecated"
          ],
          "label": "spacesService",
          "description": [
            "\nService for interacting with spaces.\n"
          ],
          "signature": [
            {
              "pluginId": "spaces",
              "scope": "server",
              "docId": "kibSpacesPluginApi",
              "section": "def-server.SpacesServiceSetup",
              "text": "SpacesServiceSetup"
            }
          ],
          "source": {
            "path": "x-pack/plugins/spaces/server/plugin.ts",
            "lineNumber": 64
          },
          "deprecated": true,
          "removeBy": "7.16",
          "references": [
            {
              "plugin": "security",
              "link": {
                "path": "x-pack/plugins/security/server/plugin.ts",
                "lineNumber": 59
              }
            },
            {
              "plugin": "security",
              "link": {
                "path": "x-pack/plugins/security/server/plugin.ts",
                "lineNumber": 266
              }
            },
            {
              "plugin": "security",
              "link": {
                "path": "x-pack/plugins/security/server/plugin.ts",
                "lineNumber": 284
              }
            },
            {
              "plugin": "security",
              "link": {
                "path": "x-pack/plugins/security/server/plugin.ts",
                "lineNumber": 300
              }
            },
            {
              "plugin": "reporting",
              "link": {
                "path": "x-pack/plugins/reporting/server/core.ts",
                "lineNumber": 267
              }
            },
            {
              "plugin": "reporting",
              "link": {
                "path": "x-pack/plugins/reporting/server/core.ts",
                "lineNumber": 289
              }
            },
            {
              "plugin": "reporting",
              "link": {
                "path": "x-pack/plugins/reporting/server/core.ts",
                "lineNumber": 301
              }
            },
            {
              "plugin": "apm",
              "link": {
                "path": "x-pack/plugins/apm/server/routes/index_pattern.ts",
                "lineNumber": 33
              }
            },
            {
              "plugin": "infra",
              "link": {
                "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts",
                "lineNumber": 238
              }
            },
            {
              "plugin": "infra",
              "link": {
                "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts",
                "lineNumber": 239
              }
            },
            {
              "plugin": "infra",
              "link": {
                "path": "x-pack/plugins/infra/server/lib/adapters/framework/kibana_framework_adapter.ts",
                "lineNumber": 241
              }
            },
            {
              "plugin": "infra",
              "link": {
                "path": "x-pack/plugins/infra/server/plugin.ts",
                "lineNumber": 174
              }
            },
            {
              "plugin": "securitySolution",
              "link": {
                "path": "x-pack/plugins/security_solution/server/plugin.ts",
                "lineNumber": 191
              }
            }
          ]
        },
        {
          "parentPluginId": "spaces",
          "id": "def-server.SpacesPluginSetup.spacesClient",
          "type": "Object",
          "tags": [
            "private"
          ],
          "label": "spacesClient",
          "description": [
            "\nRegistries exposed for the security plugin to transparently provide authorization and audit logging."
          ],
          "signature": [
            "{ setClientRepositoryFactory: (factory: ",
            {
              "pluginId": "spaces",
              "scope": "server",
              "docId": "kibSpacesPluginApi",
              "section": "def-server.SpacesClientRepositoryFactory",
              "text": "SpacesClientRepositoryFactory"
            },
            ") => void; registerClientWrapper: (wrapper: ",
            {
              "pluginId": "spaces",
              "scope": "server",
              "docId": "kibSpacesPluginApi",
              "section": "def-server.SpacesClientWrapper",
              "text": "SpacesClientWrapper"
            },
            ") => void; }"
          ],
          "source": {
            "path": "x-pack/plugins/spaces/server/plugin.ts",
            "lineNumber": 70
          },
          "deprecated": false
        }
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "parentPluginId": "spaces",
      "id": "def-server.SpacesPluginStart",
      "type": "Interface",
      "tags": [],
      "label": "SpacesPluginStart",
      "description": [
        "\nStart contract for the Spaces plugin."
      ],
      "source": {
        "path": "x-pack/plugins/spaces/server/plugin.ts",
        "lineNumber": 87
      },
      "deprecated": false,
      "children": [
        {
          "parentPluginId": "spaces",
          "id": "def-server.SpacesPluginStart.spacesService",
          "type": "Object",
          "tags": [],
          "label": "spacesService",
          "description": [
            "Service for interacting with spaces."
          ],
          "signature": [
            {
              "pluginId": "spaces",
              "scope": "server",
              "docId": "kibSpacesPluginApi",
              "section": "def-server.SpacesServiceStart",
              "text": "SpacesServiceStart"
            }
          ],
          "source": {
            "path": "x-pack/plugins/spaces/server/plugin.ts",
            "lineNumber": 89
          },
          "deprecated": false
        }
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "common": {
    "classes": [],
    "functions": [
      {
        "parentPluginId": "spaces",
        "id": "def-common.addSpaceIdToPath",
        "type": "Function",
        "tags": [],
        "label": "addSpaceIdToPath",
        "description": [
          "\nGiven a server base path, space id, and requested resource, this will construct a space-aware path\nthat includes a URL identifier with the space id.\n"
        ],
        "signature": [
          "(basePath: string, spaceId: string, requestedPath: string) => string"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
          "lineNumber": 61
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-common.addSpaceIdToPath.$1",
            "type": "string",
            "tags": [],
            "label": "basePath",
            "description": [
              "the server's base path."
            ],
            "signature": [
              "string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
              "lineNumber": 62
            },
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "spaces",
            "id": "def-common.addSpaceIdToPath.$2",
            "type": "string",
            "tags": [],
            "label": "spaceId",
            "description": [
              "the space id."
            ],
            "signature": [
              "string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
              "lineNumber": 63
            },
            "deprecated": false,
            "isRequired": true
          },
          {
            "parentPluginId": "spaces",
            "id": "def-common.addSpaceIdToPath.$3",
            "type": "string",
            "tags": [],
            "label": "requestedPath",
            "description": [
              "the requested path (e.g. `/app/dashboard`)."
            ],
            "signature": [
              "string"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
              "lineNumber": 64
            },
            "deprecated": false,
            "isRequired": true
          }
        ],
        "returnComment": [
          "the space-aware version of the requested path, inclusive of the server's base path."
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-common.getSpaceIdFromPath",
        "type": "Function",
        "tags": [
          "private"
        ],
        "label": "getSpaceIdFromPath",
        "description": [
          "\nExtracts the space id from the given path.\n"
        ],
        "signature": [
          "(requestBasePath: string | null | undefined, serverBasePath: string | null | undefined) => { spaceId: string; pathHasExplicitSpaceIdentifier: boolean; }"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
          "lineNumber": 21
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-common.getSpaceIdFromPath.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "requestBasePath",
            "description": [
              "The base path of the current request."
            ],
            "signature": [
              "string | null | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
              "lineNumber": 22
            },
            "deprecated": false,
            "isRequired": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-common.getSpaceIdFromPath.$2",
            "type": "CompoundType",
            "tags": [],
            "label": "serverBasePath",
            "description": [
              "The server's base path."
            ],
            "signature": [
              "string | null | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/lib/spaces_url_parser.ts",
              "lineNumber": 23
            },
            "deprecated": false,
            "isRequired": false
          }
        ],
        "returnComment": [
          "the space id."
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-common.isReservedSpace",
        "type": "Function",
        "tags": [],
        "label": "isReservedSpace",
        "description": [
          "\nReturns whether the given Space is reserved or not.\n"
        ],
        "signature": [
          "(space: Partial<",
          {
            "pluginId": "spacesOss",
            "scope": "common",
            "docId": "kibSpacesOssPluginApi",
            "section": "def-common.Space",
            "text": "Space"
          },
          "> | null | undefined) => boolean"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/is_reserved_space.ts",
          "lineNumber": 18
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-common.isReservedSpace.$1",
            "type": "CompoundType",
            "tags": [],
            "label": "space",
            "description": [
              "the space"
            ],
            "signature": [
              "Partial<",
              {
                "pluginId": "spacesOss",
                "scope": "common",
                "docId": "kibSpacesOssPluginApi",
                "section": "def-common.Space",
                "text": "Space"
              },
              "> | null | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/is_reserved_space.ts",
              "lineNumber": 18
            },
            "deprecated": false,
            "isRequired": false
          }
        ],
        "returnComment": [
          "boolean"
        ],
        "initialIsOpen": false
      }
    ],
    "interfaces": [
      {
        "parentPluginId": "spaces",
        "id": "def-common.GetAllSpacesOptions",
        "type": "Interface",
        "tags": [],
        "label": "GetAllSpacesOptions",
        "description": [
          "\nControls how spaces are retrieved."
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 13
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-common.GetAllSpacesOptions.purpose",
            "type": "CompoundType",
            "tags": [
              "see"
            ],
            "label": "purpose",
            "description": [
              "\nAn optional purpose describing how the set of spaces will be used.\nThe default purpose (`any`) will retrieve all spaces the user is authorized to see,\nwhereas a more specific purpose will retrieve all spaces the user is authorized to perform a specific action within.\n"
            ],
            "signature": [
              "\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\" | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 21
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-common.GetAllSpacesOptions.includeAuthorizedPurposes",
            "type": "CompoundType",
            "tags": [
              "see"
            ],
            "label": "includeAuthorizedPurposes",
            "description": [
              "\nSet to true to return a set of flags indicating which purposes the user is authorized for.\n"
            ],
            "signature": [
              "boolean | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 28
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-common.GetSpaceResult",
        "type": "Interface",
        "tags": [],
        "label": "GetSpaceResult",
        "description": [
          "\nResponse format when querying for spaces."
        ],
        "signature": [
          {
            "pluginId": "spaces",
            "scope": "common",
            "docId": "kibSpacesPluginApi",
            "section": "def-common.GetSpaceResult",
            "text": "GetSpaceResult"
          },
          " extends ",
          {
            "pluginId": "spacesOss",
            "scope": "common",
            "docId": "kibSpacesOssPluginApi",
            "section": "def-common.Space",
            "text": "Space"
          }
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 47
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-common.GetSpaceResult.authorizedPurposes",
            "type": "Object",
            "tags": [],
            "label": "authorizedPurposes",
            "description": [
              "\nA set of flags indicating which purposes the user is authorized for."
            ],
            "signature": [
              "Record<",
              {
                "pluginId": "spaces",
                "scope": "common",
                "docId": "kibSpacesPluginApi",
                "section": "def-common.GetAllSpacesPurpose",
                "text": "GetAllSpacesPurpose"
              },
              ", boolean> | undefined"
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 51
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-common.LegacyUrlAliasTarget",
        "type": "Interface",
        "tags": [],
        "label": "LegacyUrlAliasTarget",
        "description": [
          "\nClient interface for interacting with legacy URL aliases."
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 57
        },
        "deprecated": false,
        "children": [
          {
            "parentPluginId": "spaces",
            "id": "def-common.LegacyUrlAliasTarget.targetSpace",
            "type": "string",
            "tags": [],
            "label": "targetSpace",
            "description": [
              "\nThe namespace that the object existed in when it was converted."
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 61
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-common.LegacyUrlAliasTarget.targetType",
            "type": "string",
            "tags": [],
            "label": "targetType",
            "description": [
              "\nThe type of the object when it was converted."
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 65
            },
            "deprecated": false
          },
          {
            "parentPluginId": "spaces",
            "id": "def-common.LegacyUrlAliasTarget.sourceId",
            "type": "string",
            "tags": [],
            "label": "sourceId",
            "description": [
              "\nThe original ID of the object, before it was converted."
            ],
            "source": {
              "path": "x-pack/plugins/spaces/common/types.ts",
              "lineNumber": 69
            },
            "deprecated": false
          }
        ],
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [
      {
        "parentPluginId": "spaces",
        "id": "def-common.ENTER_SPACE_PATH",
        "type": "string",
        "tags": [],
        "label": "ENTER_SPACE_PATH",
        "description": [
          "\nThe path to enter a space."
        ],
        "signature": [
          "\"/spaces/enter\""
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/constants.ts",
          "lineNumber": 33
        },
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-common.GetAllSpacesPurpose",
        "type": "Type",
        "tags": [],
        "label": "GetAllSpacesPurpose",
        "description": [
          "\nThe set of purposes to retrieve spaces:\n- `any`: retrieves all spaces the user is authorized to see.\n- `copySavedObjectsIntoSpace`: retrieves all spaces the user is authorized to copy saved objects into.\n- `findSavedObjects`: retrieves all spaces the user is authorized to search within.\n- `shareSavedObjectsIntoSpace`: retrieves all spaces the user is authorized to share saved objects into."
        ],
        "signature": [
          "\"any\" | \"copySavedObjectsIntoSpace\" | \"findSavedObjects\" | \"shareSavedObjectsIntoSpace\""
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/types.ts",
          "lineNumber": 38
        },
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-common.MAX_SPACE_INITIALS",
        "type": "number",
        "tags": [],
        "label": "MAX_SPACE_INITIALS",
        "description": [
          "\nThe maximum number of characters allowed in the Space Avatar's initials"
        ],
        "signature": [
          "2"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/constants.ts",
          "lineNumber": 28
        },
        "deprecated": false,
        "initialIsOpen": false
      },
      {
        "parentPluginId": "spaces",
        "id": "def-common.SPACE_SEARCH_COUNT_THRESHOLD",
        "type": "number",
        "tags": [],
        "label": "SPACE_SEARCH_COUNT_THRESHOLD",
        "description": [
          "\nThe minimum number of spaces required to show a search control."
        ],
        "signature": [
          "8"
        ],
        "source": {
          "path": "x-pack/plugins/spaces/common/constants.ts",
          "lineNumber": 23
        },
        "deprecated": false,
        "initialIsOpen": false
      }
    ],
    "objects": []
  }
}