{"type":"api","title":"Get 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 list of Access Control Groups\u003cbr /\u003eOne of the below roles is needed to invoke this API\u003cbr /\u003e- SEA System Admin\u003cbr /\u003e- SEA Access Admin","operationId":"get_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]","in":"query","name":"filter","required":false,"type":"string"},{"in":"query","name":"search","required":false,"type":"string"},{"description":"Available options: [name]","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. Access Control Groups received.","schema":{"type":"object","properties":{"object_type":{"type":"string"},"results":{"type":"array","items":{"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"},"application_count":{"type":"integer","example":14},"description":{"type":"string","example":"test description"},"enabled":{"type":"boolean","example":true},"group_id":{"type":"string","format":"uuid","example":"89a38657-90e5-4763-ac15-9988b57929a4"},"name":{"type":"string","example":"IE-3400 group"},"recorded_guac":{"type":"boolean","example":false},"recorded_screen":{"type":"boolean","example":false},"schedules":{"type":"array","items":{"type":"object","properties":{"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_common_group_connection_schedule"}},"user_count":{"type":"integer","example":77}},"$$ref":"#/definitions/response_common_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_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 Access Control Groups","tags":["Access Control Groups"],"__originalOperationId":"get_groups","security":[{"access_token":[]},{"bearer_token":[]}],"method":"get","path":"/groups"}}