Skip to content

Commit 8505d7e

Browse files
committed
use variables
1 parent 1c36e55 commit 8505d7e

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

solutions/search/agent-builder/permissions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ navigation_title: "Permissions & access control"
1010

1111
# Permissions and access control in {{agent-builder}}
1212

13-
Use this page to learn how to configure security roles and API keys for Agent Builder. Understanding these privileges helps you control who can use agents, which tools they can access, and what data they can query.
13+
Use this page to learn how to configure security roles and API keys for {{agent-builder}}. Understanding these privileges helps you control who can use agents, which tools they can access, and what data they can query.
1414

1515
## Required privileges
1616

17-
Agent Builder requires privileges at three levels:
17+
{{agent-builder}} requires privileges at three levels:
1818

1919
- [{{kib}} feature access](#kib-privileges)
2020
- [{{es}} cluster access](#es-cluster-privileges)
2121
- [{{es}} index access](#es-index-privileges)
2222

2323
### {{kib}} privileges
2424

25-
Agent Builder access control is managed by the `agentBuilder` {{kib}} feature:
25+
{{agent-builder}} access control is managed by the `agentBuilder` {{kib}} feature:
2626

2727
- "Read" access to the `agentBuilder` feature: Required to use agents, send chat messages, view tools, and access conversations.
2828
- "All" access to the `agentBuilder` feature: Required to create, update, or delete custom agents and tools.
@@ -32,7 +32,7 @@ Learn more about [{{kib}} privileges](/deploy-manage/users-roles/cluster-or-depl
3232

3333
### {{es}} cluster privileges
3434

35-
Agent Builder requires cluster-level privileges for AI-powered query generation:
35+
{{agent-builder}} requires cluster-level privileges for AI-powered query generation:
3636

3737
- `monitor_inference`: Required when the agent uses an AI connector that calls the {{es}} Inference API (such as the Elastic default LLM or other AI connectors configured to use the Inference API). The built-in tools `search` and `generate_esql`, as well as [index search tools](tools/index-search-tools.md), use this API to generate queries from natural language. This privilege is not required when the agent uses other {{kib}} GenAI connectors.
3838

@@ -49,21 +49,21 @@ Learn more about [index privileges](elasticsearch://reference/elasticsearch/secu
4949

5050
## Grant access
5151

52-
You can grant users access to Agent Builder using these methods:
52+
You can grant users access to {{agent-builder}} using these methods:
5353

5454
- [Roles](#grant-access-with-roles) to bundle privileges for users.
5555
- [API keys](#grant-access-with-api-keys) for programmatic access.
5656
- [Spaces](#working-with-spaces) to scope access to specific environments.
5757

5858
### Grant access with roles
5959

60-
[Roles](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md) are {{es}} security constructs that bundle together {{kib}} feature privileges and {{es}} privileges. To grant users access to Agent Builder, create a role that includes the required privileges.
60+
[Roles](/deploy-manage/users-roles/cluster-or-deployment-auth/defining-roles.md) are {{es}} security constructs that bundle together {{kib}} feature privileges and {{es}} privileges. To grant users access to {{agent-builder}}, create a role that includes the required privileges.
6161

6262
:::{note}
63-
When configuring roles in the {{kib}} UI, Agent Builder privileges are currently located under the **Analytics** section, not the {{es}} section.
63+
When configuring roles in the {{kib}} UI, {{agent-builder}} privileges are currently located under the **Analytics** section, not the {{es}} section.
6464
:::
6565

66-
Example role for users who need full Agent Builder access:
66+
Example role for users who need full {{agent-builder}} access:
6767

6868
```json
6969
POST /_security/role/agent-builder-full
@@ -94,7 +94,7 @@ For read-only access, use `feature_agentBuilder.read` instead of `feature_agentB
9494

9595
### Grant access with API keys
9696

97-
When using the Agent Builder APIs programmatically, authenticate with an API key that includes the required privileges.
97+
When using the {{agent-builder}} APIs programmatically, authenticate with an API key that includes the required privileges.
9898

9999
Unlike roles, which use UI-friendly feature privilege names like `feature_agentBuilder.all`, API keys use the underlying API privilege names (`read_onechat`, `manage_onechat`). This is because API keys interact directly with the {{kib}} API layer rather than through the UI.
100100

@@ -106,14 +106,14 @@ Learn more about [API keys](/deploy-manage/api-keys/elasticsearch-api-keys.md).
106106

107107
### Working with Spaces
108108

109-
Agent Builder respects {{kib}} Spaces when enabled. All conversations, custom agents, and custom tools are scoped to the current Space.
109+
{{agent-builder}} respects {{kib}} Spaces when enabled. All conversations, custom agents, and custom tools are scoped to the current Space.
110110

111111
When configuring roles or API keys, specify the Space in the application privileges resources (e.g., `"resources": ["space:production"]`). Users and API keys cannot access resources in other Spaces.
112112

113113
Learn how to [Copy your MCP server URL](tools.md#copy-your-mcp-server-url).
114114

115115
:::{important}
116-
When accessing Agent Builder APIs or the MCP server from a custom Space, include the space name in the URL path: `https://<deployment>/s/<space-name>/api/agent_builder/...`
116+
When accessing {{agent-builder}} APIs or the MCP server from a custom Space, include the space name in the URL path: `https://<deployment>/s/<space-name>/api/agent_builder/...`
117117

118118
The default space uses the standard URL format without `/s/<space-name>`.
119119
:::

0 commit comments

Comments
 (0)