kibana/api_docs/security.json

{
  "id": "security",
  "client": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "id": "def-public.AuthenticatedUser",
        "type": "Interface",
        "label": "AuthenticatedUser",
        "signature": [
          "AuthenticatedUser",
          " extends ",
          "User"
        ],
        "description": [
          "\nRepresents the currently authenticated user."
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-public.AuthenticatedUser.authentication_realm",
            "type": "Object",
            "label": "authentication_realm",
            "description": [
              "\nThe name and type of the Realm that has authenticated the user."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
              "lineNumber": 25
            },
            "signature": [
              "UserRealm"
            ]
          },
          {
            "tags": [],
            "id": "def-public.AuthenticatedUser.lookup_realm",
            "type": "Object",
            "label": "lookup_realm",
            "description": [
              "\nThe name and type of the Realm where the user information were retrieved from."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
              "lineNumber": 30
            },
            "signature": [
              "UserRealm"
            ]
          },
          {
            "tags": [],
            "id": "def-public.AuthenticatedUser.authentication_provider",
            "type": "Object",
            "label": "authentication_provider",
            "description": [
              "\nThe authentication provider that used to authenticate user."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
              "lineNumber": 35
            },
            "signature": [
              "AuthenticationProvider"
            ]
          },
          {
            "tags": [],
            "id": "def-public.AuthenticatedUser.authentication_type",
            "type": "string",
            "label": "authentication_type",
            "description": [
              "\nThe AuthenticationType used by ES to authenticate the user.\n"
            ],
            "source": {
              "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
              "lineNumber": 42
            }
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
          "lineNumber": 21
        },
        "initialIsOpen": false
      },
      {
        "id": "def-public.SecurityLicense",
        "type": "Interface",
        "label": "SecurityLicense",
        "description": [],
        "tags": [],
        "children": [
          {
            "id": "def-public.SecurityLicense.isLicenseAvailable",
            "type": "Function",
            "label": "isLicenseAvailable",
            "signature": [
              "() => boolean"
            ],
            "description": [],
            "children": [],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_service.ts",
              "lineNumber": 15
            }
          },
          {
            "id": "def-public.SecurityLicense.isEnabled",
            "type": "Function",
            "label": "isEnabled",
            "signature": [
              "() => boolean"
            ],
            "description": [],
            "children": [],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_service.ts",
              "lineNumber": 16
            }
          },
          {
            "id": "def-public.SecurityLicense.getType",
            "type": "Function",
            "label": "getType",
            "signature": [
              "() => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
            ],
            "description": [],
            "children": [],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_service.ts",
              "lineNumber": 17
            }
          },
          {
            "id": "def-public.SecurityLicense.getFeatures",
            "type": "Function",
            "label": "getFeatures",
            "signature": [
              "() => ",
              "SecurityLicenseFeatures"
            ],
            "description": [],
            "children": [],
            "tags": [],
            "returnComment": [],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_service.ts",
              "lineNumber": 18
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicense.features$",
            "type": "Object",
            "label": "features$",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_service.ts",
              "lineNumber": 19
            },
            "signature": [
              "Observable",
              "<",
              "SecurityLicenseFeatures",
              ">"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/common/licensing/license_service.ts",
          "lineNumber": 14
        },
        "initialIsOpen": false
      },
      {
        "id": "def-public.SecurityLicenseFeatures",
        "type": "Interface",
        "label": "SecurityLicenseFeatures",
        "description": [
          "\nDescribes Security plugin features that depend on license."
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.showLogin",
            "type": "boolean",
            "label": "showLogin",
            "description": [
              "\nIndicates whether we show login page or skip it."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 20
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.allowLogin",
            "type": "boolean",
            "label": "allowLogin",
            "description": [
              "\nIndicates whether we allow login or disable it on the login page."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 25
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.showLinks",
            "type": "boolean",
            "label": "showLinks",
            "description": [
              "\nIndicates whether we show security links throughout the kibana app."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 30
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.showRoleMappingsManagement",
            "type": "boolean",
            "label": "showRoleMappingsManagement",
            "description": [
              "\nIndicates whether we show the Role Mappings UI."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 35
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.allowAccessAgreement",
            "type": "boolean",
            "label": "allowAccessAgreement",
            "description": [
              "\nIndicates whether we allow users to access agreement UI and acknowledge it."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 40
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.allowAuditLogging",
            "type": "boolean",
            "label": "allowAuditLogging",
            "description": [
              "\nIndicates whether we allow logging of audit events."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 45
            }
          },
          {
            "tags": [
              "deprecated"
            ],
            "id": "def-public.SecurityLicenseFeatures.allowLegacyAuditLogging",
            "type": "boolean",
            "label": "allowLegacyAuditLogging",
            "description": [
              "\nIndicates whether we allow logging of legacy audit events."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 51
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.allowRoleDocumentLevelSecurity",
            "type": "boolean",
            "label": "allowRoleDocumentLevelSecurity",
            "description": [
              "\nIndicates whether we allow users to define document level security in roles."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 56
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.allowRoleFieldLevelSecurity",
            "type": "boolean",
            "label": "allowRoleFieldLevelSecurity",
            "description": [
              "\nIndicates whether we allow users to define field level security in roles."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 61
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.allowRbac",
            "type": "boolean",
            "label": "allowRbac",
            "description": [
              "\nIndicates whether we allow Role-based access control (RBAC)."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 66
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.allowSubFeaturePrivileges",
            "type": "boolean",
            "label": "allowSubFeaturePrivileges",
            "description": [
              "\nIndicates whether we allow sub-feature privileges."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 71
            }
          },
          {
            "tags": [],
            "id": "def-public.SecurityLicenseFeatures.layout",
            "type": "CompoundType",
            "label": "layout",
            "description": [
              "\nDescribes the layout of the login form if it's displayed."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/licensing/license_features.ts",
              "lineNumber": 76
            },
            "signature": [
              "\"form\" | \"error-es-unavailable\" | \"error-xpack-unavailable\" | undefined"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/common/licensing/license_features.ts",
          "lineNumber": 16
        },
        "initialIsOpen": false
      },
      {
        "id": "def-public.UserMenuLink",
        "type": "Interface",
        "label": "UserMenuLink",
        "description": [],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-public.UserMenuLink.label",
            "type": "string",
            "label": "label",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx",
              "lineNumber": 28
            }
          },
          {
            "tags": [],
            "id": "def-public.UserMenuLink.iconType",
            "type": "CompoundType",
            "label": "iconType",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx",
              "lineNumber": 29
            },
            "signature": [
              "IconType"
            ]
          },
          {
            "tags": [],
            "id": "def-public.UserMenuLink.href",
            "type": "string",
            "label": "href",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx",
              "lineNumber": 30
            }
          },
          {
            "tags": [],
            "id": "def-public.UserMenuLink.order",
            "type": "number",
            "label": "order",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx",
              "lineNumber": 31
            },
            "signature": [
              "number | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-public.UserMenuLink.setAsProfile",
            "type": "CompoundType",
            "label": "setAsProfile",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx",
              "lineNumber": 32
            },
            "signature": [
              "boolean | undefined"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/public/nav_control/nav_control_component.tsx",
          "lineNumber": 27
        },
        "initialIsOpen": false
      }
    ],
    "enums": [],
    "misc": [],
    "objects": [],
    "setup": {
      "id": "def-public.SecurityPluginSetup",
      "type": "Type",
      "label": "SecurityPluginSetup",
      "tags": [],
      "description": [],
      "source": {
        "path": "x-pack/plugins/security/public/plugin.tsx",
        "lineNumber": 168
      },
      "signature": [
        "{ authc: AuthenticationServiceSetup; sessionTimeout: ISessionTimeout; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => ",
        "SecurityLicenseFeatures",
        "; features$: ",
        "Observable",
        "<",
        "SecurityLicenseFeatures",
        ">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }"
      ],
      "lifecycle": "setup",
      "initialIsOpen": true
    },
    "start": {
      "id": "def-public.SecurityPluginStart",
      "type": "Type",
      "label": "SecurityPluginStart",
      "tags": [],
      "description": [],
      "source": {
        "path": "x-pack/plugins/security/public/plugin.tsx",
        "lineNumber": 169
      },
      "signature": [
        "{ navControlService: ",
        "SecurityNavControlServiceStart",
        "; }"
      ],
      "lifecycle": "start",
      "initialIsOpen": true
    }
  },
  "server": {
    "classes": [],
    "functions": [],
    "interfaces": [
      {
        "id": "def-server.AuditEvent",
        "type": "Interface",
        "label": "AuditEvent",
        "description": [
          "\nAudit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.6/index.html\n\nIf you add additional fields to the schema ensure you update the Kibana Filebeat module:\nhttps://github.com/elastic/beats/tree/master/filebeat/module/kibana\n"
        ],
        "tags": [
          "public"
        ],
        "children": [
          {
            "tags": [],
            "id": "def-server.AuditEvent.message",
            "type": "string",
            "label": "message",
            "description": [
              "\nHuman readable message describing action, outcome and user.\n"
            ],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_events.ts",
              "lineNumber": 27
            }
          },
          {
            "tags": [],
            "id": "def-server.AuditEvent.event",
            "type": "Object",
            "label": "event",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_events.ts",
              "lineNumber": 28
            },
            "signature": [
              "{ action: string; category?: ",
              {
                "pluginId": "security",
                "scope": "server",
                "docId": "kibSecurityPluginApi",
                "section": "def-server.EventCategory",
                "text": "EventCategory"
              },
              " | undefined; type?: ",
              {
                "pluginId": "security",
                "scope": "server",
                "docId": "kibSecurityPluginApi",
                "section": "def-server.EventType",
                "text": "EventType"
              },
              " | undefined; outcome?: ",
              {
                "pluginId": "security",
                "scope": "server",
                "docId": "kibSecurityPluginApi",
                "section": "def-server.EventOutcome",
                "text": "EventOutcome"
              },
              " | undefined; }"
            ]
          },
          {
            "tags": [],
            "id": "def-server.AuditEvent.user",
            "type": "Object",
            "label": "user",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_events.ts",
              "lineNumber": 34
            },
            "signature": [
              "{ name: string; roles?: readonly string[] | undefined; } | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.AuditEvent.kibana",
            "type": "Object",
            "label": "kibana",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_events.ts",
              "lineNumber": 38
            },
            "signature": [
              "{ space_id?: string | undefined; session_id?: string | undefined; saved_object?: { type: string; id: string; } | undefined; authentication_provider?: string | undefined; authentication_type?: string | undefined; authentication_realm?: string | undefined; lookup_realm?: string | undefined; add_to_spaces?: readonly string[] | undefined; delete_from_spaces?: readonly string[] | undefined; } | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.AuditEvent.error",
            "type": "Object",
            "label": "error",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_events.ts",
              "lineNumber": 80
            },
            "signature": [
              "{ code?: string | undefined; message?: string | undefined; } | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.AuditEvent.http",
            "type": "Object",
            "label": "http",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_events.ts",
              "lineNumber": 84
            },
            "signature": [
              "{ request?: { method?: string | undefined; } | undefined; } | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.AuditEvent.url",
            "type": "Object",
            "label": "url",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_events.ts",
              "lineNumber": 89
            },
            "signature": [
              "{ domain?: string | undefined; path?: string | undefined; port?: number | undefined; query?: string | undefined; scheme?: string | undefined; } | undefined"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/audit/audit_events.ts",
          "lineNumber": 20
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.AuditLogger",
        "type": "Interface",
        "label": "AuditLogger",
        "description": [],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.AuditLogger.log",
            "type": "Function",
            "label": "log",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_service.ts",
              "lineNumber": 37
            },
            "signature": [
              "(event: ",
              {
                "pluginId": "security",
                "scope": "server",
                "docId": "kibSecurityPluginApi",
                "section": "def-server.AuditEvent",
                "text": "AuditEvent"
              },
              " | undefined) => void"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/audit/audit_service.ts",
          "lineNumber": 36
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.AuthenticatedUser",
        "type": "Interface",
        "label": "AuthenticatedUser",
        "signature": [
          "AuthenticatedUser",
          " extends ",
          "User"
        ],
        "description": [
          "\nRepresents the currently authenticated user."
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.AuthenticatedUser.authentication_realm",
            "type": "Object",
            "label": "authentication_realm",
            "description": [
              "\nThe name and type of the Realm that has authenticated the user."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
              "lineNumber": 25
            },
            "signature": [
              "UserRealm"
            ]
          },
          {
            "tags": [],
            "id": "def-server.AuthenticatedUser.lookup_realm",
            "type": "Object",
            "label": "lookup_realm",
            "description": [
              "\nThe name and type of the Realm where the user information were retrieved from."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
              "lineNumber": 30
            },
            "signature": [
              "UserRealm"
            ]
          },
          {
            "tags": [],
            "id": "def-server.AuthenticatedUser.authentication_provider",
            "type": "Object",
            "label": "authentication_provider",
            "description": [
              "\nThe authentication provider that used to authenticate user."
            ],
            "source": {
              "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
              "lineNumber": 35
            },
            "signature": [
              "AuthenticationProvider"
            ]
          },
          {
            "tags": [],
            "id": "def-server.AuthenticatedUser.authentication_type",
            "type": "string",
            "label": "authentication_type",
            "description": [
              "\nThe AuthenticationType used by ES to authenticate the user.\n"
            ],
            "source": {
              "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
              "lineNumber": 42
            }
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/common/model/authenticated_user.ts",
          "lineNumber": 21
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.CheckPrivilegesPayload",
        "type": "Interface",
        "label": "CheckPrivilegesPayload",
        "description": [],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.CheckPrivilegesPayload.kibana",
            "type": "CompoundType",
            "label": "kibana",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/authorization/types.ts",
              "lineNumber": 71
            },
            "signature": [
              "string | string[] | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.CheckPrivilegesPayload.elasticsearch",
            "type": "Object",
            "label": "elasticsearch",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/authorization/types.ts",
              "lineNumber": 72
            },
            "signature": [
              "{ cluster: string[]; index: Record<string, string[]>; } | undefined"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/authorization/types.ts",
          "lineNumber": 70
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.CreateAPIKeyResult",
        "type": "Interface",
        "label": "CreateAPIKeyResult",
        "description": [
          "\nThe return value when creating an API key in Elasticsearch. The API key returned by this API\ncan then be used by sending a request with a Authorization header with a value having the\nprefix ApiKey `{token}` where token is id and api_key joined by a colon `{id}:{api_key}` and\nthen encoded to base64."
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.CreateAPIKeyResult.id",
            "type": "string",
            "label": "id",
            "description": [
              "\nUnique id for this API key"
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 60
            }
          },
          {
            "tags": [],
            "id": "def-server.CreateAPIKeyResult.name",
            "type": "string",
            "label": "name",
            "description": [
              "\nName for this API key"
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 64
            }
          },
          {
            "tags": [],
            "id": "def-server.CreateAPIKeyResult.expiration",
            "type": "number",
            "label": "expiration",
            "description": [
              "\nOptional expiration in milliseconds for this API key"
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 68
            },
            "signature": [
              "number | undefined"
            ]
          },
          {
            "tags": [],
            "id": "def-server.CreateAPIKeyResult.api_key",
            "type": "string",
            "label": "api_key",
            "description": [
              "\nGenerated API key"
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 72
            }
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
          "lineNumber": 56
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.GrantAPIKeyResult",
        "type": "Interface",
        "label": "GrantAPIKeyResult",
        "description": [],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.GrantAPIKeyResult.id",
            "type": "string",
            "label": "id",
            "description": [
              "\nUnique id for this API key"
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 79
            }
          },
          {
            "tags": [],
            "id": "def-server.GrantAPIKeyResult.name",
            "type": "string",
            "label": "name",
            "description": [
              "\nName for this API key"
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 83
            }
          },
          {
            "tags": [],
            "id": "def-server.GrantAPIKeyResult.api_key",
            "type": "string",
            "label": "api_key",
            "description": [
              "\nGenerated API key"
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 87
            }
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
          "lineNumber": 75
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.InvalidateAPIKeyResult",
        "type": "Interface",
        "label": "InvalidateAPIKeyResult",
        "description": [
          "\nThe return value when invalidating an API key in Elasticsearch."
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.InvalidateAPIKeyResult.invalidated_api_keys",
            "type": "Array",
            "label": "invalidated_api_keys",
            "description": [
              "\nThe IDs of the API keys that were invalidated as part of the request."
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 97
            },
            "signature": [
              "string[]"
            ]
          },
          {
            "tags": [],
            "id": "def-server.InvalidateAPIKeyResult.previously_invalidated_api_keys",
            "type": "Array",
            "label": "previously_invalidated_api_keys",
            "description": [
              "\nThe IDs of the API keys that were already invalidated."
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 101
            },
            "signature": [
              "string[]"
            ]
          },
          {
            "tags": [],
            "id": "def-server.InvalidateAPIKeyResult.error_count",
            "type": "number",
            "label": "error_count",
            "description": [
              "\nThe number of errors that were encountered when invalidating the API keys."
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 105
            }
          },
          {
            "tags": [],
            "id": "def-server.InvalidateAPIKeyResult.error_details",
            "type": "Array",
            "label": "error_details",
            "description": [
              "\nDetails about these errors. This field is not present in the response when error_count is 0."
            ],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 109
            },
            "signature": [
              "{ type: string; reason: string; caused_by?: { type: string; reason: string; } | undefined; }[] | undefined"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
          "lineNumber": 93
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.InvalidateAPIKeysParams",
        "type": "Interface",
        "label": "InvalidateAPIKeysParams",
        "description": [
          "\nRepresents the params for invalidating multiple API keys"
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.InvalidateAPIKeysParams.ids",
            "type": "Array",
            "label": "ids",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
              "lineNumber": 47
            },
            "signature": [
              "string[]"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts",
          "lineNumber": 46
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.LegacyAuditLogger",
        "type": "Interface",
        "label": "LegacyAuditLogger",
        "description": [],
        "tags": [
          "deprecated"
        ],
        "children": [
          {
            "tags": [],
            "id": "def-server.LegacyAuditLogger.log",
            "type": "Function",
            "label": "log",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/audit/audit_service.ts",
              "lineNumber": 33
            },
            "signature": [
              "(eventType: string, message: string, data?: Record<string, any> | undefined) => void"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/audit/audit_service.ts",
          "lineNumber": 32
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.SecurityPluginSetup",
        "type": "Interface",
        "label": "SecurityPluginSetup",
        "description": [
          "\nDescribes public Security plugin contract returned at the `setup` stage."
        ],
        "tags": [],
        "children": [
          {
            "tags": [
              "deprecated"
            ],
            "id": "def-server.SecurityPluginSetup.authc",
            "type": "Object",
            "label": "authc",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/plugin.ts",
              "lineNumber": 73
            },
            "signature": [
              "{ getCurrentUser: (request: ",
              {
                "pluginId": "core",
                "scope": "server",
                "docId": "kibCoreHttpPluginApi",
                "section": "def-server.KibanaRequest",
                "text": "KibanaRequest"
              },
              "<unknown, unknown, unknown, any>) => ",
              "AuthenticatedUser",
              " | null; }"
            ]
          },
          {
            "tags": [
              "deprecated"
            ],
            "id": "def-server.SecurityPluginSetup.authz",
            "type": "Object",
            "label": "authz",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/plugin.ts",
              "lineNumber": 77
            },
            "signature": [
              "Pick<",
              "AuthorizationServiceSetup",
              ", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">"
            ]
          },
          {
            "tags": [],
            "id": "def-server.SecurityPluginSetup.license",
            "type": "Object",
            "label": "license",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/plugin.ts",
              "lineNumber": 81
            },
            "signature": [
              "SecurityLicense"
            ]
          },
          {
            "tags": [],
            "id": "def-server.SecurityPluginSetup.audit",
            "type": "Object",
            "label": "audit",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/plugin.ts",
              "lineNumber": 82
            },
            "signature": [
              "AuditServiceSetup"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/plugin.ts",
          "lineNumber": 69
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.SecurityPluginStart",
        "type": "Interface",
        "label": "SecurityPluginStart",
        "description": [
          "\nDescribes public Security plugin contract returned at the `start` stage."
        ],
        "tags": [],
        "children": [
          {
            "tags": [],
            "id": "def-server.SecurityPluginStart.authc",
            "type": "Object",
            "label": "authc",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/plugin.ts",
              "lineNumber": 89
            },
            "signature": [
              "Pick<",
              "AuthenticationServiceStart",
              ", \"apiKeys\" | \"getCurrentUser\">"
            ]
          },
          {
            "tags": [],
            "id": "def-server.SecurityPluginStart.authz",
            "type": "Object",
            "label": "authz",
            "description": [],
            "source": {
              "path": "x-pack/plugins/security/server/plugin.ts",
              "lineNumber": 90
            },
            "signature": [
              "Pick<",
              "AuthorizationServiceSetup",
              ", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">"
            ]
          }
        ],
        "source": {
          "path": "x-pack/plugins/security/server/plugin.ts",
          "lineNumber": 88
        },
        "initialIsOpen": false
      }
    ],
    "enums": [
      {
        "id": "def-server.EventCategory",
        "type": "Enum",
        "label": "EventCategory",
        "tags": [],
        "description": [],
        "source": {
          "path": "x-pack/plugins/security/server/audit/audit_events.ts",
          "lineNumber": 98
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.EventOutcome",
        "type": "Enum",
        "label": "EventOutcome",
        "tags": [],
        "description": [],
        "source": {
          "path": "x-pack/plugins/security/server/audit/audit_events.ts",
          "lineNumber": 111
        },
        "initialIsOpen": false
      },
      {
        "id": "def-server.EventType",
        "type": "Enum",
        "label": "EventType",
        "tags": [],
        "description": [],
        "source": {
          "path": "x-pack/plugins/security/server/audit/audit_events.ts",
          "lineNumber": 104
        },
        "initialIsOpen": false
      }
    ],
    "misc": [],
    "objects": []
  },
  "common": {
    "classes": [],
    "functions": [],
    "interfaces": [],
    "enums": [],
    "misc": [],
    "objects": []
  }
}