You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
# Permissions and access control in {{agent-builder}}
12
12
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.
14
14
15
15
## Required privileges
16
16
17
-
Agent Builder requires privileges at three levels:
17
+
{{agent-builder}} requires privileges at three levels:
18
18
19
19
-[{{kib}} feature access](#kib-privileges)
20
20
-[{{es}} cluster access](#es-cluster-privileges)
21
21
-[{{es}} index access](#es-index-privileges)
22
22
23
23
### {{kib}} privileges
24
24
25
-
Agent Builder access control is managed by the `agentBuilder` {{kib}} feature:
25
+
{{agent-builder}} access control is managed by the `agentBuilder` {{kib}} feature:
26
26
27
27
- "Read" access to the `agentBuilder` feature: Required to use agents, send chat messages, view tools, and access conversations.
28
28
- "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
32
32
33
33
### {{es}} cluster privileges
34
34
35
-
Agent Builder requires cluster-level privileges for AI-powered query generation:
35
+
{{agent-builder}} requires cluster-level privileges for AI-powered query generation:
36
36
37
37
-`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.
38
38
@@ -49,21 +49,21 @@ Learn more about [index privileges](elasticsearch://reference/elasticsearch/secu
49
49
50
50
## Grant access
51
51
52
-
You can grant users access to Agent Builder using these methods:
52
+
You can grant users access to {{agent-builder}} using these methods:
53
53
54
54
-[Roles](#grant-access-with-roles) to bundle privileges for users.
55
55
-[API keys](#grant-access-with-api-keys) for programmatic access.
56
56
-[Spaces](#working-with-spaces) to scope access to specific environments.
57
57
58
58
### Grant access with roles
59
59
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.
61
61
62
62
:::{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.
64
64
:::
65
65
66
-
Example role for users who need full Agent Builder access:
66
+
Example role for users who need full {{agent-builder}} access:
67
67
68
68
```json
69
69
POST /_security/role/agent-builder-full
@@ -94,7 +94,7 @@ For read-only access, use `feature_agentBuilder.read` instead of `feature_agentB
94
94
95
95
### Grant access with API keys
96
96
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.
98
98
99
99
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.
100
100
@@ -106,14 +106,14 @@ Learn more about [API keys](/deploy-manage/api-keys/elasticsearch-api-keys.md).
106
106
107
107
### Working with Spaces
108
108
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.
110
110
111
111
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.
112
112
113
113
Learn how to [Copy your MCP server URL](tools.md#copy-your-mcp-server-url).
114
114
115
115
:::{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/...`
117
117
118
118
The default space uses the standard URL format without `/s/<space-name>`.
0 commit comments