Commit graph

17 commits

Author SHA1 Message Date
Kibana Machine
418281b2d1
[8.x] [Docs] Update nav instructions and sample data installation to accommodate for the solution views (#199163) (#199438)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[Docs] Update nav instructions and sample data installation to
accommodate for the solution views
(#199163)](https://github.com/elastic/kibana/pull/199163)

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

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

<!--BACKPORT
[{"author":{"name":"florent-leborgne","email":"florent.leborgne@elastic.co"},"sourceCommit":{"committedDate":"2024-11-08T10:10:32Z","message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","release_note:skip","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"title":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution
views","number":199163,"url":"https://github.com/elastic/kibana/pull/199163","mergeCommit":{"message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","branchLabelMappingKey":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/199163","number":199163,"mergeCommit":{"message":"[Docs]
Update nav instructions and sample data installation to accommodate for
the solution views (#199163)\n\nThis PR:\r\n- updates navigation
instructions to accommodate for the navigation\r\nchanges related to
solution views.\r\n- updates instructions for adding sample data to rely
on the\r\nintegrations page instead of the home page, that only exists
with the\r\nclassic solution view\r\n- updates references to the home
page to avoid confusing users using one\r\nof the new solution
views\r\n\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/529\r\nCloses:
https://github.com/elastic/platform-docs-team/issues/540","sha":"8e7fb7a77e2399e3e946bbba0462517fd7dad0f7"}},{"branch":"8.16","label":"v8.16.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","branchLabelMappingKey":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
2024-11-08 10:41:00 +00:00
Lisa Cawley
c056931598
[8.x] [OpenAPI][DOCS] Add descriptions, examples, responses for role APIs (#195527) (#197889)
# Backport

This will backport the following commits from `main` to `8.x`:
- [[OpenAPI][DOCS] Add descriptions, examples, responses for role APIs
(#195527)](https://github.com/elastic/kibana/pull/195527)

<!--- Backport version: 8.9.8 -->

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

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-10-25T17:13:57Z","message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595","branchLabelMapping":{"^v9.0.0$":"main","^v8.17.0$":"8.x","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Security","release_note:skip","Feature:Security/Authorization","v9.0.0","docs","v8.16.0","backport:version","v8.17.0"],"number":195527,"url":"https://github.com/elastic/kibana/pull/195527","mergeCommit":{"message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595"}},"sourceBranch":"main","suggestedTargetBranches":["8.16","8.x"],"targetPullRequestStates":[{"branch":"main","label":"v9.0.0","labelRegex":"^v9.0.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/195527","number":195527,"mergeCommit":{"message":"[OpenAPI][DOCS]
Add descriptions, examples, responses for role APIs
(#195527)\n\nCo-authored-by: Elena Shostak
<165678770+elena-shostak@users.noreply.github.com>","sha":"02fab7248d5b4e537030252df81bef55d04d0595"}},{"branch":"8.16","label":"v8.16.0","labelRegex":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.x","label":"v8.17.0","labelRegex":"^v8.17.0$","isSourceBranch":false,"state":"NOT_CREATED"}]}]
BACKPORT-->

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2024-10-28 20:04:48 -05:00
Larry Gregory
0ac38ec851
Update copy for API Key management (#175809)
## Summary

Resolves https://github.com/elastic/kibana/issues/166095.

This updates the API Key management screen to reflect the copy
adjustments described in #166095:

1. Change `Cross-Cluster` to `Cross-cluster`, unless it is mid-sentence
in which case `cross-cluster` should be used.
2. Updated ownership & expiry warnings to use the active voice.
3. Renamed `Personal` API Keys to `User` API Keys.


![Larry Gregory 2024-01-29 at 10 12
45@2x](8df4e279-5d68-4353-87aa-e40e6949f528)

![Larry Gregory 2024-01-29 at 10 14
02@2x](290166ea-51a3-43ae-bed4-7278865b1bdc)

![Larry Gregory 2024-01-29 at 10 15
03@2x](97bb6426-e8ce-4bc1-b5ae-44944683978f)


![Larry Gregory 2024-01-29 at 10 15
27@2x](61adfece-05eb-4fbc-bf68-265d5cfaa987)


View docs changes here:
https://kibana_bk_175809.docs-preview.app.elstc.co/diff
2024-01-30 09:36:39 +01:00
amyjtechwriter
4ffd7562ff
[DOCS] Updating API key page in Kibana docs (#165599)
## Summary

This PR adds the new cross-cluster API key option to the [API Keys
page](https://www.elastic.co/guide/en/kibana/current/api-keys.html) and
makes some further edits to the page.

Relates to: #162363 & #163566

---------

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
2023-09-08 12:05:35 +01:00
Kurt
9a6985eeef
Allow users to Update API Keys (#146237)
## Summary

API keys can now be updated via the API Keys Management screen

## Release Note

API Keys can now be updated with new Role Descriptors and Metadata via
the API Keys Management screen.

## Testing Instructions

Login as `elastic`

Navigate to Roles and create a new role with the `read_security` cluster
privilege:
<img width="962" alt="Screen Shot 2022-11-30 at 9 42 31 AM"
src="https://user-images.githubusercontent.com/21210601/204826868-a8f6bf03-acf8-404c-90c8-e2b9ab62dc11.png">


Create a new user and assign that new role, `viewer`, and
`kibana_admin`:
<img width="936" alt="Screen Shot 2022-11-30 at 9 43 10 AM"
src="https://user-images.githubusercontent.com/21210601/204827030-e5f97f8e-6676-4c18-8a46-f6afee87ba12.png">


Navigate to Dev Tools and run the following:

```json
POST /_security/api_key/grant
{
  "grant_type": "password",
  "username" : "elastic",  
  "password" : "changeme",  
  "run_as": "elastic",  
  "api_key" : {
    "name": "test-expired-key",
    "expiration": "1ms"
  }
}

POST /_security/api_key/grant
{
  "grant_type": "password",
  "username" : "elastic",  
  "password" : "changeme",  
  "run_as": "test_user",  
  "api_key" : {
    "name": "test-user-key",
    "expiration": "1d"
  }
}
```

The first command will create an API key for the `elastic` user that
expires immediately.

The second command will create an API key for `test_user`.

Navigate to the API Key page, click the name column links to see a
readonly view for the 2 previously created keys as users cannot update
an API key that belongs to another user nor an API key that is expired.

Create a new API key:
<img width="632" alt="Screen Shot 2022-11-30 at 9 44 52 AM"
src="https://user-images.githubusercontent.com/21210601/204829114-672c6583-8801-4af0-bfa8-64ae1072ef46.png">

Click the name link for the newly created API key to see the Update API
key flyout.

Update the fields and click submit:
<img width="642" alt="Screen Shot 2022-11-30 at 9 45 59 AM"
src="https://user-images.githubusercontent.com/21210601/204829914-9fb1f8e6-8b3f-4acc-b63f-d7e4a0906727.png">

If the update was successful:
<img width="904" alt="Screen Shot 2022-11-30 at 9 46 42 AM"
src="https://user-images.githubusercontent.com/21210601/204830133-1dcb083b-f945-4980-9e91-19081c224b55.png">

Now click the name link again for the updated key and click submit
without making changes. You should see a warning:
<img width="895" alt="Screen Shot 2022-11-30 at 9 46 52 AM"
src="https://user-images.githubusercontent.com/21210601/204830570-2ca5e2e0-19b6-43ce-b7e4-ae594be6a86b.png">

Logout the `elastic` user and login as `test_user`

Navigate to API Keys and click the existing API Key to see a readonly
view flyout:
<img width="639" alt="Screen Shot 2022-11-30 at 9 58 25 AM"
src="https://user-images.githubusercontent.com/21210601/204832019-640ecd2e-4bcb-402b-a164-e8b8eb9f8848.png">


Thanks for reviewing!

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-12-14 07:50:07 -05:00
Kurt
7b07faf7d1
Fixing es template string and programmatic typo (#139014) 2022-08-17 12:17:57 -04:00
Kurt
e22e3a52b5
Adding deprecation warning for Interactive Users using ApiKeys (#136422)
* Adding deprecation warning for Interactive Users using ApiKeys

* Fixing unit test verbiage

* Update docs/user/security/authentication/index.asciidoc

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

* Update docs/user/security/api-keys/index.asciidoc

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

* Changing capitalization on 'keys' to avoid confusion with the UI API Keys

* Update docs/user/security/api-keys/index.asciidoc

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

* Update docs/user/security/authentication/index.asciidoc

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

* Changing the logging message and unit test descriptions based on PR review feedback

* Update x-pack/plugins/security/server/routes/analytics/authentication_type.test.ts

Co-authored-by: Aleh Zasypkin <aleh.zasypkin@gmail.com>

* Update x-pack/plugins/security/server/routes/analytics/authentication_type.ts

Co-authored-by: Aleh Zasypkin <aleh.zasypkin@gmail.com>

* Update x-pack/plugins/security/server/routes/analytics/authentication_type.ts

Co-authored-by: Aleh Zasypkin <aleh.zasypkin@gmail.com>

* Removing unnecessary whitespace

* Fixing spelling in unit test assertion

Co-authored-by: Larry Gregory <lgregorydev@gmail.com>
Co-authored-by: Aleh Zasypkin <aleh.zasypkin@gmail.com>
2022-07-20 10:52:46 -04:00
Aleh Zasypkin
aa4ce92457
Update API keys docs to remove unnecessary API keys service section. (#128464) 2022-03-29 10:44:00 +02:00
Joe Portner
15b4981b1d
[Docs] Update security and spaces docs/screenshots (#105652) 2021-07-15 16:04:33 -04:00
Thom Heymann
27f790c8f2
Create API keys with metadata (#100682) 2021-06-01 19:55:11 +03:00
Thom Heymann
69f013e2fb
Added ability to create API keys (#92610)
* Added ability to create API keys

* Remove hard coded colours

* Added unit tests

* Fix linting errors

* Display full base64 encoded API key

* Fix linting errors

* Fix more linting error and unit tests

* Added suggestions from code review

* fix unit tests

* move code editor field into separate component

* fixed tests

* fixed test

* Fixed functional tests

* replaced theme hook with eui import

* Revert to manual theme detection

* added storybook

* Additional unit and functional tests

* Added suggestions from code review

* Remove unused translations

* Updated docs and added detailed error description

* Removed unused messages

* Updated unit test

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Larry Gregory <larry.gregory@elastic.co>
2021-04-13 12:21:11 +01:00
Francois
6f2dc10727
[DOCS] Fix API Keys doc example 2020-11-02 14:26:42 -05:00
Kaarina Tungseth
c77619352b
[DOCS] 7.10 Core UI changes (#80407)
* [DOCS] 7.10 screenCore UI changes

* Kibana access options

* Removed Kibana from Set up Kibana

* Removed rogue symbols

* Update docs/spaces/index.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/management/managing-beats.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Update docs/user/introduction.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Review comments

* Changed menu to main menu

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2020-10-22 09:06:51 -05:00
Théo Frasquet
e9acb95657
Added clarification on b64 encoding of API key (#78394)
* Added clarification on b64 encoding of API key

The current documentation does not specify how to encode the response to get a valid api key, I added it from the info found here: https://github.com/elastic/elasticsearch/issues/50235#issuecomment-644170902

* Updated for consistency with Elasticsearch docs

https://github.com/elastic/kibana/pull/78394#pullrequestreview-497412674
2020-09-29 11:35:15 -07:00
Kaarina Tungseth
896b9cddbc
[DOCS] Updates for navigation redesign (#68709)
* [DOCS] Updates for navigation redesign

* Getting started

* Set up text

* Discover

* Dashboard, Graph, ML, Maps, APM, SIEM, Dev tools

* Dev Tools, Stack Monitoring, Management

* Management

* Final changes

* [DOCS] Updates for navigation redesign

* [DOCS] Updates CCR monitoring screenshots

* updates SIEM screenshot and Cases overview text

* Added Brandon's APM image

* [DOCS] Refines CCR shard screenshot

* Removed merge conflict image file

Co-authored-by: lcawl <lcawley@elastic.co>
Co-authored-by: Ben Skelker <ben.skelker@elastic.co>
2020-06-12 09:39:36 -05:00
gchaps
5333a046c1
[DOCS] Improves example in API keys (#66456)
* [DOCS] Improves example in API keys

* [DOCS] Incorporates review comments

* [DOCS] Fixes name of api key
2020-05-14 13:21:42 -07:00
gchaps
243a9815e3
[DOCS] Adds docs for API Keys UI (#49135)
* [DOCS] Adds docs for API Keys UI

* [DOCS] Incorporates review comments into API keys doc

* [DOCS] Fixes typo
2019-10-25 11:59:01 -07:00