Cisco Secure Access VPN User Connections API, Overview

VPN User Connections

The Cisco Secure Access VPN User Connections API enables you to list and update the organization's VPN user connections. You can find the Secure Access VPN User Connections API endpoints under the admin scope.

Overview

Rate Limits for VPN User Connections

Secure Access enables rate limits on the VPN User Connections API endpoints. For more information, see Rate Limits > Admin.

Request Headers

Unless specified, the Secure Access API endpoints use JSON for all requests and responses.

Note: For POST, PUT, and PATCH operations, set the HTTP Content-Type header to application/json in your API request.

VPN User Connections API Endpoints

Check for Partially Disconnected VPN Users

The PUT operation (/admin/v2/userConnections) can return an HTTP 200 (OK) or HTTP 207 (Multi-Status). If the PUT operation returns an HTTP 207, review the failed field in the response. Within the failed field, the usernames field lists the email addresses for the users that have not disconnected fully.

We recommend that you get the list of VPN user connections and retry the PUT operation.

  1. Make an API request (GET /admin/v2/userConnections) to list the VPN user connections.
  2. Make an API request (PUT /admin/v2/userConnections) to update the VPN user connections.
    • Provide the list of users from the usernames value in the failed object from the previous PUT operation.

Example of an HTTP 207 Response for the PUT operation:

{
    "statusCode": "string",
    "message": "string",
    "failed": {
        "usernames": [
            "test.user1@cisco.com",
            "test.user2@cisco.com"
        ],
        "sessions": []
    }
}