[DOCS] Adds docs for API Keys UI #49135
Conversation
gchaps
added
Team:Docs
v8.0.0
release_note:skip
|
Pinging @elastic/kibana-docs (Team:Docs) |
|
@elasticmachine, run elasticsearch-ci/docs |
There was a problem hiding this comment.
@gchaps nice job! LGTM. I left one suggestion about swapping the order of Security privileges and API key service.
|
|
||
| [float] | ||
| [[api-keys-service]] | ||
| === {es} API key service |
There was a problem hiding this comment.
Do you think it makes sense to move this section above Security privileges? Even if you had the correct privileges, if the API Key service isn't enabled, you would not be able to use API keys.
| [[api-keys]] | ||
| === API Keys | ||
|
|
||
| An API key enables you to create secondary credentials with the same or lower |
| them in *Management > Security > API Keys*. | ||
|
|
||
| [role="screenshot"] | ||
| image:user/security/api-keys/images/api-keys.png["API Keys UI"] |
There was a problem hiding this comment.
It looks like the UI uses both API Keys and API keys
| [[api-keys]] | ||
| === API Keys | ||
|
|
||
| An API key enables you to create secondary credentials with the same or lower |
There was a problem hiding this comment.
How about:
API keys enable you to create secondary credentials so that you can send requests on behalf of other Kibana users. Secondary credentials have the same or lower access rights.
|
|
||
| The {es} API key service is automatically enabled when you configure | ||
| {ref}/configuring-tls.html#tls-http[TLS on the HTTP interface]. | ||
| This ensures that API keys are not sent in clear-text by clients. |
There was a problem hiding this comment.
How about:
This makes sure that clients are unable to send API keys in clear-text.
| {ref}/configuring-tls.html#tls-http[TLS on the HTTP interface]. | ||
| This ensures that API keys are not sent in clear-text by clients. | ||
|
|
||
| If HTTPS connections are not enabled between {kib} and {es}, you will |
There was a problem hiding this comment.
How about:
When HTTPS connections are not enabled between Kibana and Elasticsearch, you cannot use or manage API keys, and you get an error message.
| "expiration": "1d" | ||
| } | ||
|
|
||
| This creates an API key with the name my_api_key that |
There was a problem hiding this comment.
my_api_key > my_api_key
| You can also use API keys to automate ingestion of new data from | ||
| remote sources, without a live user interaction. | ||
|
|
||
| You can create API Keys in the {kib} Console and view and invalidate |
There was a problem hiding this comment.
Instead of starting a second sentence with you can, how about:
`To create, view, and invalidate APIs keys in the Kibana Console, go to Management > Security > API Keys.
* [DOCS] Adds docs for API Keys UI * [DOCS] Incorporates review comments into API keys doc * [DOCS] Fixes typo
* [DOCS] Adds docs for API Keys UI * [DOCS] Incorporates review comments into API keys doc * [DOCS] Fixes typo
Summary
Fixes #47873
This PR adds documentation for the new API Keys UI
A formatted version of the doc is here.
[skip ci]