Skip to content

Commit 33f7801

Browse files
Merge branch 'main' into 1640-update-tutorial-ingest-logs-from-python-app
2 parents 6648f9f + f11d754 commit 33f7801

File tree

6 files changed

+30
-11
lines changed

6 files changed

+30
-11
lines changed

deploy-manage/api-keys/elasticsearch-api-keys.md

Lines changed: 27 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Several types of {{es}} API keys exist:
1515
* **Cross-cluster** API key: allows other clusters to connect to this cluster.
1616
* **Managed** API key: created and managed by {{kib}} to run background tasks.
1717

18-
To manage API keys in {{kib}}, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
18+
To manage API keys in {{kib}}, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md).
1919

2020
![API Keys UI](/deploy-manage/images/kibana-api-keys.png "")
2121

@@ -33,23 +33,41 @@ To manage roles, go to the **Roles** management page using the navigation menu o
3333

3434
## Create an API key [create-api-key]
3535

36-
To create an API key, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and select **Create API key**.
36+
Two methods are available to create an API key:
3737

38-
![Create API Key UI](/deploy-manage/images/kibana-create-ccr-api-key.png "")
38+
* As a quick option to create a personal API key from anywhere in {{kib}}:
39+
1. From the **Help menu** (![help icon](/deploy-manage/images/help-icon.svg)), select **Connection details > API key**.
40+
1. Give the key a name.
41+
1. Select **Create API key**.
42+
43+
Your personal API key is created with a default expiration of 90 days from the time of creation. You can manage the key from the **API Keys** page.
3944

40-
Refer to the [Create API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) documentation to learn more about creating user API keys.
45+
* To create a personal or cross-cluster API key with configurable options, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and select **Create API key**.
4146

42-
Refer to the [Create cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) documentation to learn more about creating cross-cluster API keys.
47+
![Create API Key UI](/deploy-manage/images/kibana-create-user-api-key.png "")
4348

49+
1. Choose to create either a user or a cross-cluster API key.
50+
2. Optionally, set an expiry date. By default the API key will not expire, but it's a good security practice to give the key a limited lifespan.
51+
3. Configure access:
52+
* For a user API key, you can opt to configure access to specific {{es}} APIs and resources by assigning the key with predefined roles or custom privileges. Refer to [Defining roles](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md) and the [Create API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) API documentation to learn more.
53+
* For a cross-cluster API key, you can control the indices that other clusters have access to. Refer to the [Create cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-cross-cluster-api-key) API documentation to learn more.
54+
4. Add any additional metadata about the API as one or more key-value pairs. Refer to the [Create API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-create-api-key) API documentation for examples.
4455

4556
## Update an API key [update-api-key]
4657

47-
To update an API key, go to the **API Keys** management page using the navigation menu or the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and then click on the name of the key. You cannot update the name or the type of API key.
58+
To update an API key, go to **Management > Stack Management > API Keys** from the navigation menu or use the [global search field](../../explore-analyze/find-and-organize/find-apps-and-objects.md), and then click on the name of the key. You cannot update the name or the type of an API key.
4859

49-
Refer to the [Update API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key) documentation to learn more about updating user API keys.
50-
51-
Refer to the [Update cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key) documentation to learn more about updating cross-cluster API keys.
60+
* For a user API key, you can update:
61+
* The API key's access to {{es}} APIs and resources.
62+
* The metadata associated with the key.
63+
64+
Refer to the [Update API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-api-key) API documentation to learn more.
5265

66+
* For a cross-cluster API key, you can update:
67+
* The indices that other clusters have access to.
68+
* The metadata associated with the key.
69+
70+
Refer to the [Update cross-cluster API key](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-update-cross-cluster-api-key) API documentation to learn more.
5371

5472
## View and delete API keys [view-api-keys]
5573

deploy-manage/api-keys/serverless-project-api-keys.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,9 @@ API keys are intended for programmatic access. Don’t use API keys to authentic
4646

4747

4848

49-
### Restrict privileges [api-keys-restrict-privileges]
49+
### Control security privileges [api-keys-restrict-privileges]
5050

51-
When you create or update an API key, use **Restrict privileges** to limit the permissions. Define the permissions using a JSON `role_descriptors` object, where you specify one or more roles and the associated privileges.
51+
When you create or update an API key, use **Control security privileges** to configure access to specific {{es}} APIs and resources. Define the permissions using a JSON `role_descriptors` object, where you specify one or more roles and the associated privileges.
5252

5353
For example, the following `role_descriptors` object defines a `books-read-only` role that limits the API key to `read` privileges on the `books` index.
5454

deploy-manage/images/help-icon.svg

Lines changed: 1 addition & 0 deletions
Loading
-345 KB
Binary file not shown.
573 KB
Loading
293 KB
Loading

0 commit comments

Comments
 (0)