Get Tenant Settings - Security Cloud Control Firewall Manager API Documentation

{"type":"api","title":"Get Tenant Settings","meta":{"id":"/apps/pubhub/media/cdo-api-documentation/ee9bdf946673e45c4f256a22e0a754e29a9b2098/9b0e4c9a-48cb-3530-a00a-1f32fbf2438c","info":{"title":"Cisco Security Cloud Control Firewall Manager API","version":"1.15.0","description":"Use the documentation to explore the endpoints Security Cloud Control Firewall Manager has to offer","contact":{"name":"Cisco Security Cloud Control TAC","email":"cdo.tac@cisco.com"}},"openapi":"3.0.1","servers":[{"url":"https://api.us.security.cisco.com/firewall","description":"US"},{"url":"https://api.eu.security.cisco.com/firewall","description":"EU"},{"url":"https://api.apj.security.cisco.com/firewall","description":"APJ"},{"url":"https://api.au.security.cisco.com/firewall","description":"AUS"},{"url":"https://api.in.security.cisco.com/firewall","description":"IN"},{"url":"https://api.int.security.cisco.com/firewall","description":"Staging"},{"url":"https://scale.manage.security.cisco.com/api/rest","description":"Scale"},{"url":"https://ci.manage.security.cisco.com/api/rest","description":"CI"},{"url":"https://manage.stg.secure.cisco/api/rest","description":"Stgf9"}],"securitySchemes":{"bearerAuth":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"spec":{"description":"Get the settings for the Security Cloud Control tenant.","operationId":"getTenantSettings","responses":{"200":{"content":{"application/json":{"schema":{"properties":{"aiAssistant":{"description":"Indicates if the tenant has the AI assistant enabled.","example":true,"type":"boolean"},"allowCrossRegionTenantAddition":{"description":"Indicates whether adding tenants from different regions to this MSP Portal is allowed.","example":true,"type":"boolean"},"asaHealthMetrics":{"description":"Indicates if the tenant collects ASA health metrics.","example":false,"type":"boolean"},"autoAcceptDeviceChanges":{"description":"Indicates if changes made out-of-band on devices on the tenant are automatically accepted without manual approval.","example":true,"type":"boolean"},"autoDiscoverOnPremFmcs":{"description":"Indicates if the system automatically discovers on-premise FMCs.","example":true,"type":"boolean"},"changeRequestSupport":{"description":"Indicates if the tenant supports change requests.","example":true,"type":"boolean"},"conflictDetectionInterval":{"description":"Specifies the default interval at which Security Cloud Control checks for changes made out-of-band on the devices on the tenant.","example":"EVERY_6_HOURS","enum":["EVERY_10_MINUTES","EVERY_HOUR","EVERY_6_HOURS","EVERY_24_HOURS"],"type":"string","$$ref":"#/components/schemas/ConflictDetectionInterval"},"denyCiscoSupportAccessToTenant":{"description":"Indicates if Cisco support is denied access to the tenant.","example":true,"type":"boolean"},"mspPortalUid":{"description":"The unique identifier, represented as a UUID, of the MSP portal associated with the tenant.","example":"dda3ce11-111c-477a-aa86-1fd1866ddab6","format":"uuid","type":"string"},"multicloudDefense":{"description":"Indicates if the tenant has the multicloud defense enabled.","example":false,"type":"boolean"},"objectSharingEnabled":{"description":"Indicates if the tenant has Object Sharing enabled.","example":false,"type":"boolean"},"policyAnalyzer":{"description":"Indicates if the tenant has the policy analyzer enabled.","example":true,"type":"boolean"},"scheduledDeployments":{"description":"Indicates if the tenant has scheduled deployments enabled.","example":false,"type":"boolean"},"uid":{"description":"The unique identifier, represented as a UUID, of the tenant in Security Cloud Control.","example":"7131daad-e813-4b8f-8f42-be1e241e8cdb","format":"uuid","type":"string"},"webAnalytics":{"description":"Indicates if web analytics are enabled for the tenant.","example":true,"type":"boolean"}},"type":"object","$$ref":"#/components/schemas/TenantSettings"}}},"description":"Tenant Settings Object"},"400":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Invalid input provided. Check the response for details.","$$ref":"#/components/responses/http400BadRequest"},"401":{"content":{"application/json":{"schema":{"properties":{"error":{"description":"A human-readable error description in English.","example":"invalid_token","type":"string"},"errorDescription":{"description":"A human-readable error description in English.","example":"Your token is invalid","type":"string"}},"$$ref":"#/components/schemas/AuthenticationError"}}},"description":"Request not authorized.","$$ref":"#/components/responses/http401Unauthorised"},"403":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"User does not have sufficient privileges to perform this operation.","$$ref":"#/components/responses/http403Forbidden"},"404":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Entity not found.","$$ref":"#/components/responses/http404NotFound"},"500":{"content":{"application/json":{"schema":{"properties":{"details":{"additionalProperties":{"description":"Additional details, if any, about the error.","example":{},"type":"object"},"description":"Additional details, if any, about the error.","example":{},"type":"object"},"errorCode":{"description":"Unique code that describes the error.","enum":["INVALID_INPUT","UNAUTHORIZED","FORBIDDEN","NOT_FOUND","METHOD_NOT_ALLOWED","CONFLICT","TOO_MANY_REQUESTS","SERVER_ERROR","PROXY_ERROR","BAD_REQUEST","UNPROCESSABLE_ENTITY"],"example":"INVALID_INPUT","type":"string"},"errorMsg":{"description":"Human-readable error description in English.","example":"sample error","type":"string"}},"$$ref":"#/components/schemas/CommonApiError"}}},"description":"Internal server error."}},"security":[{"bearerAuth":[]}],"summary":"Get Tenant Settings","tags":["Tenant Management"],"__originalOperationId":"getTenantSettings","method":"get","path":"/v1/settings/tenant"}}