List Security Profiles - Cloud Security API

{"type":"api","title":"List Security Profiles","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/83e8a10367d157243cd1c3e478b807cb81262a3d/73390bb1-ff0a-387e-9a8f-4e95641829f2","info":{"title":"Cisco Secure Access Security Profiles API","version":"1.0.1","description":"View and manage the Security profiles in the Secure Access organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Security Profiles","description":"The Security profiles in the organization."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/security-profiles-overview.md","uri":"secure-access-api-reference-security-profiles-overview"}},"openapi":"3.1.0","servers":[{"url":"https://api.sse.cisco.com/{basePath}","variables":{"basePath":{"default":"policies/v2"}}}],"securitySchemes":{"oauthFlow":{"type":"oauth2","description":"The client credential flow.","flows":{"clientCredentials":{"tokenUrl":"https://api.sse.cisco.com/auth/v2/token","scopes":{"policies.securityProfiles:read":"Read Security Profiles","policies.securityProfiles:write":"Write Security Profiles"}}}}}},"spec":{"tags":["Security Profiles","Secure Access"],"summary":"List Security Profiles","description":"Get the Security profiles in the organization.","operationId":"getSecurityProfiles","security":[{"oauthFlow":["policies.securityProfiles:read"]}],"parameters":[{"name":"page","in":"query","description":"The number of a page in the collection.","required":false,"schema":{"default":1,"type":"integer","format":"int32","minimum":1},"$$ref":"#/components/parameters/page"},{"name":"limit","in":"query","description":"The number of items on a page. The maximum items that are allowed on a page in the response are 100.","required":false,"schema":{"type":"integer","default":25,"format":"int32","minimum":1,"maximum":100},"example":20,"$$ref":"#/components/parameters/limit"}],"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":"array","description":"The list of the Security profiles in the organization.","items":{"type":"object","required":["id","organizationId","isDefault","name","createdAt","modifiedAt"],"description":"The properties of the Security Profile.","properties":{"id":{"type":"integer","description":"The ID of the Security profile.","example":1234567,"$$ref":"#/components/schemas/id"},"organizationId":{"type":"integer","description":"The ID of the organization.","example":2345678,"$$ref":"#/components/schemas/organizationId"},"isDefault":{"type":"boolean","example":true,"description":"Specifies whether the setting is the default setting.","$$ref":"#/components/schemas/isDefault"},"name":{"type":"string","description":"The name of the Security profile.","example":"System Provided - Private Access","$$ref":"#/components/schemas/name"},"createdAt":{"type":"integer","description":"The date and time (in seconds since the Unix Epoch) when the system created the Security profile setting.","example":1490206249,"$$ref":"#/components/schemas/securityProfileCreatedAt"},"modifiedAt":{"type":"integer","description":"The date and time (in seconds since the Unix Epoch) when the system created the Security profile setting.","example":1490206249,"$$ref":"#/components/schemas/securityProfileModifiedAt"},"applicationAupSettingGroupId":{"type":"integer","nullable":true,"example":1139310,"description":"The group ID of the Application setting.","$$ref":"#/components/schemas/applicationAupSettingGroupId"},"aupSettingGroupId":{"type":"integer","nullable":true,"example":9,"description":"The group ID of the Category setting.","$$ref":"#/components/schemas/aupSettingGroupId"},"bundleTypeId":{"type":"integer","enum":[1,2,3,4],"example":2,"description":"The ID of the bundle type.","$$ref":"#/components/schemas/bundleTypeId"},"landerSettingGroupId":{"type":"integer","example":1139310,"description":"The group ID of the Notification setting.","$$ref":"#/components/schemas/landerSettingGroupId"},"securitySettingGroupId":{"type":"integer","example":1139310,"description":"The group ID of the Security setting.","$$ref":"#/components/schemas/securitySettingGroupId"},"policySettingGroupId":{"type":"integer","example":1139310,"description":"The group ID of the Policy setting.","$$ref":"#/components/schemas/policySettingGroupId"},"settingGroupBypassInspectionGroupId":{"type":"integer","nullable":true,"example":1139310,"description":"The group ID of the Bypass Inspection setting.","$$ref":"#/components/schemas/settingGroupBypassInspectionGroupId"},"fileInspectionSettingGroupId":{"type":"integer","example":1139310,"description":"The group ID of the File Inspection setting.","$$ref":"#/components/schemas/fileInspectionSettingGroupId"},"frontendModifiedAt":{"type":"integer","description":"The date and time (in seconds since the Unix Epoch) when the system modified the dashboard.","example":1139310,"$$ref":"#/components/schemas/frontendModifiedAt"},"priority":{"type":"integer","description":"The priority of the Security profile.","example":1139310,"$$ref":"#/components/schemas/priority"},"reporting":{"type":"string","description":"Specifies whether the system enables or disables the reporting of the Security profile setting.","enum":["enabled","disabled"],"example":"enabled","$$ref":"#/components/schemas/reporting"},"isFwaasDefault":{"type":"boolean","nullable":true,"description":"Specifies whether the Security profile for the cloud-delivered firewall is the default Security profile.","example":true,"$$ref":"#/components/schemas/isFwaasDefault"},"isSwgDefault":{"type":"boolean","nullable":true,"description":"Specifies whether the Security profile for the secure web gateway (SWG) is the default Security profile.","example":true,"$$ref":"#/components/schemas/isSwgDefault"},"restriction":{"type":"object","description":"The properties of the Tenant Control.","properties":{"id":{"type":"integer","description":"The ID of the Tenant Control setting.","example":17764},"name":{"type":"string","description":"The name of the Tenant Control setting.","example":"Global Tenant Controls"},"domains":{"type":"array","description":"The list of destinations.","items":{"type":"object","description":"The properties of the destination.","properties":{}}},"restrictions":{"type":"array","description":"The list of Tenant Control restrictions.","items":{"type":"object","description":"The properties of the Tenant Control restriction.","properties":{}}}},"$$ref":"#/components/schemas/tenantControlsRestriction"}}},"example":[{"id":13725886,"organizationId":8053787,"isDefault":false,"name":"System Provided - Internet Access","createdAt":1668574861,"modifiedAt":1748620055,"applicationAupSettingGroupId":1139310,"aupSettingGroupId":14758856,"bundleTypeId":2,"landerSettingGroupId":6556912,"securitySettingGroupId":14168795,"policySettingGroupId":13704136,"settingGroupBypassInspectionGroupId":6497268,"fileInspectionSettingGroupId":13658923,"frontendModifiedAt":1668574861,"priority":10,"reporting":"enabled","isSwgDefault":true,"isFwaasDefault":false,"restriction":{"id":17764,"name":"Global Tenant Controls","domains":[],"restrictions":[]}}],"$$ref":"#/components/schemas/ListSecurityProfilesResponse"},"examples":{"example-success":{"summary":"Example Response","value":[{"id":13943535,"organizationId":8099167,"isDefault":false,"name":"Web Profile 4","aupSettingGroupId":9,"applicationAupSettingGroupId":1139310,"landerSettingGroupId":4,"securitySettingGroupId":14405796,"policySettingGroupId":13946317,"settingGroupBypassInspectionGroupId":6454267,"fileInspectionSettingGroupId":13878875,"frontendModifiedAt":1603850002,"createdAt":1680137817,"modifiedAt":1776805707,"priority":71,"reporting":"enabled","bundleTypeId":2,"isSwgDefault":null,"isFwaasDefault":null,"disableReporting":0,"disableLogging":0}],"$$ref":"#/components/examples/ListSecurityProfilesExampleOne"}}}}},"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","description":"Bad Request","properties":{"statusCode":{"type":"integer","example":400,"description":"HTTP status code"},"error":{"type":"string","example":"Bad Request","description":"A brief description of the error"},"message":{"type":"string","example":"Validation Error"},"txId":{"type":"string","example":"d479k9i2b723"}},"$$ref":"#/components/schemas/BadRequestError"},"examples":{"example_bad_request":{"summary":"Bad Request Example Response","value":{"statusCode":400,"error":"Bad Request","message":"Validation Error","txId":"d479k9i2b723-abdj1-672635-45362"},"$$ref":"#/components/examples/400BadRequestExample"}}}},"$$ref":"#/components/responses/BadRequest"},"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"}},"content":{"application/json":{"schema":{"type":"object","description":"Unauthorized","properties":{"statusCode":{"type":"integer","example":401,"description":"HTTP status code"},"error":{"type":"string","example":"Unauthorized","description":"The authorization header is missing or the token is unauthorized."},"message":{"type":"string","example":"Error"},"txId":{"type":"string","example":"a478k9i2b723"}},"$$ref":"#/components/schemas/UnauthorizedError"}}},"$$ref":"#/components/responses/Unauthorized"},"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":"Forbidden","properties":{"statusCode":{"type":"integer","example":403,"description":"HTTP status code"},"error":{"type":"string","example":"Forbidden","description":"The token is invalid."},"message":{"type":"string","example":"Error"},"txId":{"type":"string","example":"a478k9i2b723"}},"$$ref":"#/components/schemas/ForbiddenError"}}},"$$ref":"#/components/responses/Forbidden"},"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":"Not Found","properties":{"statusCode":{"type":"integer","example":404,"description":"HTTP status code"},"error":{"type":"string","example":"Not Found","description":"A resource specified in the URL was not found."},"message":{"type":"string","example":"Error"},"txId":{"type":"string","example":"a478k9i2b723"}},"$$ref":"#/components/schemas/NotFoundError"}}},"$$ref":"#/components/responses/NotFound"},"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","description":"Internal Server Error","properties":{"statusCode":{"type":"integer","example":500,"description":"HTTP status code"},"error":{"type":"string","example":"Internal Server Error","description":"The server can not process the request."},"message":{"type":"string","example":"An internal server error occurred"},"txId":{"type":"string","example":"l477k9i2b893"}},"$$ref":"#/components/schemas/ServerError"}}},"$$ref":"#/components/responses/ServerErr"}},"method":"get","path":"/securityProfiles"}}