kibana/api_docs/security.mdx
Stacey Gammon 8aa370ba3b
Improve security plugin return types (#101492)
* Add explicit security types

* Remove sessionTimeout, seems unused

* add comments

* Add comments and fix test since removing the unused APIs

* remove unused import

* wording cleanup

* Export some types that are part of the public API but not exported

* more improvements for api docs

* update security docs

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/nav_control/nav_control_service.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* Update x-pack/plugins/security/public/plugin.tsx

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>

* remove unneccessary readonly prefix

* Update all api docs

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
2021-06-08 14:05:14 -04:00

41 lines
1,019 B
Plaintext

---
id: kibSecurityPluginApi
slug: /kibana-dev-docs/securityPluginApi
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';
## 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
### Interfaces
<DocDefinitionList data={securityObj.server.interfaces}/>
### Consts, variables and types
<DocDefinitionList data={securityObj.server.misc}/>
## Common
### Interfaces
<DocDefinitionList data={securityObj.common.interfaces}/>