List all Permissions on an Agent

GET

/api/v2/agents/{agent_id}/permissions

Lists the users and teams that can use an agent, and the role each one holds. Use it to show
an agent's sharing settings, or to see who keeps access before you remove someone.

Direct permissions are roles given on the agent itself. Indirect permissions are roles held on
the agent's project, which apply to every agent in it. Only users and teams given a role on the
project directly are listed as indirect; organization admins aren't listed, although they can
use every agent. The list isn't paged.

Requires edit_agent on the agent; organizations that don't use permission sets check
manage instead.

Request

Path Params

Query Params

Header Params

Responses

🟢200

application/json

The agent's direct and indirect permissions.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/agents//permissions?agent_version=' \
--header 'X-Authorization-Consistency-Token;' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Agent permissions

{
    "success": true,
    "message": "Agent permissions retrieved successfully",
    "data": {
        "agent_id": 42,
        "agent_name": "Support Assistant",
        "project_id": 7,
        "project_name": "Customer Care",
        "organization_id": 3,
        "direct_permissions": {
            "users": [
                {
                    "user_id": "15",
                    "user_name": "Dana Lee",
                    "email": "[email protected]",
                    "relations": [
                        "admin"
                    ]
                }
            ],
            "teams": [
                {
                    "team_id": "9",
                    "team_name": "Support Leads",
                    "relations": [
                        "member"
                    ]
                }
            ]
        },
        "indirect_permissions": {
            "users": [
                {
                    "user_id": "21",
                    "user_name": "Sam Ortiz",
                    "email": "[email protected]",
                    "relations": [
                        "member"
                    ],
                    "inheritance_source": "project"
                }
            ],
            "teams": []
        },
        "is_public": false
    }
}

Delete Agent Evaluation Run

Grant Permission on an Agent