github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/security.devdocs.json

8559 lines
No EOL
317 KiB
JSON
Raw Permalink Blame History

{
"id": "security",
"client": {
"classes": [],
"functions": [],
"interfaces": [
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser",
"type": "Interface",
"tags": [],
"label": "AuthenticatedUser",
"description": [
"\nRepresents the currently authenticated user."
],
"signature": [
"AuthenticatedUser",
" extends ",
"User"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser.authentication_realm",
"type": "Object",
"tags": [],
"label": "authentication_realm",
"description": [
"\nThe name and type of the Realm that has authenticated the user."
],
"signature": [
"UserRealm"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser.lookup_realm",
"type": "Object",
"tags": [],
"label": "lookup_realm",
"description": [
"\nThe name and type of the Realm where the user information were retrieved from."
],
"signature": [
"UserRealm"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser.authentication_provider",
"type": "Object",
"tags": [],
"label": "authentication_provider",
"description": [
"\nThe authentication provider that used to authenticate user."
],
"signature": [
"AuthenticationProvider"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser.authentication_type",
"type": "string",
"tags": [],
"label": "authentication_type",
"description": [
"\nThe AuthenticationType used by ES to authenticate the user.\n"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser.elastic_cloud_user",
"type": "boolean",
"tags": [],
"label": "elastic_cloud_user",
"description": [
"\nIndicates whether user is authenticated via Elastic Cloud built-in SAML realm."
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser.profile_uid",
"type": "string",
"tags": [],
"label": "profile_uid",
"description": [
"\nUser profile ID of this user."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [
"\nIndicates whether user is an operator."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticatedUser.api_key",
"type": "Object",
"tags": [],
"label": "api_key",
"description": [
"\nMetadata of the API key that was used to authenticate the user."
],
"signature": [
"ApiKeyDescriptor",
" | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticationServiceSetup",
"type": "Interface",
"tags": [],
"label": "AuthenticationServiceSetup",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authentication/authentication_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.AuthenticationServiceSetup.getCurrentUser",
"type": "Function",
"tags": [],
"label": "getCurrentUser",
"description": [
"\nReturns currently authenticated user and throws if current user isn't authenticated."
],
"signature": [
"() => Promise<",
"AuthenticatedUser",
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authentication/authentication_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticationServiceSetup.areAPIKeysEnabled",
"type": "Function",
"tags": [],
"label": "areAPIKeysEnabled",
"description": [
"\nDetermines if API Keys are currently enabled."
],
"signature": [
"() => Promise<boolean>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authentication/authentication_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthorizationServiceSetup",
"type": "Interface",
"tags": [],
"label": "AuthorizationServiceSetup",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.AuthorizationServiceSetup.isRoleManagementEnabled",
"type": "Function",
"tags": [],
"label": "isRoleManagementEnabled",
"description": [
"\nDetermines if role management is enabled."
],
"signature": [
"() => boolean | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.AuthorizationServiceSetup.roles",
"type": "Object",
"tags": [],
"label": "roles",
"description": [
"\nA set of methods to work with Kibana user roles."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.RolesAPIClient",
"text": "RolesAPIClient"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthorizationServiceSetup.privileges",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [
"\nA set of methods to work with Kibana role privileges"
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.PrivilegesAPIClientPublicContract",
"text": "PrivilegesAPIClientPublicContract"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.ChangePasswordProps",
"type": "Interface",
"tags": [],
"label": "ChangePasswordProps",
"description": [],
"path": "x-pack/platform/plugins/shared/security/public/ui_api/change_password/change_password.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.ChangePasswordProps.user",
"type": "Object",
"tags": [],
"label": "user",
"description": [],
"signature": [
"AuthenticatedUser"
],
"path": "x-pack/platform/plugins/shared/security/public/ui_api/change_password/change_password.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.PersonalInfoProps",
"type": "Interface",
"tags": [],
"label": "PersonalInfoProps",
"description": [],
"path": "x-pack/platform/plugins/shared/security/public/ui_api/personal_info/personal_info.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.PersonalInfoProps.user",
"type": "Object",
"tags": [],
"label": "user",
"description": [],
"signature": [
"AuthenticatedUser"
],
"path": "x-pack/platform/plugins/shared/security/public/ui_api/personal_info/personal_info.tsx",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense",
"type": "Interface",
"tags": [],
"label": "SecurityLicense",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense.isLicenseAvailable",
"type": "Function",
"tags": [],
"label": "isLicenseAvailable",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense.getLicenseType",
"type": "Function",
"tags": [],
"label": "getLicenseType",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense.getUnavailableReason",
"type": "Function",
"tags": [],
"label": "getUnavailableReason",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense.isEnabled",
"type": "Function",
"tags": [],
"label": "isEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense.getFeatures",
"type": "Function",
"tags": [],
"label": "getFeatures",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.SecurityLicenseFeatures",
"text": "SecurityLicenseFeatures"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense.hasAtLeast",
"type": "Function",
"tags": [],
"label": "hasAtLeast",
"description": [],
"signature": [
"(licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense.hasAtLeast.$1",
"type": "CompoundType",
"tags": [],
"label": "licenseType",
"description": [],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicense.features$",
"type": "Object",
"tags": [],
"label": "features$",
"description": [],
"signature": [
"Observable",
"<",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.SecurityLicenseFeatures",
"text": "SecurityLicenseFeatures"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures",
"type": "Interface",
"tags": [],
"label": "SecurityLicenseFeatures",
"description": [
"\nDescribes Security plugin features that depend on license."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.showLogin",
"type": "boolean",
"tags": [],
"label": "showLogin",
"description": [
"\nIndicates whether we show login page or skip it."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowLogin",
"type": "boolean",
"tags": [],
"label": "allowLogin",
"description": [
"\nIndicates whether we allow login or disable it on the login page."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.showLinks",
"type": "boolean",
"tags": [],
"label": "showLinks",
"description": [
"\nIndicates whether we show security links throughout the kibana app."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.showRoleMappingsManagement",
"type": "boolean",
"tags": [],
"label": "showRoleMappingsManagement",
"description": [
"\nIndicates whether we show the Role Mappings UI."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowAccessAgreement",
"type": "boolean",
"tags": [],
"label": "allowAccessAgreement",
"description": [
"\nIndicates whether we allow users to access agreement UI and acknowledge it."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowAuditLogging",
"type": "boolean",
"tags": [],
"label": "allowAuditLogging",
"description": [
"\nIndicates whether we allow logging of audit events."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowRoleDocumentLevelSecurity",
"type": "boolean",
"tags": [],
"label": "allowRoleDocumentLevelSecurity",
"description": [
"\nIndicates whether we allow users to define document level security in roles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowRoleFieldLevelSecurity",
"type": "boolean",
"tags": [],
"label": "allowRoleFieldLevelSecurity",
"description": [
"\nIndicates whether we allow users to define field level security in roles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowRoleRemoteIndexPrivileges",
"type": "boolean",
"tags": [],
"label": "allowRoleRemoteIndexPrivileges",
"description": [
"\nIndicates whether we allow users to define remote index privileges in roles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowRemoteClusterPrivileges",
"type": "boolean",
"tags": [],
"label": "allowRemoteClusterPrivileges",
"description": [
"\nIndicates whether we allow users to define remote cluster privileges in roles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowRbac",
"type": "boolean",
"tags": [],
"label": "allowRbac",
"description": [
"\nIndicates whether we allow Role-based access control (RBAC)."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowSubFeaturePrivileges",
"type": "boolean",
"tags": [],
"label": "allowSubFeaturePrivileges",
"description": [
"\nIndicates whether we allow sub-feature privileges."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowUserProfileCollaboration",
"type": "boolean",
"tags": [],
"label": "allowUserProfileCollaboration",
"description": [
"\nIndicates whether we allow user profile collaboration features (suggest and privileges checks APIs)."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.layout",
"type": "CompoundType",
"tags": [],
"label": "layout",
"description": [
"\nDescribes the layout of the login form if it's displayed."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.LoginLayout",
"text": "LoginLayout"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityLicenseFeatures.allowFips",
"type": "boolean",
"tags": [],
"label": "allowFips",
"description": [
"\nIndicates whether we allow FIPS mode"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityNavControlServiceStart",
"type": "Interface",
"tags": [],
"label": "SecurityNavControlServiceStart",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.SecurityNavControlServiceStart.getUserMenuLinks$",
"type": "Function",
"tags": [],
"label": "getUserMenuLinks$",
"description": [
"\nReturns an Observable of the array of user menu links (the links that show up under the user's Avatar in the UI) registered by other plugins"
],
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.UserMenuLink",
"text": "UserMenuLink"
},
"[]>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-public.SecurityNavControlServiceStart.addUserMenuLinks",
"type": "Function",
"tags": [],
"label": "addUserMenuLinks",
"description": [
"\nRegisters the provided user menu links to be displayed in the user menu (the links that show up under the user's Avatar in the UI)."
],
"signature": [
"(newUserMenuLink: ",
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.UserMenuLink",
"text": "UserMenuLink"
},
"[]) => void"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.SecurityNavControlServiceStart.addUserMenuLinks.$1",
"type": "Array",
"tags": [],
"label": "newUserMenuLink",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.UserMenuLink",
"text": "UserMenuLink"
},
"[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.UiApi",
"type": "Interface",
"tags": [],
"label": "UiApi",
"description": [],
"path": "x-pack/platform/plugins/shared/security/public/ui_api/index.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.UiApi.components",
"type": "Object",
"tags": [],
"label": "components",
"description": [],
"signature": [
"{ getPersonalInfo: LazyComponentFn<",
{
"pluginId": "security",
"scope": "public",
"docId": "kibSecurityPluginApi",
"section": "def-public.PersonalInfoProps",
"text": "PersonalInfoProps"
},
">; getChangePassword: LazyComponentFn<",
{
"pluginId": "security",
"scope": "public",
"docId": "kibSecurityPluginApi",
"section": "def-public.ChangePasswordProps",
"text": "ChangePasswordProps"
},
">; }"
],
"path": "x-pack/platform/plugins/shared/security/public/ui_api/index.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.UserMenuLink",
"type": "Interface",
"tags": [],
"label": "UserMenuLink",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.UserMenuLink.label",
"type": "string",
"tags": [],
"label": "label",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.UserMenuLink.iconType",
"type": "CompoundType",
"tags": [],
"label": "iconType",
"description": [],
"signature": [
"string | React.ComponentType<{}>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.UserMenuLink.href",
"type": "string",
"tags": [],
"label": "href",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.UserMenuLink.order",
"type": "number",
"tags": [],
"label": "order",
"description": [],
"signature": [
"number | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.UserMenuLink.setAsProfile",
"type": "CompoundType",
"tags": [],
"label": "setAsProfile",
"description": [],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.UserMenuLink.content",
"type": "CompoundType",
"tags": [],
"label": "content",
"description": [
"Render a custom ReactNode instead of the default <EuiContextMenuItem />"
],
"signature": [
"React.ReactNode | ((args: { closePopover: () => void; }) => React.ReactNode)"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/nav_control/nav_control_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.UserProfileBulkGetParams",
"type": "Interface",
"tags": [],
"label": "UserProfileBulkGetParams",
"description": [
"\nParameters for the bulk get API."
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.UserProfileBulkGetParams.uids",
"type": "Object",
"tags": [],
"label": "uids",
"description": [
"\nList of user profile identifiers."
],
"signature": [
"Set<string>"
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.UserProfileBulkGetParams.dataPath",
"type": "string",
"tags": [],
"label": "dataPath",
"description": [
"\nBy default, suggest API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.UserProfileGetCurrentParams",
"type": "Interface",
"tags": [],
"label": "UserProfileGetCurrentParams",
"description": [
"\nParameters for the get user profile for the current user API."
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.UserProfileGetCurrentParams.dataPath",
"type": "string",
"tags": [],
"label": "dataPath",
"description": [
"\nBy default, get API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)."
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.UserProfileSuggestParams",
"type": "Interface",
"tags": [],
"label": "UserProfileSuggestParams",
"description": [
"\nParameters for the suggest API."
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.UserProfileSuggestParams.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nQuery string used to match name-related fields in user profiles. The following fields are treated as\nname-related: username, full_name and email."
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.UserProfileSuggestParams.size",
"type": "number",
"tags": [],
"label": "size",
"description": [
"\nDesired number of suggestions to return. The default value is 10."
],
"signature": [
"number | undefined"
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.UserProfileSuggestParams.dataPath",
"type": "string",
"tags": [],
"label": "dataPath",
"description": [
"\nBy default, suggest API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/browser/src/service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "security",
"id": "def-public.ALL_SPACES_ID",
"type": "string",
"tags": [],
"label": "ALL_SPACES_ID",
"description": [
"\nThe identifier in a saved object's `namespaces` array when it is shared globally to all spaces."
],
"signature": [
"\"*\""
],
"path": "x-pack/platform/plugins/shared/security/common/constants.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthenticationServiceStart",
"type": "Type",
"tags": [],
"label": "AuthenticationServiceStart",
"description": [
"\nStart has the same contract as Setup for now."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.AuthenticationServiceSetup",
"text": "AuthenticationServiceSetup"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authentication/authentication_service.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.AuthorizationServiceStart",
"type": "Type",
"tags": [],
"label": "AuthorizationServiceStart",
"description": [
"\nStart has the same contract as Setup for now."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.AuthorizationServiceSetup",
"text": "AuthorizationServiceSetup"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-public.StartServices",
"type": "Type",
"tags": [],
"label": "StartServices",
"description": [],
"signature": [
"{ i18n: ",
"I18nStart",
"; analytics: ",
"AnalyticsServiceStart",
"; theme: ",
"ThemeServiceSetup",
"; userProfile: ",
"UserProfileService",
"; }"
],
"path": "x-pack/platform/plugins/shared/security/public/index.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"start": {
"parentPluginId": "security",
"id": "def-public.SecurityPluginStart",
"type": "Interface",
"tags": [],
"label": "SecurityPluginStart",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "public",
"docId": "kibSecurityPluginApi",
"section": "def-public.SecurityPluginStart",
"text": "SecurityPluginStart"
},
" extends ",
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.SecurityPluginStart",
"text": "SecurityPluginStart"
}
],
"path": "x-pack/platform/plugins/shared/security/public/plugin.tsx",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.SecurityPluginStart.uiApi",
"type": "Object",
"tags": [
"deprecated"
],
"label": "uiApi",
"description": [
"\nExposes UI components that will be loaded asynchronously."
],
"signature": [
{
"pluginId": "security",
"scope": "public",
"docId": "kibSecurityPluginApi",
"section": "def-public.UiApi",
"text": "UiApi"
}
],
"path": "x-pack/platform/plugins/shared/security/public/plugin.tsx",
"deprecated": true,
"trackAdoption": false,
"references": []
}
],
"lifecycle": "start",
"initialIsOpen": true
},
"setup": {
"parentPluginId": "security",
"id": "def-public.SecurityPluginSetup",
"type": "Interface",
"tags": [],
"label": "SecurityPluginSetup",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-public.SecurityPluginSetup.authc",
"type": "Object",
"tags": [
"deprecated"
],
"label": "authc",
"description": [
"\nExposes authentication information about the currently logged in user.\n"
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.AuthenticationServiceSetup",
"text": "AuthenticationServiceSetup"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/plugin.ts",
"deprecated": true,
"trackAdoption": false,
"references": []
},
{
"parentPluginId": "security",
"id": "def-public.SecurityPluginSetup.authz",
"type": "Object",
"tags": [],
"label": "authz",
"description": [
"\nExposes authorization configuration."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-public",
"scope": "public",
"docId": "kibKbnSecurityPluginTypesPublicPluginApi",
"section": "def-public.AuthorizationServiceSetup",
"text": "AuthorizationServiceSetup"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-public.SecurityPluginSetup.license",
"type": "Object",
"tags": [],
"label": "license",
"description": [
"\nExposes information about the available security features under the current license."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.SecurityLicense",
"text": "SecurityLicense"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_public/src/plugin.ts",
"deprecated": false,
"trackAdoption": false
}
],
"lifecycle": "setup",
"initialIsOpen": true
}
},
"server": {
"classes": [
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader",
"type": "Class",
"tags": [],
"label": "HTTPAuthorizationHeader",
"description": [],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.scheme",
"type": "string",
"tags": [],
"label": "scheme",
"description": [
"\nThe authentication scheme. Should be consumed in a case-insensitive manner.\nhttps://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml#authschemes"
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.credentials",
"type": "string",
"tags": [],
"label": "credentials",
"description": [
"\nThe authentication credentials for the scheme."
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [],
"signature": [
"any"
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.Unnamed.$1",
"type": "string",
"tags": [],
"label": "scheme",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.Unnamed.$2",
"type": "string",
"tags": [],
"label": "credentials",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.parseFromRequest",
"type": "Function",
"tags": [],
"label": "parseFromRequest",
"description": [
"\nParses request's `Authorization` HTTP header if present."
],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>, headerName?: string) => ",
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.HTTPAuthorizationHeader",
"text": "HTTPAuthorizationHeader"
},
" | null"
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.parseFromRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"Request instance to extract the authorization header from."
],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.parseFromRequest.$2",
"type": "string",
"tags": [],
"label": "headerName",
"description": [
"Optional name of the HTTP header to extract authentication information from. By default, the\nauthentication information is extracted from the `Authorization` HTTP header."
],
"signature": [
"string"
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.HTTPAuthorizationHeader.toString",
"type": "Function",
"tags": [],
"label": "toString",
"description": [],
"signature": [
"() => string"
],
"path": "x-pack/platform/plugins/shared/security/server/authentication/http_authentication/http_authorization_header.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [],
"interfaces": [
{
"parentPluginId": "security",
"id": "def-server.Actions",
"type": "Interface",
"tags": [],
"label": "Actions",
"description": [
"Actions are used to create the \"actions\" that are associated with Elasticsearch's\napplication privileges, and are used to perform the authorization checks implemented\nby the various `checkPrivilegesWithRequest` derivatives."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.Actions.api",
"type": "Object",
"tags": [],
"label": "api",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.ApiActions",
"text": "ApiActions"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.Actions.app",
"type": "Object",
"tags": [],
"label": "app",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.AppActions",
"text": "AppActions"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.Actions.cases",
"type": "Object",
"tags": [],
"label": "cases",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CasesActions",
"text": "CasesActions"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.Actions.login",
"type": "string",
"tags": [],
"label": "login",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.Actions.savedObject",
"type": "Object",
"tags": [],
"label": "savedObject",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.SavedObjectActions",
"text": "SavedObjectActions"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.Actions.alerting",
"type": "Object",
"tags": [],
"label": "alerting",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.AlertingActions",
"text": "AlertingActions"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.Actions.space",
"type": "Object",
"tags": [],
"label": "space",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.SpaceActions",
"text": "SpaceActions"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.Actions.ui",
"type": "Object",
"tags": [],
"label": "ui",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.UIActions",
"text": "UIActions"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/actions.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AlertingActions",
"type": "Interface",
"tags": [],
"label": "AlertingActions",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/alerting.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AlertingActions.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(ruleTypeId: string, consumer: string, alertingEntity: string, operation: string) => string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/alerting.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AlertingActions.get.$1",
"type": "string",
"tags": [],
"label": "ruleTypeId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/alerting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.AlertingActions.get.$2",
"type": "string",
"tags": [],
"label": "consumer",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/alerting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.AlertingActions.get.$3",
"type": "string",
"tags": [],
"label": "alertingEntity",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/alerting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.AlertingActions.get.$4",
"type": "string",
"tags": [],
"label": "operation",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/alerting.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.ApiActions",
"type": "Interface",
"tags": [],
"label": "ApiActions",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.ApiActions.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"{ (operation: ",
"ApiOperation",
", subject: string): string; (subject: string): string; }"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.ApiActions.get.$1",
"type": "Enum",
"tags": [],
"label": "operation",
"description": [],
"signature": [
"ApiOperation"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.ApiActions.get.$2",
"type": "string",
"tags": [],
"label": "subject",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.ApiActions.get",
"type": "Function",
"tags": [
"deprecated"
],
"label": "get",
"description": [],
"signature": [
"{ (operation: ",
"ApiOperation",
", subject: string): string; (subject: string): string; }"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "@kbn/security-plugin-types-server",
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts"
},
{
"plugin": "telemetry",
"path": "src/platform/plugins/shared/telemetry/server/routes/telemetry_usage_stats.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/routes/agent_policy/handlers.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/routes/epm/kibana_assets_handler.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/routes/app/index.ts"
},
{
"plugin": "profiling",
"path": "x-pack/solutions/observability/plugins/profiling/server/lib/setup/get_has_setup_privileges.ts"
},
{
"plugin": "profiling",
"path": "x-pack/solutions/observability/plugins/profiling/server/lib/setup/get_has_setup_privileges.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/actions/api.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/actions/api.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/feature_privilege_builder/api.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/actions/api.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/actions/api.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "@kbn/security-authorization-core",
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/privileges.test.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/security/fleet_router.test.ts"
}
],
"children": [
{
"parentPluginId": "security",
"id": "def-server.ApiActions.get.$1",
"type": "string",
"tags": [],
"label": "subject",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.ApiActions.actionFromRouteTag",
"type": "Function",
"tags": [],
"label": "actionFromRouteTag",
"description": [],
"signature": [
"(routeTag: string) => string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.ApiActions.actionFromRouteTag.$1",
"type": "string",
"tags": [],
"label": "routeTag",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/api.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys",
"type": "Interface",
"tags": [],
"label": "APIKeys",
"description": [
"\nInterface for managing API keys in Elasticsearch, including creation,\nvalidation, and invalidation of API keys,\nas well as checking the status of API key features."
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.APIKeys.areAPIKeysEnabled",
"type": "Function",
"tags": [],
"label": "areAPIKeysEnabled",
"description": [
"\nDetermines if API Keys are enabled in Elasticsearch."
],
"signature": [
"() => Promise<boolean>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.areCrossClusterAPIKeysEnabled",
"type": "Function",
"tags": [],
"label": "areCrossClusterAPIKeysEnabled",
"description": [
"\nDetermines if Cross-Cluster API Keys are enabled in Elasticsearch."
],
"signature": [
"() => Promise<boolean>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.create",
"type": "Function",
"tags": [],
"label": "create",
"description": [
"\nTries to create an API key for the current user.\n\nReturns newly created API key or `null` if API keys are disabled.\n\nUser needs `manage_api_key` privilege to create REST API keys and `manage_security` for Cross-Cluster API keys.\n"
],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>, createParams: ",
"CreateAPIKeyParams",
") => Promise<",
"SecurityCreateApiKeyResponse",
" | null>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.APIKeys.create.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"Request instance."
],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.create.$2",
"type": "CompoundType",
"tags": [],
"label": "createParams",
"description": [
"The params to create an API key"
],
"signature": [
"CreateAPIKeyParams"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.update",
"type": "Function",
"tags": [],
"label": "update",
"description": [
"\nAttempts update an API key with the provided 'role_descriptors' and 'metadata'\n\nReturns `updated`, `true` if the update was successful, `false` if there was nothing to update\n\nUser needs `manage_api_key` privilege to update REST API keys and `manage_security` for cross-cluster API keys.\n"
],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>, updateParams: ",
"UpdateAPIKeyParams",
") => Promise<",
"SecurityUpdateApiKeyResponse",
" | null>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.APIKeys.update.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"Request instance."
],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.update.$2",
"type": "CompoundType",
"tags": [],
"label": "updateParams",
"description": [
"The params to edit an API key"
],
"signature": [
"UpdateAPIKeyParams"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.grantAsInternalUser",
"type": "Function",
"tags": [],
"label": "grantAsInternalUser",
"description": [
"\nTries to grant an API key for the current user."
],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>, createParams: ",
"CreateRestAPIKeyParams",
" | ",
"CreateRestAPIKeyWithKibanaPrivilegesParams",
") => Promise<",
"GrantAPIKeyResult",
" | null>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.APIKeys.grantAsInternalUser.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"Request instance."
],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.grantAsInternalUser.$2",
"type": "CompoundType",
"tags": [],
"label": "createParams",
"description": [
"Create operation parameters."
],
"signature": [
"CreateRestAPIKeyParams",
" | ",
"CreateRestAPIKeyWithKibanaPrivilegesParams"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.validate",
"type": "Function",
"tags": [],
"label": "validate",
"description": [
"\nTries to validate an API key."
],
"signature": [
"(apiKeyPrams: ",
"ValidateAPIKeyParams",
") => Promise<boolean>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.APIKeys.validate.$1",
"type": "Object",
"tags": [],
"label": "apiKeyPrams",
"description": [
"ValidateAPIKeyParams."
],
"signature": [
"ValidateAPIKeyParams"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.invalidate",
"type": "Function",
"tags": [],
"label": "invalidate",
"description": [
"\nTries to invalidate an API keys."
],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>, params: ",
"InvalidateAPIKeysParams",
") => Promise<",
"InvalidateAPIKeyResult",
" | null>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.APIKeys.invalidate.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"Request instance."
],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.invalidate.$2",
"type": "Object",
"tags": [],
"label": "params",
"description": [
"The params to invalidate an API keys."
],
"signature": [
"InvalidateAPIKeysParams"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.APIKeys.invalidateAsInternalUser",
"type": "Function",
"tags": [],
"label": "invalidateAsInternalUser",
"description": [
"\nTries to invalidate the API keys by using the internal user."
],
"signature": [
"(params: ",
"InvalidateAPIKeysParams",
") => Promise<",
"InvalidateAPIKeyResult",
" | null>"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.APIKeys.invalidateAsInternalUser.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [
"The params to invalidate the API keys."
],
"signature": [
"InvalidateAPIKeysParams"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AppActions",
"type": "Interface",
"tags": [],
"label": "AppActions",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/app.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AppActions.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(operation: string) => string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/app.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AppActions.get.$1",
"type": "string",
"tags": [],
"label": "operation",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/app.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditEvent",
"type": "Interface",
"tags": [],
"label": "AuditEvent",
"description": [
"\nAudit event schema using ECS format: https://www.elastic.co/guide/en/ecs/1.12/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"
],
"signature": [
"AuditEvent",
" extends ",
{
"pluginId": "@kbn/logging",
"scope": "common",
"docId": "kibKbnLoggingPluginApi",
"section": "def-common.LogMeta",
"text": "LogMeta"
}
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuditEvent.message",
"type": "string",
"tags": [],
"label": "message",
"description": [
"\nLog message"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditEvent.kibana",
"type": "Object",
"tags": [],
"label": "kibana",
"description": [
"\nKibana specific fields"
],
"signature": [
"AuditKibana",
" | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditEvent.http",
"type": "Object",
"tags": [],
"label": "http",
"description": [
"\nFields describing an HTTP request"
],
"signature": [
"AuditHttp",
" | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditHttp",
"type": "Interface",
"tags": [],
"label": "AuditHttp",
"description": [
"\nAudit http schema using ECS format"
],
"signature": [
"AuditHttp",
" extends ",
"EcsHttp"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuditHttp.request",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"\nHTTP request details"
],
"signature": [
"AuditRequest",
" | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana",
"type": "Interface",
"tags": [],
"label": "AuditKibana",
"description": [
"\nAudit kibana schema using ECS format"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.space_id",
"type": "string",
"tags": [],
"label": "space_id",
"description": [
"\nThe ID of the space associated with this event."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.session_id",
"type": "string",
"tags": [],
"label": "session_id",
"description": [
"\nThe ID of the user session associated with this event. Each login attempt\nresults in a unique session id."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.saved_object",
"type": "Object",
"tags": [],
"label": "saved_object",
"description": [
"\nSaved object that was created, changed, deleted or accessed as part of this event."
],
"signature": [
"{ type: string; id: string; name?: string | undefined; } | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.authentication_provider",
"type": "string",
"tags": [],
"label": "authentication_provider",
"description": [
"\nName of authentication provider associated with a login event."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.authentication_type",
"type": "string",
"tags": [],
"label": "authentication_type",
"description": [
"\nType of authentication provider associated with a login event."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.authentication_realm",
"type": "string",
"tags": [],
"label": "authentication_realm",
"description": [
"\nName of Elasticsearch realm that has authenticated the user."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.lookup_realm",
"type": "string",
"tags": [],
"label": "lookup_realm",
"description": [
"\nName of Elasticsearch realm where the user details were retrieved from."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.add_to_spaces",
"type": "Object",
"tags": [],
"label": "add_to_spaces",
"description": [
"\nSet of space IDs that a saved object was shared to."
],
"signature": [
"readonly string[] | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.delete_from_spaces",
"type": "Object",
"tags": [],
"label": "delete_from_spaces",
"description": [
"\nSet of space IDs that a saved object was removed from."
],
"signature": [
"readonly string[] | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.unauthorized_spaces",
"type": "Object",
"tags": [],
"label": "unauthorized_spaces",
"description": [
"\nSet of space IDs that are not authorized for an action."
],
"signature": [
"readonly string[] | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditKibana.unauthorized_types",
"type": "Object",
"tags": [],
"label": "unauthorized_types",
"description": [
"\nSet of types that are not authorized for an action."
],
"signature": [
"readonly string[] | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditLogger",
"type": "Interface",
"tags": [],
"label": "AuditLogger",
"description": [],
"path": "src/core/packages/security/server/src/audit_logging/audit_logger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuditLogger.log",
"type": "Function",
"tags": [],
"label": "log",
"description": [
"\nLogs an {@link AuditEvent} and automatically adds meta data about the\ncurrent user, space and correlation id.\n\nGuidelines around what events should be logged and how they should be\nstructured can be found in: `/x-pack/platform/plugins/shared/security/README.md`\n"
],
"signature": [
"(event: ",
"AuditEvent",
" | undefined) => void"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_logger.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuditLogger.log.$1",
"type": "Object",
"tags": [],
"label": "event",
"description": [],
"signature": [
"AuditEvent",
" | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_logger.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.AuditLogger.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [
"\nIndicates whether audit logging is enabled or not.\n\nUseful for skipping resource-intense operations that don't need to be performed when audit\nlogging is disabled."
],
"path": "src/core/packages/security/server/src/audit_logging/audit_logger.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditLogger.includeSavedObjectNames",
"type": "boolean",
"tags": [],
"label": "includeSavedObjectNames",
"description": [
"\nIndicates whether to include saved objects names in audit log"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_logger.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditRequest",
"type": "Interface",
"tags": [],
"label": "AuditRequest",
"description": [
"\nAudit request schema using ECS format"
],
"signature": [
"AuditRequest",
" extends { body?: { bytes?: number | undefined; content?: string | undefined; } | undefined; bytes?: number | undefined; id?: string | undefined; method?: string | undefined; mime_type?: string | undefined; referrer?: string | undefined; }"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuditRequest.headers",
"type": "Object",
"tags": [],
"label": "headers",
"description": [
"\nHTTP request headers"
],
"signature": [
"{ 'x-forwarded-for'?: string | undefined; } | undefined"
],
"path": "src/core/packages/security/server/src/audit_logging/audit_events.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuditServiceSetup",
"type": "Interface",
"tags": [],
"label": "AuditServiceSetup",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/audit/audit_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuditServiceSetup.asScoped",
"type": "Function",
"tags": [],
"label": "asScoped",
"description": [
"\nCreates an {@link AuditLogger} scoped to the current request.\n\nThis audit logger logs events with all required user and session info and should be used for\nall user-initiated actions.\n"
],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
"AuditLogger"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/audit/audit_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuditServiceSetup.asScoped.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/audit/audit_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.AuditServiceSetup.withoutRequest",
"type": "Object",
"tags": [],
"label": "withoutRequest",
"description": [
"\n{@link AuditLogger} for background tasks only.\n\nThis audit logger logs events without any user or session info and should never be used to log\nuser-initiated actions.\n"
],
"signature": [
"AuditLogger"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/audit/audit_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser",
"type": "Interface",
"tags": [],
"label": "AuthenticatedUser",
"description": [
"\nRepresents the currently authenticated user."
],
"signature": [
"AuthenticatedUser",
" extends ",
"User"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser.authentication_realm",
"type": "Object",
"tags": [],
"label": "authentication_realm",
"description": [
"\nThe name and type of the Realm that has authenticated the user."
],
"signature": [
"UserRealm"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser.lookup_realm",
"type": "Object",
"tags": [],
"label": "lookup_realm",
"description": [
"\nThe name and type of the Realm where the user information were retrieved from."
],
"signature": [
"UserRealm"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser.authentication_provider",
"type": "Object",
"tags": [],
"label": "authentication_provider",
"description": [
"\nThe authentication provider that used to authenticate user."
],
"signature": [
"AuthenticationProvider"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser.authentication_type",
"type": "string",
"tags": [],
"label": "authentication_type",
"description": [
"\nThe AuthenticationType used by ES to authenticate the user.\n"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser.elastic_cloud_user",
"type": "boolean",
"tags": [],
"label": "elastic_cloud_user",
"description": [
"\nIndicates whether user is authenticated via Elastic Cloud built-in SAML realm."
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser.profile_uid",
"type": "string",
"tags": [],
"label": "profile_uid",
"description": [
"\nUser profile ID of this user."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [
"\nIndicates whether user is an operator."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticatedUser.api_key",
"type": "Object",
"tags": [],
"label": "api_key",
"description": [
"\nMetadata of the API key that was used to authenticate the user."
],
"signature": [
"ApiKeyDescriptor",
" | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticationServiceStart",
"type": "Interface",
"tags": [],
"label": "AuthenticationServiceStart",
"description": [
"\nAuthentication services available on the security plugin's start contract."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authentication/authentication_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthenticationServiceStart.apiKeys",
"type": "Object",
"tags": [],
"label": "apiKeys",
"description": [],
"signature": [
"APIKeys"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authentication/authentication_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthenticationServiceStart.getCurrentUser",
"type": "Function",
"tags": [],
"label": "getCurrentUser",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
"AuthenticatedUser",
" | null"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authentication/authentication_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthenticationServiceStart.getCurrentUser.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authentication/authentication_service.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthorizationMode",
"type": "Interface",
"tags": [],
"label": "AuthorizationMode",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/mode.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthorizationMode.useRbacForRequest",
"type": "Function",
"tags": [],
"label": "useRbacForRequest",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => boolean"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/mode.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthorizationMode.useRbacForRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/mode.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup",
"type": "Interface",
"tags": [],
"label": "AuthorizationServiceSetup",
"description": [
"\nAuthorization services available on the setup contract of the security plugin."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup.actions",
"type": "Object",
"tags": [],
"label": "actions",
"description": [
"\nActions are used to create the \"actions\" that are associated with Elasticsearch's\napplication privileges, and are used to perform the authorization checks implemented\nby the various `checkPrivilegesWithRequest` derivatives."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.Actions",
"text": "Actions"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup.checkPrivilegesWithRequest",
"type": "Function",
"tags": [],
"label": "checkPrivilegesWithRequest",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivileges",
"text": "CheckPrivileges"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup.checkPrivilegesWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup.checkPrivilegesDynamicallyWithRequest",
"type": "Function",
"tags": [],
"label": "checkPrivilegesDynamicallyWithRequest",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesDynamically",
"text": "CheckPrivilegesDynamically"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup.checkPrivilegesDynamicallyWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges_dynamically.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup.checkSavedObjectsPrivilegesWithRequest",
"type": "Function",
"tags": [],
"label": "checkSavedObjectsPrivilegesWithRequest",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckSavedObjectsPrivileges",
"text": "CheckSavedObjectsPrivileges"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup.checkSavedObjectsPrivilegesWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_saved_objects_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
]
},
{
"parentPluginId": "security",
"id": "def-server.AuthorizationServiceSetup.mode",
"type": "Object",
"tags": [],
"label": "mode",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.AuthorizationMode",
"text": "AuthorizationMode"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/authorization_service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CasesActions",
"type": "Interface",
"tags": [],
"label": "CasesActions",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/cases.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CasesActions.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(owner: string, operation: string) => string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/cases.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CasesActions.get.$1",
"type": "string",
"tags": [],
"label": "owner",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/cases.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.CasesActions.get.$2",
"type": "string",
"tags": [],
"label": "operation",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/cases.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges",
"type": "Interface",
"tags": [],
"label": "CheckPrivileges",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.atSpace",
"type": "Function",
"tags": [],
"label": "atSpace",
"description": [],
"signature": [
"(spaceId: string, privileges: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesPayload",
"text": "CheckPrivilegesPayload"
},
", options?: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesOptions",
"text": "CheckPrivilegesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesResponse",
"text": "CheckPrivilegesResponse"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.atSpace.$1",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.atSpace.$2",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesPayload",
"text": "CheckPrivilegesPayload"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.atSpace.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesOptions",
"text": "CheckPrivilegesOptions"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.atSpaces",
"type": "Function",
"tags": [],
"label": "atSpaces",
"description": [],
"signature": [
"(spaceIds: string[], privileges: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesPayload",
"text": "CheckPrivilegesPayload"
},
", options?: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesOptions",
"text": "CheckPrivilegesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesResponse",
"text": "CheckPrivilegesResponse"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.atSpaces.$1",
"type": "Array",
"tags": [],
"label": "spaceIds",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.atSpaces.$2",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesPayload",
"text": "CheckPrivilegesPayload"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.atSpaces.$3",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesOptions",
"text": "CheckPrivilegesOptions"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.globally",
"type": "Function",
"tags": [],
"label": "globally",
"description": [],
"signature": [
"(privileges: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesPayload",
"text": "CheckPrivilegesPayload"
},
", options?: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesOptions",
"text": "CheckPrivilegesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesResponse",
"text": "CheckPrivilegesResponse"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.globally.$1",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesPayload",
"text": "CheckPrivilegesPayload"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivileges.globally.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesOptions",
"text": "CheckPrivilegesOptions"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesOptions",
"type": "Interface",
"tags": [],
"label": "CheckPrivilegesOptions",
"description": [
"\nOptions to influce the privilege checks."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesOptions.requireLoginAction",
"type": "CompoundType",
"tags": [],
"label": "requireLoginAction",
"description": [
"\nWhether or not the `login` action should be required (default: true).\nSetting this to false is not advised except for special circumstances, when you do not require\nthe request to belong to a user capable of logging into Kibana."
],
"signature": [
"boolean | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesPayload",
"type": "Interface",
"tags": [],
"label": "CheckPrivilegesPayload",
"description": [
"\nPrivileges that can be checked for the Kibana users."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesPayload.kibana",
"type": "CompoundType",
"tags": [],
"label": "kibana",
"description": [
"\nA list of the Kibana specific privileges (usually generated with `security.authz.actions.*.get(...)`)."
],
"signature": [
"string | string[] | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesPayload.elasticsearch",
"type": "Object",
"tags": [],
"label": "elasticsearch",
"description": [
"\nA set of the Elasticsearch cluster and index privileges."
],
"signature": [
"{ cluster: string[]; index: Record<string, string[]>; } | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesResponse",
"type": "Interface",
"tags": [],
"label": "CheckPrivilegesResponse",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesResponse.hasAllRequested",
"type": "boolean",
"tags": [],
"label": "hasAllRequested",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesResponse.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesResponse.privileges",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
"{ kibana: { resource?: string | undefined; privilege: string; authorized: boolean; }[]; elasticsearch: { cluster: { privilege: string; authorized: boolean; }[]; index: { [indexName: string]: { privilege: string; authorized: boolean; }[]; }; }; }"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivileges",
"type": "Interface",
"tags": [],
"label": "CheckUserProfilesPrivileges",
"description": [
"\nAn interface to check users profiles privileges in a specific context (only a single-space context is supported at\nthe moment)."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivileges.atSpace",
"type": "Function",
"tags": [],
"label": "atSpace",
"description": [],
"signature": [
"(spaceId: string, privileges: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckUserProfilesPrivilegesPayload",
"text": "CheckUserProfilesPrivilegesPayload"
},
") => Promise<",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckUserProfilesPrivilegesResponse",
"text": "CheckUserProfilesPrivilegesResponse"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivileges.atSpace.$1",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivileges.atSpace.$2",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckUserProfilesPrivilegesPayload",
"text": "CheckUserProfilesPrivilegesPayload"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivilegesPayload",
"type": "Interface",
"tags": [],
"label": "CheckUserProfilesPrivilegesPayload",
"description": [
"\nPrivileges that can be checked for the users profiles (only Kibana specific privileges are supported at the moment)."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivilegesPayload.kibana",
"type": "Array",
"tags": [],
"label": "kibana",
"description": [
"\nA list of the Kibana specific privileges (usually generated with `security.authz.actions.*.get(...)`)."
],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivilegesResponse",
"type": "Interface",
"tags": [],
"label": "CheckUserProfilesPrivilegesResponse",
"description": [
"\nResponse of the check privileges operation for the users profiles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivilegesResponse.hasPrivilegeUids",
"type": "Array",
"tags": [],
"label": "hasPrivilegeUids",
"description": [
"\nThe subset of the requested profile IDs of the users that have all the requested privileges."
],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckUserProfilesPrivilegesResponse.errors",
"type": "Object",
"tags": [],
"label": "errors",
"description": [
"\nAn errors object that may be returned from ES that contains a `count` of UIDs that have errors in the `details` property.\n\nEach entry in `details` will contain an error `type`, e.g 'resource_not_found_exception', and a `reason` message, e.g. 'profile document not found'"
],
"signature": [
"{ count: number; details: Record<string, { type: string; reason: string; }>; } | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateCrossClusterAPIKeyParams",
"type": "Interface",
"tags": [],
"label": "CreateCrossClusterAPIKeyParams",
"description": [],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CreateCrossClusterAPIKeyParams.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"cross_cluster\""
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateCrossClusterAPIKeyParams.expiration",
"type": "string",
"tags": [],
"label": "expiration",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateCrossClusterAPIKeyParams.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateCrossClusterAPIKeyParams.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"{ [key: string]: any; } | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateCrossClusterAPIKeyParams.access",
"type": "Object",
"tags": [],
"label": "access",
"description": [],
"signature": [
"{ search?: { names: string[]; query?: unknown; field_security?: unknown; allow_restricted_indices?: boolean | undefined; }[] | undefined; replication?: { names: string[]; }[] | undefined; }"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyParams",
"type": "Interface",
"tags": [],
"label": "CreateRestAPIKeyParams",
"description": [],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyParams.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"rest\" | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyParams.expiration",
"type": "string",
"tags": [],
"label": "expiration",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyParams.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyParams.role_descriptors",
"type": "Object",
"tags": [],
"label": "role_descriptors",
"description": [],
"signature": [
"{ [x: string]: { [key: string]: any; }; }"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyParams.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"{ [key: string]: any; } | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyWithKibanaPrivilegesParams",
"type": "Interface",
"tags": [],
"label": "CreateRestAPIKeyWithKibanaPrivilegesParams",
"description": [],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyWithKibanaPrivilegesParams.type",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"\"rest\" | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyWithKibanaPrivilegesParams.expiration",
"type": "string",
"tags": [],
"label": "expiration",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyWithKibanaPrivilegesParams.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyWithKibanaPrivilegesParams.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"{ [key: string]: any; } | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateRestAPIKeyWithKibanaPrivilegesParams.kibana_role_descriptors",
"type": "Object",
"tags": [],
"label": "kibana_role_descriptors",
"description": [],
"signature": [
"{ [x: string]: { elasticsearch: ",
"ElasticsearchPrivilegesType",
" & { [key: string]: unknown; }; kibana: ",
"KibanaPrivilegesType",
"; }; }"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.ElasticsearchPrivilegesType",
"type": "Interface",
"tags": [],
"label": "ElasticsearchPrivilegesType",
"description": [
"\nType representing Elasticsearch specific portion of the role definition."
],
"path": "src/core/packages/security/server/src/roles/schema.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.ElasticsearchPrivilegesType.cluster",
"type": "Array",
"tags": [],
"label": "cluster",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/core/packages/security/server/src/roles/schema.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.ElasticsearchPrivilegesType.remote_cluster",
"type": "Array",
"tags": [],
"label": "remote_cluster",
"description": [],
"signature": [
"{ privileges: string[]; clusters: string[]; }[] | undefined"
],
"path": "src/core/packages/security/server/src/roles/schema.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.ElasticsearchPrivilegesType.indices",
"type": "Array",
"tags": [],
"label": "indices",
"description": [],
"signature": [
"{ names: string[]; field_security?: Record<\"except\" | \"grant\", string[]> | undefined; privileges: string[]; query?: string | undefined; allow_restricted_indices?: boolean | undefined; }[] | undefined"
],
"path": "src/core/packages/security/server/src/roles/schema.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.ElasticsearchPrivilegesType.remote_indices",
"type": "Array",
"tags": [],
"label": "remote_indices",
"description": [],
"signature": [
"{ clusters: string[]; names: string[]; field_security?: Record<\"except\" | \"grant\", string[]> | undefined; privileges: string[]; query?: string | undefined; allow_restricted_indices?: boolean | undefined; }[] | undefined"
],
"path": "src/core/packages/security/server/src/roles/schema.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.ElasticsearchPrivilegesType.run_as",
"type": "Array",
"tags": [],
"label": "run_as",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "src/core/packages/security/server/src/roles/schema.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.GrantAPIKeyResult",
"type": "Interface",
"tags": [],
"label": "GrantAPIKeyResult",
"description": [],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.GrantAPIKeyResult.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nUnique id for this API key"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.GrantAPIKeyResult.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nName for this API key"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.GrantAPIKeyResult.api_key",
"type": "string",
"tags": [],
"label": "api_key",
"description": [
"\nGenerated API key"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.InvalidateAPIKeyResult",
"type": "Interface",
"tags": [],
"label": "InvalidateAPIKeyResult",
"description": [
"\nThe return value when invalidating an API key in Elasticsearch."
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.InvalidateAPIKeyResult.invalidated_api_keys",
"type": "Array",
"tags": [],
"label": "invalidated_api_keys",
"description": [
"\nThe IDs of the API keys that were invalidated as part of the request."
],
"signature": [
"string[]"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.InvalidateAPIKeyResult.previously_invalidated_api_keys",
"type": "Array",
"tags": [],
"label": "previously_invalidated_api_keys",
"description": [
"\nThe IDs of the API keys that were already invalidated."
],
"signature": [
"string[]"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.InvalidateAPIKeyResult.error_count",
"type": "number",
"tags": [],
"label": "error_count",
"description": [
"\nThe number of errors that were encountered when invalidating the API keys."
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.InvalidateAPIKeyResult.error_details",
"type": "Array",
"tags": [],
"label": "error_details",
"description": [
"\nDetails about these errors. This field is not present in the response when error_count is 0."
],
"signature": [
"{ type?: string | undefined; reason?: string | undefined; caused_by?: { type?: string | undefined; reason?: string | undefined; } | undefined; }[] | undefined"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.InvalidateAPIKeysParams",
"type": "Interface",
"tags": [],
"label": "InvalidateAPIKeysParams",
"description": [
"\nRepresents the params for invalidating multiple API keys"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.InvalidateAPIKeysParams.ids",
"type": "Array",
"tags": [],
"label": "ids",
"description": [
"\nList of unique API key IDs"
],
"signature": [
"string[]"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsRolesByFeatureIdRequest",
"type": "Interface",
"tags": [],
"label": "PrivilegeDeprecationsRolesByFeatureIdRequest",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsRolesByFeatureIdRequest.context",
"type": "Object",
"tags": [],
"label": "context",
"description": [],
"signature": [
"GetDeprecationsContext"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsRolesByFeatureIdRequest.featureId",
"type": "string",
"tags": [],
"label": "featureId",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsRolesByFeatureIdResponse",
"type": "Interface",
"tags": [],
"label": "PrivilegeDeprecationsRolesByFeatureIdResponse",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsRolesByFeatureIdResponse.roles",
"type": "Array",
"tags": [],
"label": "roles",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.Role",
"text": "Role"
},
"[] | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsRolesByFeatureIdResponse.errors",
"type": "Array",
"tags": [],
"label": "errors",
"description": [],
"signature": [
"DeprecationsDetails",
"[] | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsService",
"type": "Interface",
"tags": [],
"label": "PrivilegeDeprecationsService",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsService.getKibanaRolesByFeatureId",
"type": "Function",
"tags": [],
"label": "getKibanaRolesByFeatureId",
"description": [],
"signature": [
"(args: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.PrivilegeDeprecationsRolesByFeatureIdRequest",
"text": "PrivilegeDeprecationsRolesByFeatureIdRequest"
},
") => Promise<",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.PrivilegeDeprecationsRolesByFeatureIdResponse",
"text": "PrivilegeDeprecationsRolesByFeatureIdResponse"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.PrivilegeDeprecationsService.getKibanaRolesByFeatureId.$1",
"type": "Object",
"tags": [],
"label": "args",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.PrivilegeDeprecationsRolesByFeatureIdRequest",
"text": "PrivilegeDeprecationsRolesByFeatureIdRequest"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/deprecations.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.SavedObjectActions",
"type": "Interface",
"tags": [],
"label": "SavedObjectActions",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.SavedObjectActions.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(type: string, operation: string) => string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.SavedObjectActions.get.$1",
"type": "string",
"tags": [],
"label": "type",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.SavedObjectActions.get.$2",
"type": "string",
"tags": [],
"label": "operation",
"description": [],
"signature": [
"string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/saved_object.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.SpaceActions",
"type": "Interface",
"tags": [],
"label": "SpaceActions",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/space.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.SpaceActions.manage",
"type": "string",
"tags": [],
"label": "manage",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/space.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.UIActions",
"type": "Interface",
"tags": [],
"label": "UIActions",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/ui.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.UIActions.get",
"type": "Function",
"tags": [],
"label": "get",
"description": [],
"signature": [
"(featureId: string | number, ...uiCapabilityParts: string[]) => string"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/ui.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.UIActions.get.$1",
"type": "CompoundType",
"tags": [],
"label": "featureId",
"description": [],
"signature": [
"string | number"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/ui.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
},
{
"parentPluginId": "security",
"id": "def-server.UIActions.get.$2",
"type": "Array",
"tags": [],
"label": "uiCapabilityParts",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/actions/ui.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileBulkGetParams",
"type": "Interface",
"tags": [],
"label": "UserProfileBulkGetParams",
"description": [
"\nParameters for the bulk get API."
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.UserProfileBulkGetParams.uids",
"type": "Object",
"tags": [],
"label": "uids",
"description": [
"\nList of user profile identifiers."
],
"signature": [
"Set<string>"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileBulkGetParams.dataPath",
"type": "string",
"tags": [],
"label": "dataPath",
"description": [
"\nBy default, suggest API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileGetCurrentParams",
"type": "Interface",
"tags": [],
"label": "UserProfileGetCurrentParams",
"description": [
"\nParameters for the get user profile for the current user API."
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.UserProfileGetCurrentParams.request",
"type": "Object",
"tags": [],
"label": "request",
"description": [
"\nUser request instance to get user profile for."
],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileGetCurrentParams.dataPath",
"type": "string",
"tags": [],
"label": "dataPath",
"description": [
"\nBy default, get API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileRequiredPrivileges",
"type": "Interface",
"tags": [],
"label": "UserProfileRequiredPrivileges",
"description": [
"\nThe set of privileges that users associated with the suggested user profile should have for a specified space id."
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.UserProfileRequiredPrivileges.spaceId",
"type": "string",
"tags": [],
"label": "spaceId",
"description": [
"\nThe id of the Kibana Space."
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileRequiredPrivileges.privileges",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [
"\nThe set of the Kibana specific application privileges."
],
"signature": [
"{ kibana: string[]; }"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileSuggestParams",
"type": "Interface",
"tags": [],
"label": "UserProfileSuggestParams",
"description": [
"\nParameters for the suggest API."
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.UserProfileSuggestParams.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nQuery string used to match name-related fields in user profiles. The following fields are treated as\nname-related: username, full_name and email."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileSuggestParams.hint",
"type": "Object",
"tags": [],
"label": "hint",
"description": [
"\nExtra search criteria to improve relevance of the suggestion result. A profile matching the\nspecified hint is ranked higher in the response. But not-matching the hint does not exclude a\nprofile from the response as long as it matches the `name` field query."
],
"signature": [
"{ uids: string[]; } | undefined"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileSuggestParams.size",
"type": "number",
"tags": [],
"label": "size",
"description": [
"\nDesired number of suggestion to return. The default value is 10."
],
"signature": [
"number | undefined"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileSuggestParams.dataPath",
"type": "string",
"tags": [],
"label": "dataPath",
"description": [
"\nBy default, suggest API returns user information, but does not return any user data. The optional \"dataPath\"\nparameter can be used to return personal data for this user (within `kibana` namespace only)."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileSuggestParams.requiredPrivileges",
"type": "Object",
"tags": [],
"label": "requiredPrivileges",
"description": [
"\nThe set of the privileges that users associated with the suggested user profile should have in the specified space.\nIf not specified, privileges check isn't performed and all matched profiles are returned irrespective to the\nprivileges of the associated users."
],
"signature": [
"UserProfileRequiredPrivileges",
" | undefined"
],
"path": "src/core/packages/user-profile/server/src/service.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.ValidateAPIKeyParams",
"type": "Interface",
"tags": [],
"label": "ValidateAPIKeyParams",
"description": [
"\nRepresents the parameters for validating API Key credentials."
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.ValidateAPIKeyParams.id",
"type": "string",
"tags": [],
"label": "id",
"description": [
"\nUnique id for this API key"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.ValidateAPIKeyParams.api_key",
"type": "string",
"tags": [],
"label": "api_key",
"description": [
"\nGenerated API Key (secret)"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "security",
"id": "def-server.CasesSupportedOperations",
"type": "Type",
"tags": [],
"label": "CasesSupportedOperations",
"description": [],
"signature": [
"\"getTags\" | \"createComment\" | \"reopenCase\" | \"pushCase\" | \"createCase\" | \"getCase\" | \"getComment\" | \"getReporters\" | \"getUserActions\" | \"findConfigurations\" | \"updateCase\" | \"updateComment\" | \"deleteCase\" | \"deleteComment\" | \"createConfiguration\" | \"updateConfiguration\" | \"assignCase\""
],
"path": "x-pack/platform/packages/private/security/authorization_core/src/privileges/feature_privilege_builder/cases.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesDynamically",
"type": "Type",
"tags": [],
"label": "CheckPrivilegesDynamically",
"description": [],
"signature": [
"(privileges: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesPayload",
"text": "CheckPrivilegesPayload"
},
", options?: ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesOptions",
"text": "CheckPrivilegesOptions"
},
" | undefined) => Promise<",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesResponse",
"text": "CheckPrivilegesResponse"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges_dynamically.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesDynamically.$1",
"type": "Object",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesPayload",
"text": "CheckPrivilegesPayload"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges_dynamically.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesDynamically.$2",
"type": "Object",
"tags": [],
"label": "options",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesOptions",
"text": "CheckPrivilegesOptions"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges_dynamically.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesDynamicallyWithRequest",
"type": "Type",
"tags": [],
"label": "CheckPrivilegesDynamicallyWithRequest",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesDynamically",
"text": "CheckPrivilegesDynamically"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges_dynamically.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesDynamicallyWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges_dynamically.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesWithRequest",
"type": "Type",
"tags": [],
"label": "CheckPrivilegesWithRequest",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivileges",
"text": "CheckPrivileges"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckPrivilegesWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckSavedObjectsPrivileges",
"type": "Type",
"tags": [],
"label": "CheckSavedObjectsPrivileges",
"description": [],
"signature": [
"(actions: string | string[], namespaceOrNamespaces?: string | (string | undefined)[] | undefined) => Promise<",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckPrivilegesResponse",
"text": "CheckPrivilegesResponse"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_saved_objects_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckSavedObjectsPrivileges.$1",
"type": "CompoundType",
"tags": [],
"label": "actions",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_saved_objects_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckSavedObjectsPrivileges.$2",
"type": "CompoundType",
"tags": [],
"label": "namespaceOrNamespaces",
"description": [],
"signature": [
"string | (string | undefined)[] | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_saved_objects_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CheckSavedObjectsPrivilegesWithRequest",
"type": "Type",
"tags": [],
"label": "CheckSavedObjectsPrivilegesWithRequest",
"description": [],
"signature": [
"(request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.CheckSavedObjectsPrivileges",
"text": "CheckSavedObjectsPrivileges"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_saved_objects_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"returnComment": [],
"children": [
{
"parentPluginId": "security",
"id": "def-server.CheckSavedObjectsPrivilegesWithRequest.$1",
"type": "Object",
"tags": [],
"label": "request",
"description": [],
"signature": [
"KibanaRequest",
"<unknown, unknown, unknown, any>"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/authorization/check_saved_objects_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateAPIKeyParams",
"type": "Type",
"tags": [],
"label": "CreateAPIKeyParams",
"description": [],
"signature": [
"CreateRestAPIKeyParams",
" | ",
"CreateRestAPIKeyWithKibanaPrivilegesParams",
" | ",
"CreateCrossClusterAPIKeyParams"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.CreateAPIKeyResult",
"type": "Type",
"tags": [],
"label": "CreateAPIKeyResult",
"description": [
"\nResponse of Kibana Create API key endpoint."
],
"signature": [
"SecurityCreateApiKeyResponse"
],
"path": "src/core/packages/security/server/src/authentication/api_keys/api_keys.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.KibanaPrivilegesType",
"type": "Type",
"tags": [],
"label": "KibanaPrivilegesType",
"description": [
"\nType representing Kibana specific portion of the role definition."
],
"signature": [
"{ spaces: string[]; base?: string[] | undefined; feature?: Record<string, string[]> | undefined; }[]"
],
"path": "src/core/packages/security/server/src/roles/schema.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.ROUTE_TAG_AUTH_FLOW",
"type": "string",
"tags": [],
"label": "ROUTE_TAG_AUTH_FLOW",
"description": [
"\nThe routes that are involved into authentication flows, especially if they are used by the 3rd\nparties, require special handling."
],
"signature": [
"\"security:authFlow\""
],
"path": "x-pack/platform/plugins/shared/security/server/routes/tags.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.ROUTE_TAG_CAN_REDIRECT",
"type": "string",
"tags": [],
"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."
],
"signature": [
"\"security:canRedirect\""
],
"path": "x-pack/platform/plugins/shared/security/server/routes/tags.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-server.UserProfileServiceStart",
"type": "Type",
"tags": [],
"label": "UserProfileServiceStart",
"description": [
"\nStart contract for Core's userProfile service.\n"
],
"signature": [
"UserProfileService"
],
"path": "src/core/packages/user-profile/server/src/contracts.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [],
"setup": {
"parentPluginId": "security",
"id": "def-server.SecurityPluginSetup",
"type": "Interface",
"tags": [],
"label": "SecurityPluginSetup",
"description": [
"\nDescribes public Security plugin contract returned at the `setup` stage."
],
"signature": [
{
"pluginId": "security",
"scope": "server",
"docId": "kibSecurityPluginApi",
"section": "def-server.SecurityPluginSetup",
"text": "SecurityPluginSetup"
},
" extends ",
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.SecurityPluginSetup",
"text": "SecurityPluginSetup"
}
],
"path": "x-pack/platform/plugins/shared/security/server/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.SecurityPluginSetup.authc",
"type": "Object",
"tags": [
"deprecated"
],
"label": "authc",
"description": [],
"signature": [
"{ getCurrentUser: (request: ",
"KibanaRequest",
"<unknown, unknown, unknown, any>) => ",
"AuthenticatedUser",
" | null; }"
],
"path": "x-pack/platform/plugins/shared/security/server/plugin.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "ml",
"path": "x-pack/platform/plugins/shared/ml/server/routes/annotations.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/rule_preview/api/preview_rules/route.ts"
}
]
},
{
"parentPluginId": "security",
"id": "def-server.SecurityPluginSetup.authz",
"type": "Object",
"tags": [
"deprecated"
],
"label": "authz",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.AuthorizationServiceSetup",
"text": "AuthorizationServiceSetup"
}
],
"path": "x-pack/platform/plugins/shared/security/server/plugin.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "actions",
"path": "x-pack/platform/plugins/shared/actions/server/plugin.ts"
},
{
"plugin": "savedObjectsTagging",
"path": "x-pack/platform/plugins/shared/saved_objects_tagging/server/request_handler_context.ts"
},
{
"plugin": "ml",
"path": "x-pack/platform/plugins/shared/ml/server/saved_objects/initialization/initialization.ts"
},
{
"plugin": "ml",
"path": "x-pack/platform/plugins/shared/ml/server/saved_objects/sync_task.ts"
},
{
"plugin": "ml",
"path": "x-pack/platform/plugins/shared/ml/server/plugin.ts"
},
{
"plugin": "ml",
"path": "x-pack/platform/plugins/shared/ml/server/plugin.ts"
}
]
}
],
"lifecycle": "setup",
"initialIsOpen": true
},
"start": {
"parentPluginId": "security",
"id": "def-server.SecurityPluginStart",
"type": "Interface",
"tags": [],
"label": "SecurityPluginStart",
"description": [
"\nDescribes public Security plugin contract returned at the `start` stage."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/plugin.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-server.SecurityPluginStart.authc",
"type": "Object",
"tags": [
"deprecated"
],
"label": "authc",
"description": [
"\nAuthentication services to confirm the user is who they say they are.\n"
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.AuthenticationServiceStart",
"text": "AuthenticationServiceStart"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/plugin.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "alerting",
"path": "x-pack/platform/plugins/shared/alerting/server/rules_client_factory.ts"
},
{
"plugin": "alerting",
"path": "x-pack/platform/plugins/shared/alerting/server/invalidate_pending_api_keys/task.ts"
},
{
"plugin": "alerting",
"path": "x-pack/platform/plugins/shared/alerting/server/plugin.ts"
},
{
"plugin": "alerting",
"path": "x-pack/platform/plugins/shared/alerting/server/plugin.ts"
},
{
"plugin": "observabilityAIAssistant",
"path": "x-pack/platform/plugins/shared/observability_ai_assistant/server/service/index.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/api_keys/security.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/api_keys/transform_api_keys.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/services/setup/fleet_server_policies_enrollment_keys.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/routes/setup/handlers.ts"
},
{
"plugin": "transform",
"path": "x-pack/platform/plugins/private/transform/server/routes/api/reauthorize_transforms/route_handler_factory.ts"
},
{
"plugin": "upgradeAssistant",
"path": "x-pack/platform/plugins/private/upgrade_assistant/server/lib/reindexing/credential_store.ts"
},
{
"plugin": "upgradeAssistant",
"path": "x-pack/platform/plugins/private/upgrade_assistant/server/lib/reindexing/credential_store.ts"
},
{
"plugin": "upgradeAssistant",
"path": "x-pack/platform/plugins/private/upgrade_assistant/server/lib/reindexing/credential_store.ts"
},
{
"plugin": "entityManager",
"path": "x-pack/platform/plugins/shared/entity_manager/server/lib/auth/api_key/api_key.ts"
},
{
"plugin": "entityManager",
"path": "x-pack/platform/plugins/shared/entity_manager/server/lib/auth/api_key/api_key.ts"
},
{
"plugin": "entityManager",
"path": "x-pack/platform/plugins/shared/entity_manager/server/lib/auth/api_key/api_key.ts"
},
{
"plugin": "entityManager",
"path": "x-pack/platform/plugins/shared/entity_manager/server/lib/entities/uninstall_entity_definition.ts"
},
{
"plugin": "entityManager",
"path": "x-pack/platform/plugins/shared/entity_manager/server/routes/enablement/enable.ts"
},
{
"plugin": "entityManager",
"path": "x-pack/platform/plugins/shared/entity_manager/server/routes/enablement/disable.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/lib/entity_analytics/privilege_monitoring/auth/api_key.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/routes/setup/handlers.test.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/routes/setup/handlers.test.ts"
},
{
"plugin": "fleet",
"path": "x-pack/platform/plugins/shared/fleet/server/routes/setup/handlers.test.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/synthetics_service/get_api_key.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/routes/synthetics_service/enablement.ts"
},
{
"plugin": "synthetics",
"path": "x-pack/solutions/observability/plugins/synthetics/server/routes/synthetics_service/enablement.ts"
},
{
"plugin": "serverlessSearch",
"path": "x-pack/solutions/search/plugins/serverless_search/server/routes/api_key_routes.ts"
},
{
"plugin": "cloudSecurityPosture",
"path": "x-pack/solutions/security/plugins/cloud_security_posture/server/routes/setup_routes.ts"
}
]
},
{
"parentPluginId": "security",
"id": "def-server.SecurityPluginStart.authz",
"type": "Object",
"tags": [],
"label": "authz",
"description": [
"\nAuthorization services to manage and access the permissions a particular user has."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-server",
"scope": "server",
"docId": "kibKbnSecurityPluginTypesServerPluginApi",
"section": "def-server.AuthorizationServiceSetup",
"text": "AuthorizationServiceSetup"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/plugin.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-server.SecurityPluginStart.userProfiles",
"type": "Object",
"tags": [
"deprecated"
],
"label": "userProfiles",
"description": [
"\nUser profiles services to retrieve user profiles.\n"
],
"signature": [
"UserProfileService"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_server/src/plugin.ts",
"deprecated": true,
"trackAdoption": false,
"references": [
{
"plugin": "cases",
"path": "x-pack/platform/plugins/shared/cases/server/services/notifications/email_notification_service.ts"
},
{
"plugin": "cases",
"path": "x-pack/platform/plugins/shared/cases/server/client/factory.ts"
},
{
"plugin": "cases",
"path": "x-pack/platform/plugins/shared/cases/server/client/cases/utils.ts"
},
{
"plugin": "cases",
"path": "x-pack/platform/plugins/shared/cases/server/services/user_profiles/index.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/lib/detection_engine/routes/users/suggest_user_profiles_route.ts"
},
{
"plugin": "securitySolution",
"path": "x-pack/solutions/security/plugins/security_solution/server/lib/timeline/routes/notes/get_notes.ts"
}
]
}
],
"lifecycle": "start",
"initialIsOpen": true
}
},
"common": {
"classes": [],
"functions": [
{
"parentPluginId": "security",
"id": "def-common.getUserDisplayName",
"type": "Function",
"tags": [],
"label": "getUserDisplayName",
"description": [
"\nDetermines the display name for the provided user information."
],
"signature": [
"(params: ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.GetUserDisplayNameParams",
"text": "GetUserDisplayNameParams"
},
") => string"
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.getUserDisplayName.$1",
"type": "Object",
"tags": [],
"label": "params",
"description": [
"Set of available user's name-related fields."
],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.GetUserDisplayNameParams",
"text": "GetUserDisplayNameParams"
}
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.isRoleReserved",
"type": "Function",
"tags": [],
"label": "isRoleReserved",
"description": [
"\nReturns whether given role is reserved or not.\n"
],
"signature": [
"(role: Partial<",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.Role",
"text": "Role"
},
">) => boolean"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.isRoleReserved.$1",
"type": "Object",
"tags": [],
"label": "role",
"description": [
"Role as returned by roles API"
],
"signature": [
"Partial<",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.Role",
"text": "Role"
},
">"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.isRoleWithWildcardBasePrivilege",
"type": "Function",
"tags": [],
"label": "isRoleWithWildcardBasePrivilege",
"description": [
"\nReturns whether given role is editable through the UI or not.\n"
],
"signature": [
"(role: Partial<",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.Role",
"text": "Role"
},
">) => boolean"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.isRoleWithWildcardBasePrivilege.$1",
"type": "Object",
"tags": [],
"label": "role",
"description": [
"the Role as returned by roles API"
],
"signature": [
"Partial<",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.Role",
"text": "Role"
},
">"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [],
"initialIsOpen": false
}
],
"interfaces": [
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser",
"type": "Interface",
"tags": [],
"label": "AuthenticatedUser",
"description": [
"\nRepresents the currently authenticated user."
],
"signature": [
"AuthenticatedUser",
" extends ",
"User"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser.authentication_realm",
"type": "Object",
"tags": [],
"label": "authentication_realm",
"description": [
"\nThe name and type of the Realm that has authenticated the user."
],
"signature": [
"UserRealm"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser.lookup_realm",
"type": "Object",
"tags": [],
"label": "lookup_realm",
"description": [
"\nThe name and type of the Realm where the user information were retrieved from."
],
"signature": [
"UserRealm"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser.authentication_provider",
"type": "Object",
"tags": [],
"label": "authentication_provider",
"description": [
"\nThe authentication provider that used to authenticate user."
],
"signature": [
"AuthenticationProvider"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser.authentication_type",
"type": "string",
"tags": [],
"label": "authentication_type",
"description": [
"\nThe AuthenticationType used by ES to authenticate the user.\n"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser.elastic_cloud_user",
"type": "boolean",
"tags": [],
"label": "elastic_cloud_user",
"description": [
"\nIndicates whether user is authenticated via Elastic Cloud built-in SAML realm."
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser.profile_uid",
"type": "string",
"tags": [],
"label": "profile_uid",
"description": [
"\nUser profile ID of this user."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser.operator",
"type": "CompoundType",
"tags": [],
"label": "operator",
"description": [
"\nIndicates whether user is an operator."
],
"signature": [
"boolean | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticatedUser.api_key",
"type": "Object",
"tags": [],
"label": "api_key",
"description": [
"\nMetadata of the API key that was used to authenticate the user."
],
"signature": [
"ApiKeyDescriptor",
" | undefined"
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticationProvider",
"type": "Interface",
"tags": [],
"label": "AuthenticationProvider",
"description": [
"\nType and name tuple to identify provider used to authenticate user."
],
"path": "src/core/packages/security/common/src/authentication/authentication_provider.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.AuthenticationProvider.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"\nType of the Kibana authentication provider."
],
"path": "src/core/packages/security/common/src/authentication/authentication_provider.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.AuthenticationProvider.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nName of the Kibana authentication provider (arbitrary string)."
],
"path": "src/core/packages/security/common/src/authentication/authentication_provider.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.BuiltinESPrivileges",
"type": "Interface",
"tags": [],
"label": "BuiltinESPrivileges",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/builtin_es_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.BuiltinESPrivileges.cluster",
"type": "Array",
"tags": [],
"label": "cluster",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/security/common/model/builtin_es_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.BuiltinESPrivileges.index",
"type": "Array",
"tags": [],
"label": "index",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/security/common/model/builtin_es_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.BuiltinESPrivileges.remote_cluster",
"type": "Array",
"tags": [],
"label": "remote_cluster",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/plugins/shared/security/common/model/builtin_es_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.EditUser",
"type": "Interface",
"tags": [],
"label": "EditUser",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.EditUser",
"text": "EditUser"
},
" extends ",
"User"
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.EditUser.password",
"type": "string",
"tags": [],
"label": "password",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.EditUser.confirmPassword",
"type": "string",
"tags": [],
"label": "confirmPassword",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.FeaturesPrivileges",
"type": "Interface",
"tags": [],
"label": "FeaturesPrivileges",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/features_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.FeaturesPrivileges.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[featureId: string]: string[]",
"description": [],
"signature": [
"[featureId: string]: string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/features_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.GetUserDisplayNameParams",
"type": "Interface",
"tags": [],
"label": "GetUserDisplayNameParams",
"description": [
"\nSet of available name-related fields to pick as display name."
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.GetUserDisplayNameParams.username",
"type": "string",
"tags": [],
"label": "username",
"description": [
"\nUsername of the user."
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.GetUserDisplayNameParams.email",
"type": "string",
"tags": [],
"label": "email",
"description": [
"\nOptional email of the user."
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.GetUserDisplayNameParams.full_name",
"type": "string",
"tags": [],
"label": "full_name",
"description": [
"\nOptional full name of the user."
],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/user.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.GetUserProfileResponse",
"type": "Interface",
"tags": [],
"label": "GetUserProfileResponse",
"description": [
"\nUser profile enriched with session information."
],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.GetUserProfileResponse",
"text": "GetUserProfileResponse"
},
"<D> extends ",
"UserProfileWithSecurity",
"<D, ",
"UserProfileLabels",
">"
],
"path": "x-pack/platform/plugins/shared/security/common/model/user_profile.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.GetUserProfileResponse.user",
"type": "CompoundType",
"tags": [],
"label": "user",
"description": [
"\nInformation about the currently authenticated user that owns the profile."
],
"signature": [
"UserProfileUserInfoWithSecurity",
" & Pick<",
"AuthenticatedUser",
", \"authentication_provider\">"
],
"path": "x-pack/platform/plugins/shared/security/common/model/user_profile.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.InlineRoleTemplate",
"type": "Interface",
"tags": [],
"label": "InlineRoleTemplate",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.InlineRoleTemplate.template",
"type": "Object",
"tags": [],
"label": "template",
"description": [],
"signature": [
"{ source: string; }"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.InlineRoleTemplate.format",
"type": "CompoundType",
"tags": [],
"label": "format",
"description": [],
"signature": [
"RoleTemplateFormat | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.InvalidRoleTemplate",
"type": "Interface",
"tags": [],
"label": "InvalidRoleTemplate",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.InvalidRoleTemplate.template",
"type": "string",
"tags": [],
"label": "template",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.InvalidRoleTemplate.format",
"type": "CompoundType",
"tags": [],
"label": "format",
"description": [],
"signature": [
"RoleTemplateFormat | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RawKibanaFeaturePrivileges",
"type": "Interface",
"tags": [],
"label": "RawKibanaFeaturePrivileges",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/raw_kibana_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RawKibanaFeaturePrivileges.Unnamed",
"type": "IndexSignature",
"tags": [],
"label": "[featureId: string]: { [privilegeId: string]: string[]; }",
"description": [],
"signature": [
"[featureId: string]: { [privilegeId: string]: string[]; }"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/raw_kibana_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RawKibanaPrivileges",
"type": "Interface",
"tags": [],
"label": "RawKibanaPrivileges",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/raw_kibana_privileges.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RawKibanaPrivileges.global",
"type": "Object",
"tags": [],
"label": "global",
"description": [],
"signature": [
"{ [x: string]: string[]; }"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/raw_kibana_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RawKibanaPrivileges.features",
"type": "Object",
"tags": [],
"label": "features",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.RawKibanaFeaturePrivileges",
"text": "RawKibanaFeaturePrivileges"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/raw_kibana_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RawKibanaPrivileges.space",
"type": "Object",
"tags": [],
"label": "space",
"description": [],
"signature": [
"{ [x: string]: string[]; }"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/raw_kibana_privileges.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RawKibanaPrivileges.reserved",
"type": "Object",
"tags": [],
"label": "reserved",
"description": [],
"signature": [
"{ [x: string]: string[]; }"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/raw_kibana_privileges.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.Role",
"type": "Interface",
"tags": [],
"label": "Role",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.Role.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.Role.description",
"type": "string",
"tags": [],
"label": "description",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.Role.elasticsearch",
"type": "Object",
"tags": [],
"label": "elasticsearch",
"description": [],
"signature": [
"{ cluster: string[]; remote_cluster?: ",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.RoleRemoteClusterPrivilege",
"text": "RoleRemoteClusterPrivilege"
},
"[] | undefined; indices: ",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.RoleIndexPrivilege",
"text": "RoleIndexPrivilege"
},
"[]; remote_indices?: ",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.RoleRemoteIndexPrivilege",
"text": "RoleRemoteIndexPrivilege"
},
"[] | undefined; run_as: string[]; }"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.Role.kibana",
"type": "Array",
"tags": [],
"label": "kibana",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.RoleKibanaPrivilege",
"text": "RoleKibanaPrivilege"
},
"[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.Role.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"{ [anyKey: string]: any; } | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.Role.transient_metadata",
"type": "Object",
"tags": [],
"label": "transient_metadata",
"description": [],
"signature": [
"{ [anyKey: string]: any; } | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.Role._transform_error",
"type": "Array",
"tags": [],
"label": "_transform_error",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.Role._unrecognized_applications",
"type": "Array",
"tags": [],
"label": "_unrecognized_applications",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleIndexPrivilege",
"type": "Interface",
"tags": [],
"label": "RoleIndexPrivilege",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleIndexPrivilege.names",
"type": "Array",
"tags": [],
"label": "names",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleIndexPrivilege.privileges",
"type": "Array",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleIndexPrivilege.field_security",
"type": "Object",
"tags": [],
"label": "field_security",
"description": [],
"signature": [
"{ grant?: string[] | undefined; except?: string[] | undefined; } | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleIndexPrivilege.query",
"type": "string",
"tags": [],
"label": "query",
"description": [],
"signature": [
"string | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleKibanaPrivilege",
"type": "Interface",
"tags": [],
"label": "RoleKibanaPrivilege",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleKibanaPrivilege.spaces",
"type": "Array",
"tags": [],
"label": "spaces",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleKibanaPrivilege.base",
"type": "Array",
"tags": [],
"label": "base",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleKibanaPrivilege.feature",
"type": "Object",
"tags": [],
"label": "feature",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.FeaturesPrivileges",
"text": "FeaturesPrivileges"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleKibanaPrivilege._reserved",
"type": "Array",
"tags": [],
"label": "_reserved",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMapping",
"type": "Interface",
"tags": [],
"label": "RoleMapping",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleMapping.name",
"type": "string",
"tags": [],
"label": "name",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMapping.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMapping.roles",
"type": "Array",
"tags": [],
"label": "roles",
"description": [],
"signature": [
"string[] | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMapping.role_templates",
"type": "Array",
"tags": [],
"label": "role_templates",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleTemplate",
"text": "RoleTemplate"
},
"[] | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMapping.rules",
"type": "CompoundType",
"tags": [],
"label": "rules",
"description": [],
"signature": [
"{} | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingRule",
"text": "RoleMappingRule"
}
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMapping.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMappingAllRule",
"type": "Interface",
"tags": [],
"label": "RoleMappingAllRule",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleMappingAllRule.all",
"type": "Array",
"tags": [],
"label": "all",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingRule",
"text": "RoleMappingRule"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMappingAnyRule",
"type": "Interface",
"tags": [],
"label": "RoleMappingAnyRule",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleMappingAnyRule.any",
"type": "Array",
"tags": [],
"label": "any",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingRule",
"text": "RoleMappingRule"
},
"[]"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMappingExceptRule",
"type": "Interface",
"tags": [],
"label": "RoleMappingExceptRule",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleMappingExceptRule.except",
"type": "CompoundType",
"tags": [],
"label": "except",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingAnyRule",
"text": "RoleMappingAnyRule"
},
" | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingAllRule",
"text": "RoleMappingAllRule"
},
" | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingFieldRule",
"text": "RoleMappingFieldRule"
},
" | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingExceptRule",
"text": "RoleMappingExceptRule"
}
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMappingFieldRule",
"type": "Interface",
"tags": [],
"label": "RoleMappingFieldRule",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleMappingFieldRule.field",
"type": "Object",
"tags": [],
"label": "field",
"description": [],
"signature": [
"{ [x: string]: any; }"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleRemoteClusterPrivilege",
"type": "Interface",
"tags": [],
"label": "RoleRemoteClusterPrivilege",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleRemoteClusterPrivilege.clusters",
"type": "CompoundType",
"tags": [],
"label": "clusters",
"description": [],
"signature": [
"string | string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleRemoteClusterPrivilege.privileges",
"type": "Array",
"tags": [],
"label": "privileges",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.RemoteClusterPrivilege",
"text": "RemoteClusterPrivilege"
},
"[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleRemoteIndexPrivilege",
"type": "Interface",
"tags": [],
"label": "RoleRemoteIndexPrivilege",
"description": [],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.RoleRemoteIndexPrivilege",
"text": "RoleRemoteIndexPrivilege"
},
" extends ",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.RoleIndexPrivilege",
"text": "RoleIndexPrivilege"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.RoleRemoteIndexPrivilege.clusters",
"type": "Array",
"tags": [],
"label": "clusters",
"description": [],
"signature": [
"string[]"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/authorization/role.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense",
"type": "Interface",
"tags": [],
"label": "SecurityLicense",
"description": [],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense.isLicenseAvailable",
"type": "Function",
"tags": [],
"label": "isLicenseAvailable",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense.getLicenseType",
"type": "Function",
"tags": [],
"label": "getLicenseType",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense.getUnavailableReason",
"type": "Function",
"tags": [],
"label": "getUnavailableReason",
"description": [],
"signature": [
"() => string | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense.isEnabled",
"type": "Function",
"tags": [],
"label": "isEnabled",
"description": [],
"signature": [
"() => boolean"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense.getFeatures",
"type": "Function",
"tags": [],
"label": "getFeatures",
"description": [],
"signature": [
"() => ",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.SecurityLicenseFeatures",
"text": "SecurityLicenseFeatures"
}
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense.hasAtLeast",
"type": "Function",
"tags": [],
"label": "hasAtLeast",
"description": [],
"signature": [
"(licenseType: \"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\") => boolean | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense.hasAtLeast.$1",
"type": "CompoundType",
"tags": [],
"label": "licenseType",
"description": [],
"signature": [
"\"basic\" | \"standard\" | \"gold\" | \"platinum\" | \"enterprise\" | \"trial\""
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicense.features$",
"type": "Object",
"tags": [],
"label": "features$",
"description": [],
"signature": [
"Observable",
"<",
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.SecurityLicenseFeatures",
"text": "SecurityLicenseFeatures"
},
">"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures",
"type": "Interface",
"tags": [],
"label": "SecurityLicenseFeatures",
"description": [
"\nDescribes Security plugin features that depend on license."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.showLogin",
"type": "boolean",
"tags": [],
"label": "showLogin",
"description": [
"\nIndicates whether we show login page or skip it."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowLogin",
"type": "boolean",
"tags": [],
"label": "allowLogin",
"description": [
"\nIndicates whether we allow login or disable it on the login page."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.showLinks",
"type": "boolean",
"tags": [],
"label": "showLinks",
"description": [
"\nIndicates whether we show security links throughout the kibana app."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.showRoleMappingsManagement",
"type": "boolean",
"tags": [],
"label": "showRoleMappingsManagement",
"description": [
"\nIndicates whether we show the Role Mappings UI."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowAccessAgreement",
"type": "boolean",
"tags": [],
"label": "allowAccessAgreement",
"description": [
"\nIndicates whether we allow users to access agreement UI and acknowledge it."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowAuditLogging",
"type": "boolean",
"tags": [],
"label": "allowAuditLogging",
"description": [
"\nIndicates whether we allow logging of audit events."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowRoleDocumentLevelSecurity",
"type": "boolean",
"tags": [],
"label": "allowRoleDocumentLevelSecurity",
"description": [
"\nIndicates whether we allow users to define document level security in roles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowRoleFieldLevelSecurity",
"type": "boolean",
"tags": [],
"label": "allowRoleFieldLevelSecurity",
"description": [
"\nIndicates whether we allow users to define field level security in roles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowRoleRemoteIndexPrivileges",
"type": "boolean",
"tags": [],
"label": "allowRoleRemoteIndexPrivileges",
"description": [
"\nIndicates whether we allow users to define remote index privileges in roles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowRemoteClusterPrivileges",
"type": "boolean",
"tags": [],
"label": "allowRemoteClusterPrivileges",
"description": [
"\nIndicates whether we allow users to define remote cluster privileges in roles."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowRbac",
"type": "boolean",
"tags": [],
"label": "allowRbac",
"description": [
"\nIndicates whether we allow Role-based access control (RBAC)."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowSubFeaturePrivileges",
"type": "boolean",
"tags": [],
"label": "allowSubFeaturePrivileges",
"description": [
"\nIndicates whether we allow sub-feature privileges."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowUserProfileCollaboration",
"type": "boolean",
"tags": [],
"label": "allowUserProfileCollaboration",
"description": [
"\nIndicates whether we allow user profile collaboration features (suggest and privileges checks APIs)."
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.layout",
"type": "CompoundType",
"tags": [],
"label": "layout",
"description": [
"\nDescribes the layout of the login form if it's displayed."
],
"signature": [
{
"pluginId": "@kbn/security-plugin-types-common",
"scope": "common",
"docId": "kibKbnSecurityPluginTypesCommonPluginApi",
"section": "def-common.LoginLayout",
"text": "LoginLayout"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.SecurityLicenseFeatures.allowFips",
"type": "boolean",
"tags": [],
"label": "allowFips",
"description": [
"\nIndicates whether we allow FIPS mode"
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.StoredRoleTemplate",
"type": "Interface",
"tags": [],
"label": "StoredRoleTemplate",
"description": [],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.StoredRoleTemplate.template",
"type": "Object",
"tags": [],
"label": "template",
"description": [],
"signature": [
"{ id: string; }"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.StoredRoleTemplate.format",
"type": "CompoundType",
"tags": [],
"label": "format",
"description": [],
"signature": [
"RoleTemplateFormat | undefined"
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.User",
"type": "Interface",
"tags": [],
"label": "User",
"description": [
"\nA set of fields describing Kibana user."
],
"path": "src/core/packages/security/common/src/authentication/user.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.User.username",
"type": "string",
"tags": [],
"label": "username",
"description": [],
"path": "src/core/packages/security/common/src/authentication/user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.User.email",
"type": "string",
"tags": [],
"label": "email",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/common/src/authentication/user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.User.full_name",
"type": "string",
"tags": [],
"label": "full_name",
"description": [],
"signature": [
"string | undefined"
],
"path": "src/core/packages/security/common/src/authentication/user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.User.roles",
"type": "Object",
"tags": [],
"label": "roles",
"description": [],
"signature": [
"readonly string[]"
],
"path": "src/core/packages/security/common/src/authentication/user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.User.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [],
"path": "src/core/packages/security/common/src/authentication/user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.User.metadata",
"type": "Object",
"tags": [],
"label": "metadata",
"description": [],
"signature": [
"{ _reserved: boolean; _deprecated?: boolean | undefined; _deprecated_reason?: string | undefined; } | undefined"
],
"path": "src/core/packages/security/common/src/authentication/user.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfile",
"type": "Interface",
"tags": [],
"label": "UserProfile",
"description": [
"\nIMPORTANT:\n\nThe types in this file are duplicated at\n`src/platform/packages/shared/kbn-user-profile-components/src/user_profile.ts`\n\nWhen making changes please ensure to keep both files in sync.\n\nDescribes basic properties stored in user profile."
],
"signature": [
"UserProfile",
"<D>"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.UserProfile.uid",
"type": "string",
"tags": [],
"label": "uid",
"description": [
"\nUnique ID for of the user profile."
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfile.enabled",
"type": "boolean",
"tags": [],
"label": "enabled",
"description": [
"\nIndicates whether user profile is enabled or not."
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfile.user",
"type": "Object",
"tags": [],
"label": "user",
"description": [
"\nInformation about the user that owns profile."
],
"signature": [
"UserProfileUserInfo"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfile.data",
"type": "Object",
"tags": [],
"label": "data",
"description": [
"\nUser specific data associated with the profile."
],
"signature": [
"{ [P in keyof D]?: D[P] | undefined; }"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileUserInfo",
"type": "Interface",
"tags": [],
"label": "UserProfileUserInfo",
"description": [
"\nBasic user information returned in user profile."
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.UserProfileUserInfo.username",
"type": "string",
"tags": [],
"label": "username",
"description": [
"\nUsername of the user."
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileUserInfo.email",
"type": "string",
"tags": [],
"label": "email",
"description": [
"\nOptional email of the user."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileUserInfo.full_name",
"type": "string",
"tags": [],
"label": "full_name",
"description": [
"\nOptional full name of the user."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileUserInfoWithSecurity",
"type": "Interface",
"tags": [],
"label": "UserProfileUserInfoWithSecurity",
"description": [
"\nExtended user information returned in user profile (both basic and security related properties)."
],
"signature": [
"UserProfileUserInfoWithSecurity",
" extends ",
"UserProfileUserInfo"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.UserProfileUserInfoWithSecurity.roles",
"type": "Object",
"tags": [],
"label": "roles",
"description": [
"\nList of the user roles."
],
"signature": [
"readonly string[]"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileUserInfoWithSecurity.realm_name",
"type": "string",
"tags": [],
"label": "realm_name",
"description": [
"\nName of the Elasticsearch security realm that was used to authenticate user."
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileUserInfoWithSecurity.realm_domain",
"type": "string",
"tags": [],
"label": "realm_domain",
"description": [
"\nOptional name of the security domain that Elasticsearch security realm that was\nused to authenticate user resides in (if any)."
],
"signature": [
"string | undefined"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileWithSecurity",
"type": "Interface",
"tags": [],
"label": "UserProfileWithSecurity",
"description": [
"\nDescribes all properties stored in user profile (both basic and security related properties)."
],
"signature": [
"UserProfileWithSecurity",
"<D, L> extends ",
"UserProfile",
"<D>"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.UserProfileWithSecurity.user",
"type": "Object",
"tags": [],
"label": "user",
"description": [
"\nInformation about the user that owns profile."
],
"signature": [
"UserProfileUserInfoWithSecurity"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileWithSecurity.labels",
"type": "Uncategorized",
"tags": [],
"label": "labels",
"description": [
"\nUser specific _searchable_ labels associated with the profile. Note that labels are considered\nsecurity related field since it's going to be used to store user's space ID."
],
"signature": [
"L"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.UserRealm",
"type": "Interface",
"tags": [],
"label": "UserRealm",
"description": [
"\nAn Elasticsearch realm that was used to resolve and authenticate the user."
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "security",
"id": "def-common.UserRealm.name",
"type": "string",
"tags": [],
"label": "name",
"description": [
"\nArbitrary name of the security realm."
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
},
{
"parentPluginId": "security",
"id": "def-common.UserRealm.type",
"type": "string",
"tags": [],
"label": "type",
"description": [
"\nType of the security realm (file, native, saml etc.)."
],
"path": "src/core/packages/security/common/src/authentication/authenticated_user.ts",
"deprecated": false,
"trackAdoption": false
}
],
"initialIsOpen": false
}
],
"enums": [],
"misc": [
{
"parentPluginId": "security",
"id": "def-common.LoginLayout",
"type": "Type",
"tags": [],
"label": "LoginLayout",
"description": [
"\nRepresents types of login form layouts."
],
"signature": [
"\"form\" | \"error-es-unavailable\" | \"error-xpack-unavailable\""
],
"path": "x-pack/platform/packages/shared/security/plugin_types_common/src/licensing/license_features.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleMappingRule",
"type": "Type",
"tags": [],
"label": "RoleMappingRule",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingAnyRule",
"text": "RoleMappingAnyRule"
},
" | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingAllRule",
"text": "RoleMappingAllRule"
},
" | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingFieldRule",
"text": "RoleMappingFieldRule"
},
" | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.RoleMappingExceptRule",
"text": "RoleMappingExceptRule"
}
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.RoleTemplate",
"type": "Type",
"tags": [],
"label": "RoleTemplate",
"description": [],
"signature": [
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.InlineRoleTemplate",
"text": "InlineRoleTemplate"
},
" | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.StoredRoleTemplate",
"text": "StoredRoleTemplate"
},
" | ",
{
"pluginId": "security",
"scope": "common",
"docId": "kibSecurityPluginApi",
"section": "def-common.InvalidRoleTemplate",
"text": "InvalidRoleTemplate"
}
],
"path": "x-pack/platform/plugins/shared/security/common/model/role_mapping.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileData",
"type": "Type",
"tags": [],
"label": "UserProfileData",
"description": [
"\nPlaceholder for data stored in user profile."
],
"signature": [
"{ [x: string]: unknown; }"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "security",
"id": "def-common.UserProfileLabels",
"type": "Type",
"tags": [],
"label": "UserProfileLabels",
"description": [
"\nType of the user profile labels structure (currently"
],
"signature": [
"{ [x: string]: string; }"
],
"path": "src/core/packages/user-profile/common/src/user_profile.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": []
}
}
Reference in a new issue View git blame Copy permalink