Skip to main content
Glama
CoveoSec
by CoveoSec

rbac_set_user_role

Add or remove one or more users from a role in Cortex XSIAM to manage their access permissions.

Instructions

Set a User Role

Add or remove one or more users from a role.

Required license: Cortex XSIAM Premium or Cortex XSIAM Enterprise or Cortex XSIAM Enterprise Plus

[POST /public_api/v1/rbac/set_user_role] · System management

Example request body:

{
  "request_data": {
    "user_emails": [
      "user1@acme.com",
      "user2@acme.com"
    ],
    "role_name": "Role1"
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
request_dataNoA dictionary containing the API request fields.
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It discloses that the tool adds or removes users from a role and requires a specific license, which is useful. However, it does not mention permissions, side effects, or whether existing assignments are replaced or appended. Given the mutation nature, more behavioral detail would be helpful, but the basic behavior is described.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is well-structured with a title, behavior summary, license requirement, endpoint, and example. While the title is redundant with the first sentence, the content is purposeful and not excessively verbose. The example is useful for understanding the request format.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

The tool is a mutation with a nested object parameter and no output schema. The description covers the request body and license, but does not describe the response format, error handling, or any post-conditions. This is a moderate gap for a tool of this complexity, so a score of 3 reflects the missing return behavior and caveats.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The input schema provides 100% coverage for parameters, including descriptions for role_name and user_emails. The description adds an example request body that clarifies the expected structure, but it does not add significant meaning beyond the schema. Baseline 3 is appropriate.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the tool's function: 'Add or remove one or more users from a role.' This uses specific verbs (add/remove) and identifies the resource (users and roles), distinguishing it from sibling tools like rbac_get_users and rbac_get_roles which are read-only queries.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage by describing the operation and the required license, but it does not explicitly state when to use this tool versus alternatives, nor does it mention any exclusions or prerequisites beyond the license. The context is clear but lacks explicit guidance on alternatives.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/CoveoSec/xsiam-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server