{"type":"api","title":"List VPN Connections","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/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":"List VPN Connections","description":"List the VPN sessions created by your organization.","tags":["VPN Sessions","Secure Access"],"operationId":"getVpnSessions","security":[{"oauthFlow":["admin.vpn:read"]}],"parameters":[{"in":"query","name":"offset","required":false,"description":"The place to start reading in the collection. The default offset is 0.","schema":{"type":"integer","format":"int32","default":0},"example":1,"$$ref":"#/components/parameters/offset"},{"in":"query","name":"limit","required":false,"description":"The number of items to return on the page. The default limit is 100.","schema":{"type":"integer","format":"int32","default":100,"maximum":1000},"example":25,"$$ref":"#/components/parameters/limit"},{"in":"query","name":"region","required":false,"schema":{"type":"string"},"description":"The region where the VPN session occurs.","$$ref":"#/components/parameters/region"},{"in":"query","name":"profileName","required":false,"schema":{"type":"string"},"description":"The name of the VPN profile.","example":"East cost VPN profile","$$ref":"#/components/parameters/profileName"},{"in":"query","name":"sortBy","required":false,"schema":{"type":"string","default":"username","enum":["username"]},"description":"Filter the collection on the VPN session property.","example":"username","$$ref":"#/components/parameters/sortBy"},{"in":"query","name":"sortOrder","required":false,"schema":{"type":"string","default":"asc","enum":["asc","desc"]},"description":"Sort the collection in either ascending or descending order.","example":"desc","$$ref":"#/components/parameters/sortOrder"},{"in":"query","name":"usernames","required":false,"schema":{"type":"array","items":{"type":"string","description":"The email address for the VPN connection.","example":"vpnuser@cisco.com"}},"style":"form","explode":false,"description":"The comma-separated list of email addresses for the VPN users.","example":["vpnuser@cisco.com","user@cisco.com"],"$$ref":"#/components/parameters/usernames"}],"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","description":"The properties of the VPN sessions.","required":["offset","limit","total","data"],"properties":{"offset":{"type":"integer","description":"The place to start reading in the collection.","example":10},"limit":{"type":"integer","description":"The maximum number of records in the collection returned on the response.","example":100},"total":{"type":"integer","description":"The total number of items read from the collection.","example":1000},"cursorId":{"type":"string","description":"The ID of the cursor that paginates the collection.","example":"1e122c65-00ee-4b1d-81f4-236c3f1d8a16"},"data":{"type":"array","description":"The list of VPN sessions.","items":{"type":"object","description":"The properties of the VPN session.","properties":{"username":{"type":"string","description":"The email address of the VPN user.","example":"user@cisco.com"},"deviceName":{"type":"string","description":"The name of the device that has the VPN session.","example":"device-one"},"assignedIp":{"type":"string","pattern":"^(?:10\\.(?:[0-9]{1,3}\\.){2}[0-9]{1,3}|172\\.(?:1[6-9]|2[0-9]|3[0-1])\\.(?:[0-9]{1,3}\\.){1}[0-9]{1,3}|192\\.168\\.(?:[0-9]{1,3}\\.){1}[0-9]{1,3})$","description":"A nonroutable (an RFC 1918 compliant IP address) IPv4 address that is assigned to the VPN connection."},"assignedIpv6":{"type":"string","pattern":"^([0-9a-fA-F]{1,4}:){7}([0-9a-fA-F]{1,4})$","description":"The IPv6 address that is assigned to the VPN session."},"publicIp":{"type":"string","pattern":"^(25[0-5]|2[0-4]\\d|[1]?\\d{1,2})(\\.(25[0-5]|2[0-4]\\d|[1]?\\d{1,2})){3}$","description":"The public IP address for the VPN session."},"sessionId":{"type":"string","description":"The session ID.","example":"15afasfb"},"loginTime":{"type":"string","description":"The date and time that the session was created.","format":"date-time","readOnly":true,"example":"2021-12-13T16:07:07.222Z"},"profileName":{"type":"string","description":"The name of the VPN profile.","example":"East coast VPN profile","$$ref":"#/components/schemas/profileName"}}}}},"example":{"offset":1,"limit":100,"total":100,"data":[{"username":"user@cisco.com","deviceName":"device-one","publicIp":"1.1.192.168","sessionId":"1425345a","loginTime":"2021-12-13T16:07:07.222Z","profileName":"East coast VPN profile"}],"cursorId":"1e122c65-00ee-4b1d-81f4-236c3f1d8a16"},"$$ref":"#/components/schemas/ListVpnSessions"},"example":{"offset":1,"limit":100,"total":100,"data":[{"username":"user@cisco.com","deviceName":"device-one","publicIp":"1.1.192.168","sessionId":"1425345a","loginTime":"2021-12-13T16:07:07.222Z","profileName":"East coast VPN profile"}],"cursorId":"1e122c65-00ee-4b1d-81f4-236c3f1d8a16"}}},"$$ref":"#/components/responses/ListVpnSessions"},"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":"getVpnSessions","method":"get","path":"/vpn/userConnections"}}