github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-24 01:38:56 -04:00
Code Issues Projects Releases Packages Wiki Activity

[8.x] [DOCS] Clarify alerting API key management (#208292) (#208462)

Browse source 
# Backport

This will backport the following commits from `main` to `8.x`:
- [[DOCS] Clarify alerting API key management
(#208292)](https://github.com/elastic/kibana/pull/208292)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2025-01-27T22:56:07Z","message":"[DOCS]
Clarify alerting API key management
(#208292)","sha":"5624fc21066561e87af2b59ec384e62f8fc00766","branchLabelMapping":{"^v9.0.0$":"main","^v8.18.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","v9.0.0","docs","backport:prev-minor","v8.18.0"],"title":"[DOCS]
Clarify alerting API key
management","number":208292,"url":"https://github.com/elastic/kibana/pull/208292","mergeCommit":{"message":"[DOCS]
Clarify alerting API key management
(#208292)","sha":"5624fc21066561e87af2b59ec384e62f8fc00766"}},"sourceBranch":"main","suggestedTargetBranches":["8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/208292","number":208292,"mergeCommit":{"message":"[DOCS]
Clarify alerting API key management
(#208292)","sha":"5624fc21066561e87af2b59ec384e62f8fc00766"}},{"branch":"8.x","label":"v8.18.0","branchLabelMappingKey":"^v8.18.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
This commit is contained in:
Kibana Machine 2025-01-28 10:27:07 +11:00 • committed by GitHub
parent 7529444d01
commit 608a25edc3
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 5 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

12
docs/user/alerting/alerting-setup.asciidoc
View file

@ -113,16 +113,14 @@ For more information on configuring roles that provide access to features, go to
Rules are authorized using an API key.
Its credentials are used to run all background tasks associated with the rule, including condition checks like {es} queries and triggered actions.
If you create or edit a rule in {kib}, an API key is created that captures a snapshot of your privileges at the time of the edit.
The following actions regenerate the API key in {kib}:
* Creating a rule
* Updating a rule
When you create a rule in {kib}, an API key is created that captures a snapshot of your privileges.
Likewise when you update a rule, the API key is updated with a snapshot of your privileges at the time of the edit.
When you disable a rule, it retains the associated API key which is reused when the rule is enabled.
If the API key is missing when you enable the rule (for example, in the case of imported rules), it generates a new key that has your security privileges.
If the API key is missing when you enable the rule, a new key is generated that has your current security privileges.
When you import a rule, you must enable it before you can use it and a new API key is generated at that time.
You can update an API key manually in **{stack-manage-app} > {rules-ui}** or in the rule details page by selecting **Update API key** in the actions menu.
You can generate a new API key at any time in **{stack-manage-app} > {rules-ui}** or in the rule details page by selecting **Update API key** in the actions menu.
If you manage your rules by using {kib} APIs, they support support both key- and token-based authentication as described in <<api-authentication>>.
To use key-based authentication, create API keys and use them in the header of your API calls as described in <<api-keys>>.