List Tenant Controls Profiles - Cloud Security API

{"type":"api","title":"List Tenant Controls Profiles","meta":{"id":"/apps/pubhub/media/cloud-security-apis-in-eft/9d37d008417d562ab46d4b67547a68457ce288d2/038233c8-f2b4-3578-9ebb-30913a181d9d","info":{"title":"Cisco Secure Access Tenant Controls Profiles API","version":"1.0.0","description":"Get the Tenant Controls Profiles in the Secure Access organization.","contact":{"name":"Cloud Security Developer Community"}},"security":[{"oauthFlow":[]}],"tags":[{"name":"Tenant Controls Profiles","description":"The Tenant Controls Profiles settings."},{"name":"Secure Access"}],"x-parser-conf":{"overview":{"markdownPath":"secure-access/reference/policies/tenant-controls-profiles-overview.md","uri":"secure-access-api-reference-tenant-controls-profiles-overview"}},"openapi":"3.0.1","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.tenantControlsProfiles:read":"Read Tenant Controls Profiles"}}}}}},"spec":{"tags":["Tenant Controls Profiles","Secure Access"],"summary":"List Tenant Controls Profiles","description":"Get the Tenant Controls profiles for the organization.","operationId":"getTenantControlsProfiles","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":10,"format":"int32","minimum":1,"maximum":100},"example":20,"$$ref":"#/components/parameters/limit"}],"security":[{"oauthFlow":["policies.tenantControlsProfiles:read"]}],"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 Tenant Controls profiles in the organization.","items":{"type":"object","description":"The properties of the Tenant Control profile.","properties":{"created_at":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the system created the Tenant Controls profile setting.","example":"2024-12-13T16:07:07.222Z","$$ref":"#/components/schemas/created_at"},"id":{"type":"integer","description":"The ID of the Tenant Controls profile.","example":1234567,"$$ref":"#/components/schemas/id"},"is_default":{"type":"boolean","example":true,"description":"Specifies whether the setting is the default setting.","$$ref":"#/components/schemas/is_default"},"modified_at":{"type":"string","format":"date-time","readOnly":true,"description":"The date and time when the system modified the Tenant Controls profile setting.","example":"2024-12-13T16:07:07.222Z","$$ref":"#/components/schemas/modified_at"},"name":{"type":"string","description":"The name of the Tenant Controls profile.","example":"tenant controls profile one","$$ref":"#/components/schemas/name"},"org_id":{"type":"integer","description":"The ID of the organization.","example":1234568,"$$ref":"#/components/schemas/org_id"},"restrictions":{"type":"array","description":"The list of tenant controls.","items":{"type":"object","description":"The properties of the tenant control.","properties":{"application_id":{"type":"integer","description":"The ID of the application.","example":5000116},"application_name":{"type":"string","description":"The name of the application.","example":"YouTube"},"description":{"type":"string","description":"The text that describes the Tenant Control profile setting.","example":"The application for securing the AI model.","$$ref":"#/components/schemas/description"},"id":{"type":"integer","description":"The ID of the tenant control.","example":304346},"key_field_type":{"type":"string","description":"The type of the key field.","example":"enum"},"key_id":{"type":"integer","description":"The ID of the key.","example":10},"key_name":{"type":"string","description":"The name of the key.","example":"category"},"value":{"type":"string","description":"The value of the key category.","example":"Music"}}},"$$ref":"#/components/schemas/tenantControlsRestrictions"}}},"example":[{"created_at":"2024-04-04T18:35:24.108190","id":28034,"is_default":true,"modified_at":"2025-06-04T17:51:54.713559","name":"tenant controls profile one","org_id":8053787,"restrictions":[{"application_id":5000116,"application_name":"YouTube","description":"sample description","id":304346,"key_field_type":"enum","key_id":10,"key_name":"category","value":"Music"}]}],"$$ref":"#/components/schemas/ListTenantControlsProfilesResponse"}}}},"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":{"description":"Bad Request","type":"object","properties":{"status":{"type":"object","description":"Validation Error","properties":{"code":{"type":"integer","example":400,"description":"HTTP status error code"},"text":{"type":"string","example":"Bad Request","description":"HTTP status error text"}}},"data":{"type":"object","description":"Validation Error","properties":{"message":{"type":"string","example":"Bad Request","description":"Error message"}}}},"$$ref":"#/components/schemas/badRequest"}}},"$$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":{"description":"Unauthorized","type":"object","properties":{"status":{"type":"object","description":"Unauthorized","properties":{"code":{"type":"integer","example":401,"description":"HTTP status error code"},"text":{"type":"string","example":"Unauthorized","description":"HTTP status error text"}}},"data":{"type":"object","description":"Unauthorized","properties":{"message":{"type":"string","example":"Unauthorized","description":"Error message"}}}},"$$ref":"#/components/schemas/unauthorized"}}},"$$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":{"description":"Forbidden","type":"object","properties":{"status":{"type":"object","description":"Forbidden","properties":{"code":{"type":"integer","example":403,"description":"HTTP status error code"},"text":{"type":"string","example":"Forbidden","description":"HTTP status error text"}}},"data":{"type":"object","description":"Forbidden","properties":{"message":{"type":"string","example":"Forbidden","description":"Error message"}}}},"$$ref":"#/components/schemas/forbidden"}}},"$$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":{"description":"Not Found","type":"object","properties":{"status":{"type":"object","description":"Resource Not Found","properties":{"code":{"type":"integer","example":404,"description":"HTTP status error code"},"text":{"type":"string","example":"Not Found","description":"HTTP status error text"}}},"data":{"type":"object","description":"Resource Not Found","properties":{"message":{"type":"string","example":"Not Found","description":"Error message"}}}},"$$ref":"#/components/schemas/notFound"}}},"$$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":{"description":"Internal Server Error","type":"object","properties":{"status":{"type":"object","description":"Internal Server Error","properties":{"code":{"type":"integer","example":500,"description":"HTTP status error code"},"text":{"type":"string","example":"Internal Server Error","description":"HTTP status error text"}}},"data":{"type":"object","description":"Internal Server Error","properties":{"message":{"type":"string","example":"Internal Server Error","description":"Error message"}}}},"$$ref":"#/components/schemas/serverError"}}},"$$ref":"#/components/responses/serverError"}},"__originalOperationId":"getTenantControlsProfiles","method":"get","path":"/tenantControls/profiles"}}