Get Access Method by Id - Secure Equipment Access (SEA) API

{"type":"api","title":"Get Access Method by Id","meta":{"id":"/apps/pubhub/media/sea-api/7c15e51e49c0ffa2ba78927684d875bb631dffa7/d5f79626-4df3-3cd0-aec3-6ecc5b860dd3","swagger":"2.0","info":{"description":"Deals with Remote Sessions, Access Management (Access Control Groups), and System Management (Network Devices and Assets) APIs","license":{"name":"Licensing is primarily subscription based.","url":"https://www.cisco.com"},"termsOfService":"http://swagger.io/terms/","title":"Secure Equipment Access (SEA) Management APIs","version":"1.0.0"},"host":"us.ciscoiot.com","basePath":"/nbapi/sramgmt/ext","schemes":["https"],"securityDefinitions":{"access_token":{"in":"header","name":"x-access-token","type":"apiKey"},"bearer_token":{"in":"header","name":"Authorization","type":"apiKey"}},"security":[{"access_token":[]},{"bearer_token":[]}],"x-parser-conf":{"apiKeyGenerator":{"$remoteModule":"./config/apikey.js"},"labelConfig":{"endpoint":"summary"}}},"spec":{"description":"Get Access Method details by Id\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA System Admin","operationId":"get_connection_by_id","parameters":[{"format":"uuid","in":"path","name":"connection_id","required":true,"type":"string"},{"format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Successful operation. Access Method received.","schema":{"type":"object","properties":{"advanced_parameters":{"type":"string","format":"json","description":"Advanced parameters JSON string (i.e. for guacamole: recording_path, create_recording_path, recording_exclude_mouse, recording_exclude_output, recording_include_keys, recording_name)","example":"{\"recording_path\": \"/example/to/path\", \"create_recording_path\": true}"},"application_cross_launch_params":{"type":"string","example":"-load \"Test Session\""},"application_cross_launch_path":{"type":"string","format":"uri","example":"\\filename.app"},"application_cross_launch_url":{"type":"string","format":"uri-reference","example":"https://1.1.1.1:1"},"associated_devices":{"type":"array","items":{"type":"object","properties":{"host":{"type":"string","format":"hostname","description":"Host can be a valid domain name (e.g. www.example.com), IP address (e.g. 1.1.1.1), or hostname (e.g. localhost)","example":"127.0.0.1"},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP (self)"}},"$$ref":"#/definitions/response_common_associated_device"}},"clipboard_encoding":{"type":"string","description":"Available options: [ISO8859-1, UTF-8, UTF-16, CP1252]","enum":["ISO8859-1","UTF-8","UTF-16","CP1252"],"example":"ISO8859-1"},"color_depth":{"type":"integer","enum":[8,16,24,32],"example":8},"color_scheme":{"type":"string","description":"Available options: [black-white, gray-black, green-black, white-blacks]","enum":["black-white","gray-black","green-black","white-blacks"],"example":"black-white"},"connection_id":{"type":"string","format":"uuid","example":"c7e24647-c904-4830-83d7-fc1a78fdbe3a"},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"description":{"type":"string","example":"test description"},"device":{"type":"object","properties":{"access_control_group_count":{"type":"integer","example":9},"access_method_count":{"type":"integer","example":75},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.784"},"description":{"type":"string","example":"test description"},"device_id":{"type":"string","format":"uuid","example":"a8cf89b4-d248-4a5e-bf9e-17171a0fde96"},"device_identifier":{"type":"string","description":"Any unique string recognizable by the customer (ex: device serial number).","example":"IE-3400-8P2S+FOC1408V0FJ"},"gateway":{"type":"array","items":{"type":"object","properties":{"capabilities":{"type":"string","example":"SpeedTestEnabled,SEAPlusEnabledALL,SEAPlusEnabledMP,PingAckEnabled"},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.784"},"description":{"type":"string","example":"test description"},"ext_controller_cross_launch_url":{"type":"string","example":"https://1.1.1.1:1","format":"uri-reference"},"gateway_id":{"type":"string","format":"uuid","example":"3f20c9a3-a317-46bb-9425-9c43c54f0659"},"gateway_identifier":{"type":"string","description":"Any unique string recognizable by the customer (ex: gateway serial number). Will be used as username to IOx app.","example":"FCW1408P9S2TEMP"},"host":{"type":"string","format":"hostname","description":"Host can be a valid domain name (e.g. www.example.com), IP address (e.g. 1.1.1.1), or hostname (e.g. localhost)","example":"127.0.0.1"},"last_active":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.784"},"model":{"type":"string","enum":["IE3100","IE3105","IE3200","IE3300","IE3400","IR809","IR829","IR1101","IR1821","IR1831","IR1833","IR1835","IE9300","IE9310","IE9320","CAT9300","CAT9400"],"example":"IE3400"},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP"},"sra_agent_app_container_version":{"type":"string","example":"2.0"},"sra_agent_app_phase":{"type":"string","enum":["STABLE","RELEASE","BETA"],"example":"STABLE"},"sra_agent_app_status":{"type":"string","description":"Available options: [Lost Connection, others from App Mgmt response]","enum":["DEPLOYED","DEPLOYING","RUNNING","STARTING"],"example":"DEPLOYED"},"sra_agent_app_version":{"type":"string","example":"1.3"},"sra_agent_authorization_method":{"type":"string","example":"STATIC_SECRET"},"sra_agent_installable":{"type":"boolean","description":"To let users know if the gateway can currently install SEA agent app","example":true},"sra_agent_installed_by":{"type":"string","enum":["APP_MGMT","CLI","DNAC","MANUAL","VMANAGE"],"example":"APP_MGMT"},"sra_agent_installed_by_display_name":{"type":"string","enum":["App Manager","CLI","DNAC","Manual Entry","WAN Manager"],"example":"App Manager"},"sra_agent_status":{"type":"string","description":"Available options: [Unsupported, Pending, Deployed, Running, Failed]","enum":["Pending","Unsupported","Deployed","Running","Failed"],"example":"Pending"},"sra_agent_status_details":{"type":"string","description":"Description for any errors during sra agent installation","example":"Unable to retrieve agent status"},"status":{"type":"string","description":"Available options: [Up, Down, Unknown]","enum":["Up","Down","Unknown"],"example":"Up"},"tenant_id":{"type":"string","format":"uuid","example":"71072a97-2951-474f-8d08-4a6da28d0c7a"}},"$$ref":"#/definitions/response_common_gateway"}},"host":{"type":"string","format":"hostname","description":"Host can be a valid domain name (e.g. www.example.com), IP address (e.g. 1.1.1.1), or hostname (e.g. localhost)","example":"127.0.0.1"},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP (self)"},"status_health":{"type":"string","example":"UNKNOWN"},"tenant_id":{"type":"string","format":"uuid","example":"b00c82e3-cb2b-4787-b466-a07381010e36"},"type":{"type":"string","example":"IE3400"}},"$$ref":"#/definitions/response_common_device_with_gateway"},"disable_download":{"type":"boolean","example":false},"disable_upload":{"type":"boolean","example":false},"domain":{"type":"string","format":"hostname","example":"example.com"},"drive_name":{"type":"string","example":"SRA Drive"},"enable_drive":{"type":"boolean","example":false},"font_size":{"type":"integer","example":68},"full_url":{"type":"string","format":"uri-reference","description":"Format follows as http(s)://\u003cdevice_id_host\u003e:\u003cremote_port\u003e/\u003clanding_url_path\u003e","example":"http://127.0.0.1:1/landing_url_path"},"https_enabled":{"type":"boolean","default":true,"example":true},"idle_timeout":{"type":"integer","default":180,"minimum":60,"maximum":600,"example":180},"ignore_cert":{"type":"boolean","default":true,"example":true},"landing_url_path":{"type":"string","format":"uri","example":"/example/path"},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP (self) (SSH)"},"network_protocol":{"type":"string","description":"Available options: [ANY, ICMP, TCP, UDP]","enum":["ANY","ICMP","TCP","UDP"],"example":"ANY"},"password":{"type":"string","format":"password","example":"password"},"protocol":{"type":"string","description":"Available options: [SSH, RDP, TELNET, VNC, WEB, SEA_PLUS]","enum":["SSH","RDP","TELNET","VNC","WEB","SEA_PLUS"],"example":"SSH"},"protocol_definition":{"type":"object","properties":{"allowed_protocols":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string","example":"test description"},"port_begin":{"type":"integer","example":73},"port_end":{"type":"integer","example":95},"protocol":{"type":"string","description":"Available options: [SSH, RDP, TELNET, VNC, WEB, SEA_PLUS]","enum":["SSH","RDP","TELNET","VNC","WEB","SEA_PLUS"],"example":"SSH"}},"$$ref":"#/definitions/response_protocol_port"}},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"description":{"type":"string","example":"test description"},"last_updated":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"name":{"type":"string","example":"example string"},"protocol_definition_id":{"type":"string","format":"uuid","example":"caf22d2c-9429-4840-9c14-3ec61c26f2b6"},"tag":{"type":"string","example":"test tag"},"tenant_id":{"type":"string","format":"uuid","example":"0648cf1b-7143-4ea4-a932-ce8c5adbbc5c"},"type":{"type":"string","enum":["PREDEFINED","CUSTOM"],"example":"CUSTOM"}},"$$ref":"#/definitions/response_common_protocol_definition"},"protocol_display_name":{"type":"string","description":"Available options: [SSH, RDP, Telnet, VNC, Web App, SEA Plus]","enum":["SSH","RDP","Telnet","VNC","Web App","SEA Plus"],"example":"SSH"},"read_only":{"type":"boolean","example":false},"remote_port":{"type":"integer","example":62},"resize_method":{"type":"string","description":"Available options: [display-update, reconnect]","enum":["display-update","reconnect"],"example":"display-update"},"scrollback":{"type":"integer","example":65},"security":{"type":"string","description":"Available options: [any, nla, rdp]","enum":["any","nla","rdp"],"example":"any"},"tenant_id":{"type":"string","format":"uuid","example":"e622a0d4-b99e-4d53-83ca-f667b537983e"},"username":{"type":"string","example":"username@cisco.com"}},"$$ref":"#/definitions/response_get_connection"}},"400":{"description":"Bad Request. Invalid input.","schema":{"properties":{"debug_message":{"items":{"type":"string"},"type":"array"},"error_code":{"type":"string"},"message":{"type":"string"}},"type":"object","$$ref":"#/definitions/response_error"}},"401":{"description":"Bad request","schema":{"example":"Authentication Token is invalid","type":"string"}},"403":{"description":"Forbidden","schema":{"example":"Permission denied to access the resource","type":"string"}},"500":{"description":"Internal server error","schema":{"example":"Could not connect to server","type":"string"}}},"summary":"Get Access Method by Id","tags":["Access Methods"],"__originalOperationId":"get_connection_by_id","security":[{"access_token":[]},{"bearer_token":[]}],"method":"get","path":"/connections/{connection_id}"}}