2021-03-03 04:02:17 +01:00
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 25
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.UserRealm" ,
"text" : "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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.UserRealm" ,
"text" : "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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 35
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.AuthenticationProvider" ,
"text" : "AuthenticationProvider"
}
]
} ,
{
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 42
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/security/common/model/authenticated_user.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 17
2021-03-03 04:02:17 +01:00
}
} ,
{
"id" : "def-public.SecurityLicense.getFeatures" ,
"type" : "Function" ,
"label" : "getFeatures" ,
"signature" : [
"() => " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.SecurityLicenseFeatures" ,
"text" : "SecurityLicenseFeatures"
}
] ,
"description" : [ ] ,
"children" : [ ] ,
"tags" : [ ] ,
"returnComment" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 18
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.SecurityLicense.features$" ,
"type" : "Object" ,
"label" : "features$" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 19
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Observable" ,
"<" ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.SecurityLicenseFeatures" ,
"text" : "SecurityLicenseFeatures"
} ,
">"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 14
2021-03-03 04:02:17 +01:00
} ,
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 25
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 35
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 40
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 45
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 51
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 56
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 61
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 66
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 71
2021-03-03 04:02:17 +01:00
}
} ,
{
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 76
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"\"form\" | \"error-es-unavailable\" | \"error-xpack-unavailable\" | undefined"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_features.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 16
2021-03-03 04:02:17 +01:00
} ,
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.UserMenuLink.iconType" ,
"type" : "CompoundType" ,
"label" : "iconType" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
} ,
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
"id" : "def-public.UserMenuLink.order" ,
"type" : "number" ,
"label" : "order" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 32
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"number | undefined"
]
2021-03-11 20:29:40 +01:00
} ,
{
"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" : 33
} ,
"signature" : [
"boolean | undefined"
]
2021-03-03 04:02:17 +01:00
}
] ,
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 28
2021-03-03 04:02:17 +01:00
} ,
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 168
2021-03-03 04:02:17 +01:00
} ,
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 169
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ navControlService: " ,
"SecurityNavControlServiceStart" ,
"; }"
] ,
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditEvent" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "AuditEvent" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\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"
2021-03-03 04:02:17 +01:00
] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditEvent.message" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-03-06 02:12:28 +01:00
"label" : "message" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nHuman readable message describing action, outcome and user.\n"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/audit/audit_events.ts" ,
"lineNumber" : 27
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditEvent.event" ,
"type" : "Object" ,
"label" : "event" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"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; }"
]
2021-03-03 04:02:17 +01:00
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditEvent.user" ,
"type" : "Object" ,
"label" : "user" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/audit/audit_events.ts" ,
"lineNumber" : 34
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"{ name: string; roles?: readonly string[] | undefined; } | undefined"
2021-03-03 04:02:17 +01:00
]
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditEvent.kibana" ,
"type" : "Object" ,
"label" : "kibana" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"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"
]
2021-03-03 04:02:17 +01:00
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/audit/audit_events.ts" ,
"lineNumber" : 20
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditLogger" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "AuditLogger" ,
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditLogger.log" ,
"type" : "Function" ,
"label" : "log" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/audit/audit_service.ts" ,
"lineNumber" : 37
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"(event: " ,
{
"pluginId" : "security" ,
"scope" : "server" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-server.AuditEvent" ,
"text" : "AuditEvent"
} ,
" | undefined) => void"
2021-03-03 04:02:17 +01:00
]
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/audit/audit_service.ts" ,
"lineNumber" : 36
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "AuthenticatedUser" ,
"signature" : [
"AuthenticatedUser" ,
" extends " ,
"User"
] ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nRepresents the currently authenticated user."
2021-03-03 04:02:17 +01:00
] ,
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser.authentication_realm" ,
"type" : "Object" ,
"label" : "authentication_realm" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe name and type of the Realm that has authenticated the user."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/common/model/authenticated_user.ts" ,
"lineNumber" : 25
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.UserRealm" ,
"text" : "UserRealm"
}
2021-03-03 04:02:17 +01:00
]
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser.lookup_realm" ,
"type" : "Object" ,
"label" : "lookup_realm" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe name and type of the Realm where the user information were retrieved from."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/common/model/authenticated_user.ts" ,
"lineNumber" : 30
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.UserRealm" ,
"text" : "UserRealm"
}
2021-03-03 04:02:17 +01:00
]
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser.authentication_provider" ,
"type" : "Object" ,
"label" : "authentication_provider" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe authentication provider that used to authenticate user."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/common/model/authenticated_user.ts" ,
"lineNumber" : 35
} ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.AuthenticationProvider" ,
"text" : "AuthenticationProvider"
}
]
2021-03-03 04:02:17 +01:00
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser.authentication_type" ,
"type" : "string" ,
"label" : "authentication_type" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe AuthenticationType used by ES to authenticate the user.\n"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/common/model/authenticated_user.ts" ,
"lineNumber" : 42
}
2021-03-03 04:02:17 +01:00
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/common/model/authenticated_user.ts" ,
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.CreateAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"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."
] ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.CreateAPIKeyResult.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "id" ,
"description" : [
"\nUnique id for this API key"
] ,
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 60
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.CreateAPIKeyResult.name" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "name" ,
"description" : [
"\nName for this API key"
] ,
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 64
2021-03-03 04:02:17 +01:00
}
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
"label" : "api_key" ,
"description" : [
"\nGenerated API key"
] ,
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 72
2021-03-03 04:02:17 +01:00
}
}
] ,
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 56
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.GrantAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "GrantAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"children" : [
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.GrantAPIKeyResult.id" ,
"type" : "string" ,
"label" : "id" ,
"description" : [
"\nUnique id for this API key"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
"lineNumber" : 79
}
} ,
2021-03-03 04:02:17 +01:00
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.GrantAPIKeyResult.name" ,
"type" : "string" ,
"label" : "name" ,
"description" : [
"\nName for this API key"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"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
}
2021-03-03 04:02:17 +01:00
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
"lineNumber" : 75
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-03-06 02:12:28 +01:00
"label" : "InvalidateAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe return value when invalidating an API key in Elasticsearch."
2021-03-03 04:02:17 +01:00
] ,
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-03-06 02:12:28 +01:00
"tags" : [ ] ,
"id" : "def-server.InvalidateAPIKeyResult.invalidated_api_keys" ,
"type" : "Array" ,
"label" : "invalidated_api_keys" ,
2021-03-03 04:02:17 +01:00
"description" : [
2021-03-06 02:12:28 +01:00
"\nThe IDs of the API keys that were invalidated as part of the request."
2021-03-03 04:02:17 +01:00
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
"lineNumber" : 97
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"string[]"
2021-03-03 04:02:17 +01:00
]
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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."
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
"lineNumber" : 101
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"string[]"
2021-03-03 04:02:17 +01:00
]
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeyResult.error_count" ,
"type" : "number" ,
"label" : "error_count" ,
"description" : [
"\nThe number of errors that were encountered when invalidating the API keys."
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
"lineNumber" : 105
}
2021-03-03 04:02:17 +01:00
} ,
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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."
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
"lineNumber" : 109
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-30 14:27:28 +02:00
"{ type: string; reason: string; caused_by?: { type: string; reason: string; } | undefined; }[] | undefined"
2021-03-03 04:02:17 +01:00
]
2021-03-06 02:12:28 +01:00
}
] ,
"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" : [
2021-03-03 04:02:17 +01:00
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeysParams.ids" ,
"type" : "Array" ,
"label" : "ids" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
"lineNumber" : 47
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"string[]"
2021-03-03 04:02:17 +01:00
]
2021-03-06 02:12:28 +01:00
}
] ,
"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" : [
2021-03-03 04:02:17 +01:00
{
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.LegacyAuditLogger.log" ,
"type" : "Function" ,
"label" : "log" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/audit/audit_service.ts" ,
"lineNumber" : 33
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
2021-03-06 02:12:28 +01:00
"(eventType: string, message: string, data?: Record<string, any> | undefined) => void"
2021-03-03 04:02:17 +01:00
]
}
] ,
"source" : {
2021-03-06 02:12:28 +01:00
"path" : "x-pack/plugins/security/server/audit/audit_service.ts" ,
"lineNumber" : 32
2021-03-03 04:02:17 +01:00
} ,
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 73
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"{ getCurrentUser: (request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => " ,
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.AuthenticatedUser" ,
"text" : "AuthenticatedUser"
} ,
" | null; }"
]
} ,
{
"tags" : [
"deprecated"
] ,
"id" : "def-server.SecurityPluginSetup.authz" ,
"type" : "Object" ,
"label" : "authz" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 77
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Pick<" ,
{
"pluginId" : "security" ,
"scope" : "server" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-server.AuthorizationServiceSetup" ,
"text" : "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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 81
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "common" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-common.SecurityLicense" ,
"text" : "SecurityLicense"
}
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.SecurityPluginSetup.audit" ,
"type" : "Object" ,
"label" : "audit" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 82
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
{
"pluginId" : "security" ,
"scope" : "server" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-server.AuditServiceSetup" ,
"text" : "AuditServiceSetup"
}
]
}
] ,
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 69
2021-03-03 04:02:17 +01:00
} ,
"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" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 89
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Pick<" ,
{
"pluginId" : "security" ,
"scope" : "server" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-server.AuthenticationServiceStart" ,
"text" : "AuthenticationServiceStart"
} ,
", \"apiKeys\" | \"getCurrentUser\">"
]
} ,
{
"tags" : [ ] ,
"id" : "def-server.SecurityPluginStart.authz" ,
"type" : "Object" ,
"label" : "authz" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 90
2021-03-03 04:02:17 +01:00
} ,
"signature" : [
"Pick<" ,
{
"pluginId" : "security" ,
"scope" : "server" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-server.AuthorizationServiceSetup" ,
"text" : "AuthorizationServiceSetup"
} ,
", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">"
]
}
] ,
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 88
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"enums" : [
{
"id" : "def-server.EventCategory" ,
"type" : "Enum" ,
"label" : "EventCategory" ,
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/server/audit/audit_events.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 98
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.EventOutcome" ,
2021-03-03 04:02:17 +01:00
"type" : "Enum" ,
2021-03-06 02:12:28 +01:00
"label" : "EventOutcome" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/server/audit/audit_events.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 111
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
} ,
{
2021-03-06 02:12:28 +01:00
"id" : "def-server.EventType" ,
2021-03-03 04:02:17 +01:00
"type" : "Enum" ,
2021-03-06 02:12:28 +01:00
"label" : "EventType" ,
2021-03-03 04:02:17 +01:00
"tags" : [ ] ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/server/audit/audit_events.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 104
2021-03-03 04:02:17 +01:00
} ,
"initialIsOpen" : false
}
] ,
"misc" : [ ] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}