2021-03-03 04:02:17 +01:00
{
"id" : "security" ,
"client" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.AuthenticatedUser" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "AuthenticatedUser" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nRepresents the currently authenticated user."
] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"AuthenticatedUser" ,
" extends " ,
"User"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/common/model/authenticated_user.ts" ,
"lineNumber" : 21
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.AuthenticatedUser.authentication_realm" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "authentication_realm" ,
"description" : [
"\nThe name and type of the Realm that has authenticated the user."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"UserRealm"
] ,
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" : 25
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.AuthenticatedUser.lookup_realm" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "lookup_realm" ,
"description" : [
"\nThe name and type of the Realm where the user information were retrieved from."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"UserRealm"
] ,
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" : 30
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.AuthenticatedUser.authentication_provider" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "authentication_provider" ,
"description" : [
"\nThe authentication provider that used to authenticate user."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"AuthenticationProvider"
] ,
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" : 35
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.AuthenticatedUser.authentication_type" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicense" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "SecurityLicense" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
"lineNumber" : 14
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicense.isLicenseAvailable" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "isLicenseAvailable" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"() => boolean"
] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 15
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicense.isEnabled" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "isEnabled" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"() => boolean"
] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 16
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicense.getType" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getType" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"() => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined"
] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 17
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicense.getFeatures" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "getFeatures" ,
2021-05-06 21:29:47 +02:00
"description" : [ ] ,
2021-03-03 04:02:17 +01:00
"signature" : [
"() => " ,
2021-04-15 17:36:10 +02:00
"SecurityLicenseFeatures"
2021-03-03 04:02:17 +01:00
] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
2021-03-06 02:12:28 +01:00
"lineNumber" : 18
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
"children" : [ ] ,
"returnComment" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicense.features$" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "features$" ,
"description" : [ ] ,
"signature" : [
"Observable" ,
"<" ,
2021-04-15 17:36:10 +02:00
"SecurityLicenseFeatures" ,
2021-03-03 04:02:17 +01:00
">"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_service.ts" ,
"lineNumber" : 19
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "SecurityLicenseFeatures" ,
"description" : [
"\nDescribes Security plugin features that depend on license."
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/common/licensing/license_features.ts" ,
"lineNumber" : 16
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.showLogin" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.allowLogin" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.showLinks" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.showRoleMappingsManagement" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.allowAccessAgreement" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.allowAuditLogging" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
"id" : "def-public.SecurityLicenseFeatures.allowLegacyAuditLogging" ,
"type" : "boolean" ,
2021-03-03 04:02:17 +01:00
"tags" : [
"deprecated"
] ,
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : true ,
"references" : [ ]
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.allowRoleDocumentLevelSecurity" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.allowRoleFieldLevelSecurity" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.allowRbac" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.allowSubFeaturePrivileges" ,
"type" : "boolean" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityLicenseFeatures.layout" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "layout" ,
"description" : [
"\nDescribes the layout of the login form if it's displayed."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"form\" | \"error-es-unavailable\" | \"error-xpack-unavailable\" | undefined"
] ,
2021-03-03 04:02:17 +01:00
"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
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UserMenuLink" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "UserMenuLink" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
"lineNumber" : 27
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UserMenuLink.label" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "label" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
2021-04-15 17:36:10 +02:00
"lineNumber" : 28
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UserMenuLink.iconType" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "iconType" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 21:02:57 +02:00
"IconType"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
2021-04-15 17:36:10 +02:00
"lineNumber" : 29
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UserMenuLink.href" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "href" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
2021-04-15 17:36:10 +02:00
"lineNumber" : 30
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.UserMenuLink.order" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "order" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"number | undefined"
] ,
2021-03-03 04:02:17 +01:00
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
2021-04-15 17:36:10 +02:00
"lineNumber" : 31
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-11 20:29:40 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-11 20:29:40 +01:00
"id" : "def-public.UserMenuLink.setAsProfile" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-11 20:29:40 +01:00
"label" : "setAsProfile" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"boolean | undefined"
] ,
2021-03-11 20:29:40 +01:00
"source" : {
"path" : "x-pack/plugins/security/public/nav_control/nav_control_component.tsx" ,
2021-04-15 17:36:10 +02:00
"lineNumber" : 32
2021-03-11 20:29:40 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ] ,
"setup" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityPluginSetup" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "SecurityPluginSetup" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"signature" : [
2021-06-07 21:02:57 +02:00
"{ authc: AuthenticationServiceSetup; sessionTimeout: SessionTimeout; license: Readonly<{ isLicenseAvailable: () => boolean; isEnabled: () => boolean; getType: () => \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\" | undefined; getFeatures: () => " ,
2021-03-03 04:02:17 +01:00
"SecurityLicenseFeatures" ,
"; features$: " ,
"Observable" ,
"<" ,
"SecurityLicenseFeatures" ,
">; }>; __legacyCompat: { logoutUrl: string; tenant: string; }; }"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/public/plugin.tsx" ,
2021-05-20 19:22:41 +02:00
"lineNumber" : 164
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"lifecycle" : "setup" ,
"initialIsOpen" : true
} ,
"start" : {
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-public.SecurityPluginStart" ,
"type" : "Type" ,
"tags" : [ ] ,
2021-05-06 21:29:47 +02:00
"label" : "SecurityPluginStart" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"signature" : [
"{ navControlService: " ,
"SecurityNavControlServiceStart" ,
2021-06-07 21:02:57 +02:00
"; authc: AuthenticationServiceSetup; }"
2021-03-03 04:02:17 +01:00
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/public/plugin.tsx" ,
2021-05-20 19:22:41 +02:00
"lineNumber" : 165
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"lifecycle" : "start" ,
"initialIsOpen" : true
}
} ,
"server" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditEvent" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "AuditEvent" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nAudit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.9/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"
] ,
2021-05-06 19:09:09 +02:00
"signature" : [
{
"pluginId" : "security" ,
"scope" : "server" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-server.AuditEvent" ,
"text" : "AuditEvent"
} ,
" extends " ,
"LogMeta"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/audit/audit_events.ts" ,
"lineNumber" : 20
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditEvent.message" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "message" ,
"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" ,
2021-05-06 19:09:09 +02:00
"lineNumber" : 21
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditEvent.kibana" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "kibana" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"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"
] ,
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" ,
2021-05-06 19:09:09 +02:00
"lineNumber" : 22
2021-03-06 02:12:28 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditLogger" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "AuditLogger" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/audit/audit_service.ts" ,
"lineNumber" : 36
} ,
"deprecated" : false ,
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuditLogger.log" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "log" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
"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-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/security/server/audit/audit_service.ts" ,
"lineNumber" : 37
} ,
2021-06-07 21:02:57 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "AuthenticatedUser" ,
2021-05-06 21:29:47 +02:00
"description" : [
"\nRepresents the currently authenticated user."
] ,
2021-03-06 02:12:28 +01:00
"signature" : [
"AuthenticatedUser" ,
" extends " ,
"User"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/common/model/authenticated_user.ts" ,
"lineNumber" : 21
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser.authentication_realm" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"UserRealm"
] ,
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
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser.lookup_realm" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"UserRealm"
] ,
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
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser.authentication_provider" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"AuthenticationProvider"
] ,
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
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.AuthenticatedUser.authentication_type" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
2021-04-15 17:36:10 +02:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.CheckPrivilegesPayload" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-04-15 17:36:10 +02:00
"label" : "CheckPrivilegesPayload" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/authorization/types.ts" ,
"lineNumber" : 70
} ,
"deprecated" : false ,
2021-04-15 17:36:10 +02:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.CheckPrivilegesPayload.kibana" ,
"type" : "CompoundType" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-04-15 17:36:10 +02:00
"label" : "kibana" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string | string[] | undefined"
] ,
2021-04-15 17:36:10 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/authorization/types.ts" ,
"lineNumber" : 71
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-04-15 17:36:10 +02:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-04-15 17:36:10 +02:00
"id" : "def-server.CheckPrivilegesPayload.elasticsearch" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-04-15 17:36:10 +02:00
"label" : "elasticsearch" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"{ cluster: string[]; index: Record<string, string[]>; } | undefined"
] ,
2021-04-15 17:36:10 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/authorization/types.ts" ,
"lineNumber" : 72
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-04-15 17:36:10 +02:00
}
] ,
"initialIsOpen" : false
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.CreateAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 62
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.CreateAPIKeyResult.id" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "id" ,
"description" : [
"\nUnique id for this API key"
] ,
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 66
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.CreateAPIKeyResult.name" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "name" ,
"description" : [
"\nName for this API key"
] ,
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 70
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.CreateAPIKeyResult.expiration" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "expiration" ,
"description" : [
"\nOptional expiration in milliseconds for this API key"
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"number | undefined"
] ,
2021-03-06 02:12:28 +01:00
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 74
2021-03-06 02:12:28 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.CreateAPIKeyResult.api_key" ,
2021-03-03 04:02:17 +01:00
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "api_key" ,
"description" : [
"\nGenerated API key"
] ,
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 78
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.GrantAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "GrantAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 81
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.GrantAPIKeyResult.id" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 85
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-06 02:12:28 +01:00
} ,
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.GrantAPIKeyResult.name" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 89
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-06 02:12:28 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.GrantAPIKeyResult.api_key" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "api_key" ,
"description" : [
"\nGenerated API key"
] ,
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 93
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeyResult" ,
2021-03-03 04:02:17 +01:00
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
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-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 99
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeyResult.invalidated_api_keys" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string[]"
] ,
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" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 103
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeyResult.previously_invalidated_api_keys" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "previously_invalidated_api_keys" ,
"description" : [
"\nThe IDs of the API keys that were already invalidated."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string[]"
] ,
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" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 107
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeyResult.error_count" ,
"type" : "number" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"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" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 111
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeyResult.error_details" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "error_details" ,
"description" : [
"\nDetails about these errors. This field is not present in the response when error_count is 0."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"{ type: string; reason: string; caused_by?: { type: string; reason: 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/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 115
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeysParams" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "InvalidateAPIKeysParams" ,
"description" : [
"\nRepresents the params for invalidating multiple API keys"
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/authentication/api_keys/api_keys.ts" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 52
2021-05-06 21:29:47 +02:00
} ,
"deprecated" : false ,
2021-03-06 02:12:28 +01:00
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.InvalidateAPIKeysParams.ids" ,
"type" : "Array" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "ids" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"string[]"
] ,
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" ,
2021-06-07 21:02:57 +02:00
"lineNumber" : 53
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-06 02:12:28 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.LegacyAuditLogger" ,
"type" : "Interface" ,
"tags" : [
"deprecated"
] ,
2021-05-06 21:29:47 +02:00
"label" : "LegacyAuditLogger" ,
"description" : [ ] ,
"source" : {
"path" : "x-pack/plugins/security/server/audit/audit_service.ts" ,
"lineNumber" : 32
} ,
"deprecated" : true ,
"references" : [
{
"plugin" : "encryptedSavedObjects" ,
"link" : {
"path" : "x-pack/plugins/encrypted_saved_objects/server/audit/audit_logger.ts" ,
"lineNumber" : 8
}
} ,
{
"plugin" : "encryptedSavedObjects" ,
"link" : {
"path" : "x-pack/plugins/encrypted_saved_objects/server/audit/audit_logger.ts" ,
"lineNumber" : 16
}
} ,
{
"plugin" : "actions" ,
"link" : {
"path" : "x-pack/plugins/actions/server/authorization/audit_logger.ts" ,
"lineNumber" : 8
}
} ,
{
"plugin" : "actions" ,
"link" : {
"path" : "x-pack/plugins/actions/server/authorization/audit_logger.ts" ,
"lineNumber" : 16
}
} ,
{
"plugin" : "actions" ,
"link" : {
"path" : "x-pack/plugins/actions/server/authorization/audit_logger.ts" ,
"lineNumber" : 18
}
} ,
{
"plugin" : "alerting" ,
"link" : {
"path" : "x-pack/plugins/alerting/server/authorization/audit_logger.ts" ,
"lineNumber" : 8
}
} ,
{
"plugin" : "alerting" ,
"link" : {
"path" : "x-pack/plugins/alerting/server/authorization/audit_logger.ts" ,
"lineNumber" : 21
}
} ,
{
"plugin" : "alerting" ,
"link" : {
"path" : "x-pack/plugins/alerting/server/authorization/audit_logger.ts" ,
"lineNumber" : 23
}
} ,
{
"plugin" : "alerting" ,
"link" : {
"path" : "x-pack/plugins/alerting/server/alerts_client_factory.test.ts" ,
2021-05-20 19:22:41 +02:00
"lineNumber" : 23
2021-05-06 21:29:47 +02:00
}
} ,
{
"plugin" : "alerting" ,
"link" : {
"path" : "x-pack/plugins/alerting/server/alerts_client_factory.test.ts" ,
2021-05-20 19:22:41 +02:00
"lineNumber" : 98
2021-05-06 21:29:47 +02:00
}
}
] ,
2021-03-06 02:12:28 +01:00
"children" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-06 02:12:28 +01:00
"id" : "def-server.LegacyAuditLogger.log" ,
"type" : "Function" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-06 02:12:28 +01:00
"label" : "log" ,
2021-03-03 04:02:17 +01:00
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"(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" : 33
2021-03-03 04:02:17 +01:00
} ,
2021-06-07 21:02:57 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.SecurityPluginSetup" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "SecurityPluginSetup" ,
"description" : [
"\nDescribes public Security plugin contract returned at the `setup` stage."
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
"lineNumber" : 69
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
"id" : "def-server.SecurityPluginSetup.authc" ,
"type" : "Object" ,
2021-03-03 04:02:17 +01:00
"tags" : [
"deprecated"
] ,
"label" : "authc" ,
"description" : [ ] ,
"signature" : [
"{ getCurrentUser: (request: " ,
{
"pluginId" : "core" ,
"scope" : "server" ,
"docId" : "kibCoreHttpPluginApi" ,
"section" : "def-server.KibanaRequest" ,
"text" : "KibanaRequest"
} ,
"<unknown, unknown, unknown, any>) => " ,
2021-04-15 17:36:10 +02:00
"AuthenticatedUser" ,
2021-03-03 04:02:17 +01:00
" | null; }"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
"lineNumber" : 73
} ,
"deprecated" : true ,
"references" : [
{
"plugin" : "reporting" ,
"link" : {
"path" : "x-pack/plugins/reporting/server/routes/lib/get_user.ts" ,
"lineNumber" : 13
}
} ,
{
"plugin" : "encryptedSavedObjects" ,
"link" : {
"path" : "x-pack/plugins/encrypted_saved_objects/server/crypto/encryption_key_rotation_service.ts" ,
"lineNumber" : 107
}
} ,
{
"plugin" : "encryptedSavedObjects" ,
"link" : {
"path" : "x-pack/plugins/encrypted_saved_objects/server/saved_objects/index.ts" ,
"lineNumber" : 67
}
} ,
{
"plugin" : "actions" ,
"link" : {
"path" : "x-pack/plugins/actions/server/plugin.ts" ,
"lineNumber" : 444
}
} ,
{
2021-05-20 19:22:41 +02:00
"plugin" : "ml" ,
2021-05-06 21:29:47 +02:00
"link" : {
2021-05-20 19:22:41 +02:00
"path" : "x-pack/plugins/ml/server/routes/annotations.ts" ,
"lineNumber" : 105
2021-05-06 21:29:47 +02:00
}
} ,
{
2021-05-27 11:30:15 +02:00
"plugin" : "dashboardMode" ,
2021-05-06 21:29:47 +02:00
"link" : {
2021-05-27 11:30:15 +02:00
"path" : "x-pack/plugins/dashboard_mode/server/interceptors/dashboard_mode_request_interceptor.ts" ,
"lineNumber" : 33
2021-05-06 21:29:47 +02:00
}
} ,
{
2021-05-27 11:30:15 +02:00
"plugin" : "dataEnhanced" ,
2021-05-06 21:29:47 +02:00
"link" : {
2021-05-27 11:30:15 +02:00
"path" : "x-pack/plugins/data_enhanced/server/search/session/session_service.ts" ,
"lineNumber" : 448
2021-05-06 21:29:47 +02:00
}
} ,
{
2021-05-27 11:30:15 +02:00
"plugin" : "logstash" ,
2021-05-06 21:29:47 +02:00
"link" : {
2021-05-27 11:30:15 +02:00
"path" : "x-pack/plugins/logstash/server/routes/pipeline/save.ts" ,
"lineNumber" : 41
2021-05-06 21:29:47 +02:00
}
} ,
{
2021-05-27 11:30:15 +02:00
"plugin" : "securitySolution" ,
2021-05-06 21:29:47 +02:00
"link" : {
2021-05-27 11:30:15 +02:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/create_signals_migration_route.ts" ,
"lineNumber" : 48
2021-05-06 21:29:47 +02:00
}
} ,
{
2021-05-27 11:30:15 +02:00
"plugin" : "securitySolution" ,
2021-05-06 21:29:47 +02:00
"link" : {
2021-05-27 11:30:15 +02:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/delete_signals_migration_route.ts" ,
"lineNumber" : 45
2021-05-06 21:29:47 +02:00
}
} ,
{
2021-05-27 11:30:15 +02:00
"plugin" : "securitySolution" ,
2021-05-06 21:29:47 +02:00
"link" : {
2021-05-27 11:30:15 +02:00
"path" : "x-pack/plugins/security_solution/server/lib/detection_engine/routes/signals/finalize_signals_migration_route.ts" ,
"lineNumber" : 45
2021-05-06 21:29:47 +02:00
}
2021-05-20 19:22:41 +02:00
} ,
{
"plugin" : "securitySolution" ,
"link" : {
"path" : "x-pack/plugins/security_solution/server/lib/timeline/utils/common.ts" ,
"lineNumber" : 28
}
2021-05-06 21:29:47 +02:00
}
2021-03-03 04:02:17 +01:00
]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
"id" : "def-server.SecurityPluginSetup.authz" ,
"type" : "Object" ,
2021-03-03 04:02:17 +01:00
"tags" : [
"deprecated"
] ,
"label" : "authz" ,
"description" : [ ] ,
"signature" : [
2021-06-07 21:02:57 +02:00
"Pick<" ,
{
"pluginId" : "security" ,
"scope" : "server" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-server.AuthorizationServiceSetup" ,
"text" : "AuthorizationServiceSetup"
} ,
", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
"lineNumber" : 77
} ,
"deprecated" : true ,
"references" : [
{
"plugin" : "actions" ,
"link" : {
"path" : "x-pack/plugins/actions/server/plugin.ts" ,
"lineNumber" : 443
}
} ,
{
"plugin" : "ml" ,
"link" : {
"path" : "x-pack/plugins/ml/server/saved_objects/initialization/initialization.ts" ,
"lineNumber" : 54
}
} ,
{
"plugin" : "ml" ,
"link" : {
"path" : "x-pack/plugins/ml/server/plugin.ts" ,
"lineNumber" : 153
}
} ,
{
"plugin" : "ml" ,
"link" : {
"path" : "x-pack/plugins/ml/server/plugin.ts" ,
"lineNumber" : 203
}
} ,
{
"plugin" : "enterpriseSearch" ,
"link" : {
"path" : "x-pack/plugins/enterprise_search/server/lib/check_access.ts" ,
"lineNumber" : 46
}
} ,
{
"plugin" : "enterpriseSearch" ,
"link" : {
"path" : "x-pack/plugins/enterprise_search/server/lib/check_access.ts" ,
"lineNumber" : 86
}
} ,
{
"plugin" : "enterpriseSearch" ,
"link" : {
"path" : "x-pack/plugins/enterprise_search/server/lib/check_access.ts" ,
"lineNumber" : 88
}
} ,
{
"plugin" : "savedObjectsTagging" ,
"link" : {
"path" : "x-pack/plugins/saved_objects_tagging/server/request_handler_context.ts" ,
"lineNumber" : 37
}
}
2021-03-03 04:02:17 +01:00
]
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.SecurityPluginSetup.license" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "license" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"SecurityLicense"
] ,
2021-03-03 04:02:17 +01:00
"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
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.SecurityPluginSetup.audit" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "audit" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"AuditServiceSetup"
] ,
2021-03-03 04:02:17 +01:00
"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
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.SecurityPluginStart" ,
"type" : "Interface" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "SecurityPluginStart" ,
"description" : [
"\nDescribes public Security plugin contract returned at the `start` stage."
] ,
2021-05-06 21:29:47 +02:00
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
"lineNumber" : 88
} ,
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"children" : [
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.SecurityPluginStart.authc" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "authc" ,
"description" : [ ] ,
2021-05-06 21:29:47 +02:00
"signature" : [
2021-06-07 21:02:57 +02:00
"Pick<" ,
"AuthenticationServiceStart" ,
", \"getCurrentUser\" | \"apiKeys\">"
2021-05-06 21:29:47 +02:00
] ,
2021-03-03 04:02:17 +01:00
"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
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false
2021-03-03 04:02:17 +01:00
} ,
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-03-03 04:02:17 +01:00
"id" : "def-server.SecurityPluginStart.authz" ,
"type" : "Object" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-03-03 04:02:17 +01:00
"label" : "authz" ,
"description" : [ ] ,
"signature" : [
2021-06-07 21:02:57 +02:00
"Pick<" ,
{
"pluginId" : "security" ,
"scope" : "server" ,
"docId" : "kibSecurityPluginApi" ,
"section" : "def-server.AuthorizationServiceSetup" ,
"text" : "AuthorizationServiceSetup"
} ,
", \"mode\" | \"actions\" | \"checkPrivilegesDynamicallyWithRequest\" | \"checkPrivilegesWithRequest\">"
2021-05-06 21:29:47 +02:00
] ,
"source" : {
"path" : "x-pack/plugins/security/server/plugin.ts" ,
"lineNumber" : 90
} ,
"deprecated" : false
2021-03-03 04:02:17 +01:00
}
] ,
"initialIsOpen" : false
}
] ,
2021-05-06 19:09:09 +02:00
"enums" : [ ] ,
"misc" : [
2021-03-03 04:02:17 +01:00
{
2021-05-06 21:29:47 +02:00
"parentPluginId" : "security" ,
2021-05-20 19:22:41 +02:00
"id" : "def-server.AuthorizationServiceSetup" ,
"type" : "Type" ,
"tags" : [ ] ,
"label" : "AuthorizationServiceSetup" ,
"description" : [ ] ,
"signature" : [
"{ mode: " ,
"AuthorizationMode" ,
"; actions: " ,
"Actions" ,
"; checkPrivilegesDynamicallyWithRequest: " ,
"CheckPrivilegesDynamicallyWithRequest" ,
"; checkPrivilegesWithRequest: " ,
"CheckPrivilegesWithRequest" ,
"; }"
] ,
"source" : {
"path" : "x-pack/plugins/security/server/index.ts" ,
"lineNumber" : 30
} ,
"deprecated" : false ,
"initialIsOpen" : false
} ,
{
"parentPluginId" : "security" ,
2021-05-06 19:09:09 +02:00
"id" : "def-server.ROUTE_TAG_CAN_REDIRECT" ,
"type" : "string" ,
2021-05-06 21:29:47 +02:00
"tags" : [ ] ,
2021-05-06 19:09:09 +02:00
"label" : "ROUTE_TAG_CAN_REDIRECT" ,
"description" : [
"\nIf the route is marked with this tag Security can safely assume that the calling party that sends\nrequest to this route can handle redirect responses. It's particularly important if we want the\nspecific route to be able to initiate or participate in the authentication handshake that may\ninvolve redirects and will eventually redirect authenticated user to this route."
] ,
2021-05-06 21:29:47 +02:00
"signature" : [
"\"security:canRedirect\""
] ,
2021-03-03 04:02:17 +01:00
"source" : {
2021-05-06 19:09:09 +02:00
"path" : "x-pack/plugins/security/server/routes/tags.ts" ,
"lineNumber" : 21
2021-03-03 04:02:17 +01:00
} ,
2021-05-06 21:29:47 +02:00
"deprecated" : false ,
2021-03-03 04:02:17 +01:00
"initialIsOpen" : false
}
] ,
"objects" : [ ]
} ,
"common" : {
"classes" : [ ] ,
"functions" : [ ] ,
"interfaces" : [ ] ,
"enums" : [ ] ,
"misc" : [ ] ,
"objects" : [ ]
}
}