Get User Permissions on Multiple Agents

GET

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

Shows the role a user holds on each of several agents in the organization, worked out from
what the user can do on each one. Use it to list the agents a user can open, or to review one
user's access.

The organization is the one the Organization-Id header names, otherwise your subscription
key's, otherwise your own. Agents the user can't access are left out of agents; agents that
couldn't be checked are listed in omitted_ids instead.

You can always read your own roles. Reading another user's roles requires being a member of
the organization (view on it).

Request

Path Params

Query Params

Header Params

Responses

🟢200

application/json

The user's role on each agent they can access.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

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

Response Example

200 - Roles on two agents

{
    "success": true,
    "message": "User permissions on agents retrieved successfully",
    "data": {
        "user_id": 15,
        "user_name": "Dana Lee",
        "email": "[email protected]",
        "agents": [
            {
                "agent_id": 42,
                "agent_name": "Support Assistant",
                "relations": [
                    "admin"
                ]
            },
            {
                "agent_id": 43,
                "agent_name": "Billing Helper",
                "relations": [
                    "member"
                ]
            }
        ],
        "omitted_ids": [
            77
        ]
    }
}

Get User Permissions on a Specific Agent

Get All Skills Available to an Agent