{"type":"api","title":"Disconnect VPN Users","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/d2a1854d5c0ed9069a7f0bc54a9b813f3075ddc9/57baa1e5-6ecd-32fe-9c1f-da027dc6d101","info":{"version":"1.0.0","title":"Cisco Secure Access VPN User Connections API","description":"Manage your Secure Access remote access VPN connections.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"VPN Sessions"},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/admin/ravpn-overview.md","uri":"secure-access-api-reference-ravpn-overview"}},"openapi":"3.0.2","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"admin/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"admin.vpn:read":"Read the remote access VPN user connections.","admin.vpn:write":"Update the remote access VPN user connections."}}}}}},"spec":{"summary":"Disconnect VPN Users","description":"Disconnect the remote VPN sessions.","tags":["VPN Sessions","Secure Access"],"operationId":"updateVpnConnections","security":[{"oauthFlow":["admin.vpn:write"]}],"requestBody":{"description":"Update the VPN connections.\nAdd a list of 1-500 email addresses for the users in the organization.","required":true,"content":{"application/json":{"schema":{"type":"object","required":["action"],"properties":{"action":{"type":"string","description":"The type of action to take on the VPN session.","enum":["disconnect"],"default":"disconnect","example":"disconnect","$$ref":"#/components/schemas/action"},"usernames":{"type":"array","items":{"type":"string","description":"An email address for the VPN user.","example":"name@domain.com"},"description":"The list of email addresses for the VPN users. The list can contain 1-500 email addresses.","example":["name@domain.com"],"$$ref":"#/components/schemas/usernames"},"sessions":{"type":"array","items":{"type":"string","example":"12345a","description":"The session ID for the remote VPN connection."},"description":"The list of session IDs.","example":["1355a6","ab3xyrt"],"$$ref":"#/components/schemas/sessions"},"profileName":{"type":"string","description":"The name of the VPN profile.","example":"East coast VPN profile","$$ref":"#/components/schemas/profileName"},"region":{"type":"string","description":"The region where the action occurs on the VPN connection.","example":"West coast","$$ref":"#/components/schemas/region"}}},"example":{"action":"disconnect"}}},"$$ref":"#/components/requestBodies/VpnSessionsUpdate"},"responses":{"200":{"description":"OK","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","required":["message"],"description":"The state and information about the disconnected sessions.","properties":{"statusCode":{"type":"string","description":"The status code that describes whether the sessions were disconnected."},"message":{"type":"string","description":"The informational message that describes the disconnected sessions."},"failed":{"description":"The information that describes the action that failed for the VPN sessions.","type":"object","properties":{"usernames":{"type":"array","items":{"type":"string","description":"An email address for the VPN user.","example":"name@domain.com"},"description":"The list of email addresses for the VPN users. The list can contain 1-500 email addresses.","example":["name@domain.com"],"$$ref":"#/components/schemas/usernames"},"sessions":{"type":"array","items":{"type":"string","example":"12345a","description":"The session ID for the remote VPN connection."},"description":"The list of session IDs.","example":["1355a6","ab3xyrt"],"$$ref":"#/components/schemas/sessions"}}}},"example":{"statusCode":"207","message":"Disconnected the VPN sessions.","failed":{"usernames":["test.user1@cisco.com","test.user2@cisco.com"]},"sessions":[]},"$$ref":"#/components/schemas/TerminateSessions"},"example":{"statusCode":"200","message":"Successfully disconnected the VPN sessions."}}},"$$ref":"#/components/responses/TerminateSessionsResponse"},"207":{"description":"Multi-Status","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","required":["message"],"description":"The state and information about the disconnected sessions.","properties":{"statusCode":{"type":"string","description":"The status code that describes whether the sessions were disconnected."},"message":{"type":"string","description":"The informational message that describes the disconnected sessions."},"failed":{"description":"The information that describes the action that failed for the VPN sessions.","type":"object","properties":{"usernames":{"type":"array","items":{"type":"string","description":"An email address for the VPN user.","example":"name@domain.com"},"description":"The list of email addresses for the VPN users. The list can contain 1-500 email addresses.","example":["name@domain.com"],"$$ref":"#/components/schemas/usernames"},"sessions":{"type":"array","items":{"type":"string","example":"12345a","description":"The session ID for the remote VPN connection."},"description":"The list of session IDs.","example":["1355a6","ab3xyrt"],"$$ref":"#/components/schemas/sessions"}}}},"example":{"statusCode":"207","message":"Disconnected the VPN sessions.","failed":{"usernames":["test.user1@cisco.com","test.user2@cisco.com"]},"sessions":[]},"$$ref":"#/components/schemas/TerminateSessions"}}}},"400":{"description":"Bad Request","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"},"description":{"type":"string"}},"example":{"message":"error","description":"Bad Request"}}}},"$$ref":"#/components/responses/invalidRequestError"},"401":{"description":"Unauthorized","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"},"WWW-Authenticate":{"schema":{"type":"string"},"description":"A challenge response for the intended resource."}},"content":{"application/json":{"schema":{"type":"object","description":"The request is not authorized.","properties":{"message":{"type":"string","example":"success","enum":["success","error"]},"description":{"type":"string"}},"example":{"message":"error","description":"Unauthorized request"}}}},"$$ref":"#/components/responses/unauthorizedError"},"403":{"description":"Forbidden","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The request is forbidden.","properties":{"message":{"type":"string","example":"success","enum":["success","error"]},"description":{"type":"string"}},"example":{"message":"error","description":"Forbidden"}}}},"$$ref":"#/components/responses/forbiddenError"},"404":{"description":"Not Found","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","description":"The request failed because the resource doesn't exist.","properties":{"message":{"type":"string","example":"error","enum":["success","error"]},"description":{"type":"string"}},"example":{"message":"error","description":"Not Found"}}}},"$$ref":"#/components/responses/notFoundError"},"500":{"description":"Internal Server Error","headers":{"Content-Type":{"schema":{"type":"string"},"description":"The MIME content type of the response body.","example":"application/json","$$ref":"#/components/headers/Content-Type"},"Date":{"schema":{"type":"string","pattern":"^[0-90-90-90-9-0-90-9-0-90-9T0-90-9:0-90-9:0-90-9Z]+$"},"description":"The timestamp of the response.","example":"2023-03-14T18:34:25Z","$$ref":"#/components/headers/Date"}},"content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message explaining the reason for failure.","example":"Internal Server Error"},"requestId":{"type":"string","description":"The ID of the request.","example":"7d318524-d5a4-4fd8-8b29-ad295b2f035b"}}}}},"$$ref":"#/components/responses/internalServerError"}},"__originalOperationId":"updateVpnConnections","method":"put","path":"/vpn/userConnections"}}