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

* Update docs

* Fix test and types

* debug heap size

* remove debug heap line

* updated docs
2021-10-06 17:02:57 -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}/>