{"type":"api","title":"Get Access Control Group 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 Control Group details by id\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA System Admin\u003cbr /\u003e- SEA Access Admin\u003cbr /\u003e- SEA User","operationId":"get_group_by_id","parameters":[{"description":"ID of the access control group to return","format":"uuid","in":"path","name":"group_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 Control Group received.","schema":{"type":"object","properties":{"access_type":{"type":"string","enum":["SCHEDULED_ACCESS","ALWAYS_ACTIVE","REQUEST_ACCESS"],"example":"ALWAYS_ACTIVE"},"access_type_display_name":{"type":"string","enum":["Scheduled Access","Always Active","Request Access"],"example":"Scheduled Access"},"applications":{"type":"array","items":{"type":"object","properties":{"app_id":{"type":"string","format":"uuid","example":"67e2ea27-1ffe-4de3-8940-27ed97cbe43a"},"device_name":{"type":"string","example":"IE-3400-8P2S+FOC1408V0FJ (self)"},"gateway_name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP"},"group_id":{"type":"string","format":"uuid","example":"9540a6dd-4ef7-42b5-bada-e4a15b3e8849"},"group_name":{"type":"string","example":"IE-3400 group"},"name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP (self) (SSH)"},"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_common_group_application"}},"connections":{"type":"array","items":{"type":"object","properties":{"connection_id":{"type":"string","format":"uuid","example":"23be2a2a-0e1c-4115-8582-b33e1e872333"},"device_name":{"type":"string","example":"IE-3400-8P2S+FOC1408V0FJ (self)"},"gateway_name":{"type":"string","example":"IE-3400-8P2S+FCW1408P9S2TEMP"},"name":{"type":"string","example":"IE-3400 group connection"},"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_common_group_connection"}},"create_date":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"description":{"type":"string","example":"test description"},"enabled":{"type":"boolean","example":false},"group_id":{"type":"string","format":"uuid","example":"5a1361d0-85d7-4e72-844a-b14f174da785"},"last_updated":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"name":{"type":"string","example":"IE-3400 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"}},"users":{"type":"array","items":{"type":"object","properties":{"access_methods_count":{"type":"integer","example":34},"active":{"type":"boolean","example":false},"assets_count":{"type":"integer","example":2},"gateway_count":{"type":"integer","example":8},"group_count":{"type":"integer","example":32},"last_active":{"type":"string","format":"date-time","example":"2024-06-19 16:12:39.785"},"user_id":{"type":"string","format":"uuid","example":"3186e8a2-856a-4641-962c-e9108c2fbc4d"},"username":{"type":"string","example":"username@cisco.com"}},"$$ref":"#/definitions/response_get_group_user"}}},"$$ref":"#/definitions/response_get_group"}},"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 Control Group by Id","tags":["Access Control Groups"],"__originalOperationId":"get_group_by_id","security":[{"access_token":[]},{"bearer_token":[]}],"method":"get","path":"/groups/{group_id}"}}