{"type":"api","title":"Get Remote Access Control Groups","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 available remote access access control groups\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA User\u003cbr /\u003e- SEA System Admin","operationId":"get_remote_access_groups","parameters":[{"format":"uuid","in":"header","name":"x-tenant-id","required":true,"type":"string"},{"description":"The number of pages to skip before starting to collect the result set. Default: 1","in":"query","name":"page","required":false,"type":"integer"},{"description":"The numbers of items to return on a page. Default: 500","in":"query","name":"size","required":false,"type":"integer"},{"description":"Available (multiple) options: [name, app_id]","in":"query","name":"filter","required":false,"type":"string"},{"in":"query","name":"search","required":false,"type":"string"},{"description":"Available options: [name, app_id]","in":"query","name":"sort_by","required":false,"type":"string"},{"description":"Available options: [ASC, DESC] Default: ASC","in":"query","name":"sort_dir","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"Successful operation. Remote Access Control Groups received.","schema":{"type":"object","properties":{"object_type":{"type":"string"},"results":{"type":"array","items":{"type":"object","properties":{"applications":{"type":"array","items":{"type":"object","properties":{"access_method":{"type":"string","example":"SSH"},"access_method_display_name":{"type":"string","example":"SSH"},"active_sessions":{"type":"integer","example":27},"app_id":{"type":"string","format":"uuid","example":"4bca5682-f053-467e-8de0-cbf78464bafb"},"credentials_required":{"type":"boolean","example":false},"device_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"},"device_name":{"type":"string","example":"IE-3400-8P2S+FOC1408V0FJ (self)"},"gateway_capabilities":{"type":"string","example":"SpeedTestEnabled,SEAPlusEnabledALL,SEAPlusEnabledMP,PingAckEnabled"},"gateway_identifier":{"type":"string","example":"FCW1408P9S2TEMP"},"gateway_name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP"},"last_accessed":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP (self) (SSH)"},"status":{"type":"string","description":"Same as gateway status. Available options: [Up, Down, Unknown]","enum":["Up","Down","Unknown"],"example":"Up"},"time_begin":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"time_remaining":{"type":"integer","example":51}},"$$ref":"#/definitions/response_common_remote_access_application"}},"enabled":{"type":"boolean","example":true},"group_id":{"type":"string","format":"uuid","example":"41a958f2-c00d-489d-be7a-26c12fe1689c"},"name":{"type":"string","example":"IE-3400 remote access group"},"recorded_guac":{"type":"boolean","example":false},"recorded_screen":{"type":"boolean","example":true},"schedules":{"type":"array","items":{"type":"object","properties":{"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"duration":{"type":"integer","minimum":0,"example":84},"group_connection_schedule_id":{"type":"string","format":"uuid","example":"66cc623c-9b7a-40fc-b331-fa8ce923dfa7"},"time_begin":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"time_end":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"timezone":{"type":"string","example":"America/New_York"}},"$$ref":"#/definitions/response_get_group_connection_schedule"}}},"$$ref":"#/definitions/response_common_remote_access_group"}},"page":{"type":"integer","description":"Current page to display","default":1,"example":1},"page_links":{"type":"object","description":"Page links to navigate pages","example":null},"size":{"type":"integer","description":"The numbers of records to return","default":500,"example":500},"total_count":{"type":"integer","description":"Total count of records retrieved by query","example":95},"total_pages":{"type":"integer","description":"Total count of records retrieved by query","example":19}},"$$ref":"#/definitions/response_get_remote_access_groups"}},"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 Remote Access Control Groups","tags":["Access Control Groups"],"__originalOperationId":"get_remote_access_groups","security":[{"access_token":[]},{"bearer_token":[]}],"method":"get","path":"/groups/remote_access"}}