Delete User from Agent

DELETE

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

Deletes a specific user from an agent.

Purpose:

Allows administrators to remove users from an agent, potentially revoking their access or collaboration permissions.

Path Parameters:

agent_id (int): Unique identifier of the agent from which the user will be removed.

user_id (int): Unique identifier of the user to be removed from the agent.

Returns:

A JSON response with the serialized list of user-agent mappings after deletion or an error message.

A 400 error if the version is invalid.

A 500 error if an unexpected server error occurs.

Current Version:

2.0.0

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request DELETE 'https:///api/v2/agents//users/' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Example 1

{
    "success": true,
    "message": "string",
    "data": {
        "id": 0,
        "user": {
            "id": 0,
            "email": "user@example.com",
            "is_staff": true,
            "is_superuser": true,
            "is_active": true,
            "date_joined": "2019-08-24T14:15:22Z",
            "first_name": "string",
            "last_name": "string",
            "organization": {
                "id": 0,
                "org_name": "string",
                "domain": "string"
            }
        }
    }
}

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Success

Body

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Add user to Agent

Get all Agents Users