Get User Permissions on a Specific Agent

GET

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

Shows the role one user holds on one agent, worked out from what the user can do on it, so
access through the agent's project or a team counts too. Use it to check a user's access before
you share the agent with them or change their role.

You can always read your own role. Reading another user's role 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 user's role on the agent.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Admin of the agent

{
    "success": true,
    "message": "User permissions on agent retrieved successfully",
    "data": {
        "user_id": 15,
        "user_name": "Dana Lee",
        "email": "[email protected]",
        "agent_id": 42,
        "agent_name": "Support Assistant",
        "relations": [
            "admin"
        ],
        "permissions": [
            "view_agent",
            "edit_agent",
            "delete_agent",
            "publish_agent"
        ]
    }
}

Revoke Multiple Permissions on an Agent

Get User Permissions on Multiple Agents