kibana/api_docs/security.mdx
Stacey Gammon e92a945ab1
Add packages to our API documentation (#113564) (#114513)
* Add packages

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
# Conflicts:
#	api_docs/alerting.mdx
#	api_docs/apm.json
#	api_docs/core.mdx
#	api_docs/core_application.mdx
#	api_docs/core_chrome.mdx
#	api_docs/core_http.mdx
#	api_docs/core_saved_objects.mdx
#	api_docs/custom_integrations.mdx
#	api_docs/data.json
#	api_docs/data.mdx
#	api_docs/data_autocomplete.mdx
#	api_docs/data_data_views.json
#	api_docs/data_data_views.mdx
#	api_docs/data_query.mdx
#	api_docs/data_search.mdx
#	api_docs/data_ui.mdx
#	api_docs/deprecations_by_api.mdx
#	api_docs/deprecations_by_plugin.mdx
#	api_docs/discover_enhanced.json
#	api_docs/embeddable.json
#	api_docs/event_log.mdx
#	api_docs/fleet.mdx
#	api_docs/home.json
#	api_docs/index_management.json
#	api_docs/interactive_setup.mdx
#	api_docs/kibana_legacy.json
#	api_docs/kibana_legacy.mdx
#	api_docs/observability.mdx
#	api_docs/plugin_directory.mdx
#	api_docs/security_oss.mdx
2021-10-11 13:58:18 -04:00

56 lines
1.6 KiB
Plaintext

---
id: kibSecurityPluginApi
slug: /kibana-dev-docs/api/security
title: "security"
image: https://source.unsplash.com/400x175/?github
summary: API docs for the security plugin
date: 2020-11-16
tags: ['contributor', 'dev', 'apidocs', 'kibana', 'security']
warning: This document is auto-generated and is meant to be viewed inside our experimental, new docs system. Reach out in #docs-engineering for more info.
---
import securityObj from './security.json';
This plugin provides authentication and authorization features, and exposes functionality to understand the capabilities of the currently authenticated user.
Contact [Platform Security](https://github.com/orgs/elastic/teams/kibana-security) for questions regarding this plugin.
**Code health stats**
| Public API count | Any count | Items lacking comments | Missing exports |
|-------------------|-----------|------------------------|-----------------|
| 113 | 0 | 51 | 7 |
## Client
### Setup
<DocDefinitionList data={[securityObj.client.setup]}/>
### Start
<DocDefinitionList data={[securityObj.client.start]}/>
### Interfaces
<DocDefinitionList data={securityObj.client.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={securityObj.client.misc}/>
## Server
### Setup
<DocDefinitionList data={[securityObj.server.setup]}/>
### Start
<DocDefinitionList data={[securityObj.server.start]}/>
### Interfaces
<DocDefinitionList data={securityObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={securityObj.server.misc}/>
## Common
### Interfaces
<DocDefinitionList data={securityObj.common.interfaces}/>