{"swagger": "2.0", "basePath": "/", "paths": {"/access/posture/governance_summary/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SummaryCountResponse"}}}, "summary": "Get Access Summary Count", "description": "Displays the summary of the violations based on the cloud provider", "operationId": "AccessSummaryCount", "parameters": [{"description": "Supported services for Access Dashboard. Select one from the dropdown to display summary for that particular service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "services"}], "security": [{"auth_token": []}], "tags": ["Access"]}}, "/access/posture/governance_summary_dashboard": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AccessSummaryDashboard"}}}}, "summary": "Get Access Summary Dashboard Count", "description": "Displays the summary of the violations", "operationId": "AccessSummaryDashboardCount", "parameters": [{"description": "Select one from the supported services to display summary for that particular service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "services"}, {"description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.", "type": "string", "required": false, "name": "tenant_id", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Access"]}}, "/access/posture/view_violations": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ViewViolationResponse"}}}, "summary": "Get Access Violations", "description": "Displays the violations based on the cloud provider", "operationId": "AccessViolations", "parameters": [{"description": "Supported services for Access Dashboard. Select one from the dropdown to display violations of all the accounts for that particular service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "services"}, {"description": "Specify the tenant ID as comma separated. This is a unique ID and can be retrieved using the List Tenants API.", "type": "string", "required": false, "name": "tenant_ids", "in": "query"}, {"description": "Search by account_name wise", "type": "string", "name": "search", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Limit of the data to be displayed", "type": "integer", "name": "limit", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Access"]}}, "/access/visibility/details": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/DetailsResponse"}}}, "summary": "Get Access Detail", "description": "Displays the details of individual violation", "operationId": "AccessDetails", "parameters": [{"name": "DetailsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DetailsRequest"}}, {"description": "Supported services for Access Dashboard. Select one from the dropdown to display details for that particular service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "services"}, {"description": "Category under which a particular violation falls in a particular cloud account. Please get category from the guardrail of AccessVisibilityFilters in Access Visibility Dashboard", "type": "string", "required": true, "name": "category", "in": "query"}, {"description": "Name of the violation. Please get name from the guardrail of AccessVisibilityFilters in Access Visibility Dashboard", "type": "string", "required": true, "name": "item", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Limit of the data to be displayed", "type": "integer", "name": "limit", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Access"]}}, "/access/visibility/filter": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/VisibilityFilterResponse"}}}, "summary": "Get Access Visibility Filter", "description": "Displays the filters by tenants, cloud accounts, guardrail", "operationId": "AccessVisibilityFilters", "parameters": [{"description": "Supported services for Access Dashboard. Select one from the dropdown to display filter for that particular service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "services"}], "security": [{"auth_token": []}], "tags": ["Access"]}}, "/budget/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BudgetCreateUpdateResponse"}}}, "summary": "Create Budget", "description": "Budget Create", "operationId": "BudgetCreate", "parameters": [{"name": "BudgetCreateUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BudgetCreateUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budget/dashboard/budget_alert_exceeds_count": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BudgetAlertsExceedResponse"}}}, "summary": "View Count Budget Alert Exceeds Summary", "description": "Budget Alert Exceed Count", "operationId": "BudgetAlertExceedsData", "parameters": [{"name": "BudgetSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BudgetSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budget/dashboard/budget_summary_count": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BudgetSummaryResponse"}}}, "summary": "View Count Budget Summary", "description": "Budget Summary Count", "operationId": "BudgetSummary", "parameters": [{"name": "BudgetSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BudgetSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budget/dashboard/list_budgets": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BudgetListResponse"}}}, "summary": "View Budget Dashboard", "description": "List Budget Management", "operationId": "ListBudget", "parameters": [{"name": "BudgetListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BudgetListRequest"}}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budget/filter_values": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BudgetListConstraintsResponse"}}}, "summary": "View Create Budget Advanced Filters", "description": "Filter Budget Management", "operationId": "ListBudgetConstraints", "parameters": [{"name": "BudgetListConstraintsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BudgetListConstraintsRequest"}}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budget/item/{budget_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Budget", "description": "Delete Budget", "operationId": "Delete Budget", "parameters": [{"name": "budget_id", "in": "path", "required": true, "type": "string", "description": "Specify the budget ID.This is a unique ID and can be retrieved using the create budget"}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budget/update": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BudgetCreateUpdateResponse"}}}, "summary": "Update Budget", "description": "Budget Update", "operationId": "BudgetUpdate", "parameters": [{"name": "BudgetCreateUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BudgetCreateUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budget/{budget_id}/budget_history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BudgetHistoryResponse"}}}, "summary": "List Budget History", "description": "Budget History", "operationId": "BudgetHistory", "parameters": [{"name": "budget_id", "in": "path", "required": true, "type": "string", "description": "Specify the budget ID.This is a unique ID and can be retrieved using the create budget"}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budget/{budget_id}/view": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BudgetViewResponse"}}}, "summary": "List Budget Detail", "description": "View Budget", "operationId": "ViewBudget", "parameters": [{"name": "budget_id", "in": "path", "required": true, "type": "string", "description": "Specify the budget ID.This is a unique ID and can be retrieved using the create budget"}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budgets/threshold_alerts/update": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ThresholdAlertUpdateResponse"}}}, "summary": "Update Budget Threshold Alerts", "description": "ThresholdAlert Update", "operationId": "ThresholdAlertUpdate", "parameters": [{"name": "ThresholdAlertUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ThresholdAlertUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/budgets/threshold_alerts/view": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ThresholdAlertListResponse"}}}, "summary": "View Budget Threshold Alerts", "description": "ThresholdAlert View", "operationId": "ThresholdAlertList", "parameters": [{"name": "ThresholdAlertViewListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ThresholdAlertViewListRequest"}}, {"description": "to view threshold list data", "type": "boolean", "required": false, "name": "expand", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Budget V2 Management"]}}, "/compliance/compliance_control_mapping/assessment_summary_by_job": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceAssessmentHistorySummary"}}}, "summary": "Get compliance assessment summary by assessment job number", "description": "To get the summary of compliance assessment for the given assessment job number.", "operationId": "ComplianceMappingSummary", "parameters": [{"description": "Specify the assessment_job_number.This can be fetched from List Compliance Control Assessment History API.", "required": true, "name": "assessment_job_number", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/executive_dashboard/compliance": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityDashboardComplianceStatus"}}}}, "summary": "Compliance Security Dashboard Summary", "description": "Security Dashboard Compliance", "operationId": "SecurityDashboardByCompliance", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/executive_dashboard/control_health": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityDashboardComplianceControlHealth"}}}}, "summary": "Compliance Control Health by Control Categories", "description": "Compliance Control Health", "operationId": "ComplianceControlHealth", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/executive_dashboard/risk": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityDashboardCompliance"}}}}, "summary": "Compliance Risks By Cloud Accounts", "description": "Compliance Risk by Cloud Accounts", "operationId": "ComplianceRiskByCloudAccounts", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/posture_summary/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AssessmentPostureSummaryResponse"}}}, "summary": "Get Compliance assessment posture Summary", "description": "objective is to return the compliance assessment posture summary of all the applicable tenants", "operationId": "ComplianceAssessmentPostureSummaryList", "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/assessment_history/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AssessmentHistoryResponse"}}}, "summary": "List Compliance Control Assessment History", "description": "objective is to return all of the compliance assessment triggered in the tenant", "operationId": "AssessmentHistoryList", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"description": "Number of records to display", "type": "integer", "enum": ["10", "25", "50", "100"], "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "search assessment", "type": "string", "required": false, "name": "search", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/compliance_control_mapping/get_assessment_job_details": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyJobExecutionStatusResponse"}}}, "summary": "List compliance control mapping, get_assessment_job_details", "description": "objective is to return Policy Job execution status  for given, the tenant,assessment job number, policy id as input", "operationId": "PolicyJobExecutionStatus", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"name": "PolicyJobExecutionStatusRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyJobExecutionStatusRequest"}}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/compliance_control_mapping/get_on_audit_entries": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceMappingResponse"}}}, "summary": "List compliance control mapping, get_on_audit_entries", "description": "objective is to return all of the compliance Mapping get_on_audit_entries given, the tenant,assessment job number as input", "operationId": "ComplianceMapping", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using theList Tenants API. "}, {"description": "Specify the assessment_job_number.This can be fetched from List Compliance Control Assessment History API.", "required": true, "name": "assessment_job_number", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/control_mapping/on_demand_execute_control": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceControlResponse"}}}, "summary": "Compliance On Demand Control_execute", "description": "Compliance On Demand Control_execute", "operationId": "ComplianceOnDemandControl", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ComplianceControlRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ComplianceControlRequest"}}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/control_mapping/on_demand_execute_standard": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceStandardResponse"}}}, "summary": "Compliance On Demand Standard_execute", "description": "Compliance On Demand Standard_execute", "operationId": "ComplianceOnDemandStandard", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ComplianceStandardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ComplianceStandardRequest"}}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/controls/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ControlsListResponse"}}}, "summary": "List Compliance Controls", "description": "Objective is to return all of the compliance controls given, the tenant and compliance standard as input", "operationId": "ListControls", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Number of records to display", "type": "integer", "required": true, "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "uri of compliance standard, This can be fetched from the compliance standards list API call.", "type": "string", "required": true, "name": "compliance_uri", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/mapping/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ControlsListMappingResponse"}}}, "summary": "List Compliance Control Mappings", "description": "objective is to return all of the compliance control mappings given, the tenant and compliance standard as input", "operationId": "ListControlMappings", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"default": "control", "description": "type of data requested", "type": "string", "name": "caller", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "uri of compliance standard This can be fetched from the compliance standards list API call.", "type": "string", "name": "compliance_uri", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/standards": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceStandardsResponse"}}}, "summary": "List Compliance Standards", "description": "Objective is to return all of the compliance standards given, the tenant as input", "operationId": "ListStandards", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"description": "Select the Type of Compliance Standard", "type": "string", "enum": ["all", "marketplace", "my_standard"], "name": "type", "in": "query"}, {"description": "Select a Valid Service Type", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "valid_service_type"}, {"description": "Select the scope of Compliance Standard", "type": "string", "enum": ["account", "tenant"], "name": "scope", "in": "query"}, {"description": "true/false flag to fetch framework standards", "type": "boolean", "name": "framework", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance/{tenant_id}/visibility": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceVisibilityResponse"}}}, "summary": "List Compliance Visibility", "description": "objective is to return all of the compliance visibility given, the tenant as input", "operationId": "ComplianceVisibility", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"description": "ID of the cloud account. This can be fetched from ListCloudAccounts API", "name": "service_account_id", "type": "string", "in": "query"}, {"description": "Select a Valid Compliance Type", "type": "string", "enum": ["service", "standard"], "name": "compliance_type", "in": "query"}, {"description": "Specify the service resource type,this can be fetched from the corestack", "name": "service_resource_type", "type": "string", "in": "query"}, {"description": "uri of compliance standard, This can be fetched from the compliance standards list API call.", "type": "string", "name": "compliance_uri", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance_posture/detail_for_policy/{policy_id}": {"parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceDetailsForPoliciesResponse"}}}, "summary": "List Compliance posture DetailsForPolicies", "description": "Objective is to return all of the compliance posture DetailsForPolicies", "operationId": "DetailsForPolicies", "parameters": [{"name": "ComplianceDetailsForPoliciesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ComplianceDetailsForPoliciesRequest"}}, {"description": "status of resource to filter", "type": "string", "name": "status", "in": "query"}, {"description": "Allowed values:resource_type, resource_name, resource_id", "type": "string", "name": "search", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance_posture/filters": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceFilterResponse"}}}, "summary": "List Compliance Filter", "description": "objective is to return all of the compliance Filter given, the tenant as input", "operationId": "ListFilter", "parameters": [{"name": "ComplianceFilterRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ComplianceFilterRequest"}}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance_posture/filters/by_policy": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceFilterByPolicyResponse"}}}, "summary": "List Compliance Filter For Heatstack", "description": "Objective is to return all of the compliance Filter given, the tenant as input", "operationId": "CompliancePostureFilter", "parameters": [{"description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.", "type": "string", "name": "tenant_id", "in": "query"}, {"description": "true/false flag to get policies filter as well", "type": "boolean", "enum": ["true", "false"], "name": "policy_filters", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance_posture/policy_filters": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceFilterPolicyResponse"}}}, "summary": "List Compliance Filter_Policy", "description": "Objective is to return all of the compliance Filter Policy given, the tenant as input", "operationId": "CompliancePostureFilterPolicy", "parameters": [{"description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.", "type": "string", "required": true, "name": "tenant_id", "in": "query"}, {"description": "compliance standards to filter policies", "type": "string", "name": "standards", "in": "query"}, {"description": "severity filter", "type": "string", "name": "severity", "in": "query"}, {"description": "matches policy name, display_name, engine_type, severity, services, resource_type and service_resource ", "type": "string", "name": "search", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance_posture/summary_by_accounts": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceSummary"}}}, "summary": "List compliance_posture summary_by_accounts", "description": "objective is to return all of the compliance summary_by_accounts", "operationId": "ComplianceSummaryByAccounts", "parameters": [{"name": "ComplianceSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ComplianceSummaryRequest"}}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Number of records to display", "type": "integer", "enum": ["10", "25", "50", "100"], "name": "limit", "in": "query"}, {"description": "Allowed values:account,standard,service", "type": "string", "name": "search", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/compliance_posture/summary_by_policies": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceSummaryByPoliciesResponse"}}}, "summary": "List Compliance posture SummaryByPolicies", "description": "Objective is to return all of the compliance posture SummaryByPolicies", "operationId": "SummaryByPolicies", "parameters": [{"name": "ComplianceSummaryByPoliciesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ComplianceSummaryByPoliciesRequest"}}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Allowed values:account,standard,service", "type": "string", "name": "search", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/cost/cost_savings/accounts/visibility/{tenant_id}": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListRecommendationsResponse"}}}, "summary": "List Cost Saving Recommendation", "description": "list recommendation", "operationId": "CostSavingListRecommendation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ListRecommendationsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ListRecommendationsRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/cost_savings/accounts/visibility/{tenant_id}/recommendations/{recommendation_id}/view": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListRecommendationsViewResponse"}}}, "summary": "View Cost Saving Recommendation", "description": "view recommendation", "operationId": "CostSavingViewRecommendation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "recommendation_id", "in": "path", "required": true, "type": "string", "description": "Recommendation Id.Can be fetched from '/cost/cost_savings/accounts/visibility/{tenant_id}' or '/cost/cost_savings/tenants/visibility/{tenant_id}' api"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/cost_savings/cost_saved_recommendation": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CostSavingsRecommendationsResponse"}}}, "summary": "List Cost Saving Recommendations", "description": "view cost saving recommendation", "operationId": "ListCostSavingRecommendations", "parameters": [{"description": "Currency to fetch the data", "type": "string", "in": "query", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency", "required": false, "name": "currency"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/cost_savings/tenants/visibility/{tenant_id}": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListRecommendationsTenantResponse"}}}, "summary": "List Cost Saving Recommendation by Tenant", "description": "list recommendation tenant", "operationId": "CostSavingListRecommendationTenant", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ListRecommendationsTenantRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ListRecommendationsTenantRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/cost_savings/{tenant_id}/resolve_recommendation/{recommendation_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Resolved", "schema": {"type": "boolean"}}}, "summary": "Resolve Cost Savings Recommendations", "description": "Resolve cost savings recommendation", "operationId": "ResolveCostSavingsRecommendation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "recommendation_id", "in": "path", "required": true, "type": "string", "description": "Recommendation Id.Can be fetched from '/cost/cost_savings/accounts/visibility/{tenant_id}' or '/cost/cost_savings/tenants/visibility/{tenant_id}' api"}, {"name": "ResolveCostSavingsRecommendationsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResolveCostSavingsRecommendationsRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizerate/license_benefit/hub_discounts": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/LicenseBenefitHubDiscountsResponse"}}}, "summary": "License Benefit Hub Discounts", "description": "License Benefit", "operationId": "LicenseBenefitHubDiscounts", "parameters": [{"name": "LicenseBenefitHubDiscountsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/LicenseBenefitHubDiscountsRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizerate/license_benefit/saving_summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/LicenseBenefitSavingResponse"}}}, "summary": "License Benefit Cost Savings Summary", "description": "License Benefit", "operationId": "LicenseBenefitSavingSummary", "parameters": [{"name": "LicenseBenefitSavingRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/LicenseBenefitSavingRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizeusage/tenant": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CostOptimizationTenResponse"}}}, "summary": "Tenant Details", "description": "Under cost optimization Tenant ID and Tenant details", "operationId": "TenantDetails", "parameters": [{"description": "select the request type", "type": "string", "in": "query", "enum": ["right_size", "orphaned", "idle", "config"], "required": true, "name": "request_type"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_account_summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CostOptimizationCloudAccountSummaryResponse"}}}, "summary": "Overall Cloud Account Summary", "description": "cost optimization overall cloud account summary", "operationId": "costOptimizationCloudAccountSummary", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CostOptimizationCloudAccountSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostOptimizationCloudAccountSummaryRequest"}}, {"description": "select the request type", "type": "string", "in": "query", "enum": ["right_size", "orphaned", "idle", "config"], "required": true, "name": "request_type"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_account_type": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CostOptimizationCloudAccTypeResponse"}}}, "summary": "Cloud Account Details", "description": "fetch cloud account details", "operationId": "CostOptimizationCloudAccountType", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CostOptimizationCloudAccountTypeRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostOptimizationCloudAccountTypeRequest"}}, {"description": "select the request type", "type": "string", "in": "query", "enum": ["right_size", "orphaned", "idle", "config"], "required": true, "name": "request_type"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizeusage/{tenant_id}/cloud_accounts": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CloudAccounts"}}}, "summary": "View Cloud Account_ID and Cloud Account Name", "description": "fetch cloud account_id and cloud account name", "operationId": "CostOptimizationCloudAccounts", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "select mode of currency", "type": "string", "in": "query", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency", "required": true, "name": "currency"}, {"description": "select cloud account type", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "service_name"}, {"description": "select the request type", "type": "string", "in": "query", "enum": ["right_size", "orphaned", "idle", "config"], "required": true, "name": "request_type"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizeusage/{tenant_id}/filter": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FilterServices"}}}, "summary": "View Tenant Wise Currency's Or Cloud Account Type", "description": "view tenant wise currency or cloud account type", "operationId": "TenantServicesFilter", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "view cloud account type", "type": "string", "in": "query", "enum": ["true", "false"], "required": false, "name": "services"}, {"description": "view currency", "type": "string", "in": "query", "enum": ["true", "false"], "required": false, "name": "currency"}, {"description": "select the cloud type", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "service_name"}, {"description": "select the request type", "type": "string", "in": "query", "enum": ["right_size", "orphaned", "idle", "config"], "required": true, "name": "request_type"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizeusage/{tenant_id}/summary": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/OptimizationSummary"}}}, "summary": "Tenant Wise Cost Summary", "description": "under cost optimization tenant wise summary", "operationId": "TenantCostSummary", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "select the cloud account type", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "service_name"}, {"description": "select the mode of currency", "type": "string", "in": "query", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency", "required": true, "name": "currency"}, {"description": "select the request type", "type": "string", "in": "query", "enum": ["right_size", "orphaned", "idle", "config"], "required": true, "name": "request_type"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizeusage/{tenant_id}/top_recommendations": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TopRecommendations"}}}, "summary": "View Resource Wise Cost Details Under Cloud Account ID", "description": "Fetch Cost Optimization Top Recommendation as per resource IDs", "operationId": "CostOptimizationTopRecommendations", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "provide recommendation_id", "name": "recommendation_id", "type": "string", "in": "query"}, {"description": "provide resource_id", "name": "resource_id", "type": "string", "in": "query"}, {"description": "provide cloud_account_id", "name": "cloud_account_id", "type": "string", "in": "query"}, {"description": "select mode of currency", "name": "currency", "type": "string", "in": "query"}, {"description": "provide resource_type", "name": "resource_type", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/costoptimizer/optimizeusage/{tenant_id}/view_recommendations": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CostOptimizationViewRecommendationResponse"}}}, "summary": "Resource Wise Recommendation(Savings) Data", "description": "Cost Optimization Resource wise Recommendation(saving) data", "operationId": "CostOptimizationViewRecommendations", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CostOptimizationViewRecommendationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostOptimizationViewRecommendationRequest"}}, {"description": "resource status", "type": "string", "in": "query", "enum": ["open", "close"], "required": false, "name": "resource_status"}, {"description": "select the request type", "type": "string", "in": "query", "enum": ["right_size", "orphaned", "idle", "config"], "required": true, "name": "request_type"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/executive_dashboard/budget_drift": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BudgetDrift"}}}}, "summary": "Get Actual or Forecast Budget Drift", "description": "View Current or Forecast budget drift.", "operationId": "BudgetDrift", "parameters": [{"name": "BudgetDriftRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BudgetDriftRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/executive_dashboard/cost_anomalies_by_cloud": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/CostAnomalyByCloud"}}}}, "summary": "Get Cost Spend By Cloud and Resource Category", "description": "View Cost Anomalies By Cloud.", "operationId": "CostAnomaliesByCloud", "parameters": [{"name": "CostAnomalyByCloudRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostAnomalyByCloudRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/executive_dashboard/cost_optimization_by_optimization_types": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/CostOptimizationByOptimizationTypes"}}}}, "summary": "cost optimization by optimization type", "description": "View Cost Optimization By Optimization Types.", "operationId": "CostOptimizationByOptimizationTypes", "parameters": [{"name": "CostOptimizationByOptimizationTypesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostOptimizationByOptimizationTypesRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/executive_dashboard/cost_optimization_trend": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/CostOptimizationTrend"}}}}, "summary": "Get cost optimization trend", "description": "View cost optimization trend.", "operationId": "GetCostOptimizationTrend", "parameters": [{"name": "CostOptimizationTrendRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostOptimizationTrendRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/executive_dashboard/geo_coordinates_for_regions": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/GeoCoordinatesForRegion"}}}}, "summary": "geo coordinates for regions", "description": "View Geo Coordinates For Regions.", "operationId": "GeoCoordinatesForRegions", "parameters": [{"name": "GeoCoordinatesForRegionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/GeoCoordinatesForRegionRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/executive_dashboard/tagged_and_untagged_resources": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/TaggedUntaggedResourcesByProductCategory"}}}}, "summary": "Get Tagged and Untagged Resources Cost By Product Category", "description": "View Tagged and Untagged Resources By Product Category.", "operationId": "TaggedUntaggedResources", "parameters": [{"name": "TaggedUntaggedResourcesByProductCategoryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TaggedUntaggedResourcesByProductCategoryRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/executive_dashboard/top_budgets": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/TopBudgetByTenant"}}}}, "summary": "Get Top Budget By Tenant", "description": "View Top Budget By Tenant.", "operationId": "TopBudgetByTenant", "parameters": [{"name": "TopBudgetByTenantRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TopBudgetByTenantRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/markups_and_discounts/{tenant_id}/create": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CreateMarkupResponse"}}}, "summary": "Create Cost Markup Rule", "description": "create Markup rule", "operationId": "CreateMarkupRule", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CreateMarkupRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateMarkupRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/markups_and_discounts/{tenant_id}/delete": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/DeleteMarkupResponse"}}}, "summary": "Delete Cost Markup Rule", "description": "delete Markup rule", "operationId": "DeleteMarkupRule", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Specify the rule name to be deleted", "type": "string", "in": "query", "required": true, "name": "rule_name"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/markups_and_discounts/{tenant_id}/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/MarkupDetails"}}}}, "summary": "List Cost Markup Rules", "description": "list Markup rules", "operationId": "ListMarkupRules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Specify the action to fetch markup data", "type": "string", "in": "query", "enum": ["list_configured_rules"], "required": true, "name": "action"}, {"description": "Specify the scope to fetch markup data", "type": "string", "in": "query", "enum": ["tenant", "cloud_account"], "name": "scope"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/markups_and_discounts/{tenant_id}/update": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UpdateMarkupResponse"}}}, "summary": "Update Cost Markup Rule", "description": "update Markup rule", "operationId": "UpdateMarkupRule", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "UpdateMarkupRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateMarkupRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/ri/recommendation": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListRIRecommendationsResponse"}}}, "summary": "List Recommendations", "description": "View RI Recommendations Reservations", "operationId": "RIRecommendationsReservations", "parameters": [{"name": "ListRIRecommendationsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ListRIRecommendationsRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/ri/utilization/reservations": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListReservationsResponse"}}}, "summary": "List Cost Reservations & Utilization", "description": "list reservation utilization", "operationId": "ListReservationsUtilization", "parameters": [{"description": "Date Filter to select", "type": "string", "in": "query", "enum": ["current_month", "current_month_minus_1", "current_month_minus_2", "current_month_minus_3", "current_month_minus_4", "current_month_minus_5", "current_month_minus_6", "current_month_minus_7", "current_month_minus_8", "current_month_minus_9", "current_month_minus_10", "current_month_minus_11", "current_month_minus_12"], "x-cs-enum-type": "DashboardDateFilter", "required": true, "name": "date_filter"}, {"description": "Currency to fetch the data", "type": "string", "in": "query", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency", "required": true, "name": "currency"}, {"description": "cloud service name", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "service"}], "security": [{"auth_token": []}], "tags": ["Cost"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListReservationsResponse"}}}, "summary": "List Cost Reservations & Utilization (multi-tenant)", "description": "list reservation utilization across one or more tenants in a single call", "operationId": "ListReservationsUtilizationV2", "parameters": [{"name": "ListReservationsV2Request", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ListReservationsV2Request"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost/ri/utilization/{cloud_account_id}/reservations/{reservation_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListReservationsServiceAccountResponse"}}}, "summary": "List Cost Reservations & Utilization by Cloud Account", "description": "list reservation utilization cloud account wise", "operationId": "ListReservationsUtilizationCloudAccount", "parameters": [{"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the Cloud Account ID. This can be fetched from List CloudAccounts API call."}, {"name": "reservation_id", "in": "path", "required": true, "type": "string", "description": "Specify the Reservation ID for the Cloud Account. This can be fetched from List Cost Reservations & Utilizations API call."}, {"description": "Date Filter to select", "type": "string", "in": "query", "enum": ["current_month", "current_month_minus_1", "current_month_minus_2", "current_month_minus_3", "current_month_minus_4", "current_month_minus_5", "current_month_minus_6", "current_month_minus_7", "current_month_minus_8", "current_month_minus_9", "current_month_minus_10", "current_month_minus_11", "current_month_minus_12"], "x-cs-enum-type": "DashboardDateFilter", "required": true, "name": "date_filter"}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/cost_anomaly/billing_cost_anomaly": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CostAnomalySummaryResponse"}}}, "summary": "Get Account wise daily Billing Cost Anomaly", "description": "View Billing Cost Anomaly Data.", "operationId": "CostAnomalySummary", "parameters": [{"name": "CostAnomalySummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostAnomalySummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost Anomaly"]}}, "/cost_anomaly/billing_cost_anomaly_resources": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CostAnomalyResourcesResponse"}}}, "summary": "Get Account wise daily Billing Cost Anomaly Resources", "description": "View Billing Cost Anomaly Resources.", "operationId": "CostAnomalyResources", "parameters": [{"name": "CostAnomalyResourcesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostAnomalyResourcesRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost Anomaly"]}}, "/cost_anomaly/reject_anomaly": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Reject Billing Cost Anomaly", "description": "Reject Anomaly", "operationId": "RejectAnomaly", "parameters": [{"name": "CostAnomalyRejectRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostAnomalyRejectRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost Anomaly"]}}, "/governance/account/settings/access/post/{tenant_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/AssessmentValidationResponseList"}}}, "summary": "Assessment Validation", "description": "Analyse the access requirements for the given cloud account.", "operationId": "AssessmentValidation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "AssessmentValidationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AssessmentValidationRequest"}}], "security": [{"auth_token": []}], "tags": ["Assessment"]}}, "/governance/account/{tenant_id}/cloud_account/{cloud_account_id}/config_validation": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ConfigValidationResponse"}}}, "summary": "Config Validation Details", "description": "Config validation based on the policy engine", "operationId": "CloudAccountConfigValidation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the cloud account id to update, cloud account id is unique can be obtained from the list cloud account api. This should be same as the ID of the reference APIFor Azure CSP-Direct subscriptions, this can be fetched from list child accounts api."}, {"name": "ConfigValidationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ConfigValidationRequest"}}], "security": [{"auth_token": []}], "tags": ["Account Governance"]}}, "/governance/account/{tenant_id}/compliance_standards/{cloud_account_id}/get_configurations": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AssessmentComplianceResponse"}}}, "summary": "Assessment Compliance Validation", "description": "Creates a Assessment Validation list for compliance under the tenant.", "operationId": "AssessmentComplianceValidation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "ID of the cloud account. This can be fetched from ListCloudAccounts API"}], "security": [{"auth_token": []}], "tags": ["Assessment"]}}, "/governance/account/{tenant_id}/create/{cloud_account_id}/assessment_validation_result": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Success", "schema": {"$ref": "#/definitions/AssessmentValidationResponseDataModel"}}}, "summary": "Assessment Validation Details", "description": "Assessment validation for Operations, Cost, Security, Access and Resource.", "operationId": "AssessmentValidationDetails", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the cloud account id to update, cloud account id is unique can be obtained from the list cloud account api. This should be same as the ID of the reference APIFor Azure CSP-Direct subscriptions, this can be fetched from list child accounts api."}, {"name": "AssessmentValidationRequestDataModel", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AssessmentValidationRequestDataModel"}}], "security": [{"auth_token": []}], "tags": ["Account Governance"]}}, "/governance/account/{tenant_id}/create/{cloud_account_id}/revalidate_assessment": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Assessment Re-Validation", "description": "Assessment revalidation for Operations, Cost, Security, Access and Resource.", "operationId": "AssessmentReValidation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the cloud account id to assess a cloud account, cloud account id is unique can be obtained from the list cloud account api. This should be same as the ID of the reference APIFor Azure CSP-Direct subscriptions, this can be fetched from list child accounts api."}, {"name": "AssessmentValidationRequestDataModel", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AssessmentValidationRequestDataModel"}}], "security": [{"auth_token": []}], "tags": ["Account Governance"]}}, "/governance/account/{tenant_id}/get/{cloud_account_id}/assessment_validation_result": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AssessmentResultResponseDataModel"}}}, "summary": "Assessment Results", "description": "Displays the results of assessment with summary and history of the cloud account for OSCAR", "operationId": "AssessmentResults", "security": [{"auth_token": []}], "tags": ["Account Governance"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "cloud_account_id", "in": "path", "required": true, "type": "string"}]}, "/governance/guardrails/policies/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/PolicyDescription"}}}}, "summary": "List of policy details fetched for given policy uris or policy ids", "description": "Fetch policy details for given policy uris or policy ids. Supports a maximum of 1000 results per request\nSupports a maximum of 1000 results per request", "operationId": "BatchPoliciesUsingIds", "parameters": [{"name": "PolicyRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/policies/{tenant_id}/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CreateScheduleResponse"}}}, "summary": "Create Policy Schedules", "description": "create policy schedules", "operationId": "CreatePolicySchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "UpdateScheduleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateScheduleRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/policies/{tenant_id}/delete/{schedule_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Policy Schedules", "description": "Delete policy schedules", "operationId": "DeletePolicySchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to fetch the schedule data"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/policies/{tenant_id}/get/{schedule_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ViewScheduleResponse"}}}, "summary": "View Policy Schedules", "description": "view policy schedules", "operationId": "ViewPolicySchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to fetch the schedule data"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/policies/{tenant_id}/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListScheduleResponse"}}}, "summary": "List Policy Schedules", "description": "list policy schedules", "operationId": "ListPolicySchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/policies/{tenant_id}/update/{schedule_id}": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UpdateScheduleResponse"}}}, "summary": "Update Policy Schedules", "description": "update policy schedules", "operationId": "UpdatePolicySchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to fetch the schedule data"}, {"name": "UpdateScheduleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateScheduleRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/policies": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyData"}}}, "summary": "Create Policy", "description": "Creates a new policy under the tenant which will generate a unique policy id in the response this is can be used to describe details about the policy, update policy, execute or delete policy. However the policy will be accessible based on its scope  Account scope - All users under that account will have access to describe and execute. Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts to describe and execute. Tenant admins can update/delete. Private - User who created will only have access.", "operationId": "CreatePolicy", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CreatePolicyRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreatePolicyRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/policies/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/PolicyDescription"}}}}, "summary": "List of policy details fetched for given policy uris", "description": "Fetch policy details for given policy uris", "operationId": "policies-batch", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "PolicyDescriptionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyDescriptionRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/policies/list": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyListResponse"}}}, "summary": "List Policies", "description": "List all the policies. Global Policies Scope- All user will have access to Corestack Marketplace Policies these policies cannot be updated and deleted can be only describe and executed. Account Scope:- All users under that account will have access to view and execute Only Account admins can update/delete the policies.Tenant Scope - Users with access to the specific tenant will have access to policies who can describe or execute policies. Tenant admins can  only update/delete. Private Scope - User who created will only have access", "operationId": "ListPolicies", "parameters": [{"name": "PolicyListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyListRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/policies/validate_parameters": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ValidationResults"}}}, "summary": "Validate parameters for a given policy", "description": "Validate a set of parameters for a given policy", "operationId": "policies-validate-parameters", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "PolicyNamedParameterValidationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyNamedParameterValidationRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/policies/{policy_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Policy", "description": "Delete a policy which is no more required", "operationId": "DeletePolicy", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to execute, policy id can be obtained from the list policy api"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyViewResponse"}}}, "summary": "Describe Policy", "description": "Describe the already created Polices", "operationId": "DescribePolicy", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to execute, policy id can be obtained from the list policy api"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Update Policy", "description": "Update Policy details if required after creation using the api, the update by a user depends on the scope of the policy created check create policy docs for more details on the scope", "operationId": "UpdatePolicy", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to execute, policy id can be obtained from the list policy api"}, {"name": "UpdatePolicyRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdatePolicyRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/policies/{policy_id}/execute": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyExecuteResponse"}}}, "summary": "Execute Policy", "description": "Execute policy will return a unique job id the status of the policy can be checked using the Job details api where you can pass the unique id generated to get the details or errors if any on execution", "operationId": "ExecutePolicy", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to execute, policy id can be obtained from the list policy api"}, {"name": "PolicyExecuteRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyExecuteRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/policy_jobs/{job_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JobExecutionDetailsResponse"}}}, "summary": "Describe Policy Job Details", "description": "Retrieve policy job details using the unique job id, this can be used to check the status of the policy execution or any failure\n:param tenant_id:\n:param job_id:\n:return:", "operationId": "JobDetails", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "job_id", "in": "path", "required": true, "type": "string", "description": "Specify the job id to retrieve details of policy execution, job id is unique can be obtained from the execute policy response"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/recommendations": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyRecommendationListResponse"}}}, "summary": "List Policy Recommendations", "description": "Policy recommendations are the guide line to the users to solve a policy violation by executing the recommendations the this can be a instruction or a combination of multipleinstructions defined to solve a problem", "operationId": "PolicyRecommendations", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Specify the policy id for the recommendations which is a unique id can be obtained from policy listing api", "required": true, "name": "policy_id", "type": "string", "in": "query"}, {"description": "Specify the cloud account id  for the recommendation which is a unique id can be retrieved from the cloud listing api", "name": "cloud_account_id", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/governance/guardrails/{tenant_id}/recommendations/{recommendation_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyRecommendationViewResponse"}}}, "summary": "Describe Policy Recommendations", "description": "This is the api to view the recommendation associated with the policy and the resources which will get effected on execution of the recommendations. We can also get a idea on the actions which can be performed", "operationId": "DescribePolicyRecommendations", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "recommendation_id", "in": "path", "required": true, "type": "string", "description": "This is a unique identifier for recommendation, can be obtained from the PolicyRecommendations api response"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Execute Policy Recommendation", "description": "This is the api to execute recommendations for a policy violation, The recommended steps to resolve the violations can be executed with the help of data like action_name, resource_recommendation_id, will be available in Recommendation View API. The Recommendations can be executed with dynamic parameter which may or may not be passed in the input", "operationId": "ExecuteRecommendation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "recommendation_id", "in": "path", "required": true, "type": "string", "description": "This is a unique identifier for recommendation, can be obtained from the PolicyRecommendations api response"}, {"name": "ExecuteRecommendationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ExecuteRecommendationRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/operation/automation/scripts/{tenant_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScriptListResponse"}}}, "summary": "List Scripts", "description": "List all the scripts. Global Scripts - All user will have access to Corestack's Marketplace Scripts (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts (Can view and execute). Tenant admins can update/delete. Private - User who created will only have access.", "operationId": "ListScripts", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Script types to filter. Allowed Values: chef, ansible, puppet, shell", "in": "query", "type": "string", "enum": ["chef", "ansible", "puppet", "shell"], "name": "types"}, {"description": "Script types to filter. Allowed Values: Application, Languages, Database, Security, System, Web Server, Others", "in": "query", "type": "string", "enum": ["Application", "Languages", "Database", "Security", "System", "Web Server", "Others"], "name": "category"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Automation"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/CreateScriptResponse"}}}, "summary": "Create Script", "description": "Creates a new script under the tenant. However the script will be accessible based on its scope. Global Scripts - All user will have access to Corestack's Marketplace Scripts (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access scripts (Can view and execute). Tenant admins can update/delete. Private - User who created will only have access.", "operationId": "CreateScript", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CreateScriptRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateScriptRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/scripts/{tenant_id}/execute": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Execution Initiated", "schema": {"$ref": "#/definitions/ExecuteResponse"}}}, "summary": "Execute Script", "description": "Execute scripts. Ansible script supports executing single script in multiple machines. Chef/Puppet/Shell executing multiple scripts against multiple target machines.", "operationId": "ExecuteScript", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ExecuteScriptRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ExecuteScriptRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/scripts/{tenant_id}/get/{script_job_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScriptJobDataView"}}}, "summary": "Describe Script Job", "description": "View script job details.", "operationId": "DescribeScriptJob", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "script_job_id", "in": "path", "required": true, "type": "string", "description": "ID of the script_job. This can be fetched from listScriptJobs API/scriptExecute response"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/scripts/{tenant_id}/jobs/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScriptJobListResponse"}}}, "summary": "List Script Jobs", "description": "This API will list all script jobs initiated by the logged in user.", "operationId": "ListScriptJobs", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/scripts/{tenant_id}/scan": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Scanned successfully", "schema": {"$ref": "#/definitions/ScanScriptResponse"}}}, "summary": "Scan Script", "description": "Scans a script to check if all dependencies(if any) are satisfied. This API will also return parameters available in script for chef and parameter & hosts available in the script for ansible", "operationId": "ScanScript", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ScriptScanRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScriptScanRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/template/{tenant_id}/get/{job_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplateJobUpdateResponse"}}}, "summary": "View Template Job", "description": "View Template job details", "operationId": "ViewTemplateJob", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "job_id", "in": "path", "required": true, "type": "string", "description": "ID of the template_job. This can be fetched from listTemplateJobs API response"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/template/{tenant_id}/jobs/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplateJobListResponse"}}}, "summary": "List Templates Jobs", "description": "Jobs represent an instance of a Template or Script. Every time a Template or Script is executed, a Job is created. Jobs provide a reference of the execution, during and any time after it.", "operationId": "ListTemplatesJobs", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/templates/{tenant_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplateListResponse"}}}, "summary": "List Templates", "description": "List all the Templates. Global Scope - All the users will have access to view and execute CoreStack Marketplace Templates will not have access to update/delete the templates. Account Scope - All users under account scope will have access to view and execute the templates, only Account admins can update/delete the templates. Tenant Scope - Users having access to the specific tenant can view or execute templates. Tenant admins can only have the access toupdate/delete the templates. Private Scope - Templates created by the user will only have access for the templates under private scope.", "operationId": "ListTemplates", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "DSL types to filter templates.", "in": "query", "type": "string", "enum": ["arm", "cfn", "heat", "mistral", "terraform"], "name": "dsl"}, {"description": "Services to filter templates.", "in": "query", "type": "string", "enum": ["Openstack", "Azure(public)", "Azure", "Cloudstack", "vCenter", "AWS", "Rackspace", "OpenstackPublic", "GCP"], "name": "services"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Automation"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/TemplateCreateResponse"}}}, "summary": "Create Template", "description": "Creates a new Template under the tenant. However the script will be accessible based on its scope. Global Templates - All user will have access to CoreStack's Marketplace Templates (Can view and execute). Account - All users under that account will have access (Can view and execute). Only Account admins can update/delete. Tenant - Users with access to the specific tenant will have access template (Can view and execute). Tenant admins can update/delete. Private - User who created will only have access.", "operationId": "CreateTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CreateTemplateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateTemplateRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/{tenant_id}/scripts/{script_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete Script", "description": "Deletes a script. Cannot undo this action, so be cautious when performing this operation. Use updateScript to make the script as inactive if required", "operationId": "DeleteScript", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "script_id", "in": "path", "required": true, "type": "string", "description": "ID of the script. This can be fetched from listScripts API"}], "security": [{"auth_token": []}], "tags": ["Automation"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScriptDataView"}}}, "summary": "Describe Script", "description": "This API will provide detailed information about the script.", "operationId": "DescribeScript", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "script_id", "in": "path", "required": true, "type": "string", "description": "ID of the script. This can be fetched from listScripts API"}], "security": [{"auth_token": []}], "tags": ["Automation"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/CreateScriptResponse"}}}, "summary": "Update Script", "description": "Updates script details such as name, script path, dependencies etc.,", "operationId": "UpdateScript", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "script_id", "in": "path", "required": true, "type": "string", "description": "ID of the script. This can be fetched from listScripts API"}, {"name": "CreateScriptRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateScriptRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/{tenant_id}/templates/{template_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Template", "description": "Delete a Template which is no more required", "operationId": "DeleteTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "template_id", "in": "path", "required": true, "type": "string", "description": "Specify the template id of the template to delete, template id is unique can be obtained from the list template api"}], "security": [{"auth_token": []}], "tags": ["Automation"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplateViewResponse"}}}, "summary": "Describe Template", "description": "Describe the already created Templates", "operationId": "DescribeTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "template_id", "in": "path", "required": true, "type": "string", "description": "specify the template id to retrieve, which is a unique id can be obtained using list template api"}], "security": [{"auth_token": []}], "tags": ["Automation"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Update Template", "description": "Update Template details if required after creation using the api, the update by a user depends on the scope of the template created check create template docs for more details on the scope", "operationId": "UpdateTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "template_id", "in": "path", "required": true, "type": "string", "description": "Specify the template id to update which is a unique id can be retrieved using list template api"}, {"name": "CreateTemplateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateTemplateRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/{tenant_id}/templates/{template_id}/execute": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplateExecuteResponse"}}}, "summary": "Execute Template", "description": "Execute template will return a unique job id the status of the template can be checked  using the Job details api where you can pass the unique id generated to get the details or errors if any on execution", "operationId": "ExecuteTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "template_id", "in": "path", "required": true, "type": "string", "description": "Specify the template id to execute, template id can be obtained from the list template api"}, {"name": "TemplateExecuteRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TemplateExecuteRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/{tenant_id}/templates/{template_id}/get_params": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplateGetParamsResponse"}}}, "summary": "Get Template Params", "description": "Get the parameters required to execute a template", "operationId": "GetTemplateParams", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "template_id", "in": "path", "required": true, "type": "string", "description": "Specify the template id to execute, template id can be obtained from the list template api"}, {"name": "TemplateGetParamsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TemplateGetParamsRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/automation/{tenant_id}/templates/{template_id}/validate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplateValidateResponse"}}}, "summary": "Validate Template", "description": "Validates the Cloud Account and the input parameters provided for a template before executing the template", "operationId": "ValidateTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "template_id", "in": "path", "required": true, "type": "string", "description": "Specify the template id to execute, template id can be obtained from the list template api"}, {"name": "TemplateValidateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TemplateValidateRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operation/posture/dashboard_summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/OperationPostureResponse"}}}, "summary": "List Operation Posture Details For Mobile Site", "description": "Operation posture dashboard", "operationId": "OperationPostureDashboard", "parameters": [{"name": "OperationPostureRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/OperationPostureRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operation/posture/dashboard_summary/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/OperationPostureResponse"}}}, "summary": "List Operation Posture Details", "description": "operation posture dashboard", "operationId": "ListOperationOpsPosture", "parameters": [{"description": "to filter data by cloud provider or cloud account wise.By default tenant wise data displayed", "type": "string", "enum": ["cloud_account", "cloud_provider"], "required": true, "name": "filter_by", "in": "query"}, {"description": "Number of records to display", "type": "integer", "default": 10, "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "default": 1, "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operation/{tenant_id}/visibility/{cloud}/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/OperationVisibilityResponse"}}}, "summary": "List Operation Visibility Details", "description": "operation visibility dashboard", "operationId": "ListOperationOpsVisibility", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "cloud", "in": "path", "required": true, "type": "string", "description": "Specify the cloud service name to get the visibility details", "enum": ["AWS", "GCP", "Azure"]}, {"description": "to filter operation data count by region, resource or zone or account", "type": "string", "enum": ["resource", "region", "resource_group", "zone", "account"], "default": "account", "required": true, "name": "filter_by", "in": "query"}, {"description": "filter data by alerts or activity", "type": "string", "enum": ["activity", "alerts", "automation_failures"], "default": "activity", "required": true, "name": "visibility_by", "in": "query"}, {"description": "filter data by cloud account.Invalid if filter by value is account", "type": "string", "name": "service_account_id", "in": "query"}, {"description": "enable this option to list the visibility data for alerts or activity or automation failures", "type": "string", "enum": ["true", "false"], "name": "view_list", "in": "query"}, {"description": "to list visibility by  resource. valid if view_list option is true and region/resource_group/zone should be false/empty", "type": "string", "name": "resource", "in": "query"}, {"description": "to list visibility by region.valid if view_list option is true and cloud is AWS and resource/resource_group/zone should be false/empty", "type": "string", "name": "region", "in": "query"}, {"description": "to list visibility by resource group. valid if view_list option is true and cloud is Azure and resource/region/zone should be false/empty", "type": "string", "name": "resource_group", "in": "query"}, {"description": "to list visibility by zone.valid if view_list option is true and cloud is GCP and resource/region/resource_group should be false/empty", "type": "string", "name": "zone", "in": "query"}, {"description": "Number of records to display", "type": "integer", "default": 10, "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "default": 1, "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/activity/{cloud_name}/get_resource_detail": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/GetResourceDetailsResponse"}}}, "summary": "Get Operations Resource Details", "description": "Get the resource details for the specified cloud service name", "operationId": "GetResourceDetails", "parameters": [{"name": "cloud_name", "in": "path", "required": true, "type": "string", "description": "Specify the cloud service name to get the resource details. Allowed Values - AWS, Azure, GCP"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/activity/{tenant_id}/list_activity_operations": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListOperationsResponse"}}}, "summary": "List Operations Activity Details by Resource & Resource Type", "description": "List the operations based on resource and resource_type specified", "operationId": "ListActivityOperations", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"default": "list_operations", "required": true, "name": "action", "type": "string", "in": "query"}, {"description": "Service by which the cloud accounts and their configurations are segregated.", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "service"}, {"description": "Resource name of the corresponding cloud service. Resource can be fetched from Get Resource Detail API ", "type": "string", "required": true, "name": "resource", "in": "query"}, {"description": "Resource type of the corresponding cloud service. Resource Type can be obtained from List Operation Visibility Details", "type": "string", "required": true, "name": "resource_type", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/automation/blueprints/{tenant_id}/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CreateBlueprintDetails"}}}, "summary": "Create Blueprints", "description": "create blueprints", "operationId": "CreateBlueprints", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CreateBlueprintRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateBlueprintRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/blueprints/{tenant_id}/delete/{blueprint_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Blueprints", "description": "delete blueprints", "operationId": "DeleteBlueprints", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "blueprint_id", "in": "path", "required": true, "type": "string", "description": "Specify the blueprint Id to fetch data"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/blueprints/{tenant_id}/get/{blueprint_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ViewBlueprintDetails"}}}, "summary": "View Blueprints", "description": "view blueprints", "operationId": "ViewBlueprints", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "blueprint_id", "in": "path", "required": true, "type": "string", "description": "Specify the blueprint Id to fetch data"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/blueprints/{tenant_id}/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListBlueprintDetails"}}}, "summary": "List Blueprints", "description": "list blueprints", "operationId": "ListBlueprints", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/blueprints/{tenant_id}/update/{blueprint_id}": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UpdateBlueprintResponse"}}}, "summary": "Update Blueprints", "description": "update blueprints", "operationId": "UpdateBlueprints", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "blueprint_id", "in": "path", "required": true, "type": "string", "description": "Specify the blueprint Id to fetch data"}, {"name": "CreateBlueprintRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateBlueprintRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/scripts/{tenant_id}/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CreateScheduleResponse"}}}, "summary": "Create Script Schedules", "description": "create script schedules", "operationId": "CreateScriptSchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "UpdateScheduleRequestScript", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateScheduleRequestScript"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/scripts/{tenant_id}/update/{schedule_id}": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UpdateScheduleResponse"}}}, "summary": "Update Script Schedules", "description": "update script schedules", "operationId": "UpdateScriptSchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to fetch the schedule data"}, {"name": "UpdateScheduleRequestScript", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateScheduleRequestScript"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/templates/{tenant_id}/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CreateScheduleResponse"}}}, "summary": "Create Template Schedules", "description": "create template schedules", "operationId": "CreateTemplateSchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "UpdateScheduleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateScheduleRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/templates/{tenant_id}/update/{schedule_id}": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UpdateScheduleResponse"}}}, "summary": "Update Template Schedules", "description": "update template schedules", "operationId": "UpdateTemplateSchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to fetch the schedule data"}, {"name": "UpdateScheduleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateScheduleRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/{tenant_id}/delete/{schedule_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Template and Script Schedules", "description": "delete template and script schedules", "operationId": "DeleteTemplateAndScriptSchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to fetch the schedule data"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/{tenant_id}/get/{schedule_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ViewScheduleResponse"}}}, "summary": "View Template and Script Schedules", "description": "view template and script schedules", "operationId": "ViewTemplateAndScriptSchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to fetch the schedule data"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/automation/{tenant_id}/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListScheduleResponse"}}}, "summary": "List Template and Script Schedules", "description": "list template and script schedules", "operationId": "ListTemplateAndScriptSchedules", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Type of schedule. Choose one of the below.", "enum": ["template", "script"], "required": true, "name": "type", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/operations/azure_patch_management/report/trigger": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Azure Patch Management Report Trigger", "description": "Trigger Azure Patch Management report", "operationId": "AzurePatchManagementReportTrigger", "parameters": [{"name": "AzurePatchManagementReportTriggerRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AzurePatchManagementReportTriggerRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/apply_template": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Applied", "schema": {"type": "boolean"}}}, "summary": "Apply Operations Alert Configuration", "description": "Apply Template", "operationId": "ApplyTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ApplyTemplateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ApplyTemplateRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/list_cloud_account_configurations": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListCloudAccountConfiguration"}}}, "summary": "List Operations Alert Configuration by Cloud Account", "description": "List cloud account configurations", "operationId": "ListCloudAccountConfigurations", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/list_cloud_account_details": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/GetServiceDetails"}}}, "summary": "Get Service Details For Operations Alert Configuration", "description": "Get Service Details", "operationId": "GetServiceDetails", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/cloud_accounts/{tenant_id}/view_applied": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ViewAppliedResponse"}}}, "summary": "View Applied Operations Alert Configuration", "description": "View what is applied", "operationId": "ViewApplied", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ViewAppliedRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ViewAppliedRequest"}}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/clone_template": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CloneTemplateResponse"}}}, "summary": "Clone Operations Alert Configuration Templates", "description": "Clone Template", "operationId": "CloneTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CloneTemplateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CloneTemplateRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/create_template": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CreateAlertTemplateResponse"}}}, "summary": "Create Operations Alert Configuration Templates", "description": "Create Template", "operationId": "OperationsAlertConfigurationCreateTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CreateAlertTemplateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateAlertTemplateRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/edit_template": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Update Operations Alert Configuration Template", "description": "Edit Template", "operationId": "EditTemplate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "EditTemplateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/EditTemplateRequest"}}, {"description": "Specify the monitoring_template_uri of the template which the name to be edited", "required": true, "name": "monitoring_template_uri", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/edit_template_name": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Update Operations Alert Configuration Template Name", "description": "Edit Template Name", "operationId": "EditTemplateName", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "EditTemplateNameRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/EditTemplateNameRequest"}}, {"description": "Specify the monitoring_template_uri of the template which the name to be edited", "required": true, "name": "monitoring_template_uri", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/enable_default_template": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Set", "schema": {"type": "boolean"}}}, "summary": "Set Default Options Operations Alert Configuration", "description": "Option to Set Template as Default", "operationId": "SetDefaultOptions", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "SetDefaultRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SetDefaultRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/list_alert_templates": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListAlertTemplates"}}}, "summary": "List Operations Alert Configuration Templates", "description": "List Alert templates", "operationId": "ListAlertTemplates", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/resource_metric_hierarchy_configuration": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourceMetricHierarchyResponse"}}}, "summary": "List Operations Resource Metric Hierarchy Configuration", "description": "resource metric hierarchy configuration listing", "operationId": "ResourceMetricHierarchyConfiguration", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ResourceMetricHierarchyRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResourceMetricHierarchyRequest"}}, {"description": "Specify the criticality", "enum": ["all", "High", "Medium", "Low"], "required": false, "name": "criticality", "type": "string", "in": "query"}, {"description": "Specify the status", "enum": ["all", "configured", "unconfigured"], "required": false, "name": "status", "type": "string", "in": "query"}, {"description": "Specify the metric_type", "enum": ["all", "Availability", "Capacity", "Failure", "Performance", "Security", "Success", "Utilization"], "required": false, "name": "metric_type", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/monitoring_and_alerts/monitoring_templates/{tenant_id}/view_configuration": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ViewConfigurationResponse"}}}, "summary": "View Operations Configuration Details", "description": "view configuration listing", "operationId": "ViewConfiguration", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ViewConfigurationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ViewConfigurationRequest"}}, {"description": "Specify the criticality", "enum": ["all", "High", "Medium", "Low"], "default": "all", "required": true, "name": "criticality", "type": "string", "in": "query"}, {"description": "Specify the status", "enum": ["all", "configured", "unconfigured"], "default": "all", "required": false, "name": "status", "type": "string", "in": "query"}, {"description": "Specify the metric_type", "enum": ["all", "Availability", "Capacity", "Failure", "Performance", "Security", "Success", "Utilization"], "default": "all", "required": true, "name": "metric_type", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Operations"]}}, "/operations/trend_analysis/backup": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/BackupReportResponse"}}}, "summary": "Backup Report", "description": "Fetch the backup report based on cloud account usage", "operationId": "CreateBackupReport", "parameters": [{"name": "CreateBackupReport", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateBackupReport"}}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/operations/trend_analysis/patch_compliance": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/PatchComplianceReportRes"}}}, "summary": "Patch Compliance Report", "description": "Fetch the patch compliance report based on cloud account usage", "operationId": "PatchComplianceReports", "parameters": [{"name": "PatchComplianceReportReq", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PatchComplianceReportReq"}}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/operations/trend_analysis/recovery_service": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/RecoveryServiceReportRes"}}}, "summary": "RecoveryService Report", "description": "Fetch the recovery service report based on cloud account usage", "operationId": "RecoveryServiceReports", "parameters": [{"name": "RecoveryServiceReportReq", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecoveryServiceReportReq"}}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/recommendations/{definition_id}/resolve": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Resolved", "schema": {"type": "boolean"}}}, "summary": "Resolve Definition Recommendation", "description": "Resolve definition recommendations", "operationId": "ResolveDefRecommendations", "parameters": [{"name": "definition_id", "in": "path", "required": true, "type": "string", "description": "Specify the definition_id it will be fetched from list compliance posture DetailsForPolicies"}, {"name": "ResolveDefRecommendationsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResolveDefRecommendationsRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/recommendations/{definition_id}/resolve_preexecute": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ExecuteActionRecommendationResponse"}}}, "summary": "Resolve Recommendation Action Preexecute", "description": "Resolve recommendations", "operationId": "ResolveActionRecommendationExecute", "parameters": [{"name": "definition_id", "in": "path", "required": true, "type": "string", "description": "Specify the definition_id it will be fetched from list compliance posture DetailsForPolicies"}, {"name": "ExecuteResolveActionRecommendationsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ExecuteResolveActionRecommendationsRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/recommendations/{tenant_id}/account/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListRecommendationByAccountResponse"}}}, "summary": "List Recommendations by Account", "description": "List recommendations by account", "operationId": "ListRecommendationsByAccount", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"name": "ListRecommendationByAccountRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ListRecommendationByAccountRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/recommendations/{tenant_id}/category/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListRecommendationByCategoryResponse"}}}, "summary": "List Recommendations by Category", "description": "list recommendations by category", "operationId": "ListRecommendationsByCategory", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"description": "Specify the Category to fetch the recommendation data.Please enter comma separated values.Allowed values - Cost,Security,Access,Operation,Resource", "type": "string", "in": "query", "name": "classifications"}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/recommendations/{tenant_id}/get/{recommendation_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListPolicyRecommendationsResponse"}}}, "summary": "List Recommendations", "description": "List recommendations", "operationId": "ListsRecommendations", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"name": "recommendation_id", "in": "path", "required": true, "type": "string", "description": "Specify the recommendation ID. This is a unique ID and can be retrieved using the 'List recommendations by Cloud Account' or 'List recommendations by Category' API call. "}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Select the Status", "enum": ["open"], "name": "resource_status", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/recommendations/{tenant_id}/resolve/{recommendation_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Resolved", "schema": {"type": "boolean"}}}, "summary": "Resolve Recommendation", "description": "Resolve recommendations", "operationId": "ResolveRecommendation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"name": "recommendation_id", "in": "path", "required": true, "type": "string", "description": "Specify the recommendation ID. This is a unique ID and can be retrieved using the 'List recommendations by Cloud Account' or 'List recommendations by Category' API call. "}, {"name": "ResolveRecommendationsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResolveRecommendationsRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/recommendations/{tenant_id}/resolve_preexecute/{recommendation_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ExecuteRecommendationRespModel"}}}, "summary": "Resolve PreExecute Recommendation", "description": "Execute resolve recommendations", "operationId": "ResolveRecommendationExecute", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"name": "recommendation_id", "in": "path", "required": true, "type": "string", "description": "Specify the recommendation ID. This is a unique ID and can be retrieved using the 'List recommendations by Cloud Account' or 'List recommendations by Category' API call. "}, {"name": "ExecuteResolveRecommendationsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ExecuteResolveRecommendationsRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/recommendations/{tenant_id}/service_account/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListRecommendationByAccountResponse"}}}, "summary": "List Recommendations by Cloud Account", "description": "List recommendations by cloud account", "operationId": "ListRecommendationsByCloudAccount", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API. "}, {"description": "Specify the Cloud Account ID. It is unique ID and can be retrieved from the List Cloud Accounts API.", "type": "string", "in": "query", "name": "service_account_id"}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/resource/inventory/{tenant_id}/cloud_account": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RediscoverResponse"}}}, "summary": "Getting the resources cloud account details based on the tenant", "description": "Getting the resources cloud account details based on the tenant", "operationId": "FilterCloudAccount", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Cloud Service Name", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "service_name"}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/inventory/{tenant_id}/count": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CategoryCountResponse"}}}, "summary": "Get Inventory Count", "description": "Get inventory category count based on the cloud and cloud account will list categories & Get inventory resource count based on the cloud and cloud account will list all resources with resource_category, resource_type, resource and will list only the count on number of resources available in particular category", "operationId": "GetInventoryCount", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CategoryCountRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CategoryCountRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/inventory/{tenant_id}/filters": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/InventoryResponse"}}}, "summary": "List Inventory Filters", "description": "Get all the available filters for the corresponding cloud.Listing filter attributes will help us in getting resource details with the filters listed can be applied on the resource details call and this api is only to list filtersfor ex: AWS will have regions and tags as filters available and Azure will have resource groups and tags as filters", "operationId": "ListInventoryFilters", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "InventoryFilterRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InventoryFilterRequest"}}, {"description": "Name of the cloud", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "service_name"}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/inventory/{tenant_id}/resource_listing": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ResourceListingResponse"}}}}, "summary": "Get Resource Listing", "description": "Listing the Resource details", "operationId": "GetResourceList", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID for the Resource. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ResourceListingRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResourceListingRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/inventory/{tenant_id}/resources": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/InventoryResourceDetailsResponse"}}}, "summary": "Get Inventory Details", "description": "Get resource details based on the cloud accounts, category, component, resource and filters can be applied based on the cloud and cloud account for ex: AWS will have regions in filters and Azure will have resource group as filters for listing resources.", "operationId": "GetInventoryDetails", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID for the inventory. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "InventoryResourceDetailsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InventoryResourceDetailsRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/locks/{tenant_id}/list_config_rules": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListLockConfigRuleResponse"}}}, "summary": "List Resource Lock Config Rules", "description": "Resource posture dashboard", "operationId": "ListConfigRules", "parameters": [{"description": "to filter locks by tenant or cloud account wise", "type": "string", "enum": ["cloud_account", "tenant"], "required": true, "name": "scope", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Resource"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}]}, "/resource/locks/{tenant_id}/lock_config_rule": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Resource Lock Config Rule", "description": "Delete a lock config rule under a CoreStack", "operationId": "DeleteLockConfigRule", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "DeleteLockConfigRuleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DeleteLockConfigRuleRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/CreateLockConfigRuleResponse"}}}, "summary": "Create Resource Lock Config Rule", "description": "Creates a new lock config rule under a CoreStack", "operationId": "createLockConfigRule", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "CreateResourceLockRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateResourceLockRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/posture/account_or_tenant/visibility": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourceVisibilityResponse"}}}, "summary": "List Resource Visibility Count", "description": "Resource visibility dashboard", "operationId": "ListVisibilityCount", "parameters": [{"description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.", "name": "tenant_id", "type": "string", "in": "query"}, {"description": "to filter resource data count by region, resource or account", "type": "string", "required": true, "enum": ["resource_type", "application", "account", "region", "resource_group", "resource_category"], "name": "sub_category", "in": "query"}, {"description": "filter data by cloud", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "cloud"}, {"description": "filter data by cloud account.Invalid if sub_Category by value is account", "type": "string", "name": "cloud_account_id", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/posture/account_or_tenant/visibility/resources_without_locks_or_tags": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourceVisibilityListResponse"}}}, "summary": "List Resource Visibility Details", "description": "Resource Visibility dashboard", "operationId": "ListResourceVisibility", "parameters": [{"description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.", "type": "string", "required": true, "name": "tenant_id", "in": "query"}, {"description": "filter data by cloud", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": true, "name": "cloud"}, {"description": "filter data by cloud account", "type": "string", "name": "cloud_account_id", "in": "query"}, {"description": "to list resource data without tags, locks", "type": "string", "required": true, "enum": ["tags", "locks"], "name": "filter_by", "in": "query"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/posture/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourcePostureResponse"}}}, "summary": "List Resource Posture Details", "description": "Resource posture dashboard", "operationId": "ListResourcePosture", "parameters": [{"description": "to filter data by cloud provider or cloud account wise.By default tenant wise data displayed", "type": "string", "enum": ["cloud_account", "cloud_provider"], "name": "sub_category", "in": "query"}, {"description": "Specify the tenant ID as comma separated. This is a unique ID and can be retrieved using the List Tenants API.", "required": true, "name": "tenant_ids", "type": "string", "in": "query"}, {"description": "Select one from the supported services to display summary for that particular service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "service_name"}, {"description": "Search by account_name wise", "type": "string", "name": "search", "in": "query"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/resource/{tenant_id}/locks/{cloud}/get_filters": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScopeFilter"}}}, "summary": "List Resource Lock Config Rule Filters", "description": "Resource lock", "operationId": "ListConfigRuleFilters", "parameters": [{"description": "to get tags keys of cloud account", "type": "boolean", "name": "tags", "in": "query"}, {"description": "get resource filters of cloud account", "type": "boolean", "name": "resources", "in": "query"}, {"description": "get filters for tags of cloud account", "type": "boolean", "name": "is_tag_wise", "in": "query"}, {"description": "to list of regions of cloud account", "type": "boolean", "name": "region", "in": "query"}, {"description": "to list resource groups of cloud account", "type": "boolean", "name": "resource_group", "in": "query"}, {"description": "to list zone of cloud account", "type": "boolean", "name": "zone", "in": "query"}, {"description": "to list applicability filters of cloud account", "type": "boolean", "name": "applicability_by", "in": "query"}, {"description": "cloud account id", "type": "string", "name": "service_account_id", "in": "query"}, {"description": "scope", "type": "string", "enum": ["cloud_account", "tenant"], "name": "scope", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Resource"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "cloud", "in": "path", "required": true, "type": "string"}]}, "/secure/{tenant_id}/score": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Mapping", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecureDetails"}}}}, "summary": "SecureScore Mapping Report", "operationId": "getSecureScores", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This needs to fetch from Azure accounts."}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/security/executive_dashboard/threats/by_cloud_accounts": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardThreatsSummaryAccountResponse"}}}, "summary": "Get Threat by Cloud Accounts", "description": "Security Dashboard Threats by Accounts", "operationId": "ThreatByAccounts", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/threats/by_region": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardThreatsByRegionResponse"}}}, "summary": "Get Threat by Region", "description": "Security Dashboard Threat by Region", "operationId": "ThreatByRegion", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/threats/by_resource_category": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardThreatsByResourceCategoryResponse"}}}, "summary": "Get Threat by Resource Category", "description": "Security Dashboard Threat by Resource Category", "operationId": "ThreatByResourceCategory", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/threats/trend_by_severity": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardThreatSummaryMonthResponse"}}}, "summary": "Get Threats by Trend", "description": "Security Dashboard Threats by Trend", "operationId": "ThreatByTrend", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/violations/by_cloud_account": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardViolationsByAccountResponse"}}}, "summary": "Get Config Violation by Cloud Account", "description": "Security Dashboard Violations by Cloud Accounts", "operationId": "violationsByCloudAccount", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/violations/by_region": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardViolationsByRegionResponse"}}}, "summary": "Get Config Violation By Region", "description": "Security Dashboard Violations by Region", "operationId": "violationsByRegion", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/violations/by_resource_category": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardViolationsByResourceCategoryResponse"}}}, "summary": "Get Config Violation by Resource Category", "description": "Security Dashboard Violation by Resource Category", "operationId": "violationsByResourceCategory", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/violations/trend_by_severity": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardViolationsByMonthResponse"}}}, "summary": "Get Config Violation trend by severity", "description": "Security Dashboard Config Violation by Trend", "operationId": "violationsTrend", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/vulnerabilities/by_cloud_account": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardVulnerabilitySummaryAccountResponse"}}}, "summary": "Get Vulnerability by Cloud Account", "description": "SecOps Dashboard Vulnerabilities by Cloud Account", "operationId": "VulnerabilityByAccount", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/vulnerabilities/by_region": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityDashboardVulnerabilitySummaryRegionResponse"}}}, "summary": "Get Vulnerability by Region", "description": "SecOps Dashboard Vulnerabilities by Region", "operationId": "VulnerabilityByRegion", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/executive_dashboard/vulnerabilities/trend_by_severity": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityVulnerabilitySummaryMonthResponse"}}}, "summary": "Get Vulnerability by Trend", "description": "SecOps Dashboard Vulnerabilities by Trend", "operationId": "VulnerabilityByTrend", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/posture/visibility/{tenant_id}/get/vulnerability": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityVulnerabilityResponse"}}}, "summary": "List Security Vulnerability Details", "description": "Security Vulnerability for tenant or cloud account", "operationId": "SecurityVulnerability", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "ID of the service account. This can be fetched from list cloud accounts API.", "name": "accounts", "type": "string", "in": "query"}, {"description": "Cloud service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "services"}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/posture/visibility/{tenant_id}/get/{action_name}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityVisibilityResponse"}}}, "summary": "List Security Visibility Details", "description": "Security threat and guardrails details for tenant or cloud account", "operationId": "SecurityVisibility", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "action_name", "in": "path", "required": true, "type": "string", "description": "Action name to get visibility data", "enum": ["threats_tenant_summary", "guardrails_tenant_summary"]}, {"description": "ID of the service account. This can be fetched from list cloud accounts API.", "name": "accounts", "type": "string", "in": "query"}, {"description": "Cloud service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "services"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/posture/{tenant_id}/get/securityops": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityPostureTenantResponse"}}}, "summary": "Get Security Posture Details By Tenant", "description": "Security posture By Tenant", "operationId": "SecurityPostureByTenant", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Severity of the violations.", "type": "string", "enum": ["threats", "vulnerability", "guardrail"], "name": "category", "in": "query"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "search by tenant_name wise", "type": "string", "name": "search", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/security/posture/{tenant_id}/get/securityops/{action_name}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/SecurityPostureResponse"}}}, "summary": "Get Security Posture Details by Cloud Account & Cloud Service Provider", "description": "Security posture by Cloud and Cloud Accounts", "operationId": "SecurityPosture", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "action_name", "in": "path", "required": true, "type": "string", "description": "Action name to get posture data by Cloud and Cloud Accounts category", "enum": ["posture_by_cloud", "posture_by_cloud_account"]}, {"description": "Severity of the violations. Choose any of the below when action_name is chosen as posture_by_cloud_account", "type": "string", "enum": ["threats", "vulnerability", "guardrail"], "name": "category", "in": "query"}, {"description": "Select one from the supported services to display summary for that particular service", "type": "string", "in": "query", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName", "default": "AWS", "required": false, "name": "service_name"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Search by account_name wise", "type": "string", "name": "search", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/self_service/dashboard/{tenant_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CustomerDashboardReportModel"}}}, "summary": "Self Service Customer Dashboard", "description": "CustomerDashboard", "operationId": "CustomerDashboard", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Select action", "type": "string", "enum": ["consumer_dashboard"], "name": "action", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/self_service/orders/{tenant_id}/{action}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/OrderHistoryReportModel"}}}, "summary": "Self Service Order History", "description": "OrderHistory", "operationId": "OrderHistory", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "action", "in": "path", "required": true, "type": "string", "description": "Select action", "enum": ["myrequests"]}], "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/self_service/resource_catalogs/{tenant_id}/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourceCatalogCreateDataModel"}}}, "summary": "Create Resource Catalog", "description": "Resource Catalog Create", "operationId": "ResourceCatalogCreate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "ResourceCatalogServiceLevelDataModel", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResourceCatalogServiceLevelDataModel"}}], "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/self_service/resource_catalogs/{tenant_id}/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourceCatalogGetDataModel"}}}, "summary": "List Resource Catalog", "description": "Resource Catalog list", "operationId": "ResourceCatalogList", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/self_service/resource_catalogs/{tenant_id}/{catalog_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Resource Catalog", "description": "Resource Catalog Delete", "operationId": "ResourceCatalogDelete", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "catalog_id", "in": "path", "required": true, "type": "string", "description": "Catalog ID"}], "security": [{"auth_token": []}], "tags": ["Self Service"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Update Resource Catalog", "description": "Resource Catalog Modify", "operationId": "ResourceCatalogModify", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "catalog_id", "in": "path", "required": true, "type": "string", "description": "Catalog ID"}, {"name": "ResourceCatalogServiceLevelDataModel", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResourceCatalogServiceLevelDataModel"}}], "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/self_service/workspace/{tenant_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkSpaceReportModel"}}}, "summary": "List Workspaces", "description": "WorkSpace", "operationId": "WorkSpace", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Select the action", "type": "string", "enum": ["dashboard"], "name": "action", "in": "query"}, {"description": "Select the request type", "type": "string", "enum": ["myrequest"], "name": "type", "in": "query"}, {"description": "Select to true to display false one also", "type": "string", "enum": ["true", "false"], "name": "show_failed", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/self_service/{tenant_id}/catalog/{cloud_account_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Service Catalog", "description": "Service Catalog list", "operationId": "ServiceCatalogDelete", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "Cloud Account ID"}], "security": [{"auth_token": []}], "tags": ["Self Service"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceCatalogGetDataModel"}}}, "summary": "Create Service Catalog", "description": "Get Service Catalog", "operationId": "serviceCatalogCreate", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "Cloud Account ID"}, {"description": "action", "type": "string", "enum": ["default_values"], "name": "action", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/tenants": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListTenantResponse"}}}, "summary": "List Tenant", "description": "There can be multiple tenants within a CoreStack account. List all tenants the user is mapped under a CoreStack account. If there are 3 tenants and user performing this operation has access to only 2 tenants then only those 2 tenants will be returned.", "operationId": "listTenant", "security": [{"auth_token": []}], "tags": ["Identity"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/TenantCreateResponse"}}}, "summary": "Create Tenant", "description": "Creates a new tenant under a CoreStack account. There can be multiple tenants within a CoreStack account.", "operationId": "createTenant", "parameters": [{"name": "CreateTenantRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateTenantRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/tenants/{tenant_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Tenant", "description": "Delete a tenant by its Id. Cannot undo this action, so be cautious when performing this operation. Use updateTenant to make the tenant as suspended if required.", "operationId": "deleteTenant", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Id of the tenant to be deleted."}], "security": [{"auth_token": []}], "tags": ["Identity"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/GetTenantResponse"}}}, "summary": "Get Tenant", "description": "Retrieve a tenant by its Id.  If you're unsure of the tenant_id, use listTenant operation to list all tenants under a CoreStack account and fetch the needed tenant_id.", "operationId": "getTenant", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Identity"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TenantUpdateResponse"}}}, "summary": "Update Tenant", "description": "Update a tenant's status, description & metadata using its id. No operation can be performed when a tenant is made suspended.", "operationId": "updateTenant", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Id of the CoreStack account under which the tenant to be updated."}, {"name": "UpdateTenantRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UpdateTenantRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/tenants/{tenant_id}/name_change_history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Name change history retrieved successfully", "schema": {"$ref": "#/definitions/NameChangeHistoryResponse"}}}, "summary": "Get Tenant Name Change History", "description": "Retrieve the name change history for a tenant.", "operationId": "getTenantNameChangeHistory", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Id of the tenant to retrieve name change history for."}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/tenants/{tenant_id}/roles": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RoleListResponse"}}}, "summary": "List Roles by Tenant", "description": "This GET method is used to retrieve the list of Roles available within a specific tenant.", "operationId": "ListRoles", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/tenants/{tenant_id}/users": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserTenantResponseList"}}}, "summary": "List Users by Tenant", "description": "List all users within a tenant.", "operationId": "ListTenantUser", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/change_password/{user_id}": {"parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string"}], "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ChangePasswordResponse"}}}, "summary": "Change Password", "description": "Update the password of the user. This password will be used for login to portal and it will not affect the Access Key / Secret Key associated with the user. Cannot update password of another user within the same CoreStack account. Can be updated for the user associated with Access Key / Secret Key", "operationId": "ChangePassword", "parameters": [{"name": "ChangePasswordRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ChangePasswordRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/change_time_zone/{user_id}": {"parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string"}], "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ChangeTimezoneResponse"}}}, "summary": "Change Timezone", "description": "Update the timezone settings of the user. In CoreStack portal, wherever the datatime is shown it is converted to the timezone set to the user. Cannot update timezone of another user within the same CoreStack account. Can be updated for the user associated with Access Key / Secret Key", "operationId": "ChangeTimezone", "parameters": [{"name": "ChangeTimezoneRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ChangeTimezoneRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Success", "schema": {"$ref": "#/definitions/UserCreateResponse"}}}, "summary": "Create User", "description": "Creates an user within a CoreStack account and assign different roles for different tenants. There can be multiple tenants within a CoreStack account. User will be created at the account level and mapped to multiple tenants as needed.", "operationId": "CreateUser", "parameters": [{"name": "UserCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/delete/{user_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete User", "description": "Deletes the User from CoreStack system. This operation cannot be undone.", "operationId": "DeleteUser", "security": [{"auth_token": []}], "tags": ["Identity"]}, "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string"}]}, "/users/filter-options": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FilterOptions"}}}, "summary": "List Users", "description": "List all tenants, cloud providers and cloud accounts available within a CoreStack account.", "operationId": "ListUserFilterOptions", "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/filter-options-light": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FilterOptionsLight"}}}, "summary": "List Users", "description": "List all tenants with limited details within a CoreStack account.", "operationId": "ListUserFilterOptionsLight", "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/forget_password/{user_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Forgotten", "schema": {"type": "boolean"}}}, "summary": "Forget Password", "description": "Forget the password of the user. This password will be used for login to portal and it will not affect the Access Key / Secret Key associated with the user", "operationId": "ForgetPassword", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "User Id fetched from List User API"}, {"name": "ForgetPasswordRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ForgetPasswordRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserResponseList"}}}, "summary": "List Users", "description": "List all users within a CoreStack account.", "operationId": "ListUser", "parameters": [{"description": "Specify the master account id", "name": "master_account_id", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/notification/report": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/NotificationReportResponse"}}}, "summary": "Send notification report email", "description": "Send a notification email for a shared report", "operationId": "NotificationReport", "parameters": [{"name": "NotificationReportRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/NotificationReportRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/notifications/{user_id}/{tenant_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CountUserNotificationsResponse"}}}, "summary": "Check notification status", "description": "Check Notification status for user", "operationId": "CountUserNotifications", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Id of user"}, {"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Id of active tenant"}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/profile/active-tenant": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserProfileActiveTenantResponse"}}}, "summary": "Update active tenant for a user", "description": "Sets the active tenant for the user", "operationId": "UserProfileActiveTenant", "parameters": [{"name": "UserProfileActiveTenantRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserProfileActiveTenantRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/profile/{user_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ProfileResponse"}}}, "summary": "View User Profile", "description": "Describes an User by ID. This provides detailed information about a user profile", "operationId": "UserProfile", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "User Id fetched from List User API"}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/resend_token/{user_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResendTokenResponse"}}}, "summary": "Resend User Token for Activation", "description": "Resend User Activation Link", "operationId": "ResendTokenUser", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Id of user"}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/reset_password": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResetPasswordResponse"}}}, "summary": "Reset Password", "description": "Reset the password of the user.This password will be used for login to portal and it will not affect the Access Key / Secret Key associated with the user", "operationId": "UsersResetPassword", "parameters": [{"name": "ResetPasswordRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResetPasswordRequest"}}], "tags": ["Identity"]}}, "/users/summary/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserSummaryBatchResponse"}}}, "summary": "User Batch", "description": "User Summary Batch", "operationId": "UserSummaryBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/update/{user_id}": {"parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string"}], "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserUpdateResponse"}}}, "summary": "Update User", "description": "Updates a user and their role assignment in multiple tenants.", "operationId": "UpdateUser", "parameters": [{"name": "UserUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/view/{user_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserDescribeResponse"}}}, "summary": "Describe User", "description": "Describes an User by ID. This provides detailed information about a user", "operationId": "DescribeUser", "security": [{"auth_token": []}], "tags": ["Identity"]}, "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string"}]}, "/users/{tenant_id}/notification_message": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/NotificationMessageResponse"}}}, "summary": "List notification message", "description": "This GET method is used to retrieve the Notification, Message a specific tenant.", "operationId": "NotificationMessageResource", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Specify the action name. Allowed values: view_notifications, if require to fetch data with filter wise use view_notifications", "enum": ["view_notifications"], "name": "action", "type": "string", "in": "query"}, {"description": "Specify value for display, if require to fetch data for filter wise use read, unread,all", "enum": ["read", "unread", "all"], "name": "display", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/{user_id}/activate_user/{auth_token}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ActivateUserResponse"}}}, "summary": "Activate User", "description": "Activate user using auth token", "operationId": "AuthActivateUser", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Id of user"}, {"name": "auth_token", "in": "path", "required": true, "type": "string", "description": "auth_token to activate created user.Can be fetched from the activation email sent"}, {"name": "ActivateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ActivateRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/users/{user_id}/verify_user/{auth_token}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/VerifyUserResponse"}}}, "summary": "Verify User", "description": "Verify user using auth token", "operationId": "AuthVerifyUser", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Id of user"}, {"name": "auth_token", "in": "path", "required": true, "type": "string", "description": "auth_token to verify created user.Can be fetched from the activation email sent"}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/admin/background_job/activation": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Sets the next activation time for the Background Job", "description": "Changes the activation of a Background Job", "operationId": "BackgroundJobActivation", "parameters": [{"name": "BackgroundJobUpdateActivationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobUpdateActivationRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/BackgroundJobBatchResponse"}}}, "summary": "Returns a batch of BackgroundJobs", "description": "Get details for the Background Job ids passed in the request", "operationId": "BackgroundJobBatch", "parameters": [{"name": "BackgroundJobBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/cancel": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Cancelled", "schema": {"type": "boolean"}}}, "summary": "Requests the cancellation of a job", "description": "Request a Background Job to stop processing as soon as possible", "operationId": "BackgroundJobCancel", "parameters": [{"name": "RecordIdentity", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentity"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/forwarding_check": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Checked", "schema": {"$ref": "#/definitions/BackgroundJobForwardingCheckResponse"}}}, "summary": "Internal", "description": "Verify federation route", "operationId": "BackgroundJobForwardingCheck", "parameters": [{"name": "BackgroundJobForwardingCheckRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobForwardingCheckRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/invalidation": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Invalidated", "schema": {"type": "boolean"}}}, "description": "Request a Background Job to stop processing as soon as possible", "operationId": "BackgroundJobInvalidation", "parameters": [{"name": "BackgroundJobInvalidation", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobInvalidation"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListDetailedResponse"}}}, "summary": "Returns a list of BackgroundJobs ids", "description": "Get the list of all Background Jobs.", "operationId": "BackgroundJobList", "parameters": [{"name": "BackgroundJobListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobListRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/log": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Unknown Background Job", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/BackgroundJobLogResponse"}}}, "summary": "Returns a batch of log entries for BackgroundJob", "description": "Get log entries for the Background Job passed in the request", "operationId": "BackgroundJobLog", "parameters": [{"name": "BackgroundJobLogRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobLogRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/logger/set-level": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/BackgroundJobLogger"}}}, "summary": "Sets the level of a logger", "description": "Set the level of a logger for Background Jobs workers.", "operationId": "BackgroundJobLoggerSet", "parameters": [{"name": "BackgroundJobLogger", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobLogger"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/loggers": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"type": "array", "items": {"$ref": "#/definitions/BackgroundJobLogger"}}}}, "summary": "Returns a list of BackgroundJobs threads", "description": "Get loggers from all Background Jobs workers.", "operationId": "BackgroundJobLoggers", "parameters": [{"name": "BackgroundJobLoggerRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobLoggerRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/priority": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Sets the priority on Background Job", "description": "Changes the priority of a Background Job", "operationId": "BackgroundJobPriority", "parameters": [{"name": "BackgroundJobUpdatePriorityRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobUpdatePriorityRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/queue": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Queue outcome", "schema": {"$ref": "#/definitions/BackgroundJobQueueResponse"}}}, "summary": "Queues a Background Job", "description": "Queue a Background Job", "operationId": "BackgroundJobQueue", "parameters": [{"name": "BackgroundJobQueueRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobQueueRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/stacktrace": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Unknown Background Job", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/BackgroundJobThread"}}}, "summary": "Returns the frames for the executing BackgroundJob", "description": "Get the stack trace for the executing Background Job passed in the request", "operationId": "BackgroundJobStackTrace", "parameters": [{"name": "RecordIdentity", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentity"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/stats": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/BackgroundJobStatisticsResponse"}}}, "summary": "Returns statistics about the selected executors", "description": "Get statistics from all Background Jobs workers.", "operationId": "BackgroundJobStats", "parameters": [{"name": "BackgroundJobStatisticsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobStatisticsRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/background_job/threads": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"type": "array", "items": {"$ref": "#/definitions/BackgroundJobThread"}}}}, "summary": "Returns a list of BackgroundJobs threads", "description": "Get threads from all Background Jobs workers.", "operationId": "BackgroundJobThreads", "parameters": [{"name": "BackgroundJobThreadRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobThreadRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/admin/request_audit/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/RequestAuditBatchResponse"}}}, "summary": "Returns a batch of RequestAuditEntries", "description": "Get details for the request audit ids passed in the request", "operationId": "RequestAuditBatch", "parameters": [{"name": "RequestAuditBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RequestAuditBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Request Audit"]}}, "/v1/admin/request_audit/cache/flush": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Clears the caching layer", "description": "Clears caching layer", "operationId": "RequestAuditFlushCache", "parameters": [{"name": "RequestAuditCacheFlushRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RequestAuditCacheFlushRequest"}}], "security": [{"auth_token": []}], "tags": ["Request Audit"]}}, "/v1/admin/request_audit/describe": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Described", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "Returns a list of endpoints active in the target executor", "description": "Describe active endpoints", "operationId": "RequestAuditDescribe", "parameters": [{"name": "RequestAuditDescribeRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RequestAuditDescribeRequest"}}], "security": [{"auth_token": []}], "tags": ["Request Audit"]}}, "/v1/admin/request_audit/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed", "schema": {"$ref": "#/definitions/RequestAuditListResponse"}}}, "summary": "Returns a list of BackgroundJobs ids", "description": "Filter request audits", "operationId": "RequestAuditList", "parameters": [{"name": "RequestAuditListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RequestAuditListRequest"}}], "security": [{"auth_token": []}], "tags": ["Request Audit"]}}, "/v1/admin/request_audit/profile/{request_audit_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Found", "schema": {"$ref": "#/definitions/InputStream"}}}, "summary": "Streams the profiler's result for a request audit", "description": "Download a profile results", "operationId": "RequestAuditProfileDownload", "produces": ["application/octet-stream"], "tags": ["Request Audit"]}, "parameters": [{"name": "request_audit_id", "in": "path", "required": true, "type": "string"}]}, "/v1/admin/request_audit/profiler/auto_trigger": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Queued", "schema": {"$ref": "#/definitions/RequestAuditProfileAutoTrigger"}}}, "summary": "Configures the parameters for auto triggering the collection of profiling data", "description": "Configure profiling auto trigger", "operationId": "RequestAuditProfileAutoTrigger", "parameters": [{"name": "RequestAuditProfileAutoTrigger", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RequestAuditProfileAutoTrigger"}}], "security": [{"auth_token": []}], "tags": ["Request Audit"]}}, "/v1/admin/request_audit/profiler/config": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Queued", "schema": {"$ref": "#/definitions/RequestAuditProfileStatus"}}}, "summary": "Requests to profile a endpoint or resource path", "description": "Requests to profile endpoints", "operationId": "RequestAuditProfile", "parameters": [{"name": "RequestAuditProfileRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RequestAuditProfileRequest"}}], "security": [{"auth_token": []}], "tags": ["Request Audit"]}}, "/v1/admin/request_audit/profiler/status": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Queued", "schema": {"type": "array", "items": {"$ref": "#/definitions/RequestAuditProfileStatus"}}}}, "summary": "Get the list of endpoints currently profiled", "description": "Lists currently profiled endpoints", "operationId": "RequestAuditProfileDescribe", "parameters": [{"name": "RequestAuditProfileDescribeRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RequestAuditProfileDescribeRequest"}}], "security": [{"auth_token": []}], "tags": ["Request Audit"]}}, "/v1/admin/request_audit/statistics": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Collected", "schema": {"$ref": "#/definitions/RequestAuditEndpointStatisticsResponse"}}}, "summary": "Returns hit counts for an endpoint or path in the target executor", "description": "Reports usage statistics for an endpoint or path", "operationId": "RequestAuditEndpointStatistics", "parameters": [{"name": "RequestAuditEndpointStatisticsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RequestAuditEndpointStatisticsRequest"}}], "security": [{"auth_token": []}], "tags": ["Request Audit"]}}, "/v1/agent/action/confirm": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "string"}}}, "summary": "Confirm or deny a pending agent action", "description": "Confirm or deny a pending agent action. On confirm, the agent executes the action (workload creation, policy execution, etc.). On deny, the action is cancelled with no execution.", "operationId": "ConfirmAgentAction", "parameters": [{"name": "AgentActionConfirmRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AgentActionConfirmRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/chat/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/AgentChatBatchResponse"}}}, "summary": "Batch Chat Details", "description": "Retrieve the chat details for the specified ids", "operationId": "BatchChats", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/chat/conversations/item/{conversation_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Update the conversation of the chat", "description": "Update the conversation of the chat.", "operationId": "ConversationUpdate", "parameters": [{"name": "conversation_id", "in": "path", "required": true, "type": "string", "description": "Specify the conversation ID to read, ID which can be obtained from the conversations API."}, {"name": "ConversationFeedbackRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ConversationFeedbackRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/chat/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Create a new chat", "description": "Create a new Chat", "operationId": "CreateChat", "parameters": [{"name": "AgentCreateChatRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AgentCreateChatRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/chat/delete": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"$ref": "#/definitions/AgentChatDeleteResponse"}}}, "summary": "Delete the Chat and the conversations associated with it", "description": "Delete the chat for the specified ids", "operationId": "DeleteChats", "parameters": [{"name": "AgentChatDeleteRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AgentChatDeleteRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/chat/item/{chat_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/AgentChat"}}}, "summary": "Get chat details", "description": "Retrieve the current details of the chat.", "operationId": "GetChat", "security": [{"auth_token": []}], "tags": ["AI Agent"]}, "parameters": [{"description": "Specify the chat ID to read, ID which can be obtained from the list chats API.", "name": "chat_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "412": {"description": "Validation Failed", "schema": {"$ref": "#/definitions/ValidationResults"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/AgentChat"}}}, "summary": "Update the details of the chat", "description": "Update the details of the chat.", "operationId": "UpdateChatName", "parameters": [{"name": "AgentChatUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AgentChatUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/chat/item/{chat_id}/suggestions": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AgentPromptSuggestionResponse"}}}, "description": "Get the chat suggestions", "operationId": "ListChatSuggestions", "security": [{"auth_token": []}], "tags": ["AI Agent"]}, "parameters": [{"name": "chat_id", "in": "path", "required": true, "type": "string"}]}, "/v1/agent/chat/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/AgentListChatResponse"}}}, "summary": "List chats", "description": "Retrieve the ids of chats matching the filtering criteria", "operationId": "ListChats", "parameters": [{"name": "AgentListChatRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AgentListChatRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/conversations/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ChatConversationBatchResponse"}}}, "summary": "Batch conversations Details", "description": "Retrieve the conversations details for the specified ids", "operationId": "BatchConversations", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/conversations/item/{conversation_id}/interrupt": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Interrupt the processing conversation of the chat", "description": "Interrupt the processing conversation of the chat.", "operationId": "InterruptConversation", "parameters": [{"name": "conversation_id", "in": "path", "required": true, "type": "string", "description": "Specify the conversation ID to read, ID which can be obtained from the conversations API."}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/conversations/item/{conversation_id}/stream": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success - Streaming data", "schema": {"$ref": "#/definitions/AgentStreamingResponse"}}}, "summary": "Stream the conversation response for the specified conversation ID", "description": "Stream the conversation response for the specified conversation ID using Server-Sent Events (SSE).\nReturns an SSE stream with real-time data chunks.", "operationId": "StreamQueryResponse", "parameters": [{"name": "conversation_id", "in": "path", "required": true, "type": "string", "description": "Specify the conversation ID to read, ID which can be obtained from the conversations API."}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/conversations/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ChatConversationListResponse"}}}, "summary": "Retrieves the conversations for the specified chat based on the given filter", "description": "Fetch the conversations for the specified chat based on the given filter.", "operationId": "ListConversations", "parameters": [{"name": "ChatConversationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ChatConversationRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/feed": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserQueryResponse"}}}, "summary": "Submit a new query for the specific agent and retrieve the agent's response for the given feed query", "description": "Submit a new query for the specific agent and retrieve the agent's response for the given feed query.", "operationId": "AgenticFeed", "parameters": [{"name": "UserQueryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserQueryRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/prompt/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/PromptBatchResponse"}}}, "summary": "Retrieve the saved prompt details for the specified ids", "description": "Retrieve the saved prompt details for the specified ids", "operationId": "BatchSavedPrompts", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/prompt/filters": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/PromptFiltersResponse"}}}, "summary": "List the filters for the specified agent id and prompt type", "description": "Retrieve the filters for the specified agent id and prompt type.", "operationId": "ListPromptFilters", "parameters": [{"name": "PromptFiltersRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PromptFiltersRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/prompt/item/{prompt_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete a particular custom prompt", "description": "Delete the custom prompt.", "operationId": "DeletePrompt", "security": [{"auth_token": []}], "tags": ["AI Agent"]}, "parameters": [{"description": "Specify the prompt ID to read, ID which can be obtained from the list prompts API.", "name": "prompt_id", "in": "path", "required": true, "type": "string"}]}, "/v1/agent/prompt/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/PromptListResponse"}}}, "summary": "List saved prompts", "description": "Retrieve the ids of saved prompts matching the filtering criteria", "operationId": "ListSavedPrompts", "parameters": [{"name": "PromptListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PromptListRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/prompt/save": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Saves the prompt", "description": "Saves the prompt.", "operationId": "SavePrompt", "parameters": [{"name": "PromptSaveRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PromptSaveRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/query": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Submit a new query for the specified chat and retrieve the agent's response", "description": "Submit a new query for the specified chat and retrieve the agent's response.", "operationId": "SubmitNewQuery", "parameters": [{"name": "UserQueryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserQueryRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/report/generate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/RecordIdentity"}}}, "summary": "Schedule the generation of a report for Ai agent", "description": "Generate a report for an Ai agent", "operationId": "report-create", "parameters": [{"name": "AiAgentReportCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AiAgentReportCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/report/item/{report_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/AiAgentReport"}}}, "summary": "Fetch an Ai agent report by ID", "description": "Get a report for an agent.", "operationId": "report-get", "parameters": [{"name": "report_id", "in": "path", "required": true, "type": "string", "description": "ID of the report to fetch. This can be retrieved using Report Generation API."}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/agent/types": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AgentTypeResponse"}}}, "summary": "List the available agents types", "description": "List of Agent types.", "operationId": "AgentTypes", "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/ai_governance/metrics/aggregate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Metrics retrieved successfully", "schema": {"$ref": "#/definitions/ResponseForAggregatedMetricsList"}}}, "summary": "Aggregate AI Metrics", "description": "Retrieve aggregated AI metrics for the specified filters and date range", "operationId": "AggregateAIMetrics", "parameters": [{"name": "MetricListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/MetricListRequest"}}], "security": [{"auth_token": []}], "tags": ["AIGovernance"]}}, "/v1/application_health/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/ApplicationHealthBatchResponse"}}}, "description": "Batch Application Health Details.", "operationId": "BatchApplicationHealthDetails", "parameters": [{"name": "ApplicationHealthBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ApplicationHealthBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Application Health"]}}, "/v1/application_health/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "description": "Retrieve the list of Application Health.", "operationId": "ListApplicationHealth", "parameters": [{"name": "ApplicationHealthListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ApplicationHealthListRequest"}}], "security": [{"auth_token": []}], "tags": ["Application Health"]}}, "/v1/appsecops/applications/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsApplicationBatchResponse"}}}, "summary": "List of application details", "description": "Details of the given batch of application IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchApplication", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/applications/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsApplicationResponse"}}}, "summary": "Creates an application", "description": "Creates an application", "operationId": "CreateApplication", "parameters": [{"name": "AppSecopsApplicationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsApplicationRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/applications/item/{application_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsApplicationResponse"}}}, "summary": "Get the application details", "description": "Get details of a given application.", "operationId": "GetApplication", "parameters": [{"name": "application_id", "in": "path", "required": true, "type": "string", "description": "Specify the application ID to get the application data"}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsApplicationResponse"}}}, "summary": "Update an application", "description": "Update details of the given application.", "operationId": "UpdateApplication", "parameters": [{"name": "application_id", "in": "path", "required": true, "type": "string", "description": "Specify the application ID to update the application data"}, {"name": "AppSecopsApplicationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsApplicationRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/applications/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of Applications", "description": "List of applications", "operationId": "ListApplication", "parameters": [{"name": "AppSecopsApplicationListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsApplicationListRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/bcs_questions/answers_version/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsBCSQuestionsAnswers"}}}, "summary": "Create a new BCS answer version", "description": "Create a new BCS answer version", "operationId": "BCSAnswerVersionCreate", "parameters": [{"name": "AppSecopsBCSQuestionsAnswersVersionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsBCSQuestionsAnswersVersionRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/bcs_questions/answers_version/history": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsBCSQuestionsAnswersHistoryResponse"}}}, "summary": "Paginated history of BCS answer versions", "description": "Paginated history of BCS answer versions", "operationId": "BCSAnswerVersionHistory", "parameters": [{"name": "AppSecopsBCSQuestionsAnswersHistoryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsBCSQuestionsAnswersHistoryRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/bcs_questions/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsBCSQuestion"}}}}, "summary": "List of BCS questions", "description": "List of BCS questions", "operationId": "ListBCSQuestions", "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/container/findings/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ContainerFindingsResponse"}}}}, "summary": "List of container finding details", "description": "Details of the given batch of container finding IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchContainerFindings", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/container/findings/ingest": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ContainerFindings"}}}}, "summary": "Ingest container security findings from external tools", "description": "Ingest container security findings from tools like Dockle and Hadolint", "operationId": "IngestContainerFindings", "parameters": [{"name": "AppSecopsIngestContainerFindingsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsIngestContainerFindingsRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/container/findings/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of container security findings with filtering and pagination support", "description": "List of container security findings with filtering and pagination support", "operationId": "ListContainerFindings", "parameters": [{"name": "ContainerFindingsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ContainerFindingsRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/dashboard/summary/portfolio_hierarchy": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsPortfolioHierarchyResponse"}}}}, "summary": "List all Portfolios along with its associated applications and projects", "description": "List of portfolio details and associated applications and projects", "operationId": "PortfolioHierarchy", "parameters": [{"name": "AppSecopsPortfolioHierarchyRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsPortfolioHierarchyRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/dashboard/summary/sbom_components": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomComponentsResponse"}}}, "summary": "List of all SBOMs along with its associated components", "description": "List of SBOM details along with associated components", "operationId": "SummarySbomComponents", "parameters": [{"name": "AppSecopsSbomComponentRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomComponentRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/dashboard/summary/sbom_vulnerabilities": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomVulnerabilityResponse"}}}, "summary": "List of all SBOM vulnerabilities", "description": "List of SBOM vulnerabilities", "operationId": "SummarySbomVulnerabilities", "parameters": [{"name": "AppSecopsSbomVulnerabilityRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomVulnerabilityRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/dashboard/summary/version_diff": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomBuildDifferenceResponse"}}}}, "summary": "Summary of differences in vulnerability and component counts compared to the previous SBOM build", "description": "Retrieve the difference in vulnerability and component counts compared to the previous SBOM build.", "operationId": "SbomBuildDifferenceTrend", "parameters": [{"name": "AppSecopsSbomBuildDifferenceTrendRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomBuildDifferenceTrendRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/dashboard/top_actionable_issues": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsTopActionableIssuesResponse"}}}, "summary": "List top (x) actionable issues including vulnerabilities, threats and config violations", "description": "List Top actionable issues including vulnerabilities, threats and config violations", "operationId": "TopActionableIssues", "parameters": [{"name": "AppSecopsTopActionableIssuesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsTopActionableIssuesRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/dashboard/vulnerabilities/aggregation_by_component": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsVulnerabilityByComponent"}}}}, "summary": "List of aggregated vulnerability count by component properties", "description": "Aggregated vulnerability count by component properties", "operationId": "VulnerabilityByComponent", "parameters": [{"name": "AppSecopsVulnerabilityByComponentRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsVulnerabilityByComponentRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/dashboard/vulnerabilities/trend_by_severity": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsVulnerabilityTrendBySeverity"}}}}, "summary": "List of vulnerabilities count by severity", "description": "List of vulnerabilities count by severity", "operationId": "VulnerabilityTrendBySeverity", "parameters": [{"name": "AppSecopsVulnerabilityTrendBySeverityRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsVulnerabilityTrendBySeverityRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/portfolios/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsPortfolioBatchResponse"}}}, "summary": "List of portfolio details", "description": "Details of the given batch of portfolio IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchPortfolio", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/portfolios/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsPortfolioResponse"}}}, "summary": "Creates a portfolio", "description": "Creates a portfolio", "operationId": "CreatePortfolio", "parameters": [{"name": "AppSecopsPortfolioRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsPortfolioRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/portfolios/item/{portfolio_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsPortfolioResponse"}}}, "summary": "Get the portfolio details", "description": "Get details of a given portfolio.", "operationId": "GetPortfolio", "parameters": [{"name": "portfolio_id", "in": "path", "required": true, "type": "string", "description": "Specify the portfolio ID to get the portfolio data"}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsPortfolioResponse"}}}, "summary": "Update the portfolio details", "description": "Updates the given portfolio details.", "operationId": "UpdatePortfolio", "parameters": [{"name": "portfolio_id", "in": "path", "required": true, "type": "string", "description": "Specify the portfolio Id to update the portfolio data"}, {"name": "AppSecopsPortfolioRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsPortfolioRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/portfolios/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of portfolios", "description": "List of portfolios", "operationId": "ListPortfolio", "parameters": [{"name": "AppSecopsPortfolioListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsPortfolioListRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/projects/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsProjectBatchResponse"}}}, "summary": "List of project details", "description": "Details of the given batch of project IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchProject", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/projects/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsProjectResponse"}}}, "summary": "Creates a project", "description": "Creates a project", "operationId": "CreateProject", "parameters": [{"name": "AppSecopsProjectRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsProjectRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/projects/item/{project_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsProjectResponse"}}}, "summary": "Get the project details", "description": "Get details for given project ID", "operationId": "GetProject", "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string", "description": "Specify the project ID to get the project data"}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsProjectResponse"}}}, "summary": "Update the project details", "description": "Update the project details for given project ID", "operationId": "UpdateProject", "parameters": [{"name": "project_id", "in": "path", "required": true, "type": "string", "description": "Specify the project ID to update the project data"}, {"name": "AppSecopsProjectRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsProjectRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/projects/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of projects", "description": "List of projects", "operationId": "ListProject", "parameters": [{"name": "AppSecopsProjectListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsProjectListRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_components/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomComponent"}}}}, "summary": "List of sbom component details", "description": "Details of the given batch of SBOM component IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchSbomComponents", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_definition/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomDefinition"}}}}, "summary": "List of SBOM definition details", "description": "Details of the given batch of SBOM definition IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchSbomDefinitions", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_definition/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomDefinition"}}}, "summary": "Creates a SBOM definition", "description": "Create a SBOM definition", "operationId": "CreateSbomDefinition", "parameters": [{"name": "AppSecopsSbomDefinitionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomDefinitionRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_definition/item/{sbom_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomDefinition"}}}, "summary": "Get SBOM definition details", "description": "Get a particular SBOM definition details for given SBOM definition ID", "operationId": "GetSbomDefinition", "parameters": [{"name": "sbom_id", "in": "path", "required": true, "type": "string", "description": "Specify the SBOM definition ID to get the SBOM definition data"}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomDefinition"}}}, "summary": "Update SBOM definition details", "description": "Update the SBOM definition details for given SBOM definition ID", "operationId": "UpdateSbomDefinition", "parameters": [{"name": "sbom_id", "in": "path", "required": true, "type": "string", "description": "Specify the SBOM definition ID to update the SBOM definition data"}, {"name": "AppSecopsSbomDefinitionUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomDefinitionUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_definition/item/{sbom_id}/list_version": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"type": "string", "x-cs-type": "ObjectId"}}}}, "summary": "List of versions for a SBOM definition", "description": "List of SBOM versions for a given SBOM definition ID", "operationId": "ListSbomVersions", "security": [{"auth_token": []}], "tags": ["AppSecOps"]}, "parameters": [{"name": "sbom_id", "in": "path", "required": true, "type": "string"}]}, "/v1/appsecops/sbom_definition/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomDefinitionsListResponse"}}}, "summary": "List of SBOM definitions", "description": "List of SBOM definitions", "operationId": "ListSbomDefinitions", "parameters": [{"name": "AppSecopsSbomDefinitionsListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomDefinitionsListRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_version/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomVersionResponse"}}}}, "summary": "List of SBOM version details", "description": "Details of the given batch of SBOM version IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchSbomVersions", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_version/create": {"post": {"responses": {"409": {"description": "Resource Conflict", "schema": {"$ref": "#/definitions/ModelError"}}, "500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomVersionResponse"}}}, "summary": "Creates a SBOM Version", "description": "Create a SBOM Version", "operationId": "CreateSbomVersion", "parameters": [{"name": "AppSecopsSbomVersionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomVersionRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_version/diff/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomVersionDifference"}}}}, "summary": "List of SBOM version difference details between the given SBOM version IDs and its corresponding predecessor version IDs", "description": "List of SBOM version difference details for the given SBOM version IDs and predecessor version ID. Supports a maximum of 1000 IDs per request.", "operationId": "BatchSbomVersionDifference", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_version/item/{version_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete SBOM version", "description": "Deletes given SBOM version", "operationId": "DeleteSbomVersion", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "Specify the SBOM version ID to remove the SBOM version data"}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomVersionResponse"}}}, "summary": "Get SBOM version details", "description": "Get a particular SBOM version for given SBOM version ID", "operationId": "GetSbomVersion", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "Specify the SBOM version ID to get the SBOM version data"}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomVersionResponse"}}}, "summary": "Update SBOM version details", "description": "Update SBOM version details (Build ID) for given SBOM Version ID", "operationId": "UpdateSbomVersion", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "Specify the SBOM version ID to update the SBOM version data"}, {"name": "AppSecopsSbomVersionUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomVersionUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_version/item/{version_id}/diff": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomVersionDifference"}}}, "summary": "Fetch SBOM version component and vulnerability difference details", "description": "Retrieve the difference in vulnerability and component IDs compared from the given SBOM version to requested SBOM version. If compare version ID is not passed, fetch for previous SBOM version", "operationId": "SbomVersionDifference", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "Specify the SBOM version ID which is the base version to fetch the build difference"}, {"name": "AppSecopsSbomVersionDifferenceRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsSbomVersionDifferenceRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_version/item/{version_id}/make-release": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsSbomVersionResponse"}}}, "summary": "Make SBOM version as the Release version", "description": "Mark this version as the release version", "operationId": "MakeSbomReleaseVersion", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "Specify the SBOM version ID to mark this version as the release version"}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/sbom_version/vulnerabilities/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomVersionVulnerability"}}}}, "summary": "List of SBOM version vulnerabilities details", "description": "Vulnerabilities details of the given batch of SBOM version Vulnerability ID(s). SBOM version vulnerability IDs can be obtained from the List SBOM Vulnerabilities API. Supports a maximum of 1000 IDs per request.", "operationId": "SbomVersionVulnerabilityBatch", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/appsecops/vulnerabilities/prevalence/organization": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsVulnerabilityOrganizationPrevalence"}}}}, "summary": "List of organization(s) details where the vulnerabilities are prevalent", "description": "List of Organizational entities (portfolio, application and project) where the provided vulnerability is prevalent", "operationId": "OrganizationalVulnerabilityPrevalence", "parameters": [{"name": "AppSecopsVulnerabilityPrevalenceRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsVulnerabilityPrevalenceRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/attachment/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/Attachment"}}}}, "summary": "Get Attachments", "description": "Fetch a batch of Attachments", "operationId": "batch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Attachments"]}}, "/v1/attachment/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/Attachment"}}}, "summary": "Create new Attachment", "description": "Create a new Attachment", "operationId": "create", "parameters": [{"name": "Attachment", "required": true, "in": "body", "schema": {"$ref": "#/definitions/Attachment"}}], "security": [{"auth_token": []}], "tags": ["Attachments"]}}, "/v1/attachment/item/{attachment_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Found", "schema": {"$ref": "#/definitions/Attachment"}}}, "summary": "Get an Attachment", "description": "Get an Attachment", "operationId": "get", "security": [{"auth_token": []}], "tags": ["Attachments"]}, "parameters": [{"name": "attachment_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/Attachment"}}}, "summary": "Update an Attachment", "description": "Update an Attachment", "operationId": "update", "parameters": [{"name": "Attachment", "required": true, "in": "body", "schema": {"$ref": "#/definitions/Attachment"}}], "security": [{"auth_token": []}], "tags": ["Attachments"]}}, "/v1/attachment/item/{attachment_id}/stream": {"parameters": [{"name": "attachment_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/Attachment"}}}, "summary": "Upload an Attachment", "description": "Upload an Attachment", "operationId": "upload", "parameters": [{"name": "InputStream", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InputStream"}}], "security": [{"auth_token": []}], "consumes": ["application/octet-stream"], "tags": ["Attachments"]}}, "/v1/attachment/item/{attachment_id}/stream/{file_name}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Found", "schema": {"$ref": "#/definitions/InputStream"}}}, "summary": "Download an Attachment", "description": "Download an Attachment", "operationId": "download", "security": [{"auth_token": []}], "produces": ["application/octet-stream"], "tags": ["Attachments"]}, "parameters": [{"name": "attachment_id", "in": "path", "required": true, "type": "string"}, {"name": "file_name", "in": "path", "required": true, "type": "string"}]}, "/v1/auth/tokens": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/AuthResponse"}}}, "summary": "Get Access Token", "description": "CoreStack requires Auth token to be passed in all the API headers. Auth token has to be generated and it is valid only for an hour. New token can be generated using this API. Extract Auth-token, Tenant Id & Account Id from the response. This will be required in most of the API calls", "operationId": "authToken", "parameters": [{"name": "AuthRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AuthRequest"}}], "tags": ["Authorization"]}}, "/v1/auth/tokens/refresh": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RefreshTokenResponse"}}}, "summary": "Get Refresh Token", "description": "Token generated in authToken API will be valid for an hour. Post that access_token will automatically expire. When the access_token is expired, there are two options. 1) use the authToken API to generate a new token 2) use refreshToken API to extend the validity of the current token.The refreshed token will also expire after an hour, refer to expires_at in the response for the validity of the token. When the refreshed token also expires, call again the refreshToken API to extend it further. Like wise a token can extended 3 times, refer to refresh_count in the response. After 3 refresh attempts, token will expire and cannot be extended any further. Need to use authToken API to generate a new token.", "operationId": "RefreshToken", "parameters": [{"name": "RefreshTokenRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RefreshTokenRequest"}}], "tags": ["Authorization"]}}, "/v1/automation_workflows/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/WorkFlowBatchResponse"}}}, "summary": "Batch Workflows", "description": "Retrieve the WorkFlow details for the specified ids", "operationId": "BatchWorkFlows", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation WorkFlows"]}}, "/v1/automation_workflows/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Create a workflow", "description": "Create WorkFlow.", "operationId": "CreateWorkFlow", "parameters": [{"name": "WorkFlowDefinitionDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkFlowDefinitionDetails"}}], "security": [{"auth_token": []}], "tags": ["Automation WorkFlows"]}}, "/v1/automation_workflows/item/{definition_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "204": {"description": "Deleted successfully"}}, "summary": "Delete a Workflow", "description": "DeleteWorkFlow.", "operationId": "DeleteWorkFlow", "security": [{"auth_token": []}], "tags": ["Automation WorkFlows"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/WorkFlowDefinitionDetails"}}}, "summary": "Get a Workflow", "description": "Get WorkFlow.", "operationId": "GetWorkFlow", "security": [{"auth_token": []}], "tags": ["Automation WorkFlows"]}, "parameters": [{"name": "definition_id", "in": "path", "required": true, "type": "string"}], "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "update a workflow", "description": "Update WorkFlow.", "operationId": "UpdateWorkFlow", "parameters": [{"name": "WorkFlowDefinitionDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkFlowDefinitionDetails"}}], "security": [{"auth_token": []}], "tags": ["Automation WorkFlows"]}}, "/v1/automation_workflows/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List WorkFlows", "description": "Retrieve the ids of workflows matching the criteria", "operationId": "ListWorkFlows", "parameters": [{"name": "WorkFlowsListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkFlowsListRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation WorkFlows"]}}, "/v1/automation_workflows/list_master_rules": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/WorkFlowRuleList"}}}, "summary": "List the master rules for a workflow configuration", "description": "List the master rules for a WorkFlow configurations", "operationId": "ListWorkFlowMasterRules", "parameters": [{"name": "WorkFlowRuleListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkFlowRuleListRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation WorkFlows"]}}, "/v1/aws-security-hub/dashboard/findings/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingBatchResponse"}}}, "summary": "Returns a batch of Findings", "description": "Get AWS Security hub findings for all ids passed in the request.", "operationId": "getFindingsBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AWS Security Hub"]}}, "/v1/aws-security-hub/dashboard/findings/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a list AWS Security Hub Findings ids", "description": "List AWS Security Hub Finding Ids", "operationId": "listFindings", "parameters": [{"name": "AwsSecurityHubFindingListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingListRequest"}}], "security": [{"auth_token": []}], "tags": ["AWS Security Hub"]}}, "/v1/aws-security-hub/findings/filters/product_name": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Finding Product Names Filter", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingProductNameResponse"}}}, "summary": "Returns list of AWS securityhub finding product names with all possible filter values for the given tenant", "description": "Fetch all the product names filter values for the given tenant id", "operationId": "fetchFindingsFiltersProductName", "parameters": [{"name": "AwsSecurityHubFindingProductNameRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingProductNameRequest"}}], "security": [{"auth_token": []}], "tags": ["AWS Security Hub"]}}, "/v1/aws-security-hub/findings/filters/record_state": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Finding Resource Filter", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingRecordStatesResponse"}}}, "summary": "Returns list of AWS securityhub finding record state with all possible filter values for the given tenant", "description": "Fetch all the record state filter values for the given tenant id", "operationId": "fetchFindingFiltersRecordState", "parameters": [{"name": "AwsSecurityHubFindingRecordStatesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingRecordStatesRequest"}}], "security": [{"auth_token": []}], "tags": ["AWS Security Hub"]}}, "/v1/aws-security-hub/findings/filters/region": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Finding Region Filter", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingRegionResponse"}}}, "summary": "Returns list of AWS securityhub finding Region with all possible filter values for the given cloud accounts", "description": "Fetch all the region filter values for the given tenant id", "operationId": "fetchFindingsFiltersRegion", "parameters": [{"name": "AwsSecurityHubFindingRegionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingRegionRequest"}}], "security": [{"auth_token": []}], "tags": ["AWS Security Hub"]}}, "/v1/aws-security-hub/findings/filters/resource": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Finding Resource Filter", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingResourcesResponse"}}}, "summary": "Returns list of AWS securityhub finding resource with all possible filter values for the given tenant", "description": "Fetch all the region filter values for the given tenant id", "operationId": "fetchFindingsFiltersResource", "parameters": [{"name": "AwsSecurityHubFindingResourcesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingResourcesRequest"}}], "security": [{"auth_token": []}], "tags": ["AWS Security Hub"]}}, "/v1/aws-security-hub/findings/filters/severity": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Finding Severity Filter", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingSeverityResponse"}}}, "summary": "Returns list of AWS securityhub finding severity with all possible filter values for the given tenant", "description": "Fetch all the severity filter values for the given tenant id", "operationId": "fetchFindingsFiltersSeverity", "parameters": [{"name": "AwsSecurityHubFindingSeverityRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSecurityHubFindingSeverityRequest"}}], "security": [{"auth_token": []}], "tags": ["AWS Security Hub"]}}, "/v1/aws-security-hub/{cloud_account_id}/region_details": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AwsSecurityHubRegionDetail"}}}}, "summary": "Get AWS Security Hub Region Validation Results", "description": "Get AWS SecurityHub Region Results", "operationId": "getRegionResults", "security": [{"auth_token": []}], "tags": ["AWS Security Hub"]}, "parameters": [{"name": "cloud_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/azure-devops/dashboard/buildlogs/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AzureDevOpsListBuildLogsResponse"}}}, "summary": "List the available logs associated with build in AzureDevops", "description": "List the available logs associated with build in AzureDevops", "operationId": "ListBuildLogs", "parameters": [{"name": "AzureDevOpsListBuildLogsRequests", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AzureDevOpsListBuildLogsRequests"}}], "security": [{"auth_token": []}], "tags": ["Azure DevOps Pipeline DashBoard"]}}, "/v1/azure-devops/dashboard/builds/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AzureDevOpsListBuildResponse"}}}, "summary": "List the available builds under pipelines in AzureDevops", "description": "List the available builds under pipelines in AzureDevops", "operationId": "ListBuilds", "parameters": [{"name": "AzureDevOpsListBuildRequests", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AzureDevOpsListBuildRequests"}}], "security": [{"auth_token": []}], "tags": ["Azure DevOps Pipeline DashBoard"]}}, "/v1/azure-devops/dashboard/buildworkitems/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AzureDevOpsBuildWorkItemsResponse"}}}, "summary": "List the available workitems associated with build in AzureDevops", "description": "List the available workitems associated with build in AzureDevops", "operationId": "ListBuildWorkItems", "parameters": [{"name": "AzureDevOpsBuildWorkItemsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AzureDevOpsBuildWorkItemsRequest"}}], "security": [{"auth_token": []}], "tags": ["Azure DevOps Pipeline DashBoard"]}}, "/v1/azure-devops/dashboard/pipelines/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AzureDevOpsListPipelinesResponse"}}}, "summary": "List the available projects under account in AzureDevops", "description": "List the available projects under account in AzureDevops", "operationId": "ListPipelines", "parameters": [{"name": "AzureDevOpsListPipelinesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AzureDevOpsListPipelinesRequest"}}], "security": [{"auth_token": []}], "tags": ["Azure DevOps Pipeline DashBoard"]}}, "/v1/azure-devops/dashboard/projects/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AzureDevOpsPipelineListProjectsResponse"}}}, "summary": "List the available project under AzureDevops", "description": "List the available projects under account in AzureDevops", "operationId": "ListProjects", "parameters": [{"name": "AzureDevOpsPipelineListProjectsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AzureDevOpsPipelineListProjectsRequest"}}], "security": [{"auth_token": []}], "tags": ["Azure DevOps Pipeline DashBoard"]}}, "/v1/background_job_handler/configuration": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/BackgroundJobHandlerConfiguration"}}}, "summary": "Fetch the configuration of a Background Job Handler", "description": "Request the configuration for a Background Job Handler", "operationId": "GetBackgroundJobHandlerConfiguration", "parameters": [{"name": "BackgroundJobHandlerConfigurationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobHandlerConfigurationRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/BackgroundJobHandlerConfiguration"}}}, "summary": "Update the configuration of a Background Job Handler", "description": "Update the configuration for a Background Job Handler", "operationId": "UpdateBackgroundJobHandlerConfiguration", "parameters": [{"name": "BackgroundJobHandlerConfigurationUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobHandlerConfigurationUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/background_job_handler/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/BackgroundJobHandlerListResponse"}}}, "summary": "Lists the active Background Job Handlers", "description": "List the active Background Job Handlers", "operationId": "ListBackgroundJobHandlers", "parameters": [{"name": "BackgroundJobHandlerConfigurationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BackgroundJobHandlerConfigurationRequest"}}], "security": [{"auth_token": []}], "tags": ["Background Jobs"]}}, "/v1/billing/commitment": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/BillingCommitmentBatchResponse"}}}, "summary": "Get billing commitment details", "description": "Retrieve billing commitment details for Azure, supported only for EA account types.", "operationId": "GetBillingCommitment", "parameters": [{"name": "BillingCommitmentRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingCommitmentRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing Commitment"]}}, "/v1/billing/commitment/events": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingCommitmentEvent"}}}}, "summary": "List all billing commitment events", "description": "List all billing commitment events for the cloud account, supported only for Azure EA account types.", "operationId": "ListBillingCommitmentEvents", "parameters": [{"name": "BillingCommitmentEventsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingCommitmentEventsRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing Commitment"]}}, "/v1/billing/master_account/{master_account_id}/summary": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/MasterAccountBillingSummaryResponse"}}}, "summary": "Master Account Billing Summary", "description": "Billing summary of the master account", "operationId": "MasterAccountBillingSummary", "security": [{"auth_token": []}], "tags": ["MasterAccount Billing"]}, "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/billing/master_account/{master_account_id}/transaction": {"parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/MasterAccountBalanceUpdateResponse"}}}, "summary": "Record a transaction and Update the balance for the master account", "description": "Update the balance for the master account", "operationId": "MasterAccountBillingTransaction", "parameters": [{"name": "MasterAccountBalanceUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/MasterAccountBalanceUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["MasterAccount Billing"]}}, "/v1/billing/master_account/{master_account_id}/validate_balance": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Master Account Billing Balance Validate", "description": "Validate Billing Balance of the master account", "operationId": "MasterAccountBillingBalanceValidate", "security": [{"auth_token": []}], "tags": ["MasterAccount Billing"]}, "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/billing/transaction/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/MasterAccountBillingTransactionsBatchResponse"}}}, "summary": "Batch billing transactions", "description": "List all billing transactions batches", "operationId": "BillingTransactionsBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["MasterAccount Billing"]}}, "/v1/billing/transaction/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List billing transactions", "description": "List all Billing Transactions", "operationId": "BillingTransactionsList", "parameters": [{"name": "MasterAccountBillingListTransactionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/MasterAccountBillingListTransactionRequest"}}], "security": [{"auth_token": []}], "tags": ["MasterAccount Billing"]}}, "/v1/billing_plans/batch": {"post": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"type": "array", "description": "List of billing plan definitions", "items": {"$ref": "#/definitions/BillingPlanDefinition"}}}}, "summary": "Fetch all Billing Plan definitions", "description": "Fetch all Billing Plan definitions", "operationId": "batch@@@2", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitions"]}}, "/v1/billing_plans/create": {"post": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Successful operation", "schema": {"$ref": "#/definitions/BillingPlanDefinition"}}}, "summary": "Create a new Billing Plan definition", "description": "Create a new Billing Plan definition", "operationId": "create@@@2", "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitions"]}}, "/v1/billing_plans/list": {"post": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Fetch all Billing Plan definitions for the user", "description": "Fetch all Billing Plan definitions for the user", "operationId": "list", "parameters": [{"name": "BillingPlanDefinitionListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingPlanDefinitionListRequest"}}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitions"]}}, "/v1/billing_plans/version/batch": {"post": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Successful operation", "schema": {"type": "array", "description": "List of billing plan versions", "items": {"$ref": "#/definitions/BillingPlanDefinitionVersion"}}}}, "summary": "Fetch Billing Plan versions by ids", "description": "Fetch Billing Plan versions by ids", "operationId": "batch@@@3", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitionVersions"]}}, "/v1/billing_plans/version/create": {"post": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Successful operation", "schema": {"$ref": "#/definitions/BillingPlanDefinitionVersion"}}}, "summary": "Create a new version of a Billing Plan", "description": "Create a new version of a Billing Plan", "operationId": "create@@@3", "parameters": [{"name": "BillingPlanDefinitionVersion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingPlanDefinitionVersion"}}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitionVersions"]}}, "/v1/billing_plans/version/parse_import": {"post": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"$ref": "#/definitions/BillingPlanConfiguration"}}}, "summary": "Parse Billing Plan Version", "description": "Parse and validate a raw json string to be used for importing a Billing Plan version", "operationId": "parse-import", "parameters": [{"name": "RawImport", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RawImport"}}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitionVersions"]}}, "/v1/billing_plans/version/{version_id}": {"get": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Version not found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"$ref": "#/definitions/BillingPlanDefinitionVersion"}}}, "summary": "Get Billing Plan version details by version_id", "description": "Get Billing Plan version details by version_id", "operationId": "get@@@3", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "The Billing Plan version ID"}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitionVersions"]}}, "/v1/billing_plans/version/{version_id}/make_head": {"patch": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Version not found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"$ref": "#/definitions/BillingPlanDefinitionVersion"}}}, "summary": "Make a Billing Plan version the head version", "description": "Make a Billing Plan version the head version", "operationId": "make-head", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "The Billing Plan version ID"}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitionVersions"]}}, "/v1/billing_plans/version/{version_id}/make_release": {"patch": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Version not found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"$ref": "#/definitions/BillingPlanDefinitionVersion"}}}, "summary": "Make a Billing Plan version the release version", "description": "Make a Billing Plan version the release version", "operationId": "make-release", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "The Billing Plan version ID"}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitionVersions"]}}, "/v1/billing_plans/{plan_definition_id}": {"delete": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Plan definition not found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "204": {"description": "Successful operation"}}, "summary": "Delete Billing Plan by plan_id", "description": "Delete Billing Plan by plan_id", "operationId": "remove", "parameters": [{"name": "plan_definition_id", "in": "path", "required": true, "type": "string", "description": "The Billing Plan definition ID"}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitions"]}, "get": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Plan definition not found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"$ref": "#/definitions/BillingPlanDefinition"}}}, "summary": "Get Billing Plan definition by id", "description": "Get Billing Plan definition by id", "operationId": "get@@@2", "parameters": [{"name": "plan_definition_id", "in": "path", "required": true, "type": "string", "description": "The Billing Plan definition ID"}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitions"]}}, "/v1/billing_plans/{plan_definition_id}/history": {"get": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Plan definition not found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "Get Billing Plan definition history by definition id", "description": "Get Billing Plan definition history by definition id", "operationId": "get-history", "parameters": [{"name": "plan_definition_id", "in": "path", "required": true, "type": "string", "description": "The Billing Plan definition ID"}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitions"]}}, "/v1/billing_plans/{plan_definition_id}/set_state": {"post": {"responses": {"500": {"description": "Internal server error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Invalid input", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Plan definition not found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"$ref": "#/definitions/BillingPlanDefinition"}}}, "summary": "Set the state of a Billing Plan definition", "description": "Set the state of a Billing Plan definition", "operationId": "set-state", "parameters": [{"name": "plan_definition_id", "in": "path", "required": true, "type": "string", "description": "The Billing Plan definition ID"}, {"name": "BillingPlanDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingPlanDefinition"}}], "security": [{"auth_token": []}], "tags": ["BillingPlanDefinitions"]}}, "/v1/compliance/control_mapping/cleanup_policy_data": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CompliancePolicyDataCleanUpResponse"}}}, "summary": "Clean Up Unmapped Policy Data", "description": "Cleanup the data in compliance that was created by deprecated policy", "operationId": "CleanupCompliancePolicyData", "parameters": [{"name": "CompliancePolicyDataCleanUpRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CompliancePolicyDataCleanUpRequest"}}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/v1/copilot_stats/org_metrics": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/CopilotOrgMetricsResponse"}}}, "summary": "Get Copilot Organization Metrics", "description": "Retrieve Copilot organization-level metrics for a service account", "operationId": "GetCopilotOrgMetrics", "parameters": [{"name": "CopilotOrgMetricsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CopilotOrgMetricsRequest"}}], "security": [{"auth_token": []}], "tags": ["Copilot Governance"]}}, "/v1/copilot_stats/user_metrics": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/CopilotUserMetricsResponse"}}}, "summary": "Get Copilot User Metrics", "description": "Retrieve Copilot statistics at user level", "operationId": "GetCopilotUserMetrics", "parameters": [{"name": "CopilotUserMetricsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CopilotUserMetricsRequest"}}], "security": [{"auth_token": []}], "tags": ["Copilot Governance"]}}, "/v1/cost/costoptimizer/optimizerate/long_term_savings/recommended_reservations/savings_summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RecommendedReservationsSavingsSummaryResponse"}}}, "summary": "Saving Summary for Recommended Reservations", "description": "Recommended Reservations Savings Summary", "operationId": "RecommendedReservationsSavingsSummary", "parameters": [{"name": "RecommendedReservationsSavingsSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecommendedReservationsSavingsSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/v1/cost/finops_assessment_trigger/{tenant_id}/{cloud_account_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FinopsAssessmentTriggerResponse"}}}, "summary": "Finops Assessment Trigger", "description": "Trigger FinOps Assessment", "operationId": "FinopsAssessmentTrigger", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the cloud account ID. This is a unique ID and can be retrieved using the List cloud account API."}, {"name": "FinopsAssessmentTriggerRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/FinopsAssessmentTriggerRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/v1/cost/finops_assessment_trigger_history/{cloud_account_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/FinopsAssessmentHistory"}}}}, "summary": "Finops Assessment Trigger History", "description": "History of Triggered FinOps Assessment in Desc order", "operationId": "FinopsAssessmentTriggerHistory", "parameters": [{"name": "cloud_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the cloud account ID. This is a unique ID and can be retrieved using the List cloud account API."}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/v1/cost/finops_assessment_trigger_status/{assessment_run_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FinopsAssessmentTriggerStatusResponse"}}}, "summary": "Finops Assessment Trigger Status", "description": "Status of Triggered FinOps Assessment", "operationId": "FinopsAssessmentTriggerStatus", "parameters": [{"name": "assessment_run_id", "in": "path", "required": true, "type": "string", "description": "Specify the assessment run ID. This is a unique ID and can be retrieved using the Finops Assessment Trigger API."}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/v1/cost/tags/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/CostTagBatchResponse"}}}, "summary": "Returns a batch of CostTag", "description": "Batch Tags", "operationId": "CostTagBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/v1/cost/tags/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a list of CostTag ids", "description": "List Tags", "operationId": "CostTagList", "parameters": [{"name": "CostTagListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostTagListRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost"]}}, "/v1/currency_exchange_configuration/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/CurrencyExchangeConfigurationBatchResponse"}}}, "summary": "Batch Currency Exchange Configuration", "description": "Batch Currency Exchange Configuration.", "operationId": "BatchCurrencyExchangeConfiguration", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["CurrencyExchangeConfiguration"]}}, "/v1/currency_exchange_configuration/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created successfully", "schema": {"$ref": "#/definitions/CurrencyExchangeConfigurationDefinition"}}}, "summary": "Create Currency Exchange Configuration", "description": "Create Currency Exchange Configuration.", "operationId": "CreateCurrencyExchangeConfiguration", "parameters": [{"name": "CurrencyExchangeConfigurationDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CurrencyExchangeConfigurationDefinition"}}], "security": [{"auth_token": []}], "tags": ["CurrencyExchangeConfiguration"]}}, "/v1/currency_exchange_configuration/item/{item_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted successfully", "schema": {"type": "boolean"}}}, "summary": "Delete Currency Exchange Configuration", "description": "Delete Currency Exchange Configuration.", "operationId": "DeleteCurrencyExchangeConfiguration", "security": [{"auth_token": []}], "tags": ["CurrencyExchangeConfiguration"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/CurrencyExchangeConfigurationDefinition"}}}, "summary": "Get Currency Exchange Configuration", "description": "Get Currency Exchange Configuration.", "operationId": "GetCurrencyExchangeConfiguration", "security": [{"auth_token": []}], "tags": ["CurrencyExchangeConfiguration"]}, "parameters": [{"name": "item_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/CurrencyExchangeConfigurationDefinition"}}}, "summary": "Update Currency Exchange Configuration", "description": "Update Currency Exchange Configuration.", "operationId": "UpdateCurrencyExchangeConfiguration", "parameters": [{"name": "CurrencyExchangeConfigurationDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CurrencyExchangeConfigurationDefinition"}}], "security": [{"auth_token": []}], "tags": ["CurrencyExchangeConfiguration"]}}, "/v1/currency_exchange_configuration/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Currency Exchange Configuration", "description": "List Currency Exchange Configuration.", "operationId": "ListCurrencyExchangeConfiguration", "parameters": [{"name": "CurrencyExchangeConfigurationListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CurrencyExchangeConfigurationListRequest"}}], "security": [{"auth_token": []}], "tags": ["CurrencyExchangeConfiguration"]}}, "/v1/custom_tags/master_account/{master_account_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Delete CustomTags by Master Account", "description": "This delete method is used to delete the CustomTags for a specific MasterAccount", "operationId": "deleteMasterAccountCustomTags", "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "specify the master account id"}], "security": [{"auth_token": []}], "tags": ["Custom Tags"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}}, "summary": "List CustomTags by Master Account", "description": "This GET method is used to retrieve the list of CustomTags available for a specific MasterAccount.", "operationId": "getMasterAccountCustomTags", "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "specify the master account id"}], "security": [{"auth_token": []}], "tags": ["Custom Tags"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}}, "summary": "Set CustomTags by Master Account", "description": "This Post method is used to update the list of CustomTags for a specific MasterAccount.", "operationId": "setMasterAccountCustomTags", "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "specify the master account id"}, {"name": "payload", "required": true, "in": "body", "schema": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}], "security": [{"auth_token": []}], "tags": ["Custom Tags"]}}, "/v1/custom_tags/tenant/{tenant_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Delete CustomTags by Tenant", "description": "This Delete method is used to delete the CustomTags for a specific Tenant.", "operationId": "deleteTenantCustomTags", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Custom Tags"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}}, "summary": "List CustomTags by Tenant", "description": "This GET method is used to retrieve the list of CustomTags available for a specific Tenant.", "operationId": "getTenantCustomTags", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Custom Tags"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Set CustomTags by Tenant", "description": "This Post method is used to update the list of CustomTags for a specific Tenant.", "operationId": "setTenantCustomTags", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "payload", "required": true, "in": "body", "schema": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}], "security": [{"auth_token": []}], "tags": ["Custom Tags"]}}, "/v1/dimensions/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/DimensionDefinitionBatchResponse"}}}, "summary": "Batch Dimensions", "description": "Retrieve the Dimension details for the specified ids", "operationId": "BatchDimension", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Dimension"]}}, "/v1/dimensions/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created successfully", "schema": {"$ref": "#/definitions/DimensionDefinition"}}}, "summary": "Create a Dimension", "description": "Create Dimension.", "operationId": "CreateDimension", "parameters": [{"name": "DimensionDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DimensionDefinition"}}], "security": [{"auth_token": []}], "tags": ["Dimension"]}}, "/v1/dimensions/item/{dimension_definition_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "204": {"description": "Deleted successfully"}}, "summary": "Delete a Dimension", "description": "Delete Dimension.", "operationId": "DeleteDimension", "security": [{"auth_token": []}], "tags": ["Dimension"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/DimensionDefinition"}}}, "summary": "Get a Dimension", "description": "Get Dimension.", "operationId": "GetDimension", "security": [{"auth_token": []}], "tags": ["Dimension"]}, "parameters": [{"name": "dimension_definition_id", "in": "path", "required": true, "type": "string"}]}, "/v1/dimensions/item/{dimension_definition_id}/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"type": "array", "description": "List of dimension definition versions", "items": {"$ref": "#/definitions/DimensionDefinitionVersion"}}}}, "summary": "Get Dimension History", "description": "Get Dimension Definition History.", "operationId": "GetDimensionDefinitionHistory", "security": [{"auth_token": []}], "tags": ["Dimension"]}, "parameters": [{"name": "dimension_definition_id", "in": "path", "required": true, "type": "string"}]}, "/v1/dimensions/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Dimensions", "description": "Retrieve the ids of dimensions matching the filtering criteria", "operationId": "ListDimensions", "parameters": [{"name": "DimensionListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DimensionListRequest"}}], "security": [{"auth_token": []}], "tags": ["Dimension"]}}, "/v1/dimensions/versions/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/DimensionDefinitionVersionBatchResponse"}}}, "summary": "Batch Dimension Versions", "description": "Batch Dimension Definition Versions.", "operationId": "BatchDimensionBatchDefinitionVersion", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["DimensionVersion"]}}, "/v1/dimensions/versions/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/DimensionDefinitionVersion"}}}, "summary": "Create Dimension Version", "description": "Create a New Dimension Definition Version.", "operationId": "CreateDimensionDefinitionVersion", "parameters": [{"name": "DimensionDefinitionVersion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DimensionDefinitionVersion"}}], "security": [{"auth_token": []}], "tags": ["DimensionVersion"]}}, "/v1/dimensions/versions/item/{dimension_definition_version_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/DimensionDefinitionVersion"}}}, "summary": "Get Dimension Version", "description": "Get Dimension Definition Version.", "operationId": "GetDimensionDefinitionVersion", "parameters": [{"name": "dimension_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Dimension Definition Version."}], "security": [{"auth_token": []}], "tags": ["DimensionVersion"]}}, "/v1/dimensions/versions/item/{dimension_definition_version_id}/make-head": {"patch": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/DimensionDefinitionVersion"}}}, "summary": "Make Dimension Version Head", "description": "Make Dimensions Definition Version Head.", "operationId": "MakeDimensionDefinitionVersionHead", "parameters": [{"name": "dimension_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Dimension Definition Version."}], "security": [{"auth_token": []}], "tags": ["DimensionVersion"]}}, "/v1/dimensions/versions/item/{dimension_definition_version_id}/make-release": {"patch": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/DimensionDefinitionVersion"}}}, "summary": "Make Dimension Version Release", "description": "Make Dimension Definition Version Release.", "operationId": "MakeDimensionDefinitionVersionRelease", "parameters": [{"name": "dimension_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Dimension Definition Version."}], "security": [{"auth_token": []}], "tags": ["DimensionVersion"]}}, "/v1/dimensions/{dimension_definition_id}/set_state": {"parameters": [{"name": "dimension_definition_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Successful operation", "schema": {"$ref": "#/definitions/DimensionDefinition"}}}, "summary": "Set Dimension State", "description": "Set Dimension State.", "operationId": "SetDimensionState", "parameters": [{"name": "DimensionDefinitionSetStateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DimensionDefinitionSetStateRequest"}}], "security": [{"auth_token": []}], "tags": ["Dimension"]}}, "/v1/executive_dashboard/active": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Active Dashboard", "schema": {"type": "string"}}}, "summary": "Get Active Dashboard Definition", "description": "Get active Executive Dashboard", "operationId": "get-active", "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Active Description Set", "schema": {"type": "string"}}}, "summary": "Set Active Dashboard Definition", "operationId": "set-active", "parameters": [{"description": "ID of Dashboard Definition.", "name": "id", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/all": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Get all Dashboard Definitions", "operationId": "get-all", "parameters": [{"description": "Filter to shared dashboards.", "in": "query", "type": "boolean", "name": "onlyShared"}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/DashboardDefinition"}}}}, "summary": "Get Dashboard Definitions", "description": "Batch Executive Dashboard definitions", "operationId": "batch@@@4", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/DashboardDefinition"}}}, "summary": "Create new Dashboard Definition", "description": "Create Executive Dashboard definition", "operationId": "create@@@4", "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/item/{dashboard_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Dashboard Definition", "operationId": "remove@@@2", "parameters": [{"name": "dashboard_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/DashboardDefinition"}}}, "summary": "Get Dashboard Definition", "operationId": "get@@@4", "parameters": [{"name": "dashboard_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/item/{dashboard_id}/acl": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Dashboard Definition", "operationId": "removeAcl", "parameters": [{"name": "dashboard_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/DashboardDefinitionAcl"}}}, "summary": "Get Dashboard Definition ACL", "operationId": "getAcl", "parameters": [{"name": "dashboard_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Update Dashboard Definition ACL", "operationId": "putAcl", "parameters": [{"name": "dashboard_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition."}, {"name": "DashboardDefinitionAcl", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DashboardDefinitionAcl"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/item/{dashboard_id}/acl_context": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Evaluated", "schema": {"$ref": "#/definitions/DashboardDefinitionAclContext"}}}, "summary": "Evaluate Dashboard Definition ACL context", "operationId": "contextAcl", "parameters": [{"name": "dashboard_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/item/{dashboard_id}/acl_eval": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Evaluated", "schema": {"$ref": "#/definitions/DashboardDefinitionAclEval"}}}, "summary": "Evaluate Dashboard Definition ACL", "operationId": "evalAcl", "parameters": [{"name": "dashboard_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/item/{dashboard_id}/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/DashboardDefinitionVersion"}}}}, "summary": "Get the history of a Dashboard Definition", "operationId": "get-history@@@2", "parameters": [{"name": "dashboard_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/portals/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Mapping", "schema": {"type": "array", "items": {"$ref": "#/definitions/DashboardDefinitionToPortal"}}}}, "summary": "List all accessible portals", "description": "List portals", "operationId": "list-portals", "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/portals/resolve": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Resolved", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Resolve a portal path to its Dashboard Definition version", "operationId": "resolve-portal", "parameters": [{"description": "Path of the Portal page.", "name": "path", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/report/generate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/RecordIdentity"}}}, "summary": "Schedule the generation of a report for a dashboard", "description": "Create a report for a dashboard", "operationId": "dashboard-report-create", "parameters": [{"name": "DashboardReportCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DashboardReportCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/report/item/{report_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/DashboardReport"}}}, "summary": "Fetch a report by ID", "description": "Get a report for a dashboard", "operationId": "dashboard-report-get", "parameters": [{"name": "report_id", "in": "path", "required": true, "type": "string", "description": "ID of the report to fetch. This can be retrieved using Report Generation API."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definitions"]}}, "/v1/executive_dashboard/saved_views": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/SavedViewDetail"}}}, "summary": "Create a saved view", "description": "Create a saved view (dashboard_id is optional and goes in the body)", "operationId": "create-saved-view", "parameters": [{"name": "SavedViewCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SavedViewCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Saved Views"]}}, "/v1/executive_dashboard/saved_views/item/{view_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete a saved view", "description": "Soft-delete a saved view", "operationId": "delete-saved-view", "parameters": [{"name": "view_id", "in": "path", "required": true, "type": "string", "description": "Unique identifier of the saved view."}], "security": [{"auth_token": []}], "tags": ["Dashboard Saved Views"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/SavedViewDetail"}}}, "summary": "Get a saved view by identifier", "description": "Resolve a saved view by its identifier", "operationId": "get-saved-view", "parameters": [{"name": "view_id", "in": "path", "required": true, "type": "string", "description": "Unique identifier of the saved view."}], "security": [{"auth_token": []}], "tags": ["Dashboard Saved Views"]}, "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/SavedViewDetail"}}}, "summary": "Update a saved view", "description": "Update an existing saved view", "operationId": "update-saved-view", "parameters": [{"name": "view_id", "in": "path", "required": true, "type": "string", "description": "Unique identifier of the saved view."}, {"name": "SavedViewUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SavedViewUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Saved Views"]}}, "/v1/executive_dashboard/saved_views/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/SavedViewListResponse"}}}, "summary": "List saved views", "description": "List saved views with optional filters (POST with body so dashboard_id is optional)", "operationId": "list-saved-views", "parameters": [{"name": "SavedViewListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SavedViewListRequest"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Saved Views"]}}, "/v1/executive_dashboard_version/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/DashboardDefinitionVersion"}}}}, "summary": "Get Dashboard Versions", "description": "Batch Executive Dashboard versions", "operationId": "batch@@@5", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Definition Versions"]}}, "/v1/executive_dashboard_version/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/DashboardDefinitionVersion"}}}, "summary": "Create new Dashboard Definition Version", "description": "Create Executive Dashboard version", "operationId": "create@@@5", "parameters": [{"name": "DashboardDefinitionVersion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/DashboardDefinitionVersion"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Definition Versions"]}}, "/v1/executive_dashboard_version/item/{version_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/DashboardDefinitionVersion"}}}, "summary": "Get Dashboard Definition Version", "operationId": "get@@@5", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition Version."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definition Versions"]}}, "/v1/executive_dashboard_version/item/{version_id}/make-head": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/DashboardDefinitionVersion"}}}, "summary": "Make Dashboard Definition Version the Head version", "operationId": "make-head@@@2", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition Version."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definition Versions"]}}, "/v1/executive_dashboard_version/item/{version_id}/make-release": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/DashboardDefinitionVersion"}}}, "summary": "Make Dashboard Definition Version the Release version", "operationId": "make-release@@@2", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Dashboard Definition Version."}], "security": [{"auth_token": []}], "tags": ["Dashboard Definition Versions"]}}, "/v1/executive_dashboard_version/parseImport": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Parsed", "schema": {"$ref": "#/definitions/DashboardConfiguration"}}}, "summary": "Parse Dashboard Definition Version", "description": "Validate Executive Dashboard version", "operationId": "parse-import@@@2", "parameters": [{"name": "RawImport", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RawImport"}}], "security": [{"auth_token": []}], "tags": ["Dashboard Definition Versions"]}}, "/v1/feature_requirements/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceAccountFeatureRequirement"}}}}, "summary": "List Feature requirements", "description": "List all Feature requirements within CoreStack product.", "operationId": "ListFeatureRequirements", "security": [{"auth_token": []}], "tags": ["Product"]}}, "/v1/forgot_password/{token}/token_validate": {"parameters": [{"name": "token", "in": "path", "required": true, "type": "string"}]}, "/v1/integrations/servicenow/cmdb_config/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigCreateResponse"}}}, "summary": "Create ServiceNow CMDB Configuration", "description": "Create ServiceNowCMDBConfiguration", "operationId": "create@@@6", "parameters": [{"name": "ServiceNowCmdbConfigCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_config/delete": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigDeleteResponse"}}}, "summary": "Delete ServiceNow CMDB Configuration", "description": "Delete ServiceNowCMDBConfiguration", "operationId": "remove@@@3", "parameters": [{"name": "ServiceNowCmdbConfigDeleteRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigDeleteRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_config/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowCmdbConfig"}}}}, "summary": "List ServiceNow CMDB Configurations", "description": "List ServiceNow CMDB Configuration", "operationId": "list@@@2", "parameters": [{"name": "ServiceNowCmdbConfigListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigListRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_config/list_cmdb_ci_class_attributes": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbListClassAttributesResponse"}}}, "summary": "List ServiceNow CMDB CI Class Attributes", "description": "View CMDB CI Class Attributes", "operationId": "viewCMDBCIClassAttributes", "parameters": [{"name": "ServiceNowCmdbListClassAttributesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbListClassAttributesRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_config/list_cmdb_ci_classes": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbListCmdbClassResponse"}}}, "summary": "List ServiceNow CMDB CI Classes", "description": "View CMDB CI Class List", "operationId": "viewCMDBCIClasses", "parameters": [{"name": "ServiceNowCmdbListCmdbClassRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbListCmdbClassRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_config/list_inventory_attributes": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowCmdbInventoryAttribute"}}}}, "summary": "List Inventory Attributes for Resource", "description": "View Resource Inventory Schema", "operationId": "viewInventorySchema", "parameters": [{"name": "ServiceNowCmdbViewInventorySchemaRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbViewInventorySchemaRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_config/update": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigUpdateResponse"}}}, "summary": "Update ServiceNow CMDB Configuration", "description": "Update ServiceNowCMDBConfiguration", "operationId": "update@@@2", "parameters": [{"name": "ServiceNowCmdbConfigUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_config/view": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigView"}}}, "summary": "View ServiceNow CMDB Configuration", "description": "View ServiceNowCMDBConfiguration", "operationId": "view", "parameters": [{"name": "ServiceNowCmdbConfigViewRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbConfigViewRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_config/view_hierarchy": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbCloudSchemaCategory"}}}, "summary": "View Cloud Schema Hierarchy", "description": "View Cloud Hierarchy", "operationId": "viewServiceHierarchy", "parameters": [{"name": "ServiceNowCmdbCloudSchemaRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbCloudSchemaRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_sync/logs/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ServiceNowCmdbSyncLogBatchResponse"}}}, "summary": "Returns a batch of CMDB Sync Logs", "description": "Get AWS Security hub findings for all ids passed in the request.", "operationId": "ServiceNowCMDBSyncLogsBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_sync/logs/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a list CMDB Sync Log Ids", "description": "List CMDB Sync Log Ids", "operationId": "ServiceNowCMDBSyncLogsList", "parameters": [{"name": "ServiceNowCmdbSyncLogListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbSyncLogListRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/cmdb_sync/progress/{cloud_account_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbSyncProgressResponse"}}}, "summary": "Cmdb Sync Progress", "description": "CMDB Sync Progress", "operationId": "progress", "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}, "parameters": [{"name": "cloud_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/integrations/servicenow/list_assignment_groups": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowCmdbListAssignmentGroupResponse"}}}, "summary": "List ServiceNow User Groups", "description": "List ServiceNow User Groups", "operationId": "ListServiceNowCmdbListAssignmentGroups", "parameters": [{"name": "ServiceNowCmdbListAssignmentGroupRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowCmdbListAssignmentGroupRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/{service_account_id}/incident/custom_reference_attributes": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowIncidentCustomAttributeField"}}}}, "summary": "List ServiceNow Incident Custom Attributes", "description": "List Custom reference attributes of ServiceNow Incident", "operationId": "ListServiceNowIncidentCustomReferenceAttributes", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account ID of ServiceNow."}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/servicenow/{service_account_id}/request/attributes": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "List ServiceNow Request Attributes", "description": "View Service Request Attributes", "operationId": "ViewServiceRequestAttributes", "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}, "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/integrations/servicenow/{service_account_id}/request/service_catalog_hierarchy": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowServiceCatalog"}}}}, "summary": "View ServiceNow Service Catalog Hierarchy", "description": "View Service Catalog Hierarchy", "operationId": "viewServiceCatalogHierarchy", "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}, "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/integrations/servicenow/{service_account_id}/table/{table_name}/rows": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceNowTableRowsListResponse"}}}, "summary": "List ServiceNow Table Rows", "description": "List ServiceNow Table Rows", "operationId": "ListServiceNowTableRows", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account ID of ServiceNow."}, {"name": "table_name", "in": "path", "required": true, "type": "string", "description": "Specify the table name in ServiceNow to fetch rows"}, {"name": "ServiceNowTableRowsListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceNowTableRowsListRequest"}}], "security": [{"auth_token": []}], "tags": ["ServiceNow Integrations"]}}, "/v1/integrations/zoho/{service_account_id}/incident/sites": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ZohoServiceDeskSite"}}}}, "summary": "List Zoho ServiceDesk Sites", "description": "List Zoho ServiceDesk Sites", "operationId": "ListZohoServiceDeskSites", "security": [{"auth_token": []}], "tags": ["Zoho Incident"]}, "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/integrations/zoho/{service_account_id}/incident/users": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ZohoServiceDeskUser"}}}}, "summary": "List Zoho ServiceDesk Users", "description": "List Zoho ServiceDesk Users", "operationId": "ListZohoServiceDeskUsers", "security": [{"auth_token": []}], "tags": ["Zoho Incident"]}, "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/jira_service_management/project_fields/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/JiraServiceManagementListProjectFieldsResponse"}}}, "summary": "List Jira Service Management Project Fields", "description": "Retrieve the list of Jira project fields for the service account", "operationId": "ListJiraFields", "parameters": [{"name": "JiraServiceManagementProjectFieldsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/JiraServiceManagementProjectFieldsRequest"}}], "security": [{"auth_token": []}], "tags": ["Jira Service Management"]}}, "/v1/master_accounts": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/CreateMasterAccountResponse"}}}, "description": "Creates a new master account under a CoreStack account. There can be multiple tenants within a CoreStack account.", "operationId": "createMasterAccount", "parameters": [{"name": "CreateMasterAccountRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CreateMasterAccountRequest"}}], "security": [{"auth_token": []}], "tags": ["MasterAccount"]}}, "/v1/master_accounts/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/MasterAccountBatchResponse"}}}, "description": "Master Account Batch", "operationId": "MasterAccountBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["MasterAccount"]}}, "/v1/master_accounts/item/{master_account_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Master Account Delete", "description": "Delete the master account", "operationId": "MasterAccountDelete", "security": [{"auth_token": []}], "tags": ["MasterAccount"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/MasterAccountDetails"}}}, "summary": "Master Account View", "description": "View the master account", "operationId": "MasterAccountView", "security": [{"auth_token": []}], "tags": ["MasterAccount"]}, "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}], "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/MasterAccountDetails"}}}, "summary": "Master Account Update", "description": "Update the master account", "operationId": "MasterAccountUpdate", "parameters": [{"name": "MasterAccountDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/MasterAccountDetails"}}], "security": [{"auth_token": []}], "tags": ["MasterAccount"]}}, "/v1/master_accounts/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "description": "List master account", "operationId": "ListMasterAccount", "parameters": [{"name": "MasterAccountListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/MasterAccountListRequest"}}], "security": [{"auth_token": []}], "tags": ["MasterAccount"]}}, "/v1/master_accounts/{master_account_id}/policy_configurations/{policy_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete Policy parameter configuration Master Account", "description": "Delete Policy configuration parameters for a master account level", "operationId": "deleteMasterAccountPolicyConfiguration", "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the master account id to delete the policy configuration."}, {"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to delete configuration, policy id can be obtained from the list policy api"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}}, "summary": "Get Policy parameter configuration Master Account", "description": "Fetch the Policy parameters configuration for a master account level", "operationId": "getMasterAccountPolicyConfiguration", "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the master account id to fetch the configuration for master account."}, {"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to configure, policy id can be obtained from the list policy api"}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}}, "summary": "Update Policy parameter configuration Master Account", "description": "Update Policy configuration parameters for a master account level", "operationId": "setMasterAccountPolicyConfiguration", "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the master account id to configure the policy parameters."}, {"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to configure, policy id can be obtained from the list policy api"}, {"name": "PolicyParameterConfiguration", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/v1/master_accounts/{master_account_id}/roles": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RoleListResponse"}}}, "summary": "List Roles by Master Account", "description": "Role List By Master Account", "operationId": "RoleListByMasterAccount", "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the master account ID"}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/master_accounts/{master_account_id}/tenants": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/MasterAccountTenantSummary"}}}}, "summary": "Tenant List by Master Account", "description": "Tenant List by Master Account", "operationId": "TenantListByMasterAccount", "security": [{"auth_token": []}], "tags": ["Identity"]}, "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/master_accounts/{master_account_id}/user_groups": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/MasterAccountUserGroupSummary"}}}}, "summary": "User Group List By Master Account", "description": "User Group List By Master Account", "operationId": "UserGroupListByMasterAccount", "security": [{"auth_token": []}], "tags": ["UserGroups"]}, "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/master_data/categories/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/MasterDataCategoryListResponse"}}}, "summary": "List Master data", "description": "List Master Data Categories", "operationId": "ListMasterDataCategories", "parameters": [{"name": "MasterDataCategoryListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/MasterDataCategoryListRequest"}}], "security": [{"auth_token": []}], "tags": ["Master Data"]}}, "/v1/mcp/server/item/{server_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted"}}, "summary": "Delete MCP server", "description": "Delete a registered MCP server.", "operationId": "DeleteMcpServer", "security": [{"auth_token": []}], "tags": ["AI Agent"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/McpServerItem"}}}, "summary": "Get MCP server details", "description": "Retrieve details of a specific MCP server.", "operationId": "GetMcpServer", "security": [{"auth_token": []}], "tags": ["AI Agent"]}, "parameters": [{"description": "MCP server ID returned from the register API.", "name": "server_id", "in": "path", "required": true, "type": "string"}], "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated"}}, "summary": "Update an MCP server's configuration", "description": "Update a registered MCP server.", "operationId": "UpdateMcpServer", "parameters": [{"name": "McpServerRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/McpServerRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/mcp/server/item/{server_id}/enabled": {"parameters": [{"description": "MCP server ID returned from the register API.", "name": "server_id", "in": "path", "required": true, "type": "string"}], "patch": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success"}}, "summary": "Enable or disable an MCP server post-registration", "description": "Enable or disable a registered MCP server without modifying its configuration.", "operationId": "SetMcpServerEnabled", "parameters": [{"name": "McpServerSetEnabledRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/McpServerSetEnabledRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/mcp/server/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/McpServerListResponse"}}}, "summary": "List MCP servers for the current tenant", "description": "List all MCP servers registered for the current tenant.", "operationId": "ListMcpServers", "parameters": [{"name": "McpServerListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/McpServerListRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/mcp/server/register": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/RecordIdentity"}}}, "summary": "Register a new MCP server for the current tenant", "description": "Register a new MCP server for the tenant.", "operationId": "RegisterMcpServer", "parameters": [{"name": "McpServerRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/McpServerRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/mcp/server/tools": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/McpToolsResponse"}}}, "summary": "Get MCP tools available for a tenant and business agent", "description": "Retrieve MCP tool metadata scoped by tenant and business agent.", "operationId": "GetMcpTools", "parameters": [{"name": "McpToolsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/McpToolsRequest"}}], "security": [{"auth_token": []}], "tags": ["AI Agent"]}}, "/v1/metric_configuration": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Create Custom Metric Configuration", "description": "Create Custom Metric configuration Request", "operationId": "CustomMetricConfigurationCreate", "parameters": [{"name": "CustomMetricConfigurationDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CustomMetricConfigurationDetails"}}], "security": [{"auth_token": []}], "tags": ["Custom Metric Configuration"]}}, "/v1/metric_configuration/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/CustomMetricConfigurationBatchResponse"}}}, "summary": "Batch of Custom Metric Configuration", "description": "List all custom metric configuration as batches", "operationId": "CustomMetricConfigurationBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Custom Metric Configuration"]}}, "/v1/metric_configuration/item/{metric_configuration_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "string"}}}, "summary": "Delete Custom Metric Configuration", "description": "Deletes a specific custom metric configuration for a cloud account.", "operationId": "CustomMetricConfigurationDelete", "parameters": [{"name": "metric_configuration_id", "in": "path", "required": true, "type": "string", "description": "Specify the Id of metric configuration to delete, metric configuration id is unique can be obtained from the list custom metrics."}], "security": [{"auth_token": []}], "tags": ["Custom Metric Configuration"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Update Custom Metric Configuration", "description": "Update Custom Metric Configuration is used to update the already created custom metrics for a cloud account.", "operationId": "CustomMetricConfigurationUpdate", "parameters": [{"name": "metric_configuration_id", "in": "path", "required": true, "type": "string", "description": "Specify the Id of metric configuration to update, metric configuration id is unique can be obtained from the list custom metrics."}, {"name": "CustomMetricConfigurationDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CustomMetricConfigurationDetails"}}], "security": [{"auth_token": []}], "tags": ["Custom Metric Configuration"]}}, "/v1/metric_configuration/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Custom Metric Configuration", "description": "List Custom Metric Configuration.", "operationId": "CustomMetricConfigurationList", "parameters": [{"name": "CustomMetricConfigurationListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CustomMetricConfigurationListRequest"}}], "security": [{"auth_token": []}], "tags": ["Custom Metric Configuration"]}}, "/v1/metric_configuration/sync": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Manual Sync Custom Metric Configuration", "description": "Sync custom metric Configuration for mentioned cloud accounts", "operationId": "CustomMetricConfigurationSync", "parameters": [{"name": "CustomMetricConfigurationSyncRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CustomMetricConfigurationSyncRequest"}}], "security": [{"auth_token": []}], "tags": ["Custom Metric Configuration"]}}, "/v1/monitoring/resource_utilization": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/UtilizationResourceAggregationResponse"}}}, "description": "Metric Resource Utilization Details.", "operationId": "MetricResourceUtilization", "parameters": [{"name": "UtilizationResourceAggregationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UtilizationResourceAggregationRequest"}}], "security": [{"auth_token": []}], "tags": ["Application Health"]}}, "/v1/on_premises/utilization/metric": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/UtilizationResourceAggregationResponse"}}}, "description": "Retrieve the Utilization metric Data for the given period of time in the granularity provided.", "operationId": "OnPremisesUtilizationMetricAggregateTrend", "parameters": [{"name": "OnPremisesMonitoringRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/OnPremisesMonitoringRequest"}}], "security": [{"auth_token": []}], "tags": ["On premises"]}}, "/v1/operations/utilization_data/aggregate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/UtilizationAggregateResponse"}}}, "summary": "Batch Utilization Data", "description": "Retrieve the Utilization Data for the specified Resource ids", "operationId": "UtilizationAggregateData", "parameters": [{"name": "UtilizationAggregationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UtilizationAggregationRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations Utilization"]}}, "/v1/operations/utilization_data/statistics": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/UtilizationStatisticsResponse"}}}, "summary": "List KPI statistics for Utilization Dashboard", "description": "Retrieve the Over all statistics for the vm utilization.", "operationId": "ListOverallStatisticsForUtilization", "parameters": [{"name": "UtilizationStatisticsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UtilizationStatisticsRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations Utilization"]}}, "/v1/policies/policy_jobs/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/JobExecutionDetailsResponse"}}}}, "summary": "List of policy job details", "description": "Returns a list of job execution details for given policy job ids", "operationId": "BatchPolicyJob", "parameters": [{"name": "PolicyJobBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyJobBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/v1/policy/configuration/policy/{policy_id}/tenant/{tenant_id}/service_account_list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyConfigurationAccountListRequest"}}}, "summary": "List accounts for policy configuration", "description": "Get list of cloud accounts that are configured for policy.", "operationId": "listServiceAccountPolicyConfiguration", "parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy_id to retrieve the configured service accounts. Policy id can be obtained from the list policy api"}, {"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/v1/policy/configuration/{policy_id}/service_account/{service_account_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Delete Policy parameter configuration Account", "description": "Delete Policy configuration parameters for a cloud account level", "operationId": "deleteServiceAccountPolicyConfiguration", "parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to delete configuration, policy id can be obtained from the list policy api"}, {"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account id to delete the policy configuration."}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}}, "summary": "Get Policy parameter configuration Account", "description": "Fetch the Policy parameters configuration for a cloud account level", "operationId": "getServiceAccountPolicyConfiguration", "parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to configure, policy id can be obtained from the list policy api"}, {"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account id to fetch the configuration for service account."}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}}, "summary": "Update Policy parameter configuration Account", "description": "Update Policy configuration parameters for a cloud account level", "operationId": "setServiceAccountPolicyConfiguration", "parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to configure, policy id can be obtained from the list policy api"}, {"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account id to configure the policy parameters."}, {"name": "PolicyParameterConfiguration", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/v1/policy/configuration/{policy_id}/service_account_batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AccountPolicyConfigurationBatchResponse"}}}, "summary": "Get account policy configuration batch", "description": "Get policy configurations for cloud accounts batch.", "operationId": "BatchAccountPolicyConfiguration", "parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy_id to retrieve the configured service accounts. Policy id can be obtained from the list policy api"}, {"name": "PolicyConfigurationAccountListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyConfigurationAccountListRequest"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/v1/policy/configuration/{policy_id}/tenant/{tenant_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Delete Policy parameter configuration Tenant", "description": "Delete the policy configuration parameters for a tenant level", "operationId": "deleteTenantPolicyConfiguration", "parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to delete policy configuration for the tanant. Policy id can be obtained from the list policy api"}, {"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}}, "summary": "Get Policy parameter configuration tenant", "description": "Fetch the configured Policy parameters configuration for a tenant", "operationId": "getTenantPolicyConfiguration", "parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to fetch the configuration for tenant. Policy id can be obtained from the list policy api"}, {"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}}, "summary": "Update Policy parameter configuration Tenant", "description": "Update Policy configuration parameters for a tenant", "operationId": "setTenantPolicyConfiguration", "parameters": [{"name": "policy_id", "in": "path", "required": true, "type": "string", "description": "Specify the policy id to configure for the tenant, policy id can be obtained from the list policy api"}, {"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "PolicyParameterConfiguration", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PolicyParameterConfiguration"}}], "security": [{"auth_token": []}], "tags": ["Guardrails"]}}, "/v1/product_bundles/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProductBundleDetails"}}}}, "summary": "List Product Bundles", "description": "List all product bundles within CoreStack.", "operationId": "ListProductBundles", "security": [{"auth_token": []}], "tags": ["Product"]}}, "/v1/products/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ProductDetails"}}}}, "summary": "List Products", "description": "List all product within CoreStack.", "operationId": "ListProducts", "security": [{"auth_token": []}], "tags": ["Product"]}}, "/v1/recommendations/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RecommendationDetailsBatchResponse"}}}, "summary": "Get the List of Recommendation Details", "description": "Fetch a List of Recommendation Details", "operationId": "BatchRecommendations", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/recommendations/exclusion_rule/apply": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Initiated", "schema": {"type": "boolean"}}}, "summary": "Apply all the Recommendation Exclusion Rules which are available/applicable/provided in the tenant", "description": "Apply all Recommendation Exclusion Rule", "operationId": "ApplyExclusionRule", "parameters": [{"name": "RecommendationExclusionRuleApplyRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecommendationExclusionRuleApplyRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/recommendations/exclusion_rule/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RecommendationExclusionRuleBatchResponse"}}}, "summary": "Fetch a Recommendation Exclusion Rule Details", "description": "Get Recommendation Exclusion rules", "operationId": "BatchExclusionRules", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/recommendations/exclusion_rule/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RecommendationExclusionRuleResponse"}}}, "summary": "Creates a Recommendation Exclusion Rule", "description": "Create a Recommendation Exclusion Rule", "operationId": "CreateExclusionRule", "parameters": [{"name": "RecommendationExclusionRuleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecommendationExclusionRuleRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/recommendations/exclusion_rule/item/{rule_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete Recommendation Exclusion Rule", "description": "Delete given rule ID", "operationId": "DeleteExclusionRule", "parameters": [{"name": "rule_id", "in": "path", "required": true, "type": "string", "description": "Specify the rule ID of the Recommendation Exclusion Rule to be removed."}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RecommendationExclusionRuleGetResponse"}}}, "summary": "Get Recommendation Exclusion Rule", "description": "Get a Particular Recommendation Exclusion Rule", "operationId": "GetExclusionRule", "parameters": [{"name": "rule_id", "in": "path", "required": true, "type": "string", "description": "Specify the rule Id to get the recommendation exclusion rule data"}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RecommendationExclusionRuleResponse"}}}, "summary": "Update Recommendation Exclusion Rule", "description": "Update Recommendation Exclusion Rule", "operationId": "UpdateExclusionRule", "parameters": [{"name": "RecommendationExclusionRuleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecommendationExclusionRuleRequest"}}, {"name": "rule_id", "in": "path", "required": true, "type": "string"}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/recommendations/exclusion_rule/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of Recommendation Exclusion Rules", "description": "List Recommendation Exclusion rules.", "operationId": "ListExclusionRules", "parameters": [{"name": "RecommendationExclusionRulesListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecommendationExclusionRulesListRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/recommendations/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of Recommendations", "description": "Fetch a List of Recommendation", "operationId": "ListRecommendations", "parameters": [{"name": "ListRecommendationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ListRecommendationRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/recommendations/resources/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourceRecommendationResponse"}}}, "summary": "List of Resource Recommendation Details", "description": "List of resource recommendations details", "operationId": "BatchResourceRecommendations", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/recommendations/resources/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Fetch a List of Resource Recommendation", "description": "List of resource recommendations", "operationId": "ListResourceRecommendations", "parameters": [{"name": "ListResourceRecommendationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ListResourceRecommendationRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation"]}}, "/v1/reset_password_by_token": {}, "/v1/resource/alert_actions/{service_account_id}/disable": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Alert Rule Disabled", "schema": {"type": "boolean"}}}, "summary": "Disable Alert Rule", "description": "Disable Alert Rule.", "operationId": "DisableAlerts", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the Service Account Id. This is a unique ID for each service account"}, {"name": "AlertActionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AlertActionRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/alert_actions/{service_account_id}/enable": {"post": {"responses": {"500": {"description": "lInternal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Alert Rule Enabled", "schema": {"type": "boolean"}}}, "summary": "Enable Alert Rule", "description": "Enable the Azure Alert Rule.", "operationId": "EnableAlerts", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the Service Account Id. This is a unique ID for each service account"}, {"name": "AlertActionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AlertActionRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/dashboard/detail": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/InfraResourceDetailResponse"}}}, "summary": "Retrieves resource detail view (overview and configuration)", "description": "Retrieves detail view of a single infrastructure resource including identity, lifecycle metadata, and canonical configuration.", "operationId": "InfraResourceDetail", "parameters": [{"name": "InfraResourceDetailRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraResourceDetailRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/dashboard/detail/activity": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/InfraResourceActivityResponse"}}}, "summary": "Retrieves resource activity timeline or event attribute details", "description": "Retrieves activity timeline or event details for a single infrastructure resource. Mode 1 (no event_ids): paginated timeline. Mode 2 (with event_ids): changed attribute details for diff.", "operationId": "InfraResourceActivity", "parameters": [{"name": "InfraResourceActivityRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraResourceActivityRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/dashboard/trend/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/InfraResourceTrendResourceResponse"}}}, "summary": "List of infra resource details captured for given summary filters", "description": "List of infra resource IDs captured for given trend summary.", "operationId": "ListInfraResourceTrendSummary", "parameters": [{"name": "InfraResourceTrendSummaryListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraResourceTrendSummaryListRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/dashboard/trend/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/InfraResourceTrendSummary"}}}}, "summary": "Retrieves trend summary of infrastructure resources", "description": "Retrieves trend summary of infrastructure resources", "operationId": "InfraResourceTrendSummary", "parameters": [{"name": "InfraResourceTrendSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraResourceTrendSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/gcp/sku_details_for_resource": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/GcpResourceSkuDetailsResponse"}}}, "summary": "Get GCP sku details for the given resource", "description": "Fetch sku details for the given GCP account", "operationId": "GcpSkuDetailsForResource", "parameters": [{"name": "GcpResourceSkuDetailsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/GcpResourceSkuDetailsRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/inventory/item/{corestack_resource_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ServiceResourceInventoryDetails"}}}, "summary": "Get ServiceResourceInventory Details", "description": "Get resource details from the ServiceResourceInventory", "operationId": "get_get_service_resource_inventory", "security": [{"auth_token": []}], "tags": ["Resource"]}, "parameters": [{"name": "corestack_resource_id", "in": "path", "required": true, "type": "string"}]}, "/v1/resource/inventory/lookup": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceResourceInventoryLookup"}}}}, "summary": "Lookup ServiceResourceInventory Service Accounts", "description": "List resource Service Account from ServiceResourceInventory", "operationId": "post_service_resource_inventory_lookup", "parameters": [{"name": "ServiceResourceInventoryLookupRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceResourceInventoryLookupRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/item/{service_account_id}/complete_upload": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Completed"}}, "summary": "Complete the Multiple Parts upload for the Kubernetes agent", "description": "Complete the Multiple Parts of a kubernetes agent upload to the bucket", "operationId": "CompletePartPreSignedUrlForForKubernetesAgent", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}, {"name": "KubernetesAgentCompletePartPreSignedUrlRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/KubernetesAgentCompletePartPreSignedUrlRequest"}}], "security": [{"auth_token": []}], "tags": ["Kubernetes Agent"]}}, "/v1/resource/item/{service_account_id}/generate_kubernetes_secrets_yaml": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/KubernetesManifestResponse"}}}, "summary": "Get the attachment ID for the Kubernetes secrets configuration based on the given service account id", "description": "Generate a Kubernetes secrets manifest for the provided Kubernetes cluster account.", "operationId": "GenerateKubernetesSecretsManifest", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Kubernetes Agent"]}}, "/v1/resource/item/{service_account_id}/generate_presigned_url": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/KubernetesAgentPreSignedUrlResponse"}}}, "summary": "Get the Presigned url and other details for the Kubernetes agent", "description": "Generate Presigned_Url for Kubernetes agent to access the bucket", "operationId": "GeneratePreSignedUrlForKubernetesAgent", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}, {"name": "KubernetesAgentPreSignedUrlRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/KubernetesAgentPreSignedUrlRequest"}}], "security": [{"auth_token": []}], "tags": ["Kubernetes Agent"]}}, "/v1/resource/item/{service_account_id}/kubernetes_manifest": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/KubernetesManifestResponse"}}}, "summary": "Get the attachment ID for the Kubernetes deployment configuration based on the given service account id", "description": "Generate a Kubernetes manifest for the provided Kubernetes cluster account.", "operationId": "GenerateKubernetesManifest", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Kubernetes Agent"]}}, "/v1/resource/item/{service_account_id}/sync": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/ProgressDetailsForKubernetesAgentSyncStatus"}}}, "summary": "Get the Job Sync Status of Kubernetes Cluster", "description": "Get the Job Sync Status of Kubernetes Cluster", "operationId": "GetJobSyncStatusForKubernetesAgent", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Kubernetes Agent"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "boolean"}}}, "summary": "Update the Sync Status of Kubernetes Cluster", "description": "Update the Sync Status of Kubernetes Cluster", "operationId": "UpdateSyncStatusForKubernetesAgent", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}, {"name": "KubernetesClusterSyncUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/KubernetesClusterSyncUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["Kubernetes Agent"]}}, "/v1/resource/kubernetes/item/{service_account_id}/configuration": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/GovernanceConfigurationForKubernetesCluster"}}}, "summary": "Get the current configuration of the Kubernetes Agent", "description": "Retrieve the current configuration of the Kubernetes Agent", "operationId": "GetConfigurationForKubernetesAgent", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account ID to read, ID which can be obtained from the list service account API."}], "security": [{"auth_token": []}], "tags": ["Kubernetes Agent"]}}, "/v1/resource/log_analytics/list_workspaces": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "list of log analytic workspaces at the tenant level", "items": {"$ref": "#/definitions/WorkspaceDataForServiceAccount"}}}}, "summary": "List of Log Analytics Workspaces at Tenant Level", "description": "List Log Analytics Workspaces", "operationId": "ListLogAnalyticsWorkspaces", "parameters": [{"name": "ListLogAnalyticsWorkspaceRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ListLogAnalyticsWorkspaceRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/smallest_sku_region": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourceUnitPriceCheapestSkuResponse"}}}, "summary": "Get unit price of smallest sku for a specific region", "description": "Fetch unit price of smallest sku for a specific region", "operationId": "SmallestSkuRegion", "parameters": [{"name": "ResourceUnitPriceCheapestSkuRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResourceUnitPriceCheapestSkuRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/tags/bulk_remediation": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/BulkTagRemediationResponse"}}}, "summary": "Create Bulk Resource Tag Remediation", "description": "Create Bulk Tag Remediation", "operationId": "CreateBulkTagRemediation", "parameters": [{"name": "BulkTagRemediationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BulkTagRemediationRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/tags/bulk_remediation_status": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/BulkTagRemediationStatusResponse"}}}, "summary": "Return bulk Resource Tag Remediation Status", "description": "Bulk Tag Remediation Status", "operationId": "CheckBulkTagRemediationStatus", "parameters": [{"name": "BulkTagRemediationStatusRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BulkTagRemediationStatusRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/tags/remediation/{tenant_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/CreateRemediationResponse"}}}, "summary": "Create Resource Tag Remediation", "description": "Create Tag Remediation", "operationId": "createRemediation", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "TagRemediationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagRemediationRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/unit_price": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ResourceUnitPriceResponse"}}}, "summary": "Get unit price for list of resources", "description": "Fetch unit price for list of resources", "operationId": "UnitPriceForResources", "parameters": [{"name": "ResourceUnitPriceRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ResourceUnitPriceRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/virtual_machine_agents/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/VirtualMachineAgentsBatchResponse"}}}, "summary": "Batch VM Agents Details", "description": "Batch VM Agents Details.", "operationId": "BatchVirtualMachineAgentsDetails", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/resource/virtual_machine_agents/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List VM Agents Details", "description": "List VM Agents Details.", "operationId": "ListVirtualMachineAgentsDetails", "parameters": [{"name": "VirtualMachineAgentsListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/VirtualMachineAgentsListRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v1/role_templates/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/RoleTemplatesDetails"}}}}, "summary": "List Role Templates", "description": "List all Role templates within CoreStack.", "operationId": "ListRoleTemplates", "security": [{"auth_token": []}], "tags": ["Product"]}}, "/v1/roles/summary/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/RoleSummaryBatchResponse"}}}, "summary": "Role Batch", "description": "Role Batch", "operationId": "RoleBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/runbook/{tenant_id}/AWS/automation/{document_id}": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "document_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/AwsSsmExecuteDocumentResponse"}}}, "summary": "Execute automation document", "description": "Execute a automation document with all required parameters", "operationId": "AutomationExecute", "parameters": [{"name": "AwsSsmExecuteAutomationDocumentRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSsmExecuteAutomationDocumentRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm Automation"]}}, "/v1/runbook/{tenant_id}/AWS/automation/{execution_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/AwsSsmExecuteDocumentResponse"}}}, "summary": "Cancel Automation Execution", "description": "Cancel a specific automation document execution", "operationId": "CancelAutomation", "security": [{"auth_token": []}], "tags": ["AwsSsm Automation"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "execution_id", "in": "path", "required": true, "type": "string"}]}, "/v1/runbook/{tenant_id}/AWS/command/{document_id}": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "document_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/AwsSsmExecuteDocumentResponse"}}}, "summary": "Execute command document", "description": "Execute a command document with all required parameters", "operationId": "CommandExecute", "parameters": [{"name": "AwsSsmExecuteCommandDocumentRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSsmExecuteCommandDocumentRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm Command"]}}, "/v1/runbook/{tenant_id}/AWS/command/{execution_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/AwsSsmExecuteDocumentResponse"}}}, "summary": "Cancel command execution", "description": "Cancel a specific command document execution", "operationId": "CancelCommand", "security": [{"auth_token": []}], "tags": ["AwsSsm Command"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "execution_id", "in": "path", "required": true, "type": "string"}]}, "/v1/runbook/{tenant_id}/AWS/document/{document_id}/versions/batch": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "document_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/AwsSsmDocumentVersionBatchResponse"}}}, "summary": "Batch Document versions", "description": "List document version batches", "operationId": "DocumentVersionsBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm"]}}, "/v1/runbook/{tenant_id}/AWS/document/{document_id}/versions/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/AwsSsmListDocumentVersion"}}}}, "summary": "List Document versions", "description": "List all document versions", "operationId": "DocumentVersionsList", "security": [{"auth_token": []}], "tags": ["AwsSsm"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "document_id", "in": "path", "required": true, "type": "string"}]}, "/v1/runbook/{tenant_id}/AWS/document/{document_type}/filters": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/AwsSsmDocumentFilter"}}}, "summary": "List document filters", "description": "List Document Filters", "operationId": "ListDocumentFilters", "security": [{"auth_token": []}], "tags": ["AwsSsm"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "document_type", "in": "path", "required": true, "type": "string"}]}, "/v1/runbook/{tenant_id}/AWS/documents/batch": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/AwsSsmDocumentsBatchResponse"}}}, "summary": "Batch SSM Documents", "description": "List all SSM document batches", "operationId": "DocumentBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm"]}}, "/v1/runbook/{tenant_id}/AWS/documents/execution/batch": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/AwsSsmDocumentExecutionBatchResponse"}}}, "summary": "Batch executions", "description": "List all document execution batches", "operationId": "ExecutionBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm"]}}, "/v1/runbook/{tenant_id}/AWS/documents/execution/list": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List executions", "description": "List all document executions", "operationId": "ExecutionList", "parameters": [{"name": "AwsSsmListDocumentExecutionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSsmListDocumentExecutionRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm"]}}, "/v1/runbook/{tenant_id}/AWS/documents/list": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Documents", "description": "List all SSM Documents", "operationId": "DocumentList", "parameters": [{"name": "AwsSsmListDocumentsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSsmListDocumentsRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm"]}}, "/v1/runbook/{tenant_id}/AWS/documents/sync": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/AwsSsmDocumentSyncResponse"}}}, "summary": "Manual document sync", "description": "Sync SSM Documents for mentioned cloud accounts", "operationId": "DocumentSync", "parameters": [{"name": "AwsSsmDocumentSyncRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSsmDocumentSyncRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm"]}}, "/v1/runbook/{tenant_id}/AWS/execution/filters/{document_type}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/AwsSsmExecutionFilter"}}}, "summary": "List execution filters", "description": "List Execution Filters", "operationId": "listExecutionFilters", "security": [{"auth_token": []}], "tags": ["AwsSsm"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "document_type", "in": "path", "required": true, "type": "string"}]}, "/v1/runbook/{tenant_id}/AWS/execution/group/batch": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/AwsSsmExecutionGroupBatchResponse"}}}, "summary": "Batch execution job groups", "description": "List all document execution group batches", "operationId": "ExecutionGroupsBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm"]}}, "/v1/runbook/{tenant_id}/AWS/execution/group/list": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List execution job groups", "description": "List all document execution groups", "operationId": "ExecutionGroupsList", "parameters": [{"name": "AwsSsmListExecutionGroupRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AwsSsmListExecutionGroupRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm"]}}, "/v1/runbook/{tenant_id}/AWS/execution/instance/batch": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/AwsSsmCommandInstanceExecutionBatchResponse"}}}, "summary": "Batch execution instances", "description": "List all document execution Instance batch", "operationId": "ExecutionInstanceBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm Command"]}}, "/v1/runbook/{tenant_id}/AWS/execution/instance/list/{execution_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List execution instances", "description": "List all document execution Instances", "operationId": "ExecutionInstanceList", "security": [{"auth_token": []}], "tags": ["AwsSsm Command"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "execution_id", "in": "path", "required": true, "type": "string"}]}, "/v1/runbook/{tenant_id}/AWS/execution/step/batch": {"parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/AwsSsmExecutionStepBatchResponse"}}}, "summary": "Batch execution steps", "description": "List all document execution steps batch", "operationId": "ExecutionStepBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AwsSsm Automation"]}}, "/v1/runbook/{tenant_id}/AWS/execution/step/list/{execution_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List execution steps", "description": "List all document execution Steps", "operationId": "ExecutionStepList", "security": [{"auth_token": []}], "tags": ["AwsSsm Automation"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "execution_id", "in": "path", "required": true, "type": "string"}]}, "/v1/schedules/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ScheduleDetails"}}}}, "summary": "Fetch a batch of schedules", "description": "Fetch a batch of schedules", "operationId": "SchedulesBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedules"]}}, "/v1/schedules/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScheduleDetails"}}}, "summary": "Creates a Schedule", "description": "Creates a Schedule", "operationId": "CreateSchedule", "parameters": [{"name": "ScheduleDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleDetails"}}], "security": [{"auth_token": []}], "tags": ["Schedules"]}}, "/v1/schedules/item/{schedule_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete Schedule", "description": "Delete given schedule", "operationId": "ScheduleDelete", "parameters": [{"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to remove the schedule data"}], "security": [{"auth_token": []}], "tags": ["Schedules"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ScheduleDetails"}}}, "summary": "Retrieve Schedule", "description": "Retrieve details of given schedule", "operationId": "ScheduleGet", "parameters": [{"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to retrieve the schedule data"}], "security": [{"auth_token": []}], "tags": ["Schedules"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScheduleDetails"}}}, "summary": "Updates a Schedule", "description": "Update schedule", "operationId": "ScheduleUpdate", "parameters": [{"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to update the schedule data"}, {"name": "ScheduleDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleDetails"}}], "security": [{"auth_token": []}], "tags": ["Schedules"]}}, "/v1/schedules/item/{schedule_id}/set_next_execution": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Set Next Execution of a Schedule", "description": "Set Next Execution of a Schedule", "operationId": "SetNextExecutionSchedule", "parameters": [{"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to remove the schedule data"}, {"name": "ScheduleSetNextExecutionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleSetNextExecutionRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedules"]}}, "/v1/schedules/item/{schedule_id}/skip_next_execution": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Skipped", "schema": {"type": "boolean"}}}, "summary": "Skip next execution of a Schedule", "description": "Skip next execution of a Schedule", "operationId": "SkipNextExecutionSchedule", "parameters": [{"name": "schedule_id", "in": "path", "required": true, "type": "string", "description": "Specify the schedule Id to remove the schedule data"}], "security": [{"auth_token": []}], "tags": ["Schedules"]}}, "/v1/schedules/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScheduleListResponse"}}}, "summary": "List Schedules of given category", "description": "List schedules of given Category", "operationId": "ScheduleList", "parameters": [{"name": "ScheduleListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleListRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedules"]}}, "/v1/secops/dashboard/infra_misconfig/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityInfraDashboardSummaryDetails"}}}}, "summary": "Get summary of infra mis-configurations aggregated by region, resource category, or account for a given tenant", "description": "Get summary of infra mis-configurations aggregated by region, resource category, or account for a given tenant.", "operationId": "InfraMisConfigSummary", "parameters": [{"name": "SecurityInfraDashboardSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityInfraDashboardSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_misconfig/summary_by_resource": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityInfraDashboardSummaryDetails"}}}}, "summary": "Get summary of infra mis-configurations aggregated by resource(s) for a given tenant", "description": "Get summary of infra mis-configurations aggregated by region, resource category, or account for a given tenant.", "operationId": "InfraMisConfigSummaryByResource", "parameters": [{"name": "SecurityInfraDashboardSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityInfraDashboardSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_misconfig/trend/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/InfraMisconfigurationTrendResponse"}}}, "summary": "List of infra misconfigurations IDs captured for given summary filters", "description": "List of infra misconfigurations IDs captured for given trend summary.", "operationId": "ListInfraMisConfigurationsTrendSummary", "parameters": [{"name": "InfraMisConfigurationsTrendListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraMisConfigurationsTrendListRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_misconfig/trend/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of infrastructure misconfigurations trends", "items": {"$ref": "#/definitions/InfraMisConfigurationsTrendSummary"}}}}, "summary": "Retrieves trend summary of infrastructure misconfigurations", "description": "Retrieves trend summary of infrastructure misconfigurations", "operationId": "InfraMisConfigurationsTrendSummary", "parameters": [{"name": "InfraMisConfigurationsTrendSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraMisConfigurationsTrendSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_threats/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityInfraDashboardSummaryDetails"}}}}, "summary": "Get summary of infra threats aggregated by region, resource category, or account for a given tenant", "description": "Get summary of infra threats aggregated by region, resource category, or account for a given tenant.", "operationId": "InfraThreatSummary", "parameters": [{"name": "SecurityInfraDashboardSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityInfraDashboardSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_threats/summary_by_resource": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityInfraDashboardSummaryDetails"}}}}, "summary": "Get summary of infra threats aggregated by resource(s) for a given tenant", "description": "Get summary of infra threats aggregated by resource(s) for a given tenant", "operationId": "InfraThreatSummaryByResource", "parameters": [{"name": "SecurityInfraDashboardSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityInfraDashboardSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_threats/trend/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of infra threat IDs captured for given summary filters", "description": "List of infra threat IDs captured for given trend summary.", "operationId": "ListInfraThreatsTrendSummary", "parameters": [{"name": "InfraThreatsTrendListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraThreatsTrendListRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_threats/trend/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of infrastructure threats trends", "items": {"$ref": "#/definitions/InfraThreatsTrendSummary"}}}}, "summary": "Retrieves trend summary of infrastructure threats", "description": "Retrieves trend summary of infrastructure threats", "operationId": "InfraThreatsTrendSummary", "parameters": [{"name": "InfraThreatsTrendSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraThreatsTrendSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_vulnerabilities/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityInfraDashboardSummaryDetails"}}}}, "summary": "Get summary of infra vulnerabilities aggregated by region, resource category, or account for a given tenant", "description": "Get summary of infra vulnerabilities aggregated by region/account/resource category for a given tenant.", "operationId": "InfraVulnerabilitySummary", "parameters": [{"name": "SecurityInfraDashboardSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityInfraDashboardSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_vulnerabilities/summary_by_resource": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityInfraDashboardSummaryDetails"}}}}, "summary": "Get summary of infra vulnerabilities aggregated by resource(s) for a given tenant", "description": "Get summary of infra vulnerabilities aggregated by aggregated by resource(s) for a given tenant", "operationId": "InfraVulnerabilitySummaryByResource", "parameters": [{"name": "SecurityInfraDashboardSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityInfraDashboardSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_vulnerabilities/trend/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of infra vulnerability IDs captured for given summary filters", "description": "List of infra vulnerability IDs captured for given trend summary.", "operationId": "ListInfraVulnerabilitiesTrendSummary", "parameters": [{"name": "InfraVulnerabilitiesTrendListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraVulnerabilitiesTrendListRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/dashboard/infra_vulnerabilities/trend/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of infrastructure vulnerability trends", "items": {"$ref": "#/definitions/InfraVulnerabilitiesTrendSummary"}}}}, "summary": "Retrieves trend summary of infrastructure vulnerabilities", "description": "Retrieves trend summary of infrastructure vulnerabilities", "operationId": "InfraVulnerabilitiesTrendSummary", "parameters": [{"name": "InfraVulnerabilitiesTrendSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/InfraVulnerabilitiesTrendSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/infra_threats/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of Threat details", "items": {"$ref": "#/definitions/ThreatResponse"}}}}, "summary": "Details of the given batch of threat IDs", "description": "Details of the given batch of threat IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchThreats", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/infra_threats/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Lists of threat IDs captured for cloud resources", "description": "List of threat IDs captured for cloud resources.", "operationId": "ListThreats", "parameters": [{"name": "ThreatVulnerabilityRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ThreatVulnerabilityRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/infra_vulnerabilities/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of vulnerability details", "items": {"$ref": "#/definitions/VulnerabilityResponse"}}}}, "summary": "Details of the given batch of vulnerability IDs", "description": "Details of the given batch of vulnerability IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchVulnerabilities@@@2", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/infra_vulnerabilities/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List of vulnerability IDs captured for cloud resources", "description": "List of vulnerability IDs captured for cloud resources.", "operationId": "ListVulnerabilities", "parameters": [{"name": "ThreatVulnerabilityRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ThreatVulnerabilityRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v1/secops/vulnerabilities/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsVulnerability"}}}}, "summary": "List of vulnerability details", "description": "Details of the given batch of vulnerability IDs. Supports a maximum of 1000 IDs per request.", "operationId": "BatchVulnerabilities", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v1/security/threat/{service_account_id}/gcp/validate": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/SecurityThreatValidationForGCPResponse"}}}, "summary": "Threat Validation for GCP Services", "description": "Security Threat Validation for GCP", "operationId": "ThreatValidationForGCP", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v1/security/threat/{service_account_id}/oci/validate": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/SecurityThreatValidationForOCIResponse"}}}, "summary": "Threat Validation for OCI services", "description": "Security Threat Validation for OCI", "operationId": "ThreatValidationForOCI", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v1/security/vulnerability/{service_account_id}/gcp/validate": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/SecurityVulnerabilityValidationForGCPResponse"}}}, "summary": "Vulnerability Validation for GCP Services", "description": "Security Vulnerability Validation for GCP", "operationId": "VulnerabilityValidationForGCP", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v1/security/vulnerability/{service_account_id}/oci/validate": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/SecurityVulnerabilityValidationForOCIResponse"}}}, "summary": "Vulnerability Validation for OCI services", "description": "Security Vulnerability Validation for OCI", "operationId": "VulnerabilityValidationForOCI", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v1/sso_auth/tokens/{sso_name}": {"parameters": [{"name": "sso_name", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "SSO Redirected url", "schema": {"$ref": "#/definitions/SsoRedirectResponse"}}}, "summary": "Returns SSO Redirected url", "description": "SSO Redirected url", "operationId": "SsoRedirectUrl", "parameters": [{"name": "SsoRedirectUrlRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SsoRedirectUrlRequest"}}], "tags": ["Authorization"]}}, "/v1/stacks-marketplace/products/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceProductDefinitionBatchResponse"}}}, "summary": "Batch Stacks Marketplace Products", "description": "Batch Stacks Marketplace Products.", "operationId": "BatchProduct", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceProduct"]}}, "/v1/stacks-marketplace/products/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/StacksMarketplaceProductDefinition"}}}, "summary": "Create Stacks Marketplace Product", "description": "Create a new Stacks Marketplace Product.", "operationId": "CreateProduct", "parameters": [{"name": "StacksMarketplaceProductDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceProductDefinition"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceProduct"]}}, "/v1/stacks-marketplace/products/item/{product_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted successfully", "schema": {"type": "boolean"}}}, "summary": "Delete Stacks Marketplace Product", "description": "Delete Stacks Marketplace Product.", "operationId": "DeleteProduct", "security": [{"auth_token": []}], "tags": ["StacksMarketplaceProduct"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceProductDefinition"}}}, "summary": "Get Stacks Marketplace Product", "description": "Get Stacks Marketplace Product.", "operationId": "GetProduct", "security": [{"auth_token": []}], "tags": ["StacksMarketplaceProduct"]}, "parameters": [{"name": "product_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceProductDefinition"}}}, "summary": "Update Stacks Marketplace Product", "description": "Update Stacks Marketplace Product.", "operationId": "UpdateProduct", "parameters": [{"name": "StacksMarketplaceProductDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceProductDefinition"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceProduct"]}}, "/v1/stacks-marketplace/products/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Stacks Marketplace Products", "description": "List Stacks Marketplace Products.", "operationId": "ListProduct", "parameters": [{"name": "StacksMarketplaceProductListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceProductListRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceProduct"]}}, "/v1/stacks-marketplace/stack-definition-versions/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersionBatchResponse"}}}, "summary": "Batch Stacks Marketplace Stack Definition Versions", "description": "Batch Stacks Marketplace Stack Definition Versions.", "operationId": "BatchStackDefinitionVersion", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersion"}}}, "summary": "Create Stacks Marketplace Stack Definition Version", "description": "Create a new Stacks Marketplace Stack Definition Version.", "operationId": "CreateStackDefinitionVersion", "parameters": [{"name": "StacksMarketplaceStackDefinitionVersion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersion"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersion"}}}, "summary": "Get Stacks Marketplace Stack Definition Version", "description": "Get Stacks Marketplace Stack Definition Version.", "operationId": "GetStackDefinitionVersion", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/cost-estimate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Cost estimation initiated successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceEstimateCostResponse"}}}, "summary": "Initiates the cost estimation of a deployment run that could happen on a service account", "description": "Initiate cost estimation of a deployment run that could happen on a service account", "operationId": "InitiateStackVersionDeploymentCostEstimation", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}, {"name": "StacksMarketplaceEstimateCostRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceEstimateCostRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/cost-estimate/{background_job_id}/status": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Cost estimation status fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceCostEstimation"}}}, "summary": "Gets the cost estimation of a deployment run that could happen on a service account", "description": "Gets Estimated cost of a deployment run that could happen on a service account", "operationId": "GetStackVersionDeploymentCostEstimation", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}, {"name": "background_job_id", "in": "path", "required": true, "type": "string", "description": "ID of background job which performs the cost estimation of the given Stack Definition Version."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/make-head": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersion"}}}, "summary": "Make Stacks Marketplace Stack Definition Version Head", "description": "Make Stacks Marketplace Stack Definition Version Head.", "operationId": "MakeStackDefinitionVersionHead", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/make-release": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersion"}}}, "summary": "Make Stacks Marketplace Stack Definition Version Release", "description": "Make Stacks Marketplace Stack Definition Version Release.", "operationId": "MakeStackDefinitionVersionRelease", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/publishing/{master_account_id}/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"type": "array", "items": {"$ref": "#/definitions/StacksMarketplaceStackPublishingState"}}}}, "summary": "Get Stacks Marketplace Stack Definitions Version Publishing History", "description": "Get Stacks Marketplace Stack Definitions Version publishing log for a Master Account.", "operationId": "GetStackPublishingHistory", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}, {"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "ID of the Source Master Account."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/publishing/{master_account_id}/state": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackPublishingState"}}}, "summary": "Get State for Stacks Marketplace Stack Definition Version Publishing", "description": "GetState for the stack definition version publishing state.", "operationId": "GetStackPublishingState", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}, {"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "ID of the Source Master Account."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackPublishingState"}}}, "summary": "Set State for Stacks Marketplace Stack Definition Version Publishing", "description": "SetState for the stack definition version publishing state.", "operationId": "SetStackPublishingState", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}, {"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "ID of the Source Master Account."}, {"name": "StacksMarketplaceStackPublishingState", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceStackPublishingState"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definition-versions/item/{stack_definition_version_id}/set-state": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersion"}}}, "summary": "Set Stacks Marketplace Stack Definition Version State", "description": "Set Stacks Marketplace Stack Definition Version State.", "operationId": "SetStackDefinitionVersionState", "parameters": [{"name": "stack_definition_version_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition Version."}, {"name": "StacksMarketplaceStackDefinitionVersionSetStateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersionSetStateRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinitionVersion"]}}, "/v1/stacks-marketplace/stack-definitions/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionBatchResponse"}}}, "summary": "Batch Stacks Marketplace Stack Definitions", "description": "Batch Stacks Marketplace Stack Definitions.", "operationId": "BatchStackDefinition", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinition"]}}, "/v1/stacks-marketplace/stack-definitions/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinition"}}}, "summary": "Create Stacks Marketplace Stack Definition", "description": "Create a new Stacks Marketplace Stack Definition.", "operationId": "CreateStackDefinition", "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinition"]}}, "/v1/stacks-marketplace/stack-definitions/item/{stack_definition_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinition"}}}, "summary": "Get Stacks Marketplace Stack Definition", "description": "Get Stacks Marketplace Stack Definition.", "operationId": "GetStackDefinition", "parameters": [{"name": "stack_definition_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinition"]}}, "/v1/stacks-marketplace/stack-definitions/item/{stack_definition_id}/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersionBatchResponse"}}}, "summary": "Get Stacks Marketplace Stack Definition History", "description": "Get Stacks Marketplace Stack Definition History.", "operationId": "GetStackDefinitionHistory", "parameters": [{"name": "stack_definition_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinition"]}}, "/v1/stacks-marketplace/stack-definitions/item/{stack_definition_id}/set-state": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinition"}}}, "summary": "Set Stacks Marketplace Stack Definition State", "description": "Set Stacks Marketplace Stack Definition State.", "operationId": "SetStackDefinitionState", "parameters": [{"name": "stack_definition_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Definition."}, {"name": "StacksMarketplaceStackDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinition"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinition"]}}, "/v1/stacks-marketplace/stack-definitions/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Stacks Marketplace Stack Definitions", "description": "List Stacks Marketplace Stack Definitions.", "operationId": "ListStackDefinition", "parameters": [{"name": "StacksMarketplaceStackDefinitionListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionListRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDefinition"]}}, "/v1/stacks-marketplace/stack-deployment/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDeploymentBatchResponse"}}}, "summary": "Batch Stacks Marketplace Stack Deployments", "description": "Batch Stacks Marketplace Stack Deployments.", "operationId": "BatchStackDeployment", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDeployment"]}}, "/v1/stacks-marketplace/stack-deployment/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "created successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceDeploymentDefinition"}}}, "summary": "Create Stacks Marketplace Stack Deployment", "description": "Create a new Stacks Marketplace Stack Deployment", "operationId": "CreateStackDeployment", "parameters": [{"name": "StacksMarketplaceDeploymentDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StacksMarketplaceDeploymentDefinition"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDeployment"]}}, "/v1/stacks-marketplace/stack-deployment/history/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDeploymentHistoryBatchResponse"}}}, "summary": "Batch Stacks Marketplace Stack Deployment History", "description": "Batch Stacks Marketplace Stack Deployment History.", "operationId": "BatchStackDeploymentHistory", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDeployment"]}}, "/v1/stacks-marketplace/stack-deployment/item/{stack_deployment_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceDeploymentDefinition"}}}, "summary": "Get Stacks Marketplace Stack Deployment", "description": "Get Stacks Marketplace Stack Deployment.", "operationId": "GetStackDeployment", "parameters": [{"name": "stack_deployment_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Deployment."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDeployment"]}}, "/v1/stacks-marketplace/stack-deployment/item/{stack_deployment_id}/execute": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Executed successfully", "schema": {"$ref": "#/definitions/StacksMarketplaceStackDeploymentHistory"}}}, "summary": "Execute Stacks Marketplace Stack Deployment", "description": "Execute Stacks Marketplace Stack Deployment.", "operationId": "ExecuteStackDeployment", "parameters": [{"name": "stack_deployment_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Deployment."}, {"name": "StackMarketplaceStackDeploymentExecute", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StackMarketplaceStackDeploymentExecute"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDeployment"]}}, "/v1/stacks-marketplace/stack-deployment/item/{stack_deployment_id}/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Get Stacks Marketplace Stack Deployment History", "description": "Get Stacks Marketplace Stack Deployment History IDs.", "operationId": "GetStackDeploymentHistory", "parameters": [{"name": "stack_deployment_id", "in": "path", "required": true, "type": "string", "description": "ID of Stack Deployment."}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDeployment"]}}, "/v1/stacks-marketplace/stack-deployment/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Stacks Marketplace Stack Deployments", "description": "List Stacks Marketplace Stack Deployments.", "operationId": "ListStackDeployment", "parameters": [{"name": "StackMarketplaceStackDeploymentListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/StackMarketplaceStackDeploymentListRequest"}}], "security": [{"auth_token": []}], "tags": ["StacksMarketplaceStackDeployment"]}}, "/v1/summary_dashboard/cloud_wise_usage": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/CloudWiseUsageResponse"}}}, "summary": "Get cloud-wise cost usage and top resource consumption data for the service accounts in a tenant", "description": "Get cloud-wise cost usage and top resource consumption data for the service accounts in a tenant", "operationId": "CloudWiseUsage", "parameters": [{"name": "CloudWiseUsageRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CloudWiseUsageRequest"}}], "security": [{"auth_token": []}], "tags": ["SummaryDashboard"]}}, "/v1/support/freshservice/departments/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/FreshserviceDepartmentDetails"}}}}, "summary": "List Departments accessible by the user", "description": "Retrieve the departments accessible by the user.", "operationId": "ListDepartments", "security": [{"auth_token": []}], "tags": ["Freshservice Tickets"]}}, "/v1/support/freshservice/tickets/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FreshserviceTicketDetails"}}}, "summary": "Creates a new FreshService Ticket", "description": "Creates a ticket in FreshService", "operationId": "CreateTicket", "parameters": [{"name": "FreshserviceTicketCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/FreshserviceTicketCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["Freshservice Tickets"]}}, "/v1/support/freshservice/tickets/filters": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Freshservice Ticket Filters", "schema": {"$ref": "#/definitions/FreshserviceTicketFiltersResponse"}}}, "summary": "Freshservice Ticket Filters", "description": "Freshservice Ticket Filters", "operationId": "FreshserviceTicketFilters", "security": [{"auth_token": []}], "tags": ["Freshservice Tickets"]}}, "/v1/support/freshservice/tickets/item/{ticket_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FreshserviceTicketDetails"}}}, "summary": "Get FreshService Ticket details", "description": "Retrieve the current details of ticket", "operationId": "GetTicket", "parameters": [{"name": "ticket_id", "in": "path", "required": true, "type": "string", "description": "Specify the ticket ID. This is a unique ID and can be retrieved using the List Ticket API."}], "security": [{"auth_token": []}], "tags": ["Freshservice Tickets"]}}, "/v1/support/freshservice/tickets/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/FreshserviceSupportTicketListResponse"}}}, "summary": "List FreshService Tickets", "description": "List FreshService Tickets", "operationId": "ListTickets", "parameters": [{"name": "FreshserviceTicketListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/FreshserviceTicketListRequest"}}], "security": [{"auth_token": []}], "tags": ["Freshservice Tickets"]}}, "/v1/tag_baseline/all": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Get all Tag Baseline Definitions", "description": "Get a list of all Tag Baseline Definitions that are viewable to the user.", "operationId": "get-all@@@2", "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baseline/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/TagBaselineDefinition"}}}}, "summary": "Get Baselines", "description": "Batch Tag Baseline definitions", "operationId": "batch@@@6", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baseline/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/TagBaselineDefinition"}}}, "summary": "Create new Tag Baseline", "description": "Create a new Tag Baseline Definition. The definition is used to manage a set of versions. This request takes no body", "operationId": "create@@@7", "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baseline/item/{baseline_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Tag Baseline Definition", "description": "Delete a Tag Baseline Definition and all associated versions. Returns 'true' if the operation was successful.", "operationId": "remove@@@4", "parameters": [{"description": "ID of Tag Baseline Definition.", "name": "id", "type": "string", "in": "query"}, {"name": "baseline_id", "in": "path", "required": true, "type": "string"}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/TagBaselineDefinition"}}}, "summary": "Get Tag Baseline Definition", "description": "Get a Tag Baseline Definition by id.", "operationId": "get@@@6", "parameters": [{"name": "baseline_id", "in": "path", "required": true, "type": "string", "description": "ID of Tag Baseline Definition."}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baseline/item/{baseline_id}/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/TagBaselineDefinitionVersion"}}}}, "summary": "Get the history of a Tag Baseline Definition", "description": "Get a list of all versions for a Tag Baseline Definition.", "operationId": "get-history@@@3", "parameters": [{"name": "baseline_id", "in": "path", "required": true, "type": "string", "description": "ID of Tag Baseline Definition."}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baseline/item/{baseline_id}/set-state": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/TagBaselineDefinition"}}}, "summary": "Set state of Tag Baseline Definition", "description": "Set the Active state for a Tag Baseline Definition. When the state is true, the baseline will be used in posture generation.", "operationId": "set-state@@@2", "parameters": [{"name": "baseline_id", "in": "path", "required": true, "type": "string", "description": "ID of Tag Baseline Definition Version."}, {"name": "TagBaselineDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagBaselineDefinition"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baseline_version/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/TagBaselineDefinitionVersion"}}}}, "summary": "Get Dashboard Versions", "description": "Batch Tag Baseline versions", "operationId": "batch@@@7", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitionVersions"]}}, "/v1/tag_baseline_version/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/TagBaselineDefinitionVersion"}}}, "summary": "Create new Tag Baseline Definition Version", "description": "Create a Tag Baseline Definition Version. This will create and link a new version to the given definition id.", "operationId": "create@@@8", "parameters": [{"name": "TagBaselineDefinitionVersion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagBaselineDefinitionVersion"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitionVersions"]}}, "/v1/tag_baseline_version/item/{version_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/TagBaselineDefinitionVersion"}}}, "summary": "Get Tag Baseline Definition Version", "description": "Get a Tag Baseline Definition Version by id.", "operationId": "get@@@7", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Tag Baseline Definition Version."}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitionVersions"]}}, "/v1/tag_baseline_version/item/{version_id}/make-head": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/TagBaselineDefinitionVersion"}}}, "summary": "Make Tag Baseline Definition Version the Head version", "description": "Mark this version as the 'head' version.", "operationId": "make-head@@@3", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Tag Baseline Definition Version."}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitionVersions"]}}, "/v1/tag_baseline_version/item/{version_id}/make-release": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/TagBaselineDefinitionVersion"}}}, "summary": "Make Tag Baseline Definition Version the Release version", "description": "Mark this version as the release version. The release version will be used for posture generation", "operationId": "make-release@@@3", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Tag Baseline Definition Version."}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitionVersions"]}}, "/v1/tag_baseline_version/parseImport": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Parsed", "schema": {"$ref": "#/definitions/TagBaselineConfiguration"}}}, "summary": "Parse Tag Baseline Definition Version", "description": "Parse and validate a raw json string to be used for importing a Tag Baseline Definition Version", "operationId": "parse-import@@@3", "parameters": [{"name": "RawImport", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RawImport"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitionVersions"]}}, "/v1/tag_baselines/available_tags/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagBaselineAvailableTagBatchResponse"}}}, "summary": "Returns a batch of AvailableTag", "description": "Get all tag values for the tag keys passed in the request.", "operationId": "AvailableTagsBatch", "parameters": [{"name": "TagBaselineAvailableTagBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagBaselineAvailableTagBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baselines/available_tags/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a list of AvailableTags ids", "description": "Get a list of all available tag keys found on resources that the user can view.", "operationId": "AvailableTagsList", "parameters": [{"name": "TagBaselineAvailableTagListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagBaselineAvailableTagListRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baselines/enhance_tags": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"type": "array", "description": "AI Generated Tags response", "items": {"$ref": "#/definitions/TagBaselineCustomTags"}}}}, "summary": "Get enhanced tags from the user's tags", "description": "Get enhanced tags from the user's tags.", "operationId": "EnhanceTags", "parameters": [{"name": "TagBaselineEnhanceRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagBaselineEnhanceRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_baselines/generate_tags": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"type": "array", "description": "AI Generated Tags response", "items": {"$ref": "#/definitions/TagBaselineCustomTags"}}}}, "summary": "Returns Generated Tags", "description": "Get AI-recommended tags from the user's prompt.", "operationId": "GenerateAITags", "parameters": [{"name": "TagBaselineGenerateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagBaselineGenerateRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernanceDefinitions"]}}, "/v1/tag_posture/snapshot/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagPostureSnapshotBatchResponse"}}}, "summary": "Returns a batch of TagPostureSnapshot", "description": "Get details for the snapshot ids passed in the request", "operationId": "SnapshotBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagPostureSnapshot"}}}, "summary": "Returns a TagPostureSnapshot", "description": "Create a new snapshot. This will generate the tag posture with the currently active baselines. Old snapshots will be cleaned up based on the 'keep' parameter", "operationId": "SnapshotCreate", "parameters": [{"name": "TagPostureSnapshotCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagPostureSnapshotCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/resource/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagPostureResourceBatchResponse"}}}, "summary": "Returns a batch of TagPostureResources", "description": "For a given snapshot, get the details of the requested resources", "operationId": "ResourceBatch", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "ID of snapshot"}, {"name": "TagPostureResourceBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagPostureResourceBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/resource/item/{resource_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagPostureResource"}}}, "summary": "Returns a TagPostureResource based on input filters", "description": "Get posture details for a particular resource.", "operationId": "ResourceGet", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "Snapshot to use for evaluating baselines (\"live\" computes the posture on demand)"}, {"name": "resource_id", "in": "path", "required": true, "type": "string", "description": "ID of resource to fetch"}, {"description": "Baseline to evaluate resource against (all if missing)", "in": "query", "type": "string", "name": "baseline_id"}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/resource_summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagPostureResourceCoverage"}}}, "summary": "Summarize the tag posture matching the filtering criteria returning resource coverage counts", "description": "For a given snapshot, list all of the posture summaries for resources. Allows filtering and sorting based on the request", "operationId": "ResourceSummary", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "ID of snapshot"}, {"name": "TagPostureSummaryListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagPostureSummaryListRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/summary/cloud_account/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagPostureCloudAccountSummaryBatchResponse"}}}, "summary": "Returns a batch of TagPostureCloudAccountSummary", "description": "For a given snapshot, get the details of the requested cloud account posture summaries", "operationId": "CloudAccountSummaryBatch", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "ID of snapshot"}, {"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}, {"description": "Baseline to fetch summary for (all if missing)", "in": "query", "type": "string", "name": "baseline_id"}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/summary/cloud_account/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a list of TagPostureCloudAccountSummary identifiers based on input filters", "description": "For a given snapshot, list all of the posture summaries for cloud accounts. Allows filtering and sorting based on the request", "operationId": "CloudAccountSummaryList", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "ID of snapshot"}, {"name": "TagPostureSummaryListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagPostureSummaryListRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/summary/resource/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagPostureResourceSummaryBatchResponse"}}}, "summary": "Returns a batch of TagPostureResourceSummary", "description": "For a given snapshot, get the details of the requested resource posture summaries", "operationId": "ResourceSummaryBatch", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "ID of snapshot"}, {"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}, {"description": "Baseline to fetch summary for (all if missing)", "in": "query", "type": "string", "name": "baseline_id"}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/summary/resource/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a list of TagPostureResourceSummary identifiers based on input filters", "description": "For a given snapshot, list all of the posture summaries for resources. Allows filtering and sorting based on the request", "operationId": "ResourceSummaryList", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "ID of snapshot"}, {"name": "TagPostureSummaryListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagPostureSummaryListRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/workload_summary/{workload_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/TagPostureWorkloadCloudSummaryResponse"}}}, "summary": "Get a TagPostureSummary for Workload", "description": "For a given snapshot, get the details of the requested workload cloud posture summaries", "operationId": "TagPostureWorkloadSummary", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "ID of Snapshot"}, {"name": "workload_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload"}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/item/{snapshot_id}/workload_summary/{workload_id}/resource/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a batch of TagPostureWorkloadResourceSummary", "description": "For a given snapshot, get the details of the requested workload resource posture summaries", "operationId": "WorkloadResourceSummaryList", "parameters": [{"name": "snapshot_id", "in": "path", "required": true, "type": "string", "description": "ID of snapshot"}, {"name": "workload_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload"}, {"name": "TagPostureSummaryListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagPostureSummaryListRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/tag_posture/snapshot/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a list of TagPostureSnapshot ids", "description": "Get the list of all Tag Posture Snapshot. Each snapshot represents the tag posture generated at a particular time with a set of baselines.", "operationId": "SnapshotList", "parameters": [{"name": "TagPostureSnapshotListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TagPostureSnapshotListRequest"}}], "security": [{"auth_token": []}], "tags": ["TaggingGovernancePostures"]}}, "/v1/user/switch_account/{master_account_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AuthDetailedResponse"}}}, "summary": "Switch Master Account", "description": "Switching Master AccountsAuth token has to be generated and it is valid only for an hour. New token can be generated using this API. Extract Auth-token.", "operationId": "SwitchMasterAccount", "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the Master Account ID ,That you want to Switch."}], "security": [{"auth_token": []}], "tags": ["Authorization"]}}, "/v1/user/verify/{access_key}": {"parameters": [{"name": "access_key", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserVerificationResponse"}}}, "summary": "Auth0 User Verification", "description": "User Verify", "operationId": "UserVerify", "parameters": [{"name": "UserVerificationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserVerificationRequest"}}], "tags": ["Identity"]}}, "/v1/user/{user_id}/password_reset": {"parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserUpdateResponse"}}}, "summary": "Reset Password for Auth0 User", "description": "Reset Password for the Auth0 User", "operationId": "ResetPassword", "parameters": [{"name": "PasswordResetRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PasswordResetRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/user_delegation/master_accounts/{master_account_id}/rules": {"parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/UserDelegationResponse"}}}, "summary": "Create User Delegation", "description": "Creates a new user delegation", "operationId": "CreateUserDelegation", "parameters": [{"name": "UserDelegationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserDelegationRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/user_delegation/master_accounts/{master_account_id}/rules/batch": {"parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserDelegationBatchResponse"}}}, "summary": "Batch User Delegation", "description": "Batch User Delegation", "operationId": "BatchUserDelegation", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/user_delegation/master_accounts/{master_account_id}/rules/item/{rule_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete User Delegation", "description": "Delete user delegation", "operationId": "DeleteUserDelegation", "security": [{"auth_token": []}], "tags": ["Identity"]}, "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}, {"name": "rule_id", "in": "path", "required": true, "type": "string"}], "put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserDelegationResponse"}}}, "summary": "Update User Delegation", "description": "Update user delegation", "operationId": "UpdateUserDelegation", "parameters": [{"name": "UserDelegationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserDelegationRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/user_delegation/master_accounts/{master_account_id}/rules/list": {"parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List User Delegation", "description": "List user delegation", "operationId": "ListUserDelegation", "parameters": [{"name": "UserDelegationListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserDelegationListRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/user_delegation/master_accounts/{master_account_id}/rules/refresh": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Refreshed", "schema": {"type": "boolean"}}}, "summary": "Refresh User Delegation", "description": "Refresh User Delegation", "operationId": "RefreshUserDelegation", "security": [{"auth_token": []}], "tags": ["Identity"]}, "parameters": [{"name": "master_account_id", "in": "path", "required": true, "type": "string"}]}, "/v1/user_delegation/report/{user_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/UserDelegationSummary"}}}}, "summary": "Get User Delegation Report", "description": "Get user delegation report", "operationId": "GetUserDelegationReport", "security": [{"auth_token": []}], "tags": ["Identity"]}, "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string"}]}, "/v1/user_details": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AuthDetailedResponse"}}}, "summary": "Get User session and roles details", "description": "User access details provided a valid token 1) use the authToken API to generate a new token The refreshed token will also expire after an hour, refer to expires_at in the response for the validity of the token. When the refreshed token also expires, call again the refreshToken API to extend it further. Like wise a token can extended 3 times, refer to refresh_count in the response. After 3 refresh attempts, token will expire and cannot be extended any further. Need to use authToken API to generate a new token.", "operationId": "UserSessionDetails", "security": [{"auth_token": []}], "tags": ["Authorization"]}}, "/v1/user_preferences/{user_id}/subkey/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "List all subkeys of user preferences", "description": "Get a list of all the subkeys for user preferences that are viewable to the user under the certain path.", "operationId": "listSubKeys", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API."}, {"name": "UserPreferenceListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserPreferenceListRequest"}}], "security": [{"auth_token": []}], "tags": ["UserPreference"]}}, "/v1/user_preferences/{user_id}/value/delete": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "User Preference Delete", "description": "Delete a user preference", "operationId": "delete", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API."}, {"name": "UserPreferenceDeleteRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserPreferenceDeleteRequest"}}], "security": [{"auth_token": []}], "tags": ["UserPreference"]}}, "/v1/user_preferences/{user_id}/value/get": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/UserPreference"}}}, "summary": "Get details of the user preference", "description": "Get user preference by id.", "operationId": "get@@@8", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API."}, {"name": "UserPreferenceGetRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserPreferenceGetRequest"}}], "security": [{"auth_token": []}], "tags": ["UserPreference"]}}, "/v1/user_preferences/{user_id}/value/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/UserPreferenceListResponse"}}}, "summary": "List all user preferences", "description": "Get a list of all the user preferences that are viewable to the user under the certain path.", "operationId": "listValues", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API."}, {"name": "UserPreferenceListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserPreferenceListRequest"}}], "security": [{"auth_token": []}], "tags": ["UserPreference"]}}, "/v1/user_preferences/{user_id}/value/set": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created/Updated", "schema": {"$ref": "#/definitions/UserPreference"}}}, "summary": "Create a new user preference", "description": "Create/Update a user preference", "operationId": "set", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API."}, {"name": "UserPreference", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserPreference"}}], "security": [{"auth_token": []}], "tags": ["UserPreference"]}}, "/v1/user_preferences/{user_id}/value/used": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/UserPreference"}}}, "summary": "Update updated_at time for user preference", "description": "Update user preference updated_at time", "operationId": "markAsUsed", "parameters": [{"name": "user_id", "in": "path", "required": true, "type": "string", "description": "Specify the user ID. This is a unique ID and can be retrieved using the List Users API."}, {"name": "UserPreference", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserPreference"}}], "security": [{"auth_token": []}], "tags": ["UserPreference"]}}, "/v1/users/invite": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"$ref": "#/definitions/UserInviteResponse"}}}, "summary": "Invite User", "description": "Invite user", "operationId": "InviteUser", "parameters": [{"name": "UserInviteRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserInviteRequest"}}], "security": [{"auth_token": []}], "tags": ["Identity"]}}, "/v1/waf-frameworks/{tenant_id}/best_practice/delete": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Framework Best Practice Delete", "description": "Delete a Well-Architected Framework Best practice", "operationId": "best-practice-delete", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkBestPractice", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkBestPractice"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/waf-frameworks/{tenant_id}/framework/{framework_id}/sync": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/WellArchitectedFramework"}}}, "summary": "Sync Framework from AWS or To AWS", "description": "Sync Well-Architected Framework from CS or from AWS", "operationId": "framework-sync", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}, "parameters": [{"name": "framework_id", "in": "path", "required": true, "type": "string"}]}, "/v1/waf-frameworks/{tenant_id}/pillar/delete": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Framework Pillar Delete", "description": "Delete a Well-Architected Framework Pillar", "operationId": "pillar-delete", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkPillarRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkPillarRequest"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/waf-frameworks/{tenant_id}/question/delete": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Framework Question Delete", "description": "Delete a Well-Architected Framework Question", "operationId": "question-delete", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkQuestion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkQuestion"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/assessment-definition/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinition"}}}}, "summary": "Get Dashboard Versions", "description": "Fetch a batch of Assessment Definitions", "operationId": "batch@@@8", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitions"]}}, "/v1/well-architected-framework/assessment-definition/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinition"}}}, "summary": "Create new Assessment", "description": "Create a new Assessment Definition. The definition is used to manage a set of versions. This request takes no body", "operationId": "create@@@9", "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitions"]}}, "/v1/well-architected-framework/assessment-definition/item/{assessment_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Assessment Definition", "description": "Delete a Assessment Definition and all associated versions. Returns 'true' if the operation was successful.", "operationId": "remove@@@5", "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Definition. This can be retrieved using Filter Assessment Definitions API."}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitions"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinition"}}}, "summary": "Get Assessment Definition", "description": "Get a Assessment Definition by id.", "operationId": "get@@@9", "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Definition. This can be retrieved using Filter Assessment Definitions API."}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitions"]}}, "/v1/well-architected-framework/assessment-definition/item/{assessment_id}/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinitionVersion"}}}}, "summary": "Get the history of an Assessment Definition", "description": "Get a list of all versions for a Assessment Definition.", "operationId": "get-history@@@4", "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Definition. This can be retrieved using Filter Assessment Definitions API."}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitions"]}}, "/v1/well-architected-framework/assessment-definition/item/{assessment_id}/set-state": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinition"}}}, "summary": "Set state of Assessment Definition", "description": "Set the Active state for a Assessment Definition. When the state is true, the Assessment will be used in resource selection.", "operationId": "set-state@@@3", "parameters": [{"name": "assessment_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Definition. This can be retrieved using Filter Assessment Definitions API."}, {"name": "WellArchitectedFrameworkAssessmentDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinition"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitions"]}}, "/v1/well-architected-framework/assessment-definition/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Filter Assessment Definitions", "description": "Get a list of all Assessment Definitions that are viewable to the user.", "operationId": "list@@@3", "parameters": [{"name": "AssessmentDefinitionListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AssessmentDefinitionListRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitions"]}}, "/v1/well-architected-framework/assessment-run-history/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunHistory"}}}}, "summary": "Get a batch of Assessment Run History details", "description": "Get a batch of Assessment Run History details.", "operationId": "history-batch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run-history/item/{assessment_run_history_id}/violations": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Get a list of RecordIdentity for resources that have violated the given policy job", "description": "Get a list of resources that have violated the given policy job", "operationId": "violations-list", "parameters": [{"name": "assessment_run_history_id", "in": "path", "required": true, "type": "string", "description": "ID of the Assessment Run History. This can be retrieved using get history IDs Filter API."}, {"name": "WellArchitectedFrameworkAssessmentRunViolationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunViolationRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run-history/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Get the history IDs for the given filters", "description": "Get the history IDs for the given filters.", "operationId": "history-list", "parameters": [{"name": "WellArchitectedFrameworkAssessmentRunHistoryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunHistoryRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run-question/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunQuestion"}}}}, "summary": "Get a batch of Assessment Run History Question details", "description": "Get a batch of Assessment Run History Question details.", "operationId": "question-batch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}, {"description": "ID of the Assessment Run History", "name": "assessment_run_history_id", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run-question/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Get the Question IDs for the given filters", "description": "Get the Question IDs for the given filters.", "operationId": "question-list", "parameters": [{"name": "WellArchitectedFrameworkAssessmentRunQuestionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunQuestionRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRun"}}}}, "summary": "Get a batch of assessment run details", "description": "Get a batch of assessment run", "operationId": "batch@@@10", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Started", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRun"}}}, "summary": "Start an assessment run for the assessment definition", "description": "Create an assessment run for a given Assessment Definition", "operationId": "create@@@11", "parameters": [{"name": "WellArchitectedFrameworkAssessmentRunCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run/item/{assessment_run_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRun"}}}, "summary": "Fetch the details for an assessment run by ID", "description": "Get an assessment run by ID", "operationId": "get@@@11", "parameters": [{"name": "assessment_run_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API"}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/answer": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunQuestion"}}}, "summary": "Answer a question or best practice", "description": "Answer a question or best practice\nAllows adding attachments, comments, and setting state for best practice or question", "operationId": "answer", "parameters": [{"name": "assessment_run_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API"}, {"name": "WellArchitectedFrameworkAssessmentRunAnswerRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunAnswerRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/milestone": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/RecordIdentity"}}}, "summary": "Create a milestone - take snapshot of the current state of assessment run including state of questions, best practices, comments and attachments associated alongside", "description": "Create a milestone on the Assessment Run.", "operationId": "milestone", "parameters": [{"name": "assessment_run_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API"}, {"name": "WellArchitectedAssessmentRunCreateMilestoneRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedAssessmentRunCreateMilestoneRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/scan": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Scan Started", "schema": {"$ref": "#/definitions/RecordIdentity"}}}, "summary": "Start a scan for an assessment run using the given context", "description": "Start a scan for an assessment run using the given context", "operationId": "scan", "parameters": [{"name": "assessment_run_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API"}, {"name": "WellArchitectedFrameworkAssessmentContext", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentContext"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run/item/{assessment_run_id}/set-state": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRun"}}}, "summary": "Set the state for an assessment run", "description": "Set the state for an assessment run. Used to complete or abandon the run\nUsed to complete or abandon the run", "operationId": "set-state@@@5", "parameters": [{"name": "assessment_run_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Run. This can retrieved using List Assessment run Filter API"}, {"name": "WellArchitectedFrameworkAssessmentRunSetStateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunSetStateRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-run/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Get all assessment run IDs for the given filters", "description": "Get all assessment run identities for the given filters", "operationId": "list@@@4", "parameters": [{"name": "WellArchitectedFrameworkAssessmentRunRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment-version/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinitionVersion"}}}}, "summary": "Get Assessment Versions", "description": "Fetch a batch of Assessment Versions", "operationId": "batch@@@9", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitionVersions"]}}, "/v1/well-architected-framework/assessment-version/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinitionVersion"}}}, "summary": "Create new Assessment Definition Version", "description": "Create a Assessment Definition Version. This will create and link a new version to the given definition id.", "operationId": "create@@@10", "parameters": [{"name": "WellArchitectedFrameworkAssessmentDefinitionVersion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinitionVersion"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitionVersions"]}}, "/v1/well-architected-framework/assessment-version/item/{version_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinitionVersion"}}}, "summary": "Get Assessment Definition Version", "description": "Get a Assessment Definition Version by id.", "operationId": "get@@@10", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Definition Version."}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitionVersions"]}}, "/v1/well-architected-framework/assessment-version/item/{version_id}/make-head": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinitionVersion"}}}, "summary": "Make Assessment Definition Version the Head version", "description": "Mark this version as the 'head' version.", "operationId": "make-head@@@4", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Definition Version."}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitionVersions"]}}, "/v1/well-architected-framework/assessment-version/item/{version_id}/make-release": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinitionVersion"}}}, "summary": "Make Assessment Definition Version the Release version", "description": "Mark this version as the release version. The release version will be used for posture generation", "operationId": "make-release@@@4", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Definition Version."}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitionVersions"]}}, "/v1/well-architected-framework/assessment-version/item/{version_id}/set-state": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentDefinitionVersion"}}}, "summary": "Set state of Assessment Definition Version", "description": "Set the version state for a Assessment Definition Version. This is used to approve or reject a draft version", "operationId": "set-state@@@4", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Assessment Definition Version."}, {"description": "Version state to transition to", "type": "string", "in": "query", "enum": ["Draft", "Approved", "Rejected"], "x-cs-enum-type": "VersionState", "default": "Draft", "required": true, "name": "state"}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitionVersions"]}}, "/v1/well-architected-framework/assessment-version/parseImport": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Parsed", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentConfiguration"}}}, "summary": "Parse Assessment Definition Version", "description": "Parse and validate a raw json string to be used for importing a Assessment Definition Version", "operationId": "parse-import@@@4", "parameters": [{"name": "RawImport", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RawImport"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentDefinitionVersions"]}}, "/v1/well-architected-framework/assessment/report/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkReport"}}}}, "summary": "List of assessment run report details", "description": "List of assessment run report details", "operationId": "report-batch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment/report/generate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/RecordIdentity"}}}, "summary": "Schedule the generation of a report for an assessment run", "description": "Create a report for an assessment", "operationId": "report-create@@@2", "parameters": [{"name": "WellArchitectedFrameworkReportCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkReportCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment/report/item/{report_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkReport"}}}, "summary": "Fetch an assessment run report by ID", "description": "Get a report for an assessment", "operationId": "report-get@@@2", "parameters": [{"name": "report_id", "in": "path", "required": true, "type": "string", "description": "ID of the report to fetch. This can be retrieved using Report Generation API."}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/assessment/report/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkReportListResponse"}}}, "summary": "Get a list of assessment run report ids for given filters", "description": "Get a list of assessment run report ids for given filters", "operationId": "report-list", "parameters": [{"name": "WellArchitectedFrameworkReportListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkReportListRequest"}}], "security": [{"auth_token": []}], "tags": ["WafAssessmentRuns"]}}, "/v1/well-architected-framework/{tenant_id}/best-practice/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkBestPractice"}}}}, "summary": "Batch Best Practices", "description": "Get a batch of best practices for tenant specified", "operationId": "best-practice-batch", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/best-practice/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Best practices Create", "description": "Add Best Practices to a Well-Architected Framework Question", "operationId": "best-practice-create", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkBestPracticeRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkBestPracticeRequest"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/best-practice/update": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkBestPractice"}}}, "summary": "Best practice Update", "description": "Update Best Practice for a Well-Architected Framework Question", "operationId": "best-practice-update", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkBestPractice", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkBestPractice"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/framework/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFramework"}}}}, "summary": "Batch Frameworks", "description": "Get a batch of Frameworks", "operationId": "framework-batch", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/framework/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/WellArchitectedFramework"}}}, "summary": "Framework Create", "description": "Create a Well-Architected Framework", "operationId": "framework-create", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFramework", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFramework"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/framework/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "List Frameworks", "description": "List all Frameworks for the specified tenant", "operationId": "framework-list", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/framework/update": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/WellArchitectedFramework"}}}, "summary": "Framework Update", "description": "Update a Well-Architected Framework", "operationId": "framework-update", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFramework", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFramework"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/framework/{framework_id}/delete": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Framework Delete", "description": "Delete a Well-Architected Framework", "operationId": "framework-delete", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "framework_id", "in": "path", "required": true, "type": "string", "description": "ID of Custom Framework. This can be retrieved using the List Frameworks API"}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/pillar/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Add pillars to a framework", "description": "Add pillars to a Well-Architected Framework", "operationId": "pillars-create", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkPillarRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkPillarRequest"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/pillar/update": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkPillar"}}}, "summary": "Pillar update", "description": "Update a pillar of a Well-Architected Framework", "operationId": "pillar-update", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkPillar", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkPillar"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/question/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkQuestion"}}}}, "summary": "Batch Questions", "description": "Get a batch of questions for tenant specified", "operationId": "question-batch@@@2", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/question/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}}, "summary": "Create Questions for a pillar of a framework", "description": "Add Questions to a Well-Architected Framework", "operationId": "question-create", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkQuestionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkQuestionRequest"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/well-architected-framework/{tenant_id}/question/update": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkQuestion"}}}, "summary": "Question Update", "description": "Update a Question in a  Well-Architected Framework", "operationId": "questions-update", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "WellArchitectedFrameworkQuestion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WellArchitectedFrameworkQuestion"}}], "security": [{"auth_token": []}], "tags": ["WellArchitectedFramework"]}}, "/v1/workload-definition/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WorkloadDefinition"}}}}, "summary": "Get Dashboard Versions", "description": "Fetch a batch of Workload Definitions", "operationId": "batch@@@11", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitions"]}}, "/v1/workload-definition/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/WorkloadDefinition"}}}, "summary": "Create new Workload", "description": "Create a new Workload Definition. The definition is used to manage a set of versions. This request takes no body", "operationId": "create@@@12", "security": [{"auth_token": []}], "tags": ["WorkloadDefinitions"]}}, "/v1/workload-definition/item/{workload_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed", "schema": {"type": "boolean"}}}, "summary": "Delete Workload Definition", "description": "Delete a Workload Definition and all associated versions. Returns 'true' if the operation was successful.", "operationId": "remove@@@6", "parameters": [{"name": "workload_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload Definition. This can be retrieved using Filter Definition API."}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitions"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WorkloadDefinition"}}}, "summary": "Get Workload Definition", "description": "Get a Workload Definition by id.", "operationId": "get@@@12", "parameters": [{"name": "workload_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload Definition. This can be retrieved using Filter Definition API."}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitions"]}}, "/v1/workload-definition/item/{workload_id}/history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WorkloadDefinitionVersion"}}}}, "summary": "Get the history of a Workload Definition", "description": "Get a list of all versions for a Workload Definition.", "operationId": "get-history@@@5", "parameters": [{"name": "workload_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload Definition. This can be retrieved using Filter Definition API."}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitions"]}}, "/v1/workload-definition/item/{workload_id}/set-state": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"$ref": "#/definitions/WorkloadDefinition"}}}, "summary": "Set state of Workload Definition", "description": "Set the Active state for a Workload Definition. When the state is true, the Workload will be used in resource selection.", "operationId": "set-state@@@6", "parameters": [{"name": "workload_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload Definition. This can be retrieved using Filter Definition API."}, {"name": "WorkloadDefinition", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkloadDefinition"}}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitions"]}}, "/v1/workload-definition/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Filter Workload Definitions", "description": "Get a list of all Workload Definitions that are viewable to the user.", "operationId": "list@@@5", "parameters": [{"name": "WorkloadDefinitionListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkloadDefinitionListRequest"}}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitions"]}}, "/v1/workload-definition/set-state-bulk": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "array", "items": {"$ref": "#/definitions/WorkloadDefinition"}}}}, "summary": "Set state in Bulk for Workload Definition", "description": "Set State of a list of workload definitions in bulk", "operationId": "set-state-bulk", "parameters": [{"name": "payload", "required": true, "in": "body", "schema": {"type": "array", "items": {"$ref": "#/definitions/WorkloadDefinition"}}}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitions"]}}, "/v1/workload-query/execute": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "412": {"description": "Validation Failed", "schema": {"$ref": "#/definitions/ValidationResults"}}, "200": {"description": "Generated", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Returns a list of Resource identifiers based on input query", "description": "Execute a query against the ServiceResourceInventory collection given a WorkloadTierConfiguration", "operationId": "execute", "parameters": [{"name": "WorkloadQueryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkloadQueryRequest"}}], "security": [{"auth_token": []}], "tags": ["WorkloadQuery"]}}, "/v1/workload-query/resource/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"type": "array", "items": {"$ref": "#/definitions/WorkloadResource"}}}}, "summary": "Returns a list of ServiceResourceInventory", "description": "Fetch a batch of resources from the ServiceResourceInventory collection", "operationId": "resource-batch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WorkloadQuery"]}}, "/v1/workload-query/resource/filters/region": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Workload Resource Filters", "schema": {"type": "array", "items": {"$ref": "#/definitions/WorkloadServiceResourceRegion"}}}}, "summary": "Returns list of WorkloadServiceResourceRegion with all possible filter values for the given cloud accounts", "description": "Fetch all the region filter values for the given cloud accounts", "operationId": "resource-filters-region", "parameters": [{"name": "WorkloadServiceResourceRegionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkloadServiceResourceRegionRequest"}}], "security": [{"auth_token": []}], "tags": ["WorkloadQuery"]}}, "/v1/workload-query/resource/filters/service-resource": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Workload Resource Filters", "schema": {"type": "array", "items": {"$ref": "#/definitions/WorkloadServiceResource"}}}}, "summary": "Returns list of WorkloadServiceResource with all possible filter values for the given cloud accounts", "description": "Fetch all the ServiceResource filter values", "operationId": "resource-filters-service-resource", "parameters": [{"name": "WorkloadServiceResourceRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkloadServiceResourceRequest"}}], "security": [{"auth_token": []}], "tags": ["WorkloadQuery"]}}, "/v1/workload-version/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/WorkloadDefinitionVersion"}}}}, "summary": "Get Workload Versions", "description": "Fetch a batch of Workload Versions", "operationId": "batch@@@12", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitionVersions"]}}, "/v1/workload-version/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/WorkloadDefinitionVersion"}}}, "summary": "Create new Workload Definition Version", "description": "Create a Workload Definition Version. This will create and link a new version to the given definition id.", "operationId": "create@@@13", "parameters": [{"name": "WorkloadDefinitionVersion", "required": true, "in": "body", "schema": {"$ref": "#/definitions/WorkloadDefinitionVersion"}}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitionVersions"]}}, "/v1/workload-version/item/{version_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WorkloadDefinitionVersion"}}}, "summary": "Get Workload Definition Version", "description": "Get a Workload Definition Version by id.", "operationId": "get@@@13", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload Definition Version."}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitionVersions"]}}, "/v1/workload-version/item/{version_id}/make-head": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WorkloadDefinitionVersion"}}}, "summary": "Make Workload Definition Version the Head version", "description": "Mark this version as the 'head' version.", "operationId": "make-head@@@5", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload Definition Version."}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitionVersions"]}}, "/v1/workload-version/item/{version_id}/make-release": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/WorkloadDefinitionVersion"}}}, "summary": "Make Workload Definition Version the Release version", "description": "Mark this version as the release version. The release version will be used for posture generation", "operationId": "make-release@@@5", "parameters": [{"name": "version_id", "in": "path", "required": true, "type": "string", "description": "ID of Workload Definition Version."}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitionVersions"]}}, "/v1/workload-version/parseImport": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Parsed", "schema": {"$ref": "#/definitions/WorkloadConfiguration"}}}, "summary": "Parse Workload Definition Version", "description": "Parse and validate a raw json string to be used for importing a Workload Definition Version", "operationId": "parse-import@@@5", "parameters": [{"name": "RawImport", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RawImport"}}], "security": [{"auth_token": []}], "tags": ["WorkloadDefinitionVersions"]}}, "/v2/appsecops/applications/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsApplicationV2"}}}, "summary": "Create an application with BCS scoring", "description": "Create an application with BCS scoring", "operationId": "CreateBCSApplicationV2", "parameters": [{"name": "AppSecopsApplicationV2Request", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsApplicationV2Request"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v2/appsecops/applications/item/{application_id}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsApplicationV2"}}}, "summary": "Get application details with BCS scoring", "description": "Get application details with BCS scoring", "operationId": "GetBCSApplicationV2", "security": [{"auth_token": []}], "tags": ["AppSecOps"]}, "parameters": [{"name": "application_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/AppSecopsApplicationV2"}}}, "summary": "Update application with BCS scoring", "description": "Update application with BCS scoring", "operationId": "UpdateBCSApplicationV2", "parameters": [{"name": "AppSecopsApplicationV2Request", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AppSecopsApplicationV2Request"}}], "security": [{"auth_token": []}], "tags": ["AppSecOps"]}}, "/v2/audit/auditlog/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/AuditLogBatchResponse"}}}, "summary": "Audit Detail", "description": "List all Audit Log document batches", "operationId": "AuditLogBatch", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["AuditLog"]}}, "/v2/audit/auditlog/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Audit List", "description": "Audit Log List", "operationId": "AuditLogList", "parameters": [{"name": "AuditLogListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AuditLogListRequest"}}], "security": [{"auth_token": []}], "tags": ["AuditLog"]}}, "/v2/billing/aggregation": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingAggregationResult"}}}}, "summary": "Aggregate costs based on input criteria", "description": "Generate cost aggregation.", "operationId": "GetCostAggregation", "parameters": [{"name": "BillingAggregationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingAggregationRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/aggregation/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BillingAggregationResponseBatch"}}}, "summary": "Aggregate costs based on input criteria", "description": "Generate cost aggregations in a batch.", "operationId": "GetCostAggregationBatch", "parameters": [{"name": "BillingAggregationRequestBatch", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingAggregationRequestBatch"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/aggregation/trend": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingAggregationTrendResult"}}}}, "summary": "Aggregate costs in a trend based on input criteria", "description": "Generate cost aggregation trend.", "operationId": "GetCostAggregationTrend", "parameters": [{"name": "BillingAggregationTrendRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingAggregationTrendRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/cost_and_usage/aggregation/trend": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingCostAndUsageAggregationTrendResult"}}}}, "summary": "Retrieves the aggregated trend of usage, rate and cost over a specified time period", "description": "Generate cost and usage aggregation trend.", "operationId": "CostAndUsageAggregationTrend", "parameters": [{"name": "BillingCostAndUsageAggregationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingCostAndUsageAggregationRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/description/aggregation/trend": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingDescriptionsTrendResult"}}}}, "summary": "Get description trend results", "description": "Generate description trend.", "operationId": "GetDescriptionTrend", "parameters": [{"name": "BillingAggregationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingAggregationRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/extras": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of tag key/value pairs by service account", "items": {"$ref": "#/definitions/ServiceAccountKeyValues"}}}}, "summary": "List extra keys used in service accounts", "description": "List extra keys for service accounts.", "operationId": "GetExtraKeysByServiceAccounts", "parameters": [{"name": "BillingExtraKeysRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingExtraKeysRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/identities": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingIdentitiesResult"}}}}, "summary": "Return distinct billing line-item identities including tags, without time-series data", "description": "Return distinct line-item identities (with tags) matching the request, without timestamps or cost values.", "operationId": "GetBillingIdentities", "parameters": [{"name": "BillingIdentitiesRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingIdentitiesRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/line_items_summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of tag key/value pairs by service account", "items": {"$ref": "#/definitions/ServiceAccountKeyValues"}}}}, "summary": "List values for group_by key used in service accounts", "description": "List values for group_by keys.", "operationId": "GetLineItemSummary", "parameters": [{"name": "BillingLineItemSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingLineItemSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/platform/tags": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of tag key/value pairs by service account", "items": {"$ref": "#/definitions/ServiceAccountPlatformKeyValues"}}}}, "summary": "List tag keys used in service accounts", "description": "List tag keys values and kind for platform service accounts.", "operationId": "GetPlatformServiceAccountTagsDetails", "parameters": [{"name": "BillingPlatformTagKeysRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingPlatformTagKeysRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/rate/aggregation/trend": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingRateAggregationTrendResult"}}}}, "summary": "Aggregate rate in a trend based on input criteria", "description": "Generate Rate aggregation trend.", "operationId": "GetRateAggregationTrend", "parameters": [{"name": "BillingRateAggregationTrendRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingRateAggregationTrendRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/tags": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of tag key/value pairs by service account", "items": {"$ref": "#/definitions/ServiceAccountKeyValues"}}}}, "summary": "List tag keys used in service accounts", "description": "List tag keys for service accounts.", "operationId": "GetTagKeysByServiceAccounts", "parameters": [{"name": "BillingTagKeysRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingTagKeysRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing/usage/aggregation/trend": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingUsageAggregationTrendResult"}}}}, "summary": "Aggregate usage in a trend based on input criteria", "description": "Generate usage aggregation trend.", "operationId": "GetUsageAggregationTrend", "parameters": [{"name": "BillingUsageAggregationTrendRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingUsageAggregationTrendRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing_info/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BillingInformationBatchResponse"}}}, "summary": "Fetch Billing Information", "description": "Fetch Billing Info.", "operationId": "BatchBillingInfoByServiceAccount", "parameters": [{"name": "BillingInformationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingInformationRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing"]}}, "/v2/billing_metrics/access/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingMetricAccess"}}}}, "summary": "Batch of Billing Metric Access", "description": "Get a Batch of Billing Metric Access", "operationId": "BillingMetricBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}}, "/v2/billing_metrics/access/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BillingMetricAccess"}}}, "summary": "Create new Billing Metric Access", "description": "Create Billing Metric Access.", "operationId": "BillingMetricAccessCreate", "parameters": [{"name": "BillingMetricAccess", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingMetricAccess"}}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}}, "/v2/billing_metrics/access/item/{access_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed"}}, "summary": "Delete Billing Metric Access", "description": "Deletes a billing metric.", "operationId": "BillingMetricsAccessDelete", "parameters": [{"name": "access_id", "in": "path", "required": true, "type": "string"}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BillingMetricAccess"}}}, "summary": "Update Billing Metric Access", "description": "Update Billing Metrics.", "operationId": "BillingMetricsAccessUpdate", "parameters": [{"name": "access_id", "in": "path", "required": true, "type": "string", "description": "The Id of Billing Metric access to update."}, {"name": "BillingMetricAccess", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingMetricAccess"}}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}}, "/v2/billing_metrics/access/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Billing Metric Access", "description": "List Billing Metric Access.", "operationId": "BillingMetricAccessList", "parameters": [{"name": "BillingMetricAccessListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingMetricAccessListRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}}, "/v2/billing_metrics/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Generated", "schema": {"type": "array", "items": {"$ref": "#/definitions/BillingMetrics"}}}}, "summary": "Batch of Billing Metrics", "description": "Get a Batch of Billing Metrics", "operationId": "BillingMetricsBatch", "parameters": [{"name": "BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}}, "/v2/billing_metrics/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BillingMetrics"}}}, "summary": "Create new Billing Metrics", "description": "Create Billing Metrics.", "operationId": "BillingMetricsCreate", "parameters": [{"name": "BillingMetrics", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingMetrics"}}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}}, "/v2/billing_metrics/item/{billing_metrics_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Removed"}}, "summary": "Delete Billing Metrics", "description": "Deletes a billing metric.", "operationId": "BillingMetricsDelete", "parameters": [{"name": "billing_metrics_id", "in": "path", "required": true, "type": "string"}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/BillingMetrics"}}}, "summary": "Update Billing Metrics", "description": "Update Billing Metrics.", "operationId": "BillingMetricsUpdate", "parameters": [{"name": "billing_metrics_id", "in": "path", "required": true, "type": "string", "description": "The Id of Billing Metrics to update."}, {"name": "BillingMetrics", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingMetrics"}}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}}, "/v2/billing_metrics/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Billing Metrics", "description": "List Billing Metrics.", "operationId": "BillingMetricsList", "parameters": [{"name": "BillingMetricListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/BillingMetricListRequest"}}], "security": [{"auth_token": []}], "tags": ["Billing Metric"]}}, "/v2/cost_anomaly/dimension/trigger": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Trigger cost anomaly detection for a dimension, optionally filtered by grouping rules", "description": "Trigger cost anomaly detection for a dimension, using grouping rules as filters.", "operationId": "TriggerCostAnomalyDetectionForDimension", "parameters": [{"name": "CostAnomalyDimensionTriggerRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostAnomalyDimensionTriggerRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost Anomaly"]}}, "/v2/cost_anomaly/dimension_grouping_rule/reject": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Reject Billing Cost Anomaly for Grouping Rule", "description": "Reject Anomaly Grouping Rule", "operationId": "RejectAnomalyDimensionGroupingRule", "parameters": [{"name": "CostAnomalyGroupingRuleRejectRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostAnomalyGroupingRuleRejectRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost Anomaly"]}}, "/v2/cost_anomaly/dimension_grouping_rule_view": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/CostAnomalyGroupingRuleResponse"}}}}, "summary": "Get grouping rule\u2013wise daily cost anomalies", "description": "Retrieve grouping rule\u2013wise cost anomalies.", "operationId": "GetGroupingRuleCostAnomalies", "parameters": [{"name": "CostAnomalyGroupingRuleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/CostAnomalyGroupingRuleRequest"}}], "security": [{"auth_token": []}], "tags": ["Cost Anomaly"]}}, "/v2/operation/automation/templates/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/AutomationTemplate"}}}}, "summary": "Template List Batch", "description": "Batch the templates", "operationId": "BatchTemplate", "parameters": [{"name": "RecordIdentityBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecordIdentityBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/v2/operation/automation/templates/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "Template List", "description": "List the Templates", "operationId": "ListTemplatesV2", "parameters": [{"name": "AutomationTemplateListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/AutomationTemplateListRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/v2/operation/automation/{tenant_id}/templates/{template_id}/parameter_schema": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/TemplateGetParameterSchemaResponse"}}}, "summary": "Get Template Parameter Schema", "description": "Get the list of input and output parameters schema available in a template.", "operationId": "GetTemplateParameterSchema", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "template_id", "in": "path", "required": true, "type": "string", "description": "Specify the template id to get parameters, template id can be obtained from the list template api"}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/v2/operation/automation/{tenant_id}/templates/{template_id}/validate_parameters": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ValidationResults"}}}, "summary": "Validate parameters for a given template", "description": "Validate a set of parameters for a given template", "operationId": "ValidateTemplateParameters", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "template_id", "in": "path", "required": true, "type": "string", "description": "Specify the template id to validate template execution parameters, template id can be obtained from the list template api"}, {"name": "TemplateParameterValidationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/TemplateParameterValidationRequest"}}], "security": [{"auth_token": []}], "tags": ["Automation"]}}, "/v2/operations/resource_utilization_metrics/aggregate_trend": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/UtilizationMetricsAggregateResult"}}}}, "summary": "Utilization metric aggregate trend endpoint", "description": "Retrieve the Utilization metric Data for the given period of time in the granularity provided.", "operationId": "UtilizationMetricAggregateTrend", "parameters": [{"name": "UtilizationMetricsAggregateTrendRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UtilizationMetricsAggregateTrendRequest"}}], "security": [{"auth_token": []}], "tags": ["Operations Utilization Metric Dashboard"]}}, "/v2/platform/task/assign": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Assign Platform Task to Service Account", "description": "Assign platform related background tasks to service accounts", "operationId": "PlatformTaskAssign", "parameters": [{"name": "PlatformTaskRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PlatformTaskRequest"}}], "security": [{"auth_token": []}], "tags": ["PlatformTask"]}}, "/v2/platform/{service_account_id}/logs": {"parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/PlatformLogsResponse"}}}, "summary": "Send Logs from Platform Agent for Service Account", "description": "Send the logs from the platform agent for a service account", "operationId": "PlatformLogs", "parameters": [{"name": "PlatformLogsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PlatformLogsRequest"}}], "security": [{"auth_token": []}], "tags": ["PlatformTask"]}}, "/v2/platform/{service_account_id}/task": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/PlatformTaskResponse"}}}, "summary": "Check Assigned Platform Task for Service Account", "description": "Check assigned platform related background tasks for a service account", "operationId": "PlatformTaskCheck", "security": [{"auth_token": []}], "tags": ["PlatformTask"]}, "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Updated", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Update Assigned Platform Task for Service Account", "description": "Update assigned platform related background tasks for a service account", "operationId": "PlatformTaskUpdate", "parameters": [{"name": "PlatformTaskUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/PlatformTaskUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["PlatformTask"]}}, "/v2/recommendation_dashboard/recommendations/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/RecommendationV2BatchResponse"}}}, "summary": "Batch Recommendations", "description": "Retrieve the Recommendation savings details for the resource", "operationId": "BatchV2Recommendations", "parameters": [{"name": "RecommendationV2BatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecommendationV2BatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation V2 Dashboard"]}}, "/v2/recommendation_dashboard/recommendations/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Listed successfully", "schema": {"$ref": "#/definitions/ListResponse"}}}, "summary": "List Recommendations", "description": "Retrieve the ids of Recommendations which are matching the criteria", "operationId": "ListV2Recommendations", "parameters": [{"name": "RealizationSavingsListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RealizationSavingsListRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation V2 Dashboard"]}}, "/v2/recommendation_dashboard/recommendations/manage": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "204": {"description": "action triggered successfully"}}, "summary": "manage the recommendations for the workflow", "description": "Request the action for the workflow", "operationId": "ManageRecommendations", "parameters": [{"name": "ManageRecommendationAction", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ManageRecommendationAction"}}], "security": [{"auth_token": []}], "tags": ["Recommendation V2 Dashboard"]}}, "/v2/recommendation_dashboard/recommendations/statistics": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/RecommendationStatisticsResponse"}}}, "summary": "Statistics for Recommendations", "description": "Retrieve the Recommendation savings statistics for the filters applied", "operationId": "RecommendationStatistics", "parameters": [{"name": "RecommendationStatisticsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/RecommendationStatisticsRequest"}}], "security": [{"auth_token": []}], "tags": ["Recommendation V2 Dashboard"]}}, "/v2/reports/generate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Created", "schema": {"$ref": "#/definitions/RecordIdentity"}}}, "summary": "Create a NextGen report", "description": "Create a report", "operationId": "CreateReport", "parameters": [{"name": "NextGenReportCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/NextGenReportCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["NextGen Reports"]}}, "/v2/reports/item/{report_id}": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/NextGenReportResponse"}}}, "summary": "Fetch a report by ID", "description": "Get a report by ID", "operationId": "GetReport", "parameters": [{"name": "report_id", "in": "path", "required": true, "type": "string", "description": "ID of the report to fetch. This can be retrieved using Report Generation API."}, {"name": "NextGenReportGetRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/NextGenReportGetRequest"}}], "security": [{"auth_token": []}], "tags": ["NextGen Reports"]}}, "/v2/reports/pin/{report_id}": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Create pinned report", "description": "Pin Report", "operationId": "PinReport", "parameters": [{"name": "report_id", "in": "path", "required": true, "type": "string", "description": "Id of the report"}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/v2/reports/pinned/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "List pinned report", "description": "List of pinned report", "operationId": "GetPinnedReports", "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/v2/reports/unpin/{report_id}": {"put": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Delete pinned report", "description": "Unpin Report", "operationId": "UnpinReport", "parameters": [{"name": "report_id", "in": "path", "required": true, "type": "string", "description": "Id of the report"}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/v2/reports/user_view/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Create view of the report", "description": "Create view of the report", "operationId": "CreateReportsUserView", "parameters": [{"name": "ReportsUserViewCreateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ReportsUserViewCreateRequest"}}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/v2/reports/user_view/delete": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Delete view of the report", "description": "Delete view of the report", "operationId": "DeleteReportsUserView", "parameters": [{"name": "ReportsUserViewDeleteRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ReportsUserViewDeleteRequest"}}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/v2/reports/user_view/list": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ReportDetails"}}}}, "summary": "List of user report views", "description": "List views of the report", "operationId": "ListReportsUserView", "parameters": [{"name": "report_id", "in": "query", "type": "string"}, {"name": "view_name", "in": "query", "type": "string"}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/v2/reports/user_view/update": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "boolean"}}}, "summary": "Update view of the report", "description": "Update view of the report", "operationId": "UpdateReportsUserView", "parameters": [{"name": "ReportsUserViewUpdateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ReportsUserViewUpdateRequest"}}], "security": [{"auth_token": []}], "tags": ["Reports"]}}, "/v2/resource_inventory/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceResourceBatchResponse"}}}, "summary": "Batch Service Resource Details", "description": "Retrieve the Service Resource details for the specified ids", "operationId": "BatchServiceResource", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v2/resource_inventory/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceResourceListResponse"}}}, "summary": "List Service Resources", "description": "Retrieve the ids of service resources matching the filtering criteria", "operationId": "ListServiceResources", "parameters": [{"name": "ServiceResourceListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceResourceListRequest"}}], "security": [{"auth_token": []}], "tags": ["Resource"]}}, "/v2/resources/{inventory_id}/dependent_resources": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/DependentResourcesListResponse"}}}, "summary": "Fetch all dependent resources", "description": "Fetch all Dependent Resources.", "operationId": "CloudDependentResources", "security": [{"auth_token": []}], "tags": ["Resource"]}, "parameters": [{"name": "inventory_id", "in": "path", "required": true, "type": "string"}]}, "/v2/savings_plans/recommendations": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/SavingsPlanRecommendationsData"}}}, "summary": "List savings plan purchase recommendations", "description": "List savings plan purchase recommendations across one or more tenants in a single call.", "operationId": "ListSavingsPlanRecommendations", "parameters": [{"name": "SavingsPlanRecommendationsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SavingsPlanRecommendationsRequest"}}], "security": [{"auth_token": []}], "tags": ["Savings Plans"]}}, "/v2/savings_plans/{tenant_id}/purchased/details": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/SavingsPlanDetailsData"}}}, "summary": "List purchased savings plan details", "description": "List purchased savings plan details for one or more service accounts, excluding utilization time-series.", "operationId": "ListSavingsPlanDetails", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "SavingsPlanDetailsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SavingsPlanDetailsRequest"}}], "security": [{"auth_token": []}], "tags": ["Savings Plans"]}}, "/v2/savings_plans/{tenant_id}/purchased/utilization": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched successfully", "schema": {"$ref": "#/definitions/SavingsPlanUtilizationData"}}}, "summary": "Get savings plan utilization metrics", "description": "Fetch paginated utilization time-series for a single purchased savings plan. plan_id is required.", "operationId": "GetSavingsPlanUtilization", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"name": "SavingsPlanUtilizationRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SavingsPlanUtilizationRequest"}}], "security": [{"auth_token": []}], "tags": ["Savings Plans"]}}, "/v2/schedule_recommendations/filters": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Schedule Recommendation Filters", "schema": {"$ref": "#/definitions/ScheduleRecommendationFiltersResponse"}}}, "summary": "Schedule Recommendations Filters", "description": "Schedule Recommendations Filters", "operationId": "ScheduleRecommendationsFilters", "parameters": [{"name": "ScheduleRecommendationFiltersRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationFiltersRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/list_resource_schedule": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Schedule Recommendation List Resource Schedule", "schema": {"type": "array", "items": {"$ref": "#/definitions/ScheduleRecommendationResourceScheduleDetails"}}}}, "summary": "Schedule Recommendations Resource Schedule List", "description": "Schedule Recommendations Resource Schedule List", "operationId": "ScheduleRecommendationsListResourceSchedule", "parameters": [{"name": "ScheduleRecommendationResourceScheduleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationResourceScheduleRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/list_schedules": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Schedule Recommendation List Schedules", "schema": {"$ref": "#/definitions/ScheduleRecommendationScheduleResponse"}}}, "summary": "Schedule Recommendations Schedule List", "description": "Schedule Recommendations Schedule List", "operationId": "ScheduleRecommendationsListSchedules", "parameters": [{"name": "ScheduleRecommendationScheduleRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationScheduleRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/overview": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Schedule Recommendation Overview", "schema": {"$ref": "#/definitions/ScheduleRecommendationDetailsOverviewResponse"}}}, "summary": "Schedule Recommendations Overview", "description": "Schedule Recommendations Overview", "operationId": "ScheduleRecommendationsOverview", "parameters": [{"name": "ScheduleRecommendationDetailsOverviewRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationDetailsOverviewRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/postpone": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Postponed", "schema": {"type": "boolean"}}}, "summary": "Postpone Schedule Recommendation", "description": "Postpone Schedule Recommendations", "operationId": "ScheduleRecommendationsPostpone", "parameters": [{"name": "ScheduleRecommendationPostponeRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationPostponeRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/reactivate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Reactivated", "schema": {"type": "boolean"}}}, "summary": "Reactivate Schedule Recommendation", "description": "Reactivate Schedule Recommendations", "operationId": "ScheduleRecommendationsReactivate", "parameters": [{"name": "ScheduleRecommendationReactivateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationReactivateRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/reject": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Rejected", "schema": {"type": "boolean"}}}, "summary": "Reject Schedule Recommendation", "description": "Reject Schedule Recommendations", "operationId": "ScheduleRecommendationsReject", "parameters": [{"name": "ScheduleRecommendationRejectRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationRejectRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/remediate": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Remediated", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "Remediate Schedule Recommendation", "description": "Remediate Schedule Recommendations", "operationId": "ScheduleRecommendationsRemediate", "parameters": [{"name": "ScheduleRecommendationRemediateRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationRemediateRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/resource_details": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Schedule Recommendation Resource Details", "schema": {"type": "array", "items": {"$ref": "#/definitions/ScheduleRecommendationResourceDetails"}}}}, "summary": "Schedule Recommendations Resource Details", "description": "Schedule Recommendations Resource Details", "operationId": "ScheduleRecommendationsResourceDetails", "parameters": [{"name": "ScheduleRecommendationResourceDetailsRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationResourceDetailsRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Schedule Recommendation Summary", "schema": {"$ref": "#/definitions/ScheduleRecommendationSummaryResponse"}}}, "summary": "Schedule Recommendations Summary", "description": "Schedule Recommendations Summary", "operationId": "ScheduleRecommendationsSummary", "parameters": [{"name": "ScheduleRecommendationSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/trigger_cost_savings_calculation": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Triggered", "schema": {"type": "boolean"}}}, "summary": "Trigger Cost Savings Calculation Schedule Recommendation", "description": "Trigger Cost Savings Calculations for Schedule Recommendations", "operationId": "ScheduleRecommendationsTriggerCostSavingsCalculation", "parameters": [{"name": "ScheduleRecommendationCalculateCostSavings", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationCalculateCostSavings"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/utilization_definitions": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Schedule Recommendation Utilization Definitions", "schema": {"type": "array", "items": {"$ref": "#/definitions/ScheduleRecommendationUtilizationDefinition"}}}}, "summary": "Schedule Recommendations Utilization Definitions", "description": "Schedule Recommendations Utilization Definitions", "operationId": "ScheduleRecommendationsUtilizationDefinitions", "parameters": [{"name": "ScheduleRecommendationUtilizationDefinitionRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationUtilizationDefinitionRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/schedule_recommendations/utilization_metrics": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Schedule Recommendation Utilization Metrics", "schema": {"type": "array", "items": {"$ref": "#/definitions/ScheduleRecommendationUtilizationMetric"}}}}, "summary": "Schedule Recommendations Utilization Metrics", "description": "Schedule Recommendations Utilization Metrics", "operationId": "ScheduleRecommendationsUtilizationMetrics", "parameters": [{"name": "ScheduleRecommendationUtilizationMetricRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ScheduleRecommendationUtilizationMetricRequest"}}], "security": [{"auth_token": []}], "tags": ["Schedule Recommendations"]}}, "/v2/secops/dashboard/compliance/compliance_by_service_account": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ComplianceServiceAccountSummary"}}}}, "summary": "List Compliance summary by service accounts", "description": "Compliance summary at Service Account level", "operationId": "ComplianceServiceAccountSummary", "parameters": [{"name": "ComplianceServiceAccountSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ComplianceServiceAccountSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v2/secops/dashboard/compliance/compliance_by_tenant": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ComplianceTenantSummary"}}}}, "summary": "List Compliance summary by tenants", "description": "Compliance summary at tenant level", "operationId": "ComplianceTenantSummary", "parameters": [{"name": "ComplianceTenantSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ComplianceTenantSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v2/security/executive_dashboard/access/by_cloud_account": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityDashboardViolationAccountDetails"}}}}, "summary": "Get Access Violation by Cloud Account", "description": "Security Dashboard Access Violations by Cloud Accounts", "operationId": "accessViolationsByCloudAccount", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v2/security/executive_dashboard/access/by_region": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityDashboardViolationByRegionCount"}}}}, "summary": "Get Access Violation By Region", "description": "Security Dashboard Access Violations by Region", "operationId": "accessViolationsByRegion", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v2/security/executive_dashboard/access/trend_by_severity": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/SecurityDashboardAccessViolationByTrend"}}}}, "summary": "Get Access Violation trend by severity", "description": "Security Dashboard Access Violation by Trend", "operationId": "accessViolationsTrend", "parameters": [{"name": "SecurityDashboardRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SecurityDashboardRequest"}}], "security": [{"auth_token": []}], "tags": ["Security"]}}, "/v2/self_service/catalogs/hierarchy": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/SelfServiceCatalogHierarchyComponent"}}}}, "summary": "View Self Service Catalog Hierarchy", "description": "View Self Service Catalog Hierarchy", "operationId": "ViewSelfServiceCatalogHierarchy", "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/v2/self_service/request/attributes": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "View Self Service Request Attributes", "description": "View Self Service Request Attributes for Action", "operationId": "ViewSelfServiceRequestAttributesForAction", "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/v2/self_service/request/attributes/{action}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "View Self Service Request Action Attributes", "description": "View Self Service Request Action Attributes", "operationId": "viewSelfServiceRequestActionAttributes", "parameters": [{"name": "action", "in": "path", "required": true, "type": "string", "description": "Corestack self service request action", "enum": ["create", "modify", "re_order", "approve", "terminate"]}], "security": [{"auth_token": []}], "tags": ["Self Service"]}}, "/v2/service_account/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountBatchResponse"}}}, "summary": "Batch Service Account Details", "description": "Retrieve the Service Account details for the specified ids", "operationId": "BatchServiceAccount", "parameters": [{"name": "ServiceAccountBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceAccountBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/create": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Create a new Service Account", "description": "Creates a new Service Account", "operationId": "CreateServiceAccount", "parameters": [{"name": "ServiceAccountDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete Service Account details", "description": "Delete the service account", "operationId": "DeleteServiceAccount", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account ID to delete, ID which can be obtained from the list service account API."}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}}, "summary": "Get Service Account details", "description": "Retrieve the current details of the service account", "operationId": "GetServiceAccount", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account ID to read, ID which can be obtained from the list service account API."}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "412": {"description": "Validation Failed", "schema": {"$ref": "#/definitions/ValidationResults"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}}, "summary": "Update Service Account details", "description": "Update the details of the service account", "operationId": "UpdateServiceAccount", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account ID to update, ID which can be obtained from the list service account API."}, {"name": "ServiceAccountDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/aws/buckets": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "List Available AWS S3 Buckets", "description": "List the available AWS S3 buckets for the cloud account", "operationId": "ListAvailableAwsBuckets", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v2/service_account/item/{service_account_id}/aws/trails/{region}": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AwsTrailDetails"}}}}, "summary": "List Available AWS CloudTrail By Region", "description": "List the AWS CloudTrail of a region on cloud account", "operationId": "ListAvailableAwsTrailsByRegion", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}, {"name": "region", "in": "path", "required": true, "type": "string", "description": "Specify the region to fetch trails"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v2/service_account/item/{service_account_id}/azure/action_groups": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AzureActionGroupDetails"}}}}, "summary": "List Available Azure Action Groups", "description": "List the available Azure action groups for the cloud account", "operationId": "ListAvailableAzureActionGroups", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v2/service_account/item/{service_account_id}/azure/activity_log_alerts": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AzureActivityLogAlertDetails"}}}}, "summary": "List Available Azure Activity Log Alerts", "description": "List the available Azure activity log alerts for the cloud account", "operationId": "ListAvailableAzureActivityLogAlerts", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v2/service_account/item/{service_account_id}/azure/log_analytics_workspaces": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AzureLogAnalyticsWorkspaceDetails"}}}}, "summary": "List Available Azure Log Analytics Workspaces", "description": "List the available Azure log analytics workspaces for the cloud account", "operationId": "ListAvailableAzureLogAnalyticsWorkspaces", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v2/service_account/item/{service_account_id}/azure/subscriptions": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/AzureSubscriptionDetails"}}}}, "summary": "List Available Azure Subscriptions", "description": "List the available Azure subscriptions for the cloud account", "operationId": "ListAvailableAzureSubscriptions", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v2/service_account/item/{service_account_id}/billing_metrics": {"get": {"responses": {"403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "List billing metrics for a cloud account", "description": "List the billing metrics for an account", "operationId": "ListBillingMetricsForAnAccount", "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}, "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}, "/v2/service_account/item/{service_account_id}/cloud_tags": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}}, "summary": "Fetch Service Account Cloud Tags", "description": "Fetch the cloud tags for the service account", "operationId": "FetchServiceAccountCloudTags", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/compartments": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/CompartmentDetailsBase"}}}}, "summary": "List of Available OCI Compartments", "description": "List the available compartments for the cloud account", "operationId": "ListAvailableCompartments", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/credentials_validation": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Validated", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}}, "summary": "Validate Service Account Credentials", "description": "Performs validation of credentials associated with the service account", "operationId": "PerformServiceAccountCredentialsValidation", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account id to read, cloud account id is unique can be obtained from the list cloud account api.This should be same as the ID of the reference API"}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/dry_run": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "412": {"description": "Validation Failed", "schema": {"$ref": "#/definitions/ValidationResults"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}}, "summary": "Validate update of Service Account details", "description": "Validate if the details can be applied to the service account", "operationId": "UpdateServiceAccountDryRun", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account ID to validate, ID which can be obtained from the list service account API."}, {"name": "ServiceAccountDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/extended_dry_run": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "412": {"description": "Validation Failed", "schema": {"$ref": "#/definitions/ValidationResults"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}}, "summary": "Validate update of Service Account details and check if the Governance Configuration can be accepted by the Cloud/Tool provider", "description": "Validate if the details can be applied to the service account and the Governance Configuration is acceptable by the Cloud/Tool provider", "operationId": "UpdateServiceAccountExtendedDryRun", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account ID to validate, ID which can be obtained from the list service account API."}, {"name": "ServiceAccountDetails", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceAccountDetails"}}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/gcp/buckets": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"type": "string"}}}}, "summary": "List Available GCS Buckets", "description": "List the available GCS buckets for the cloud account", "operationId": "ListAvailableGcsBuckets", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}}, "/v2/service_account/item/{service_account_id}/github/repositories": {"get": {"responses": {"403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/RepositoryDetail"}}}}, "summary": "List the repositories in a gitHub account", "description": "List the repositories for a github account", "operationId": "ListGithubRepositories", "security": [{"auth_token": []}], "tags": ["Service Account Resources"]}, "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}, "/v2/service_account/item/{service_account_id}/locations": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/LocationDetailsBase"}}}}, "summary": "List Available Locations", "description": "List the available location for the cloud account", "operationId": "ListAvailableLocations", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/resource_groups": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"type": "array", "items": {"$ref": "#/definitions/ResourceGroupDetailsBase"}}}}, "summary": "List Available Azure Resource Groups", "description": "List the available resource groups for the cloud account", "operationId": "ListAvailableResourceGroups", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the account id"}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/sync_status": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountSync"}}}, "summary": "Get Current Sync Status", "description": "Retrieve the current sync status of the service account", "operationId": "GetServiceAccountSyncStatus", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account id to read, cloud account id is unique can be obtained from the list cloud account api.This should be same as the ID of the reference API"}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}, "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountSync"}}}, "summary": "Trigger refresh of Sync Status", "description": "Trigger the refresh of the sync status of the service account", "operationId": "TriggerServiceAccountSync", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account id to read, cloud account id is unique can be obtained from the list cloud account api.This should be same as the ID of the reference API"}, {"name": "ServiceAccountSync", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceAccountSync"}}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/item/{service_account_id}/sync_status_history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountSyncHistory"}}}, "summary": "Get Sync Status History", "description": "Retrieve the historical sync status of the service account", "operationId": "GetServiceAccountSyncStatusHistory", "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string", "description": "Specify the service account id to read, cloud account id is unique can be obtained from the list cloud account api.This should be same as the ID of the reference API"}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"$ref": "#/definitions/ServiceAccountListResponse"}}}, "summary": "List Service Accounts", "description": "Retrieve the ids of service accounts matching the filtering criteria", "operationId": "ListServiceAccounts", "parameters": [{"name": "ServiceAccountListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceAccountListRequest"}}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/service_account/summary": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Fetched", "schema": {"type": "array", "items": {"$ref": "#/definitions/ServiceAccountSummary"}}}}, "summary": "Summarize Service Accounts", "description": "Summarize the service accounts matching the filtering criteria returning counts for each group", "operationId": "ServiceAccountsSummary", "parameters": [{"name": "ServiceAccountSummaryRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ServiceAccountSummaryRequest"}}], "security": [{"auth_token": []}], "tags": ["Service Account Governance"]}}, "/v2/sku_unit_price": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "404": {"description": "Not Found", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/PricingResponse"}}}, "summary": "Get cloud SKU unit pricing from MongoDB", "description": "Retrieve cloud SKU unit pricing from MongoDB. Provide service, sku_name, and region to look up pricing. Use attributes for service-specific filters: os (EC2), db_engine / deployment (RDS), cache_engine (ElastiCache). EC2 match_confidence is \"approximate\" \u2014 OS is matched but AMI-level variants are not disambiguated. For RESERVED pricing, omit payment_option to return all three upfront variants (NO/PARTIAL/ALL_UPFRONT) in the rates array.", "operationId": "PostSkuUnitPrice", "parameters": [{"name": "SkuUnitPriceRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/SkuUnitPriceRequest"}}], "security": [{"auth_token": []}], "tags": ["Pricing"]}}, "/v2/user_groups": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Created", "schema": {"type": "string", "x-cs-type": "ObjectId"}}}, "summary": "Create UserGroup", "description": "Creates a user group within a CoreStack tenant and assign different set of roles to different users.There can be multiple user groups within a CoreStack tenant. User group will be created at the tenant level", "operationId": "CreateUserGroup", "parameters": [{"name": "UserGroupRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserGroupRequest"}}], "security": [{"auth_token": []}], "tags": ["UserGroups"]}}, "/v2/user_groups/batch": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserGroupBatchResponse"}}}, "summary": "User Group Batch", "description": "User Group Batch", "operationId": "UserGroupBatch", "parameters": [{"name": "ObjectIdBatchRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/ObjectIdBatchRequest"}}], "security": [{"auth_token": []}], "tags": ["UserGroups"]}}, "/v2/user_groups/item/{group_id}": {"delete": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Deleted", "schema": {"type": "boolean"}}}, "summary": "Delete UserGroup", "description": "Delete User Group by ID", "operationId": "DeleteUserGroup", "security": [{"auth_token": []}], "tags": ["UserGroups"]}, "get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserGroupDetails"}}}, "summary": "Get UserGroup", "description": "Get User Group by ID", "operationId": "GetUserGroup", "security": [{"auth_token": []}], "tags": ["UserGroups"]}, "parameters": [{"name": "group_id", "in": "path", "required": true, "type": "string"}], "post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "201": {"description": "Success", "schema": {"$ref": "#/definitions/UserGroupDetails"}}}, "summary": "Update UserGroup", "description": "user group update within a CoreStack tenant and assign different set of roles to different users.There can be multiple user groups within a CoreStack tenant. User group will be updated at the tenant level", "operationId": "UpdateUserGroup", "parameters": [{"name": "UserGroupRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserGroupRequest"}}], "security": [{"auth_token": []}], "tags": ["UserGroups"]}}, "/v2/user_groups/list": {"post": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/UserGroupListResponse"}}}, "summary": "User Group List", "description": "List User Groups", "operationId": "ListUserGroups", "parameters": [{"name": "UserGroupListRequest", "required": true, "in": "body", "schema": {"$ref": "#/definitions/UserGroupListRequest"}}], "security": [{"auth_token": []}], "tags": ["UserGroups"]}}, "/v2/{service_account_id}/scanner_configuration/list_master_rules": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "403": {"description": "Forbidden", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ScannerRuleList"}}}, "summary": "List the governance scanner rules for a GitHub account", "description": "List the master rules for a scanner configuration", "operationId": "ListGovernanceScannerMasterRules", "security": [{"auth_token": []}], "tags": ["Pro Active Scanner Configurations"]}, "parameters": [{"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}, "/{tenant_id}/assessment_history": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceControlMappingResponse"}}}, "summary": "Get compliance standard assessments", "description": "Objective is to return all of the compliance control mapping, the tenant as input", "operationId": "ComplianceControlMapping", "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, {"description": "Page number", "type": "integer", "name": "page", "in": "query"}, {"description": "Number of records to display", "type": "integer", "name": "limit", "in": "query"}, {"description": "Allowed values:account,standard,service", "type": "string", "name": "search", "in": "query"}, {"description": "uri of compliance standard, This can be fetched from the compliance standards list API call.", "type": "string", "name": "compliance_uri", "in": "query"}, {"description": "ID of the cloud account. This can be fetched from ListCloudAccounts API", "name": "service_account", "type": "string", "in": "query"}, {"description": "Specify the assessment_status.", "enum": ["COMPLETED", "IN_PROGRESS", "PENDING"], "name": "assessment_status", "type": "string", "in": "query"}, {"description": "Specify the assessment_type.", "enum": ["standard", "control"], "name": "assessment_type", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}}, "/{tenant_id}/compliance_posture/{service_account_id}/visibility": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/CompliancePostureVisibilityResponse"}}}, "summary": "compliance posture visibility", "description": "Objective is to return all of the compliance Visibility", "operationId": "CompliancePostureVisibility", "parameters": [{"description": "uri of compliance standard This can be fetched from the compliance standards list API call.", "type": "string", "required": true, "name": "compliance_uri", "in": "query"}, {"description": "Group by attribute (Allowed Values: control_family, resource_type, severity, region) ", "default": "control_family", "name": "group_by", "type": "string", "in": "query"}, {"description": "Allowed Values: control, policy and resource.", "default": "control", "name": "count_by", "type": "string", "in": "query"}, {"description": "allowed values for selected group by", "type": "string", "name": "group_by_filter", "in": "query"}, {"description": "true/false flag to identify whether filters is required or not", "type": "boolean", "enum": ["true", "false"], "name": "filters_required", "in": "query"}, {"description": "true/false flag to identify whether detail is required or not", "type": "boolean", "enum": ["true", "false"], "name": "details_required", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}, "/{tenant_id}/compliance_posture/{service_account_id}/visibility_trend": {"get": {"responses": {"500": {"description": "Internal Server Error", "schema": {"$ref": "#/definitions/ModelError"}}, "401": {"description": "Unauthorized", "schema": {"$ref": "#/definitions/ModelError"}}, "400": {"description": "Bad Request", "schema": {"$ref": "#/definitions/ModelError"}}, "200": {"description": "Success", "schema": {"$ref": "#/definitions/ComplianceVisibilityTrendResponse"}}}, "summary": "compliance visibility trend", "description": "Objective is to return all of the compliance VisibilityTrend", "operationId": "ComplianceVisibilityTrend", "parameters": [{"description": "uri of compliance standard This can be fetched from the compliance standards list API call.", "type": "string", "required": true, "name": "compliance_uri", "in": "query"}, {"description": "date range filter (Allowed values: current_month, previous_month, last_3_months, last_10_assessments) ", "default": "last_10_assessments", "name": "period", "type": "string", "in": "query"}, {"description": "Allowed Values: control, policy and resource", "name": "count_by", "type": "string", "in": "query"}], "security": [{"auth_token": []}], "tags": ["Compliance"]}, "parameters": [{"name": "tenant_id", "in": "path", "required": true, "type": "string"}, {"name": "service_account_id", "in": "path", "required": true, "type": "string"}]}}, "info": {"title": "CoreStack External API", "version": "1.0.0", "termsOfService": "http://corestack.io/", "license": {"name": "CoreStack Inc License", "url": "http://corestack.io/licenses/LICENSE-2.0.html"}}, "produces": ["application/json"], "consumes": ["application/json"], "securityDefinitions": {"auth_token": {"type": "apiKey", "in": "header", "name": "X-Auth-Token"}}, "tags": [{"name": "Access", "description": "Access Pillar"}, {"name": "AIGovernance", "description": "Manage AI Governance Metrics"}, {"name": "AI Agent", "description": "AI Agent Framework API"}, {"name": "Application Health", "description": "Application Health"}, {"name": "AppSecOps", "description": "Application Security"}, {"name": "Assessment", "description": "Manage Assessment"}, {"name": "Attachments", "description": "Manage Attachments"}, {"name": "AuditLog", "description": "Manage Audit Log"}, {"name": "Authorization", "description": "Manage Tokens"}, {"name": "Automation", "description": "Manage Templates, Scripts & Blueprints"}, {"name": "Automation WorkFlows", "description": "Manage Automation WorkFlows"}, {"name": "AWS Security Hub", "description": "AWS Security Hub"}, {"name": "AwsSsm", "description": "Manage AWS SSM"}, {"name": "AwsSsm Automation", "description": "Manage AWS SSM Automation"}, {"name": "AwsSsm Command", "description": "Manage AWS SSM Command"}, {"name": "Azure DevOps Pipeline DashBoard", "description": "Azure DevOps Pipeline DashBoard"}, {"name": "Background Jobs", "description": "Manage Background Jobs"}, {"name": "Billing", "description": "Cost Management"}, {"name": "Billing Commitment", "description": "Billing commitment"}, {"name": "Billing Metric", "description": "Manage Billing Metrics"}, {"name": "BillingPlanDefinitions", "description": "Manage BillOps Plans"}, {"name": "BillingPlanDefinitionVersions", "description": "Manage BillOps Plan Versions"}, {"name": "Budget V2 Management", "description": "Budget V2 Management"}, {"name": "Account Governance", "description": "Manage Cloud Accounts"}, {"name": "Compliance", "description": "Corestack compliance Rest API"}, {"name": "Copilot Governance", "description": "Manage Copilot Governance Metrics"}, {"name": "Cost", "description": "Cost Pillar"}, {"name": "Cost Anomaly", "description": "Cost Anomaly Detection"}, {"name": "CurrencyExchangeConfiguration", "description": "Manage Currency Exchange Configuration"}, {"name": "Custom Metric Configuration", "description": "Custom Metric Configuration"}, {"name": "Custom Tags", "description": "Manage Custom Tags"}, {"name": "Dimension", "description": "Manage Dimensions"}, {"name": "DimensionVersion", "description": "Manage Dimension Versions"}, {"name": "Dashboard Definitions", "description": "Manage Executive Dashboards"}, {"name": "Dashboard Definition Versions", "description": "Manage Executive Dashboard Versions"}, {"name": "Dashboard Saved Views", "description": "Manage saved views for executive dashboards (deep-linkable)"}, {"name": "Freshservice Tickets", "description": "Freshservice Ticket Integration"}, {"name": "Guardrails", "description": "Manage Policy"}, {"name": "Identity", "description": "User, Tenants & Roles Management"}, {"name": "Jira Service Management", "description": "Jira Service Management"}, {"name": "Kubernetes Agent", "description": "Kubernetes Agent"}, {"name": "MasterAccount", "description": "Manage Master Account"}, {"name": "MasterAccount Billing", "description": "Manage Master Account Billing"}, {"name": "Master Data", "description": "Master Data apis"}, {"name": "NextGen Reports", "description": "Manage NextGen Reports"}, {"name": "On premises", "description": "Manage On premises Metrics"}, {"name": "Operations", "description": "Operations Pillar"}, {"name": "PlatformTask", "description": "Assign Platform related background tasks to service accounts"}, {"name": "Pro Active Scanner Configurations", "description": "Pro Active Scanner Configurations"}, {"name": "Pricing", "description": "Cloud SKU Pricing API"}, {"name": "Product", "description": "Product bundles, Product & Role templates"}, {"name": "Recommendation", "description": "Recommendation summary"}, {"name": "Recommendation V2 Dashboard", "description": "Manage Recommendations"}, {"name": "Reports", "description": "Reports Pillar"}, {"name": "Request Audit", "description": "Analyze Request Audit"}, {"name": "Resource", "description": "Resource Pillar"}, {"name": "Schedule Recommendations", "description": "Schedule Recommendation"}, {"name": "Savings Plans", "description": "Savings plans purchased and utilization"}, {"name": "Schedules", "description": "Schedules"}, {"name": "Security", "description": "Security Pillar"}, {"name": "Self Service", "description": "Self Service Pillar"}, {"name": "Service Account Resources", "description": "Manage Service Account Resources"}, {"name": "Service Account Governance", "description": "Manage Service Accounts"}, {"name": "ServiceNow Integrations", "description": "ServiceNow Integrations"}, {"name": "StacksMarketplaceProduct", "description": "Manage Stacks Marketplace Products"}, {"name": "StacksMarketplaceStackDefinition", "description": "Manage Stacks Marketplace Stack Definitions"}, {"name": "StacksMarketplaceStackDefinitionVersion", "description": "Manage Stacks Marketplace Stack Definition Versions"}, {"name": "StacksMarketplaceStackDeployment", "description": "Manage Stacks Marketplace Stack Deployments"}, {"name": "SummaryDashboard", "description": "Summary Dashboard APIs"}, {"name": "TaggingGovernanceDefinitions", "description": "Manage Tagging Governance"}, {"name": "TaggingGovernanceDefinitionVersions", "description": "Manage Tagging Governance Versions"}, {"name": "TaggingGovernancePostures", "description": "Manage Tagging Governance Postures"}, {"name": "UserPreference", "description": "Corestack UserPreferences Rest API"}, {"name": "UserGroups", "description": "User Group Management"}, {"name": "Operations Utilization", "description": "Dashboard For Utilization"}, {"name": "Operations Utilization Metric Dashboard", "description": "Dashboard For Utilization Metrics"}, {"name": "WafAssessmentDefinitions", "description": "Manage Assessments"}, {"name": "WafAssessmentDefinitionVersions", "description": "Manage Assessment Versions"}, {"name": "WafAssessmentRuns", "description": "Manage Assessment Runs"}, {"name": "WellArchitectedFramework", "description": "Corestack Well Architecture Framework Rest API"}, {"name": "WorkloadDefinitions", "description": "Manage Workloads"}, {"name": "WorkloadDefinitionVersions", "description": "Manage Workload Versions"}, {"name": "WorkloadQuery", "description": "Query Resources for Workloads"}, {"name": "Zoho Incident", "description": "Zoho Incident"}], "definitions": {"AccessGrantedRoles": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID explicitly denied access", "x-cs-type": "ObjectId"}, "role_ids": {"type": "array", "description": "Role IDs under this tenant explicitly denied access", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AccessGrantedRolesAndUserGroups": {"allOf": [{"$ref": "#/definitions/AccessGrantedUserGroups"}, {"properties": {"roles": {"type": "array", "description": "Roles explicitly denied access by tenant", "items": {"$ref": "#/definitions/AccessGrantedRoles"}}}, "type": "object"}]}, "AccessGrantedUserGroups": {"properties": {"user_groups": {"type": "array", "description": "User groups explicitly denied access", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AccessSummaryDashboard": {"required": ["service_name", "violation"], "properties": {"service_name": {"type": "string", "description": "Name of the Service"}, "violation": {"type": "object", "description": "Contains the summary of violations"}}, "type": "object"}, "AccessValidationByContext": {"properties": {"location": {"description": "Optional location context for the permission checks", "$ref": "#/definitions/LocationDetailsBase"}, "resource_group": {"description": "Optional resource group context for the permission checks", "$ref": "#/definitions/ResourceGroupDetailsBase"}, "access_granted": {"type": "array", "description": "Permissions Allowed", "items": {"type": "string"}}, "access_denied": {"type": "array", "description": "Permissions Denied", "items": {"type": "string"}}}, "type": "object"}, "AccessViolationsByCloudAccountWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AccessViolationsByCloudAccountWidgetConfiguration"}, "AccessViolationsTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AccessViolationsTrendWidgetConfiguration"}, "AccountFilters": {"properties": {"tenants": {"type": "array", "description": "Tenants to include (all if missing)", "items": {"type": "string"}}, "clouds": {"type": "array", "description": "Cloud Providers to include (all if missing)", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "cloud_accounts": {"type": "array", "description": "Cloud Accounts to include (all if missing)", "items": {"type": "string"}}, "regions": {"type": "array", "description": "Regions to include (all if missing)", "items": {"type": "string"}}, "resource_filter": {"type": "array", "description": "Resources filter to filter (all if missing)", "items": {"type": "string"}}, "product_categories": {"type": "array", "description": "Product Categories to include (all if missing)", "items": {"type": "string"}}, "category": {"type": "string", "description": "Inventory Category of the resources to filter (all if missing)"}, "resource_type": {"type": "array", "description": "Type of Resources to include (all if missing)", "items": {"type": "string"}}}, "type": "object"}, "AccountPolicyConfigurationBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/PolicyParameterConfiguration"}}}, "type": "object"}, "AccountSummary": {"required": ["cloud_account_id", "cloud_account_name", "cloud_account_type", "estimated_cost", "impacted_resources", "monthly_cost_saving_info", "monthly_cost_savings", "quarterly_cost_saving_info", "quarterly_cost_savings", "recommendation", "savings_percentage", "yearly_cost_saving_info", "yearly_cost_savings"], "properties": {"cloud_account_id": {"type": "string", "description": "Cloud account id"}, "cloud_account_name": {"type": "string", "description": "Cloud account name"}, "cloud_account_type": {"type": "string", "description": "Cloud account type"}, "recommendation": {"type": "string", "description": "Recommendations"}, "estimated_cost": {"type": "number", "description": "Estimated cost"}, "monthly_cost_savings": {"type": "number", "description": "Monthly cost savings"}, "quarterly_cost_savings": {"type": "number", "description": "Quarterly cost savings"}, "yearly_cost_savings": {"type": "number", "description": "Yearly cost savings"}, "impacted_resources": {"type": "integer", "description": "Impacted resources"}, "savings_percentage": {"type": "string", "description": "Savings percentage"}, "monthly_cost_saving_info": {"type": "string", "description": "Monthly cost saving information"}, "quarterly_cost_saving_info": {"type": "string", "description": "Quarterly cost saving information"}, "yearly_cost_saving_info": {"type": "string", "description": "Yearly cost saving information"}}, "type": "object"}, "ActionDetails": {"required": ["action_resource_name", "action_type", "description", "name", "preexecute_required", "terms_and_conditions"], "properties": {"name": {"type": "string", "description": "Name of the action"}, "terms_and_conditions": {"type": "string", "description": "Terms and Conditions of the action"}, "preexecute_required": {"type": "string", "description": "Pre execute is required or not"}, "action_type": {"type": "string", "description": "Action Type"}, "action_resource_name": {"type": "string", "description": "Action Resource Name"}, "description": {"type": "string", "description": "Description of the action"}}, "type": "object"}, "ActionFormField": {"required": ["id"], "properties": {"id": {"type": "string", "description": "Field identifier"}, "label": {"type": "string", "description": "Display label"}, "type": {"type": "string", "description": "Field type: text, select, multi_select"}, "required": {"type": "boolean", "description": "Whether field is required"}, "default": {"type": "object", "description": "Default value"}, "options": {"type": "array", "description": "Options for select fields", "items": {"type": "object"}}, "placeholder": {"type": "string", "description": "Placeholder text"}, "section_id": {"type": "string", "description": "Section this field belongs to"}}, "type": "object"}, "ActionFormSection": {"required": ["id"], "properties": {"id": {"type": "string", "description": "Section identifier"}, "title": {"type": "string", "description": "Section display title"}}, "type": "object"}, "ActivateRequest": {"required": ["password"], "properties": {"password": {"type": "string", "description": "user password"}}, "type": "object"}, "ActivateUserResponse": {"required": ["user_id"], "properties": {"user_id": {"type": "string", "description": "User ID"}}, "type": "object"}, "ActivationDetails": {"properties": {"status": {"type": "string", "description": "Status of the activation details", "example": "activated", "enum": ["activated", "failed", "pending_activation"], "x-cs-enum-type": "ActivationDetailsStatus"}, "message": {"type": "string", "description": "Message of the activation details"}}, "type": "object"}, "ActivityQueueNotificationDetails": {"properties": {"activity": {"$ref": "#/definitions/ActivityQueueNotifications"}, "alerts": {"$ref": "#/definitions/ActivityQueueNotifications"}, "policies": {"$ref": "#/definitions/ActivityQueueNotifications"}, "scripts": {"$ref": "#/definitions/ActivityQueueNotifications"}, "templates": {"$ref": "#/definitions/ActivityQueueNotifications"}, "security_alerts": {"$ref": "#/definitions/ActivityQueueNotifications"}, "inventory_update": {"$ref": "#/definitions/ActivityQueueNotifications"}, "automation_failure": {"$ref": "#/definitions/ActivityQueueNotifications"}, "budget_alerts": {"$ref": "#/definitions/ActivityQueueNotifications"}}, "type": "object"}, "ActivityQueueNotifications": {"properties": {"enabled": {"type": "boolean", "description": "Activity Queue Notifications enabled"}, "integrated_tool_account": {"$ref": "#/definitions/IntegratedToolAccount"}}, "type": "object"}, "AddRoleAssignment": {"required": ["role_names", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "ID of the tenant within the CoreStack account"}, "role_names": {"type": "array", "description": "Name of the Roles to be assigned to the user under a tenant", "items": {"type": "string"}}}, "type": "object"}, "AdditionalResourceDetailsBase": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "AdditionalResourceDetailsForFinopsBudgetSystem", "subtype_name": "AdditionalResourceDetailsForFinopsBudgetSystem"}, {"subtype_model": "AdditionalResourceDetailsForFinopsReservationRecommendations", "subtype_name": "AdditionalResourceDetailsForFinopsReservationRecommendations"}, {"subtype_model": "AdditionalResourceDetailsForFinopsBillingAzureAdvisor", "subtype_name": "AdditionalResourceDetailsForFinopsBillingAzureAdvisor"}, {"subtype_model": "AdditionalResourceDetailsForFinopsUtilizationAzureAdvisor", "subtype_name": "AdditionalResourceDetailsForFinopsUtilizationAzureAdvisor"}, {"subtype_model": "AdditionalResourceDetailsForFinopsGovernanceSystem", "subtype_name": "AdditionalResourceDetailsForFinopsGovernanceSystem"}, {"subtype_model": "AdditionalResourceDetailsForFinopsTagsSystem", "subtype_name": "AdditionalResourceDetailsForFinopsTagsSystem"}, {"subtype_model": "AdditionalResourceDetailsForFinopsUnderUtilizedAwsComputeOptimizer", "subtype_name": "AdditionalResourceDetailsForFinopsUnderUtilizedAwsComputeOptimizer"}, {"subtype_model": "AdditionalResourceDetailsForFinopsIdleAwsAdvisor", "subtype_name": "AdditionalResourceDetailsForFinopsIdleAwsAdvisor"}, {"subtype_model": "AdditionalResourceDetailsForFinopsOptimizedAwsAdvisor", "subtype_name": "AdditionalResourceDetailsForFinopsOptimizedAwsAdvisor"}, {"subtype_model": "AdditionalResourceDetailsForFinopsUtilizationAdvisor", "subtype_name": "AdditionalResourceDetailsForFinopsUtilizationAdvisor"}, {"subtype_model": "AdditionalResourceDetailsForFinopsConfigAdvisor", "subtype_name": "AdditionalResourceDetailsForFinopsConfigAdvisor"}, {"subtype_model": "AdditionalResourceDetailsForFinopsCustomBilling", "subtype_name": "AdditionalResourceDetailsForFinopsCustomBilling"}]}, "AdditionalResourceDetailsForFinopsBillingAzureAdvisor": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsForFinopsReservationRecommendations"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsBillingAzureAdvisor"}, "AdditionalResourceDetailsForFinopsBudgetSystem": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {"resource_id": {"type": "string", "description": "Resource Id"}, "actual_cost": {"type": "number", "description": "Actual Cost"}, "forecast_cost": {"type": "number", "description": "ForeCast Cost"}, "budget_cost": {"type": "number", "description": "Budget Cost"}, "scope": {"type": "string", "description": "budget scope"}, "budget_type": {"type": "string", "description": "type of the budget"}, "percentage": {"type": "number", "description": "Percentage diff"}}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsBudgetSystem"}, "AdditionalResourceDetailsForFinopsConfigAdvisor": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsConfigAdvisor"}, "AdditionalResourceDetailsForFinopsCustomBilling": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {"resource_id": {"type": "string", "description": "Resource Id"}, "resource_name": {"type": "string", "description": "Resource Name"}, "quantity": {"type": "integer", "description": "Quantity"}, "term": {"type": "string", "description": "Term for the resource"}, "lookback_period": {"type": "number", "description": "Lookback period in days"}, "region": {"type": "string", "description": "Region Name"}}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsCustomBilling"}, "AdditionalResourceDetailsForFinopsGovernanceSystem": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsForFinopsReservationRecommendations"}, {"properties": {"savings_percentage": {"type": "number", "description": "percentage of savings"}}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsGovernanceSystem"}, "AdditionalResourceDetailsForFinopsIdleAwsAdvisor": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {"lookback_period": {"type": "string", "description": "LookBack Period in days"}, "reason": {"type": "string", "description": "Reason"}, "snapshot_id": {"type": "string", "description": "Snapshot ID"}}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsIdleAwsAdvisor"}, "AdditionalResourceDetailsForFinopsOptimizedAwsAdvisor": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {"recommended_number_of_purchase": {"type": "string", "description": "Number of reservation recommended to purchase"}, "expected_average_reserved_resource_utilization": {"type": "string", "description": "Expected_Average_Reserved_Resource_Utilization"}, "estimated_break_even_months": {"type": "string", "description": "Estimated_Break_Even_Months"}, "lookback_period_in_years": {"type": "string", "description": "LookBack_Period_In_Years"}, "term_in_years": {"type": "string", "description": "Term_In_Years"}}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsOptimizedAwsAdvisor"}, "AdditionalResourceDetailsForFinopsReservationRecommendations": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {"resource_id": {"type": "string", "description": "Resource Id"}, "term": {"type": "number", "description": "Term for reservation recommendation"}, "recommendation_id": {"type": "string", "description": "sys id for the cloud native recommendation"}, "location": {"type": "string", "description": "region name"}, "lookback_period": {"type": "number", "description": "lookback period in days"}}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsReservationRecommendations"}, "AdditionalResourceDetailsForFinopsTagsSystem": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {"resource_id": {"type": "string", "description": "Resource Id"}, "tagged_cost": {"type": "number", "description": "total cost which has been tagged"}, "untagged_cost": {"type": "number", "description": "total cost which has been untagged"}}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsTagsSystem"}, "AdditionalResourceDetailsForFinopsUnderUtilizedAwsComputeOptimizer": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsUnderUtilizedAwsComputeOptimizer"}, "AdditionalResourceDetailsForFinopsUtilizationAdvisor": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsBase"}, {"properties": {"scope": {"type": "string", "description": "Scope of the reservation"}, "sku": {"type": "string", "description": "sku name"}, "term": {"type": "string", "description": "term name"}, "quantity": {"type": "string", "description": "Quantity"}, "region": {"type": "string", "description": "Region Name"}, "display_quantity": {"type": "string", "description": "Display Quantity"}, "display_sku": {"type": "string", "description": "Display SKU"}, "lookback_period": {"type": "string", "description": "LookBack Period in days"}}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsUtilizationAdvisor"}, "AdditionalResourceDetailsForFinopsUtilizationAzureAdvisor": {"allOf": [{"$ref": "#/definitions/AdditionalResourceDetailsForFinopsReservationRecommendations"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AdditionalResourceDetailsForFinopsUtilizationAzureAdvisor"}, "AgentActionConfirmRequest": {"required": ["action_id", "chat_id", "status"], "properties": {"action_id": {"type": "string", "description": "ID of the pending action"}, "chat_id": {"type": "string", "description": "ID of the chat"}, "status": {"type": "string", "description": "Confirm or deny the pending action", "example": "confirm", "enum": ["confirm", "deny"], "x-cs-enum-type": "AgentActionStatus"}, "form_data": {"type": "object", "description": "User-submitted form data; required when status is 'confirm'"}}, "type": "object"}, "AgentChartData": {"properties": {"types": {"type": "array", "description": "Type of the charts", "items": {"type": "string", "description": "Chart type to display data", "example": "Bar", "enum": ["Bar", "Column", "GroupedColumn", "StackedColumn", "Pie", "Donut", "TreeMap", "Line", "Flow", "Map", "Network", "Sunburst", "Datatable", "Sankey", "HeatMap", "Hierarchy", "Bubble", "Area", "Waterfall"], "x-cs-enum-type": "ChartType"}}, "title": {"type": "string", "description": "Title of the chart"}, "sub_title": {"type": "string", "description": "Sub Title of the chart"}, "x_axis": {"description": "X Axis of the chat", "$ref": "#/definitions/AgentChatAxis"}, "y_axis": {"description": "Y Axis of the chat", "$ref": "#/definitions/AgentChatAxis"}, "group_by": {"description": "Group by of the chart", "$ref": "#/definitions/AgentChartGroupBy"}, "data": {"type": "object", "description": "Data of the chat"}}, "type": "object"}, "AgentChartGroupBy": {"allOf": [{"$ref": "#/definitions/AgentChatAxis"}, {"properties": {"color": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}]}, "AgentChat": {"allOf": [{"$ref": "#/definitions/AgentFieldsBase"}, {"properties": {"name": {"type": "string", "description": "Name of the chat"}, "created_by": {"type": "string", "description": "Name of the user who created the chat."}, "agent_id": {"type": "string", "description": "ID of the agent", "x-cs-type": "ObjectId"}, "tenant_id": {"type": "string", "description": "ID of the tenant", "x-cs-type": "ObjectId"}, "metadata": {"description": "Metadata for the chat", "$ref": "#/definitions/ChatMetadata"}}, "type": "object"}]}, "AgentChatAxis": {"properties": {"identifier": {"type": "string", "description": "Identifier of the axis value."}, "label": {"type": "string", "description": "Label of the axis."}}, "type": "object"}, "AgentChatBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AgentChat"}}}, "type": "object"}, "AgentChatDelete": {"properties": {"status": {"type": "boolean", "description": "Indicates if the chat is deleted"}}, "type": "object"}, "AgentChatDeleteRequest": {"properties": {"chat_ids": {"type": "array", "description": "List of chat IDs to be deleted", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "tenant_id": {"type": "string", "description": "ID of the tenant", "x-cs-type": "ObjectId"}}, "type": "object"}, "AgentChatDeleteResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AgentChatDelete"}}}, "type": "object"}, "AgentChatFilter": {"required": ["agent_id", "tenant_id"], "properties": {"agent_id": {"type": "string", "description": "ID of the agent type", "x-cs-type": "ObjectId"}, "tenant_id": {"type": "string", "description": "ID of the tenant", "x-cs-type": "ObjectId"}, "name": {"type": "string", "description": "Name of the chat"}}, "type": "object"}, "AgentChatSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedAt", "UpdatedAt"], "x-cs-enum-type": "AgentChatSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AgentChatUpdateRequest": {"properties": {"name": {"type": "string", "description": "Name of the chat"}}, "type": "object"}, "AgentCreateChatRequest": {"properties": {"name": {"type": "string", "description": "Name of the chat"}, "agent_id": {"type": "string", "description": "ID of the agent", "x-cs-type": "ObjectId"}, "tenant_id": {"type": "string", "description": "ID of the tenant", "x-cs-type": "ObjectId"}}, "type": "object"}, "AgentFieldsBase": {"properties": {"sys_id": {"type": "string", "description": "Unique identifier for the document", "x-cs-type": "ObjectId"}, "created_at": {"type": "string", "format": "date-time", "description": "Timestamp when the document was created"}, "updated_at": {"type": "string", "format": "date-time", "description": "Timestamp when the document was last updated"}}, "type": "object"}, "AgentListChatRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AgentChatSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AgentChatFilter"}}, "type": "object"}, "AgentListChatResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "AgentPromptSuggestionResponse": {"properties": {"suggested_prompts": {"type": "array", "description": "List of suggested prompts", "items": {"type": "string"}}}, "type": "object"}, "AgentResponse": {"properties": {"response": {"type": "array", "description": "Response from the agent", "items": {"$ref": "#/definitions/BaseForAgentResponse"}}, "status": {"type": "string", "description": "Status of the response", "example": "failed", "enum": ["failed", "in_progress", "success"], "x-cs-enum-type": "AgentResponseStatus"}}, "type": "object"}, "AgentStreamingResponse": {"properties": {"type": {"type": "string", "description": "Type of the streaming data"}, "data": {"type": "object", "description": "Streaming data either progress data or response data"}}, "type": "object"}, "AgentTableData": {"properties": {"headers": {"type": "array", "description": "Headers of the table.", "items": {"type": "string"}}, "rows": {"type": "object", "description": "Rows of the table."}}, "type": "object"}, "AgentType": {"allOf": [{"$ref": "#/definitions/AgentFieldsBase"}, {"properties": {"name": {"type": "string", "description": "AI agents available in the system", "example": "Assessment Agent", "enum": ["Assessment Agent", "Graphion Agent", "Rate Optimization Agent"], "x-cs-enum-type": "Agents"}, "is_enabled": {"type": "boolean", "description": "Is the agent type enabled"}}, "type": "object"}]}, "AgentTypeResponse": {"properties": {"agent_types": {"type": "array", "description": "List of agent types", "items": {"$ref": "#/definitions/AgentType"}}}, "type": "object"}, "AggregateMetricsBase": {"properties": {"metric_name": {"type": "string", "description": "Name of the metric"}, "model_name": {"type": "string", "description": "Name of the model"}, "model_type": {"type": "string", "description": "Type of the model"}, "resource_category": {"type": "string", "description": "Category of the resource"}, "unit": {"type": "string", "description": "unit of measures"}}, "type": "object"}, "AggregatedMetricsResponse": {"allOf": [{"$ref": "#/definitions/AggregateMetricsBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service account identifier", "x-cs-type": "ObjectId"}, "quantity": {"type": "integer", "description": "Quantity"}, "timestamps": {"type": "array", "description": "timestamps", "items": {"type": "string", "format": "date-time"}}, "values": {"type": "array", "description": "List of metric values", "items": {"type": "number"}}}, "type": "object"}]}, "AiAgentChartConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AiAgentChartConfiguration"}, "AiAgentDataTableConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AiAgentDataTableConfiguration"}, "AiAgentFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"aiag_2602_b_mcp": {"type": "boolean", "description": "Flag's default value", "default": false}, "aiag_2603_b_concierge": {"type": "boolean", "description": "Flag's default value", "default": true}, "aiag_2504_f_test_flag": {"type": "boolean", "description": "Flag's default value", "default": false}, "aiag_2603_f_portfolio_health_dashboard": {"type": "boolean", "description": "Flag's default value", "default": true}, "aiag_2603_f_waste_analysis_dashboard": {"type": "boolean", "description": "Flag's default value", "default": true}, "aiag_2603_f_expiry_renewal_dashboard": {"type": "boolean", "description": "Flag's default value", "default": true}}, "type": "object"}]}, "AiAgentReport": {"properties": {"sys_id": {"type": "string", "description": "Unique ID for the report"}, "background_job": {"description": "Identity of the background job used to generate the report, null if the job has completed", "$ref": "#/definitions/RecordIdentity"}, "attachment_id": {"type": "string", "description": "ID of the attachment where the report contents are stored."}}, "type": "object"}, "AiAgentReportCreateRequest": {"properties": {"configuration": {"description": "Report configuration to generate report", "$ref": "#/definitions/ReportConfigurationForAiAgent"}}, "type": "object"}, "AiAgentScheduleRequest": {"allOf": [{"$ref": "#/definitions/AiAgentScheduleRequestBase"}, {"required": ["created_by", "email_recipients", "report_type", "schedule_id"], "properties": {"created_by": {"type": "string", "description": "User ID of user who scheduled the report"}, "schedule_id": {"type": "string", "description": "Schedule ID of which the report to be generated", "x-cs-type": "ObjectId"}, "email_recipients": {"type": "array", "description": "List of Email IDs for which the scheduled report will be sent.", "items": {"type": "string"}}, "report_type": {"type": "string", "description": "AI agentic feed Report type", "example": "assessments", "enum": ["assessments", "workload", "rate_optimization", "waste_analysis", "expiry_dashboard"], "x-cs-enum-type": "AiAgenticFeedReportType"}}, "type": "object"}], "x-cs-type-name": "AiAgentScheduleRequest"}, "AiAgentScheduleRequestBase": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "AiAgentScheduleRequest", "subtype_name": "AiAgentScheduleRequest"}, {"subtype_model": "AssessmentAgentScheduleRequest", "subtype_name": "AssessmentAgentScheduleRequest"}]}, "AiAgenticInsightsConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AiAgenticInsightsConfiguration"}, "AiFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"ai_2504_b_master_data_sync": {"type": "boolean", "description": "Flag's default value", "default": false}, "ai_2602_b_release_impact_analysis": {"type": "boolean", "description": "Flag's default value", "default": false}}, "type": "object"}]}, "AlertActionRequest": {"properties": {"alert_ids": {"type": "array", "description": "Inventory Ids of the Alert Rules", "items": {"type": "string"}}}, "type": "object"}, "AlertNotificationDetailsModel": {"required": ["is_template", "name", "notification_details", "notification_uri"], "properties": {"name": {"type": "string", "description": "notification name"}, "notification_uri": {"type": "string", "description": "notification name"}, "is_template": {"type": "boolean", "description": "notification name"}, "notification_details": {"type": "array", "description": "Notification Details", "items": {"$ref": "#/definitions/NotificationDetailsModel"}}}, "type": "object"}, "AllFeatureFlags": {"properties": {"release_flags": {"type": "string", "description": "Release Feature Flags", "example": "release_2504", "enum": ["release_2504", "release_2601", "release_2602", "release_2603"], "x-cs-enum-type": "ReleaseFlags"}, "ai_feature_flags": {"type": "string", "description": "AI Feature Flags", "example": "ai_2504_b_master_data_sync", "enum": ["ai_2504_b_master_data_sync", "ai_2602_b_release_impact_analysis"], "x-cs-enum-type": "AIFeatureFlags"}, "ai_agent_feature_flags": {"type": "string", "description": "AI Agent Feature Flags", "example": "aiag_2602_b_mcp", "enum": ["aiag_2602_b_mcp", "aiag_2603_b_concierge", "aiag_2504_f_test_flag", "aiag_2603_f_portfolio_health_dashboard", "aiag_2603_f_waste_analysis_dashboard", "aiag_2603_f_expiry_renewal_dashboard"], "x-cs-enum-type": "AIAgentFeatureFlags"}, "broker_feature_flags": {"type": "string", "description": "Broker Feature Flags", "example": "br_2504_a_test_flag", "enum": ["br_2504_a_test_flag"], "x-cs-enum-type": "BrokerFeatureFlags"}, "compliance_feature_flags": {"type": "string", "description": "Compliance Feature Flags", "example": "comp_2504_a_test_flag", "enum": ["comp_2504_a_test_flag", "comp_2603_a_compliance_standard_simplified"], "x-cs-enum-type": "ComplianceFeatureFlags"}, "cost_feature_flags": {"type": "string", "description": "Cost Feature Flags", "example": "cost_2601_f_budget_trend_widget", "enum": ["cost_2601_f_budget_trend_widget", "cost_2601_a_limit_tags_in_cost_processing", "cost_2601_b_flush_balance_verification", "cost_2504_b_trend_observability", "cost_2602_f_cost_trend_hide_variance", "cost_2602_a_billing_inventory_resource_tags", "cost_2602_f_oci_compartment_based_cost_121002", "cost_2602_b_dimension_grouping_rule_conflict_resolution_119664", "cost_2602_f_summary_cloud_plus_k8_cost_spend_widget", "cost_2602_b_savings_plans_external_api"], "x-cs-enum-type": "CostFeatureFlags"}, "governance_feature_flags": {"type": "string", "description": "Governance Feature Flags", "example": "govn_2504_a_test_flag", "enum": ["govn_2504_a_test_flag"], "x-cs-enum-type": "GovernanceFeatureFlags"}, "heatstack_feature_flags": {"type": "string", "description": "Heatstack Feature Flags", "example": "heat_2601_a_cost_rate_optimization", "enum": ["heat_2601_a_cost_rate_optimization", "heat_2601_a_azure_aks_cluster", "heat_2601_a_google_gke_cluster", "heat_2602_a_master_account_policy_config", "heat_2603_b_ai_observability_119985"], "x-cs-enum-type": "HeatstackFeatureFlags"}, "identity_feature_flags": {"type": "string", "description": "Identity Feature Flags", "example": "iden_2601_f_csp_blob_storage_cost_discovery", "enum": ["iden_2601_f_csp_blob_storage_cost_discovery", "iden_2601_a_scim_2_0_provisioning", "iden_2603_f_tenant_rename_enabled", "iden_2603_a_saved_views"], "x-cs-enum-type": "IdentityFeatureFlags"}, "operations_governance_feature_flags": {"type": "string", "description": "Operations Governance Feature Flags", "example": "opgn_2504_a_test_flag", "enum": ["opgn_2504_a_test_flag"], "x-cs-enum-type": "OperationsGovernanceFeatureFlags"}, "others_feature_flags": {"type": "string", "description": "Others Feature Flags", "example": "othr_2601_b_vpa_scaling", "enum": ["othr_2601_b_vpa_scaling", "othr_2602_b_vpa_scaling_for_cost", "othr_2602_b_vpa_scaling_for_corestack_identity", "othr_2602_b_vpa_scaling_for_heatstack"], "x-cs-enum-type": "OthersFeatureFlags"}, "report_generation_feature_flags": {"type": "string", "description": "Report Generation Feature Flags", "example": "regn_2504_a_test_flag", "enum": ["regn_2504_a_test_flag"], "x-cs-enum-type": "ReportGenerationFeatureFlags"}, "reports_feature_flags": {"type": "string", "description": "Report Generation Feature Flags", "example": "rept_2504_f_test_flag", "enum": ["rept_2504_f_test_flag"], "x-cs-enum-type": "ReportsFeatureFlags"}, "resource_inventory_feature_flags": {"type": "string", "description": "Resource Inventory Feature Flags", "example": "rein_2504_a_test_flag", "enum": ["rein_2504_a_test_flag", "rein_2601_b_resource_changes_trend", "rein_2602_a_resource_detail_view"], "x-cs-enum-type": "ResourceInventoryFeatureFlags"}, "security_governance_feature_flags": {"type": "string", "description": "Security Governance Feature Flags", "example": "segn_2601_b_security_issues_point_in_time", "enum": ["segn_2601_b_security_issues_point_in_time", "segn_2601_b_security_issues_trend", "segn_2602_a_resource_detail_view", "segn_2602_a_application_with_bcs_questions", "segn_2603_a_application_to_workload"], "x-cs-enum-type": "SecurityGovernanceFeatureFlags"}, "ui_feature_flags": {"type": "string", "description": "Ui Feature Flags", "example": "ui_2601_f_infra_dashboard_vulnerbility_explorer", "enum": ["ui_2601_f_infra_dashboard_vulnerbility_explorer", "ui_2601_f_infra_dashboard_threats_explorer", "ui_2601_f_infra_dashboard_misconfigurations_explorer", "ui_2601_f_infra_dashboard_open_issues_trend", "ui_2601_f_infra_dashboard_by_severity_by_account", "ui_2601_f_infra_dashboard_by_resource_category", "ui_2601_f_infra_dashboard_by_inventory_overview", "ui_2601_f_infra_dashboard_resource_issues_flow", "ui_2601_f_infra_dashboard_by_region", "ui_2601_f_widget_filter_lazy_select", "ui_2602_f_lazy_dropdown_select", "ui_2602_f_dimension_creation_wizard", "ui_2602_f_infra_dashboard_enable_workload_filter", "ui_2602_f_widget_lazy_sa", "ui_2602_f_t2_data_time_range_presets", "ui_2603_f_ai_observability_119985", "ui_2603_f_remediation_explorer"], "x-cs-enum-type": "UiFeatureFlags"}}, "type": "object"}, "AllocationCloudTarget": {"allOf": [{"$ref": "#/definitions/AllocationServiceAccountTarget"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AllocationCloudTarget"}, "AllocationDimensionGroupingTarget": {"allOf": [{"$ref": "#/definitions/AllocationDimensionTarget"}, {"required": ["grouping_rule_id", "grouping_rule_name"], "properties": {"grouping_rule_id": {"type": "string"}, "grouping_rule_name": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "AllocationDimensionGroupingTarget"}, "AllocationDimensionTarget": {"allOf": [{"$ref": "#/definitions/AllocationTarget"}, {"required": ["dimension_id", "dimension_name", "tenant_id"], "properties": {"tenant_id": {"type": "string", "x-cs-type": "ObjectId"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "dimension_id": {"type": "string"}, "dimension_name": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "AllocationDimensionTarget"}, "AllocationPercentageTarget": {"properties": {"target": {"description": "Target to allocate the cost to", "$ref": "#/definitions/AllocationTarget"}, "percentage": {"type": "number", "description": "Percentage of the cost to allocate to the target"}}, "type": "object"}, "AllocationServiceAccountTarget": {"allOf": [{"$ref": "#/definitions/AllocationTarget"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "AllocationServiceAccountTarget"}, "AllocationTarget": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "AllocationServiceAccountTarget", "subtype_name": "AllocationServiceAccountTarget"}, {"subtype_model": "AllocationCloudTarget", "subtype_name": "AllocationCloudTarget"}, {"subtype_model": "AllocationDimensionTarget", "subtype_name": "AllocationDimensionTarget"}, {"subtype_model": "AllocationDimensionGroupingTarget", "subtype_name": "AllocationDimensionGroupingTarget"}]}, "AppInsightsActionableRecommendationsWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AppInsightsActionableRecommendationsWidgetConfiguration"}, "AppSecOpsVulnerabilityByRegionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AppSecOpsVulnerabilityByRegionWidgetConfiguration"}, "AppSecopsApplication": {"allOf": [{"$ref": "#/definitions/AppSecopsApplicationBase"}, {"properties": {"application_id": {"type": "string", "description": "Application ID", "x-cs-type": "ObjectId"}, "created_at": {"type": "string", "format": "date-time", "description": "Application created time"}, "created_by": {"type": "string", "description": "Name of the user who created the application"}, "updated_by": {"type": "string", "description": "Name of the user who recently updated the application"}, "updated_at": {"type": "string", "format": "date-time", "description": "Application recently updated time"}}, "type": "object"}]}, "AppSecopsApplicationBCSInfo": {"properties": {"application_id": {"type": "string", "description": "Application ID", "x-cs-type": "ObjectId"}, "bcs_version": {"type": "integer", "description": "BCS question config version"}, "bcs_details": {"description": "Current BCS submission", "$ref": "#/definitions/AppSecopsApplicationV2BCSDetail"}}, "type": "object"}, "AppSecopsApplicationBase": {"required": ["business_criticality", "name", "owner", "portfolio_id", "tenant_id"], "properties": {"name": {"type": "string", "description": "Name of the application"}, "owner": {"type": "array", "description": "Owners of the application", "items": {"type": "string"}}, "business_criticality": {"type": "number", "description": "Indicates the application's importance to the business in terms of criticality."}, "description": {"type": "string", "description": "Description of the application"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "portfolio_id": {"type": "string", "description": "Portfolio to which the application belongs.", "x-cs-type": "ObjectId"}, "dev_tool": {"type": "string", "description": "Application Deployed DevTool", "example": "Jenkins", "enum": ["Jenkins", "GitLab", "Git", "Azure DevOps", "CircleCI", "Bamboo"], "x-cs-enum-type": "DevToolName"}, "service_name": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "GCP", "OCI"], "x-cs-enum-type": "AppSecopsApplicationCloudProvider"}, "tags": {"type": "array", "items": {"$ref": "#/definitions/KeyValuePair"}}, "workload_ids": {"type": "array", "description": "List of workload ids to which the application belongs.", "items": {"type": "string"}}}, "type": "object"}, "AppSecopsApplicationBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AppSecopsApplication"}}}, "type": "object"}, "AppSecopsApplicationFilterBase": {"allOf": [{"$ref": "#/definitions/AppSecopsFilterBase"}, {"properties": {"owner": {"type": "array", "description": "Owner of the Portfolio", "items": {"type": "string"}}, "portfolio_ids": {"type": "array", "description": "ID of the portfolios to which the application belongs.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "portfolio_names": {"type": "array", "description": "Name of the portfolios to which the application belongs.", "items": {"type": "string"}}, "appsecops_project_ids": {"type": "array", "description": "ID of the appsecops project to which the application belongs.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "appsecops_project_names": {"type": "array", "description": "Name of the appsecops project to which the application belongs.", "items": {"type": "string"}}, "search": {"type": "string", "description": "Search based on name, description and owner"}}, "type": "object"}]}, "AppSecopsApplicationIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["application_ids"], "properties": {"application_ids": {"type": "array", "description": "Application IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsApplicationIdQueryOperator"}, "AppSecopsApplicationListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AppSecopsApplicationSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AppSecopsApplicationFilterBase"}}, "type": "object"}, "AppSecopsApplicationRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsApplicationBase"}, {"properties": {}, "type": "object"}]}, "AppSecopsApplicationResponse": {"allOf": [{"$ref": "#/definitions/AppSecopsApplication"}, {"properties": {}, "type": "object"}]}, "AppSecopsApplicationSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "name", "enum": ["name", "business_criticality", "dev_tool", "service_name", "updated_at"], "x-cs-enum-type": "AppSecopsApplicationSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AppSecopsApplicationV2": {"allOf": [{"$ref": "#/definitions/AppSecopsApplication"}, {"properties": {"bcs_details": {"$ref": "#/definitions/AppSecopsApplicationV2BCSDetail"}, "bcs_history": {"type": "array", "description": "Prior BCS submissions", "items": {"$ref": "#/definitions/AppSecopsApplicationV2BCSDetail"}}}, "type": "object"}]}, "AppSecopsApplicationV2BCSDetail": {"properties": {"score": {"type": "number", "description": "BCS score (20-100)"}, "bcs_question_version": {"type": "integer", "description": "BCS questions config version"}, "version": {"type": "integer", "description": "Submission version"}, "selected": {"type": "array", "description": "Submitted answers", "items": {"$ref": "#/definitions/AppSecopsApplicationV2BCSSelectedItem"}}, "created_at": {"type": "string", "format": "date-time", "description": "When this submission was created"}, "created_by": {"type": "string", "description": "Name of the user who created the submission"}}, "type": "object"}, "AppSecopsApplicationV2BCSSelectedItem": {"required": ["question_id"], "properties": {"question_id": {"type": "string", "description": "Question ID"}, "options": {"type": "array", "description": "Selected option IDs", "items": {"type": "string"}}}, "type": "object"}, "AppSecopsApplicationV2Request": {"allOf": [{"$ref": "#/definitions/AppSecopsApplication"}, {"required": ["selected"], "properties": {"selected": {"type": "array", "description": "BCS questionnaire answers", "items": {"$ref": "#/definitions/AppSecopsApplicationV2BCSSelectedItem"}}}, "type": "object"}]}, "AppSecopsBCSQuestion": {"properties": {"id": {"type": "string", "description": "Question ID"}, "order": {"type": "integer", "description": "Display order"}, "title": {"type": "string", "description": "Short title"}, "question": {"type": "string", "description": "Full question text"}, "description": {"type": "string", "description": "Additional info"}, "options": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsBCSQuestionOption"}}, "default_weight": {"type": "integer", "description": "Default weight"}, "weight": {"type": "integer", "description": "Effective weight (tenant override of default_weight)"}, "multi_select": {"type": "boolean", "description": "Whether this question allows multiple option selections (Q6)"}, "inverted": {"type": "boolean", "description": "Whether lower answer value means higher criticality (Q9, Q10)"}}, "type": "object"}, "AppSecopsBCSQuestionOption": {"properties": {"id": {"type": "string", "description": "Option ID"}, "label": {"type": "string", "description": "Option label"}, "value": {"type": "integer", "description": "Answer value for scoring"}, "is_none": {"type": "boolean", "description": "Mutually exclusive None option (Q6)"}, "high_tier": {"type": "boolean", "description": "High-tier regulatory framework flag (Q6)"}, "prefill_q5a": {"type": "boolean", "description": "Whether selecting this option pre-fills Q5a to High (Q11)"}}, "type": "object"}, "AppSecopsBCSQuestionsAnswerItem": {"required": ["question_id", "weight"], "properties": {"question_id": {"type": "string", "description": "Question ID"}, "weight": {"type": "integer", "description": "Question weight (0-100)"}}, "type": "object"}, "AppSecopsBCSQuestionsAnswers": {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "version": {"type": "integer", "description": "Version number"}, "answers": {"type": "array", "description": "Slim weight entries [{id, weight}]", "items": {"$ref": "#/definitions/AppSecopsBCSQuestionsAnswerItem"}}, "created_at": {"type": "string", "format": "date-time", "description": "When this version was created"}, "created_by": {"type": "string", "description": "Who created this version"}}, "type": "object"}, "AppSecopsBCSQuestionsAnswersHistoryRequest": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "list_context": {"description": "Pagination context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "AppSecopsBCSQuestionsAnswersHistoryResponse": {"properties": {"items": {"type": "array", "description": "List of resources matching the trend criteria.", "items": {"$ref": "#/definitions/AppSecopsBCSQuestionsAnswers"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "AppSecopsBCSQuestionsAnswersVersionRequest": {"required": ["answers", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "answers": {"type": "array", "description": "All question weights; must sum to 100", "items": {"$ref": "#/definitions/AppSecopsBCSQuestionsAnswerItem"}}}, "type": "object"}, "AppSecopsBCSQuestionsSeedRequest": {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}}, "type": "object"}, "AppSecopsComponentProductQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["products"], "properties": {"products": {"type": "array", "description": "Component product(s)to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsComponentProductQueryOperator"}, "AppSecopsComponentReference": {"properties": {"sbom_version_id": {"type": "string", "description": "SBOM reference", "x-cs-type": "ObjectId"}, "component_ids": {"type": "array", "description": "List of IDs used to refer to the component elsewhere in the BOM.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AppSecopsContainerFindingsCategoryQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["categories"], "properties": {"categories": {"type": "array", "description": "Finding category to include", "items": {"type": "string", "description": "Finding category", "example": "Misconfiguration", "enum": ["Misconfiguration", "Vulnerability", "Threat"], "x-cs-enum-type": "SecurityFindingsCategory"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsContainerFindingsCategoryQueryOperator"}, "AppSecopsContainerFindingsExecutionPhaseQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["execution_phases"], "properties": {"execution_phases": {"type": "array", "description": "Finding execution phase to include", "items": {"type": "string", "description": "Execution phase seen for security findings", "example": "Build", "enum": ["Build", "Runtime"], "x-cs-enum-type": "SecurityFindingsExecutionPhase"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsContainerFindingsExecutionPhaseQueryOperator"}, "AppSecopsContainerFindingsSBOMVersionIdsQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["sbom_version_ids"], "properties": {"sbom_version_ids": {"type": "array", "description": "SBOM version IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsContainerFindingsSBOMVersionIdsQueryOperator"}, "AppSecopsContainerFindingsSeverityQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["severities"], "properties": {"severities": {"type": "array", "description": "Finding severity to include", "items": {"type": "string", "description": "Security findings severity level", "example": "critical", "enum": ["critical", "high", "medium", "low", "informational", "none"], "x-cs-enum-type": "SecurityFindingsSeverity"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsContainerFindingsSeverityQueryOperator"}, "AppSecopsContainerFindingsStatusQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["statuses"], "properties": {"statuses": {"type": "array", "description": "Finding status to include", "items": {"type": "string", "description": "Security findings status", "example": "open", "enum": ["open", "resolved"], "x-cs-enum-type": "SecurityFindingsStatus"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsContainerFindingsStatusQueryOperator"}, "AppSecopsCveIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["cve_id"], "properties": {"cve_id": {"type": "array", "description": "CVE identifier associated with the vulnerability", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsCveIdQueryOperator"}, "AppSecopsCvssScoreQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"cvss_score": {"type": "number", "description": "EPSS score associated with the vulnerability"}}, "type": "object"}], "x-cs-type-name": "AppSecopsCvssScoreQueryOperator"}, "AppSecopsDashboardApplicationDetails": {"allOf": [{"$ref": "#/definitions/AppSecopsApplication"}, {"properties": {"projects": {"type": "array", "description": "Project details associated with the application", "items": {"$ref": "#/definitions/AppSecopsProject"}}}, "type": "object"}]}, "AppSecopsDashboardInsights": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "AppSecopsInsightsTopActionableVulnerability", "subtype_name": "AppSecopsInsightsTopActionableVulnerability"}]}, "AppSecopsDashboardRequestBase": {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "List of tenant IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AppSecopsEntityType": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-type-name": "AppSecopsEntityType", "x-cs-subtypes": [{"subtype_model": "AppSecopsEntityTypeForApplicationChange", "subtype_name": "AppSecopsEntityTypeForApplicationChange"}, {"subtype_model": "AppSecopsEntityTypeForProjectChange", "subtype_name": "AppSecopsEntityTypeForProjectChange"}]}, "AppSecopsEntityTypeForApplicationChange": {"allOf": [{"$ref": "#/definitions/AppSecopsEntityType"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AppSecopsEntityTypeForApplicationChange"}, "AppSecopsEntityTypeForProjectChange": {"allOf": [{"$ref": "#/definitions/AppSecopsEntityType"}, {"required": ["existing_application_ids"], "properties": {"existing_application_ids": {"type": "array", "description": "List of existing application IDs to be updated. Required for Appsecops project update", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsEntityTypeForProjectChange"}, "AppSecopsEpssScoreQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"epss_score": {"type": "number", "description": "EPSS score associated with the vulnerability"}}, "type": "object"}], "x-cs-type-name": "AppSecopsEpssScoreQueryOperator"}, "AppSecopsExternalReferenceDetail": {"properties": {"url": {"type": "string", "description": "External reference URL"}, "name": {"type": "string", "description": "Name of the external reference"}, "type": {"type": "string", "description": "Type of reference (e.g., advisory, report, fix)"}, "source": {"type": "string", "description": "Source of the external reference"}}, "type": "object"}, "AppSecopsFilter": {"allOf": [{"$ref": "#/definitions/AppSecopsDashboardRequestBase"}, {"properties": {"filters": {"description": "Query based on Tenant ID, Application ID, Portfolio ID, Project ID and SBOM references", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}]}, "AppSecopsFilterBase": {"required": ["tenant_id"], "properties": {"name": {"type": "array", "description": "Name of the portfolio/application/project", "items": {"type": "string"}}, "tags": {"type": "array", "description": "Tags for Portfolio/Application/project", "items": {"$ref": "#/definitions/KeyValuePair"}}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}}, "type": "object"}, "AppSecopsFixAvailableQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"fix_available": {"type": "boolean", "description": "Indicates if the component has a fix available to include"}}, "type": "object"}], "x-cs-type-name": "AppSecopsFixAvailableQueryOperator"}, "AppSecopsGraphionScoreQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"graphion_score": {"type": "number", "description": "Graphion score associated with the vulnerability"}}, "type": "object"}], "x-cs-type-name": "AppSecopsGraphionScoreQueryOperator"}, "AppSecopsIngestContainerFindingsRequest": {"required": ["container_findings", "sbom_version_id", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Unique identifier of the tenant submitting the container security findings", "x-cs-type": "ObjectId"}, "sbom_version_id": {"type": "string", "description": "Unique identifier of the SBOM version to associate the container security findings with", "x-cs-type": "ObjectId"}, "container_findings": {"type": "array", "description": "List of container security findings to be ingested, each containing tool information and attachment reference", "items": {"$ref": "#/definitions/ContainerFindings"}}}, "type": "object"}, "AppSecopsInsightsTopActionableVulnerability": {"allOf": [{"$ref": "#/definitions/AppSecopsDashboardInsights"}, {"properties": {"aliases": {"type": "array", "description": "List of alternative identifiers for the vulnerability", "items": {"type": "string"}}, "application_ids": {"type": "array", "description": "List of application ID(s) to which the vulnerability is associated", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "appsecops_project_id": {"type": "array", "description": "List of project ID(s) to which the vulnerability is associated", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "component_type": {"type": "array", "description": "Component type associated with the vulnerability", "items": {"type": "string"}}, "cve_id": {"type": "string", "description": "CVE identifier associated with the vulnerability"}, "cvss_metric": {"$ref": "#/definitions/AppSecopsVulnerabilityCvssMetric"}, "description": {"type": "string", "description": "Description about the vulnerability"}, "cpe": {"type": "array", "description": "List of Common Platform Enumeration (CPE) identifier for the component", "items": {"type": "string"}}, "epss_score": {"type": "number", "description": "EPSS score indicating the likelihood of exploitation (0 to 1)"}, "components": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomVulnerabilityComponentDetail"}}, "is_kev": {"type": "string", "description": "Indicates whether the vulnerability is a Known Exploited Vulnerability (KEV)"}, "overall_risk_score": {"type": "number", "description": "Aggregated risk score representing the overall impact of the vulnerability, considering multiple risk factors."}, "product": {"type": "array", "description": "Product(s) associated with the vulnerability", "items": {"type": "string"}}, "portfolio_ids": {"type": "array", "description": "List of Portfolio ID(s) associated with the vulnerability", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "package_name": {"type": "array", "description": "Package name to which the vulnerability is associated", "items": {"type": "string"}}, "references": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsExternalReferenceDetail"}}, "sbom_version_ids": {"type": "array", "description": "List of Reference ID(s) to the SBOM used to detect vulnerabilities in software components", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "vulnerability_id": {"type": "string", "description": "Unique ID for the vulnerability", "x-cs-type": "ObjectId"}, "application_bcs_details": {"type": "array", "description": "BCS details per application associated with the vulnerability", "items": {"$ref": "#/definitions/AppSecopsApplicationBCSInfo"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsInsightsTopActionableVulnerability"}, "AppSecopsIsKnownExploitedVulnerabilityQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"is_kev": {"type": "boolean", "description": "Indicates if the component has a Known Exploited Vulnerability (KEV) to include"}}, "type": "object"}], "x-cs-type-name": "AppSecopsIsKnownExploitedVulnerabilityQueryOperator"}, "AppSecopsLicenseDetails": {"properties": {"name": {"type": "string", "description": "Unique identifier for the license"}, "terms": {"type": "string", "description": "Terms of the license"}}, "type": "object"}, "AppSecopsMappedResource": {"required": ["inventory_id", "mapping_type", "resource", "resource_category", "resource_id", "resource_type", "service_account_id"], "properties": {"mapping_type": {"type": "string", "description": "Type of Resource Mapping", "example": "automatic", "enum": ["automatic", "manual"], "x-cs-enum-type": "AppSecopsSbomResourceMappingType"}, "service_account_id": {"type": "string", "description": "ID of service account", "x-cs-type": "ObjectId"}, "resource_category": {"type": "string", "description": "Category of the mapped resource"}, "resource_type": {"type": "string", "description": "Type of the mapped resource"}, "resource": {"type": "string", "description": "Mapped resource"}, "inventory_id": {"type": "string", "description": "Service Resource Inventory ID", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "ID of the mapped resource"}, "resource_name": {"type": "string", "description": "Name of the mapped resource"}}, "type": "object"}, "AppSecopsOsvVulnerabilityAffectedDetails": {"properties": {"package": {"$ref": "#/definitions/AppSecopsOsvVulnerabilityAffectedPackageDetails"}, "ranges": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsOsvVulnerabilityVersionDetail"}}}, "type": "object"}, "AppSecopsOsvVulnerabilityAffectedPackageDetails": {"properties": {"name": {"type": "string", "description": "Name of the package"}, "ecosystem": {"type": "string", "description": "Ecosystem of the package"}, "purl": {"type": "string", "description": "Package URL"}}, "type": "object"}, "AppSecopsOsvVulnerabilityFixDetails": {"properties": {"fixed": {"type": "string", "description": "Version that fixed the vulnerability"}, "introduced": {"type": "string", "description": "Version that introduced the vulnerability"}, "last_affected": {"type": "string", "description": "Version that last affected the vulnerability"}, "limit": {"type": "string", "description": "Limit the vulnerability"}}, "type": "object"}, "AppSecopsOsvVulnerabilityVersionDetail": {"properties": {"events": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsOsvVulnerabilityFixDetails"}}, "type": {"type": "string"}}, "type": "object"}, "AppSecopsPortfolio": {"allOf": [{"$ref": "#/definitions/AppSecopsPortfolioBase"}, {"properties": {"created_at": {"type": "string", "format": "date-time", "description": "Portfolio created time"}, "created_by": {"type": "string", "description": "Name of the user who created the portfolio"}, "portfolio_id": {"type": "string", "description": "Portfolio ID", "x-cs-type": "ObjectId"}, "updated_by": {"type": "string", "description": "Name of the user who recently updated the portfolio"}, "updated_at": {"type": "string", "format": "date-time", "description": "Portfolio updated time"}}, "type": "object"}]}, "AppSecopsPortfolioBase": {"required": ["name", "owner", "tenant_id"], "properties": {"name": {"type": "string", "description": "Name of the portfolio"}, "description": {"type": "string", "description": "Portfolio description"}, "owner": {"type": "array", "description": "Owners of portfolio", "items": {"type": "string"}}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "tags": {"type": "array", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "AppSecopsPortfolioBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AppSecopsPortfolio"}}}, "type": "object"}, "AppSecopsPortfolioFilter": {"allOf": [{"$ref": "#/definitions/AppSecopsFilterBase"}, {"properties": {"owner": {"type": "array", "description": "Owner of the Portfolio", "items": {"type": "string"}}, "search": {"type": "string", "description": "Search based on name, description, owner"}}, "type": "object"}]}, "AppSecopsPortfolioHierarchyRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsDashboardRequestBase"}, {"properties": {}, "type": "object"}]}, "AppSecopsPortfolioHierarchyResponse": {"allOf": [{"$ref": "#/definitions/AppSecopsPortfolio"}, {"properties": {"applications": {"type": "array", "description": "The application details associated with the portfolio", "items": {"$ref": "#/definitions/AppSecopsDashboardApplicationDetails"}}}, "type": "object"}]}, "AppSecopsPortfolioIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["portfolio_ids"], "properties": {"portfolio_ids": {"type": "array", "description": "Portfolio IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsPortfolioIdQueryOperator"}, "AppSecopsPortfolioListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AppSecopsPortfolioSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AppSecopsPortfolioFilter"}}, "type": "object"}, "AppSecopsPortfolioRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsPortfolioBase"}, {"properties": {}, "type": "object"}]}, "AppSecopsPortfolioResponse": {"allOf": [{"$ref": "#/definitions/AppSecopsPortfolio"}, {"properties": {}, "type": "object"}]}, "AppSecopsPortfolioSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "name", "enum": ["name", "created_at", "updated_at"], "x-cs-enum-type": "AppSecopsPortfolioSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AppSecopsProject": {"allOf": [{"$ref": "#/definitions/AppSecopsProjectBase"}, {"properties": {"project_id": {"type": "string", "description": "Unique ID of the project", "x-cs-type": "ObjectId"}, "created_at": {"type": "string", "format": "date-time", "description": "Project created time"}, "created_by": {"type": "string", "description": "Name of the user who created a project"}, "updated_at": {"type": "string", "format": "date-time", "description": "Project updated time"}, "updated_by": {"type": "string", "description": "Name of the user who recently updated"}}, "type": "object"}]}, "AppSecopsProjectBase": {"required": ["application_ids", "name", "tenant_id"], "properties": {"name": {"type": "string", "description": "Name of the application"}, "description": {"type": "string", "description": "Project description"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "application_ids": {"type": "array", "description": "Project related application IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "tags": {"type": "array", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "AppSecopsProjectBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AppSecopsProject"}}}, "type": "object"}, "AppSecopsProjectFilterBase": {"allOf": [{"$ref": "#/definitions/AppSecopsFilterBase"}, {"properties": {"sbom_names": {"type": "array", "description": "Name of SBOMs linked to a project.", "items": {"type": "string"}}, "application_ids": {"type": "array", "description": "ID of applications to which the project belongs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "application_names": {"type": "array", "description": "Name of applications to which the project belongs", "items": {"type": "string"}}, "sbom_filter": {"type": "string", "description": "Filter projects based on SBOM association status", "example": "with_sbom", "enum": ["with_sbom", "without_sbom"], "x-cs-enum-type": "AppSecopsProjectSbomFilter"}, "search": {"type": "string", "description": "Search based on name, description and SBOM name"}}, "type": "object"}]}, "AppSecopsProjectIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["appsecops_project_ids"], "properties": {"appsecops_project_ids": {"type": "array", "description": "Appsecops project IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsProjectIdQueryOperator"}, "AppSecopsProjectListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AppSecopsProjectSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AppSecopsProjectFilterBase"}}, "type": "object"}, "AppSecopsProjectRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsProjectBase"}, {"properties": {}, "type": "object"}]}, "AppSecopsProjectResponse": {"allOf": [{"$ref": "#/definitions/AppSecopsProject"}, {"properties": {}, "type": "object"}]}, "AppSecopsProjectSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "name", "enum": ["name", "updated_at"], "x-cs-enum-type": "AppSecopsProjectSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AppSecopsSbomBuildDifferenceResponse": {"properties": {"build_id": {"type": "string", "description": "Unique ID of the build"}, "version_id": {"type": "string", "description": "Unique ID of the latest SBOM build version", "x-cs-type": "ObjectId"}, "compared_version_id": {"type": "string", "description": "Unique ID of the previous SBOM build version", "x-cs-type": "ObjectId"}, "sbom_generated_date": {"type": "string", "format": "date-time", "description": "SBOM file generated datetime"}, "new_components": {"type": "array", "description": "List of new component IDs created in the build", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "upgraded_components": {"type": "array", "description": "List of upgraded component IDs in the build", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "deleted_components": {"type": "array", "description": "List of deleted component IDs in the build", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "new_vulnerabilities": {"type": "array", "description": "List of new vulnerability and component details", "items": {"$ref": "#/definitions/AppSecopsVulnerabilityWithComponentDetails"}}, "resolved_vulnerabilities": {"type": "array", "description": "List of resolved vulnerability unique IDs in the build", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AppSecopsSbomBuildDifferenceTrendRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsTimeRangeFilter"}, {"properties": {}, "type": "object"}]}, "AppSecopsSbomComponent": {"properties": {"author": {"type": "string", "description": "Author of the component"}, "component_id": {"type": "string", "description": "Unique identifier for the component", "x-cs-type": "ObjectId"}, "cpe": {"type": "string", "description": "Common Platform Enumeration (CPE) identifier for the component"}, "dependent_component_ids": {"type": "array", "description": "List of dependent component references", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "description": {"type": "string", "description": "Description of the component"}, "external_references": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsExternalReferenceDetail"}}, "licenses": {"type": "array", "description": "License for the component", "items": {"$ref": "#/definitions/AppSecopsLicenseDetails"}}, "name": {"type": "string", "description": "Name of the component"}, "properties": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomComponentProperty"}}, "purl": {"type": "string", "description": "Package URL (PURL) that uniquely identifies the component across ecosystems"}, "version": {"type": "string", "description": "Version of the component"}, "component_type": {"type": "string", "description": "Sbom component type", "example": "application", "enum": ["application", "container", "cryptographic-asset", "data", "device", "device-driver", "file", "firmware", "framework", "library", "machine-learning-model", "operating-system", "platform"], "x-cs-enum-type": "AppSecopsSbomComponentType"}}, "type": "object"}, "AppSecopsSbomComponentDetails": {"properties": {"name": {"type": "string", "description": "Name of the component"}, "component_id": {"type": "string", "description": "Unique identifier for the component", "x-cs-type": "ObjectId"}, "dependent_component_ids": {"type": "array", "description": "List of BOM references that this component depends on", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AppSecopsSbomComponentFilter": {"allOf": [{"$ref": "#/definitions/AppSecopsFilter"}, {"properties": {"vulnerable_components_only": {"type": "boolean", "description": "If set true, fetch only components associated with vulnerabilities"}}, "type": "object"}]}, "AppSecopsSbomComponentIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["component_ids"], "properties": {"component_ids": {"type": "array", "description": "SBOM component IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsSbomComponentIdQueryOperator"}, "AppSecopsSbomComponentProperty": {"properties": {"name": {"type": "string", "description": "Name of the SBOM component property"}, "value": {"type": "string", "description": "value of the SBOM component"}}, "type": "object"}, "AppSecopsSbomComponentRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AppSecopsSbomComponentFilter"}}, "type": "object"}, "AppSecopsSbomComponentTypeQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["component_types"], "properties": {"component_types": {"type": "array", "description": "SBOM component type to include", "items": {"type": "string", "description": "Sbom component type", "example": "application", "enum": ["application", "container", "cryptographic-asset", "data", "device", "device-driver", "file", "firmware", "framework", "library", "machine-learning-model", "operating-system", "platform"], "x-cs-enum-type": "AppSecopsSbomComponentType"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsSbomComponentTypeQueryOperator"}, "AppSecopsSbomComponentsResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"$ref": "#/definitions/AppSecopsSbomComponentDetails"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "AppSecopsSbomDefinition": {"allOf": [{"$ref": "#/definitions/AppSecopsSbomDefinitionBase"}, {"properties": {"sbom_definition_id": {"type": "string", "description": "Unique ID of the Sbom", "x-cs-type": "ObjectId"}, "release_version_id": {"type": "string", "description": "Release version ID of SBOM", "x-cs-type": "ObjectId"}, "appsecops_project_id": {"type": "string", "description": "SBOM related project ID", "x-cs-type": "ObjectId"}, "created_at": {"type": "string", "format": "date-time", "description": "SBOM definition created date"}, "created_by": {"type": "string", "description": "Name of the user who created the SBOM definition"}, "updated_by": {"type": "string", "description": "Name of the user who recently updated the SBOM definition"}, "updated_at": {"type": "string", "format": "date-time", "description": "SBOM definition updated date"}, "resource_mapping_details": {"description": "Details of resources mapped to SBOM.", "$ref": "#/definitions/AppSecopsSbomResourceMappingDetails"}}, "type": "object"}]}, "AppSecopsSbomDefinitionBase": {"required": ["name", "tenant_id"], "properties": {"name": {"type": "string", "description": "Name of the SBOM"}, "description": {"type": "string", "description": "SBOM description"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "AppSecopsSbomDefinitionRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsSbomDefinitionBase"}, {"required": ["appsecops_project_id"], "properties": {"appsecops_project_id": {"type": "string", "description": "SBOM related project ID", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "AppSecopsSbomDefinitionUpdateRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsSbomDefinitionBase"}, {"properties": {"resource_mapping_details": {"description": "Details of resources mapped to SBOM.", "$ref": "#/definitions/AppSecopsSbomResourceMappingDetails"}}, "type": "object"}]}, "AppSecopsSbomDefinitionsFilter": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "search": {"type": "string", "description": "Search based on name"}, "filters": {"description": "Filter based on portfolio_id, application_id, appsecops_project_id", "$ref": "#/definitions/QueryOperator"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "AppSecopsSbomDefinitionsListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AppSecopsSbomDefinitionsSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AppSecopsSbomDefinitionsFilter"}}, "type": "object"}, "AppSecopsSbomDefinitionsListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "AppSecopsSbomDefinitionsSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "name", "enum": ["name", "updated_at"], "x-cs-enum-type": "AppSecopsSbomDefinitionsSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AppSecopsSbomNameQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["sbom_name"], "properties": {"sbom_name": {"type": "array", "description": "User who submitted SBOM version to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsSbomNameQueryOperator"}, "AppSecopsSbomResourceMappingDetails": {"properties": {"mapped_resources": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsMappedResource"}}, "status": {"type": "string", "description": "Status of Resource Mapping", "example": "success", "enum": ["success", "error"], "x-cs-enum-type": "AppSecopsSbomResourceMappingStatus"}, "message": {"type": "string", "description": "Message of Resource Mapping"}, "last_mapped_at": {"type": "string", "format": "date-time", "description": "The most recent date and time of automated resource mapping to the SBOM."}, "background_job_id": {"description": "Id of background job which performs the mapping of resources to SBOM.", "$ref": "#/definitions/RecordIdentity"}}, "type": "object"}, "AppSecopsSbomVersion": {"allOf": [{"$ref": "#/definitions/AppSecopsSbomVersionBase"}, {"properties": {"sbom_version_id": {"type": "string", "description": "Unique ID of the SBOM version", "x-cs-type": "ObjectId"}, "predecessor_version_id": {"type": "string", "description": "Unique ID of the previous SBOM version from which this version is created", "x-cs-type": "ObjectId"}, "version_number": {"type": "integer", "description": "Sequence number of the SBOM version"}, "created_at": {"type": "string", "format": "date-time", "description": "SBOM version created date"}, "created_by": {"type": "string", "description": "Name of the user who created the SBOM version"}, "updated_at": {"type": "string", "format": "date-time", "description": "SBOM version updated date"}, "updated_by": {"type": "string", "description": "Name of the user who updated the SBOM version"}, "metadata": {"$ref": "#/definitions/AppSecopsSbomVersionMetadata"}, "parser_status": {"$ref": "#/definitions/AppSecopsSbomVersionParserStatus"}, "component_ids": {"type": "array", "description": "List of IDs used to refer the components under the SBOM version", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}]}, "AppSecopsSbomVersionBase": {"required": ["attachment_id", "sbom_definition_id", "sbom_file_format", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "sbom_definition_id": {"type": "string", "description": "Unique ID of the SBOM", "x-cs-type": "ObjectId"}, "attachment_id": {"type": "string", "description": "Unique ID of the attachment to identify the SBOM version file", "x-cs-type": "ObjectId"}, "build_id": {"type": "string", "description": "Unique ID of the build associated with the SBOM version"}, "sbom_file_format": {"description": "File format of the SBOM version", "$ref": "#/definitions/AppSecopsSbomVersionFileFormat"}}, "type": "object"}, "AppSecopsSbomVersionBuildIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["build_ids"], "properties": {"build_ids": {"type": "array", "description": "Build ID(s) associated with the SBOM version to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsSbomVersionBuildIdQueryOperator"}, "AppSecopsSbomVersionDifference": {"properties": {"base_version_id": {"type": "string", "description": "ID of the SBOM version to compare against", "x-cs-type": "ObjectId"}, "compare_version_id": {"type": "string", "description": "ID of the SBOM version to compare with", "x-cs-type": "ObjectId"}, "new_component_ids": {"type": "array", "description": "List of new component IDs created in the SBOM version", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "upgraded_component_ids": {"type": "array", "description": "List of upgraded component IDs created in the SBOM version", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "deleted_component_ids": {"type": "array", "description": "List of deleted component IDs in the SBOM version", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "new_vulnerability_ids": {"type": "array", "description": "List of new vulnerability IDs created in the SBOM version", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "resolved_vulnerability_ids": {"type": "array", "description": "List of resolved vulnerability IDs in the SBOM version", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AppSecopsSbomVersionDifferenceRequest": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "compare_version_id": {"type": "string", "description": "ID of the SBOM version against which component and vulnerability difference is fetched", "x-cs-type": "ObjectId"}}, "type": "object"}, "AppSecopsSbomVersionFileFormat": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-type-name": "AppSecopsSbomVersionFileFormat", "x-cs-subtypes": [{"subtype_model": "AppSecopsSbomVersionFileFormatForCycloneDX", "subtype_name": "AppSecopsSbomVersionFileFormatForCycloneDX"}]}, "AppSecopsSbomVersionFileFormatForCycloneDX": {"allOf": [{"$ref": "#/definitions/AppSecopsSbomVersionFileFormat"}, {"required": ["version"], "properties": {"version": {"type": "string", "description": "CycloneDX schema version of the Software Bill of Materials (SBOM) document.", "example": "1.6", "enum": ["1.6"], "x-cs-enum-type": "SBOMVersionCycloneDxFileFormatVersion"}}, "type": "object"}], "x-cs-type-name": "AppSecopsSbomVersionFileFormatForCycloneDX"}, "AppSecopsSbomVersionIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["sbom_version_ids"], "properties": {"sbom_version_ids": {"type": "array", "description": "SBOM version IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsSbomVersionIdQueryOperator"}, "AppSecopsSbomVersionMetadata": {"properties": {"component_type": {"type": "string", "description": "Sbom component type", "example": "application", "enum": ["application", "container", "cryptographic-asset", "data", "device", "device-driver", "file", "firmware", "framework", "library", "machine-learning-model", "operating-system", "platform"], "x-cs-enum-type": "AppSecopsSbomComponentType"}, "tools": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsSbomVersionMetadataTool"}}, "bom_created_at": {"type": "string", "format": "date-time", "description": "SBOM build created datetime"}}, "type": "object"}, "AppSecopsSbomVersionMetadataTool": {"properties": {"name": {"type": "string", "description": "Name of the SBOM tool"}, "version": {"type": "string", "description": "Version of the SBOM tool"}, "tool_type": {"type": "string", "description": "Sbom component type", "example": "application", "enum": ["application", "container", "cryptographic-asset", "data", "device", "device-driver", "file", "firmware", "framework", "library", "machine-learning-model", "operating-system", "platform"], "x-cs-enum-type": "AppSecopsSbomComponentType"}, "author": {"type": "string", "description": "The person or organization that authored the component tool"}}, "type": "object"}, "AppSecopsSbomVersionParserStatus": {"properties": {"status": {"type": "string", "description": "Parsing status of SBOM", "example": "error", "enum": ["error", "in_progress", "success"], "x-cs-enum-type": "SbomParsingStatus"}, "message": {"type": "string", "description": "Parsing message of SBOM"}, "time_taken": {"type": "number", "description": "Time taken for parsing in seconds"}}, "type": "object"}, "AppSecopsSbomVersionRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsSbomVersionBase"}, {"properties": {"force": {"type": "boolean", "description": "If set true, allows version creation even if duplicate exists under tenant, false prevents duplicate creation"}}, "type": "object"}]}, "AppSecopsSbomVersionResponse": {"allOf": [{"$ref": "#/definitions/AppSecopsSbomVersion"}, {"properties": {"vulnerability_ids": {"type": "array", "description": "List of vulnerability IDs detected in the components of this SBOM version", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "sbom_version_vulnerability_ids": {"type": "array", "description": "List of IDs that associate each vulnerability with this SBOM version, including version-specific details", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}]}, "AppSecopsSbomVersionRiskScore": {"properties": {"application_id": {"type": "string", "description": "The unique ID of the application that the SBOM project is linked to.", "x-cs-type": "ObjectId"}, "overall_risk_score": {"type": "number", "description": "Aggregated risk score representing the overall impact of the vulnerability, considering multiple risk factors."}}, "type": "object"}, "AppSecopsSbomVersionSubmittedByQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["sbom_submitted_by"], "properties": {"sbom_submitted_by": {"type": "array", "description": "User who submitted SBOM version to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsSbomVersionSubmittedByQueryOperator"}, "AppSecopsSbomVersionSubmittedDateQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"sbom_submitted_date": {"type": "string", "format": "date-time", "description": "SBOM submitted date associated with the vulnerability"}}, "type": "object"}], "x-cs-type-name": "AppSecopsSbomVersionSubmittedDateQueryOperator"}, "AppSecopsSbomVersionUpdateRequest": {"required": ["build_id", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "build_id": {"type": "string", "description": "Unique ID of the build associated with the SBOM version"}}, "type": "object"}, "AppSecopsSbomVersionVulnerability": {"properties": {"sbom_version_vulnerability_id": {"type": "string", "description": "Unique ID of the vulnerabilities associated to the SBOM version.", "x-cs-type": "ObjectId"}, "sbom_version_id": {"type": "string", "description": "Unique ID of the SBOM version", "x-cs-type": "ObjectId"}, "vulnerability_id": {"type": "string", "description": "Unique ID for the global vulnerability reference.", "x-cs-type": "ObjectId"}, "components": {"type": "array", "description": "List of affected SBOM components.", "items": {"$ref": "#/definitions/AppSecopsSbomVulnerabilityComponentDetail"}}, "risk_score_by_application": {"type": "array", "description": "Risk score of the vulnerability by application.", "items": {"$ref": "#/definitions/AppSecopsSbomVersionRiskScore"}}, "tenant_id": {"type": "string", "description": "Tenant ID associated with the vulnerability", "x-cs-type": "ObjectId"}, "sbom_vulnerability_details_by_tenant": {"description": "Tenant ID to which the SBOM belongs to.", "$ref": "#/definitions/AppSecopsSbomVulnerabilityDetailsByTenant"}}, "type": "object"}, "AppSecopsSbomVulnerability": {"properties": {"sbom_version_vulnerability_ids": {"type": "array", "description": "List of sbom version vulnerability ID(s)", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "vulnerability_id": {"type": "string", "description": "The Unique ID of the vulnerability"}, "top_cvss_metric": {"description": "Top CVSS metric of a vulnerability", "$ref": "#/definitions/AppSecopsVulnerabilityCvssMetric"}, "is_kev": {"type": "boolean", "description": "Indicates whether the vulnerability is a Known Exploited Vulnerability (KEV)"}, "overall_risk_score": {"type": "number", "description": "Aggregated risk score representing the overall impact of the vulnerability, considering multiple risk factors."}, "bom_references": {"type": "array", "description": "List of Bom references", "items": {"$ref": "#/definitions/AppSecopsComponentReference"}}, "description_from_sbom": {"type": "string", "description": "Description of the vulnerability from the SBOM"}, "references_from_sbom": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsExternalReferenceDetail"}}}, "type": "object"}, "AppSecopsSbomVulnerabilityComponentDetail": {"properties": {"id": {"type": "string", "description": "Unique ID for the component", "x-cs-type": "ObjectId"}, "fix_available": {"type": "boolean", "description": "Indicates if a fix is available for the component in the vulnerability"}}, "type": "object"}, "AppSecopsSbomVulnerabilityDetailsByTenant": {"properties": {"cvss_metrics": {"description": "CVSS metrics associated with the vulnerability captured from different source.", "$ref": "#/definitions/AppSecopsVulnerabilityCvssMetric"}, "sbom_source_details": {"description": "SBOM vulnerability source details specific to the tenant", "$ref": "#/definitions/AppSecopsVulnerabilitySourceDetails"}, "updated_at": {"type": "string", "format": "date-time", "description": "Datetime when the vulnerability details were last updated for the tenant"}}, "type": "object"}, "AppSecopsSbomVulnerabilityRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AppSecopsFilter"}}, "type": "object"}, "AppSecopsSbomVulnerabilityResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"$ref": "#/definitions/AppSecopsSbomVulnerability"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "AppSecopsScoreRangeQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"greater_than_or_equal_to": {"type": "string", "description": "Minimum value for the score range"}, "less_than_or_equal_to": {"type": "string", "description": "Maximum value for the score range"}, "equal_to": {"type": "string", "description": "Exact value for the score to match"}}, "type": "object"}]}, "AppSecopsTimeRangeFilter": {"allOf": [{"$ref": "#/definitions/AppSecopsFilter"}, {"required": ["end_date", "start_date"], "properties": {"start_date": {"type": "string", "format": "date-time", "description": "Start date of the time period"}, "end_date": {"type": "string", "format": "date-time", "description": "End date of the time period"}}, "type": "object"}]}, "AppSecopsTopActionableIssuesFilter": {"allOf": [{"$ref": "#/definitions/AppSecopsDashboardRequestBase"}, {"required": ["categories"], "properties": {"categories": {"type": "array", "description": "Security category", "items": {"type": "string", "description": "Security Category to select", "example": "vulnerability", "enum": ["vulnerability"], "x-cs-enum-type": "SecurityCategory"}}, "filters": {"description": "Query based on Tenant ID, Application ID, Portfolio ID, Project ID and SBOM references", "$ref": "#/definitions/QueryOperator"}, "view_by": {"type": "string", "description": "If not set, grouping is defaulted to Project. This can either be set to application or unique vulnerability.", "example": "application", "enum": ["application", "unique_vulnerability"], "x-cs-enum-type": "AppInsightsViewBy"}, "search": {"type": "string", "description": "Search text to filter the actionable issues based on CVE ID"}, "days_range": {"type": "string", "description": "Time range bucket for grouping vulnerabilities based on NVD published date or SBOM created date", "example": "0-30 days", "enum": ["0-30 days", "31-60 days", "61-90 days", "91-365 days", "> 365 days", "Unknown"], "x-cs-enum-type": "DaysRange"}, "all_version": {"type": "boolean", "description": "True if all versions are required to be considered; false considers only the latest version of SBOMs"}}, "type": "object"}]}, "AppSecopsTopActionableIssuesRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AppSecopsTopActionableIssuesFilter"}}, "type": "object"}, "AppSecopsTopActionableIssuesResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"$ref": "#/definitions/AppSecopsDashboardInsights"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "AppSecopsVulnerability": {"properties": {"id": {"type": "string", "description": "Unique ID of the vulnerability", "x-cs-type": "ObjectId"}, "vulnerability_id": {"$ref": "#/definitions/AppSecopsVulnerabilityCveDetail"}, "is_kev": {"type": "boolean", "description": "Indicates whether the vulnerability is a Known Exploited Vulnerability"}, "epss_metric": {"description": "EPSS metrics associated with the vulnerability", "$ref": "#/definitions/AppSecopsVulnerabilityEpssScore"}, "cvss_metrics": {"type": "array", "description": "CVSS metrics associated with the vulnerability captured from different source.", "items": {"$ref": "#/definitions/AppSecopsVulnerabilityCvssMetric"}}, "fix_available": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsVulnerabilityFixAvailableDetails"}}, "aliases": {"type": "array", "items": {"type": "string", "description": "List of alternative identifiers for the vulnerability"}}, "details_from_source": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsVulnerabilitySourceDetails"}}}, "type": "object"}, "AppSecopsVulnerabilityByComponent": {"properties": {"days_range": {"type": "string", "description": "Time range bucket for grouping vulnerabilities based on NVD published date or SBOM created date", "example": "0-30 days", "enum": ["0-30 days", "31-60 days", "61-90 days", "91-365 days", "> 365 days", "Unknown"], "x-cs-enum-type": "DaysRange"}, "product": {"type": "string", "description": "SBOM component Product name"}, "vendor": {"type": "string", "description": "SBOM component Vendor name"}, "package_type": {"type": "string", "description": "SBOM component package type"}, "severity": {"type": "string", "description": "Severity of the vulnerability", "example": "Critical", "enum": ["Critical", "High", "Info", "Low", "Medium", "None", "Unknown"], "x-cs-enum-type": "Severity"}, "is_kev": {"type": "boolean", "description": "Indicates whether the vulnerability is a Known Exploited Vulnerability (KEV)"}, "count": {"type": "integer", "description": "Total count of vulnerabilities associated with the category"}, "vulnerability_ids": {"type": "array", "description": "List of vulnerability IDs associated with the component", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AppSecopsVulnerabilityByComponentRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsFilter"}, {"properties": {"category": {"type": "array", "description": "Component property category", "items": {"type": "string", "description": "Grouping Category", "example": "product", "enum": ["product", "vendor", "package_type", "by_nvd_published_date", "by_sbom_created_date"], "x-cs-enum-type": "AppSecopsComponentGroupingCategory"}}}, "type": "object"}]}, "AppSecopsVulnerabilityCveDetail": {"properties": {"id": {"type": "string", "description": "ID of the vulnerability."}, "type": {"type": "string", "description": "Type of the vulnerability."}}, "type": "object"}, "AppSecopsVulnerabilityCvssMetric": {"properties": {"version": {"type": "string", "description": "CVSS version used for scoring (e.g., 3.1)"}, "vector_string": {"type": "string", "description": "Encoded CVSS vector string representing all metric values"}, "access_complexity": {"type": "string", "description": "Level of complexity required for an attacker to exploit the vulnerability"}, "access_vector": {"type": "string", "description": "Encoded access vector string representing all metric values"}, "attack_vector": {"type": "string", "description": "Context required to exploit the vulnerability (e.g., network, local)"}, "attack_requirements": {"type": "string", "description": "Specific conditions or requirements needed for a successful attack (e.g., configuration, user privileges)"}, "authentication": {"type": "string", "description": "Authentication type (e.g., Basic authentication)"}, "attack_complexity": {"type": "string", "description": "Level of difficulty to exploit the vulnerability"}, "exploit_maturity": {"type": "string", "description": "Indicates a vulnerability is to be exploited based on exploit availability and threat intelligence."}, "privileges_required": {"type": "string", "description": "Level of privileges an attacker needs to exploit the vulnerability"}, "user_interaction": {"type": "string", "description": "Indicates if user interaction is required for exploitation"}, "scope": {"type": "string", "description": "Whether exploitation affects resources beyond the vulnerable component"}, "confidentiality_impact": {"type": "string", "description": "Impact on confidentiality if the vulnerability is exploited"}, "integrity_impact": {"type": "string", "description": "Impact on data integrity if the vulnerability is exploited"}, "availability_impact": {"type": "string", "description": "Impact on system availability if the vulnerability is exploited"}, "base_score": {"type": "number", "description": "CVSS base score (0\u201310) indicating overall severity"}, "severity": {"type": "string", "description": "Severity level of the vulnerability", "example": "Critical", "enum": ["Critical", "High", "Info", "Low", "Medium", "None", "Unknown"], "x-cs-enum-type": "Severity"}, "subsequent_availability": {"type": "string", "description": "Availability impact on dependent or downstream systems after the vulnerability is exploited"}, "subsequent_confidentiality": {"type": "string", "description": "Impact on confidentiality of the system after the vulnerability is exploited"}, "subsequent_integrity": {"type": "string", "description": "Integrity impact on systems that depend on or are affected by the vulnerable system."}, "vulnerable_availability": {"type": "string", "description": "Availability impact on the directly affected system after the vulnerability is exploited."}, "vulnerable_confidentiality": {"type": "string", "description": "Confidentiality impact on the directly affected system after the vulnerability is exploited."}, "vulnerable_integrity": {"type": "string", "description": "Integrity impact on the system where the vulnerability exists"}}, "type": "object"}, "AppSecopsVulnerabilityEpssScore": {"properties": {"score": {"type": "number", "description": "EPSS score indicating the likelihood of exploitation (0 to 1)"}, "percentile": {"type": "number", "description": "EPSS percentile ranking among all scored vulnerabilities"}, "calculated_at": {"type": "string", "format": "date-time", "description": "Timestamp when the EPSS score was generated"}, "updated_at": {"type": "string", "format": "date-time", "description": "Timestamp when the score was recently updated"}}, "type": "object"}, "AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["attack_complexity_v31"], "properties": {"attack_complexity_v31": {"type": "array", "description": "Exploitability metric(s) attack complexity v3.1 to include", "items": {"type": "string", "description": "Level of difficulty to exploit the vulnerability", "example": "High", "enum": ["High", "Low"], "x-cs-enum-type": "CvssV31ExploitabilityAttackComplexity"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator"}, "AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["attack_vector_v31"], "properties": {"attack_vector_v31": {"type": "array", "description": "Exploitability metric(s) attack vector v3.1 to include", "items": {"type": "string", "description": "Context required to exploit the vulnerability (e.g., network, local)", "example": "Adjacent", "enum": ["Adjacent", "Local", "Network", "Physical"], "x-cs-enum-type": "CvssV31ExploitabilityAttackVector"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator"}, "AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["privileges_required_v31"], "properties": {"privileges_required_v31": {"type": "array", "description": "Exploitability metric(s) privileges required v3.1 to include", "items": {"type": "string", "description": "Level of access required before exploiting the vulnerability.", "example": "High", "enum": ["High", "Low", "None"], "x-cs-enum-type": "Cvss31ExploitabilityPrivilegesRequired"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator"}, "AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["scope_v31"], "properties": {"scope_v31": {"type": "array", "description": "Exploitability metric(s) scope v3.1 to include", "items": {"type": "string", "description": "Whether exploitation affects resources beyond the vulnerable component", "example": "Changed", "enum": ["Changed", "Unchanged"], "x-cs-enum-type": "CvssV31ExploitabilityScope"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator"}, "AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["user_interaction_v31"], "properties": {"user_interaction_v31": {"type": "array", "description": "Exploitability metric(s) user interaction v3.1 to include", "items": {"type": "string", "description": "Indicates if user interaction is required for exploitation", "example": "None", "enum": ["None", "Required"], "x-cs-enum-type": "CvssV31ExploitabilityUserInteraction"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator"}, "AppSecopsVulnerabilityFixAvailableDetails": {"properties": {"source": {"type": "string", "description": "Source of vulnerability", "example": "NVD", "enum": ["NVD", "SBOM", "KEV", "OSV"], "x-cs-enum-type": "VulnerabilitySource"}, "affected_component_ids": {"type": "array", "description": "List of component IDs that are affected by this vulnerability and for which a fix is available", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["availability_impact_v31"], "properties": {"availability_impact_v31": {"type": "array", "description": "Impact metric(s) availability impact to include", "items": {"type": "string", "description": "Whether exploitation affects resources beyond the vulnerable component", "example": "High", "enum": ["High", "Low", "None"], "x-cs-enum-type": "CvssV31ImpactMetrics"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator"}, "AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["confidentiality_impact_v31"], "properties": {"confidentiality_impact_v31": {"type": "array", "description": "Impact metric(s) confidentiality impact to include", "items": {"type": "string", "description": "Whether exploitation affects resources beyond the vulnerable component", "example": "High", "enum": ["High", "Low", "None"], "x-cs-enum-type": "CvssV31ImpactMetrics"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator"}, "AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["integrity_impact_v31"], "properties": {"integrity_impact_v31": {"type": "array", "description": "Impact metric(s) integrity impact to include", "items": {"type": "string", "description": "Whether exploitation affects resources beyond the vulnerable component", "example": "High", "enum": ["High", "Low", "None"], "x-cs-enum-type": "CvssV31ImpactMetrics"}}}, "type": "object"}], "x-cs-type-name": "AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator"}, "AppSecopsVulnerabilityOrganizationPrevalence": {"properties": {"vulnerability_id": {"type": "string", "description": "Unique ID of the vulnerability", "x-cs-type": "ObjectId"}, "application_id": {"type": "string", "description": "Application ID", "x-cs-type": "ObjectId"}, "appsecops_project_id": {"type": "string", "description": "Appsecops project ID", "x-cs-type": "ObjectId"}, "portfolio_id": {"type": "string", "description": "Portfolio ID", "x-cs-type": "ObjectId"}}, "type": "object"}, "AppSecopsVulnerabilityPrevalenceRequest": {"required": ["tenant_ids", "vulnerability_ids"], "properties": {"tenant_ids": {"type": "array", "description": "List of tenant IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "vulnerability_ids": {"type": "array", "description": "List of vulnerability IDs to fetch organization-wide prevalence data", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "AppSecopsVulnerabilitySourceDetails": {"allOf": [{"$ref": "#/definitions/KnownExploitedVulnerability"}, {"properties": {"advisories": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsExternalReferenceDetail"}}, "affected": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsOsvVulnerabilityAffectedDetails"}}, "cpe": {"type": "array", "description": "Common Platform Enumeration(CPE) of the vulnerability", "items": {"type": "string"}}, "details": {"type": "string", "description": "Detailed information about the vulnerability"}, "description": {"type": "string", "description": "Description of the vulnerability"}, "references": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsExternalReferenceDetail"}}, "source": {"type": "string", "description": "Source of the vulnerability", "example": "NVD", "enum": ["NVD", "SBOM", "KEV", "OSV"], "x-cs-enum-type": "VulnerabilitySource"}, "origin": {"type": "string", "description": "Origin of the vulnerability"}, "related": {"type": "array", "description": "List of related vulnerability CVE IDs", "items": {"type": "string"}}, "recommendation": {"type": "string", "description": "Recommendation of the vulnerability"}, "url": {"type": "string", "description": "Vulnerability source URL"}, "schema_version": {"type": "string", "description": "Schema version of the vulnerability"}, "source_updated_at": {"type": "string", "format": "date-time", "description": "Date when the source details was last updated"}, "sourceIdentifier": {"type": "string", "description": "Source identifier of the vulnerability"}, "summary": {"type": "string", "description": "Summary of the vulnerability"}, "modified": {"type": "string", "format": "date-time", "description": "Date when the source details was modified"}, "published": {"type": "string", "format": "date-time", "description": "Date when the source details was published"}, "vulnStatus": {"type": "string", "description": "Status of the vulnerability"}, "vendorComments": {"type": "array", "items": {"$ref": "#/definitions/AppSecopsVulnerabilityVendorComment"}}, "descriptions": {"type": "array", "items": {"$ref": "#/definitions/VulnerabilityNvdDescription"}}, "lastModified": {"type": "string", "format": "date-time", "description": "Date when the source details was last modified"}, "upstream": {"type": "array", "description": "List of upstream vulnerability IDs that are transitively referred to by this vulnerability entry", "items": {"type": "string"}}, "updated_at": {"type": "string", "format": "date-time", "description": "Date when the vulnerability was last updated"}}, "type": "object"}]}, "AppSecopsVulnerabilityTrendBySeverity": {"properties": {"date": {"type": "string", "format": "date", "description": "date of the aggregated time interval."}, "sbom_version_ids": {"type": "array", "description": "List of sbom version ID(s) that are associated with the vulnerabilities detected in the time interval.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "critical_count": {"type": "integer", "description": "Total count of vulnerabilities with critical severity."}, "high_count": {"type": "integer", "description": "Total count of vulnerabilities with high severity."}, "medium_count": {"type": "integer", "description": "Total count of vulnerabilities with medium severity."}, "low_count": {"type": "integer", "description": "Total count of vulnerabilities with low severity."}, "none_count": {"type": "integer", "description": "Total count of vulnerabilities with none severity."}, "unknown_count": {"type": "integer", "description": "Total count of vulnerabilities with unknown severity."}, "info_count": {"type": "integer", "description": "Total count of vulnerabilities with info severity."}}, "type": "object"}, "AppSecopsVulnerabilityTrendBySeverityRequest": {"allOf": [{"$ref": "#/definitions/AppSecopsTimeRangeFilter"}, {"required": ["granularity"], "properties": {"granularity": {"type": "string", "description": "Granularity for aggregating vulnerability trend data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}}, "type": "object"}]}, "AppSecopsVulnerabilityVendorComment": {"properties": {"organization": {"type": "string", "description": "Name of the vendor or organization providing the comment"}, "comment": {"type": "string", "description": "Vendor\u2019s statement or advisory regarding the vulnerability"}, "lastModified": {"type": "string", "format": "date-time", "description": "Date and time when the comment was last updated"}}, "type": "object"}, "AppSecopsVulnerabilityWithComponentDetails": {"properties": {"vulnerability_id": {"type": "string", "description": "The Unique ID of the vulnerability", "x-cs-type": "ObjectId"}, "affected_components": {"type": "array", "description": "List of component IDs which has vulnerability", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "ApplicableHealthMetricsQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["applicable_health_metrics"], "properties": {"applicable_health_metrics": {"type": "array", "description": "Metrics applicable for evaluating health status of a resource", "items": {"type": "string", "description": "Metrics applicable for the Health status of a resource", "example": "Alerts", "enum": ["Alerts", "Backup Compliance", "Patch Compliance", "Disk Space"], "x-cs-enum-type": "ApplicableHealthMetrics"}}}, "type": "object"}], "x-cs-type-name": "ApplicableHealthMetricsQueryOperator"}, "ApplicableToDetails": {"properties": {"name": {"type": "string", "description": "Applicable to which cloud account or tenant. Example 'name':'AWS_Account_1'"}, "id": {"type": "string", "description": "ID of that account.Example 'id': '61237f01e4b04a4c6b19addd'"}}, "type": "object"}, "ApplicationHealthAlert": {"properties": {"metric_name": {"type": "string", "description": "Name of the metric"}, "status": {"type": "string", "description": "Alert status"}, "metric_value": {"type": "number", "description": "Metric value"}, "threshold": {"type": "string", "description": "Configured threshold"}, "operator": {"type": "string", "description": "Operator used for comparison", "example": "Equals", "enum": ["Equals", "NotEquals", "GreaterThan", "GreaterThanOrEqual", "LessThan", "LessThanOrEqual"], "x-cs-enum-type": "AlertOperator"}, "window_size": {"type": "string", "description": "Window size for evaluation"}, "time_aggregation": {"type": "string", "description": "Time aggregation type"}, "is_critical": {"type": "boolean", "description": "Whether the alert requires immediate action"}, "event_creation_time": {"type": "string", "format": "date-time", "description": "Timestamp of the event"}}, "type": "object"}, "ApplicationHealthBatchRequest": {"required": ["end_date", "start_date"], "properties": {"ids": {"type": "array", "description": "Identifiers to fetch", "items": {"type": "string"}}, "start_date": {"type": "string", "format": "date-time", "description": "Start date for filtering alerts"}, "end_date": {"type": "string", "format": "date-time", "description": "End date for filtering alerts"}}, "type": "object"}, "ApplicationHealthBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/ApplicationHealthSummary"}}}, "type": "object"}, "ApplicationHealthListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/ApplicationHealthSummarySortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ApplicationHealthRequestFilter"}}, "type": "object"}, "ApplicationHealthRequestFilter": {"required": ["end_date", "start_date"], "properties": {"filter": {"description": "Query expression to filter application health data.", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "Start date for filtering alerts"}, "end_date": {"type": "string", "format": "date-time", "description": "End date for filtering alerts"}}, "type": "object"}, "ApplicationHealthSummary": {"properties": {"service_account_id": {"type": "string", "description": "Service account id", "x-cs-type": "ObjectId"}, "service_resource_inventory_id": {"type": "string", "description": "Service Resource Inventory ID"}, "resource_id": {"type": "string", "description": "Application resource ID"}, "resource_name": {"type": "string", "description": "Application resource Name"}, "resource_filter": {"type": "string", "description": "Resource group or logical grouping"}, "resource_region": {"type": "string", "description": "Application region"}, "resource": {"type": "string", "description": "Resource name"}, "resource_type": {"type": "string", "description": "Type of application resource"}, "resource_category": {"type": "string", "description": "Resource category"}, "resource_state": {"type": "string", "description": "Current State of the resource"}, "alert_metrics": {"type": "array", "description": "Configured alert metrics", "items": {"type": "string"}}, "patch_details": {"description": "Patch compliance details for the application", "$ref": "#/definitions/PatchCompliance"}, "backup_details": {"description": "Backup and protection status", "$ref": "#/definitions/ProtectionStatus"}, "disk_details": {"description": "Disk usage and status information", "$ref": "#/definitions/DiskStatus"}, "alert_details": {"type": "array", "description": "List of configured alerts and their metrics", "items": {"$ref": "#/definitions/ApplicationHealthAlert"}}}, "type": "object"}, "ApplicationHealthSummarySortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "resource_category", "enum": ["resource_category"], "x-cs-enum-type": "ApplicationHealthSummarySortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ApplyTemplateRequest": {"required": ["cloud_accounts", "monitoring_template_uri"], "properties": {"cloud_accounts": {"type": "array", "description": "Specify the cloud_account_id to which the template to be applied", "items": {"type": "string"}}, "regions": {"type": "array", "description": "Select the regions to which the template to be applied, when the AWS cloud account is selected", "items": {"type": "string"}}, "resource_groups": {"type": "array", "description": "Select the resource_groups to which the template to be applied, when the Azure cloud account is selected", "items": {"type": "string"}}, "monitoring_template_uri": {"type": "string", "description": "Specify the monitoring_template_uri of the template to be applied"}}, "type": "object"}, "ArgsDetails": {"required": ["job_details"], "properties": {"job_details": {"type": "array", "description": "The Job Details of the script", "items": {"$ref": "#/definitions/JobDetails"}}}, "type": "object"}, "AssessmentAgentScheduleRequest": {"allOf": [{"$ref": "#/definitions/AiAgentScheduleRequest"}, {"properties": {"configuration": {"description": "Report configuration to generate report", "$ref": "#/definitions/ReportConfigurationForAiAgent"}}, "type": "object"}], "x-cs-type-name": "AssessmentAgentScheduleRequest"}, "AssessmentComplianceResponse": {"properties": {"configuration_status": {"type": "string", "description": "Configuration Status"}, "summary": {"type": "object", "description": "Summary of validation result"}}, "type": "object"}, "AssessmentDefinitionListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AssessmentDefinitionListSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AssessmentFilter"}}, "type": "object"}, "AssessmentDefinitionListSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedOn", "UpdatedOn"], "x-cs-enum-type": "AssessmentDefinitionListSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AssessmentFilter": {"properties": {"tenant_id": {"type": "string", "description": "Tenant id"}, "query": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "AssessmentHistory": {"properties": {"compliance_uri": {"type": "string", "description": "URI of compliance standard"}, "assessment_job_number": {"type": "string", "description": "Unique Assessment job number of assessment triggered"}, "tenant_id": {"type": "string", "description": "Id of tenant"}, "created_at": {"type": "string", "format": "date-time", "description": "When was the assessment trigger created"}, "created_by": {"type": "string", "description": "Name of the user who triggered assessment"}, "updated_at": {"type": "string", "format": "date-time", "description": "When was the assessment trigger updated"}, "updated_by": {"type": "string", "description": "Name of the user who triggered assessment"}, "service_account_id": {"type": "string", "description": "Id of service account", "x-cs-type": "ObjectId"}, "assessment_status": {"type": "string", "description": "Status of assessment trigger", "example": "COMPLETED", "enum": ["COMPLETED", "FAILED", "IN_PROGRESS", "PENDING"], "x-cs-enum-type": "AssessmentStatus"}, "all_trails_processed": {"type": "boolean", "description": "Whether all audit trails processed"}, "assessment_type": {"type": "string", "description": "Type of assessment", "example": "standard", "enum": ["standard", "control"], "x-cs-enum-type": "AssessmentType"}, "execution_type": {"type": "string", "description": "Type of execution.", "example": "on_demand", "enum": ["on_demand", "scheduled"], "x-cs-enum-type": "AssessmentExecutionType"}, "assessment_summary": {"description": "Summary of Assessment", "$ref": "#/definitions/AssessmentSummaryData"}, "is_archive": {"type": "boolean", "description": "Archive status"}, "compliance_name": {"type": "string", "description": "Name of compliance standard"}, "service_account_name": {"type": "string", "description": "Name of Service account"}}, "type": "object"}, "AssessmentHistoryResponse": {"properties": {"total_count": {"type": "integer", "description": "Number of controls in the standard"}, "page_count": {"type": "integer", "description": "Page number"}, "assessment_history": {"type": "array", "description": "list of assessment history entries.", "items": {"$ref": "#/definitions/AssessmentHistory"}}}, "type": "object"}, "AssessmentPostureSummaryResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "success"}, "message": {"type": "string", "description": "compliance governance summary listed successfully"}, "data": {"type": "object", "description": "list of assessment posture summary enteries."}}, "type": "object"}, "AssessmentQueryAssessmentApprover": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["assessment_approvers"], "properties": {"assessment_approvers": {"type": "array", "description": "Approvers of assessment", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentQueryAssessmentApprover"}, "AssessmentQueryAssessmentName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["name"], "properties": {"name": {"type": "string", "description": "Regular expression to match against Assessment name"}}, "type": "object"}], "x-cs-type-name": "AssessmentQueryAssessmentName"}, "AssessmentQueryAssessmentOwner": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["assessment_owners"], "properties": {"assessment_owners": {"type": "array", "description": "Owners of assessment", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentQueryAssessmentOwner"}, "AssessmentQueryFramework": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["framework_ids"], "properties": {"framework_ids": {"type": "array", "description": "ID of framework", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentQueryFramework"}, "AssessmentQueryPillar": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["pillar_ids"], "properties": {"pillar_ids": {"type": "array", "description": "ID of pillar", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentQueryPillar"}, "AssessmentQueryWorkload": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["workload_ids"], "properties": {"workload_ids": {"type": "array", "description": "ID of the Workload Definition", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentQueryWorkload"}, "AssessmentReportQueryAssessmentName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"assessment_name": {"type": "string", "description": "Regular expression to match against Assessment name"}}, "type": "object"}], "x-cs-type-name": "AssessmentReportQueryAssessmentName"}, "AssessmentReportQueryFramework": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["framework_ids"], "properties": {"framework_ids": {"type": "array", "description": "ID of framework", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentReportQueryFramework"}, "AssessmentReportQueryReportType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["report_type"], "properties": {"report_type": {"type": "array", "description": "Report type for assessment run", "items": {"type": "string", "description": "Report type for assessment run", "example": "AssessmentRunDetail", "enum": ["AssessmentRunDetail", "AssessmentRunSummary", "AssessmentRunViolation"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunReportType"}}}, "type": "object"}], "x-cs-type-name": "AssessmentReportQueryReportType"}, "AssessmentReportQueryWorkloadId": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["workload_ids"], "properties": {"workload_ids": {"type": "array", "description": "ID of Workload", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentReportQueryWorkloadId"}, "AssessmentResultResponseDataModel": {"required": ["grade", "history", "last_assessed_time", "overall_status", "score", "summary"], "properties": {"overall_status": {"type": "string", "description": "Overall assessment status for the cloud account"}, "score": {"type": "string", "description": "Assessment score for the cloud account"}, "grade": {"type": "string", "description": "Grade based on the assessment for the cloud account"}, "last_assessed_time": {"type": "string", "description": "Last assessed time for the cloud account"}, "summary": {"type": "object", "description": "Summary of the assessment for the cloud account on OSCAR"}, "history": {"type": "object", "description": "History of the assessment for the cloud account on OSCAR"}}, "type": "object"}, "AssessmentRetriggerState": {"properties": {"AssessmentRunID": {"type": "string", "description": "Assessment Run ID"}, "AssessmentCategoryID": {"type": "string", "description": "Assessment Category ID"}, "ServiceAccountID": {"type": "string", "description": "Service Account ID"}, "AssessmentMode": {"type": "string", "description": "Assessment Mode"}, "InitiatedBy": {"type": "string", "description": "Initiated By"}}, "type": "object"}, "AssessmentRunReportDetailQuerySection": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["sections"], "properties": {"sections": {"type": "array", "description": "Section of workload assessment detailed report", "items": {"type": "string", "description": "Section of workload assessment detailed report", "example": "WorkloadAssessmentDetailsWithResources", "enum": ["WorkloadAssessmentDetailsWithResources", "WorkloadAssessmentSummary", "WorkloadAssessmentSummaryByBestPractices"], "x-cs-enum-type": "AssessmentRunReportDetailSection"}}}, "type": "object"}], "x-cs-type-name": "AssessmentRunReportDetailQuerySection"}, "AssessmentRunReportSummaryQuerySection": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["sections"], "properties": {"sections": {"type": "array", "description": "Section of workload assessment detailed report", "items": {"type": "string", "description": "Section of workload assessment detailed report", "example": "BestPracticeStatusByPillar", "enum": ["BestPracticeStatusByPillar", "QuestionStatusByPillar", "NumberOfBestPractices", "NumberOfQuestions", "SummaryOfResourceViolations"], "x-cs-enum-type": "AssessmentRunReportSummarySection"}}}, "type": "object"}], "x-cs-type-name": "AssessmentRunReportSummaryQuerySection"}, "AssessmentSummaryData": {"properties": {"violations": {"type": "integer", "description": "Number of controls violated"}, "failures": {"type": "integer", "description": "Number of controls that failed"}, "completed": {"type": "integer", "description": "Number of controls that executed successfully"}, "in_progress": {"type": "integer", "description": "Number of controls currently in progress"}}, "type": "object"}, "AssessmentValidationRequest": {"required": ["category", "cloud_account_id", "validation_type"], "properties": {"cloud_account_id": {"type": "string", "description": "Cloud Account Id"}, "category": {"type": "string", "description": "Name of the category", "example": "operations", "enum": ["operations", "security", "access", "cost", "resource", "compliance"], "x-cs-enum-type": "AssessmentCategory"}, "validation_type": {"type": "string", "description": "Type of Validation"}}, "type": "object"}, "AssessmentValidationRequestDataModel": {"required": ["category", "validation_type"], "properties": {"validation_type": {"type": "string", "description": "Type of validation for the cloud account. If post_onboarding is selected, then the category can only be cost/access/resource/operations/security. Post Onboarding applies for Governance Configuration", "example": "assessment", "enum": ["assessment", "post_onboarding"], "x-cs-enum-type": "ValidationType"}, "category": {"type": "string", "description": "Category of assessment validation for the cloud account", "example": "operations", "enum": ["operations", "security", "access", "cost", "resource", "compliance"], "x-cs-enum-type": "AssessmentCategory"}}, "type": "object"}, "AssessmentValidationResponse": {"required": ["mandatory_requirements", "optional_requirements", "status", "sub_category"], "properties": {"sub_category": {"type": "string", "description": "Sub Category of Assessment"}, "status": {"type": "string", "description": "Status of Assessment Validation"}, "mandatory_requirements": {"type": "object", "description": "Mandatory Requirements"}, "optional_requirements": {"type": "object", "description": "Optional Requirements"}, "configuration_status": {"type": "object", "description": "Configuration Status"}}, "type": "object"}, "AssessmentValidationResponseDataModel": {"required": ["data"], "properties": {"data": {"type": "object", "description": "Assessment validation response for the cloud account based on the category"}}, "type": "object"}, "AssessmentValidationResponseList": {"required": ["assessment_validation_list"], "properties": {"assessment_validation_list": {"type": "array", "description": "Assessment Validation data", "items": {"$ref": "#/definitions/AssessmentValidationResponse"}}}, "type": "object"}, "AssessmentViewQueryAssignedTo": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["assigned_to"], "properties": {"assigned_to": {"type": "array", "description": "User ID to whom the question is assigned to", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentViewQueryAssignedTo"}, "AssessmentViewQueryBestPracticeRisk": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["best_practice_risks"], "properties": {"best_practice_risks": {"type": "array", "description": "Risk of best practice", "items": {"type": "string", "description": "Risk of question or Best practice", "example": "Low", "enum": ["Low", "Medium", "High", "None"], "x-cs-enum-type": "WellArchitectedFrameworkRisk"}}}, "type": "object"}], "x-cs-type-name": "AssessmentViewQueryBestPracticeRisk"}, "AssessmentViewQueryBestPracticeStatus": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["best_practice_statuses"], "properties": {"best_practice_statuses": {"type": "array", "description": "Status of best practice", "items": {"type": "string", "description": "Status of the question or best practice", "example": "Open", "enum": ["Open", "NotApplicable", "Unanswered", "Verified", "VerifiedWithException"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunAnswerStatus"}}}, "type": "object"}], "x-cs-type-name": "AssessmentViewQueryBestPracticeStatus"}, "AssessmentViewQueryComment": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["comments"], "properties": {"comments": {"type": "array", "description": "User id who commented", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentViewQueryComment"}, "AssessmentViewQueryNature": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["natures"], "properties": {"natures": {"type": "array", "description": "Nature of the best practice", "items": {"type": "string", "description": "Nature of framework best practice", "example": "Automated", "enum": ["Automated", "Manual"], "x-cs-enum-type": "WellArchitectedFrameworkBestPracticeNature"}}}, "type": "object"}], "x-cs-type-name": "AssessmentViewQueryNature"}, "AssessmentViewQueryOwner": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["owners"], "properties": {"owners": {"type": "array", "description": "Owner of question", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AssessmentViewQueryOwner"}, "AssessmentViewQueryQuestionRisk": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["question_risks"], "properties": {"question_risks": {"type": "array", "description": "Risk of question", "items": {"type": "string", "description": "Risk of question or Best practice", "example": "Low", "enum": ["Low", "Medium", "High", "None"], "x-cs-enum-type": "WellArchitectedFrameworkRisk"}}}, "type": "object"}], "x-cs-type-name": "AssessmentViewQueryQuestionRisk"}, "AssessmentViewQueryQuestionStatus": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["question_statuses"], "properties": {"question_statuses": {"type": "array", "description": "Status of question", "items": {"type": "string", "description": "Status of the question or best practice", "example": "Open", "enum": ["Open", "NotApplicable", "Unanswered", "Verified", "VerifiedWithException"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunAnswerStatus"}}}, "type": "object"}], "x-cs-type-name": "AssessmentViewQueryQuestionStatus"}, "Attachment": {"required": ["file_name", "name"], "properties": {"id": {"type": "string"}, "created_at": {"type": "string", "format": "date-time", "description": "Date and Time of the attachment"}, "created_by": {"type": "string", "description": "Creator of the attachment"}, "updated_at": {"type": "string", "format": "date-time", "description": "Last update of the attachment"}, "updated_by": {"type": "string", "description": "Updated By"}, "name": {"type": "string", "description": "Name of the attachment"}, "description": {"type": "string", "description": "Description of the attachment"}, "file_name": {"type": "string", "description": "Original file name of the attachment"}}, "type": "object"}, "AttachmentStorageAzureBlob": {"allOf": [{"$ref": "#/definitions/AttachmentStorageBase"}, {"required": ["blob_path", "secure_access_url"], "properties": {"secure_access_url": {"type": "string"}, "blob_path": {"type": "string", "description": "Path to the blob in Azure storage"}}, "type": "object"}], "x-cs-type-name": "AttachmentStorageAzureBlob"}, "AttachmentStorageBase": {"required": ["__type"], "properties": {"file_name": {"type": "string", "description": "Original file name"}, "size": {"type": "integer", "description": "Size of file in bytes"}, "created_at": {"type": "string", "format": "date-time", "description": "Date and Time of the attachment creation"}, "expires_at": {"type": "string", "format": "date-time", "description": "Date and Time when the attachment expires. If not set, the attachment does not expire."}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "AttachmentStorageCorestack", "subtype_name": "AttachmentStorageCorestack"}, {"subtype_model": "AttachmentStorageAzureBlob", "subtype_name": "AttachmentStorageAzureBlob"}]}, "AttachmentStorageCorestack": {"allOf": [{"$ref": "#/definitions/AttachmentStorageBase"}, {"required": ["sys_id"], "properties": {"sys_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "AttachmentStorageCorestack"}, "AttributeDefinitionBase": {"required": ["__type", "name"], "properties": {"name": {"type": "string", "description": "Name of the Attribute"}, "mandatory": {"type": "boolean", "description": "Is the dimensions attribute mandatory"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "AttributeDefinitionForBoolean", "subtype_name": "AttributeDefinitionForBoolean"}, {"subtype_model": "AttributeDefinitionForString", "subtype_name": "AttributeDefinitionForString"}, {"subtype_model": "AttributeDefinitionForNumber", "subtype_name": "AttributeDefinitionForNumber"}, {"subtype_model": "AttributeDefinitionForDateTime", "subtype_name": "AttributeDefinitionForDateTime"}]}, "AttributeDefinitionForBoolean": {"allOf": [{"$ref": "#/definitions/AttributeDefinitionBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "AttributeDefinitionForBoolean"}, "AttributeDefinitionForDateTime": {"allOf": [{"$ref": "#/definitions/AttributeDefinitionBase"}, {"required": ["min_date"], "properties": {"min_date": {"type": "string", "format": "date-time", "description": "Minimum Allowed Date"}, "max_date": {"type": "string", "format": "date-time", "description": "Maximum Allowed Date"}}, "type": "object"}], "x-cs-type-name": "AttributeDefinitionForDateTime"}, "AttributeDefinitionForNumber": {"allOf": [{"$ref": "#/definitions/AttributeDefinitionBase"}, {"properties": {"min": {"type": "number", "description": "Minimum allowed value"}, "max": {"type": "number", "description": "Maximum allowed value"}}, "type": "object"}], "x-cs-type-name": "AttributeDefinitionForNumber"}, "AttributeDefinitionForString": {"allOf": [{"$ref": "#/definitions/AttributeDefinitionBase"}, {"properties": {"is_multiple_values_allowed": {"type": "boolean", "description": "Is it a multi select field"}, "allowed_values": {"type": "array", "description": "Possible values for the field", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AttributeDefinitionForString"}, "AttributeDetails": {"required": ["service_accounts"], "properties": {"service_accounts": {"type": "array", "description": "Service account id is unique can be obtained from the list cloud", "items": {"$ref": "#/definitions/CloudAccountDetails"}}}, "type": "object"}, "AttributeValueBase": {"required": ["__type", "name"], "properties": {"name": {"type": "string", "description": "Name of the Attribute"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "AttributeValueForBoolean", "subtype_name": "AttributeValueForBoolean"}, {"subtype_model": "AttributeValueForString", "subtype_name": "AttributeValueForString"}, {"subtype_model": "AttributeValueForNumber", "subtype_name": "AttributeValueForNumber"}, {"subtype_model": "AttributeValueForDateTime", "subtype_name": "AttributeValueForDateTime"}]}, "AttributeValueForBoolean": {"allOf": [{"$ref": "#/definitions/AttributeValueBase"}, {"properties": {"value": {"type": "boolean", "description": "Value for the Attribute"}}, "type": "object"}], "x-cs-type-name": "AttributeValueForBoolean"}, "AttributeValueForDateTime": {"allOf": [{"$ref": "#/definitions/AttributeValueBase"}, {"properties": {"value": {"type": "string", "format": "date-time", "description": "Value for the Attribute"}}, "type": "object"}], "x-cs-type-name": "AttributeValueForDateTime"}, "AttributeValueForNumber": {"allOf": [{"$ref": "#/definitions/AttributeValueBase"}, {"properties": {"value": {"type": "number", "description": "Values for the Attribute"}}, "type": "object"}], "x-cs-type-name": "AttributeValueForNumber"}, "AttributeValueForString": {"allOf": [{"$ref": "#/definitions/AttributeValueBase"}, {"properties": {"values": {"type": "array", "description": "Values for the Attribute", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AttributeValueForString"}, "AuditLogBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AuditLogDocument"}}}, "type": "object"}, "AuditLogCreateRequest": {"required": ["event_action", "event_type", "master_account_id", "master_account_name", "tenant_name", "user_name"], "properties": {"event_type": {"type": "string", "description": "Type of the event performed.", "example": "Activity", "enum": ["Activity", "AiAgent", "Alarm", "AlarmListener", "Alert", "Application", "AuthConfig", "AutomationWorkflows", "AwsSsm", "Billing", "BillingPlans", "Blueprint", "BlueprintJobs", "Catalog", "CloudAccount", "ComplianceStandard", "CostAnomaly", "CostAnomalyDashboard", "CostBudget", "CostBudgetAction", "CostBudgetAlert", "CostBudgetNotification", "CostBudgetReview", "CostDashboard", "CostMarkupDiscount", "CostOptimization", "CostOptimizer", "CostPosture", "CurrencyExchangeConfiguration", "CustomTags", "Dimension", "GovernanceConfiguration", "IntegratedTool", "Inventory", "InventoryElements", "KubernetesCluster", "LogAnalyticsWorkspaces", "MasterAccount", "Policy", "PolicyRecommendation", "PolicyParameterConfiguration", "Portfolio", "Project", "RecommendationExclusionRule", "Report", "Request", "Request-iaas", "Request-workload", "RequestApproval-iaas", "RequestApproval-workload", "RequestJob", "ResourceCatalog", "RoleAccessPolicies", "SaaS", "Sbom", "Scheduler", "ScriptComponent", "ScriptJobs", "Scripts", "Services", "StackOpsApprove", "StackOpsDeployment", "StackOpsProduct", "StackOpsPublish", "StackOpsStack", "SwitchMasterAccount", "Template", "TemplateBuilder", "TemplateJobs", "Tenant", "User", "UserDelegation", "UserGroup", "UserInvite", "UserLogin", "WellArchitectedAssessment", "WellArchitectedAssessmentRun", "WellArchitectedCustomFramework", "WellArchitectedWorkload", "WorkloadComponent"], "x-cs-enum-type": "AuditLogEventType"}, "event_action": {"type": "string", "description": "Type of the action performed.", "example": "abandon", "enum": ["abandon", "activate", "add_balance", "add_role", "add_tenant", "add_user", "apply", "approve", "archive", "cancel", "clone", "configure", "create", "deactivate", "definition", "delete", "disable", "dismiss", "download", "enable", "execute", "export", "import", "inventory_action", "login", "open", "postpone", "publish", "reactivate", "reject", "remediate", "remove_role", "remove_tenant", "remove_user", "retry", "reorder", "request_review", "rerun", "resolve", "revoke", "save_commit", "schedule", "set_defaults", "share", "share_report", "start_scan", "submit", "suspend", "terminate", "trigger", "update", "version"], "x-cs-enum-type": "AuditLogEventAction"}, "master_account_id": {"type": "string", "description": "The id of the account master within the CoreStack."}, "master_account_name": {"type": "string", "description": "The name of the account master within the CoreStack."}, "tenant_name": {"type": "string", "description": "The name of the tenant within the CoreStack account."}, "user_name": {"type": "string", "description": "The name of the user who performed the action."}, "source_ip_address": {"type": "string", "description": "IP from which the action is performed."}, "activity": {"type": "string", "description": "Description for the action done by user."}}, "type": "object"}, "AuditLogDocument": {"properties": {"sysId": {"type": "string", "description": "Id of the document."}, "event_time": {"type": "string", "format": "date-time", "description": "Time of document creation."}, "event_type": {"type": "string", "description": "Type of the event performed.", "example": "Activity", "enum": ["Activity", "AiAgent", "Alarm", "AlarmListener", "Alert", "Application", "AuthConfig", "AutomationWorkflows", "AwsSsm", "Billing", "BillingPlans", "Blueprint", "BlueprintJobs", "Catalog", "CloudAccount", "ComplianceStandard", "CostAnomaly", "CostAnomalyDashboard", "CostBudget", "CostBudgetAction", "CostBudgetAlert", "CostBudgetNotification", "CostBudgetReview", "CostDashboard", "CostMarkupDiscount", "CostOptimization", "CostOptimizer", "CostPosture", "CurrencyExchangeConfiguration", "CustomTags", "Dimension", "GovernanceConfiguration", "IntegratedTool", "Inventory", "InventoryElements", "KubernetesCluster", "LogAnalyticsWorkspaces", "MasterAccount", "Policy", "PolicyRecommendation", "PolicyParameterConfiguration", "Portfolio", "Project", "RecommendationExclusionRule", "Report", "Request", "Request-iaas", "Request-workload", "RequestApproval-iaas", "RequestApproval-workload", "RequestJob", "ResourceCatalog", "RoleAccessPolicies", "SaaS", "Sbom", "Scheduler", "ScriptComponent", "ScriptJobs", "Scripts", "Services", "StackOpsApprove", "StackOpsDeployment", "StackOpsProduct", "StackOpsPublish", "StackOpsStack", "SwitchMasterAccount", "Template", "TemplateBuilder", "TemplateJobs", "Tenant", "User", "UserDelegation", "UserGroup", "UserInvite", "UserLogin", "WellArchitectedAssessment", "WellArchitectedAssessmentRun", "WellArchitectedCustomFramework", "WellArchitectedWorkload", "WorkloadComponent"], "x-cs-enum-type": "AuditLogEventType"}, "event_action": {"type": "string", "description": "Type of the action performed.", "example": "abandon", "enum": ["abandon", "activate", "add_balance", "add_role", "add_tenant", "add_user", "apply", "approve", "archive", "cancel", "clone", "configure", "create", "deactivate", "definition", "delete", "disable", "dismiss", "download", "enable", "execute", "export", "import", "inventory_action", "login", "open", "postpone", "publish", "reactivate", "reject", "remediate", "remove_role", "remove_tenant", "remove_user", "retry", "reorder", "request_review", "rerun", "resolve", "revoke", "save_commit", "schedule", "set_defaults", "share", "share_report", "start_scan", "submit", "suspend", "terminate", "trigger", "update", "version"], "x-cs-enum-type": "AuditLogEventAction"}, "master_account_id": {"type": "string", "description": "The id of the account master within the CoreStack."}, "master_account_name": {"type": "string", "description": "The name of the account master within the CoreStack."}, "tenant_name": {"type": "string", "description": "The name of the tenant within the CoreStack account."}, "user_name": {"type": "string", "description": "The name of the user who performed the action."}, "source_ip_address": {"type": "string", "description": "IP from which the action is performed."}, "activity": {"type": "string", "description": "Description of the activity done."}}, "type": "object"}, "AuditLogDocumentSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "event_time", "enum": ["event_time"], "x-cs-enum-type": "AuditLogDocumentSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AuditLogFilters": {"properties": {"from_date": {"type": "string", "format": "date-time", "description": "Filter from date"}, "to_date": {"type": "string", "format": "date-time", "description": "Filter to date"}, "master_account_id": {"type": "array", "description": "Filter by master account ids", "items": {"type": "string"}}, "master_account_names": {"type": "array", "description": "Filter by accounts", "items": {"type": "string"}}, "tenant_names": {"type": "array", "description": "Filter by tenants", "items": {"type": "string"}}, "user_names": {"type": "array", "description": "Filter by users", "items": {"type": "string"}}, "event_types": {"type": "array", "description": "Filter by event types", "items": {"type": "string", "description": "Type of the event performed.", "example": "Activity", "enum": ["Activity", "AiAgent", "Alarm", "AlarmListener", "Alert", "Application", "AuthConfig", "AutomationWorkflows", "AwsSsm", "Billing", "BillingPlans", "Blueprint", "BlueprintJobs", "Catalog", "CloudAccount", "ComplianceStandard", "CostAnomaly", "CostAnomalyDashboard", "CostBudget", "CostBudgetAction", "CostBudgetAlert", "CostBudgetNotification", "CostBudgetReview", "CostDashboard", "CostMarkupDiscount", "CostOptimization", "CostOptimizer", "CostPosture", "CurrencyExchangeConfiguration", "CustomTags", "Dimension", "GovernanceConfiguration", "IntegratedTool", "Inventory", "InventoryElements", "KubernetesCluster", "LogAnalyticsWorkspaces", "MasterAccount", "Policy", "PolicyRecommendation", "PolicyParameterConfiguration", "Portfolio", "Project", "RecommendationExclusionRule", "Report", "Request", "Request-iaas", "Request-workload", "RequestApproval-iaas", "RequestApproval-workload", "RequestJob", "ResourceCatalog", "RoleAccessPolicies", "SaaS", "Sbom", "Scheduler", "ScriptComponent", "ScriptJobs", "Scripts", "Services", "StackOpsApprove", "StackOpsDeployment", "StackOpsProduct", "StackOpsPublish", "StackOpsStack", "SwitchMasterAccount", "Template", "TemplateBuilder", "TemplateJobs", "Tenant", "User", "UserDelegation", "UserGroup", "UserInvite", "UserLogin", "WellArchitectedAssessment", "WellArchitectedAssessmentRun", "WellArchitectedCustomFramework", "WellArchitectedWorkload", "WorkloadComponent"], "x-cs-enum-type": "AuditLogEventType"}}, "event_actions": {"type": "array", "description": "Filter by event actions", "items": {"type": "string", "description": "Type of the action performed.", "example": "abandon", "enum": ["abandon", "activate", "add_balance", "add_role", "add_tenant", "add_user", "apply", "approve", "archive", "cancel", "clone", "configure", "create", "deactivate", "definition", "delete", "disable", "dismiss", "download", "enable", "execute", "export", "import", "inventory_action", "login", "open", "postpone", "publish", "reactivate", "reject", "remediate", "remove_role", "remove_tenant", "remove_user", "retry", "reorder", "request_review", "rerun", "resolve", "revoke", "save_commit", "schedule", "set_defaults", "share", "share_report", "start_scan", "submit", "suspend", "terminate", "trigger", "update", "version"], "x-cs-enum-type": "AuditLogEventAction"}}}, "type": "object"}, "AuditLogListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AuditLogDocumentSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AuditLogFilters"}}, "type": "object"}, "AuditModel": {"properties": {"enabled": {"type": "boolean", "description": "Whether audit log is enabled or not."}, "audit_level": {"type": "string", "description": "Audit log level."}}, "type": "object"}, "AuthDetailedResponse": {"required": ["account_id", "auth_method", "auth_type", "banner_logo", "cost_currency", "cost_unit", "footer_text", "header_logo", "is_account_admin", "is_product_admin", "require_access_key", "subscription_details", "tenants", "token", "user"], "properties": {"auth_type": {"type": "string", "description": "Authentication type."}, "require_access_key": {"type": "boolean", "description": "Whether access key required."}, "account_id": {"type": "string", "description": "Account id."}, "is_account_admin": {"type": "boolean", "description": "Whether account admin or not."}, "header_logo": {"type": "string", "description": "Header logo."}, "banner_logo": {"type": "string", "description": "Banner logo."}, "user": {"description": "Token.", "$ref": "#/definitions/UserModel"}, "auth_method": {"type": "string", "description": "Authentication method."}, "tenants": {"type": "array", "description": "Tenants list.", "items": {"$ref": "#/definitions/DetailTenantModel"}}, "audit": {"description": "Audit details", "$ref": "#/definitions/AuditModel"}, "cost_unit": {"type": "string", "description": "Constant unit."}, "subscription_details": {"type": "object", "description": "Subscription details."}, "is_product_admin": {"type": "boolean", "description": "Whether Product admin or not."}, "token": {"description": "Token.", "$ref": "#/definitions/Authorization"}, "cost_currency": {"type": "string", "description": "Cost currency."}, "footer_text": {"type": "string", "description": "Footer text."}, "user_guide_url": {"type": "string", "description": "User Guide URL"}, "support_url": {"type": "string", "description": "Support URL"}, "terms_and_conditions_url": {"type": "string", "description": "Terms and Conditions URL"}}, "type": "object"}, "AuthRequest": {"properties": {"access_key": {"type": "string", "description": "API Access Key. This can be retrieved from the <b>My Profile</b> page. Also this will be sent over email when the keys are generated.Please enter username and password pair or access_key and secret_key pair"}, "secret_key": {"type": "string", "description": "API Secret Key. This will be available in the email sent when the keys are generated. If you have lost the secret key, it cannot be retrieved. Request your admin to generate a new set of keys, if lost.Please enter username and password pair or access_key and secret_key pair"}, "username": {"type": "string", "description": "User name which will be used to login to corestack.Please enter username and password pair or access_key and secret_key pair"}, "password": {"type": "string", "description": "Password which will be used to login to corestack.Please enter username and password pair or access_key and secret_key pair"}}, "type": "object"}, "AuthResponse": {"required": ["account_id", "banner_logo", "header_logo", "is_account_admin", "tenants", "token", "user"], "properties": {"token": {"description": "This contains the atrributes access_token, expires_at & issued_at. access_token will be  passed with X-Auth-Token header in all other  APIs for authentication.", "$ref": "#/definitions/Authorization"}, "header_logo": {"type": "string", "description": "Header logo."}, "banner_logo": {"type": "string", "description": "Banner logo."}, "user": {"description": "Contains information about the user associated with the Access Key / Secret Key.", "$ref": "#/definitions/UserModel"}, "account_id": {"type": "string", "description": "Id of the Account in CoreStack. There can be multiple tenats within an account, so account_id will be required for performing account level actions such as createTenant."}, "is_account_admin": {"type": "boolean", "description": "Implies the user associated with Access Key / Secret Key is an account admin in CoreStack. True means account admin."}, "tenants": {"type": "array", "description": "List of tenants within the CoreStack account. Each tenant will have an id & name that uniquely identifies it.", "items": {"$ref": "#/definitions/TokenTenantModel"}}, "audit": {"description": "Audit details", "$ref": "#/definitions/AuditModel"}, "user_guide_url": {"type": "string", "description": "User Guide URL"}, "support_url": {"type": "string", "description": "Support URL"}, "terms_and_conditions_url": {"type": "string", "description": "Terms and Conditions URL"}}, "type": "object"}, "Authorization": {"required": ["access_token", "expires_at", "issued_at"], "properties": {"issued_at": {"type": "string", "description": "DateTime in UTC when the token was issued."}, "expires_at": {"type": "string", "description": "Token expiry datetime in UTC."}, "access_token": {"type": "string", "description": "This will be used as X-Auth-Token in all other APIs."}}, "type": "object"}, "AutomationTemplate": {"required": ["content", "content_files", "content_type", "created_at", "created_by", "description", "name", "scope", "services", "updated_at", "updated_by"], "properties": {"sysId": {"type": "string", "description": "ID of the template"}, "services": {"type": "array", "description": "Service(s) associated with the template.", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "name": {"type": "string", "description": "Name of the template"}, "content": {"type": "string", "description": "Raw content of the template which is usually in YAML or JSON format"}, "content_type": {"type": "string", "description": "Template content source (git, file)"}, "content_url": {"type": "string", "description": "Git project URL when the content type is git required only in case of content type git"}, "content_files": {"type": "string", "description": "Details about content like its data,filename"}, "description": {"type": "string", "description": "Usage of template"}, "resources": {"type": "string", "description": "Resources created/modified by the template"}, "resource_types": {"type": "array", "description": "Resource Types for Services.", "items": {"$ref": "#/definitions/AutomationTemplateResourceTypesMapping"}}, "status": {"type": "string", "description": "Status of the template[active/inactive]. Only active templates can be executed"}, "sub_classifications": {"type": "array", "description": "Sub classification of the template", "items": {"$ref": "#/definitions/AutomationTemplateSubClassification"}}, "template_types": {"type": "array", "description": "Type of the template like Cloud, Monitoring, Orchestration., etc", "items": {"type": "string"}}, "engine_type": {"type": "string", "description": "Engine type of the template"}, "classifications": {"type": "array", "description": "Classification of the template", "items": {"type": "string"}}, "scope": {"type": "string", "description": "Scope of the template [MarketPlace, MyTemplates]"}, "created_by": {"type": "string", "description": "Name of the user who created the template."}, "created_at": {"type": "string", "description": "Template creation time"}, "updated_by": {"type": "string", "description": "Name of the user who updated the templated. "}, "updated_at": {"type": "string", "description": "Template updated time"}, "blueprint_support": {"type": "boolean", "description": "Blueprint support for the template"}}, "type": "object"}, "AutomationTemplateFilters": {"properties": {"from_date": {"type": "string", "format": "date-time", "description": "Filter from date"}, "to_date": {"type": "string", "format": "date-time", "description": "Filter to date"}, "scope": {"type": "string", "description": "Scope of the template.", "example": "MyTemplates", "enum": ["MyTemplates", "Marketplace"], "x-cs-enum-type": "AutomationTemplateScope"}, "template_name": {"type": "string", "description": "Name of the template"}, "query": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "AutomationTemplateListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AutomationTemplateSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AutomationTemplateFilters"}}, "type": "object"}, "AutomationTemplateQueryEngineType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["engine_types"], "properties": {"engine_types": {"type": "array", "description": "DSL type of the template", "items": {"type": "string", "description": "Type of template engine/dsl", "example": "cfn", "enum": ["cfn", "arm", "terraform", "mistral", "heat", "oracle", "dm"], "x-cs-enum-type": "TemplateEngineType"}}}, "type": "object"}], "x-cs-type-name": "AutomationTemplateQueryEngineType"}, "AutomationTemplateQueryRepoType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["repo_types"], "properties": {"repo_types": {"type": "array", "description": "Repo type of the template", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AutomationTemplateQueryRepoType"}, "AutomationTemplateQueryService": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["services"], "properties": {"services": {"type": "array", "description": "Service(s) associated with the template.", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}}, "type": "object"}], "x-cs-type-name": "AutomationTemplateQueryService"}, "AutomationTemplateQueryTenant": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "Tenant of the template", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AutomationTemplateQueryTenant"}, "AutomationTemplateResourceTypesMapping": {"properties": {"service_name": {"type": "string", "description": "Cloud Service and it's resource type.", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "resource_types": {"type": "array", "description": "Resource type of the service.", "items": {"type": "string"}}}, "type": "object"}, "AutomationTemplateSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CreatedAt", "enum": ["CreatedAt", "UpdatedAt", "Name"], "x-cs-enum-type": "AutomationTemplateSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AutomationTemplateSubClassification": {"properties": {"key": {"type": "string", "description": "List sub-classification based on templates."}, "classifications": {"type": "array", "description": "List of sub-classification for templates.", "items": {"type": "string"}}}, "type": "object"}, "AvailabilityZoneQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["availability_zones"], "properties": {"availability_zones": {"type": "array", "description": "Availability zones to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AvailabilityZoneQueryOperator"}, "AwsSecurityHubFinding": {"properties": {"severity": {"type": "string", "description": "Severity label", "example": "Informational", "enum": ["Informational", "Medium", "Low", "High", "Critical"], "x-cs-enum-type": "AwsSecurityHubSeverity"}, "record_state": {"type": "string", "description": "Record status", "example": "Active", "enum": ["Active", "Archived"], "x-cs-enum-type": "AwsSecurityHubRecordState"}, "workflow_status": {"type": "string", "description": "Workflow status", "example": "New", "enum": ["New", "Notified", "Suppressed", "Resolved"], "x-cs-enum-type": "AwsSecurityHubWorkflowStatus"}, "region": {"type": "string", "description": "Findings region"}, "aws_account_id": {"type": "string", "description": "AWS account id"}, "cloud_account_id": {"type": "string", "description": "Corestack cloud account id"}, "company_name": {"type": "string", "description": "Company name"}, "product_name": {"type": "string", "description": "Product name"}, "title": {"type": "string", "description": "Findings title"}, "resources": {"type": "array", "description": "Impacted resources", "items": {"$ref": "#/definitions/AwsSecurityHubFindingResource"}}, "compliance_status": {"type": "string", "description": "Compliance status", "example": "Passed", "enum": ["Passed", "Failed", "NotAvailable"], "x-cs-enum-type": "AwsSecurityHubComplianceStatus"}, "compliance_related_requirements": {"type": "array", "description": "Related Contorl ARN", "items": {"type": "string"}}, "compliance_security_control_id": {"type": "string"}, "compliance_rule": {"type": "string"}, "compliance_associated_standards": {"type": "array", "description": "Associated Compliance Standards", "items": {"type": "string"}}, "finding_created_at": {"type": "string", "format": "date-time", "description": "Findings created time"}, "finding_updated_at": {"type": "string", "format": "date-time", "description": "Findings updated time"}, "description": {"type": "string", "description": "Findings description"}, "finding_id": {"type": "string", "description": "Finding Id"}, "recommendation_text": {"type": "string", "description": "Recommendation description"}, "recommendation_url": {"type": "string", "description": "Recommendation Link"}, "finding_provider_severity": {"type": "string", "description": "Severity label", "example": "Informational", "enum": ["Informational", "Medium", "Low", "High", "Critical"], "x-cs-enum-type": "AwsSecurityHubSeverity"}, "finding_provider_types": {"type": "array", "description": "Resource Id", "items": {"type": "string"}}, "finding_provider_related_findings": {"type": "array", "description": "Related findings", "items": {"type": "string"}}}, "type": "object"}, "AwsSecurityHubFindingBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AwsSecurityHubFinding"}}}, "type": "object"}, "AwsSecurityHubFindingData": {"properties": {"cloud_account_id": {"type": "string", "description": "Corestack cloud account id"}, "tenant_id": {"type": "string", "description": "Corestack cloud tenant id"}, "severity": {"type": "string", "description": "Severity label", "example": "Informational", "enum": ["Informational", "Medium", "Low", "High", "Critical"], "x-cs-enum-type": "AwsSecurityHubSeverity"}, "finding_id": {"type": "string", "description": "Finding Id"}, "title": {"type": "string", "description": "Findings title"}, "description": {"type": "string", "description": "Findings description"}, "product_name": {"type": "string", "description": "Product name"}, "company_name": {"type": "string", "description": "Company name"}, "aws_account_id": {"type": "string", "description": "AWS account id"}, "workflow_status": {"type": "string", "description": "Workflow status", "example": "New", "enum": ["New", "Notified", "Suppressed", "Resolved"], "x-cs-enum-type": "AwsSecurityHubWorkflowStatus"}, "record_state": {"type": "string", "description": "Record status", "example": "Active", "enum": ["Active", "Archived"], "x-cs-enum-type": "AwsSecurityHubRecordState"}, "region": {"type": "string", "description": "Findings region"}, "finding_created_at": {"type": "string", "format": "date-time", "description": "Findings created in AWS time"}, "finding_updated_at": {"type": "string", "format": "date-time", "description": "Findings updated AWS time"}, "created_at": {"type": "string", "format": "date-time", "description": "Findings created time"}, "updated_at": {"type": "string", "format": "date-time", "description": "Findings updated time"}, "resources": {"type": "array", "description": "Impacted resources", "items": {"$ref": "#/definitions/AwsSecurityHubFindingResource"}}, "recommendation_text": {"type": "string", "description": "Recommendation description"}, "recommendation_url": {"type": "string", "description": "Recommendation Link"}, "compliance_status": {"type": "string", "description": "Compliance status", "example": "Passed", "enum": ["Passed", "Failed", "NotAvailable"], "x-cs-enum-type": "AwsSecurityHubComplianceStatus"}, "compliance_related_requirements": {"type": "array", "description": "Related Contorl ARN", "items": {"type": "string"}}, "compliance_associated_standards": {"type": "array", "description": "Associated Compliance Standards", "items": {"type": "string"}}, "compliance_security_control_id": {"type": "string"}, "compliance_rule": {"type": "string"}, "finding_provider_severity": {"type": "string", "description": "Severity label", "example": "Informational", "enum": ["Informational", "Medium", "Low", "High", "Critical"], "x-cs-enum-type": "AwsSecurityHubSeverity"}, "finding_provider_types": {"type": "array", "description": "Resource Id", "items": {"type": "string"}}, "finding_provider_related_findings": {"type": "array", "description": "Related findings", "items": {"type": "string"}}, "first_observed_at": {"type": "string", "format": "date-time", "description": "Findings first observed  time"}, "last_observed_at": {"type": "string", "format": "date-time", "description": "Findings last observed time"}, "generator_id": {"type": "string", "description": "Findings Generator Id"}, "source_account_id": {"type": "string", "description": "Source Corestack Account Id"}}, "type": "object"}, "AwsSecurityHubFindingFilters": {"properties": {"text_search_value": {"type": "string", "description": "Text filter the tag keys"}, "filters": {"description": "Account filters for the tags", "$ref": "#/definitions/AccountFilters"}, "findings_filter": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "AwsSecurityHubFindingListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AwsSecurityHubFindingSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AwsSecurityHubFindingFilters"}}, "type": "object"}, "AwsSecurityHubFindingProductNameRequest": {"properties": {"tenant_id": {"type": "string", "description": "Which tenant Id to fetch product names for"}}, "type": "object"}, "AwsSecurityHubFindingProductNameResponse": {"properties": {"product_names": {"type": "array", "description": "List of Product Names", "items": {"type": "string"}}}, "type": "object"}, "AwsSecurityHubFindingQueryCloudAccount": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["cloud_account_ids"], "properties": {"cloud_account_ids": {"type": "array", "description": "Cloud Accounts for the resources", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSecurityHubFindingQueryCloudAccount"}, "AwsSecurityHubFindingQueryLocation": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["regions"], "properties": {"regions": {"type": "array", "description": "Regions for the findings", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSecurityHubFindingQueryLocation"}, "AwsSecurityHubFindingQueryProductName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["product_names"], "properties": {"product_names": {"type": "array", "description": "Product names for the findings", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSecurityHubFindingQueryProductName"}, "AwsSecurityHubFindingQueryRecordState": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["record_states"], "properties": {"record_states": {"type": "array", "description": "Record States for the resources", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSecurityHubFindingQueryRecordState"}, "AwsSecurityHubFindingQueryResource": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resources"], "properties": {"resources": {"type": "array", "description": "Resource fields for the resources", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSecurityHubFindingQueryResource"}, "AwsSecurityHubFindingQuerySeverity": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["severities"], "properties": {"severities": {"type": "array", "description": "Severities for the findings", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSecurityHubFindingQuerySeverity"}, "AwsSecurityHubFindingRecordStatesRequest": {"properties": {"tenant_id": {"type": "string", "description": "Which tenant Id to fetch record states for"}}, "type": "object"}, "AwsSecurityHubFindingRecordStatesResponse": {"properties": {"record_states": {"type": "array", "description": "List of Record States", "items": {"type": "string"}}}, "type": "object"}, "AwsSecurityHubFindingRegionRequest": {"properties": {"tenant_id": {"type": "string", "description": "Which tenant Id to fetch regions for"}}, "type": "object"}, "AwsSecurityHubFindingRegionResponse": {"properties": {"regions": {"type": "array", "description": "List of Regions", "items": {"type": "string"}}}, "type": "object"}, "AwsSecurityHubFindingResource": {"properties": {"type": {"type": "string", "description": "Resource Type"}, "id": {"type": "string", "description": "Resource Id"}, "region": {"type": "string", "description": "Resource Region"}}, "type": "object"}, "AwsSecurityHubFindingResourcesRequest": {"properties": {"tenant_id": {"type": "string", "description": "Which tenant Id to fetch regions for"}}, "type": "object"}, "AwsSecurityHubFindingResourcesResponse": {"properties": {"resources": {"type": "array", "description": "List of Resources", "items": {"type": "string"}}}, "type": "object"}, "AwsSecurityHubFindingSeverityRequest": {"properties": {"tenant_id": {"type": "string", "description": "Which tenant Id to fetch severities for"}}, "type": "object"}, "AwsSecurityHubFindingSeverityResponse": {"properties": {"severities": {"type": "array", "description": "List of Severities", "items": {"type": "string"}}}, "type": "object"}, "AwsSecurityHubFindingSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "created_at", "enum": ["created_at"], "x-cs-enum-type": "AwsSecurityHubFindingSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AwsSecurityHubRegionDetail": {"properties": {"region": {"type": "string", "description": "AWS security hub region"}, "status": {"type": "string", "description": "Permission validation status", "example": "Success", "enum": ["Success", "Failed", "InProgress"], "x-cs-enum-type": "AwsSecurityHubPermissionValidationStatus"}, "message": {"type": "string", "description": "AWS security hub status message"}}, "type": "object"}, "AwsSsmAutomationExecution": {"allOf": [{"$ref": "#/definitions/AwsSsmBaseExecution"}, {"properties": {"step_execution_truncated": {"type": "boolean", "description": "Flag to check if the executed step is truncated."}, "mode": {"type": "string", "description": "Mode of the Base Execution", "example": "Auto", "enum": ["Auto", "Interactive"], "x-cs-enum-type": "AwsSsmBaseExecutionMode"}, "executed_by": {"type": "string", "description": "IAM ARN of the user who executed the document"}, "automation_type": {"type": "string", "description": "Type of the automation document"}, "outputs": {"type": "object", "description": "Output fields of the step", "additionalProperties": {"type": "string"}}, "resolved_targets": {"description": "resolved target resources", "$ref": "#/definitions/AwsSsmResolvedTarget"}, "failure_message": {"type": "string", "description": "Failure message of the job."}}, "type": "object"}], "x-cs-type-name": "AwsSsmAutomationExecution"}, "AwsSsmAutomationFilter": {"allOf": [{"$ref": "#/definitions/AwsSsmExecutionFilter"}, {"properties": {"status": {"type": "string", "description": "Status of the Automation Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"], "x-cs-enum-type": "AwsSsmAutomationExecutionStatus"}}, "type": "object"}], "x-cs-type-name": "AwsSsmAutomationFilter"}, "AwsSsmBaseDocumentFilter": {"required": ["flavor"], "properties": {"cloud_account_details": {"type": "array", "description": "Id and name of the cloud accounts.", "items": {"$ref": "#/definitions/AwsSsmCloudAccount"}}, "regions": {"type": "array", "description": "Regions based on the available documents.", "items": {"type": "string"}}}, "discriminator": "flavor", "type": "object", "x-cs-subtypes": [{"subtype_model": "AwsSsmExecutionFilter", "subtype_name": "AwsSsmExecutionFilter"}, {"subtype_model": "AwsSsmAutomationFilter", "subtype_name": "AwsSsmAutomationFilter"}, {"subtype_model": "AwsSsmCommandFilter", "subtype_name": "AwsSsmCommandFilter"}, {"subtype_model": "AwsSsmDocumentFilter", "subtype_name": "AwsSsmDocumentFilter"}]}, "AwsSsmBaseExecuteDocumentRequest": {"required": ["cloud_account_id", "document_name", "document_version", "region"], "properties": {"cloud_account_id": {"type": "string", "description": "Cloud Account id  for which command document need to be executed."}, "region": {"type": "string", "description": "Region of the document to be executed."}, "document_name": {"type": "string", "description": "Name of the document."}, "document_version": {"type": "string", "description": "The SSM document version to use in the request."}, "document_hash": {"type": "string", "description": "The cryptographic hash value of the document content."}, "document_hash_type": {"type": "string", "description": "The hash algorithm used to calculate the hash value", "example": "Sha256", "enum": ["Sha256", "Sha1"], "x-cs-enum-type": "AwsSsmHashType"}, "parameters": {"type": "object", "description": "The required and optional parameters specified in the document being run.", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "max_concurrency": {"type": "string", "description": "The maximum number of managed nodes that are allowed to run the command at the same time."}, "max_errors": {"type": "string", "description": "The maximum number of errors allowed without the command failing."}, "alarm_configuration": {"description": "The CloudWatch alarm you want to apply to your command.", "$ref": "#/definitions/AwsSsmDocumentAlarmConfiguration"}, "change_id": {"type": "string", "description": "Service Now tracking id"}}, "type": "object"}, "AwsSsmBaseExecution": {"required": ["flavor"], "properties": {"inputs": {"type": "object", "additionalProperties": {"type": "string"}}, "targets": {"type": "array", "description": "Details of the target.", "items": {"$ref": "#/definitions/AwsSsmTarget"}}, "max_concurrency": {"type": "string"}, "max_errors": {"type": "string", "description": "The maximum number of errors allowed without the command failing."}}, "discriminator": "flavor", "type": "object", "x-cs-subtypes": [{"subtype_model": "AwsSsmCommandExecution", "subtype_name": "AwsSsmCommandExecution"}, {"subtype_model": "AwsSsmAutomationExecution", "subtype_name": "AwsSsmAutomationExecution"}]}, "AwsSsmCloudAccount": {"properties": {"id": {"type": "string", "description": "Id of the cloud account."}, "name": {"type": "string", "description": "Name of the cloud account."}, "sync_status": {"$ref": "#/definitions/AwsSsmCloudAccountSyncDetails"}}, "type": "object"}, "AwsSsmCloudAccountSyncDetails": {"properties": {"initiated_at": {"type": "string", "format": "date-time", "description": "Time when the document sync is started"}, "completed_at": {"type": "string", "format": "date-time", "description": "Time when the document sync is completed"}, "sync_type": {"type": "string", "description": "Type of the document sync", "example": "automation", "enum": ["automation", "manual"], "x-cs-enum-type": "AwsSsmDocumentSyncType"}, "sync_status": {"type": "string", "description": "Status of the sync for the particular cloud account"}}, "type": "object"}, "AwsSsmCloudWatchOutputConfig": {"properties": {"log_group_name": {"type": "string", "description": "Name of the log group created to monitor."}, "output_enabled": {"type": "boolean", "description": "Enabled output keys"}}, "type": "object"}, "AwsSsmCommandDocumentAlarm": {"properties": {"name": {"type": "string", "description": "The name of CloudWatch alarm."}}, "type": "object"}, "AwsSsmCommandDocumentCloudWatchOutputConfig": {"properties": {"cloud_watch_log_group_name": {"type": "string", "description": "The name of the CloudWatch Logs log group where you want to send command output."}, "cloud_watch_output_enabled": {"type": "boolean", "description": "Enables Systems Manager to send command output to CloudWatch Logs."}}, "type": "object"}, "AwsSsmCommandDocumentTarget": {"properties": {"key": {"type": "string", "description": "Supported keys: InstanceIds/tag/resource-groups"}, "values": {"type": "array", "description": "Supported values: <instance-id-1>,<instance-id-2>/<my-tag-value-1>,<my-tag-value-2>/<resource-type-1>,<resource-type-2>", "items": {"type": "string"}}}, "type": "object"}, "AwsSsmCommandExecution": {"allOf": [{"$ref": "#/definitions/AwsSsmBaseExecution"}, {"properties": {"comment": {"type": "string", "description": "User specified information."}, "parameters": {"type": "object", "description": "The parameter values to be inserted in the document when running the command", "additionalProperties": {"type": "string"}}, "requested_date_time": {"type": "string", "format": "date-time", "description": "The date and time the command was requested."}, "expires_after": {"type": "string", "format": "date-time", "description": "Time after the command expires."}, "instance_ids": {"type": "array", "description": "List of target instance ids.", "items": {"type": "string"}}, "output_s3_region": {"type": "string", "description": "Region of s3 bucket to store output."}, "output_s3_bucket_name": {"type": "string", "description": "Name of s3 bucket to store output."}, "output_s3_key_prefix": {"type": "string", "description": "Key prefix of s3 path."}, "target_count": {"type": "string", "description": "Number of target resources selected."}, "completed_count": {"type": "string", "description": "Number of target resources completed"}, "error_count": {"type": "string", "description": "Number of target resources failed"}, "delivery_timed_out_count": {"type": "string", "description": "Time to wait before failing"}, "service_role": {"type": "string", "description": "Role of the service."}, "notification_config": {"description": "Configuration details of the notification.", "$ref": "#/definitions/AwsSsmNotificationConfig"}, "cloudwatch_output_config": {"description": "Cloud watch output configuration details", "$ref": "#/definitions/AwsSsmCloudWatchOutputConfig"}, "delivery_timeout_seconds": {"type": "number", "description": "Delivery Time out in seconds"}, "status": {"type": "string", "description": "Status of the Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Delayed", "Success", "Cancelled", "TimedOut", "Failed", "Cancelling"], "x-cs-enum-type": "AwsSsmCommandExecutionStatus"}, "status_details": {"type": "string", "description": "Detailed status of the execution"}, "alarm_configuration": {"$ref": "#/definitions/AwsSsmDocumentAlarmConfiguration"}}, "type": "object"}], "x-cs-type-name": "AwsSsmCommandExecution"}, "AwsSsmCommandFilter": {"allOf": [{"$ref": "#/definitions/AwsSsmExecutionFilter"}, {"properties": {"status": {"type": "string", "description": "Status of the Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Delayed", "Success", "Cancelled", "TimedOut", "Failed", "Cancelling"], "x-cs-enum-type": "AwsSsmCommandExecutionStatus"}}, "type": "object"}], "x-cs-type-name": "AwsSsmCommandFilter"}, "AwsSsmCommandInstanceExecutionBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AwsSsmCommandInstanceExecutionDetail"}}}, "type": "object"}, "AwsSsmCommandInstanceExecutionDetail": {"properties": {"sysId": {"type": "string", "description": "Id of the command execution"}, "job_id": {"type": "string", "description": "Id of the command execution job"}, "instance_id": {"type": "string", "description": "The ID of the instance on which the command document is executed."}, "instance_name": {"type": "string", "description": "The Name of the instance on which the command document is executed."}, "comment": {"type": "string", "description": "The comment text for the command."}, "execution_start_time": {"type": "string", "format": "date-time", "description": "The date and time the plugin started running."}, "execution_end_time": {"type": "string", "format": "date-time", "description": "The date and time the plugin finished running."}, "status": {"type": "string", "description": "Status of the Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Delayed", "Success", "Cancelled", "TimedOut", "Failed", "Cancelling"], "x-cs-enum-type": "AwsSsmCommandExecutionStatus"}, "status_details": {"type": "string", "description": "Detailed status of the execution"}, "command_plugins": {"type": "array", "description": "Plugin details of the command execution", "items": {"$ref": "#/definitions/AwsSsmCommandPlugin"}}}, "type": "object"}, "AwsSsmCommandPlugin": {"properties": {"name": {"type": "string", "description": "Name of the plugin"}, "status": {"type": "string", "description": "Status of the Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Delayed", "Success", "Cancelled", "TimedOut", "Failed", "Cancelling"], "x-cs-enum-type": "AwsSsmCommandExecutionStatus"}, "status_details": {"type": "string", "description": "Detailed status of the execution"}, "response_code": {"type": "integer", "description": "Response code of the plug in"}, "response_start_date_time": {"type": "string", "format": "date-time"}, "response_finish_date_time": {"type": "string", "format": "date-time"}, "output": {"type": "string", "description": "Output of the execution"}, "plugin_name": {"type": "string", "description": "Name of the plugin"}, "standard_output_contents": {"type": "string", "description": "standard output parameters"}, "standard_output_url": {"type": "string", "description": "standard url of the output"}, "standard_error_content": {"type": "string", "description": "standard error contents of the output."}, "standard_error_url": {"type": "string", "description": "standard url of the error content"}}, "type": "object"}, "AwsSsmContentAttachmentDetail": {"properties": {"name": {"type": "string", "description": "The name of an attachment."}, "size": {"type": "integer", "description": "The size of an attachment in bytes."}, "hash": {"type": "string", "description": "The cryptographic hash value of the document content."}, "hash_type": {"type": "string", "description": "The hash algorithm used to calculate the hash value", "example": "Sha256", "enum": ["Sha256", "Sha1"], "x-cs-enum-type": "AwsSsmHashType"}, "url": {"type": "string", "description": "The URL location of the attachment content."}}, "type": "object"}, "AwsSsmDocs": {"properties": {"name": {"type": "string", "description": "Name of the SSM document"}, "master_account_id": {"type": "string", "description": "The unique identifier of the master account to which the document is associated."}, "cloud_account_id": {"type": "string", "description": "ID of the cloud account"}, "status": {"type": "string", "description": "Status of the document", "example": "Creating", "enum": ["Creating", "Active", "Updating", "Deleting", "Failed", "Deleted"], "x-cs-enum-type": "AwsSsmAutomationDocumentStatus"}, "document_type": {"type": "string", "description": "The document type"}, "latest_version": {"type": "string", "description": "The document version."}, "owner": {"type": "string", "description": "The Amazon Web Services user that created the document"}, "default_version": {"type": "string", "description": "The default version"}, "created_at": {"type": "string", "format": "date-time", "description": "DB record created at"}, "created_by": {"type": "string", "description": "Name of the user who created the document"}, "updated_at": {"type": "string", "format": "date-time", "description": "DB record last updated at"}, "updated_by": {"type": "string", "description": "Name of the user updated the document"}, "document_creation_time": {"type": "string", "format": "date-time", "description": "The date the SSM document was created"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "categories": {"type": "array", "description": "The classification of a document to help you identify and categorize", "items": {"type": "string"}}, "category_identifiers": {"type": "array", "description": "The value that identifies a documents category", "items": {"type": "string"}}, "region": {"type": "string", "description": "The region of the document"}, "scope": {"type": "string", "description": "The scope of owner document"}, "permission_details": {"description": "Describes the permissions for a Amazon Web Services Systems Manager document", "$ref": "#/definitions/AwsSsmDocsPermissionDetail"}}, "type": "object"}, "AwsSsmDocsAccountSharingInfo": {"properties": {"account_id": {"type": "string", "description": "The Amazon Web Services account ID where the current document is shared"}, "shared_document_version": {"type": "string", "description": "The version of the current document shared with the account."}}, "type": "object"}, "AwsSsmDocsPermissionDetail": {"properties": {"account_ids": {"type": "array", "description": "The account IDs that have permission to use this document.", "items": {"type": "string"}}, "account_sharing_info": {"type": "array", "description": "A list of Amazon Web Services accounts where the current document is shared and the version shared with each account", "items": {"$ref": "#/definitions/AwsSsmDocsAccountSharingInfo"}}}, "type": "object"}, "AwsSsmDocument": {"properties": {"sysId": {"type": "string", "description": "Id of the document."}, "name": {"type": "string", "description": "Name of the document."}, "categories": {"type": "array", "description": "Category of the document.", "items": {"type": "string"}}, "document_type": {"type": "string", "description": "Type of the document."}, "owner": {"type": "string", "description": "Owner of the document."}, "os_types": {"type": "array", "description": "Platform of the document can be executed.", "items": {"type": "string"}}, "scope": {"type": "string", "description": "Scope of the SSM document."}, "cloud_account_id": {"type": "string", "description": "For private, self type of documents the cloud account id will be mapped"}, "region": {"type": "string", "description": "For non global document region based mapping will be there"}, "document_creation_time": {"type": "string", "format": "date-time", "description": "Time of document creation"}, "latest_version": {"type": "string", "description": "Latest version of the document"}, "default_version": {"type": "string", "description": "The default version"}, "document_version": {"type": "string", "description": "Current document version that is viewing"}, "status": {"type": "string", "description": "Status of the document", "example": "Creating", "enum": ["Creating", "Active", "Updating", "Deleting", "Failed", "Deleted"], "x-cs-enum-type": "AwsSsmAutomationDocumentStatus"}, "tags": {"type": "array", "description": "Tag key and Value pair available for the document", "items": {"$ref": "#/definitions/AwsSsmDocumentTag"}}, "permission_details": {"description": "Permission details of the Document.", "$ref": "#/definitions/AwsSsmDocumentPermissionDetail"}, "created_at": {"type": "string", "format": "date-time", "description": "Time of the document synced with system."}, "updated_at": {"type": "string", "format": "date-time", "description": "last synced time of the document."}}, "type": "object"}, "AwsSsmDocumentAccountShared": {"properties": {"account_id": {"type": "string", "description": "AWS Account Id to which the Document is shared."}, "shared_document_version": {"type": "string", "description": "Version of the document which is shared with other accounts."}}, "type": "object"}, "AwsSsmDocumentAlarmConfiguration": {"properties": {"ignore_poll_alarm_failure": {"type": "boolean", "description": "The automation or command continues to run, either the Alarm status is OK or INSUFFICIENT_DATA."}, "alarms": {"type": "array", "description": "List of Alarms.", "items": {"$ref": "#/definitions/AwsSsmCommandDocumentAlarm"}}}, "type": "object"}, "AwsSsmDocumentExecutionBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AwsSsmJob"}}}, "type": "object"}, "AwsSsmDocumentFilter": {"allOf": [{"$ref": "#/definitions/AwsSsmBaseDocumentFilter"}, {"properties": {"owners": {"type": "array", "description": "The AWS user that created the document.", "items": {"type": "string"}}, "categories": {"type": "array", "description": "The classification of a document to help you identify and categorize its use.", "items": {"type": "string"}}, "platform_types": {"type": "array", "description": "The list of operating system (OS) platforms compatible with available SSM documents.", "items": {"type": "string"}}, "filters": {"description": "Account filters for the tags", "$ref": "#/definitions/AwsSsmDocumentQueryFilters"}}, "type": "object"}], "x-cs-type-name": "AwsSsmDocumentFilter"}, "AwsSsmDocumentPermissionDetail": {"properties": {"account_ids": {"type": "array", "description": "AWS account ids ", "items": {"type": "string"}}, "account_sharing_info": {"type": "array", "description": "AWS account details", "items": {"$ref": "#/definitions/AwsSsmDocumentAccountShared"}}}, "type": "object"}, "AwsSsmDocumentQueryCategory": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["categories"], "properties": {"categories": {"type": "array", "description": "Categories for the findings", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSsmDocumentQueryCategory"}, "AwsSsmDocumentQueryCloudAccount": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["cloud_account_ids"], "properties": {"cloud_account_ids": {"type": "array", "description": "Cloud accounts for the document", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSsmDocumentQueryCloudAccount"}, "AwsSsmDocumentQueryExecutedBy": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["executed_by"], "properties": {"executed_by": {"type": "array", "description": "IAM ARN of the user who executed the document", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSsmDocumentQueryExecutedBy"}, "AwsSsmDocumentQueryFilters": {"properties": {"regions": {"type": "array", "description": "Regions based on the available documents (all if missing)", "items": {"type": "string"}}, "owners": {"type": "array", "description": "The AWS user that created the document (all if missing)", "items": {"type": "string"}}, "categories": {"type": "array", "description": "The classification of a document to help you identify and categorize its use (all if missing)", "items": {"type": "string"}}}, "type": "object"}, "AwsSsmDocumentQueryName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["document_names"], "properties": {"document_names": {"type": "array", "description": "Name of the Automation/Command document", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSsmDocumentQueryName"}, "AwsSsmDocumentQueryOwner": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["owners"], "properties": {"owners": {"type": "array", "description": "Owners for the findings", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSsmDocumentQueryOwner"}, "AwsSsmDocumentQueryRegion": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["regions"], "properties": {"regions": {"type": "array", "description": "Regions for the document", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSsmDocumentQueryRegion"}, "AwsSsmDocumentQueryStatus": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["statuses"], "properties": {"statuses": {"type": "array", "description": "List of status of the execution", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "AwsSsmDocumentQueryStatus"}, "AwsSsmDocumentSyncRequest": {"properties": {"cloud_account_ids": {"type": "array", "description": "List of ids of the cloud account for manual document sync.", "items": {"type": "string"}}}, "type": "object"}, "AwsSsmDocumentSyncResponse": {"properties": {"allowed_cloud_accounts": {"type": "array", "description": "List of cloud account ids for which manual sync triggered.", "items": {"type": "string"}}, "denied_cloud_accounts": {"type": "array", "description": "List of cloud account ids for which user may not have access or invalid id", "items": {"type": "string"}}}, "type": "object"}, "AwsSsmDocumentTag": {"properties": {"key": {"type": "string", "description": "Name for the tag key"}, "value": {"type": "string", "description": "Value for the respective tag key"}}, "type": "object"}, "AwsSsmDocumentVersion": {"properties": {"content": {"type": "string", "description": "A structure that includes attributes that describe a document attachment"}, "document_version": {"type": "string", "description": "The document version"}, "document_format": {"type": "string", "description": "The document format, either JSON or YAML"}, "description": {"type": "string", "description": "A description of the document"}, "document_id": {"type": "string", "description": "Document ID of SSM docs"}, "document_creation_time": {"type": "string", "format": "date-time", "description": "The date the SSM document was created"}, "hash": {"type": "string", "description": "The cryptographic hash value of the document content."}, "hash_type": {"type": "string", "description": "The hash algorithm used to calculate the hash value", "example": "Sha256", "enum": ["Sha256", "Sha1"], "x-cs-enum-type": "AwsSsmHashType"}, "schema_version": {"type": "string", "description": "The schema version"}, "target_type": {"type": "string", "description": "The target type defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance"}, "parameters": {"type": "array", "description": "Parameters specified in a Systems Manager document that run on the server", "items": {"$ref": "#/definitions/AwsSsmParameter"}}, "os_types": {"type": "array", "description": "The list of operating system (OS) platforms", "items": {"type": "string"}}, "attachment_contents": {"type": "array", "description": "A description of the document attachments, including names, locations, sizes", "items": {"$ref": "#/definitions/AwsSsmContentAttachmentDetail"}}}, "type": "object"}, "AwsSsmDocumentVersionBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AwsSsmDocumentVersionDetails"}}}, "type": "object"}, "AwsSsmDocumentVersionDetails": {"allOf": [{"$ref": "#/definitions/AwsSsmDocumentVersion"}, {"properties": {"sysId": {"type": "string"}, "document_creation_time": {"type": "string", "format": "date-time"}}, "type": "object"}]}, "AwsSsmDocumentsBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AwsSsmDocument"}}}, "type": "object"}, "AwsSsmExecuteAutomationDocumentRequest": {"allOf": [{"$ref": "#/definitions/AwsSsmBaseExecuteDocumentRequest"}, {"properties": {"client_token": {"type": "string", "description": "Client auth token."}, "mode": {"type": "string", "description": "Execution mode of the document."}, "target_parameter_name": {"type": "string", "description": "The name of the parameter used as the target resource for the rate-controlled execution."}, "targets": {"type": "array", "description": "An array of search criteria that targets managed nodes using a Key,Value combination.", "items": {"$ref": "#/definitions/AwsSsmCommandDocumentTarget"}}, "target_maps": {"type": "object", "description": "A key-value mapping of document parameters to target resources.", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "target_locations": {"type": "array", "description": "A location is a combination of AWS Regions and/or AWS accounts.", "items": {"$ref": "#/definitions/AwsSsmExecuteAutomationTargetLocation"}}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}]}, "AwsSsmExecuteAutomationTargetLocation": {"properties": {"accounts": {"type": "array", "description": "The AWS accounts targeted by the current Automation execution.", "items": {"type": "string"}}, "execution_role_name": {"type": "string", "description": "The Automation execution role used by the currently running Automation."}, "regions": {"type": "array", "description": "The AWS Regions targeted by the current Automation execution.", "items": {"type": "string"}}, "target_alarm_configuration": {"description": "Details of the cloud watch alarm.", "$ref": "#/definitions/AwsSsmDocumentAlarmConfiguration"}, "target_location_max_concurrency": {"type": "string", "description": "The maximum number of AWS Regions and AWS accounts allowed to run the Automation concurrently."}, "target_location_max_errors": {"type": "string", "description": "The maximum number of errors allowed before the system stops queueing additional Automation executions for the currently running Automation."}}, "type": "object"}, "AwsSsmExecuteCommandDocumentRequest": {"allOf": [{"$ref": "#/definitions/AwsSsmBaseExecuteDocumentRequest"}, {"properties": {"instance_ids": {"type": "array", "description": "The IDs of the managed nodes where the command should run.", "items": {"type": "string"}}, "targets": {"type": "array", "description": "An array of search criteria that targets managed nodes using a Key,Value combination.", "items": {"$ref": "#/definitions/AwsSsmCommandDocumentTarget"}}, "timeout_seconds": {"type": "integer", "description": "If this time is reached and the command has not already started running, it wont run."}, "comment": {"type": "string", "description": "User-specified information about the command."}, "output_s3_bucket_name": {"type": "string", "description": "The name of the S3 bucket where command execution responses should be stored."}, "output_s3_key_prefix": {"type": "string", "description": "The directory structure within the S3 bucket where the responses should be stored."}, "service_role_arn": {"type": "string", "description": "The ARN of the AWS IAM service role to use to publish Amazon SNS notifications for Run Command commands."}, "notification_config": {"description": "Configurations for sending notifications.", "$ref": "#/definitions/AwsSsmNotificationConfig"}, "cloud_watch_output_config": {"description": "Enables AWS Systems Manager to send Run Command output to Amazon CloudWatch Logs.", "$ref": "#/definitions/AwsSsmCommandDocumentCloudWatchOutputConfig"}}, "type": "object"}]}, "AwsSsmExecuteDocumentResponse": {"properties": {"execution_id": {"type": "string", "description": "Automation Execution Id"}}, "type": "object"}, "AwsSsmExecutionFilter": {"allOf": [{"$ref": "#/definitions/AwsSsmBaseDocumentFilter"}, {"properties": {"executed_by": {"type": "array", "description": "Document executed by", "items": {"type": "string"}}, "document_names": {"type": "array", "description": "Name of the Automation/Command document", "items": {"type": "string"}}, "filters": {"description": "Query filters for the execution", "$ref": "#/definitions/AwsSsmExecutionQueryFilters"}}, "type": "object"}], "x-cs-type-name": "AwsSsmExecutionFilter"}, "AwsSsmExecutionFilters": {"properties": {"group_job_ids": {"type": "array", "description": "List of group job ids.", "items": {"type": "string"}}, "parent_job_ids": {"type": "array", "description": "List of parent job ids.", "items": {"type": "string"}}, "cloud_account_ids": {"type": "array", "description": "List of ids of the cloud account.", "items": {"type": "string"}}, "regions": {"type": "array", "description": "region of the document to be executed.", "items": {"type": "string"}}, "document_ids": {"type": "array", "description": "Name of the document.", "items": {"type": "string"}}, "document_types": {"type": "array", "description": "Type of the executed document", "items": {"type": "string"}}, "executed_by": {"type": "array", "description": "IAM ARN of the user who executed the document", "items": {"type": "string"}}, "status": {"type": "string", "description": "Status of the Automation Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"], "x-cs-enum-type": "AwsSsmAutomationExecutionStatus"}, "text_query": {"type": "string", "description": "Text query for Document Executions list. Search by Execution Id and Document Name"}, "query_filter": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "AwsSsmExecutionGroupBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AwsSsmJobGroup"}}}, "type": "object"}, "AwsSsmExecutionGroupFilters": {"properties": {"cloud_account_ids": {"type": "array", "description": "List of ids of the cloud account.", "items": {"type": "string"}}, "regions": {"type": "array", "description": "region of the document to be executed.", "items": {"type": "string"}}, "document_ids": {"type": "array", "description": "Name of the document.", "items": {"type": "string"}}, "document_types": {"type": "array", "description": "Type of the executed document", "items": {"type": "string"}}, "executed_by": {"type": "array", "description": "IAM ARN of the user who executed the document", "items": {"type": "string"}}, "status": {"type": "string", "description": "Status of the Automation Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"], "x-cs-enum-type": "AwsSsmAutomationExecutionStatus"}, "text_query": {"type": "string", "description": "Text query for Document Executions list. Search by Execution Id and Document Name"}}, "type": "object"}, "AwsSsmExecutionQueryFilters": {"properties": {"status": {"type": "array", "description": "status of the execution (all if missing)", "items": {"type": "string"}}, "document_names": {"type": "array", "description": "The name of the document (all if missing)", "items": {"type": "string"}}, "executed_by": {"type": "array", "description": "IAM ARN of the user who executed the document (all if missing)", "items": {"type": "string"}}}, "type": "object"}, "AwsSsmExecutionStepBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/AwsSsmStepExecution"}}}, "type": "object"}, "AwsSsmJob": {"properties": {"sysId": {"type": "string", "description": "Id of the Job Execution"}, "group_job_id": {"type": "string", "description": "ID of the group job."}, "parent_job_id": {"type": "string", "description": "ID of the parent job if the execution document is child."}, "cloud_account_id": {"type": "string", "description": "ID of the cloud account for which document is executed."}, "region": {"type": "string", "description": "AWS region where the document is executed."}, "execution_id": {"type": "string", "description": "Automation or command document execution id."}, "execution_start_time": {"type": "string", "format": "date-time", "description": "Start time of document execution."}, "execution_end_time": {"type": "string", "format": "date-time", "description": "End time of document execution."}, "status": {"type": "string", "description": "Status of the Automation Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"], "x-cs-enum-type": "AwsSsmAutomationExecutionStatus"}, "document_name": {"type": "string", "description": "Name of the document that is executed"}, "execution_parameters": {"description": "Input parameter details of the execution", "$ref": "#/definitions/AwsSsmBaseExecution"}}, "type": "object"}, "AwsSsmJobGroup": {"properties": {"sysId": {"type": "string", "description": "Id of the Group Executions"}, "status": {"type": "string", "description": "Status of the Job Group", "example": "in_progress", "enum": ["in_progress", "completed"], "x-cs-enum-type": "AwsSsmJobGroupStatus"}, "document_id": {"type": "string", "description": "Document id from the ssm_docs collection"}, "document_version": {"type": "string", "description": "Document version id from the ssm_docs_version collection"}, "document_type": {"type": "string", "description": "Type of the document", "example": "Command", "enum": ["Command", "Automation"], "x-cs-enum-type": "AwsSsmJobGroupDocumentType"}, "created_at": {"type": "string", "format": "date-time", "description": "The date when the job was fetched"}, "created_by": {"type": "string", "description": "Name of the user who executed the document"}, "updated_at": {"type": "string", "format": "date-time", "description": "Date when the document was last updated"}, "updated_by": {"type": "string", "description": "Name of the user who updated the execution"}, "change_id": {"type": "string", "description": "Service Now tracking id"}}, "type": "object"}, "AwsSsmListDocumentExecutionGroupsSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "created_at", "enum": ["created_at"], "x-cs-enum-type": "AwsSsmListDocumentExecutionGroupsSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AwsSsmListDocumentExecutionRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AwsSsmListDocumentExecutionsSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AwsSsmExecutionFilters"}}, "type": "object"}, "AwsSsmListDocumentExecutionsSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "created_at", "enum": ["created_at"], "x-cs-enum-type": "AwsSsmListDocumentExecutionsSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AwsSsmListDocumentVersion": {"properties": {"sysId": {"type": "string"}, "document_version": {"type": "string", "description": "Version of the Systems Manager Document"}, "document_creation_time": {"type": "string", "format": "date-time"}}, "type": "object"}, "AwsSsmListDocumentsRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AwsSsmListDocumentsSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AwsSsmListDocumentsRequestContext"}}, "type": "object"}, "AwsSsmListDocumentsRequestContext": {"required": ["document_types"], "properties": {"cloud_account_ids": {"type": "array", "description": "id of the cloud accounts.", "items": {"type": "string"}}, "regions": {"type": "array", "description": "region of the document to be executed.", "items": {"type": "string"}}, "document_names": {"type": "array", "description": "Name of the document.", "items": {"type": "string"}}, "owners": {"type": "array", "description": "Owner of the SSM document.", "items": {"type": "string"}}, "platform_types": {"type": "array", "description": "Platform types supported for the document.", "items": {"type": "string"}}, "document_types": {"type": "array", "description": "Type of the document.", "items": {"type": "string"}}, "text_query": {"type": "string", "description": "Text query for SSM Documents List. Search by Document Name, Category and Owner"}, "query_filter": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "AwsSsmListDocumentsSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "name", "enum": ["name"], "x-cs-enum-type": "AwsSsmListDocumentsSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "AwsSsmListExecutionGroupRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/AwsSsmListDocumentExecutionGroupsSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AwsSsmExecutionGroupFilters"}}, "type": "object"}, "AwsSsmNotificationConfig": {"properties": {"arn": {"type": "string", "description": "AWS resource ARN of the SNS topic"}, "events": {"type": "array", "items": {"type": "string", "description": "Type of the notification events for automation documents", "example": "All", "enum": ["All", "InProgress", "Success", "TimedOut", "Cancelled", "Failed"], "x-cs-enum-type": "AwsSsmExecuteDocumentNotificationEvents"}}, "notification_type": {"type": "string", "description": "Type of the notification. Receive notifications when the status of command/invocation changes", "example": "Command", "enum": ["Command", "Invocation"], "x-cs-enum-type": "AwsSsmCommandNotificationTypes"}}, "type": "object"}, "AwsSsmParameter": {"properties": {"name": {"type": "string", "description": "The name of the parameter"}, "type": {"type": "string", "description": "Type of the parameter of automation documents", "example": "StringMap", "enum": ["StringMap", "MapList", "Integer", "Boolean", "String", "StringList", "AWS_EC2_Instance_Id", "AWS_IAM_Role_Arn", "AWS_S3_Bucket_Name"], "x-cs-enum-type": "AwsSsmDocumentParameterType"}, "description": {"type": "string", "description": "The description of the parameters"}, "default_value": {"type": "string", "description": "The default values for the parameters"}, "min_items": {"type": "integer", "description": "Minimum number items in parameter"}, "max_items": {"type": "integer", "description": "Maximum number items in parameter"}, "allowed_values": {"type": "array", "description": "List of allowed values", "items": {"type": "string"}}, "display_type": {"type": "string", "description": "Type of display items"}, "allowed_pattern": {"type": "string", "description": "Regex patterns of the parameter"}, "min_chars": {"type": "integer", "description": "Minimum number of characters in the parameters"}, "max_chars": {"type": "integer", "description": "Maximum number of characters in the parameters"}}, "type": "object"}, "AwsSsmResolvedTarget": {"properties": {"parameter_values": {"type": "array", "description": "Parameter values of the target resources.", "items": {"type": "string"}}, "truncated": {"type": "boolean", "description": "Status if the step is truncated."}}, "type": "object"}, "AwsSsmStepExecution": {"properties": {"sysId": {"type": "string", "description": "Id of the Step Execution"}, "job_id": {"type": "string", "description": "Id reference of the execution job id"}, "name": {"type": "string", "description": "Name of the step."}, "action": {"type": "string", "description": "The action this step performs. The action determines the behavior of the step"}, "on_failure": {"type": "string", "description": "The action to take if the step fails. The default value is Abort"}, "max_attempts": {"type": "integer", "description": "The maximum number of tries to run the action of the step. The default value is 1"}, "execution_start_time": {"type": "string", "format": "date-time", "description": "If a step has begun execution, this contains the time the step started."}, "execution_end_time": {"type": "string", "format": "date-time", "description": "If a step has finished execution, this contains the time the execution ended."}, "status": {"type": "string", "description": "Status of the Automation Execution", "example": "Pending", "enum": ["Pending", "InProgress", "Waiting", "Success", "TimedOut", "Cancelling", "Cancelled", "Failed", "PendingApproval", "Approved", "Rejected", "Scheduled", "RunbookInProgress", "PendingChangeCalendarOverride", "ChangeCalendarOverrideApproved", "ChangeCalendarOverrideRejected", "CompletedWithSuccess", "CompletedWithFailure"], "x-cs-enum-type": "AwsSsmAutomationExecutionStatus"}, "inputs": {"type": "object", "additionalProperties": {"type": "string"}}, "output": {"type": "object", "additionalProperties": {"type": "string"}}, "step_execution_id": {"type": "string", "description": "The unique ID of a step execution. Execution id of the step"}, "overridden_parameters": {"type": "object", "additionalProperties": {"type": "string"}}, "valid_next_steps": {"type": "array", "description": "Strategies used when step fails, we support Continue and Abort. Abort will fail the automation when the step fails. Continue will ignore the failure of current step and allow automation to run the next step.", "items": {"type": "string"}}, "failure_message": {"type": "string", "description": "Failure message of the step of the job."}, "failure_details": {"description": "Information about the Automation failure", "$ref": "#/definitions/AwsSsmStepFailureDetail"}}, "type": "object"}, "AwsSsmStepFailureDetail": {"properties": {"stage": {"type": "string", "description": "Stage of the execution when the failure occurred"}, "type": {"type": "string", "description": "type of the failure"}, "details": {"type": "object", "additionalProperties": {"type": "string"}}}, "type": "object"}, "AwsSsmTarget": {"properties": {"key": {"type": "string", "description": "Type of the target resource for execution of command document"}, "values": {"type": "array", "description": "Target resource details", "items": {"type": "string"}}}, "type": "object"}, "AwsTrailDetails": {"properties": {"name": {"type": "string", "description": "Name of the trail"}, "bucket_name": {"type": "string", "description": "Name of the Amazon S3 bucket into which CloudTrail delivers trail files"}, "is_multi_region_trail": {"type": "boolean", "description": "Specifies whether the trail exists only in one Region or exists in all Regions"}}, "type": "object"}, "AzureActionGroupDetails": {"properties": {"name": {"type": "string", "description": "Action Group Name"}, "resource_group": {"type": "string", "description": "Resource Group Name"}}, "type": "object"}, "AzureActivityLogAlertDetails": {"properties": {"name": {"type": "string", "description": "Activity Log Alert Name"}, "resource_group": {"type": "string", "description": "Resource Group Name"}, "is_subscription_scope": {"type": "boolean", "description": "Specifies whether the alert scope is subscription"}}, "type": "object"}, "AzureDevOpsBuild": {"properties": {"build_id": {"type": "integer"}, "name": {"type": "string", "description": "Name of the Build"}, "status": {"type": "string", "description": "Build Status", "example": "all", "enum": ["all", "cancelling", "completed", "inProgress", "notStarted", "postponed"], "x-cs-enum-type": "AzureDevOpsPipelineBuildStatus"}, "result": {"type": "string", "description": "Build Result", "example": "canceled", "enum": ["canceled", "failed", "succeeded", "none", "partiallySucceeded"], "x-cs-enum-type": "AzureDevOpsPipelineBuildResult"}, "started": {"type": "string", "format": "date-time"}, "finished": {"type": "string", "format": "date-time"}, "branch": {"type": "string", "description": "Branch of the repo under Build"}, "version": {"type": "string", "description": "Version of the repo under Build"}}, "type": "object"}, "AzureDevOpsBuildLog": {"properties": {"log_id": {"type": "integer", "description": "Build Log Id"}, "created_on": {"type": "string", "format": "date-time", "description": "Build Log created datetime"}, "last_changed_on": {"type": "string", "format": "date-time", "description": "Build Log latest update datetime"}, "log_lines": {"type": "array", "description": "List of raw log lines", "items": {"type": "string"}}}, "type": "object"}, "AzureDevOpsBuildWorkItem": {"properties": {"url": {"type": "string"}, "workitem_id": {"type": "integer", "description": "Azure DevOps WorkItem ID"}, "type": {"type": "string", "description": "Azure DevOps WorkItem Type"}, "icon": {"type": "string", "description": "Azure DevOps WorkItem Type Icon URL"}}, "type": "object"}, "AzureDevOpsBuildWorkItemsRequest": {"required": ["build_id", "project_id", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}, "project_id": {"type": "string", "description": "Azure Devops Project ID"}, "build_id": {"type": "integer", "description": "Azure Devops Build ID"}}, "type": "object"}, "AzureDevOpsBuildWorkItemsResponse": {"properties": {"workitems": {"type": "array", "description": "List of workitems associated with build", "items": {"$ref": "#/definitions/AzureDevOpsBuildWorkItem"}}}, "type": "object"}, "AzureDevOpsListBuildLogsRequests": {"required": ["build_id", "project_id", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}, "project_id": {"type": "string", "description": "Azure Devops Project ID"}, "build_id": {"type": "integer", "description": "Azure Devops Build ID"}}, "type": "object"}, "AzureDevOpsListBuildLogsResponse": {"properties": {"logs": {"type": "array", "description": "List of AzureDevOpsBuildLog", "items": {"$ref": "#/definitions/AzureDevOpsBuildLog"}}}, "type": "object"}, "AzureDevOpsListBuildRequests": {"required": ["pipeline_id", "project_id", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}, "project_id": {"type": "string", "description": "Azure Devops Project ID"}, "pipeline_id": {"type": "integer", "description": "Azure Devops Pipeline ID"}, "status": {"type": "string", "description": "Filter the list of builds response based on the status", "example": "all", "enum": ["all", "cancelling", "completed", "inProgress", "notStarted", "postponed"], "x-cs-enum-type": "AzureDevOpsPipelineBuildStatus"}, "query_order": {"type": "string", "description": "Criteria to sort the builds in the response", "example": "finishTimeAscending", "enum": ["finishTimeAscending", "finishTimeDescending", "queueTimeAscending", "queueTimeDescending", "startTimeAscending", "startTimeDescending"], "x-cs-enum-type": "AzureDevOpsBuildQueryOrder"}, "search": {"type": "string", "description": "filter the build response with the provided search keyword"}}, "type": "object"}, "AzureDevOpsListBuildResponse": {"properties": {"builds": {"type": "array", "description": "List of project name", "items": {"$ref": "#/definitions/AzureDevOpsBuild"}}}, "type": "object"}, "AzureDevOpsListPipelinesRequest": {"required": ["project_id", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}, "project_id": {"type": "string", "description": "Azure Devops Project ID"}}, "type": "object"}, "AzureDevOpsListPipelinesResponse": {"properties": {"pipelines": {"type": "array", "description": "List of project name", "items": {"$ref": "#/definitions/AzureDevOpsPipeline"}}}, "type": "object"}, "AzureDevOpsPipeline": {"properties": {"pipeline_id": {"type": "integer", "description": "Azure DevOps Pipeline ID"}, "pipeline_name": {"type": "string", "description": "Azure DevOps Pipeline Name"}}, "type": "object"}, "AzureDevOpsPipelineListProjectsRequest": {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}}, "type": "object"}, "AzureDevOpsPipelineListProjectsResponse": {"properties": {"projects": {"type": "array", "description": "List of project name", "items": {"$ref": "#/definitions/AzureDevOpsProject"}}}, "type": "object"}, "AzureDevOpsProject": {"properties": {"project_name": {"type": "string", "description": "Azure DevOps Project Name"}, "project_id": {"type": "string", "description": "Azure DevOps Project ID"}}, "type": "object"}, "AzureLogAnalyticsWorkspaceDetails": {"properties": {"resource_id": {"type": "string", "description": "Resource Id"}, "name": {"type": "string", "description": "Workspace Name"}, "workspace_id": {"type": "string", "description": "Workspace Id"}}, "type": "object"}, "AzurePatchManagementReportTriggerRequest": {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Provide service_account_id to trigger the azure patch report generation", "x-cs-type": "ObjectId"}}, "type": "object"}, "AzureSubscriptionDetails": {"properties": {"subscription_id": {"type": "string", "description": "Subscription Id"}, "name": {"type": "string", "description": "Subscription Name"}, "status": {"type": "string", "description": "Azure Subscription Status", "example": "Deleted", "enum": ["Deleted", "Disabled", "Enabled", "PastDue", "Warned"], "x-cs-enum-type": "AzureSubscriptionStatus"}}, "type": "object"}, "BackgroundJob": {"properties": {"id": {"$ref": "#/definitions/RecordIdentity"}, "created_at": {"type": "string", "format": "date-time", "description": "When the Background Job was created"}, "updated_at": {"type": "string", "format": "date-time", "description": "When the Background Job was last updated"}, "cancel_requested": {"type": "boolean", "description": "If True, the Background Job should stop processing as soon as possible"}, "status": {"type": "string", "description": "Status of Background Job", "example": "Ready", "enum": ["Ready", "Pending", "Waiting", "Failed", "Completed", "Cancelled"], "x-cs-enum-type": "BackgroundJobStatus"}, "priority": {"type": "integer", "description": "Priority of the Background Job"}, "next_activation": {"type": "string", "format": "date-time", "description": "When the Background Job will execute"}, "worker_id": {"type": "string", "description": "Identifier of the worker processing this job"}, "execution_start": {"type": "string", "format": "date-time", "description": "When the Background Job started executing"}, "execution_end": {"type": "string", "format": "date-time", "description": "When the Background Job completed execution"}, "auto_retries": {"type": "integer", "description": "Number of auto retries left for this Background Job"}, "auto_retry_delay": {"type": "number", "description": "Number of seconds to wait before a retry for this Background Job"}, "failure": {"type": "object", "description": "Details in case the execution of the job failed"}, "waiting_set": {"type": "array", "description": "Background Jobs this job is waiting for", "items": {"$ref": "#/definitions/RecordIdentity"}}, "waited_set": {"type": "array", "description": "Background Jobs this job waited on", "items": {"$ref": "#/definitions/BackgroundJobIdentityWithStatus"}}, "waited_set_failed": {"type": "array", "description": "Failed Background Jobs this job waited on", "items": {"$ref": "#/definitions/BackgroundJobIdentityWithStatus"}}, "payload": {"description": "Data associated with the Background Job", "$ref": "#/definitions/BackgroundJobPayloadBase"}}, "type": "object"}, "BackgroundJobBatchRequest": {"allOf": [{"$ref": "#/definitions/RecordIdentityBatchRequest"}, {"properties": {"include_details": {"type": "boolean", "description": "Include payload details if true"}, "include_only_status": {"type": "boolean", "description": "Include just the status field if true"}}, "type": "object"}]}, "BackgroundJobBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/BackgroundJob"}}}, "type": "object"}, "BackgroundJobEngineTestSub": {"properties": {"suspend_on": {"$ref": "#/definitions/RecordIdentity"}, "sub_task_args": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "BackgroundJobFilter": {"properties": {"executor": {"type": "string", "description": "Limit results to jobs from this executor", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "payload_type": {"type": "string", "description": "Limit results to jobs with the same payload type"}, "payload_identifier": {"type": "string", "description": "Limit results to jobs with the same payload identifier"}, "status": {"type": "array", "description": "Sets of Status values to filter on", "items": {"type": "string", "description": "Status of Background Job", "example": "Ready", "enum": ["Ready", "Pending", "Waiting", "Failed", "Completed", "Cancelled"], "x-cs-enum-type": "BackgroundJobStatus"}}}, "type": "object"}, "BackgroundJobForwardingCheckRequest": {"properties": {"target_executor": {"type": "string", "description": "Target Executor for the job", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "path_executors": {"type": "array", "description": "Path of the request", "items": {"type": "string", "description": "Executor of the Background Job", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}}}, "type": "object"}, "BackgroundJobForwardingCheckResponse": {"properties": {"hops": {"type": "integer", "description": "Number of hops to react executor"}}, "type": "object"}, "BackgroundJobHandlerConfiguration": {"properties": {"max_parallel_jobs": {"type": "integer", "description": "Maximum number of concurrent jobs to process"}, "max_processes": {"type": "integer", "description": "Maximum number of workers to run jobs"}, "default_max_parallel_jobs": {"type": "integer", "description": "Default value for number of concurrent jobs to process"}, "default_max_processes": {"type": "integer", "description": "Default value for number of workers to run jobs"}, "override_expiration": {"type": "string", "format": "date-time", "description": "Override defaults until expiration"}}, "type": "object"}, "BackgroundJobHandlerConfigurationRequest": {"properties": {"executor": {"type": "string", "description": "Target executor", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "payload_type": {"type": "string", "description": "Target payload type"}}, "type": "object"}, "BackgroundJobHandlerConfigurationUpdateRequest": {"allOf": [{"$ref": "#/definitions/BackgroundJobHandlerConfigurationRequest"}, {"properties": {"config": {"description": "New configuration", "$ref": "#/definitions/BackgroundJobHandlerConfiguration"}}, "type": "object"}]}, "BackgroundJobHandlerListResponse": {"properties": {"payload_types": {"type": "array", "description": "Active Background Job Handlers", "items": {"type": "string"}}}, "type": "object"}, "BackgroundJobHeapAnalysis": {"properties": {"started_at": {"type": "string", "format": "date-time", "description": "When the Background Job was created"}, "completed_at": {"type": "string", "format": "date-time", "description": "When the Background Job was created"}, "processes": {"type": "array", "description": "Process data", "items": {"$ref": "#/definitions/BackgroundJobHeapAnalysisProcess"}}}, "type": "object"}, "BackgroundJobHeapAnalysisModule": {"properties": {"name": {"type": "string", "description": "Module name"}, "size": {"type": "integer", "description": "Bytes used in module"}, "count": {"type": "integer", "description": "Object counted in module"}}, "type": "object"}, "BackgroundJobHeapAnalysisProcess": {"properties": {"name": {"type": "string", "description": "Process name"}, "modules": {"type": "array", "description": "Module data", "items": {"$ref": "#/definitions/BackgroundJobHeapAnalysisModule"}}}, "type": "object"}, "BackgroundJobIdentityWithStatus": {"allOf": [{"$ref": "#/definitions/RecordIdentity"}, {"properties": {"status": {"type": "string", "description": "Status of Background Job", "example": "Ready", "enum": ["Ready", "Pending", "Waiting", "Failed", "Completed", "Cancelled"], "x-cs-enum-type": "BackgroundJobStatus"}}, "type": "object"}]}, "BackgroundJobInvalidation": {"properties": {"created_at": {"type": "string", "format": "date-time", "description": "When the invalidation message was created"}, "sent_at": {"type": "string", "format": "date-time", "description": "When the invalidation message was sent"}, "executors": {"type": "array", "description": "Sources of the event", "items": {"type": "string", "description": "Executor of the Background Job", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}}, "jobs": {"type": "array", "description": "Job context", "items": {"$ref": "#/definitions/BackgroundJobIdentityWithStatus"}}, "domains": {"type": "array", "description": "Domain context", "items": {"type": "string"}}}, "type": "object"}, "BackgroundJobListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/BackgroundJobSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/BackgroundJobFilter"}}, "type": "object"}, "BackgroundJobLog": {"properties": {"timestamp": {"type": "string", "format": "date-time", "description": "When the log entry was created"}, "logger": {"type": "string", "description": "Name of the logger"}, "logger_level": {"type": "string", "description": "Level of the log entry"}, "code_context": {"type": "string", "description": "Where the log entry was generated"}, "message": {"type": "string", "description": "Content of the log"}}, "type": "object"}, "BackgroundJobLogRequest": {"properties": {"id": {"description": "The background job to extract the log for", "$ref": "#/definitions/RecordIdentity"}, "offset": {"type": "integer", "description": "First log entry to extract"}, "limit": {"type": "integer", "description": "Maximum number of log entries to return"}}, "type": "object"}, "BackgroundJobLogResponse": {"properties": {"count": {"type": "integer", "description": "Total number of log entries"}, "entries": {"type": "array", "description": "Requested log entries", "items": {"$ref": "#/definitions/BackgroundJobLog"}}}, "type": "object"}, "BackgroundJobLogger": {"properties": {"executor": {"type": "string", "description": "Executor owning the logger", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "name": {"type": "string", "description": "Name of the logger"}, "level": {"type": "string", "description": "Level of a Background Job Logger", "example": "CRITICAL", "enum": ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "DEBUG_VERBOSE", "DEBUG_OBNOXIOUS", "NOTSET"], "x-cs-enum-type": "BackgroundJobLoggerLevel"}, "effective_level": {"type": "string", "description": "Level of a Background Job Logger", "example": "CRITICAL", "enum": ["CRITICAL", "ERROR", "WARNING", "INFO", "DEBUG", "DEBUG_VERBOSE", "DEBUG_OBNOXIOUS", "NOTSET"], "x-cs-enum-type": "BackgroundJobLoggerLevel"}}, "type": "object"}, "BackgroundJobLoggerRequest": {"properties": {"executor": {"type": "string", "description": "Filter to loggers in this executor", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}}, "type": "object"}, "BackgroundJobPayloadBase": {"required": ["__type"], "properties": {"identifier": {"type": "string", "description": "Optional sub-key for payload."}, "resume_target": {"type": "string"}, "resume_args": {"type": "array", "items": {"type": "string"}}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "BackgroundJobPayloadForGenericTask", "subtype_name": "BackgroundJobPayloadForGenericTask"}, {"subtype_model": "BackgroundJobPayloadForReactiveTask", "subtype_name": "BackgroundJobPayloadForReactiveTask"}, {"subtype_model": "BackgroundJobPayloadForEngineTest", "subtype_name": "BackgroundJobPayloadForEngineTest"}, {"subtype_model": "BackgroundJobPayloadForAssessmentFramework", "subtype_name": "BackgroundJobPayloadForAssessmentFramework"}, {"subtype_model": "BackgroundJobPayloadForAssessmentFrameworkRun", "subtype_name": "BackgroundJobPayloadForAssessmentFrameworkRun"}, {"subtype_model": "BackgroundJobPayloadForAssessmentFrameworkOntologySync", "subtype_name": "BackgroundJobPayloadForAssessmentFrameworkOntologySync"}, {"subtype_model": "BackgroundJobPayloadForAssessmentReportOntologyMigration", "subtype_name": "BackgroundJobPayloadForAssessmentReportOntologyMigration"}, {"subtype_model": "BackgroundJobPayloadForPeriodicBudgetAlert", "subtype_name": "BackgroundJobPayloadForPeriodicBudgetAlert"}, {"subtype_model": "BackgroundJobPayloadForBudgetAlertNotification", "subtype_name": "BackgroundJobPayloadForBudgetAlertNotification"}, {"subtype_model": "BackgroundJobPayloadForBudgetAlertTrigger", "subtype_name": "BackgroundJobPayloadForBudgetAlertTrigger"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCrpRecommendations", "subtype_name": "BackgroundJobPayloadForPeriodicCrpRecommendations"}, {"subtype_model": "BackgroundJobPayloadForCrpRecommendations", "subtype_name": "BackgroundJobPayloadForCrpRecommendations"}, {"subtype_model": "BackgroundJobPayloadForPeriodicBillingEntryCleanup", "subtype_name": "BackgroundJobPayloadForPeriodicBillingEntryCleanup"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCloudUsageBilling", "subtype_name": "BackgroundJobPayloadForPeriodicCloudUsageBilling"}, {"subtype_model": "BackgroundJobPayloadForPeriodicSaasCostProcessing", "subtype_name": "BackgroundJobPayloadForPeriodicSaasCostProcessing"}, {"subtype_model": "BackgroundJobPayloadForPeriodicSavingsPlans", "subtype_name": "BackgroundJobPayloadForPeriodicSavingsPlans"}, {"subtype_model": "BackgroundJobPayloadForPeriodicScheduleRecommendation", "subtype_name": "BackgroundJobPayloadForPeriodicScheduleRecommendation"}, {"subtype_model": "BackgroundJobPayloadForBillingEntryCleanup", "subtype_name": "BackgroundJobPayloadForBillingEntryCleanup"}, {"subtype_model": "BackgroundJobPayloadForCloudUsageBilling", "subtype_name": "BackgroundJobPayloadForCloudUsageBilling"}, {"subtype_model": "BackgroundJobPayloadForCloudUsageBillingMigration", "subtype_name": "BackgroundJobPayloadForCloudUsageBillingMigration"}, {"subtype_model": "BackgroundJobPayloadForCloudUsageBillingMigrationPropagation", "subtype_name": "BackgroundJobPayloadForCloudUsageBillingMigrationPropagation"}, {"subtype_model": "BackgroundJobPayloadForUpdateUnitRate", "subtype_name": "BackgroundJobPayloadForUpdateUnitRate"}, {"subtype_model": "BackgroundJobPayloadForKubernetesClusterBilling", "subtype_name": "BackgroundJobPayloadForKubernetesClusterBilling"}, {"subtype_model": "BackgroundJobPayloadForKubernetesClusterUsageBilling", "subtype_name": "BackgroundJobPayloadForKubernetesClusterUsageBilling"}, {"subtype_model": "BackgroundJobPayloadForKubernetesClusterUsageBillingFullRefresh", "subtype_name": "BackgroundJobPayloadForKubernetesClusterUsageBillingFullRefresh"}, {"subtype_model": "BackgroundJobPayloadForSaasCostProcessing", "subtype_name": "BackgroundJobPayloadForSaasCostProcessing"}, {"subtype_model": "BackgroundJobPayloadForCloudUsageBillingAggregation", "subtype_name": "BackgroundJobPayloadForCloudUsageBillingAggregation"}, {"subtype_model": "BackgroundJobPayloadForPeriodicProviderRecommendations", "subtype_name": "BackgroundJobPayloadForPeriodicProviderRecommendations"}, {"subtype_model": "BackgroundJobPayloadForProviderRecommendations", "subtype_name": "BackgroundJobPayloadForProviderRecommendations"}, {"subtype_model": "BackgroundJobPayloadForReportGeneration", "subtype_name": "BackgroundJobPayloadForReportGeneration"}, {"subtype_model": "BackgroundJobPayloadForWorkFlowReconciller", "subtype_name": "BackgroundJobPayloadForWorkFlowReconciller"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCustomWorkflowManager", "subtype_name": "BackgroundJobPayloadForPeriodicCustomWorkflowManager"}, {"subtype_model": "BackgroundJobPayloadForPeriodicServiceNowChangeStatusTracker", "subtype_name": "BackgroundJobPayloadForPeriodicServiceNowChangeStatusTracker"}, {"subtype_model": "BackgroundJobPayloadForPeriodicServiceAccountMaintenance", "subtype_name": "BackgroundJobPayloadForPeriodicServiceAccountMaintenance"}, {"subtype_model": "BackgroundJobPayloadForServiceAccountFeaturePropagation", "subtype_name": "BackgroundJobPayloadForServiceAccountFeaturePropagation"}, {"subtype_model": "BackgroundJobPayloadForServiceAccountSyncStatusPropagation", "subtype_name": "BackgroundJobPayloadForServiceAccountSyncStatusPropagation"}, {"subtype_model": "BackgroundJobPayloadForServiceAccountGovernancePropagation", "subtype_name": "BackgroundJobPayloadForServiceAccountGovernancePropagation"}, {"subtype_model": "BackgroundJobPayloadForPeriodicRecommendationV2Processor", "subtype_name": "BackgroundJobPayloadForPeriodicRecommendationV2Processor"}, {"subtype_model": "BackgroundJobPayloadForPeriodicReservedInstance", "subtype_name": "BackgroundJobPayloadForPeriodicReservedInstance"}, {"subtype_model": "BackgroundJobPayloadForReservedInstance", "subtype_name": "BackgroundJobPayloadForReservedInstance"}, {"subtype_model": "BackgroundJobPayloadForPeriodicSyncBudgets", "subtype_name": "BackgroundJobPayloadForPeriodicSyncBudgets"}, {"subtype_model": "BackgroundJobPayloadForSyncBudgets", "subtype_name": "BackgroundJobPayloadForSyncBudgets"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAccessGovernance", "subtype_name": "BackgroundJobPayloadForPeriodicAccessGovernance"}, {"subtype_model": "BackgroundJobPayloadForAccessGovernance", "subtype_name": "BackgroundJobPayloadForAccessGovernance"}, {"subtype_model": "BackgroundJobPayloadForPeriodicMasterDataTtlGeneration", "subtype_name": "BackgroundJobPayloadForPeriodicMasterDataTtlGeneration"}, {"subtype_model": "BackgroundJobPayloadForPeriodicServiceImpactAnalysis", "subtype_name": "BackgroundJobPayloadForPeriodicServiceImpactAnalysis"}, {"subtype_model": "BackgroundJobPayloadForAiAgentReportHandler", "subtype_name": "BackgroundJobPayloadForAiAgentReportHandler"}, {"subtype_model": "BackgroundJobPayloadForMasterDataTtlGeneration", "subtype_name": "BackgroundJobPayloadForMasterDataTtlGeneration"}, {"subtype_model": "BackgroundJobPayloadForServiceImpactAnalysis", "subtype_name": "BackgroundJobPayloadForServiceImpactAnalysis"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCloudHealthMonitoring", "subtype_name": "BackgroundJobPayloadForPeriodicCloudHealthMonitoring"}, {"subtype_model": "BackgroundJobPayloadForCloudHealthMonitoring", "subtype_name": "BackgroundJobPayloadForCloudHealthMonitoring"}, {"subtype_model": "BackgroundJobPayloadForCloudHealthMonitoringParserOnDemand", "subtype_name": "BackgroundJobPayloadForCloudHealthMonitoringParserOnDemand"}, {"subtype_model": "BackgroundJobPayloadForCloudHealthMonitoringMetricSyncerStateless", "subtype_name": "BackgroundJobPayloadForCloudHealthMonitoringMetricSyncerStateless"}, {"subtype_model": "BackgroundJobPayloadForAppSecopsEntityBulkUpdate", "subtype_name": "BackgroundJobPayloadForAppSecopsEntityBulkUpdate"}, {"subtype_model": "BackgroundJobPayloadForSbomParser", "subtype_name": "BackgroundJobPayloadForSbomParser"}, {"subtype_model": "BackgroundJobPayloadForSbomToResourceMappingAutomatic", "subtype_name": "BackgroundJobPayloadForSbomToResourceMappingAutomatic"}, {"subtype_model": "BackgroundJobPayloadForResourceToSbomMappingAutomatic", "subtype_name": "BackgroundJobPayloadForResourceToSbomMappingAutomatic"}, {"subtype_model": "BackgroundJobPayloadForPeriodicVulnerabilitySourceUpdate", "subtype_name": "BackgroundJobPayloadForPeriodicVulnerabilitySourceUpdate"}, {"subtype_model": "BackgroundJobPayloadForContainerFindingsParser", "subtype_name": "BackgroundJobPayloadForContainerFindingsParser"}, {"subtype_model": "BackgroundJobPayloadForGraphionRiskScoreUpdate", "subtype_name": "BackgroundJobPayloadForGraphionRiskScoreUpdate"}, {"subtype_model": "BackgroundJobPayloadForExecutiveDashboardReport", "subtype_name": "BackgroundJobPayloadForExecutiveDashboardReport"}, {"subtype_model": "BackgroundJobPayloadForNextGenReportHandler", "subtype_name": "BackgroundJobPayloadForNextGenReportHandler"}, {"subtype_model": "BackgroundJobPayloadForAutoAssessment", "subtype_name": "BackgroundJobPayloadForAutoAssessment"}, {"subtype_model": "BackgroundJobPayloadForAssessmentRun", "subtype_name": "BackgroundJobPayloadForAssessmentRun"}, {"subtype_model": "BackgroundJobPayloadForAssessmentRunScan", "subtype_name": "BackgroundJobPayloadForAssessmentRunScan"}, {"subtype_model": "BackgroundJobPayloadForAssessmentRunReport", "subtype_name": "BackgroundJobPayloadForAssessmentRunReport"}, {"subtype_model": "BackgroundJobPayloadForAssessmentRunTtlGeneration", "subtype_name": "BackgroundJobPayloadForAssessmentRunTtlGeneration"}, {"subtype_model": "BackgroundJobPayloadForWorkloadTtlGeneration", "subtype_name": "BackgroundJobPayloadForWorkloadTtlGeneration"}, {"subtype_model": "BackgroundJobPayloadForAssessmentRunTtlRefresh", "subtype_name": "BackgroundJobPayloadForAssessmentRunTtlRefresh"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAccessValidation", "subtype_name": "BackgroundJobPayloadForPeriodicAccessValidation"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCloudAccountTagSync", "subtype_name": "BackgroundJobPayloadForPeriodicCloudAccountTagSync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicGovernanceConfigurationValidation", "subtype_name": "BackgroundJobPayloadForPeriodicGovernanceConfigurationValidation"}, {"subtype_model": "BackgroundJobPayloadForPeriodicOnboardAndUpdateGCPAndAWSHierarchy", "subtype_name": "BackgroundJobPayloadForPeriodicOnboardAndUpdateGCPAndAWSHierarchy"}, {"subtype_model": "BackgroundJobPayloadForPeriodicSyncAccountSubscriptionAndMetadata", "subtype_name": "BackgroundJobPayloadForPeriodicSyncAccountSubscriptionAndMetadata"}, {"subtype_model": "BackgroundJobPayloadForPeriodicUpdateCSPAuthDetails", "subtype_name": "BackgroundJobPayloadForPeriodicUpdateCSPAuthDetails"}, {"subtype_model": "BackgroundJobPayloadForPeriodicUpdateSkippedAlertAndJobIdStatus", "subtype_name": "BackgroundJobPayloadForPeriodicUpdateSkippedAlertAndJobIdStatus"}, {"subtype_model": "BackgroundJobPayloadForPeriodicUpdateUnitPriceForViolations", "subtype_name": "BackgroundJobPayloadForPeriodicUpdateUnitPriceForViolations"}, {"subtype_model": "BackgroundJobPayloadForPeriodicValidateCredentials", "subtype_name": "BackgroundJobPayloadForPeriodicValidateCredentials"}, {"subtype_model": "BackgroundJobPayloadForScheduledTask", "subtype_name": "BackgroundJobPayloadForScheduledTask"}, {"subtype_model": "BackgroundJobPayloadForBlueprintExecution", "subtype_name": "BackgroundJobPayloadForBlueprintExecution"}, {"subtype_model": "BackgroundJobPayloadForScriptExecution", "subtype_name": "BackgroundJobPayloadForScriptExecution"}, {"subtype_model": "BackgroundJobPayloadForTemplateExecution", "subtype_name": "BackgroundJobPayloadForTemplateExecution"}, {"subtype_model": "BackgroundJobPayloadForMistralTemplateExecution", "subtype_name": "BackgroundJobPayloadForMistralTemplateExecution"}, {"subtype_model": "BackgroundJobPayloadForTerraformTemplateExecution", "subtype_name": "BackgroundJobPayloadForTerraformTemplateExecution"}, {"subtype_model": "BackgroundJobPayloadForCfnTemplateExecution", "subtype_name": "BackgroundJobPayloadForCfnTemplateExecution"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAwsSecurityHubFindingsSync", "subtype_name": "BackgroundJobPayloadForPeriodicAwsSecurityHubFindingsSync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAwsSsmAutomationExecutionProgress", "subtype_name": "BackgroundJobPayloadForPeriodicAwsSsmAutomationExecutionProgress"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAwsSsmCommandExecutionProgress", "subtype_name": "BackgroundJobPayloadForPeriodicAwsSsmCommandExecutionProgress"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAwsSsmDocuments", "subtype_name": "BackgroundJobPayloadForPeriodicAwsSsmDocuments"}, {"subtype_model": "BackgroundJobPayloadForAwsSsmAutomationExecutionJobs", "subtype_name": "BackgroundJobPayloadForAwsSsmAutomationExecutionJobs"}, {"subtype_model": "BackgroundJobPayloadForAwsSsmCommandExecution", "subtype_name": "BackgroundJobPayloadForAwsSsmCommandExecution"}, {"subtype_model": "BackgroundJobPayloadForAwsSsmCommandExecutionJobs", "subtype_name": "BackgroundJobPayloadForAwsSsmCommandExecutionJobs"}, {"subtype_model": "BackgroundJobPayloadForAwsSsmDocuments", "subtype_name": "BackgroundJobPayloadForAwsSsmDocuments"}, {"subtype_model": "BackgroundJobPayloadForBillingOntologySync", "subtype_name": "BackgroundJobPayloadForBillingOntologySync"}, {"subtype_model": "BackgroundJobPayloadForBillingOntologySyncAdhoc", "subtype_name": "BackgroundJobPayloadForBillingOntologySyncAdhoc"}, {"subtype_model": "BackgroundJobPayloadForBillingOntologyBudgetSync", "subtype_name": "BackgroundJobPayloadForBillingOntologyBudgetSync"}, {"subtype_model": "BackgroundJobPayloadForBillingOntologyBudgetSyncAdhoc", "subtype_name": "BackgroundJobPayloadForBillingOntologyBudgetSyncAdhoc"}, {"subtype_model": "BackgroundJobPayloadForPeriodicMarkupAndDiscountMigration", "subtype_name": "BackgroundJobPayloadForPeriodicMarkupAndDiscountMigration"}, {"subtype_model": "BackgroundJobPayloadForBillingPlanEvaluation", "subtype_name": "BackgroundJobPayloadForBillingPlanEvaluation"}, {"subtype_model": "BackgroundJobPayloadForPeriodicBudgetCost", "subtype_name": "BackgroundJobPayloadForPeriodicBudgetCost"}, {"subtype_model": "BackgroundJobPayloadForPeriodicBudgetSettings", "subtype_name": "BackgroundJobPayloadForPeriodicBudgetSettings"}, {"subtype_model": "BackgroundJobPayloadForBudgetCost", "subtype_name": "BackgroundJobPayloadForBudgetCost"}, {"subtype_model": "BackgroundJobPayloadForBudgetSettings", "subtype_name": "BackgroundJobPayloadForBudgetSettings"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAwsWorkspace", "subtype_name": "BackgroundJobPayloadForPeriodicAwsWorkspace"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAzureSentinelUpdate", "subtype_name": "BackgroundJobPayloadForPeriodicAzureSentinelUpdate"}, {"subtype_model": "BackgroundJobPayloadForPeriodicBudgetInsights", "subtype_name": "BackgroundJobPayloadForPeriodicBudgetInsights"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCloudOpsInsight", "subtype_name": "BackgroundJobPayloadForPeriodicCloudOpsInsight"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCostSavingsCalculation", "subtype_name": "BackgroundJobPayloadForPeriodicCostSavingsCalculation"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCredentialExpirationCheck", "subtype_name": "BackgroundJobPayloadForPeriodicCredentialExpirationCheck"}, {"subtype_model": "BackgroundJobPayloadForPeriodicGovernanceInstanceStatus", "subtype_name": "BackgroundJobPayloadForPeriodicGovernanceInstanceStatus"}, {"subtype_model": "BackgroundJobPayloadForPeriodicGovernanceNotification", "subtype_name": "BackgroundJobPayloadForPeriodicGovernanceNotification"}, {"subtype_model": "BackgroundJobPayloadForPeriodicParseNetworkDetails", "subtype_name": "BackgroundJobPayloadForPeriodicParseNetworkDetails"}, {"subtype_model": "BackgroundJobPayloadForPeriodicRefreshUtilizationSummary", "subtype_name": "BackgroundJobPayloadForPeriodicRefreshUtilizationSummary"}, {"subtype_model": "BackgroundJobPayloadForPeriodicServiceAccountDelete", "subtype_name": "BackgroundJobPayloadForPeriodicServiceAccountDelete"}, {"subtype_model": "BackgroundJobPayloadForPeriodicZabbixGovernance", "subtype_name": "BackgroundJobPayloadForPeriodicZabbixGovernance"}, {"subtype_model": "BackgroundJobPayloadForActivityExecutor", "subtype_name": "BackgroundJobPayloadForActivityExecutor"}, {"subtype_model": "BackgroundJobPayloadForIntegratedToolsAlert", "subtype_name": "BackgroundJobPayloadForIntegratedToolsAlert"}, {"subtype_model": "BackgroundJobPayloadForRefreshRecommendation", "subtype_name": "BackgroundJobPayloadForRefreshRecommendation"}, {"subtype_model": "BackgroundJobPayloadForServiceAccountDelete", "subtype_name": "BackgroundJobPayloadForServiceAccountDelete"}, {"subtype_model": "BackgroundJobPayloadForPeriodicComplianceRefresh", "subtype_name": "BackgroundJobPayloadForPeriodicComplianceRefresh"}, {"subtype_model": "BackgroundJobPayloadForComplianceControl", "subtype_name": "BackgroundJobPayloadForComplianceControl"}, {"subtype_model": "BackgroundJobPayloadForComplianceStandard", "subtype_name": "BackgroundJobPayloadForComplianceStandard"}, {"subtype_model": "BackgroundJobPayloadForPolicyJobStatusUpdate", "subtype_name": "BackgroundJobPayloadForPolicyJobStatusUpdate"}, {"subtype_model": "BackgroundJobPayloadForBulkPolicyTrigger", "subtype_name": "BackgroundJobPayloadForBulkPolicyTrigger"}, {"subtype_model": "BackgroundJobPayloadForThreatVulnerabilityGraphDBSummarySync", "subtype_name": "BackgroundJobPayloadForThreatVulnerabilityGraphDBSummarySync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAzureSecurityGraph", "subtype_name": "BackgroundJobPayloadForPeriodicAzureSecurityGraph"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCloudNativeThreatSync", "subtype_name": "BackgroundJobPayloadForPeriodicCloudNativeThreatSync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCloudNativeVulnerabilitySync", "subtype_name": "BackgroundJobPayloadForPeriodicCloudNativeVulnerabilitySync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicTenableNessus", "subtype_name": "BackgroundJobPayloadForPeriodicTenableNessus"}, {"subtype_model": "BackgroundJobPayloadForPeriodicThreatsVulnerabilityGraphDBSummarySync", "subtype_name": "BackgroundJobPayloadForPeriodicThreatsVulnerabilityGraphDBSummarySync"}, {"subtype_model": "BackgroundJobPayloadForThreatResourceActiveRefresh", "subtype_name": "BackgroundJobPayloadForThreatResourceActiveRefresh"}, {"subtype_model": "BackgroundJobPayloadForCopilotGovernanceMetricsProcessor", "subtype_name": "BackgroundJobPayloadForCopilotGovernanceMetricsProcessor"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCopilotGovernanceMetricsProcessor", "subtype_name": "BackgroundJobPayloadForPeriodicCopilotGovernanceMetricsProcessor"}, {"subtype_model": "BackgroundJobPayloadForRemediationTemplateExecutor", "subtype_name": "BackgroundJobPayloadForRemediationTemplateExecutor"}, {"subtype_model": "BackgroundJobPayloadForCostAnomalyDetector", "subtype_name": "BackgroundJobPayloadForCostAnomalyDetector"}, {"subtype_model": "BackgroundJobPayloadForCostAnomalyDetectorForResources", "subtype_name": "BackgroundJobPayloadForCostAnomalyDetectorForResources"}, {"subtype_model": "BackgroundJobPayloadForCostAnomalyDetectorGraphDBSync", "subtype_name": "BackgroundJobPayloadForCostAnomalyDetectorGraphDBSync"}, {"subtype_model": "BackgroundJobPayloadForCostAnomalyDetectorGraphDBSyncAdhoc", "subtype_name": "BackgroundJobPayloadForCostAnomalyDetectorGraphDBSyncAdhoc"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCostAnomalyDailySummaryNotification", "subtype_name": "BackgroundJobPayloadForPeriodicCostAnomalyDailySummaryNotification"}, {"subtype_model": "BackgroundJobPayloadForCostAnomalyDailySummaryNotification", "subtype_name": "BackgroundJobPayloadForCostAnomalyDailySummaryNotification"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCostAnomalyDetectorForDimensions", "subtype_name": "BackgroundJobPayloadForPeriodicCostAnomalyDetectorForDimensions"}, {"subtype_model": "BackgroundJobPayloadForCostAnomalyDetectorForDimensions", "subtype_name": "BackgroundJobPayloadForCostAnomalyDetectorForDimensions"}, {"subtype_model": "BackgroundJobPayloadForCostAnomalyDailySummaryNotificationForDimensions", "subtype_name": "BackgroundJobPayloadForCostAnomalyDailySummaryNotificationForDimensions"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCustomMetricConfigurationSync", "subtype_name": "BackgroundJobPayloadForPeriodicCustomMetricConfigurationSync"}, {"subtype_model": "BackgroundJobPayloadForCustomMetricConfigurationSync", "subtype_name": "BackgroundJobPayloadForCustomMetricConfigurationSync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicPolicyRefresh", "subtype_name": "BackgroundJobPayloadForPeriodicPolicyRefresh"}, {"subtype_model": "BackgroundJobPayloadForPeriodicDailyPolicyRecommendationGraphDBSync", "subtype_name": "BackgroundJobPayloadForPeriodicDailyPolicyRecommendationGraphDBSync"}, {"subtype_model": "BackgroundJobPayloadForPolicyExecution", "subtype_name": "BackgroundJobPayloadForPolicyExecution"}, {"subtype_model": "BackgroundJobPayloadForPolicyResourceRecommendationRemoval", "subtype_name": "BackgroundJobPayloadForPolicyResourceRecommendationRemoval"}, {"subtype_model": "BackgroundJobPayloadForPolicyOntologyMigration", "subtype_name": "BackgroundJobPayloadForPolicyOntologyMigration"}, {"subtype_model": "BackgroundJobPayloadForPeriodicDiskUtilization", "subtype_name": "BackgroundJobPayloadForPeriodicDiskUtilization"}, {"subtype_model": "BackgroundJobPayloadForPeriodicMetricsUtilization", "subtype_name": "BackgroundJobPayloadForPeriodicMetricsUtilization"}, {"subtype_model": "BackgroundJobPayloadForPeriodicMarketPlacePoller", "subtype_name": "BackgroundJobPayloadForPeriodicMarketPlacePoller"}, {"subtype_model": "BackgroundJobPayloadForPeriodicJiraChangeManagementHandler", "subtype_name": "BackgroundJobPayloadForPeriodicJiraChangeManagementHandler"}, {"subtype_model": "BackgroundJobPayloadForOnpremMetricDataParser", "subtype_name": "BackgroundJobPayloadForOnpremMetricDataParser"}, {"subtype_model": "BackgroundJobPayloadForOnpremAlertChecker", "subtype_name": "BackgroundJobPayloadForOnpremAlertChecker"}, {"subtype_model": "BackgroundJobPayloadForPeriodicOnpremResourceParserCleanup", "subtype_name": "BackgroundJobPayloadForPeriodicOnpremResourceParserCleanup"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAlertConfiguration", "subtype_name": "BackgroundJobPayloadForPeriodicAlertConfiguration"}, {"subtype_model": "BackgroundJobPayloadForPeriodicApplicationPerformanceMonitoring", "subtype_name": "BackgroundJobPayloadForPeriodicApplicationPerformanceMonitoring"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCreateActivityMasterTemplate", "subtype_name": "BackgroundJobPayloadForPeriodicCreateActivityMasterTemplate"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCreateAlertForNewResources", "subtype_name": "BackgroundJobPayloadForPeriodicCreateAlertForNewResources"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCreateMetricMasterTemplate", "subtype_name": "BackgroundJobPayloadForPeriodicCreateMetricMasterTemplate"}, {"subtype_model": "BackgroundJobPayloadForPeriodicLogAnalyticsWorkspace", "subtype_name": "BackgroundJobPayloadForPeriodicLogAnalyticsWorkspace"}, {"subtype_model": "BackgroundJobPayloadForPeriodicLogAnalyticsWorkspaceSync", "subtype_name": "BackgroundJobPayloadForPeriodicLogAnalyticsWorkspaceSync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicMetricsToAnomalyDetection", "subtype_name": "BackgroundJobPayloadForPeriodicMetricsToAnomalyDetection"}, {"subtype_model": "BackgroundJobPayloadForPeriodicMetricValueStorage", "subtype_name": "BackgroundJobPayloadForPeriodicMetricValueStorage"}, {"subtype_model": "BackgroundJobPayloadForPeriodicOperationAssessment", "subtype_name": "BackgroundJobPayloadForPeriodicOperationAssessment"}, {"subtype_model": "BackgroundJobPayloadForPeriodicProcessAlertTemplateStatusUpdate", "subtype_name": "BackgroundJobPayloadForPeriodicProcessAlertTemplateStatusUpdate"}, {"subtype_model": "BackgroundJobPayloadForPeriodicProcessOrphanedConfigurationRecords", "subtype_name": "BackgroundJobPayloadForPeriodicProcessOrphanedConfigurationRecords"}, {"subtype_model": "BackgroundJobPayloadForMetricValueStorage", "subtype_name": "BackgroundJobPayloadForMetricValueStorage"}, {"subtype_model": "BackgroundJobPayloadForResourceAlertConfiguration", "subtype_name": "BackgroundJobPayloadForResourceAlertConfiguration"}, {"subtype_model": "BackgroundJobPayloadForOperationAssessment", "subtype_name": "BackgroundJobPayloadForOperationAssessment"}, {"subtype_model": "BackgroundJobPayloadForOrphanedCloudMonitoringAlert", "subtype_name": "BackgroundJobPayloadForOrphanedCloudMonitoringAlert"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAlertReconciliation", "subtype_name": "BackgroundJobPayloadForPeriodicAlertReconciliation"}, {"subtype_model": "BackgroundJobPayloadForAlertReconciliation", "subtype_name": "BackgroundJobPayloadForAlertReconciliation"}, {"subtype_model": "BackgroundJobPayloadForPeriodicPatchManager", "subtype_name": "BackgroundJobPayloadForPeriodicPatchManager"}, {"subtype_model": "BackgroundJobPayloadForPeriodicProActiveScannerDetailsParser", "subtype_name": "BackgroundJobPayloadForPeriodicProActiveScannerDetailsParser"}, {"subtype_model": "BackgroundJobPayloadForProActiveScannerDetailsParserOnDemand", "subtype_name": "BackgroundJobPayloadForProActiveScannerDetailsParserOnDemand"}, {"subtype_model": "BackgroundJobPayloadForOnDemandApplyRecommendationExclusionRules", "subtype_name": "BackgroundJobPayloadForOnDemandApplyRecommendationExclusionRules"}, {"subtype_model": "BackgroundJobPayloadForPeriodicBackupConfiguration", "subtype_name": "BackgroundJobPayloadForPeriodicBackupConfiguration"}, {"subtype_model": "BackgroundJobPayloadForPeriodicDailyCostReport", "subtype_name": "BackgroundJobPayloadForPeriodicDailyCostReport"}, {"subtype_model": "BackgroundJobPayloadForPeriodicDailyGovernanceReport", "subtype_name": "BackgroundJobPayloadForPeriodicDailyGovernanceReport"}, {"subtype_model": "BackgroundJobPayloadForPeriodicDailyInventoryReport", "subtype_name": "BackgroundJobPayloadForPeriodicDailyInventoryReport"}, {"subtype_model": "BackgroundJobPayloadForPeriodicMonthlyCostReport", "subtype_name": "BackgroundJobPayloadForPeriodicMonthlyCostReport"}, {"subtype_model": "BackgroundJobPayloadForPeriodicRecoveryConfiguration", "subtype_name": "BackgroundJobPayloadForPeriodicRecoveryConfiguration"}, {"subtype_model": "BackgroundJobPayloadForPeriodicSecureScoresConfiguration", "subtype_name": "BackgroundJobPayloadForPeriodicSecureScoresConfiguration"}, {"subtype_model": "BackgroundJobPayloadForBackupConfiguration", "subtype_name": "BackgroundJobPayloadForBackupConfiguration"}, {"subtype_model": "BackgroundJobPayloadForDailyCostReport", "subtype_name": "BackgroundJobPayloadForDailyCostReport"}, {"subtype_model": "BackgroundJobPayloadForDailyGovernanceReport", "subtype_name": "BackgroundJobPayloadForDailyGovernanceReport"}, {"subtype_model": "BackgroundJobPayloadForDailyInventoryReport", "subtype_name": "BackgroundJobPayloadForDailyInventoryReport"}, {"subtype_model": "BackgroundJobPayloadForMonthlyCostReport", "subtype_name": "BackgroundJobPayloadForMonthlyCostReport"}, {"subtype_model": "BackgroundJobPayloadForRecoveryConfiguration", "subtype_name": "BackgroundJobPayloadForRecoveryConfiguration"}, {"subtype_model": "BackgroundJobPayloadForSecureScoresConfiguration", "subtype_name": "BackgroundJobPayloadForSecureScoresConfiguration"}, {"subtype_model": "BackgroundJobPayloadForPeriodicInventoryUnitRate", "subtype_name": "BackgroundJobPayloadForPeriodicInventoryUnitRate"}, {"subtype_model": "BackgroundJobPayloadForPeriodicServiceResourceBillingCategory", "subtype_name": "BackgroundJobPayloadForPeriodicServiceResourceBillingCategory"}, {"subtype_model": "BackgroundJobPayloadForPeriodicSynchronizeNirmata", "subtype_name": "BackgroundJobPayloadForPeriodicSynchronizeNirmata"}, {"subtype_model": "BackgroundJobPayloadForPeriodicUnitPriceRate", "subtype_name": "BackgroundJobPayloadForPeriodicUnitPriceRate"}, {"subtype_model": "BackgroundJobPayloadForPeriodicTagDiscovery", "subtype_name": "BackgroundJobPayloadForPeriodicTagDiscovery"}, {"subtype_model": "BackgroundJobPayloadForExtendedResourceDiscovery", "subtype_name": "BackgroundJobPayloadForExtendedResourceDiscovery"}, {"subtype_model": "BackgroundJobPayloadForResourcesDuplicationRemoval", "subtype_name": "BackgroundJobPayloadForResourcesDuplicationRemoval"}, {"subtype_model": "BackgroundJobPayloadForInventoryUnitRate", "subtype_name": "BackgroundJobPayloadForInventoryUnitRate"}, {"subtype_model": "BackgroundJobPayloadForResourceActivityLogSync", "subtype_name": "BackgroundJobPayloadForResourceActivityLogSync"}, {"subtype_model": "BackgroundJobPayloadForResourceTagRemediation", "subtype_name": "BackgroundJobPayloadForResourceTagRemediation"}, {"subtype_model": "BackgroundJobPayloadForUnitRateCrawler", "subtype_name": "BackgroundJobPayloadForUnitRateCrawler"}, {"subtype_model": "BackgroundJobPayloadForTagDiscovery", "subtype_name": "BackgroundJobPayloadForTagDiscovery"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCloudWatchMetrics", "subtype_name": "BackgroundJobPayloadForPeriodicCloudWatchMetrics"}, {"subtype_model": "BackgroundJobPayloadForPeriodicCloudWatchMetricsConfiguration", "subtype_name": "BackgroundJobPayloadForPeriodicCloudWatchMetricsConfiguration"}, {"subtype_model": "BackgroundJobPayloadForResourceLockSync", "subtype_name": "BackgroundJobPayloadForResourceLockSync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAssessmentDataCollection", "subtype_name": "BackgroundJobPayloadForPeriodicAssessmentDataCollection"}, {"subtype_model": "BackgroundJobPayloadForPeriodicAssessmentGovernanceCost", "subtype_name": "BackgroundJobPayloadForPeriodicAssessmentGovernanceCost"}, {"subtype_model": "BackgroundJobPayloadForPeriodicResourceDiscovery", "subtype_name": "BackgroundJobPayloadForPeriodicResourceDiscovery"}, {"subtype_model": "BackgroundJobPayloadForAssessmentDataCollection", "subtype_name": "BackgroundJobPayloadForAssessmentDataCollection"}, {"subtype_model": "BackgroundJobPayloadForResourceDashboard", "subtype_name": "BackgroundJobPayloadForResourceDashboard"}, {"subtype_model": "BackgroundJobPayloadForResourceDiscovery", "subtype_name": "BackgroundJobPayloadForResourceDiscovery"}, {"subtype_model": "BackgroundJobPayloadForResourceDiscoveryExecution", "subtype_name": "BackgroundJobPayloadForResourceDiscoveryExecution"}, {"subtype_model": "BackgroundJobPayloadForResourceDependencyRelationship", "subtype_name": "BackgroundJobPayloadForResourceDependencyRelationship"}, {"subtype_model": "BackgroundJobPayloadForPeriodicVirtualMachinesAgents", "subtype_name": "BackgroundJobPayloadForPeriodicVirtualMachinesAgents"}, {"subtype_model": "BackgroundJobPayloadForVirtualMachinesAgents", "subtype_name": "BackgroundJobPayloadForVirtualMachinesAgents"}, {"subtype_model": "BackgroundJobPayloadForScheduleRecommendation", "subtype_name": "BackgroundJobPayloadForScheduleRecommendation"}, {"subtype_model": "BackgroundJobPayloadForStacksMarketplaceStackDeploymentExecution", "subtype_name": "BackgroundJobPayloadForStacksMarketplaceStackDeploymentExecution"}, {"subtype_model": "BackgroundJobPayloadForStacksMarketplaceStackVersionCostEstimateExecution", "subtype_name": "BackgroundJobPayloadForStacksMarketplaceStackVersionCostEstimateExecution"}, {"subtype_model": "BackgroundJobPayloadForTagPosture", "subtype_name": "BackgroundJobPayloadForTagPosture"}, {"subtype_model": "BackgroundJobPayloadForTagPostureSync", "subtype_name": "BackgroundJobPayloadForTagPostureSync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicWorkloadAssessmentCleanup", "subtype_name": "BackgroundJobPayloadForPeriodicWorkloadAssessmentCleanup"}, {"subtype_model": "BackgroundJobPayloadForWorkloadOntologyMigration", "subtype_name": "BackgroundJobPayloadForWorkloadOntologyMigration"}, {"subtype_model": "BackgroundJobPayloadForPeriodicWorkloadVulnerabilityThreatSummaryDaily", "subtype_name": "BackgroundJobPayloadForPeriodicWorkloadVulnerabilityThreatSummaryDaily"}, {"subtype_model": "BackgroundJobPayloadForWorkloadResourceSync", "subtype_name": "BackgroundJobPayloadForWorkloadResourceSync"}, {"subtype_model": "BackgroundJobPayloadForPeriodicWorkloadResourceSnapshotDaily", "subtype_name": "BackgroundJobPayloadForPeriodicWorkloadResourceSnapshotDaily"}, {"subtype_model": "BackgroundJobPayloadForWorkloadResourceSnapshot", "subtype_name": "BackgroundJobPayloadForWorkloadResourceSnapshot"}, {"subtype_model": "BackgroundJobPayloadForPeriodicWorkloadVulnerabilityThreatSummaryMonthly", "subtype_name": "BackgroundJobPayloadForPeriodicWorkloadVulnerabilityThreatSummaryMonthly"}, {"subtype_model": "BackgroundJobPayloadForDefaultWorkloadCreation", "subtype_name": "BackgroundJobPayloadForDefaultWorkloadCreation"}, {"subtype_model": "BackgroundJobPayloadForPeriodicWorkloadRecommendationSnapshotDaily", "subtype_name": "BackgroundJobPayloadForPeriodicWorkloadRecommendationSnapshotDaily"}]}, "BackgroundJobPayloadForAccessGovernance": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"cloud_account_id": {"type": "string", "description": "Cloud Account ID", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAccessGovernance"}, "BackgroundJobPayloadForActivityExecutor": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["activity_type", "alert_data"], "properties": {"activity_type": {"type": "string", "description": "Type of activity executor action", "example": "activity_log", "enum": ["activity_log", "cloudops_parser", "secops_parser"], "x-cs-enum-type": "ActivityExecutorType"}, "alert_data": {"type": "string", "description": "alert data in json encoded text"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForActivityExecutor"}, "BackgroundJobPayloadForAiAgentReportHandler": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"report_id": {"type": "string", "description": "ID of the report being generated"}, "report_run_id": {"type": "string", "description": "ID of the report run"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAiAgentReportHandler"}, "BackgroundJobPayloadForAlertReconciliation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "ID of the service account to reconcile alerts for", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAlertReconciliation"}, "BackgroundJobPayloadForAppSecopsEntityBulkUpdate": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["entity_type"], "properties": {"entity_type": {"description": "Entity type for which the bulk update has to be performed", "$ref": "#/definitions/AppSecopsEntityType"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAppSecopsEntityBulkUpdate"}, "BackgroundJobPayloadForAssessmentDataCollection": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID that needs to processed", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentDataCollection"}, "BackgroundJobPayloadForAssessmentFramework": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"assessment_id": {"type": "string", "description": "Assessment ID"}, "policy_job_id": {"type": "string", "description": "Policy Job ID"}, "policy_job_status": {"type": "string", "description": "Policy Job Status"}, "total_count": {"type": "integer", "description": "Total Count"}, "violation_count": {"type": "integer", "description": "Validation Count"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentFramework"}, "BackgroundJobPayloadForAssessmentFrameworkOntologySync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentFrameworkOntologySync"}, "BackgroundJobPayloadForAssessmentFrameworkRun": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service account for which the assessments have to be triggered"}, "category_list": {"type": "array", "description": "Name of the categories for which the assessment has to be triggered", "items": {"type": "string", "example": "operations", "enum": ["operations", "security", "access", "cost", "resource", "compliance"], "x-cs-enum-type": "AssessmentCategory"}}, "assessment_mode": {"type": "string", "description": "assessment is triggered by automation or manual mode", "example": "automated", "enum": ["automated", "manual"], "x-cs-enum-type": "AssessmentMode"}, "triggered_by": {"type": "string", "description": "assessment triggered by user or system"}, "user_id": {"type": "string", "description": "user id"}, "assessment_run_details": {"description": "assessment run related details", "$ref": "#/definitions/AssessmentRetriggerState"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentFrameworkRun"}, "BackgroundJobPayloadForAssessmentReportOntologyMigration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentReportOntologyMigration"}, "BackgroundJobPayloadForAssessmentRun": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"state": {"type": "string", "description": "State of the background job", "example": "Setup", "enum": ["Setup", "StartScan", "Polling", "UpdateQuestions", "HandleUnansweredQuestions", "SyncAnswers", "GenerateReport", "SendNotification", "GenerateTTL"], "x-cs-enum-type": "BackgroundJobPayloadForAssessmentRunState"}, "assessment_run_history_id": {"type": "string", "description": "The assessment run history for this scan"}, "contexts": {"type": "array", "description": "Context triggering this background job", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentContext"}}, "is_rescan": {"type": "boolean", "description": "States if the assessment is full scan or not"}, "report_ids": {"type": "array", "items": {"type": "string", "description": "List of Report IDs"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentRun"}, "BackgroundJobPayloadForAssessmentRunReport": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"assessment_run_report_id": {"type": "string", "description": "ID of the Assessment Run report", "x-cs-type": "ObjectId"}, "report_id": {"type": "string", "description": "ID of the report being generated"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentRunReport"}, "BackgroundJobPayloadForAssessmentRunScan": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"assessment_run_history_id": {"type": "string", "description": "The assessment run history for this scan"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentRunScan"}, "BackgroundJobPayloadForAssessmentRunTtlGeneration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"milestone_name": {"type": "string", "description": "Milestone name for this ontology generation"}, "framework_ids": {"type": "array", "items": {"type": "string", "description": "List of framework IDs for ontology generation"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentRunTtlGeneration"}, "BackgroundJobPayloadForAssessmentRunTtlRefresh": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"refresh_data_list": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunTTLRefreshRequest"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAssessmentRunTtlRefresh"}, "BackgroundJobPayloadForAutoAssessment": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["cloud_account_id"], "properties": {"state": {"type": "string", "description": "State of the Auto Assessment background job", "example": "BeginAssessment", "enum": ["BeginAssessment", "GenerateReport", "NotifyAssessment", "SendReport", "Skipped", "WaitingForScanComplete"], "x-cs-enum-type": "BackgroundJobPayloadForAutoAssessmentState"}, "cloud_account_id": {"type": "string", "description": "Cloud account ID of the Auto Assessment"}, "assessment_run_id": {"type": "string", "description": "Assessment run ID of the Auto Assessment"}, "report_id": {"type": "string", "description": "ID of the report being generated for Auto Assessment"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAutoAssessment"}, "BackgroundJobPayloadForAwsSsmAutomationExecutionJobs": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"automation_execution_id": {"type": "string", "description": "Execution ID of the command document"}, "job_group_id": {"type": "string", "description": "SSM job group document id"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAwsSsmAutomationExecutionJobs"}, "BackgroundJobPayloadForAwsSsmCommandExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"cloud_account_id": {"type": "string", "description": "Cloud Account id for the background job command execution."}, "region": {"type": "string", "description": "Region of command execution."}, "execution_id": {"type": "string", "description": "ID of command execution in AWS."}, "status": {"type": "string", "description": "Command Execution Status."}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAwsSsmCommandExecution"}, "BackgroundJobPayloadForAwsSsmCommandExecutionJobs": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"command_execution_id": {"type": "string", "description": "Execution ID of the command document"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAwsSsmCommandExecutionJobs"}, "BackgroundJobPayloadForAwsSsmDocuments": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"master_account_id": {"type": "string", "description": "Master Account id for the background job need to processed"}, "cloud_account_id": {"type": "string", "description": "Cloud Account id for the background job need to processed"}, "sync_type": {"type": "string", "description": "Type of the document sync", "example": "automation", "enum": ["automation", "manual"], "x-cs-enum-type": "AwsSsmDocumentSyncType"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForAwsSsmDocuments"}, "BackgroundJobPayloadForBackupConfiguration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBackupConfiguration"}, "BackgroundJobPayloadForBillingEntryCleanup": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target Cloud Account", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBillingEntryCleanup"}, "BackgroundJobPayloadForBillingOntologyBudgetSync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account whose budget data is synced to GraphDB", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBillingOntologyBudgetSync"}, "BackgroundJobPayloadForBillingOntologyBudgetSyncAdhoc": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBillingOntologyBudgetSyncAdhoc"}, "BackgroundJobPayloadForBillingOntologySync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["family", "master_account_id", "service_account_id", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "CoreStack tenant whose data is being projected (named-graph scope).", "x-cs-type": "ObjectId"}, "master_account_id": {"type": "string", "description": "CoreStack master account (GraphDB repo scope).", "x-cs-type": "ObjectId"}, "service_account_id": {"type": "string", "description": "Cloud account whose RI / SP data is being projected.", "x-cs-type": "ObjectId"}, "family": {"type": "string", "description": "Which ontology family to project: ri or sp.", "example": "ri", "enum": ["ri", "sp"], "x-cs-enum-type": "BillingOntologySyncFamily"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBillingOntologySync"}, "BackgroundJobPayloadForBillingOntologySyncAdhoc": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBillingOntologySyncAdhoc"}, "BackgroundJobPayloadForBillingPlanEvaluation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service account ID", "x-cs-type": "ObjectId"}, "start_date": {"type": "string", "format": "date-time", "description": "Start date of billing data"}, "end_date": {"type": "string", "format": "date-time", "description": "End date of billing data"}, "modified_line_items": {"type": "array", "description": "List of modified line items", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBillingPlanEvaluation"}, "BackgroundJobPayloadForBlueprintExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["execution_params", "execution_type", "job_id"], "properties": {"job_id": {"type": "string"}, "execution_type": {"type": "string", "example": "execute", "enum": ["execute", "resume"], "x-cs-enum-type": "BlueprintExecutionOption"}, "execution_params": {"type": "object", "description": "parameters to blueprint"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBlueprintExecution"}, "BackgroundJobPayloadForBudgetAlertNotification": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["job_id", "status", "status_reason"], "properties": {"job_id": {"type": "string"}, "status": {"type": "string", "description": "status", "example": "completed", "enum": ["completed", "failed", "in_progress", "pending", "user_action_required"], "x-cs-enum-type": "BudgetAlertTriggerStatus"}, "status_reason": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBudgetAlertNotification"}, "BackgroundJobPayloadForBudgetAlertTrigger": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["budget_alert_trigger_id", "retries_remaining"], "properties": {"budget_alert_trigger_id": {"type": "string", "description": "Id of BUDGET_ALERT_TRIGGER_TRANSACTION_DETAILS document"}, "retries_remaining": {"type": "integer", "description": "number of retries remaining"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBudgetAlertTrigger"}, "BackgroundJobPayloadForBudgetCost": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["budget_id"], "properties": {"budget_id": {"type": "string", "description": "Id of budget document", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBudgetCost"}, "BackgroundJobPayloadForBudgetSettings": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["budget_id"], "properties": {"budget_id": {"type": "string", "description": "Id of budget document", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBudgetSettings"}, "BackgroundJobPayloadForBulkPolicyTrigger": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"execution_reference": {"type": "string"}, "execution_group": {"type": "string"}, "master_account_id": {"type": "string", "x-cs-type": "ObjectId"}, "tenant_id": {"type": "string", "x-cs-type": "ObjectId"}, "username": {"type": "string"}, "service_accounts": {"type": "array", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "policy_info": {"type": "array", "items": {"$ref": "#/definitions/PolicyTriggerInfo"}}, "applicable_resources": {"type": "array", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForBulkPolicyTrigger"}, "BackgroundJobPayloadForCfnTemplateExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["execution_params", "job_id", "notification_email_id"], "properties": {"job_id": {"type": "string"}, "notification_email_id": {"type": "string"}, "execution_params": {"type": "object", "description": "parameters to template"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCfnTemplateExecution"}, "BackgroundJobPayloadForCloudHealthMonitoring": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCloudHealthMonitoring"}, "BackgroundJobPayloadForCloudHealthMonitoringMetricSyncerStateless": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["alert_id", "metric_name", "resource_id", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID for the resource", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Cloud resource ID"}, "metric_name": {"type": "string", "description": "Metric name being synced"}, "alert_id": {"type": "string", "description": "ObjectId of the cloudops_event_logger alert document", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCloudHealthMonitoringMetricSyncerStateless"}, "BackgroundJobPayloadForCloudHealthMonitoringParserOnDemand": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["alert_data", "metric_name", "resource_id", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID that needs to processed", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Resource ID"}, "metric_name": {"type": "string", "description": "Metric name"}, "alert_data": {"type": "string", "description": "alert data in json encoded text"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCloudHealthMonitoringParserOnDemand"}, "BackgroundJobPayloadForCloudUsageBilling": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target Cloud Account", "x-cs-type": "ObjectId"}, "backfill_start_date": {"type": "string", "format": "date-time"}, "backfill_end_date": {"type": "string", "format": "date-time"}, "progress": {"description": "Progress of the cost processing", "$ref": "#/definitions/CostProcessingProgress"}, "dimension_precompute_only": {"type": "boolean", "description": "If true, only precompute dimensions without calculating costs"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCloudUsageBilling"}, "BackgroundJobPayloadForCloudUsageBillingAggregation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target Service Account Id", "x-cs-type": "ObjectId"}, "start_date": {"type": "string", "format": "date-time"}, "end_date": {"type": "string", "format": "date-time"}, "skip_l1_to_l1_slim": {"type": "boolean", "description": "Skip L1 to L1 Slim aggregation", "default": false}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCloudUsageBillingAggregation"}, "BackgroundJobPayloadForCloudUsageBillingMigration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target Cloud Account", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCloudUsageBillingMigration"}, "BackgroundJobPayloadForCloudUsageBillingMigrationPropagation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCloudUsageBillingMigrationPropagation"}, "BackgroundJobPayloadForComplianceControl": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"tenant_id": {"type": "string"}, "user_id": {"type": "string"}, "service_accounts": {"type": "array", "items": {"type": "string"}}, "assessment_jobs": {"type": "object", "additionalProperties": {"type": "string"}}, "compliance_control_uri": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForComplianceControl"}, "BackgroundJobPayloadForComplianceStandard": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"tenant_id": {"type": "string"}, "user_id": {"type": "string"}, "service_accounts": {"type": "array", "items": {"type": "string"}}, "assessment_jobs": {"type": "object", "additionalProperties": {"type": "string"}}, "compliance_uri": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForComplianceStandard"}, "BackgroundJobPayloadForContainerFindingsParser": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["findings_source_tool"], "properties": {"findings_source_tool": {"type": "string", "description": "Source tool from which the findings are ingested", "example": "Hadolint", "enum": ["Hadolint", "Dockle", "AzureDefender", "InspectorV2", "InspectorClassic", "SecurityCommandCenter", "CloudGuard", "Guardduty"], "x-cs-enum-type": "SecurityFindingsSourceTool"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForContainerFindingsParser"}, "BackgroundJobPayloadForCopilotGovernanceMetricsProcessor": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service account ID to which the Copilot data has to be synced", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCopilotGovernanceMetricsProcessor"}, "BackgroundJobPayloadForCostAnomalyDailySummaryNotification": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCostAnomalyDailySummaryNotification"}, "BackgroundJobPayloadForCostAnomalyDailySummaryNotificationForDimensions": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["dimension_id", "grouping_rule_id", "master_account_id"], "properties": {"master_account_id": {"type": "string", "description": "Master Account ID"}, "dimension_id": {"type": "string", "description": "Dimension ID"}, "grouping_rule_id": {"type": "string", "description": "Grouping key for the dimension"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCostAnomalyDailySummaryNotificationForDimensions"}, "BackgroundJobPayloadForCostAnomalyDetector": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCostAnomalyDetector"}, "BackgroundJobPayloadForCostAnomalyDetectorForDimensions": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["dimension_id", "grouping_rule_id", "master_account_id"], "properties": {"master_account_id": {"type": "string", "description": "Master Account ID"}, "dimension_id": {"type": "string", "description": "Dimension ID"}, "grouping_rule_id": {"type": "string", "description": "Grouping key for the dimension"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCostAnomalyDetectorForDimensions"}, "BackgroundJobPayloadForCostAnomalyDetectorForResources": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCostAnomalyDetectorForResources"}, "BackgroundJobPayloadForCostAnomalyDetectorGraphDBSync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account whose cost-anomaly data is synced to GraphDB", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCostAnomalyDetectorGraphDBSync"}, "BackgroundJobPayloadForCostAnomalyDetectorGraphDBSyncAdhoc": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCostAnomalyDetectorGraphDBSyncAdhoc"}, "BackgroundJobPayloadForCrpRecommendations": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCrpRecommendations"}, "BackgroundJobPayloadForCustomMetricConfigurationSync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Cloud Account Id for which custom metric configuration sync to be triggered.", "x-cs-type": "ObjectId"}, "metric_configuration_id": {"type": "string", "description": "In case of a specific metric configuration update, the id has to be added in payload"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForCustomMetricConfigurationSync"}, "BackgroundJobPayloadForDailyCostReport": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForDailyCostReport"}, "BackgroundJobPayloadForDailyGovernanceReport": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForDailyGovernanceReport"}, "BackgroundJobPayloadForDailyInventoryReport": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForDailyInventoryReport"}, "BackgroundJobPayloadForDefaultWorkloadCreation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service account ID for which to create default workload"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForDefaultWorkloadCreation"}, "BackgroundJobPayloadForEngineTest": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"header": {"type": "string"}, "sleep": {"type": "number"}, "reschedule": {"type": "number"}, "cause_failure": {"type": "string"}, "honor_cancellation": {"type": "boolean"}, "sub_jobs": {"type": "array", "items": {"$ref": "#/definitions/BackgroundJobEngineTestSub"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForEngineTest"}, "BackgroundJobPayloadForExecutiveDashboardReport": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"dashboard_report_id": {"type": "string", "description": "ID of the executive dashboard report", "x-cs-type": "ObjectId"}, "report_id": {"type": "string", "description": "ID of the report being generated"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForExecutiveDashboardReport"}, "BackgroundJobPayloadForExtendedResourceDiscovery": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["extended_operation_details", "resource_inventory_id", "service_account_id"], "properties": {"service_account_id": {"type": "string"}, "resource_inventory_id": {"type": "string"}, "extended_operation_details": {"type": "object", "additionalProperties": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForExtendedResourceDiscovery"}, "BackgroundJobPayloadForGenericTask": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"target": {"type": "string"}, "args": {"type": "array", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForGenericTask"}, "BackgroundJobPayloadForGraphionRiskScoreUpdate": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForGraphionRiskScoreUpdate"}, "BackgroundJobPayloadForIntegratedToolsAlert": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["alert_data", "alert_type"], "properties": {"integrated_tool": {"type": "string", "description": "Integrated Tool to select", "example": "Anomaly_Detector", "enum": ["Anomaly_Detector", "AppDynamics", "App_Insights", "ArrowSphere", "Azure_Devops", "Azure_Security_Graph", "Azure_Sentinel", "Corestack", "DockerHub", "ElasticSearch", "Freshservice", "GitHub", "JIRA_DataCenter", "JIRA_ServiceDesk", "JIRA_ServiceManagement", "Jenkins", "Logstash", "Microsoft_Teams", "Nagios", "Newrelic", "Prometheus", "Qualys", "RedHat_Satellite", "ServiceNow", "TCL_ITSM", "Tenable_Nessus", "ZOHO_ServiceDesk", "Zabbix"], "x-cs-enum-type": "IntegratedToolName"}, "alert_type": {"type": "string", "example": "cs_alert", "enum": ["cs_alert", "cs_budget_alert", "cs_policy_violation", "cmdb_message", "cs_activity", "itsm_activity", "snow_activity", "inventory_activity"], "x-cs-enum-type": "IntegratedToolAlertType"}, "alert_data": {"type": "string", "description": "alert data in json encoded text"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForIntegratedToolsAlert"}, "BackgroundJobPayloadForInventoryUnitRate": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_name": {"type": "string", "description": "cloud service name", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "service_account_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForInventoryUnitRate"}, "BackgroundJobPayloadForKubernetesClusterBilling": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Parent Cloud Account for the Kubernetes Cluster", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForKubernetesClusterBilling"}, "BackgroundJobPayloadForKubernetesClusterUsageBilling": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target Kubernetes Cluster Account under the parent account", "x-cs-type": "ObjectId"}, "backfill_start_date": {"type": "string", "format": "date-time"}, "backfill_end_date": {"type": "string", "format": "date-time"}, "progress": {"description": "Progress of the cost processing", "$ref": "#/definitions/CostProcessingProgress"}, "dimension_precompute_only": {"type": "boolean", "description": "If true, only precompute dimensions without calculating costs"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForKubernetesClusterUsageBilling"}, "BackgroundJobPayloadForKubernetesClusterUsageBillingFullRefresh": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target Kubernetes Cluster Account under the parent account", "x-cs-type": "ObjectId"}, "backfill_start_date": {"type": "string", "format": "date-time"}, "backfill_end_date": {"type": "string", "format": "date-time"}, "progress": {"description": "Progress of the cost processing", "$ref": "#/definitions/CostProcessingProgress"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForKubernetesClusterUsageBillingFullRefresh"}, "BackgroundJobPayloadForMasterDataTtlGeneration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"cloud_provider": {"type": "string", "description": "Cloud provider for which master data sync is to be performed", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForMasterDataTtlGeneration"}, "BackgroundJobPayloadForMetricValueStorage": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "x-cs-type": "ObjectId"}, "is_custom": {"type": "boolean"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForMetricValueStorage"}, "BackgroundJobPayloadForMistralTemplateExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["execution_params", "job_id", "notification_email_id"], "properties": {"job_id": {"type": "string"}, "notification_email_id": {"type": "string"}, "execution_params": {"type": "object", "description": "parameters to template"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForMistralTemplateExecution"}, "BackgroundJobPayloadForMonthlyCostReport": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForMonthlyCostReport"}, "BackgroundJobPayloadForNextGenReportHandler": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"report_run_id": {"type": "string", "description": "ID of the report run"}, "report_id": {"type": "string", "description": "ID of the report being generated"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForNextGenReportHandler"}, "BackgroundJobPayloadForOnDemandApplyRecommendationExclusionRules": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"tenant_id": {"type": "string", "description": "Rules to apply on provided tenant.", "x-cs-type": "ObjectId"}, "user_id": {"type": "string", "description": "Apply rules initiated User Id", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForOnDemandApplyRecommendationExclusionRules"}, "BackgroundJobPayloadForOnpremAlertChecker": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service account ID"}, "resource_id": {"type": "string", "description": "Unique resource identifier"}, "metric_name": {"type": "string", "description": "Metric to evaluate"}, "alert_type": {"type": "string", "description": "Alert rule type identifier"}, "threshold": {"type": "number", "description": "Breach threshold value"}, "operator": {"type": "string", "description": "Comparison operator"}, "window_size": {"type": "integer", "description": "Rolling window size in Seconds"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForOnpremAlertChecker"}, "BackgroundJobPayloadForOnpremMetricDataParser": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service account ID"}, "resource_id": {"type": "string", "description": "Unique resource identifier"}, "metric_name": {"type": "string", "description": "Metric being reported"}, "data": {"type": "string", "description": "Complete raw SQS message in String"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForOnpremMetricDataParser"}, "BackgroundJobPayloadForOperationAssessment": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id", "sync_type"], "properties": {"service_account_id": {"type": "string", "x-cs-type": "ObjectId"}, "sync_type": {"type": "string", "description": "Sync Type of Operations Assessment", "example": "activity_log", "enum": ["activity_log", "monitoring_alert"], "x-cs-enum-type": "OperationsAssessmentSyncType"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForOperationAssessment"}, "BackgroundJobPayloadForOrphanedCloudMonitoringAlert": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["inventory_id"], "properties": {"inventory_id": {"type": "string", "description": "identifier of the resource"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForOrphanedCloudMonitoringAlert"}, "BackgroundJobPayloadForPeriodicAccessGovernance": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAccessGovernance"}, "BackgroundJobPayloadForPeriodicAccessValidation": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAccessValidation"}, "BackgroundJobPayloadForPeriodicAlertConfiguration": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAlertConfiguration"}, "BackgroundJobPayloadForPeriodicAlertReconciliation": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAlertReconciliation"}, "BackgroundJobPayloadForPeriodicApplicationPerformanceMonitoring": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicApplicationPerformanceMonitoring"}, "BackgroundJobPayloadForPeriodicAssessmentDataCollection": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAssessmentDataCollection"}, "BackgroundJobPayloadForPeriodicAssessmentGovernanceCost": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAssessmentGovernanceCost"}, "BackgroundJobPayloadForPeriodicAwsSecurityHubFindingsSync": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAwsSecurityHubFindingsSync"}, "BackgroundJobPayloadForPeriodicAwsSsmAutomationExecutionProgress": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAwsSsmAutomationExecutionProgress"}, "BackgroundJobPayloadForPeriodicAwsSsmCommandExecutionProgress": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAwsSsmCommandExecutionProgress"}, "BackgroundJobPayloadForPeriodicAwsSsmDocuments": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAwsSsmDocuments"}, "BackgroundJobPayloadForPeriodicAwsWorkspace": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAwsWorkspace"}, "BackgroundJobPayloadForPeriodicAzureSecurityGraph": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAzureSecurityGraph"}, "BackgroundJobPayloadForPeriodicAzureSentinelUpdate": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicAzureSentinelUpdate"}, "BackgroundJobPayloadForPeriodicBackupConfiguration": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicBackupConfiguration"}, "BackgroundJobPayloadForPeriodicBillingEntryCleanup": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicBillingEntryCleanup"}, "BackgroundJobPayloadForPeriodicBudgetAlert": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicBudgetAlert"}, "BackgroundJobPayloadForPeriodicBudgetCost": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicBudgetCost"}, "BackgroundJobPayloadForPeriodicBudgetInsights": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicBudgetInsights"}, "BackgroundJobPayloadForPeriodicBudgetSettings": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicBudgetSettings"}, "BackgroundJobPayloadForPeriodicCloudAccountTagSync": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCloudAccountTagSync"}, "BackgroundJobPayloadForPeriodicCloudHealthMonitoring": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCloudHealthMonitoring"}, "BackgroundJobPayloadForPeriodicCloudNativeThreatSync": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCloudNativeThreatSync"}, "BackgroundJobPayloadForPeriodicCloudNativeVulnerabilitySync": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCloudNativeVulnerabilitySync"}, "BackgroundJobPayloadForPeriodicCloudOpsInsight": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCloudOpsInsight"}, "BackgroundJobPayloadForPeriodicCloudUsageBilling": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCloudUsageBilling"}, "BackgroundJobPayloadForPeriodicCloudWatchMetrics": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCloudWatchMetrics"}, "BackgroundJobPayloadForPeriodicCloudWatchMetricsConfiguration": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCloudWatchMetricsConfiguration"}, "BackgroundJobPayloadForPeriodicComplianceRefresh": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicComplianceRefresh"}, "BackgroundJobPayloadForPeriodicCopilotGovernanceMetricsProcessor": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCopilotGovernanceMetricsProcessor"}, "BackgroundJobPayloadForPeriodicCostAnomalyDailySummaryNotification": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCostAnomalyDailySummaryNotification"}, "BackgroundJobPayloadForPeriodicCostAnomalyDetectorForDimensions": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCostAnomalyDetectorForDimensions"}, "BackgroundJobPayloadForPeriodicCostSavingsCalculation": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCostSavingsCalculation"}, "BackgroundJobPayloadForPeriodicCreateActivityMasterTemplate": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCreateActivityMasterTemplate"}, "BackgroundJobPayloadForPeriodicCreateAlertForNewResources": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCreateAlertForNewResources"}, "BackgroundJobPayloadForPeriodicCreateMetricMasterTemplate": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCreateMetricMasterTemplate"}, "BackgroundJobPayloadForPeriodicCredentialExpirationCheck": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCredentialExpirationCheck"}, "BackgroundJobPayloadForPeriodicCrpRecommendations": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCrpRecommendations"}, "BackgroundJobPayloadForPeriodicCustomMetricConfigurationSync": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCustomMetricConfigurationSync"}, "BackgroundJobPayloadForPeriodicCustomWorkflowManager": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicCustomWorkflowManager"}, "BackgroundJobPayloadForPeriodicDailyCostReport": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicDailyCostReport"}, "BackgroundJobPayloadForPeriodicDailyGovernanceReport": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicDailyGovernanceReport"}, "BackgroundJobPayloadForPeriodicDailyInventoryReport": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicDailyInventoryReport"}, "BackgroundJobPayloadForPeriodicDailyPolicyRecommendationGraphDBSync": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicDailyPolicyRecommendationGraphDBSync"}, "BackgroundJobPayloadForPeriodicDiskUtilization": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicDiskUtilization"}, "BackgroundJobPayloadForPeriodicGovernanceConfigurationValidation": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicGovernanceConfigurationValidation"}, "BackgroundJobPayloadForPeriodicGovernanceInstanceStatus": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicGovernanceInstanceStatus"}, "BackgroundJobPayloadForPeriodicGovernanceNotification": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicGovernanceNotification"}, "BackgroundJobPayloadForPeriodicInventoryUnitRate": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicInventoryUnitRate"}, "BackgroundJobPayloadForPeriodicJiraChangeManagementHandler": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicJiraChangeManagementHandler"}, "BackgroundJobPayloadForPeriodicLogAnalyticsWorkspace": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicLogAnalyticsWorkspace"}, "BackgroundJobPayloadForPeriodicLogAnalyticsWorkspaceSync": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicLogAnalyticsWorkspaceSync"}, "BackgroundJobPayloadForPeriodicMarketPlacePoller": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicMarketPlacePoller"}, "BackgroundJobPayloadForPeriodicMarkupAndDiscountMigration": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicMarkupAndDiscountMigration"}, "BackgroundJobPayloadForPeriodicMasterDataTtlGeneration": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicMasterDataTtlGeneration"}, "BackgroundJobPayloadForPeriodicMetricValueStorage": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicMetricValueStorage"}, "BackgroundJobPayloadForPeriodicMetricsToAnomalyDetection": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicMetricsToAnomalyDetection"}, "BackgroundJobPayloadForPeriodicMetricsUtilization": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicMetricsUtilization"}, "BackgroundJobPayloadForPeriodicMonthlyCostReport": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicMonthlyCostReport"}, "BackgroundJobPayloadForPeriodicOnboardAndUpdateGCPAndAWSHierarchy": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicOnboardAndUpdateGCPAndAWSHierarchy"}, "BackgroundJobPayloadForPeriodicOnpremResourceParserCleanup": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicOnpremResourceParserCleanup"}, "BackgroundJobPayloadForPeriodicOperationAssessment": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicOperationAssessment"}, "BackgroundJobPayloadForPeriodicParseNetworkDetails": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicParseNetworkDetails"}, "BackgroundJobPayloadForPeriodicPatchManager": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {"cloud_accounts": {"type": "array", "items": {"type": "string"}}, "counter": {"type": "integer", "description": "Number of times the job has to retry for periodic job"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicPatchManager"}, "BackgroundJobPayloadForPeriodicPolicyRefresh": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicPolicyRefresh"}, "BackgroundJobPayloadForPeriodicProActiveScannerDetailsParser": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicProActiveScannerDetailsParser"}, "BackgroundJobPayloadForPeriodicProcessAlertTemplateStatusUpdate": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicProcessAlertTemplateStatusUpdate"}, "BackgroundJobPayloadForPeriodicProcessOrphanedConfigurationRecords": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicProcessOrphanedConfigurationRecords"}, "BackgroundJobPayloadForPeriodicProviderRecommendations": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicProviderRecommendations"}, "BackgroundJobPayloadForPeriodicRecommendationV2Processor": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicRecommendationV2Processor"}, "BackgroundJobPayloadForPeriodicRecoveryConfiguration": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicRecoveryConfiguration"}, "BackgroundJobPayloadForPeriodicRefreshUtilizationSummary": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicRefreshUtilizationSummary"}, "BackgroundJobPayloadForPeriodicReservedInstance": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicReservedInstance"}, "BackgroundJobPayloadForPeriodicResourceDiscovery": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicResourceDiscovery"}, "BackgroundJobPayloadForPeriodicSaasCostProcessing": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicSaasCostProcessing"}, "BackgroundJobPayloadForPeriodicSavingsPlans": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicSavingsPlans"}, "BackgroundJobPayloadForPeriodicScheduleRecommendation": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicScheduleRecommendation"}, "BackgroundJobPayloadForPeriodicSecureScoresConfiguration": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicSecureScoresConfiguration"}, "BackgroundJobPayloadForPeriodicServiceAccountDelete": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicServiceAccountDelete"}, "BackgroundJobPayloadForPeriodicServiceAccountMaintenance": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicServiceAccountMaintenance"}, "BackgroundJobPayloadForPeriodicServiceImpactAnalysis": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicServiceImpactAnalysis"}, "BackgroundJobPayloadForPeriodicServiceNowChangeStatusTracker": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicServiceNowChangeStatusTracker"}, "BackgroundJobPayloadForPeriodicServiceResourceBillingCategory": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicServiceResourceBillingCategory"}, "BackgroundJobPayloadForPeriodicSyncAccountSubscriptionAndMetadata": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicSyncAccountSubscriptionAndMetadata"}, "BackgroundJobPayloadForPeriodicSyncBudgets": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicSyncBudgets"}, "BackgroundJobPayloadForPeriodicSynchronizeNirmata": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicSynchronizeNirmata"}, "BackgroundJobPayloadForPeriodicTagDiscovery": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicTagDiscovery"}, "BackgroundJobPayloadForPeriodicTenableNessus": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicTenableNessus"}, "BackgroundJobPayloadForPeriodicThreatsVulnerabilityGraphDBSummarySync": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicThreatsVulnerabilityGraphDBSummarySync"}, "BackgroundJobPayloadForPeriodicUnitPriceRate": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicUnitPriceRate"}, "BackgroundJobPayloadForPeriodicUpdateCSPAuthDetails": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicUpdateCSPAuthDetails"}, "BackgroundJobPayloadForPeriodicUpdateSkippedAlertAndJobIdStatus": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicUpdateSkippedAlertAndJobIdStatus"}, "BackgroundJobPayloadForPeriodicUpdateUnitPriceForViolations": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicUpdateUnitPriceForViolations"}, "BackgroundJobPayloadForPeriodicValidateCredentials": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicValidateCredentials"}, "BackgroundJobPayloadForPeriodicVirtualMachinesAgents": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicVirtualMachinesAgents"}, "BackgroundJobPayloadForPeriodicVulnerabilitySourceUpdate": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicVulnerabilitySourceUpdate"}, "BackgroundJobPayloadForPeriodicWorkloadAssessmentCleanup": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicWorkloadAssessmentCleanup"}, "BackgroundJobPayloadForPeriodicWorkloadRecommendationSnapshotDaily": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicWorkloadRecommendationSnapshotDaily"}, "BackgroundJobPayloadForPeriodicWorkloadResourceSnapshotDaily": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicWorkloadResourceSnapshotDaily"}, "BackgroundJobPayloadForPeriodicWorkloadVulnerabilityThreatSummaryDaily": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicWorkloadVulnerabilityThreatSummaryDaily"}, "BackgroundJobPayloadForPeriodicWorkloadVulnerabilityThreatSummaryMonthly": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicWorkloadVulnerabilityThreatSummaryMonthly"}, "BackgroundJobPayloadForPeriodicZabbixGovernance": {"allOf": [{"$ref": "#/definitions/PeriodicBackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPeriodicZabbixGovernance"}, "BackgroundJobPayloadForPolicyExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"policy_job_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPolicyExecution"}, "BackgroundJobPayloadForPolicyJobStatusUpdate": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"policy_job_id": {"type": "string"}, "compliance_on_demand_job_id": {"type": "string"}, "violations_count": {"type": "integer"}, "status_reason": {"type": "string"}, "policy_details": {"type": "object", "additionalProperties": {"type": "string"}}, "compliance_status": {"type": "string"}, "service_account_id": {"type": "string"}, "evaluated_resources": {"type": "integer"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPolicyJobStatusUpdate"}, "BackgroundJobPayloadForPolicyOntologyMigration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPolicyOntologyMigration"}, "BackgroundJobPayloadForPolicyResourceRecommendationRemoval": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["inventory_ids"], "properties": {"inventory_ids": {"type": "array", "description": "Inventory IDs", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForPolicyResourceRecommendationRemoval"}, "BackgroundJobPayloadForProActiveScannerDetailsParserOnDemand": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID that needs to processed", "x-cs-type": "ObjectId"}, "repository_id": {"type": "string", "description": "Github Repository Id that needs to be be processed"}, "pull_request_number": {"type": "string", "description": "Github Pull Request Number that needs to be processed"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForProActiveScannerDetailsParserOnDemand"}, "BackgroundJobPayloadForProviderRecommendations": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "cloud_service": {"type": "string", "description": "Cloud service for which to execute ProviderRecommendation (use only cloud_service or integrated_tools, not both)", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "integrated_tool": {"type": "string", "description": "Integrated tool for which to execute ProviderRecommendation (use only cloud_service or integrated_tools, not both)", "example": "Anomaly_Detector", "enum": ["Anomaly_Detector", "AppDynamics", "App_Insights", "ArrowSphere", "Azure_Devops", "Azure_Security_Graph", "Azure_Sentinel", "Corestack", "DockerHub", "ElasticSearch", "Freshservice", "GitHub", "JIRA_DataCenter", "JIRA_ServiceDesk", "JIRA_ServiceManagement", "Jenkins", "Logstash", "Microsoft_Teams", "Nagios", "Newrelic", "Prometheus", "Qualys", "RedHat_Satellite", "ServiceNow", "TCL_ITSM", "Tenable_Nessus", "ZOHO_ServiceDesk", "Zabbix"], "x-cs-enum-type": "IntegratedToolName"}, "on_demand": {"type": "boolean", "description": "Indicates an \"on demand\" request when True"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForProviderRecommendations"}, "BackgroundJobPayloadForReactiveTask": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForReactiveTask"}, "BackgroundJobPayloadForRecoveryConfiguration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForRecoveryConfiguration"}, "BackgroundJobPayloadForRefreshRecommendation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["recommendation_id"], "properties": {"recommendation_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForRefreshRecommendation"}, "BackgroundJobPayloadForRemediationTemplateExecutor": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"user_id": {"type": "string", "description": "User ID", "x-cs-type": "ObjectId"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "req_body": {"type": "string", "description": "request body from the api"}, "recommendation_id": {"type": "string", "description": "Recommendation ID", "x-cs-type": "ObjectId"}, "action_resource_id": {"type": "string", "description": "Action Resource ID"}, "apply_resource_objects": {"type": "string", "description": "Recommendation Resource Objects"}, "recommendation_action_details": {"type": "string", "description": "Recommendation Action Details"}, "is_engine": {"type": "boolean", "description": "Key to check whether the request came from engine"}, "source": {"type": "string", "description": "Source"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForRemediationTemplateExecutor"}, "BackgroundJobPayloadForReportGeneration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"html": {"type": "string", "description": "HTML content of report"}, "report_options": {"$ref": "#/definitions/ReportGenerationOptions"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForReportGeneration"}, "BackgroundJobPayloadForReservedInstance": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "sync_recommendation": {"type": "boolean"}, "sync_utilization": {"type": "boolean"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForReservedInstance"}, "BackgroundJobPayloadForResourceActivityLogSync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string"}, "operation_id": {"type": "string"}, "resource_filter": {"type": "string"}, "meta_data": {"type": "object", "additionalProperties": {"type": "string"}}, "service_name": {"type": "string"}, "user_name": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceActivityLogSync"}, "BackgroundJobPayloadForResourceAlertConfiguration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"resource_audit_log_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceAlertConfiguration"}, "BackgroundJobPayloadForResourceDashboard": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID that needs to processed", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceDashboard"}, "BackgroundJobPayloadForResourceDependencyRelationship": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "x-cs-type": "ObjectId"}, "dependency type": {"type": "string", "example": "relationship", "enum": ["relationship", "dependency"], "x-cs-enum-type": "ResourceDependencyRelationshipType"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceDependencyRelationship"}, "BackgroundJobPayloadForResourceDiscovery": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID that needs to processed", "x-cs-type": "ObjectId"}, "action": {"type": "string", "description": "DiscoveryAction", "example": "create", "enum": ["create", "update", "delete"], "x-cs-enum-type": "ResourceDiscoveryActionType"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceDiscovery"}, "BackgroundJobPayloadForResourceDiscoveryExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "x-cs-type": "ObjectId"}, "is_compliance": {"type": "boolean"}, "on_create": {"type": "boolean"}, "event_name": {"type": "string"}, "event_resource": {"type": "string"}, "filter_request": {"type": "object", "additionalProperties": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceDiscoveryExecution"}, "BackgroundJobPayloadForResourceLockSync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID that needs to processed", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceLockSync"}, "BackgroundJobPayloadForResourceTagRemediation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceTagRemediation"}, "BackgroundJobPayloadForResourceToSbomMappingAutomatic": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourceToSbomMappingAutomatic"}, "BackgroundJobPayloadForResourcesDuplicationRemoval": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForResourcesDuplicationRemoval"}, "BackgroundJobPayloadForSaasCostProcessing": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target SaaS Account", "x-cs-type": "ObjectId"}, "backfill_start_date": {"type": "string", "format": "date-time"}, "backfill_end_date": {"type": "string", "format": "date-time"}, "progress": {"description": "Progress of the cost processing", "$ref": "#/definitions/CostProcessingProgress"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForSaasCostProcessing"}, "BackgroundJobPayloadForSbomParser": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["sbom_version_id"], "properties": {"sbom_version_id": {"type": "string", "description": "Unique ID of the SBOM version to be parsed", "x-cs-type": "ObjectId"}, "reparse": {"type": "boolean", "description": "Flag to indicate if this is a re-parsing operation", "default": false}, "data_store": {"type": "string", "description": "Data store to be parsed for the given SBOM version, reparse flag has to be set to true to reparse for the given data store. If no data store is provided, parsing will be done for all data stores.", "example": "mongo_db", "enum": ["mongo_db", "graph_db"], "x-cs-enum-type": "SbomParsingDataStore"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForSbomParser"}, "BackgroundJobPayloadForSbomToResourceMappingAutomatic": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForSbomToResourceMappingAutomatic"}, "BackgroundJobPayloadForScheduleRecommendation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account Id on which to generate schedule recommendations", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForScheduleRecommendation"}, "BackgroundJobPayloadForScheduledTask": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"schedule_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForScheduledTask"}, "BackgroundJobPayloadForScriptExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["execution_params", "handler_type", "job_id", "version"], "properties": {"job_id": {"type": "string"}, "version": {"type": "string"}, "handler_type": {"type": "string", "description": "Script Configuration Type", "example": "chef", "enum": ["chef", "puppet", "shell", "ansible", "git", "Workload", "app"], "x-cs-enum-type": "ScriptExecutionConfigType"}, "execution_params": {"type": "object", "description": "parameters to script"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForScriptExecution"}, "BackgroundJobPayloadForSecureScoresConfiguration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForSecureScoresConfiguration"}, "BackgroundJobPayloadForServiceAccountDelete": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string"}, "user_id": {"type": "string"}, "is_onboarded": {"type": "boolean"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForServiceAccountDelete"}, "BackgroundJobPayloadForServiceAccountFeaturePropagation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "feature": {"type": "string", "description": "Feature for the account", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}, "desired_status": {"type": "string", "description": "The desired status of the service account feature propagation", "example": "onboarding", "enum": ["onboarding", "onboarding_failed", "onboarded", "offboarding", "offboarding_failed"], "x-cs-enum-type": "ServiceAccountFeatureStatus"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForServiceAccountFeaturePropagation"}, "BackgroundJobPayloadForServiceAccountGovernancePropagation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "previous_settings": {"type": "array", "description": "Governance Configuration settings before changes", "items": {"$ref": "#/definitions/GovernanceConfigurationBase"}}, "settings": {"type": "array", "description": "Governance Configuration settings to apply", "items": {"$ref": "#/definitions/GovernanceConfigurationBase"}}, "target_settings": {"type": "array", "description": "Governance Configuration settings to apply", "items": {"$ref": "#/definitions/GovernanceConfigurationBase"}}, "periodic_check": {"type": "boolean", "description": "If set, the intent is to just check that the configuration against the Cloud/Tool provider is still valid"}, "validation_only": {"type": "boolean", "description": "If set, the intent is to just validate the configuration against the Cloud/Tool provider"}, "dispatcher": {"type": "boolean", "description": "If set, it distributes settings to services"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForServiceAccountGovernancePropagation"}, "BackgroundJobPayloadForServiceAccountSyncStatusPropagation": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "field": {"type": "string", "description": "The item to trigger"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForServiceAccountSyncStatusPropagation"}, "BackgroundJobPayloadForServiceImpactAnalysis": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID for which the service impact analysis is to be performed", "x-cs-type": "ObjectId"}, "cloud_provider": {"type": "string", "description": "Cloud provider for which service impact analysis is to be performed", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForServiceImpactAnalysis"}, "BackgroundJobPayloadForStacksMarketplaceStackDeploymentExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"state": {"type": "string", "description": "State of the background job", "example": "TriggerJob", "enum": ["TriggerJob", "StatusPolling"], "x-cs-enum-type": "BackgroundJobPayloadForStackDeploymentState"}, "deployment_history_id": {"type": "string", "description": "Stack Deployment History ID to be executed"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForStacksMarketplaceStackDeploymentExecution"}, "BackgroundJobPayloadForStacksMarketplaceStackVersionCostEstimateExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"request": {"description": "payload for computing cost estimation", "$ref": "#/definitions/StacksMarketplaceEstimateCostRequest"}, "stack_version_id": {"type": "string", "description": "Stack Version ID to be used for cost estimation"}, "breakdown": {"type": "array", "description": "Cost breakdown of all resources to be provisioned by the template.", "items": {"$ref": "#/definitions/StacksMarketplaceResourceCost"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForStacksMarketplaceStackVersionCostEstimateExecution"}, "BackgroundJobPayloadForSyncBudgets": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["account_event_type", "cloud_account_ids", "user_id"], "properties": {"cloud_account_ids": {"type": "array", "description": "List of cloud accounts", "items": {"type": "string"}}, "account_event_type": {"type": "string", "example": "create", "enum": ["create", "delete", "update"], "x-cs-enum-type": "SyncBudgetEventType"}, "user_id": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForSyncBudgets"}, "BackgroundJobPayloadForTagDiscovery": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["location_id", "resources", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account Id", "x-cs-type": "ObjectId"}, "location_id": {"type": "string", "description": "Location Id"}, "resources": {"type": "array", "items": {"$ref": "#/definitions/TagDiscoveryResourceMapping"}}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForTagDiscovery"}, "BackgroundJobPayloadForTagPosture": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"snapshot_id": {"type": "string"}, "progress": {"description": "Progress of the generation", "$ref": "#/definitions/TagPostureSnapshotProgress"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForTagPosture"}, "BackgroundJobPayloadForTagPostureSync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForTagPostureSync"}, "BackgroundJobPayloadForTemplateExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["execution_params", "job_id", "notification_email_id"], "properties": {"job_id": {"type": "string"}, "notification_email_id": {"type": "string"}, "execution_params": {"type": "object", "description": "parameters to template"}, "template_type": {"type": "string", "description": "Type of template engine/dsl", "example": "cfn", "enum": ["cfn", "arm", "terraform", "mistral", "heat", "oracle", "dm"], "x-cs-enum-type": "TemplateEngineType"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForTemplateExecution"}, "BackgroundJobPayloadForTerraformTemplateExecution": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["execution_params", "job_id", "notification_email_id"], "properties": {"job_id": {"type": "string"}, "notification_email_id": {"type": "string"}, "execution_params": {"type": "object", "description": "parameters to template"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForTerraformTemplateExecution"}, "BackgroundJobPayloadForThreatResourceActiveRefresh": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForThreatResourceActiveRefresh"}, "BackgroundJobPayloadForThreatVulnerabilityGraphDBSummarySync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_ids": {"type": "array", "description": "List of service account ID(s) to sync threats/ vulnerability to GraphDB.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "full_sync": {"type": "boolean", "description": "Whether to perform a full sync or incremental sync. Full sync will sync all the data whereas incremental sync will only sync the data that has been created/updated since the last sync time."}, "sync_threat_summary": {"type": "boolean", "description": "If set true, it sync threat summaries to graphDB"}, "sync_vulnerability_summary": {"type": "boolean", "description": "If set true, it sync vulnerability summaries to graphDB"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForThreatVulnerabilityGraphDBSummarySync"}, "BackgroundJobPayloadForUnitRateCrawler": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["configuration"], "properties": {"configuration": {"$ref": "#/definitions/UnitRateCrawlerConfiguration"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForUnitRateCrawler"}, "BackgroundJobPayloadForUpdateUnitRate": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target Cloud Account", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForUpdateUnitRate"}, "BackgroundJobPayloadForVirtualMachinesAgents": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID that needs to processed", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForVirtualMachinesAgents"}, "BackgroundJobPayloadForWorkFlowReconciller": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["tenant_id"], "properties": {"entity_type": {"type": "string", "description": "SubCategory for which the workflow which has to be generated.", "example": "recommendation", "enum": ["recommendation", "cost_anomaly"], "x-cs-enum-type": "WorkFlowCategory"}, "tenant_id": {"type": "string", "description": "Tenant id"}, "scope": {"$ref": "#/definitions/WorkFlowReconcillationScopes"}, "mode": {"type": "string", "description": "Mode for the workflow reconciliation.", "example": "Reconcile", "enum": ["Reconcile", "ReconcileOnUpdate", "Trigger"], "x-cs-enum-type": "WorkFlowReconcileMode"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForWorkFlowReconciller"}, "BackgroundJobPayloadForWorkloadOntologyMigration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForWorkloadOntologyMigration"}, "BackgroundJobPayloadForWorkloadResourceSnapshot": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForWorkloadResourceSnapshot"}, "BackgroundJobPayloadForWorkloadResourceSync": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForWorkloadResourceSync"}, "BackgroundJobPayloadForWorkloadTtlGeneration": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"required": ["workload_id"], "properties": {"workload_id": {"type": "string", "description": "Workload ID for ontology generation"}, "event_type": {"type": "string", "description": "Type of event for ontology generation"}}, "type": "object"}], "x-cs-type-name": "BackgroundJobPayloadForWorkloadTtlGeneration"}, "BackgroundJobQueryCounter": {"properties": {"identifier": {"type": "string", "description": "Counter identifier"}, "action": {"type": "string", "description": "Operation"}, "parametrized_query": {"type": "object", "description": "Summarized query"}, "query_planner": {"type": "object", "description": "Query Plan"}, "hits": {"type": "integer", "description": "Total number of calls"}, "execution_time": {"type": "number", "description": "Total execution time in seconds"}}, "type": "object"}, "BackgroundJobQueryCounterPerCaller": {"properties": {"frames": {"type": "array", "description": "Stack frames for the thread", "items": {"$ref": "#/definitions/BackgroundJobThreadFrame"}}, "hits": {"type": "integer", "description": "Total number of calls"}, "execution_time": {"type": "number", "description": "Total execution time in seconds"}}, "type": "object"}, "BackgroundJobQueryCounters": {"properties": {"entries": {"type": "array", "description": "Frequency by action and filter", "items": {"$ref": "#/definitions/BackgroundJobQueryCounter"}}}, "type": "object"}, "BackgroundJobQueueRequest": {"properties": {"executor": {"type": "string", "description": "Target Executor for the job", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "payload": {"description": "Data associated with the Background Job", "$ref": "#/definitions/BackgroundJobPayloadBase"}, "priority": {"type": "integer", "description": "Priority of the Background Job"}, "next_activation": {"type": "string", "format": "date-time", "description": "When the Background Job will execute"}, "synchronize_federation": {"type": "boolean", "description": "Ensure all the federation updates are sent"}, "check_for_queued_job": {"type": "boolean", "description": "Only queue if no other job is already queued. Queue if other job is already running"}, "check_for_running_job": {"type": "boolean", "description": "Only queue if no matching job is found"}, "queue_after_running_job": {"type": "boolean", "description": "Queue to run after any matching job"}, "auto_retries": {"type": "integer", "description": "Number of auto retries left for this Background Job"}, "auto_retry_delay": {"type": "number", "description": "Number of seconds to wait before a retry for this Background Job"}, "waiting_on": {"type": "array", "description": "Background Jobs this job is dependent for", "items": {"$ref": "#/definitions/RecordIdentity"}}}, "type": "object"}, "BackgroundJobQueueResponse": {"properties": {"created": {"description": "Background Job that got created", "$ref": "#/definitions/RecordIdentity"}, "existing": {"description": "Background Job that matched identifier", "$ref": "#/definitions/RecordIdentity"}}, "type": "object"}, "BackgroundJobSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CreatedAt", "enum": ["CreatedAt", "NextActivation", "PayloadClass"], "x-cs-enum-type": "BackgroundJobSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "BackgroundJobStatistics": {"properties": {"executing_jobs": {"type": "integer", "description": "Number of jobs currently executing"}, "processed_jobs": {"type": "integer", "description": "Number of jobs processed"}, "restarted_jobs": {"type": "integer", "description": "Number of jobs restarted"}, "failed_jobs": {"type": "integer", "description": "Number of jobs that failed"}, "invalidations": {"type": "object", "description": "Map from context to number of invalidations", "additionalProperties": {"type": "integer"}}, "query_counters": {"type": "object", "description": "Map from context to counter details", "additionalProperties": {"$ref": "#/definitions/BackgroundJobQueryCounters"}}, "query_counters_per_caller": {"type": "array", "description": "Query counters by callers for selected context", "items": {"$ref": "#/definitions/BackgroundJobQueryCounterPerCaller"}}, "heap_analysis_pending": {"type": "boolean", "description": "If true, heap processing is ongoing"}, "heap_analysis": {"type": "array", "description": "Historical heap analysis", "items": {"$ref": "#/definitions/BackgroundJobHeapAnalysis"}}}, "type": "object"}, "BackgroundJobStatisticsRequest": {"properties": {"executor": {"type": "string", "description": "Filter to threads in this executor", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "include_invalidations": {"type": "boolean", "description": "If true, invalidation counters will be returned"}, "include_query_counters": {"type": "boolean", "description": "If true, query counters will be returned"}, "include_query_counters_per_caller": {"type": "string", "description": "If set, query counters per caller will be returned for the selected context"}, "trigger_heap_analysis": {"type": "boolean", "description": "If true, a new heap analysis is started"}, "include_heap_analysis": {"type": "boolean", "description": "If true, the historical heap analysis will be returned"}}, "type": "object"}, "BackgroundJobStatisticsResponse": {"properties": {"workers": {"type": "object", "description": "Map from identifier to service statistics model", "additionalProperties": {"$ref": "#/definitions/BackgroundJobStatistics"}}}, "type": "object"}, "BackgroundJobThread": {"properties": {"executor": {"type": "string", "description": "Executor of the Background Job", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "process_id": {"type": "integer", "description": "ID of the process"}, "process_name": {"type": "string", "description": "Name of the process"}, "thread_id": {"type": "integer", "description": "ID of the thread"}, "thread_name": {"type": "string", "description": "Name of the thread"}, "frames": {"type": "array", "description": "Stack frames for the thread", "items": {"$ref": "#/definitions/BackgroundJobThreadFrame"}}}, "type": "object"}, "BackgroundJobThreadFrame": {"properties": {"filename": {"type": "string", "description": "Name of the file for the function"}, "lineno": {"type": "integer", "description": "Number line for the function"}, "name": {"type": "string", "description": "Name of the function"}, "line": {"type": "string", "description": "Text of the line"}}, "type": "object"}, "BackgroundJobThreadRequest": {"properties": {"executor": {"type": "string", "description": "Filter to threads in this executor", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}}, "type": "object"}, "BackgroundJobUpdateActivationRequest": {"properties": {"job": {"description": "Background Job to update", "$ref": "#/definitions/RecordIdentity"}, "next_activation": {"type": "string", "format": "date-time", "description": "When the Background Job will execute"}}, "type": "object"}, "BackgroundJobUpdatePriorityRequest": {"properties": {"job": {"description": "Background Job to update", "$ref": "#/definitions/RecordIdentity"}, "priority": {"type": "integer", "description": "New priority of the Background Job"}}, "type": "object"}, "BackupReportResponse": {"properties": {"status": {"type": "string", "description": "status response"}, "message": {"type": "string", "description": "message response"}, "data": {"type": "object", "description": "Backup data"}}, "type": "object"}, "BaseChartWidgetConfigurationModel": {"allOf": [{"$ref": "#/definitions/BaseDataWidgetConfigurationModel"}, {"properties": {"chartType": {"type": "string", "description": "Chart type to display data", "example": "Bar", "enum": ["Bar", "Column", "GroupedColumn", "StackedColumn", "Pie", "Donut", "TreeMap", "Line", "Flow", "Map", "Network", "Sunburst", "Datatable", "Sankey", "HeatMap", "Hierarchy", "Bubble", "Area", "Waterfall"], "x-cs-enum-type": "ChartType"}, "chartLimit": {"type": "string", "description": "Limit the amount of data to display", "example": "None", "enum": ["None", "Top5", "Top5PlusOther", "Top10", "Top10PlusOther", "Bottom5", "Bottom5PlusOther"], "x-cs-enum-type": "ChartLimit"}, "legendDisplayConfiguration": {"$ref": "#/definitions/LegendDisplayConfiguration"}}, "type": "object"}], "x-cs-type-name": "BaseChartWidgetConfigurationModel"}, "BaseCostProcessingMemory": {"required": ["__type"], "properties": {"schema": {"type": "integer", "description": "Schema version"}, "skipped_tags": {"type": "array", "description": "List of skipped tag keys", "items": {"type": "string"}}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "CostProcessingMemoryForAws", "subtype_name": "CostProcessingMemoryForAws"}, {"subtype_model": "CostProcessingMemoryForAzure", "subtype_name": "CostProcessingMemoryForAzure"}, {"subtype_model": "CostProcessingMemoryForAzureCsp", "subtype_name": "CostProcessingMemoryForAzureCsp"}, {"subtype_model": "CostProcessingMemoryForAzureEa", "subtype_name": "CostProcessingMemoryForAzureEa"}, {"subtype_model": "CostProcessingMemoryForAzureMca", "subtype_name": "CostProcessingMemoryForAzureMca"}, {"subtype_model": "CostProcessingMemoryForGcp", "subtype_name": "CostProcessingMemoryForGcp"}, {"subtype_model": "CostProcessingMemoryForOci", "subtype_name": "CostProcessingMemoryForOci"}, {"subtype_model": "CostProcessingMemoryForKubernetesAgent", "subtype_name": "CostProcessingMemoryForKubernetesAgent"}, {"subtype_model": "CostProcessingMemoryForSaas", "subtype_name": "CostProcessingMemoryForSaas"}]}, "BaseCostProcessingPeriodMemory": {"allOf": [{"$ref": "#/definitions/BillingPeriodInformation"}, {"properties": {"processed_line_items": {"type": "integer", "description": "Number of processed line items"}, "last_refreshed_at": {"type": "string", "format": "date-time", "description": "The date of last refresh of billing period"}}, "type": "object"}]}, "BaseCostTrendWidgetConfigurationModel": {"allOf": [{"$ref": "#/definitions/BaseGroupByDataWidgetConfigurationModel"}, {"properties": {"showVarianceColumn": {"type": "boolean"}}, "type": "object"}], "x-cs-type-name": "BaseCostTrendWidgetConfigurationModel"}, "BaseDataWidgetConfigurationModel": {"allOf": [{"$ref": "#/definitions/WidgetConfiguration"}, {"properties": {"contextSelector": {"type": "string"}, "context": {"$ref": "#/definitions/DataContext"}, "navigationDescriptors": {"type": "array", "items": {"$ref": "#/definitions/WidgetNavigationDescriptor"}}, "hideWidgetFiltering": {"type": "boolean", "description": "When true in-widget filters will not be displayed."}}, "type": "object"}], "x-cs-type-name": "BaseDataWidgetConfigurationModel"}, "BaseDefinition": {"properties": {"sysId": {"type": "string", "description": "Identifier of the definition"}, "createdOn": {"type": "string", "format": "date-time", "description": "Definition created on"}, "updatedOn": {"type": "string", "format": "date-time", "description": "Definition updated on"}, "headVersion": {"description": "Reference to the editable version of the definition", "$ref": "#/definitions/RecordIdentity"}, "releaseVersion": {"description": "Reference to the release version of the definition", "$ref": "#/definitions/RecordIdentity"}}, "type": "object"}, "BaseDefinitionVersion": {"properties": {"sysId": {"type": "string", "description": "Identifier of the version"}, "createdOn": {"type": "string", "format": "date-time", "description": "Version created on"}, "updatedOn": {"type": "string", "format": "date-time", "description": "Version  updated on"}, "version": {"type": "integer", "default": "Sequence number of the version"}, "definition": {"description": "Reference to the definition", "$ref": "#/definitions/RecordIdentity"}, "predecessor": {"description": "Reference to the previous version", "$ref": "#/definitions/RecordIdentity"}}, "type": "object"}, "BaseDimensionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseGroupByDataWidgetConfigurationModel"}, {"properties": {"dimensionDetails": {"$ref": "#/definitions/BillingGroupByDetails"}, "dimension_by_account_type": {"description": "Account Type as Dimension to filter child accounts", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, "dimension_tag_keys": {"type": "boolean", "description": "Dimension is based on Resource Tag keys"}, "dimension_tag_status": {"type": "boolean", "description": "Dimension is based on Resource Tag status"}, "dimension_workload_type": {"type": "boolean", "description": "Dimension is based on workload type"}}, "type": "object"}], "x-cs-type-name": "BaseDimensionWidgetConfiguration"}, "BaseForAgentResponse": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ResponseForAgentText", "subtype_name": "Text"}, {"subtype_model": "ResponseForAgentTable", "subtype_name": "Table"}, {"subtype_model": "ResponseForAgentLimitation", "subtype_name": "Limitation"}, {"subtype_model": "ResponseForAgentChart", "subtype_name": "Chart"}, {"subtype_model": "ResponseForAgentActionForm", "subtype_name": "ActionForm"}]}, "BaseGroupByDataWidgetConfigurationModel": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {"group_by_details": {"$ref": "#/definitions/BillingGroupByDetails"}, "group_by_account_type": {"description": "Type of Cloud Provider Account Type this applies to", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, "group_by_tag_status": {"type": "boolean", "description": "If set, group by is based on tag status"}, "group_by_tag_keys": {"type": "boolean", "description": "Group by is based on Resource Tag keys"}, "group_by_workload_type": {"type": "boolean", "description": "If set, group by is based on workload type"}}, "type": "object"}], "x-cs-type-name": "BaseGroupByDataWidgetConfigurationModel"}, "BaseProducerDataWidgetConfigurationModel": {"allOf": [{"$ref": "#/definitions/BaseDataWidgetConfigurationModel"}, {"properties": {"contextId": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "BaseProducerDataWidgetConfigurationModel"}, "BaseReportConfigurationForAssessmentAgent": {"allOf": [{"$ref": "#/definitions/ReportConfigurationForAiAgent"}, {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Id of the Tenant.", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "BaseReportConfigurationForAssessmentAgent"}, "BatchRequest": {"properties": {"ids": {"type": "array", "description": "Identifiers to fetch", "items": {"type": "string"}}}, "type": "object"}, "BenefitDetails": {"required": ["__type", "commitment_discount_id", "source_service_account_id"], "properties": {"source_service_account_id": {"type": "string", "description": "Source Service account ID of the benefit purchaser.", "x-cs-type": "ObjectId"}, "commitment_discount_id": {"type": "string", "description": "Commitment discount ID of the savings plan or reservation."}}, "discriminator": "__type", "type": "object"}, "BillingAggregationBase": {"required": ["end_date", "start_date"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "filters": {"description": "Query expression to filter line items", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "start of the spend period"}, "end_date": {"type": "string", "format": "date-time", "description": "end of the spend period"}, "time_zone": {"type": "string", "description": "Optional timezone of the caller"}, "platform": {"type": "string", "description": "Platforms", "example": "kubernetes", "enum": ["kubernetes"], "x-cs-enum-type": "Platforms"}, "skip_service_account_grouping": {"type": "boolean", "description": "If set, do not group by service account"}}, "type": "object"}, "BillingAggregationRequest": {"allOf": [{"$ref": "#/definitions/BillingAggregationBase"}, {"required": ["billing_source"], "properties": {"billing_source": {"type": "string", "description": "Billing plan to select data from"}, "group_by": {"type": "array", "description": "If set, the dimensions to group results by", "items": {"$ref": "#/definitions/BillingGroupByDetails"}}, "limit": {"type": "integer", "description": "If set, limits the results to given number."}, "billing_mode": {"type": "boolean", "description": "If set, results for cost data gets computed based on billing period start dates that falls in the range of the start date and end date."}, "include_resource_children": {"type": "boolean", "description": "If set, intercept the query operators to manipulate platform specific accounts. This is only applicable for ServiceAccountQueryOperator manipulation when the visitor is platform and call made through billing plans."}}, "type": "object"}]}, "BillingAggregationRequestBatch": {"properties": {"requests": {"type": "array", "description": "Batch of aggregation requests", "items": {"$ref": "#/definitions/BillingAggregationRequest"}}}, "type": "object"}, "BillingAggregationResponseBatch": {"properties": {"results": {"type": "array", "description": "Batch of aggregation requests", "items": {"type": "array", "items": {"$ref": "#/definitions/BillingAggregationResult"}}}}, "type": "object"}, "BillingAggregationResult": {"properties": {"identity": {"description": "Identity of the result group", "$ref": "#/definitions/BillingLineItemIdentityPlus"}, "value": {"type": "number", "description": "Result of aggregation"}}, "type": "object"}, "BillingAggregationTrendRequest": {"allOf": [{"$ref": "#/definitions/BillingAggregationRequest"}, {"required": ["granularity"], "properties": {"granularity": {"type": "integer", "description": "Number of seconds between steps"}, "compute_forecast": {"type": "boolean", "description": "If set, results for future dates will be computed based on a forecast."}}, "type": "object"}]}, "BillingAggregationTrendResult": {"properties": {"identity": {"description": "Identity of the result group", "$ref": "#/definitions/BillingLineItemIdentityPlus"}, "timestamps": {"type": "array", "items": {"type": "string", "format": "date-time", "description": "Time of results"}}, "values": {"type": "array", "items": {"type": "number", "description": "Results of aggregation"}}}, "type": "object"}, "BillingCommitmentBase": {"properties": {"remaining_commitment_amount": {"type": "number", "description": "Remaining Billing Commitment Amount"}, "currency": {"type": "string", "description": "Billing Currency", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "BillingCommitmentBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/BillingCommitmentDetail"}}}, "type": "object"}, "BillingCommitmentDefinition": {"allOf": [{"$ref": "#/definitions/BillingCommitmentBase"}, {"properties": {"name": {"type": "string", "description": "Billing Commitment Name"}, "status": {"type": "string", "description": "Billing Commitment Status", "example": "active", "enum": ["active", "canceled", "completed", "expired"], "x-cs-enum-type": "BillingCommitmentStatus"}, "commitment_amount": {"type": "number", "description": "Billing Commitment Amount"}, "purchased_date": {"type": "string", "format": "date-time", "description": "Purchased Date of Billing commitment"}, "start_date": {"type": "string", "format": "date-time", "description": "Start Date of Billing commitment"}, "expiry_date": {"type": "string", "format": "date-time", "description": "Expiry Date of Billing commitment"}}, "type": "object"}]}, "BillingCommitmentDetail": {"properties": {"billing_commitments": {"type": "array", "items": {"$ref": "#/definitions/BillingCommitmentDefinition"}}}, "type": "object"}, "BillingCommitmentEvent": {"allOf": [{"$ref": "#/definitions/BillingCommitmentBase"}, {"properties": {"billing_account_name": {"type": "string", "description": "Billing Account Name"}, "billing_profile_name": {"type": "string", "description": "Billing Profile Name"}, "description": {"type": "string", "description": "Billing Commitment Description"}, "charges": {"type": "number", "description": "Billing Charges"}, "transaction_date": {"type": "string", "format": "date-time", "description": "Event Transaction Date"}}, "type": "object"}]}, "BillingCommitmentEventsRequest": {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account IDs", "x-cs-type": "ObjectId"}, "start_date": {"type": "string", "format": "date", "description": "Start Date of Billing commitment"}, "end_date": {"type": "string", "format": "date", "description": "End Date of Billing commitment"}}, "type": "object"}, "BillingCommitmentRequest": {"required": ["service_account_ids"], "properties": {"service_account_ids": {"type": "array", "items": {"type": "string", "description": "List of Service account ids", "x-cs-type": "ObjectId"}}}, "type": "object"}, "BillingCostAndUsageAggregationRequest": {"allOf": [{"$ref": "#/definitions/BillingAggregationBase"}, {"required": ["billing_source", "granularity", "group_by"], "properties": {"granularity": {"type": "integer", "description": "Number of seconds between steps"}, "billing_source": {"type": "string", "description": "Billing plan to select data from"}, "group_by": {"type": "array", "description": "If set, the dimensions to group results by", "items": {"$ref": "#/definitions/BillingGroupByDetails"}}, "include_charge_description": {"type": "boolean", "description": "If set, the descriptions of line items will be included in the results."}, "limit": {"type": "integer", "description": "If set, limits the results to given number."}}, "type": "object"}]}, "BillingCostAndUsageAggregationTrendResult": {"allOf": [{"$ref": "#/definitions/BillingAggregationTrendResult"}, {"properties": {"rates": {"type": "array", "items": {"type": "number", "description": "Rate Results of aggregation"}}, "usages": {"type": "array", "items": {"type": "number", "description": "Usage Results of aggregation"}}, "descriptions": {"type": "array", "items": {"type": "string", "description": "Descriptions of line items"}}}, "type": "object"}]}, "BillingCustomGroup": {"properties": {"attribute_value": {"type": "string", "description": "Value for the group"}, "attribute_key": {"type": "string", "description": "Key for the group"}, "filter": {"description": "Filter for the custom group", "$ref": "#/definitions/QueryOperator"}, "grouping_rule_id": {"type": "string", "description": "Grouping Rule ID"}, "dimension_id": {"type": "string", "description": "Dimension ID"}}, "type": "object"}, "BillingDescriptionsTrendResult": {"allOf": [{"$ref": "#/definitions/BillingAggregationTrendResult"}, {"properties": {"descriptions": {"type": "array", "items": {"type": "string", "description": "Descriptions of line items"}}}, "type": "object"}]}, "BillingDetailsRequestModelProductCategory": {"properties": {"date_filter": {"type": "string", "description": "Date Filter to select", "example": "current_month", "enum": ["current_month", "current_month_minus_1", "current_month_minus_2", "current_month_minus_3", "current_month_minus_4", "current_month_minus_5", "current_month_minus_6", "current_month_minus_7", "current_month_minus_8", "current_month_minus_9", "current_month_minus_10", "current_month_minus_11", "current_month_minus_12"], "x-cs-enum-type": "DashboardDateFilter"}}, "type": "object"}, "BillingEntityQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["billing_entities"], "properties": {"billing_entities": {"type": "array", "description": "Billing entities to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BillingEntityQueryOperator"}, "BillingEntityRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["billing_entity"], "properties": {"billing_entity": {"description": "Include response that has the given billing_entity pattern", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "BillingEntityRegexQueryOperator"}, "BillingExtraKeysRequest": {"allOf": [{"$ref": "#/definitions/BillingSummaryBase"}, {"properties": {"extra_keys": {"type": "array", "description": "If set, the subset of keys to return", "items": {"type": "string"}}, "include_values": {"type": "boolean", "description": "If set, include values, not just keys"}}, "type": "object"}]}, "BillingGroupByDetails": {"required": ["selector"], "properties": {"selector": {"type": "string", "description": "Dimension to group results by", "example": "service_account_tags", "enum": ["service_account_tags", "service_name", "tenant_id", "tenant_tags", "service_account_id", "delegate_service_account_id", "availability_zone", "billing_entity", "line_item_type", "location", "meter_sub_category", "pricing_category", "pricing_purchase_option", "product_category", "product_family", "product_service_code", "product_sku", "publisher", "resource_category", "resource_group", "resource_id", "resource_name", "resource_operation", "extras", "tags", "hierarchy", "dimension", "compartment_name", "compartment_id", "resource_type", "utilization_type"], "x-cs-enum-type": "BillingGroupBySelector"}, "key": {"type": "string", "description": "Key to use with Extras, Tags, Hierarchy, and Dimension"}, "value": {"type": "string", "description": "Value to use with Extras, Tags and Hierarchy"}, "kind": {"type": "string", "description": "Value to use in Tags"}, "groups": {"type": "array", "description": "List of custom groups to use with Dimension", "items": {"$ref": "#/definitions/BillingCustomGroup"}}}, "type": "object"}, "BillingIdentitiesRequest": {"required": ["end_date", "start_date"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "filters": {"description": "Query expression to filter line items", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "start of the spend period"}, "end_date": {"type": "string", "format": "date-time", "description": "end of the spend period"}}, "type": "object"}, "BillingIdentitiesResult": {"properties": {"identity": {"description": "Identity of the line item group, including tags", "$ref": "#/definitions/BillingLineItemIdentityPlus"}}, "type": "object"}, "BillingInformationBase": {"required": ["type"], "properties": {}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "BillingInformationDetailForAws", "subtype_name": "BillingInformationDetailForAws"}, {"subtype_model": "BillingInformationDetailForAzureCsp", "subtype_name": "BillingInformationDetailForAzureCsp"}, {"subtype_model": "BillingInformationDetailForAzureEa", "subtype_name": "BillingInformationDetailForAzureEa"}, {"subtype_model": "BillingInformationDetailForAzureMca", "subtype_name": "BillingInformationDetailForAzureMca"}, {"subtype_model": "BillingInformationDetailForAzureSubscription", "subtype_name": "BillingInformationDetailForAzureSubscription"}, {"subtype_model": "BillingInformationDetailForSaas", "subtype_name": "BillingInformationDetailForSaas"}]}, "BillingInformationBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/BillingInformationBase"}}}, "type": "object"}, "BillingInformationDetailForAws": {"allOf": [{"$ref": "#/definitions/BillingInformationBase"}, {"properties": {"billing_periods": {"type": "array", "description": "Details for the billing period.", "items": {"$ref": "#/definitions/BillingInformationForAws"}}}, "type": "object"}], "x-cs-type-name": "BillingInformationDetailForAws"}, "BillingInformationDetailForAzureCsp": {"allOf": [{"$ref": "#/definitions/BillingInformationBase"}, {"properties": {"billing_periods": {"type": "array", "description": "Details for the billing period.", "items": {"$ref": "#/definitions/BillingInformationForAzureCsp"}}}, "type": "object"}], "x-cs-type-name": "BillingInformationDetailForAzureCsp"}, "BillingInformationDetailForAzureEa": {"allOf": [{"$ref": "#/definitions/BillingInformationBase"}, {"properties": {"billing_periods": {"type": "array", "description": "Details for the billing period.", "items": {"$ref": "#/definitions/BillingInformationForAzureEa"}}}, "type": "object"}], "x-cs-type-name": "BillingInformationDetailForAzureEa"}, "BillingInformationDetailForAzureMca": {"allOf": [{"$ref": "#/definitions/BillingInformationBase"}, {"properties": {"billing_periods": {"type": "array", "description": "Details for the billing period.", "items": {"$ref": "#/definitions/BillingInformationForAzureMca"}}}, "type": "object"}], "x-cs-type-name": "BillingInformationDetailForAzureMca"}, "BillingInformationDetailForAzureSubscription": {"allOf": [{"$ref": "#/definitions/BillingInformationBase"}, {"properties": {"billing_periods": {"type": "array", "description": "Details for the billing period.", "items": {"$ref": "#/definitions/BillingInformationForAzureSubscription"}}}, "type": "object"}], "x-cs-type-name": "BillingInformationDetailForAzureSubscription"}, "BillingInformationDetailForSaas": {"allOf": [{"$ref": "#/definitions/BillingInformationBase"}, {"properties": {"billing_periods": {"type": "array", "description": "Details for the billing period.", "items": {"$ref": "#/definitions/BillingInformationForSaas"}}}, "type": "object"}], "x-cs-type-name": "BillingInformationDetailForSaas"}, "BillingInformationForAws": {"allOf": [{"$ref": "#/definitions/BillingPeriodInformation"}, {"properties": {}, "type": "object"}]}, "BillingInformationForAzureCsp": {"allOf": [{"$ref": "#/definitions/BillingPeriodInformation"}, {"properties": {}, "type": "object"}]}, "BillingInformationForAzureEa": {"allOf": [{"$ref": "#/definitions/BillingPeriodInformation"}, {"properties": {}, "type": "object"}]}, "BillingInformationForAzureMca": {"allOf": [{"$ref": "#/definitions/BillingPeriodInformation"}, {"properties": {}, "type": "object"}]}, "BillingInformationForAzureSubscription": {"allOf": [{"$ref": "#/definitions/BillingPeriodInformation"}, {"properties": {}, "type": "object"}]}, "BillingInformationForSaas": {"allOf": [{"$ref": "#/definitions/BillingPeriodInformation"}, {"properties": {}, "type": "object"}]}, "BillingInformationRequest": {"properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "start_date": {"type": "string", "format": "date-time", "description": "start of the spend period"}, "end_date": {"type": "string", "format": "date-time", "description": "end of the spend period"}}, "type": "object"}, "BillingLineItemIdentity": {"properties": {"service_account_id": {"type": "string", "description": "Service Account the line item belongs to", "x-cs-type": "ObjectId"}, "delegate_service_account_id": {"type": "string", "description": "Service Account internally responsible for creating, updating, or deleting the line item", "x-cs-type": "ObjectId"}, "line_item_type": {"type": "string", "description": "Line item type"}, "availability_zone": {"type": "string", "description": "Availability Zone"}, "billing_entity": {"type": "string", "description": "Billing Entity"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "location": {"type": "string", "description": "Line item location"}, "meter_sub_category": {"type": "string", "description": "Meter Sub Category"}, "pricing_category": {"type": "string", "description": "Pricing Category"}, "pricing_purchase_option": {"type": "string", "description": "Pricing Purchase Option"}, "product_category": {"type": "string", "description": "Product category"}, "product_family": {"type": "string", "description": "Product family"}, "product_service_code": {"type": "string", "description": "Product service code"}, "product_sku": {"type": "string", "description": "Product SKU"}, "publisher": {"type": "string", "description": "Publisher"}, "resource_category": {"type": "string", "description": "Resource category"}, "resource_group": {"type": "string", "description": "Resource group"}, "resource_id": {"type": "string", "description": "Resource ID"}, "resource_name": {"type": "string", "description": "Resource name"}, "resource_operation": {"type": "string", "description": "Resource operation"}, "resource_type": {"type": "string", "description": "Resource type"}, "utilization_type": {"type": "string", "description": "Utilization type"}, "extras": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "hierarchy": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "custom": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "dimension_memberships": {"type": "array", "description": "List of Dimension Membership Key-Value Pairs", "items": {"$ref": "#/definitions/DimensionMembershipKeyValuePair"}}, "compartment_id": {"type": "string", "description": "Compartment ID"}, "compartment_name": {"type": "string", "description": "Compartment Name"}}, "type": "object"}, "BillingLineItemIdentityPlus": {"allOf": [{"$ref": "#/definitions/BillingLineItemIdentity"}, {"properties": {"service_name": {"type": "string", "description": "Service name"}, "tenant_id": {"type": "string", "description": "Tenant ID"}}, "type": "object"}]}, "BillingLineItemSummaryRequest": {"allOf": [{"$ref": "#/definitions/BillingSummaryBase"}, {"required": ["key"], "properties": {"key": {"description": "Field to return results for", "$ref": "#/definitions/BillingGroupByDetails"}}, "type": "object"}]}, "BillingLineItemTypeQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["line_item_types"], "properties": {"line_item_types": {"type": "array", "description": "Line Item types to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BillingLineItemTypeQueryOperator"}, "BillingLineItemTypeRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["line_item_type"], "properties": {"line_item_type": {"description": "Include response that has the given line_item_type", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "BillingLineItemTypeRegexQueryOperator"}, "BillingMetricAccess": {"allOf": [{"$ref": "#/definitions/BillingMetricAccessBase"}, {"required": ["denied_identities"], "properties": {"sys_id": {"type": "string", "description": "The Sys ID of the access assignment"}, "denied_identities": {"$ref": "#/definitions/DeniedRolesAndUserGroups"}}, "type": "object"}]}, "BillingMetricAccessAssignment": {"properties": {"master_account_id": {"type": "string", "description": "Master account ID", "x-cs-type": "ObjectId"}, "details": {"type": "array", "description": "Metric wise RBAC assignment details", "items": {"$ref": "#/definitions/BillingMetricAccess"}}}, "type": "object"}, "BillingMetricAccessBase": {"properties": {"metric_sys_id": {"type": "string", "description": "The Sys ID of the metric"}, "native_detail_type": {"description": "Cloud account native details type", "$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}}, "type": "object"}, "BillingMetricAccessFilters": {"properties": {"metric_sys_id": {"type": "string", "description": "The Sys ID of the metric"}, "native_detail_type": {"description": "Cloud account native details type", "$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}}, "type": "object"}, "BillingMetricAccessListRequest": {"allOf": [{"$ref": "#/definitions/BillingMetricAccessBase"}, {"properties": {"filters": {"description": "Filters for the Billing Metrics", "$ref": "#/definitions/BillingMetricAccessFilters"}}, "type": "object"}]}, "BillingMetricFilters": {"properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs to filter", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "descendant_service_account_query": {"description": "Descendant service account query filter", "$ref": "#/definitions/DescendantServiceAccountQuery"}}, "type": "object"}, "BillingMetricListRequest": {"properties": {"filters": {"description": "Filters for the Billing Metrics", "$ref": "#/definitions/BillingMetricFilters"}}, "type": "object"}, "BillingMetricSourceOverride": {"properties": {"native_details": {"type": "array", "items": {"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}}, "source_metric_id": {"type": "string", "description": "ID of the metric to override"}}, "type": "object"}, "BillingMetrics": {"required": ["billing_metric_type", "name"], "properties": {"sys_id": {"type": "string", "description": "The Sys ID of the metric"}, "source_sys_id": {"type": "string", "description": "Specifies the source metrics. Only system metrics can have an empty source and cannot be removed."}, "created_on": {"type": "string", "format": "date-time", "description": "Created on"}, "created_by": {"type": "string", "description": "Username who created the Billing Metrics."}, "updated_on": {"type": "string", "format": "date-time", "description": "Updated on"}, "updated_by": {"type": "string", "description": "Username who updated the Billing Metrics."}, "name": {"type": "string", "description": "Name of the billing metrics"}, "billing_metric_type": {"type": "string", "description": "Types of Billing Metric.", "example": "margin_savings", "enum": ["margin_savings", "native_cost", "rate", "system_cost", "true_cost", "usage"], "x-cs-enum-type": "BillingMetricType"}, "category": {"type": "string", "description": "Categories of Billing Metric.", "example": "Customer", "enum": ["Customer", "Dimension", "Distributor", "Partner"], "x-cs-enum-type": "BillingMetricCategory"}}, "type": "object"}, "BillingPeriodInformation": {"properties": {"billing_period_start": {"type": "string", "format": "date-time", "description": "The start date of the billing period"}, "billing_period_end": {"type": "string", "format": "date-time", "description": "The end date of the billing period"}, "invoice_ids": {"type": "array", "description": "Invoices for the period", "items": {"type": "string"}}}, "type": "object"}, "BillingPlanConfiguration": {"required": ["rules"], "properties": {"rules": {"type": "array", "description": "Root rule of the billing plan. This rule is used to evaluate the billing plan.", "items": {"$ref": "#/definitions/BillingRuleRoot"}}}, "type": "object"}, "BillingPlanDefinition": {"allOf": [{"$ref": "#/definitions/BaseDefinition"}, {"properties": {"owner": {"type": "string", "description": "Owner of the billing plan", "x-cs-type": "ObjectId"}, "name": {"type": "string", "description": "Name of the billing plan"}, "description": {"type": "string", "description": "Description of the billing plan"}, "is_active": {"type": "boolean", "description": "States if the billing plan is active or not"}, "is_template": {"type": "boolean", "description": "States if the plan is a template or not"}, "notes": {"type": "string", "description": "Notes for the billing plan"}, "attachment_ids": {"type": "array", "description": "List of attachment IDs", "items": {"type": "string"}}, "raw_list_cost_adjusted_billing_plan": {"type": "boolean", "description": "States if the billing plan is for raw list cost adjusted billing plan or not"}, "created_by": {"type": "string", "description": "Created by", "x-cs-type": "ObjectId"}, "updated_by": {"type": "string", "description": "Updated by", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "BillingPlanDefinitionFilters": {"properties": {"search": {"type": "string", "description": "Search by name or description"}, "plan_status": {"type": "string", "description": "Plan Status. This field is used to indicate the status of the billing plan.", "example": "active", "enum": ["active", "inactive"], "x-cs-enum-type": "PlanStatus"}, "scope": {"description": "Scope is/is not/contains/not contains the given value", "$ref": "#/definitions/QueryOperator"}, "from_date": {"type": "string", "format": "date-time", "description": "Billing Plan ends after this date"}, "to_date": {"type": "string", "format": "date-time", "description": "Billing Plan starts before this date"}, "raw_list_cost_adjusted_billing_plan": {"type": "boolean", "description": "raw_list_cost_adjusted_billing_plan", "default": false}}, "type": "object"}, "BillingPlanDefinitionListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/BillingPlanDefinitionListSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/BillingPlanDefinitionFilters"}}, "type": "object"}, "BillingPlanDefinitionListSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedOn", "UpdatedOn"], "x-cs-enum-type": "BillingPlanDefinitionListSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "BillingPlanDefinitionVersion": {"allOf": [{"$ref": "#/definitions/BaseDefinitionVersion"}, {"properties": {"details": {"description": "Details of the version", "$ref": "#/definitions/BillingPlanConfiguration"}, "status": {"type": "string", "description": "Billing Plan Execution Status. This field is used to indicate the completion status of the billing plan execution.", "example": "completed", "enum": ["completed", "failed", "in_progress", "pending", "na"], "x-cs-enum-type": "BillingPlanExecutionStatus"}, "statuses": {"type": "array", "description": "Status by service account", "items": {"$ref": "#/definitions/BillingPlanSyncStatus"}}, "created_by": {"type": "string", "description": "Created by", "x-cs-type": "ObjectId"}, "updated_by": {"type": "string", "description": "Updated by", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "BillingPlanSyncStatus": {"required": ["status", "sys_id"], "properties": {"sys_id": {"type": "string", "description": "Service account ID", "x-cs-type": "ObjectId"}, "status": {"type": "string", "description": "Status of the billing plan execution", "example": "completed", "enum": ["completed", "failed", "in_progress", "pending", "na"], "x-cs-enum-type": "BillingPlanExecutionStatus"}, "message": {"type": "string", "description": "Message related to the billing plan status"}}, "type": "object"}, "BillingPlatformTagKeysRequest": {"allOf": [{"$ref": "#/definitions/BillingTagKeysRequest"}, {"properties": {"kinds": {"type": "array", "description": "Billing Platform kinds", "items": {"type": "string"}}}, "type": "object"}]}, "BillingRateAggregationTrendRequest": {"allOf": [{"$ref": "#/definitions/BillingAggregationBase"}, {"required": ["billing_source"], "properties": {"billing_source": {"type": "string", "description": "Billing plan to select data from"}, "group_by": {"type": "array", "description": "If set, group results by the given group of fields", "items": {"$ref": "#/definitions/BillingGroupByDetails"}}}, "type": "object"}]}, "BillingRateAggregationTrendResult": {"allOf": [{"$ref": "#/definitions/BillingAggregationTrendResult"}, {"properties": {}, "type": "object"}]}, "BillingRule": {"required": ["__type"], "properties": {"name": {"type": "string", "description": "Name of the billing rule"}, "description": {"type": "string", "description": "Description of the billing rule"}, "is_active": {"type": "boolean", "description": "True if the billing plan is active"}, "scope": {"description": "Filter to select the line items this rule applies to.", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "Start date of the billing rule"}, "end_date": {"type": "string", "format": "date-time", "description": "End date of the billing rule"}, "note": {"type": "string", "description": "Note for the billing rule"}, "attachment_ids": {"type": "array", "description": "List of attachment IDs", "items": {"type": "string"}}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "BillingRuleStop", "subtype_name": "BillingRuleStop"}, {"subtype_model": "BillingRuleStopGroup", "subtype_name": "BillingRuleStopGroup"}, {"subtype_model": "BillingRulePublish", "subtype_name": "BillingRulePublish"}, {"subtype_model": "BillingRuleGroup", "subtype_name": "BillingRuleGroup"}, {"subtype_model": "BillingRuleRoot", "subtype_name": "BillingRuleRoot"}, {"subtype_model": "BillingRuleCalculate", "subtype_name": "BillingRuleCalculate"}, {"subtype_model": "BillingRuleFixedCustomRate", "subtype_name": "BillingRuleFixedCustomRate"}, {"subtype_model": "BillingRulePercentageCalculate", "subtype_name": "BillingRulePercentageCalculate"}, {"subtype_model": "BillingRuleMargin", "subtype_name": "BillingRuleMargin"}, {"subtype_model": "BillingRuleFixedTiered", "subtype_name": "BillingRuleFixedTiered"}, {"subtype_model": "BillingRuleAllocation", "subtype_name": "BillingRuleAllocation"}, {"subtype_model": "BillingRuleAllocationGenericTargets", "subtype_name": "BillingRuleAllocationGenericTargets"}, {"subtype_model": "BillingRuleAllocationProportionalSpend", "subtype_name": "BillingRuleAllocationProportionalSpend"}, {"subtype_model": "BillingRuleAllocationProportionalUsage", "subtype_name": "BillingRuleAllocationProportionalUsage"}, {"subtype_model": "BillingRuleAllocationProportionalServiceCategory", "subtype_name": "BillingRuleAllocationProportionalServiceCategory"}, {"subtype_model": "BillingRuleAllocationEqual", "subtype_name": "BillingRuleAllocationEqual"}, {"subtype_model": "BillingRuleAllocationPercentage", "subtype_name": "BillingRuleAllocationPercentage"}, {"subtype_model": "BillingRuleCreateLineItemBase", "subtype_name": "BillingRuleCreateLineItemBase"}, {"subtype_model": "BillingRuleCreateLineItemFromTiered", "subtype_name": "BillingRuleCreateLineItemFromTiered"}, {"subtype_model": "BillingRuleCreateLineItemFromPercentage", "subtype_name": "BillingRuleCreateLineItemFromPercentage"}, {"subtype_model": "BillingRuleCreateLineItem", "subtype_name": "BillingRuleCreateLineItem"}, {"subtype_model": "BillingRuleCommitmentUnshare", "subtype_name": "BillingRuleCommitmentUnshare"}, {"subtype_model": "BillingRuleAllocationProportionalSpendPlatform", "subtype_name": "BillingRuleAllocationProportionalSpendPlatform"}, {"subtype_model": "BillingRuleAllocationProportionalSpendCloudAndPlatform", "subtype_name": "BillingRuleAllocationProportionalSpendCloudAndPlatform"}, {"subtype_model": "BillingRuleAllocationProportionalServiceCategoryPlatform", "subtype_name": "BillingRuleAllocationProportionalServiceCategoryPlatform"}, {"subtype_model": "BillingRuleAllocationProportionalServiceCategoryCloudAndPlatform", "subtype_name": "BillingRuleAllocationProportionalServiceCategoryCloudAndPlatform"}]}, "BillingRuleAllocation": {"allOf": [{"$ref": "#/definitions/BillingRule"}, {"properties": {"execution_schedule": {"description": "Schedule for executing the automated rule", "$ref": "#/definitions/BillingRuleRepeatingSchedule"}, "approval_required": {"type": "boolean", "description": "If True, requires admin approval before applying the rule"}}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocation"}, "BillingRuleAllocationEqual": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocationGenericTargets"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationEqual"}, "BillingRuleAllocationGenericTargets": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocation"}, {"properties": {"targets": {"type": "array", "description": "List of targets to allocate the cost to", "items": {"$ref": "#/definitions/AllocationTarget"}}}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationGenericTargets"}, "BillingRuleAllocationPercentage": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocation"}, {"properties": {"targets": {"type": "array", "description": "List of targets to allocate the cost to", "items": {"$ref": "#/definitions/AllocationPercentageTarget"}}}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationPercentage"}, "BillingRuleAllocationProportionalServiceCategory": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocationGenericTargets"}, {"required": ["service_categories"], "properties": {"service_categories": {"type": "array", "description": "List of service categories to allocate by", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationProportionalServiceCategory"}, "BillingRuleAllocationProportionalServiceCategoryCloudAndPlatform": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocationGenericTargets"}, {"required": ["service_categories"], "properties": {"service_categories": {"type": "array", "description": "List of service categories to allocate by", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationProportionalServiceCategoryCloudAndPlatform"}, "BillingRuleAllocationProportionalServiceCategoryPlatform": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocationGenericTargets"}, {"required": ["service_categories"], "properties": {"service_categories": {"type": "array", "description": "List of service categories to allocate by", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationProportionalServiceCategoryPlatform"}, "BillingRuleAllocationProportionalSpend": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocationGenericTargets"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationProportionalSpend"}, "BillingRuleAllocationProportionalSpendCloudAndPlatform": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocationGenericTargets"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationProportionalSpendCloudAndPlatform"}, "BillingRuleAllocationProportionalSpendPlatform": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocationGenericTargets"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationProportionalSpendPlatform"}, "BillingRuleAllocationProportionalUsage": {"allOf": [{"$ref": "#/definitions/BillingRuleAllocationGenericTargets"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleAllocationProportionalUsage"}, "BillingRuleBenefitDistributionBase": {"required": ["__type"], "properties": {"name": {"type": "string", "description": "Name of the rule."}, "description": {"type": "string", "description": "Description of the rule."}, "is_active": {"type": "boolean", "description": "Whether the rule is active."}}, "discriminator": "__type", "type": "object", "x-cs-type-name": "BillingRuleBenefitDistributionBase", "x-cs-subtypes": [{"subtype_model": "BillingRuleCommitmentShare", "subtype_name": "BillingRuleCommitmentShare"}, {"subtype_model": "BillingRuleCommitmentShareToSelf", "subtype_name": "BillingRuleCommitmentShareToSelf"}]}, "BillingRuleCalculate": {"allOf": [{"$ref": "#/definitions/BillingRule"}, {"properties": {"metric": {"type": "string", "description": "Metric for the calculation"}}, "type": "object"}], "x-cs-type-name": "BillingRuleCalculate"}, "BillingRuleCommitmentShare": {"allOf": [{"$ref": "#/definitions/BillingRuleBenefitDistributionBase"}, {"required": ["targets"], "properties": {"targets": {"type": "array", "items": {"$ref": "#/definitions/ShareTarget"}}}, "type": "object"}], "x-cs-type-name": "BillingRuleCommitmentShare"}, "BillingRuleCommitmentShareToSelf": {"allOf": [{"$ref": "#/definitions/BillingRuleBenefitDistributionBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleCommitmentShareToSelf"}, "BillingRuleCommitmentUnshare": {"allOf": [{"$ref": "#/definitions/BillingRule"}, {"required": ["benefit_details"], "properties": {"source_metric": {"type": "string", "description": "Actual metric to copy the cost from. If not set, the source metric will be the raw_list_cost.", "default": "raw_list_cost"}, "target_metric": {"type": "string", "description": "Metric where adjusted cost will be written.", "default": "raw_list_cost_adjusted"}, "benefit_details": {"type": "array", "description": "List of benefit details to unshare.", "items": {"$ref": "#/definitions/BenefitDetails"}}, "unshare_percentage_from_source": {"type": "number", "description": "Percentage of the benefit to unshare from the source."}, "benefit_distribution_rules": {"type": "array", "description": "Distribution rules for the unshared benefits. Can include share or share-to-self rules.", "items": {"$ref": "#/definitions/BillingRuleBenefitDistributionBase"}}}, "type": "object"}], "x-cs-type-name": "BillingRuleCommitmentUnshare"}, "BillingRuleCreateLineItem": {"allOf": [{"$ref": "#/definitions/BillingRuleCreateLineItemBase"}, {"properties": {"amount": {"type": "number", "description": "Amount of the billing rule"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}], "x-cs-type-name": "BillingRuleCreateLineItem"}, "BillingRuleCreateLineItemBase": {"allOf": [{"$ref": "#/definitions/BillingRule"}, {"properties": {"line_item_identity": {"description": "Line item to create", "$ref": "#/definitions/BillingLineItemIdentity"}, "schedule": {"description": "Repeating schedule for the line item", "$ref": "#/definitions/BillingRuleRepeatingSchedule"}, "allocation": {"description": "Allocation for the line item", "$ref": "#/definitions/BillingRuleAllocation"}}, "type": "object"}], "x-cs-type-name": "BillingRuleCreateLineItemBase"}, "BillingRuleCreateLineItemFromPercentage": {"allOf": [{"$ref": "#/definitions/BillingRuleCreateLineItemBase"}, {"properties": {"percentage": {"type": "number", "description": "Percentage of the billing rule"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}], "x-cs-type-name": "BillingRuleCreateLineItemFromPercentage"}, "BillingRuleCreateLineItemFromTiered": {"allOf": [{"$ref": "#/definitions/BillingRuleCreateLineItemBase"}, {"properties": {"tiers": {"type": "array", "description": "List of tiers", "items": {"$ref": "#/definitions/CreateLineItemTier"}}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}], "x-cs-type-name": "BillingRuleCreateLineItemFromTiered"}, "BillingRuleFixedCustomRate": {"allOf": [{"$ref": "#/definitions/BillingRuleCalculate"}, {"properties": {"amount": {"type": "number", "description": "Amount of the billing rule"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}], "x-cs-type-name": "BillingRuleFixedCustomRate"}, "BillingRuleFixedTiered": {"allOf": [{"$ref": "#/definitions/BillingRuleCalculate"}, {"properties": {"tiers": {"type": "array", "description": "List of tiers", "items": {"$ref": "#/definitions/BillingRuleTier"}}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}], "x-cs-type-name": "BillingRuleFixedTiered"}, "BillingRuleGroup": {"allOf": [{"$ref": "#/definitions/BillingRule"}, {"properties": {"rules": {"type": "array", "description": "List of rules", "items": {"$ref": "#/definitions/BillingRule"}}}, "type": "object"}], "x-cs-type-name": "BillingRuleGroup"}, "BillingRuleMargin": {"allOf": [{"$ref": "#/definitions/BillingRulePercentageCalculate"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleMargin"}, "BillingRulePercentageCalculate": {"allOf": [{"$ref": "#/definitions/BillingRuleCalculate"}, {"properties": {"percentage": {"type": "number", "description": "Percentage of the billing rule"}}, "type": "object"}], "x-cs-type-name": "BillingRulePercentageCalculate"}, "BillingRulePublish": {"allOf": [{"$ref": "#/definitions/BillingRule"}, {"properties": {"master_account_ids": {"type": "array", "description": "List of master account ids to publish the scoped line items to.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "BillingRulePublish"}, "BillingRuleRepeatingSchedule": {"properties": {"start_date": {"type": "string", "format": "date-time", "description": "Start date of the billing rule"}, "frequency": {"type": "string", "description": "Frequency of the billing rule", "example": "daily", "enum": ["daily", "weekly", "monthly", "quarterly", "yearly"], "x-cs-enum-type": "BillingFrequency"}}, "type": "object"}, "BillingRuleRoot": {"allOf": [{"$ref": "#/definitions/BillingRuleGroup"}, {"properties": {"parent_plan_id": {"type": "string", "description": "Parent plan ID"}, "destination_metric": {"type": "string", "description": "Describes the destination metrics of the billing plan."}, "source_metric": {"type": "string", "description": "Describes the source metric of the billing plan."}, "source_metric_overrides": {"type": "array", "description": "List of source metric overrides by native details", "items": {"$ref": "#/definitions/BillingMetricSourceOverride"}}, "match_service_account_ancestors": {"type": "boolean", "description": "True if the rules contained by the group should match service account ancestors", "default": false}}, "type": "object"}], "x-cs-type-name": "BillingRuleRoot"}, "BillingRuleStop": {"allOf": [{"$ref": "#/definitions/BillingRule"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleStop"}, "BillingRuleStopGroup": {"allOf": [{"$ref": "#/definitions/BillingRule"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "BillingRuleStopGroup"}, "BillingRuleTier": {"allOf": [{"$ref": "#/definitions/Tier"}, {"properties": {"rule": {"description": "Rule for the tier. Nested Tiered Rules are not allowed.", "$ref": "#/definitions/BillingRule"}}, "type": "object"}], "x-cs-type-name": "BillingRuleTier"}, "BillingSourceQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["billing_sources"], "properties": {"billing_sources": {"type": "array", "description": "Billing sources / cost metrics to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "BillingSourceQueryOperator"}, "BillingSummaryBase": {"properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "descendant_service_account_query": {"description": "Descendant service account query filter", "$ref": "#/definitions/DescendantServiceAccountQuery"}, "for_platform": {"type": "boolean", "description": "If set, redirect the query to billing platform line items summary collection"}, "skip_service_account_grouping": {"type": "boolean", "description": "If set, do not group by service account"}}, "type": "object"}, "BillingTagKeysRequest": {"allOf": [{"$ref": "#/definitions/BillingSummaryBase"}, {"properties": {"tag_keys": {"type": "array", "description": "If set, the subset of keys to return", "items": {"type": "string"}}, "include_values": {"type": "boolean", "description": "If set, include values, not just keys"}}, "type": "object"}]}, "BillingUsageAggregationTrendRequest": {"allOf": [{"$ref": "#/definitions/BillingAggregationBase"}, {"required": ["granularity"], "properties": {"granularity": {"type": "integer", "description": "Number of seconds between steps"}, "group_by": {"type": "array", "description": "If set, the dimensions to group results by", "items": {"$ref": "#/definitions/BillingGroupByDetails"}}, "limit": {"type": "integer", "description": "If set, limits the results to given number."}}, "type": "object"}]}, "BillingUsageAggregationTrendResult": {"allOf": [{"$ref": "#/definitions/BillingAggregationTrendResult"}, {"properties": {}, "type": "object"}]}, "BlueprintDetails": {"required": ["created_at", "created_by", "description", "id", "name", "resources", "scope", "status", "updated_at", "updated_by"], "properties": {"id": {"type": "string", "description": "Blueprint ID"}, "name": {"type": "string", "description": "Blueprint Name"}, "description": {"type": "string", "description": "Blueprints Description"}, "resources": {"type": "array", "description": "Resource Details", "items": {"$ref": "#/definitions/ResourcesDetails"}}, "scope": {"type": "string", "description": "Scope of the blueprint"}, "status": {"type": "string", "description": "Status of the blueprint"}, "created_by": {"type": "string", "description": "Who has created the blueprint"}, "created_at": {"type": "string", "description": "When was the blueprint created"}, "updated_by": {"type": "string", "description": "Who has updated the blueprint"}, "updated_at": {"type": "string", "description": "When was the blueprint updated"}}, "type": "object"}, "BrandingConfiguration": {"properties": {"primaryColor": {"type": "string"}, "secondaryColor": {"type": "string"}, "text": {"type": "string"}, "logoBase64": {"type": "string"}, "horizontalPlacement": {"type": "string", "example": "Left", "enum": ["Left", "Center", "Right"], "x-cs-enum-type": "HorizontalAlignment"}, "verticalPlacement": {"type": "string", "example": "Top", "enum": ["Top", "Middle", "Bottom"], "x-cs-enum-type": "VerticalAlignment"}}, "type": "object"}, "BrokerFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"br_2504_a_test_flag": {"type": "boolean", "description": "Flag's default value", "default": false}}, "type": "object"}]}, "Budget": {"properties": {"budget_period": {"type": "string"}, "budget_amount": {"type": "number"}}, "type": "object"}, "BudgetAdvancedFilter": {"properties": {"tags": {"type": "array", "items": {"$ref": "#/definitions/BudgetAdvancedFilterDetails"}}, "compartments": {"type": "array", "items": {"$ref": "#/definitions/BudgetAdvancedFilterDetails"}}, "regions": {"type": "array", "items": {"$ref": "#/definitions/BudgetAdvancedFilterDetailsRegions"}}}, "type": "object"}, "BudgetAdvancedFilterDetails": {"properties": {"id": {"type": "string", "description": "tag id"}, "name": {"type": "string", "description": "tag name"}}, "type": "object"}, "BudgetAdvancedFilterDetailsRegions": {"properties": {"region": {"type": "array", "items": {"$ref": "#/definitions/BudgetFilterRegion"}}}, "type": "object"}, "BudgetAlertsExceedResponse": {"required": ["total_alerts_exceed_budgets_count"], "properties": {"total_alerts_exceed_budgets_count": {"type": "integer", "description": "alert exceeded budget count"}}, "type": "object"}, "BudgetAmountModel": {"required": ["amount"], "properties": {"amount": {"type": "integer", "description": "budget amount"}, "type": {"type": "string", "description": "type of budget amount. Allowed values will be auto_increment/auto_suggest/fixed"}, "planned_budget_limit": {"type": "array", "description": "planned budget_limit for auto_suggest/auto_increment type", "items": {"$ref": "#/definitions/BudgetLimitModel"}}, "budget_growth": {"type": "number", "description": "Percentage value for auto_increment type only"}}, "type": "object"}, "BudgetCostTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {"selectedBudgetId": {"type": "string", "description": "ID of the currently selected budget \u2014 persisted to restore the dropdown selection on reload"}}, "type": "object"}], "x-cs-type-name": "BudgetCostTrendWidgetConfiguration"}, "BudgetCreateFiltersModel": {"properties": {"resource_type": {"type": "array", "description": "resource_type with id name. Id and name can be obtained from /budget/filter_values API", "items": {"$ref": "#/definitions/FilterIdNameModel"}}, "tags": {"type": "object", "description": "tag filter values.Format should key nad list of values"}}, "type": "object"}, "BudgetCreateUpdateRequest": {"required": ["budget_event_type", "budget_frequency", "budget_name", "budget_type"], "properties": {"budget_name": {"type": "string", "description": "Provide a name for your budget"}, "budget_id": {"type": "string", "description": "Id of Budget to create budget data"}, "status": {"type": "string", "description": "The status of the budget corresponds to its budget ID and can be in one of the following states: \npending: This is the state before the budget has been synchronized.\nin_Progress: This is the state when the budget is currently being synchronized.\ncompleted: This is the state when the budget has successfully completed its synchronization.\n", "example": "pending", "enum": ["pending", "in_progress", "completed", "expired", "draft"], "x-cs-enum-type": "BudgetStatus"}, "tenant_id": {"type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, "budget_event_type": {"type": "string", "description": "budget event type.", "example": "create", "enum": ["create", "update"], "x-cs-enum-type": "BudgetEventType"}, "budget_frequency": {"type": "string", "description": "Specify the budget frequency. Example: 'budget frequency':'Daily' Allowed values - Daily,Monthly,Quarterly,Annually"}, "budget_type": {"type": "string", "description": "Budget type will Be COST for AWS and Cost for Azure"}, "budget_details": {"description": "Get details of a specific budget id within a given budget id", "$ref": "#/definitions/BudgetDetailsModel"}, "metadata": {"description": "Metadata like file name, file format", "$ref": "#/definitions/BudgetMetaModel"}, "budget_amount": {"description": "example: Currency of the cost. Example 'currency\u2019: \u2018USD\u2019", "$ref": "#/definitions/BudgetAmountModel"}}, "type": "object"}, "BudgetCreateUpdateResponse": {"required": ["budget_id", "budget_uri"], "properties": {"tenant_id": {"type": "string", "description": "tenant id"}, "budget_name": {"type": "string", "description": "created/updated budget name"}, "is_corestack_created": {"type": "boolean", "description": "true if budget created in corestack"}, "is_recurring": {"type": "boolean", "description": "true if recurring budget"}, "budget_id": {"type": "string", "description": "Specify the budget ID.This is a unique ID and can be retrieved using the create budget_UI"}, "budget_engine": {"type": "string", "description": "budget engine"}, "budget_frequency": {"type": "string", "description": "Specify the budget frequency. Example: 'budget frequency':'Daily' Allowed values - Daily,Monthly,Quarterly,Annually"}, "budget_type": {"type": "string", "description": "budget type"}, "budget_uri": {"type": "string", "description": "budget uri"}}, "type": "object"}, "BudgetDetailsModel": {"required": ["currency", "from_date", "is_recurring"], "properties": {"is_recurring": {"type": "boolean", "description": "give false for non-recurring budget"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "from_date": {"type": "string", "description": "from date for that rule. Example: 'end_date': '2021-04-01T12:00:00.000Z"}, "to_date": {"type": "string", "description": "to date for that rule. Example: 'end_date': '2021-04-01T12:00:00.000Z"}, "cloud": {"type": "array", "description": "The name of the cloud service. for example, AWS.", "items": {"type": "string"}}, "cloud_account_id": {"type": "array", "description": "Specify the cloud account id to view, cloud account id is unique can be obtained from the list cloud account api.", "items": {"type": "string"}}, "dimension": {"description": "Dimension details for the budget. This is a unique ID and can be retrieved using the List Dimensions API.", "$ref": "#/definitions/BudgetDimensionDetailsModel"}, "filters": {"description": "budget filters", "$ref": "#/definitions/BudgetCreateFiltersModel"}}, "type": "object"}, "BudgetDimensionDetailsModel": {"required": ["entity", "grouping_rule_ids", "name", "sys_id", "values"], "properties": {"sys_id": {"type": "string", "description": "Dimension ID for the budget. This is a unique ID and can be retrieved using the List Dimensions API."}, "name": {"type": "string", "description": "Dimension name for the budget. This is a unique name and can be retrieved using the List Dimensions API."}, "values": {"type": "array", "description": "Dimension value for the budget. This is a unique value and can be retrieved using.", "items": {"type": "string"}}, "grouping_rule_ids": {"type": "array", "description": "List of grouping rule IDs to be associated with the budget. This is a unique ID and can be retrieved using the List Grouping Rules API.", "items": {"type": "string"}}, "entity": {"type": "string", "description": "Entity type for the dimension. This is a unique entity type and can be retrieved."}}, "type": "object"}, "BudgetDrift": {"properties": {"tenant_id": {"type": "string", "description": "Id of the tenant"}, "budget_details": {"type": "array", "description": "Budget_details", "items": {"$ref": "#/definitions/BudgetDriftDetail"}}}, "type": "object"}, "BudgetDriftDetail": {"properties": {"budget_drift": {"type": "number", "description": "Actual or Forecast Budget_Drift"}, "cost_spend": {"type": "number", "description": "Cost Spend for the clouds"}, "budget_amount": {"type": "number", "description": "Budget Amount."}, "budget_name": {"type": "string", "description": "Name of budget"}}, "type": "object"}, "BudgetDriftRequest": {"allOf": [{"$ref": "#/definitions/CommonCostRequest"}, {"required": ["configuration_type"], "properties": {"configuration_type": {"type": "string", "description": "Type of budget", "example": "actual", "enum": ["actual", "forecast"], "x-cs-enum-type": "BudgetType"}}, "type": "object"}]}, "BudgetDriftWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {"configurationType": {"type": "string", "description": "Type of budget", "example": "actual", "enum": ["actual", "forecast"], "x-cs-enum-type": "BudgetType"}}, "type": "object"}], "x-cs-type-name": "BudgetDriftWidgetConfiguration"}, "BudgetFilterModel": {"properties": {"budget_frequency": {"type": "string", "description": "Specify the budget frequency. Example: 'budget frequency':'Daily' Allowed values - Daily,Monthly,Quarterly,Annually"}}, "type": "object"}, "BudgetFilterRegion": {"properties": {"type": {"type": "string", "description": "Type of region"}, "id": {"type": "string", "description": "Id of the region"}, "name": {"type": "string", "description": "Name of the region"}}, "type": "object"}, "BudgetHistoryDataModel": {"required": ["actual_amount", "budget_amount", "budget_id", "budget_variance", "budget_variance_percentage", "currency", "date"], "properties": {"budget_variance_percentage": {"type": "number", "description": "budget variance percentage"}, "budget_variance": {"type": "number", "description": "budget variance"}, "actual_amount": {"type": "number", "description": "actual amount"}, "budget_amount": {"type": "number", "description": "budget amount"}, "date": {"type": "string", "description": "budget amount until this date"}, "currency": {"type": "string", "description": "budget currency"}, "budget_id": {"type": "string", "description": "budget history of budget id"}}, "type": "object"}, "BudgetHistoryResponse": {"required": ["budget_history"], "properties": {"budget_history": {"type": "array", "description": "Budget History data", "items": {"$ref": "#/definitions/BudgetHistoryDataModel"}}}, "type": "object"}, "BudgetLimitModel": {"properties": {"amount": {"type": "integer", "description": "budget amount for that period"}, "month": {"type": "string", "description": "month format should be Jun-2015 and for annually 2020"}}, "type": "object"}, "BudgetListConstraintsRequest": {"required": ["cloud_account_id", "filter_key", "tenant_id"], "properties": {"filter_key": {"type": "string", "description": "List constraints based on filter key. Allowed values are region/resource_group/linked_accounts/projects/resource_type/tags"}, "tenant_id": {"type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, "cloud_account_id": {"type": "array", "description": "Specify the cloud account id to view, cloud account id is unique can be obtained from the list cloud account api.", "items": {"type": "string"}}}, "type": "object"}, "BudgetListConstraintsResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "budget filter list status"}, "message": {"type": "string", "description": "budget filter list status message"}, "data": {"type": "object", "description": "constraints listed for given filter key, cloud_account_id and tenant_id"}}, "type": "object"}, "BudgetListRequest": {"required": ["currency"], "properties": {"filters": {"description": "filter budgets based on filter data", "$ref": "#/definitions/BudgetFilterModel"}, "status": {"type": "array", "description": "Budget status. Allowed values are pending/in_progress/completed/expired", "items": {"type": "string", "description": "The status of the budget corresponds to its budget ID and can be in one of the following states: \npending: This is the state before the budget has been synchronized.\nin_Progress: This is the state when the budget is currently being synchronized.\ncompleted: This is the state when the budget has successfully completed its synchronization.\n", "example": "pending", "enum": ["pending", "in_progress", "completed", "expired", "draft"], "x-cs-enum-type": "BudgetStatus"}}, "billing_source": {"type": "string", "description": "Cost metric used to calculate the budget amount"}, "budget_engine": {"type": "string", "description": "budget engine can be Cloud_Native or System", "example": "Cloud_Native", "enum": ["Cloud_Native", "System"], "x-cs-enum-type": "BudgetEngine"}, "service_name": {"type": "array", "description": "The name of the cloud service. For example, AWS.", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "cloud_account_id": {"type": "array", "description": "Specify the cloud account id to view, cloud account id is unique and can be obtained from the list cloud account api.", "items": {"type": "string"}}, "project_id": {"type": "array", "description": "Tenant ids", "items": {"type": "string"}}, "dimension_id": {"type": "array", "description": "Dimension IDs for the budget. This is a unique ID and can be retrieved using", "items": {"type": "string"}}, "grouping_rule_ids": {"type": "array", "description": "List of grouping rule IDs to be associated with the budget. This is a unique.", "items": {"type": "string"}}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "active_only": {"type": "boolean", "description": "When true, returns only active budgets.", "default": false}, "start_date": {"type": "string", "format": "date-time", "description": "ISO 8601 UTC datetime. When provided with end_date, filters to budgets whose period overlaps the given range."}, "end_date": {"type": "string", "format": "date-time", "description": "ISO 8601 UTC datetime. When provided with start_date, filters to budgets whose period overlaps the given range."}}, "type": "object"}, "BudgetListResponse": {"required": ["budgets_list", "total_budgets_count"], "properties": {"total_budgets_count": {"type": "integer", "description": "Total Budgets count"}, "budgets_list": {"type": "array", "description": "Details of violation", "items": {"$ref": "#/definitions/ListBudgetsModel"}}}, "type": "object"}, "BudgetMetaModel": {"properties": {"tracking": {"description": "tracking details", "$ref": "#/definitions/BudgetTrackingModel"}}, "type": "object"}, "BudgetScopeDetails": {"properties": {"cloud": {"type": "array", "items": {"type": "string", "description": "cloud name", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "filters": {"description": "advanced filters details of the specific budget mentioned", "$ref": "#/definitions/BudgetAdvancedFilter"}, "tenant": {"type": "array", "items": {"type": "string", "description": "tenant name"}}, "cloud_account": {"type": "array", "items": {"type": "string"}}, "service_account_ids": {"type": "array", "description": "Service account Ids.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "grouping_rule_ids": {"type": "array", "items": {"type": "string", "description": "grouping rule id"}}, "dimension_id": {"type": "string", "description": "dimension id"}, "name": {"type": "string", "description": "name of the budget scope"}, "entity": {"type": "string", "description": "entity type for the budget scope. This is a unique entity type and can be retrieved."}, "values": {"type": "array", "items": {"type": "string", "description": "values of the budget scope"}}}, "type": "object"}, "BudgetSummaryFilterModel": {"properties": {"cloud": {"type": "array", "description": "The name of the cloud service. For example, AWS.", "items": {"type": "string"}}, "cloud_account_id": {"type": "array", "description": "Specify the cloud account ID to view, cloud account ID is unique can be obtained from the list cloud account api.", "items": {"type": "string"}}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "BudgetSummaryRequest": {"properties": {"filter_params": {"description": "filter budgets based on filter data", "$ref": "#/definitions/BudgetSummaryFilterModel"}, "tenant_ids": {"type": "array", "description": "Tenant ids", "items": {"type": "string"}}, "type": {"type": "string", "description": "Type of filter.Type will be budget_summary/alert_exceeds_summary", "example": "budget_summary", "enum": ["budget_summary", "alert_exceeds_summary"], "x-cs-enum-type": "BudgetSummaryType"}}, "type": "object"}, "BudgetSummaryResponse": {"required": ["total_budgets_count"], "properties": {"total_budgets_count": {"type": "integer", "description": "budget count"}}, "type": "object"}, "BudgetThresholdViewModel": {"properties": {"percentage": {"type": "number", "description": "threshold percentage"}, "type": {"type": "string", "description": "threshold type like actual/forecasted"}, "amount": {"type": "number", "description": "threshold amount (0.0 if set by percentage)", "default": 0.0}}, "type": "object"}, "BudgetTrackingModel": {"properties": {"next_step": {"type": "integer", "description": "next step no"}}, "type": "object"}, "BudgetViewResponse": {"required": ["budget_event_type", "budget_frequency", "budget_name", "budget_type", "budget_uri", "created_at", "created_by", "updated_at", "updated_by"], "properties": {"threshold_uri": {"type": "array", "description": "threshold uri", "items": {"type": "string"}}, "cloud": {"type": "array", "description": "The name of the cloud service. For example, AWS.", "items": {"type": "string"}}, "cloud_account_id": {"type": "array", "description": "Cloud account id", "items": {"type": "string"}}, "created_at": {"type": "string", "description": "budget created at"}, "updated_at": {"type": "string", "description": "budget updated at"}, "created_by": {"type": "string", "description": "Name of the user who created the budget"}, "updated_by": {"type": "string", "description": "Name of the user who updated the budget"}, "tenant_id": {"type": "string", "description": "tenant id"}, "is_corestack_created": {"type": "boolean", "description": "true if budget created in corestack"}, "is_tenant_level": {"type": "boolean", "description": "true if budget is system budget"}, "budget_name": {"type": "string", "description": "budget name"}, "alias_budget_name": {"type": "string", "description": "budget name"}, "status": {"type": "string", "description": "budget creation status"}, "budget_type": {"type": "string", "description": "budget type"}, "budget_frequency": {"type": "string", "description": "Specify the budget frequency. Example: budget frequency':'Daily' Allowed values - Daily,Monthly,Quarterly,Annually"}, "budget_engine": {"type": "string", "description": "budget engine"}, "budget_event_type": {"type": "string", "description": "budget event type"}, "budget_uri": {"type": "string", "description": "budget uri"}, "metadata": {"description": "metadata to maintain step", "$ref": "#/definitions/BudgetMetaModel"}, "currency": {"type": "string", "description": "Name of the currency"}, "summary": {"description": "budget summary data", "$ref": "#/definitions/BudgetViewSummaryModel"}}, "type": "object"}, "BudgetViewSummaryModel": {"properties": {"budget_details": {"description": "budget details", "$ref": "#/definitions/BudgetDetailsModel"}, "budget_amount": {"description": "budget amount data", "$ref": "#/definitions/BudgetAmountModel"}, "threshold_details": {"type": "array", "description": "threshold details", "items": {"$ref": "#/definitions/BudgetThresholdViewModel"}}}, "type": "object"}, "BulkTagRemediationRequest": {"required": ["remediation_inputs", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account Id", "x-cs-type": "ObjectId"}, "remediation_inputs": {"type": "array", "items": {"$ref": "#/definitions/TagsRemediation"}}}, "type": "object"}, "BulkTagRemediationResponse": {"properties": {"resource_enforce_tag_ids": {"type": "array", "description": "Tag Remediation Ids", "items": {"type": "string"}}}, "type": "object"}, "BulkTagRemediationStatusRequest": {"required": ["resource_ids", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account Id", "x-cs-type": "ObjectId"}, "resource_ids": {"type": "array", "description": "Tag Remediation Resource Ids", "items": {"type": "string"}}}, "type": "object"}, "BulkTagRemediationStatusResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/TagRemediationStatus"}}}, "type": "object"}, "CategoryCountRequest": {"required": ["filters", "identifier"], "properties": {"identifier": {"type": "string", "description": "Category/Resource based count for the cloud", "default": "category", "example": "category", "enum": ["category", "resource"], "x-cs-enum-type": "InventorySelector"}, "filters": {"description": "Resource filters detail", "$ref": "#/definitions/CountDetailsDataModel"}}, "type": "object"}, "CategoryCountResponse": {"properties": {"category_details": {"description": "Inventory category count details", "$ref": "#/definitions/CategoryCountResponseModelList"}, "resource_details": {"type": "object", "description": "Inventory resource count details"}}, "type": "object"}, "CategoryCountResponseModelList": {"properties": {"count": {"type": "string", "description": "Inventory category count details"}, "resource_category": {"type": "string", "description": "Name of the category"}}, "type": "object"}, "ChangePasswordRequest": {"required": ["current_password", "new_password"], "properties": {"current_password": {"type": "string", "description": "Current password of the user being used. If you are unaware of the current password, use forgot password option in the CoreStack portal."}, "new_password": {"type": "string", "description": "New Password to be set for the user. Password length must be of 8-15 characters with atleast one special character(_$^@*!#&.), one number and starting character must be an alphabet."}}, "type": "object"}, "ChangePasswordResponse": {"required": ["user_id"], "properties": {"user_id": {"type": "string", "description": "ID of the User to whom the password is changed"}}, "type": "object"}, "ChangeTimezoneData": {"required": ["id", "raw_offset"], "properties": {"raw_offset": {"type": "string", "description": "Raw offset of the timezone. It means the amount of time in milliseconds to add to UTC to get standard time in the required time zone"}, "id": {"type": "string", "description": "ID of the Timezone such as Asia/Kolkata, Asia/Dubai and so on"}}, "type": "object"}, "ChangeTimezoneRequest": {"required": ["new_timezone_id"], "properties": {"new_timezone_id": {"type": "string", "description": "New timezone id to be set for the user. For a valid list of timezone values to use, please refer https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"}}, "type": "object"}, "ChangeTimezoneResponse": {"required": ["timezone", "user_id"], "properties": {"timezone": {"description": "Contains information about the timezone set for the user. Raw offset of the timezone. It means the amount of time in milliseconds to add to UTC to get standard time in the required time zone. Id of the Timezone such as Asia/Kolkata, Asia/Dubai and so on", "$ref": "#/definitions/ChangeTimezoneData"}, "user_id": {"type": "string", "description": "ID of the user to whom the timezone is changed"}}, "type": "object"}, "ChargeDescriptionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {"group_by_details": {"$ref": "#/definitions/BillingGroupByDetails"}}, "type": "object"}], "x-cs-type-name": "ChargeDescriptionWidgetConfiguration"}, "ChartWidgetViewState": {"allOf": [{"$ref": "#/definitions/WidgetViewState"}, {"properties": {"context": {"$ref": "#/definitions/DataContext"}, "groupBy": {"type": "array", "items": {"type": "string", "description": "Dimension to group results by", "example": "service_account_tags", "enum": ["service_account_tags", "service_name", "tenant_id", "tenant_tags", "service_account_id", "delegate_service_account_id", "availability_zone", "billing_entity", "line_item_type", "location", "meter_sub_category", "pricing_category", "pricing_purchase_option", "product_category", "product_family", "product_service_code", "product_sku", "publisher", "resource_category", "resource_group", "resource_id", "resource_name", "resource_operation", "extras", "tags", "hierarchy", "dimension", "compartment_name", "compartment_id", "resource_type", "utilization_type"], "x-cs-enum-type": "BillingGroupBySelector"}}, "groupByDetails": {"type": "array", "items": {"$ref": "#/definitions/BillingGroupByDetails"}}, "groupByAccountType": {"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, "groupByTagStatus": {"type": "boolean"}, "groupByWorkloadType": {"type": "boolean"}, "groupByResourceTagKeys": {"type": "boolean"}, "groupByResourceTagStatus": {"type": "boolean"}, "dimensionDetails": {"$ref": "#/definitions/BillingGroupByDetails"}, "dimensionResourceTagKeys": {"type": "boolean"}, "dimensionResourceTagStatus": {"type": "boolean"}, "dimensionWorkloadType": {"type": "boolean"}, "selectedViewBudget": {"type": "string"}, "viewBySbomGenerationDate": {"type": "boolean", "description": "When true, the data will be viewed by SBOM generation date."}, "trendGranularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}, "forecast": {"$ref": "#/definitions/ForecastDuration"}, "viewAs": {"type": "string", "description": "Chart type to display data", "example": "Bar", "enum": ["Bar", "Column", "GroupedColumn", "StackedColumn", "Pie", "Donut", "TreeMap", "Line", "Flow", "Map", "Network", "Sunburst", "Datatable", "Sankey", "HeatMap", "Hierarchy", "Bubble", "Area", "Waterfall"], "x-cs-enum-type": "ChartType"}, "limit": {"type": "string", "description": "Limit the amount of data to display", "example": "None", "enum": ["None", "Top5", "Top5PlusOther", "Top10", "Top10PlusOther", "Bottom5", "Bottom5PlusOther"], "x-cs-enum-type": "ChartLimit"}, "showVarianceColumn": {"type": "boolean"}, "drilldownContextEntries": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "isAccumulated": {"type": "boolean"}, "inverted": {"type": "boolean"}, "showFilter": {"type": "boolean"}, "tableLimit": {"type": "integer"}}, "type": "object"}], "x-cs-type-name": "ChartWidgetViewState"}, "ChatConversationBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/ConversationDetails"}}}, "type": "object"}, "ChatConversationFilter": {"required": ["chat_id"], "properties": {"chat_id": {"type": "string", "description": "ID of the agent type", "x-cs-type": "ObjectId"}}, "type": "object"}, "ChatConversationListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "ChatConversationRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/ChatConversationSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ChatConversationFilter"}}, "type": "object"}, "ChatConversationSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CreatedAt", "enum": ["CreatedAt", "UpdatedAt"], "x-cs-enum-type": "ChatConversationSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ChatMetadata": {"properties": {"last_state": {"type": "string", "description": "Last state ID", "x-cs-type": "ObjectId"}, "framework_name": {"type": "string", "description": "Name of the framework"}}, "type": "object"}, "CloneTemplateRequest": {"required": ["clone_template_name", "is_default", "scope", "source_monitoring_template_uri"], "properties": {"clone_template_name": {"type": "string", "description": "Provide the clone template name."}, "is_default": {"type": "boolean", "description": "Boolean value to set template as default not not"}, "cloud_account_id": {"type": "array", "description": "Provide cloud_account_id when scope is selected as cloud_account scope", "items": {"type": "string"}}, "regions": {"type": "array", "description": "Select regions when scope is selected as region for an AWS cloud", "items": {"type": "string"}}, "resource_groups": {"type": "array", "description": "Select resource_groups when scope is selected as resource_group for an Azure cloud", "items": {"type": "string"}}, "apply_to_existing_resource": {"type": "boolean", "description": "Select the check box, if wish to apply the configuration for existing resources also"}, "scope": {"type": "string", "description": "scope for the template to be cloned"}, "source_monitoring_template_uri": {"type": "string", "description": "monitoring_template_uri of a template from which it is being cloned"}, "constraints": {"description": "Provide the constraints, if the template need to be mapped with constraints", "$ref": "#/definitions/ConstraintsRequest"}}, "type": "object"}, "CloneTemplateResponse": {"required": ["data", "message"], "properties": {"message": {"type": "string", "description": "Clone template response"}, "data": {"type": "object", "description": "Create Monitoring Template Details"}}, "type": "object"}, "CloudAccount": {"required": ["cloud", "cloud_account_id"], "properties": {"cloud": {"type": "string", "description": "Displays the cloud associated with the template, for example, AWS, GCP, Azure etc"}, "cloud_account_id": {"type": "string", "description": "Unique Identifier of the cloud account onboarded in the on boarding section"}, "region": {"type": "string", "description": "The region of the cloud account where it needs to be executed. Mandatory for AWS"}, "zones": {"type": "string", "description": "The zones of the cloud account where it needs to be executed. Mandatory for GCP"}, "resourcegroup": {"type": "string", "description": "Resource group for which you need to execute the template for. Mandatory for Azure"}, "location": {"type": "string", "description": "Location under which you need to execute the template for. Mandatory for Azure"}}, "type": "object"}, "CloudAccountComplianceSummaryWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CloudAccountComplianceSummaryWidgetConfiguration"}, "CloudAccountDetail": {"required": ["id", "name"], "properties": {"name": {"type": "string", "description": "Cloud account name"}, "id": {"type": "string", "description": "Cloud Account ID"}, "preferred_regions": {"type": "array", "description": "Preferred regions of AWS", "items": {"type": "string"}}}, "type": "object"}, "CloudAccountDetails": {"required": ["id"], "properties": {"id": {"type": "string", "description": "Cloud account id is unique can be obtained from the list cloud"}}, "type": "object"}, "CloudAccountDetailsExtended": {"required": ["cloud_account_id", "cloud_account_name", "currency", "service_name"], "properties": {"cloud_account_id": {"type": "string", "description": "Cloud Account Id"}, "currency": {"type": "string", "description": "Currency Selected"}, "service_name": {"type": "string", "description": "Cloud Service Name"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}}, "type": "object"}, "CloudAccountDetailsResponse": {"required": ["cloud", "cloud_account_id"], "properties": {"cloud": {"type": "string", "description": "Displays the cloud associated with the template, for example, AWS, Azure etc"}, "cloud_account_id": {"type": "string", "description": "Unique Identifier of the cloud account onboarded in the on boarding section"}, "region": {"type": "string", "description": "The region of the cloud account where it needs to be executed. Mandatory for AWS"}, "resourcegroup": {"type": "string", "description": "Resource group for which you need to execute the template for. Mandatory for Azure"}, "location": {"type": "string", "description": "Location under which you need to execute the template for. Mandatory for Azure"}}, "type": "object"}, "CloudAccountWiseUsage": {"properties": {"service_account_name": {"type": "string", "description": "Name of the cloud account"}, "service_account_id": {"type": "string", "description": "Linked account ID for the cloud account"}, "actual_cost": {"type": "number", "description": "Actual cost incurred for the cloud account"}, "forecast_cost": {"type": "number", "description": "Projected cost for the cloud account"}, "service_name": {"type": "string", "description": "Name of the service of the cloud account"}, "account_type": {"type": "string", "description": "Type of the account"}, "product_category_wise": {"type": "array", "description": "List of category-wise usage data", "items": {"$ref": "#/definitions/ProductCategoryWiseUsage"}}}, "type": "object"}, "CloudAccounts": {"required": ["cloud_accounts", "message", "status"], "properties": {"status": {"type": "string", "description": "Response status on cloud accounts fetched successfully"}, "message": {"type": "string", "description": "Cloud accounts fetched successfully"}, "cloud_accounts": {"type": "object", "description": "cloud account details"}}, "type": "object"}, "CloudForecasterForSixMonthsWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["granularity"], "properties": {"granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}}, "type": "object"}], "x-cs-type-name": "CloudForecasterForSixMonthsWidgetConfiguration"}, "CloudWiseUsageRequest": {"required": ["group_by", "tenant_id", "time_range"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID for the request"}, "service_account_ids": {"type": "array", "items": {"type": "string", "description": "List of service account IDs for the request"}}, "group_by": {"type": "string", "description": "The field by which the usage data is grouped.", "example": "day", "enum": ["day", "month", "year"], "x-cs-enum-type": "CloudWiseUsageGroupBy"}, "is_markup": {"type": "boolean", "description": "Flag to indicate if the cost includes markup"}, "time_range": {"type": "string", "description": "The Range of time for which the usage data is requested.", "example": "Day", "enum": ["Day", "Month"], "x-cs-enum-type": "CloudWiseUsageTimeRange"}, "include_forecast_cost": {"type": "boolean", "description": "Flag to indicate if the cost is projected"}}, "type": "object"}, "CloudWiseUsageResponse": {"properties": {"cost_details": {"type": "array", "description": "List of service name-wise usage data", "items": {"$ref": "#/definitions/ServiceNameWiseUsage"}}, "inventory_details": {"type": "array", "description": "List of inventory-wise usage data", "items": {"$ref": "#/definitions/InventoryWiseUsage"}}}, "type": "object"}, "ClusterFrequencyTimeDetails": {"properties": {"day": {"type": "string", "description": "Cost Resolution Frequency Day"}, "hour": {"type": "string", "description": "Cost Resolution Frequency Hour"}, "minute": {"type": "string", "description": "Cost Resolution Frequency Minute"}}, "type": "object"}, "ColorConfiguration": {"properties": {"segments": {"type": "array", "items": {"$ref": "#/definitions/ColorSegment"}}, "paletteName": {"type": "string"}}, "type": "object"}, "ColorSegment": {"properties": {"color": {"type": "string"}, "stopPoint": {"type": "string", "example": "MIN", "enum": ["MIN", "MIDPOINT", "MAX", "CUSTOM"], "x-cs-enum-type": "ColorStopPoint"}, "stopPointValue": {"type": "integer"}}, "type": "object"}, "CommitDetails": {"properties": {"commit_id": {"type": "string", "description": "Hash Identifier for a commit."}, "parent_commit_id": {"type": "string", "description": "Hash Identifier for a parent commit."}, "commit_date": {"type": "string", "format": "date-time", "description": "Date time at which the commit was committed."}}, "type": "object"}, "CommonCostRequest": {"required": ["currency"], "properties": {"filter": {"$ref": "#/definitions/AccountFilters"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "start_date": {"type": "string", "format": "date-time", "description": "specify the start date. start_date: yyyy-mm-dd"}, "end_date": {"type": "string", "format": "date-time", "description": "specify the end date. end_date: yyyy-mm-dd"}, "time_zone": {"type": "string", "description": "Optional timezone of the caller"}, "time_range": {"$ref": "#/definitions/RangeSelection"}, "query": {"description": "Query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "CompartmentDetailsBase": {"required": ["type"], "properties": {"compartment_id": {"type": "string", "description": "Unique Id"}, "name": {"type": "string", "description": "Display Name"}, "description": {"type": "string", "description": "Description"}, "parent_id": {"type": "string", "description": "Parent Compartment Id"}}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "CompartmentDetailsForOCI", "subtype_name": "CompartmentDetailsForOCI"}]}, "CompartmentDetailsForOCI": {"allOf": [{"$ref": "#/definitions/CompartmentDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CompartmentDetailsForOCI"}, "CompartmentNameQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["compartment_names"], "properties": {"compartment_names": {"type": "array", "description": "Compartment Names to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "CompartmentNameQueryOperator"}, "ComplianceAssessmentHistorySummary": {"required": ["assessment_job_status", "categorized_count", "policy_success_percentage", "status", "total_count"], "properties": {"status": {"type": "string", "description": "Status response of api hit to fetch the summary of compliance assessment."}, "assessment_job_status": {"type": "string", "description": "Status of the assessment job number given as input params."}, "total_count": {"type": "integer", "description": "Totally number of policies in assessment."}, "policy_success_percentage": {"type": "number", "description": "Percentage of policies in success status by total policies in assessment."}, "categorized_count": {"description": "Number of policies status wise detail.", "$ref": "#/definitions/PolicyCounts"}}, "type": "object"}, "ComplianceControlMappingResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "success"}, "message": {"type": "string", "description": "compliance control mappings list"}, "data": {"type": "object", "description": "data for compliance control mappings list"}}, "type": "object"}, "ComplianceControlRequest": {"required": ["cloud_accounts", "compliance_control_uri"], "properties": {"cloud_accounts": {"type": "array", "description": "ID of the cloud account. The ID is unique, it can be obtained from the list cloud account api.", "items": {"type": "string"}}, "compliance_control_uri": {"type": "string", "description": "URI of compliance_control. This can be fetched from controls mapped under standards."}}, "type": "object"}, "ComplianceControlResponse": {"required": ["assessment_jobs_by_account", "message", "status"], "properties": {"status": {"type": "string", "description": "success"}, "message": {"type": "string", "description": "compliance control execute triggered"}, "assessment_jobs_by_account": {"type": "object", "description": "execute data."}}, "type": "object"}, "ComplianceControls": {"properties": {"month": {"type": "string"}, "total_controls": {"type": "integer", "description": "Total number of controls"}, "automated_controls": {"type": "integer", "description": "Total number of automated controls"}, "assessed_controls": {"type": "integer", "description": "Total number of assessed controls"}, "success": {"type": "integer", "description": "Total number of compliance controls"}, "violations": {"type": "integer", "description": "Total number of non-compliance controls"}, "errors": {"type": "integer", "description": "Total number of controls with error"}}, "type": "object"}, "ComplianceDetailsForPoliciesRequest": {"properties": {"tenant_id": {"type": "array", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API", "items": {"type": "string"}}, "services": {"type": "array", "description": "Allowed services", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "cloud_accounts": {"type": "array", "description": "ID of the cloud account. This can be fetched from list cloud accounts API", "items": {"type": "string"}}}, "type": "object"}, "ComplianceDetailsForPoliciesResponse": {"required": ["definition_id", "impact", "page_count", "policy_name", "resolution_status", "resource_counts", "skip_allowed", "total_count"], "properties": {"skip_allowed": {"type": "string", "description": "Skip allowed true/false"}, "resolution_status": {"type": "string", "description": "resolution_status"}, "total_count": {"type": "string", "description": "total_count"}, "page_count": {"type": "string", "description": "page_count"}, "actions": {"type": "array", "description": "actions", "items": {"type": "object"}}, "policy_name": {"type": "string", "description": "policy_name"}, "resource_counts": {"type": "string", "description": "resource_counts"}, "impact": {"type": "string", "description": "impact"}, "definition_id": {"type": "string", "description": "definition_id"}}, "type": "object"}, "ComplianceFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"comp_2504_a_test_flag": {"type": "boolean", "description": "Flag's default value", "default": false}, "comp_2603_a_compliance_standard_simplified": {"type": "boolean", "description": "Flag's default value", "default": true}}, "type": "object"}]}, "ComplianceFilterByPolicyResponse": {"required": ["compliance_standards", "policies", "resource_type", "severity", "tenants"], "properties": {"resource_type": {"type": "array", "description": "Return all of the Resource type given the tenant as input", "items": {"type": "object"}}, "tenants": {"description": "Tenants data for compliance posture filters", "$ref": "#/definitions/ComplianceStandard"}, "policies": {"type": "array", "description": "Policies for compliance posture filters", "items": {"type": "object"}}, "compliance_standards": {"type": "array", "description": "Compliance standards for compliance posture filters", "items": {"type": "object"}}, "severity": {"type": "array", "description": "severity for compliance posture filters", "items": {"type": "object"}}}, "type": "object"}, "ComplianceFilterPolicyResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "success"}, "message": {"type": "string", "description": "Compliance Posture Policies list"}, "data": {"type": "object", "description": "data for Compliance Posture Policies list"}}, "type": "object"}, "ComplianceFilterRequest": {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "Specify the tenant IDs. This can be retrieved using the List Tenants API.", "items": {"type": "string"}}}, "type": "object"}, "ComplianceFilterResponse": {"required": ["tenants"], "properties": {"tenants": {"description": "Tenants data for compliance posture filters", "$ref": "#/definitions/ComplianceStandard"}}, "type": "object"}, "ComplianceMappingResponse": {"required": ["data", "message", "page_count", "status", "total_count"], "properties": {"status": {"type": "string", "description": "success"}, "message": {"type": "string", "description": "compliance control mappings list"}, "total_count": {"type": "string", "description": "Total count"}, "page_count": {"type": "string", "description": "page count"}, "data": {"type": "object", "description": "compliance control mappings list."}}, "type": "object"}, "CompliancePolicyDataCleanUpRequest": {"properties": {"policy_uris": {"type": "array", "description": "Compliance Policy uris", "items": {"type": "string"}}}, "type": "object"}, "CompliancePolicyDataCleanUpResponse": {"properties": {"policy_uris": {"type": "array", "description": "Compliance Policy uris", "items": {"type": "string"}}}, "type": "object"}, "CompliancePostureVisibilityResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "success"}, "message": {"type": "string", "description": "Compliance Standard Visibility For Cloud Account"}, "data": {"type": "object", "description": "data for compliance posture visibility"}}, "type": "object"}, "ComplianceServiceAccountSummary": {"allOf": [{"$ref": "#/definitions/ComplianceTenantSummary"}, {"properties": {"service_account_id": {"type": "string", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "ComplianceServiceAccountSummaryRequest": {"properties": {"filters": {"description": "Query based on Tenant IDs, Cloud Providers, Cloud Account Ids and Compliance URIs", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "ComplianceStandard": {"required": ["cloud_accounts", "id", "name", "services"], "properties": {"services": {"type": "object", "description": "Return all of the Services given the tenant as input"}, "cloud_accounts": {"type": "object", "description": "Return all of the Cloud accounts given the tenant as input"}, "id": {"type": "string", "description": "ID for tenant"}, "name": {"type": "string"}}, "type": "object"}, "ComplianceStandardRequest": {"required": ["cloud_accounts", "compliance_uri"], "properties": {"cloud_accounts": {"type": "array", "description": "ID of the cloud account. The ID is unique, it can be obtained from the list cloud account api.", "items": {"type": "string"}}, "compliance_uri": {"type": "string", "description": "uri of compliance standard This can be fetched from the compliance standards list API call."}}, "type": "object"}, "ComplianceStandardResponse": {"required": ["assessment_jobs_by_account", "message", "status"], "properties": {"status": {"type": "string", "description": "success"}, "message": {"type": "string", "description": "summary listed successfully"}, "assessment_jobs_by_account": {"type": "object", "description": "execute data."}}, "type": "object"}, "ComplianceStandards": {"required": ["compliance_name", "compliance_number", "compliance_uri", "created_at", "created_by", "description", "id", "is_deleted", "is_internal", "logo", "reference", "scope", "updated_at", "updated_by", "valid_service_types", "version"], "properties": {"id": {"type": "string", "description": "ID"}, "is_internal": {"type": "boolean", "description": "is_internal"}, "is_deleted": {"type": "boolean", "description": "is_deleted"}, "description": {"type": "string", "description": "Description for Compliance Standard"}, "reference": {"description": "Reference", "$ref": "#/definitions/ReferenceResponse"}, "compliance_name": {"type": "string", "description": "Name of the Compliance Standard"}, "updated_at": {"type": "string", "description": "Date and Time of Update"}, "created_by": {"type": "string", "description": "Creator of the particular Compliance"}, "version": {"type": "array", "description": "Version", "items": {"type": "string"}}, "compliance_uri": {"type": "string", "description": "Compliance URI"}, "compliance_number": {"type": "string", "description": "Compliance Number"}, "valid_service_types": {"type": "array", "description": "Valid Service Types", "items": {"type": "string"}}, "scope": {"type": "string", "description": "Scope"}, "created_at": {"type": "string", "description": "Date and Time of Creation"}, "updated_by": {"type": "string", "description": "Updated By"}, "logo": {"type": "string", "description": "Logo of standard"}}, "type": "object"}, "ComplianceStandardsResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "Response status for compliance standards"}, "message": {"type": "string", "description": "Response message for compliance standards"}, "data": {"type": "array", "description": "Compliance Standards data list", "items": {"$ref": "#/definitions/ComplianceStandards"}}}, "type": "object"}, "ComplianceSummary": {"required": ["page", "page_count", "records", "total_count"], "properties": {"total_count": {"type": "string"}, "page_count": {"type": "string", "description": "page count"}, "page": {"type": "string", "description": "page"}, "records": {"type": "object", "description": "records"}}, "type": "object"}, "ComplianceSummaryByPoliciesRequest": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "array", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API", "items": {"type": "string"}}, "standards": {"type": "array", "description": "compliance standards to filter policies", "items": {"type": "string"}}, "policy_id": {"type": "array", "description": "policies to  filter", "items": {"type": "string"}}, "services": {"type": "array", "description": "Allowed services", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "cloud_accounts": {"type": "array", "description": "ID of the cloud account. This can be fetched from list cloud accounts API", "items": {"type": "string"}}, "severity": {"type": "array", "description": "severities to filter policies", "items": {"type": "string"}}, "resource_type": {"type": "array", "description": "resource types to filter policies", "items": {"type": "string"}}}, "type": "object"}, "ComplianceSummaryByPoliciesResponse": {"required": ["page_count", "policies", "total_count"], "properties": {"total_count": {"type": "string", "description": "total_count"}, "page_count": {"type": "string", "description": "page_count"}, "policies": {"type": "object", "description": "policies"}}, "type": "object"}, "ComplianceSummaryRequest": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "array", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API", "items": {"type": "string"}}, "services": {"type": "array", "description": "Allowed services", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "cloud_accounts": {"type": "array", "description": "ID of the cloud account. This can be fetched from list cloud accounts API", "items": {"type": "string"}}, "compliance_uri": {"type": "array", "description": "uri of compliance standard This can be fetched from the compliance standards list API call", "items": {"type": "string"}}}, "type": "object"}, "ComplianceTenantSummary": {"properties": {"tenant_id": {"type": "string", "x-cs-type": "ObjectId"}, "compliance_uri": {"type": "string"}, "logo": {"type": "string", "description": "File name of the logo associated with the compliance standard."}, "control_status": {"type": "array", "description": "Compliance control status details", "items": {"$ref": "#/definitions/ComplianceControls"}}}, "type": "object"}, "ComplianceTenantSummaryRequest": {"properties": {"filters": {"description": "Query based on Tenant IDs, Cloud Providers, Cloud Account Ids, Compliance URIs and Duration", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "ComplianceURIQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["compliance_uris"], "properties": {"compliance_uris": {"type": "array", "description": "List of unique identifiers (URIs) for specific compliance standards to filter. This can be fetched from the Compliance Standards List API call.", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ComplianceURIQueryOperator"}, "ComplianceVisibilityResponse": {"required": ["data", "status"], "properties": {"status": {"type": "string", "description": "success"}, "data": {"type": "object", "description": "list of visibility summary."}}, "type": "object"}, "ComplianceVisibilityTrendResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "success"}, "message": {"type": "string", "description": "Compliance Standard Trend"}, "data": {"type": "object", "description": "data for compliance visibility trend"}}, "type": "object"}, "ConfigValidationRequest": {"required": ["policy_engine", "service_name"], "properties": {"policy_engine": {"type": "string", "description": "Supported Policy engines are corestack_policy, aws_config and azure_policy", "example": "corestack_policy", "enum": ["corestack_policy", "aws_organization_policy", "azure_policy", "aws_config", "gcp_organization_policy", "gcp_policy", "kubernetes_policy", "oracle_cloud_guard"], "x-cs-enum-type": "PolicyEngineType"}, "service_name": {"type": "string", "description": "Supported Clouds for the respective Policy engine are AWS and Azure", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "type": "object"}, "ConfigValidationResponse": {"properties": {"status": {"type": "string", "description": "Status response"}, "mandatory_requirements": {"type": "object", "description": "Mandatory requirements", "additionalProperties": {"type": "string"}}, "optional_requirements": {"type": "object", "description": "Optional requirements", "additionalProperties": {"type": "string"}}, "config_validations": {"type": "array", "description": "Config validation results", "items": {"$ref": "#/definitions/ConfigValidationSummary"}}}, "type": "object"}, "ConfigValidationSummary": {"properties": {"region": {"type": "string", "description": "Region"}, "recorder_status": {"type": "string", "description": "Recorder status", "example": "running", "enum": ["running", "not_running", "error"], "x-cs-enum-type": "ConfigValidationRecorderStatus"}, "role_name": {"type": "string", "description": "Role name"}, "availability_status": {"type": "string", "description": "Availability status", "example": "success", "enum": ["success"], "x-cs-enum-type": "ConfigValidationAvailabilityStatus"}}, "type": "object"}, "ConfigurationForAwsConsolidatedChargesReport": {"allOf": [{"$ref": "#/definitions/ConfigurationForFinOpsConsolidatedReport"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ConfigurationForAwsConsolidatedChargesReport"}, "ConfigurationForAzureConsolidatedChargesReport": {"allOf": [{"$ref": "#/definitions/ConfigurationForFinOpsConsolidatedReport"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ConfigurationForAzureConsolidatedChargesReport"}, "ConfigurationForCostAnomalyNotification": {"allOf": [{"$ref": "#/definitions/ConfigurationForNotifications"}, {"properties": {"enable_realtime_notification": {"type": "boolean", "description": "Specifies whether realtime notification enabled or not."}, "enable_daily_summary_notification": {"type": "boolean", "description": "Specifies whether daily summary notification enabled or not."}}, "type": "object"}]}, "ConfigurationForDistributorConsolidatedReport": {"allOf": [{"$ref": "#/definitions/ConfigurationForFinOpsConsolidatedReport"}, {"properties": {"cloud_account_hierarchy": {"type": "boolean", "description": "When true, render the role-scoped Partner -> Customer -> Subscription cloud account hierarchy tree instead of a flat list. The UI surfaces this as a 'Cloud Account Hierarchy' group-by option."}}, "type": "object"}], "x-cs-type-name": "ConfigurationForDistributorConsolidatedReport"}, "ConfigurationForFinOpsConsolidatedReport": {"allOf": [{"$ref": "#/definitions/ConfigurationForNextGenReportBase"}, {"required": ["billing_source", "service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}, "billing_source": {"type": "string", "description": "Billing source to select data from"}, "group_by": {"type": "array", "description": "If set, the dimensions to group results by", "items": {"$ref": "#/definitions/BillingGroupByDetails"}}, "filters": {"description": "Query expression to filter line items", "$ref": "#/definitions/QueryOperator"}, "time_range": {"$ref": "#/definitions/RangeSelection"}, "use_organization_currency": {"type": "boolean", "description": "Use organization currency rules to convert to the configured currency"}, "include_charge_description": {"type": "boolean", "description": "Include charge descriptions in the report."}, "include_usage_and_rate": {"type": "boolean", "description": "Include usage quantity and rate details in the report."}}, "type": "object"}], "x-cs-type-name": "ConfigurationForFinOpsConsolidatedReport"}, "ConfigurationForGcpConsolidatedChargesReport": {"allOf": [{"$ref": "#/definitions/ConfigurationForFinOpsConsolidatedReport"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ConfigurationForGcpConsolidatedChargesReport"}, "ConfigurationForNextGenReportBase": {"allOf": [{"$ref": "#/definitions/ReportConfiguration"}, {"properties": {"limit": {"type": "integer", "description": "If set, limits the results to given number."}}, "type": "object"}], "x-cs-type-name": "ConfigurationForNextGenReportBase"}, "ConfigurationForNotifications": {"properties": {"enabled": {"type": "boolean", "description": "Whether Notifications Are Enabled"}, "emails": {"type": "array", "description": "Emails", "items": {"type": "string"}}, "webhooks": {"type": "array", "description": "Webhooks", "items": {"type": "string"}}, "microsoft_teams_webhooks": {"type": "array", "description": "Microsoft Teams Webhooks", "items": {"type": "string"}}}, "type": "object"}, "ConfigurationForOciConsolidatedChargesReport": {"allOf": [{"$ref": "#/definitions/ConfigurationForFinOpsConsolidatedReport"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ConfigurationForOciConsolidatedChargesReport"}, "ConstraintsRequest": {"properties": {"option": {"type": "string", "description": "Option Value of Tag Details", "example": "new", "enum": ["new", "existing"], "x-cs-enum-type": "ConstraintsOption"}, "type": {"type": "string", "description": "Type of Template Details", "example": "tag", "enum": ["tag"], "x-cs-enum-type": "ConstraintsType"}, "tags": {"type": "object", "description": "Tag keys and Tag values of Template Details. eg) {\"XZV\":[\"ZNCDF\", \"dfsgsg\"]}"}}, "type": "object"}, "ContainerFindingDockleDetails": {"properties": {"code": {"type": "string", "description": "Unique identifier code of the Dockle security rule that was violated"}, "title": {"type": "string", "description": "Human-readable title describing the specific security issue detected by Dockle"}, "level": {"type": "string", "description": "Severity level of the security finding as classified by Dockle", "example": "WARN", "enum": ["WARN", "FATAL", "INFO", "SKIP", "PASS"], "x-cs-enum-type": "ContainerFindingsDockleFindingLevel"}, "alerts": {"type": "array", "description": "List of detailed alert messages and recommendations for resolving the security issue", "items": {"type": "string"}}}, "type": "object"}, "ContainerFindingDockleSummary": {"properties": {"fatal": {"type": "integer", "description": "Total number of fatal security issues found by Dockle that must be addressed"}, "warn": {"type": "integer", "description": "Total number of warning-level security issues found by Dockle that should be reviewed"}, "info": {"type": "integer", "description": "Total number of informational security issues found by Dockle for awareness"}, "skip": {"type": "integer", "description": "Total number of security checks that were skipped during the Dockle scan"}, "pass": {"type": "integer", "description": "Total number of security checks that passed successfully during the Dockle scan"}}, "type": "object"}, "ContainerFindings": {"required": ["__type", "attachment_id", "file_format"], "properties": {"file_format": {"type": "string", "description": "Format of the container security findings file (JSON or plain text)", "example": "json", "enum": ["json", "txt"], "x-cs-enum-type": "ContainerFindingsFileFormat"}, "attachment_id": {"type": "string", "description": "Unique identifier of the attachment containing the container security findings data", "x-cs-type": "ObjectId"}, "parser_status": {"description": "Current parsing status for this specific container security tool", "$ref": "#/definitions/AppSecopsSbomVersionParserStatus"}, "created_by": {"type": "string", "description": "Name of the user who recently created the container findings"}, "updated_by": {"type": "string", "description": "Name of the user who recently updated the container findings"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ContainerFindingsForDockle", "subtype_name": "ContainerFindingsForDockle"}, {"subtype_model": "ContainerFindingsForHadolint", "subtype_name": "ContainerFindingsForHadolint"}]}, "ContainerFindingsBaseFilters": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID to which the findings are associated"}, "filters": {"description": "Query based on SBOM version ID, Category, Execution Phase, Severity and Status", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "ContainerFindingsFiltersSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "sbom_version_ids", "enum": ["sbom_version_ids", "category", "severity", "status"], "x-cs-enum-type": "ContainerFindingsFiltersSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ContainerFindingsForDockle": {"allOf": [{"$ref": "#/definitions/ContainerFindings"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ContainerFindingsForDockle"}, "ContainerFindingsForHadolint": {"allOf": [{"$ref": "#/definitions/ContainerFindings"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ContainerFindingsForHadolint"}, "ContainerFindingsRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/ContainerFindingsFiltersSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ContainerFindingsBaseFilters"}}, "type": "object"}, "ContainerFindingsResponse": {"allOf": [{"$ref": "#/definitions/SecurityFinding"}, {"properties": {"sbom_version_id": {"type": "string", "description": "SBOM version ID to which the findings are associated"}, "code": {"type": "string", "description": "Unique code identifying the specific finding"}, "target": {"type": "string", "description": "Identifies the subject of the scan, can be either Image or Dockerfile"}, "tenant_id": {"type": "string", "description": "Tenant ID to which the findings are associated", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "ContainerIdRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["container_id_regex"], "properties": {"container_id_regex": {"description": "Kubernetes Container ID by regex match (resource_id, resource_group=Container)", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ContainerIdRegexQueryOperator"}, "ControlHealthWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ControlHealthWidgetConfiguration"}, "ControlMappingsListData": {"required": ["Compliance_control_uri", "Compliance_uri", "Control_action_attributes", "Control_attributes", "Control_family", "Control_name", "Id", "Policy_mappings", "Severity"], "properties": {"Control_action_attributes": {"type": "object", "description": "attributes of controls which dictate actions specific to corestack"}, "Control_family": {"type": "string", "description": "security risk family that control belongs to"}, "Compliance_control_uri": {"type": "string", "description": "the unique identifier of the control in the tenant"}, "Control_attributes": {"type": "object", "description": "attributes associated with the controls unique to the standard"}, "Severity": {"type": "string", "description": "severity of control data"}, "Policy_mappings": {"type": "object", "description": "attributes of controls which dictate actions specific to corestack"}, "Compliance_uri": {"type": "string", "description": "the compliance standard associated with the control"}, "Control_name": {"type": "string", "description": "name of the control"}, "Id": {"type": "object", "description": "unique DB id of the control"}}, "type": "object"}, "ControlViolationsWithHighRiskLevelWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ControlViolationsWithHighRiskLevelWidgetConfiguration"}, "ControlViolationsWithStandardCoverageWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ControlViolationsWithStandardCoverageWidgetConfiguration"}, "ControlsListData": {"required": ["Audit_status", "Compliance_control_uri", "Compliance_uri", "Control_action_attributes", "Control_attributes", "Count_of_status", "Id", "Policy_mappings"], "properties": {"Control_action_attributes": {"type": "object", "description": "attributes of controls which dictate actions specific to corestack"}, "Count_of_status": {"type": "integer", "description": "the count of assessed service accounts for the control"}, "Compliance_control_uri": {"type": "string", "description": "the unique identifier of the control in the tenant"}, "Control_attributes": {"type": "object", "description": "attributes associated with the controls unique to the standard"}, "Policy_mappings": {"type": "integer", "description": "count of policies mapped to the control"}, "Compliance_uri": {"type": "string", "description": "the compliance standard associated with the control"}, "Audit_status": {"type": "string", "description": "current audit status of the control"}, "Id": {"type": "object", "description": "unique DB id of the control"}}, "type": "object"}, "ControlsListMappingResponse": {"required": ["Control_records", "Total_count"], "properties": {"Total_count": {"type": "integer", "description": "Number of controls in the standard"}, "Control_records": {"description": "list of application details.", "$ref": "#/definitions/ControlMappingsListData"}}, "type": "object"}, "ControlsListResponse": {"required": ["Control_records", "Total_count"], "properties": {"Total_count": {"type": "integer", "description": "Number of controls in the standard"}, "Control_records": {"description": "list of application details.", "$ref": "#/definitions/ControlsListData"}}, "type": "object"}, "ConversationDetails": {"allOf": [{"$ref": "#/definitions/AgentFieldsBase"}, {"properties": {"chat_id": {"type": "string", "description": "ID of the chat", "x-cs-type": "ObjectId"}, "user_query": {"type": "string", "description": "User query"}, "agent_response": {"description": "Response from the agent", "$ref": "#/definitions/AgentResponse"}, "rating": {"type": "integer", "description": "Rating of the query"}, "is_interrupted": {"type": "boolean", "description": "Indicates if the conversation was interrupted", "default": false}, "is_action_response": {"type": "boolean", "description": "Indicates if the conversation was actionable", "default": false}}, "type": "object"}]}, "ConversationFeedbackRequest": {"properties": {"rating": {"type": "integer", "description": "Rating of the query"}}, "type": "object"}, "CopilotActivityBase": {"allOf": [{"$ref": "#/definitions/CopilotActivityCountBase"}, {"properties": {"lines_of_code_modified": {"type": "integer", "description": "Number of lines of code modified"}, "lines_of_code_suggested_to_modified": {"type": "integer", "description": "Lines of code suggested to modified ratio"}}, "type": "object"}]}, "CopilotActivityCountBase": {"properties": {"code_acceptance_activity_count": {"type": "integer", "description": "Number of code acceptance activities"}, "code_generation_activity_count": {"type": "integer", "description": "Number of code generation activities"}}, "type": "object"}, "CopilotFeatureMetric": {"allOf": [{"$ref": "#/definitions/CopilotMetricActivityBase"}, {"properties": {"name": {"type": "string", "description": "Feature name (e.g. code_completion, agent_edit)"}}, "type": "object"}]}, "CopilotIdeMetric": {"allOf": [{"$ref": "#/definitions/CopilotMetricActivityBase"}, {"properties": {"name": {"type": "string", "description": "IDE name (e.g. vscode, intellij)"}}, "type": "object"}]}, "CopilotLanguageFeatureMetric": {"allOf": [{"$ref": "#/definitions/CopilotMetricActivityBase"}, {"properties": {"feature": {"type": "string", "description": "Feature name (e.g. code_completion, agent_edit)"}, "name": {"type": "string", "description": "Programming language name (e.g. python, javascript)"}}, "type": "object"}]}, "CopilotLanguageMetric": {"allOf": [{"$ref": "#/definitions/CopilotMetricActivityBase"}, {"properties": {"name": {"type": "string", "description": "Programming language name (e.g. python, javascript)"}}, "type": "object"}]}, "CopilotLanguageModelMetric": {"allOf": [{"$ref": "#/definitions/CopilotMetricActivityBase"}, {"properties": {"model": {"type": "string", "description": "AI model name (e.g. gpt-4.1, claude-4.0-sonnet)"}, "name": {"type": "string", "description": "Programming language name (e.g. python, javascript)"}}, "type": "object"}]}, "CopilotLinesOfCodeSummaryBase": {"allOf": [{"$ref": "#/definitions/CopilotActivityCountBase"}, {"properties": {"day": {"type": "string", "format": "date-time", "description": "Date of the metrics record"}, "lines_of_code_added_sum": {"type": "integer", "description": "Total number of lines added"}, "lines_of_code_suggested_sum": {"type": "integer", "description": "Total number of lines suggested"}}, "type": "object"}]}, "CopilotMembers": {"properties": {"service_account_id": {"type": "string", "description": "Service account the member belongs to", "x-cs-type": "ObjectId"}, "github_username": {"type": "string", "description": "GitHub username of the member"}, "github_user_id": {"type": "string", "description": "GitHub user ID of the member"}, "created_at": {"type": "string", "format": "date-time", "description": "Timestamp when the member record was created"}, "touched_at": {"type": "string", "format": "date-time", "description": "Timestamp when the member record was last updated"}, "last_active_at": {"type": "string", "format": "date-time", "description": "Timestamp when the member was last active"}, "plan_type": {"type": "string", "description": "Copilot plan type assigned to the member"}, "is_member": {"type": "boolean", "description": "Whether the member belongs to the organization"}}, "type": "object"}, "CopilotMetricActivityBase": {"allOf": [{"$ref": "#/definitions/CopilotActivityCountBase"}, {"properties": {"lines_of_code_added_sum": {"type": "integer", "description": "Total lines of code added"}, "lines_of_code_deleted_sum": {"type": "integer", "description": "Total lines of code deleted"}, "lines_of_code_suggested_to_add_sum": {"type": "integer", "description": "Total lines of code suggested to add"}, "lines_of_code_suggested_to_delete_sum": {"type": "integer", "description": "Total lines of code suggested to delete"}, "user_initiated_interaction_count": {"type": "integer", "description": "Number of user initiated interactions"}}, "type": "object"}]}, "CopilotMetrics": {"allOf": [{"$ref": "#/definitions/CopilotLinesOfCodeSummaryBase"}, {"properties": {"feature_metrics": {"type": "array", "description": "Activity metrics broken down by feature", "items": {"$ref": "#/definitions/CopilotFeatureMetric"}}, "ide_metrics": {"type": "array", "description": "Activity metrics broken down by IDE", "items": {"$ref": "#/definitions/CopilotIdeMetric"}}, "language_feature_metrics": {"type": "array", "description": "Activity metrics broken down by language and feature", "items": {"$ref": "#/definitions/CopilotLanguageFeatureMetric"}}, "language_metrics": {"type": "array", "description": "Activity metrics broken down by programming language", "items": {"$ref": "#/definitions/CopilotLanguageMetric"}}, "language_model_metrics": {"type": "array", "description": "Activity metrics broken down by programming language and AI model", "items": {"$ref": "#/definitions/CopilotLanguageModelMetric"}}, "model_feature_metrics": {"type": "array", "description": "Activity metrics broken down by model and feature", "items": {"$ref": "#/definitions/CopilotModelFeatureMetric"}}, "service_account_id": {"type": "string", "description": "Service account the metrics belong to", "x-cs-type": "ObjectId"}, "user_id": {"type": "string", "description": "CoreStack internal user ID", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "CopilotModelFeatureMetric": {"allOf": [{"$ref": "#/definitions/CopilotMetricActivityBase"}, {"properties": {"feature": {"type": "string", "description": "Feature name (e.g. code_completion, agent_edit)"}, "name": {"type": "string", "description": "AI model name (e.g. gpt-4.1, claude-4.0-sonnet)"}}, "type": "object"}]}, "CopilotOrgMetrics": {"properties": {"active_seats": {"type": "integer", "description": "Number of active Copilot seats"}, "total_seats": {"type": "integer", "description": "Total number of Copilot seats"}}, "type": "object"}, "CopilotOrgMetricsRequest": {"properties": {"query": {"description": "Query expression to filter results.", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "CopilotOrgMetricsResponse": {"properties": {"org_metrics": {"description": "Organization-level Copilot usage metrics", "$ref": "#/definitions/CopilotOrgMetrics"}}, "type": "object"}, "CopilotTotalsByFeature": {"allOf": [{"$ref": "#/definitions/CopilotActivityBase"}, {"properties": {"feature": {"type": "string", "description": "Feature name (e.g. code_completion)"}, "user_initiated_interaction_count": {"type": "integer", "description": "Number of user initiated interactions"}}, "type": "object"}]}, "CopilotTotalsByIde": {"allOf": [{"$ref": "#/definitions/CopilotActivityBase"}, {"properties": {"ide": {"type": "string", "description": "IDE name (e.g. vscode)"}}, "type": "object"}]}, "CopilotTotalsByLanguageModel": {"allOf": [{"$ref": "#/definitions/CopilotActivityBase"}, {"properties": {"language": {"type": "string", "description": "Programming language (e.g. javascript)"}, "model": {"type": "string", "description": "AI model name (e.g. gpt-4.1)"}}, "type": "object"}]}, "CopilotTotalsByModelFeature": {"allOf": [{"$ref": "#/definitions/CopilotActivityBase"}, {"properties": {"feature": {"type": "string", "description": "Feature name (e.g. code_completion)"}, "model": {"type": "string", "description": "AI model name (e.g. gpt-4.1)"}}, "type": "object"}]}, "CopilotUserMetric": {"allOf": [{"$ref": "#/definitions/CopilotLinesOfCodeSummaryBase"}, {"properties": {"totals_by_feature": {"type": "array", "description": "Activity totals grouped by feature", "items": {"$ref": "#/definitions/CopilotTotalsByFeature"}}, "totals_by_ide": {"type": "array", "description": "Activity totals grouped by IDE", "items": {"$ref": "#/definitions/CopilotTotalsByIde"}}, "totals_by_language_model": {"type": "array", "description": "Activity totals grouped by programming language and AI model", "items": {"$ref": "#/definitions/CopilotTotalsByLanguageModel"}}, "totals_by_model_feature": {"type": "array", "description": "Activity totals grouped by model and feature", "items": {"$ref": "#/definitions/CopilotTotalsByModelFeature"}}, "github_user_id": {"type": "integer", "description": "GitHub user ID"}, "user_initiated_interaction_count": {"type": "integer", "description": "Number of user initiated interactions"}, "github_username": {"type": "string", "description": "GitHub username of the user"}}, "type": "object"}]}, "CopilotUserMetricsRequest": {"allOf": [{"$ref": "#/definitions/CopilotOrgMetricsRequest"}, {"required": ["end_date", "start_date"], "properties": {"start_date": {"type": "string", "format": "date-time", "description": "Start date for the metrics range"}, "end_date": {"type": "string", "format": "date-time", "description": "End date for the metrics range"}}, "type": "object"}]}, "CopilotUserMetricsResponse": {"properties": {"user_metrics": {"type": "array", "description": "Per-user Copilot usage metrics", "items": {"$ref": "#/definitions/CopilotUserMetric"}}}, "type": "object"}, "CostAnomalyAlgorithmRequest": {"required": ["data"], "properties": {"data": {"type": "array", "description": "List of timestamp and value pairs", "items": {"$ref": "#/definitions/CostAnomalyDataPoint"}}}, "type": "object"}, "CostAnomalyAlgorithmResponse": {"required": ["expectedValues", "isAnomaly", "isPositiveAnomaly", "lowerMargins", "upperMargins"], "properties": {"expectedValues": {"type": "array", "description": "Expected values for the bill date.", "items": {"type": "number"}}, "upperMargins": {"type": "array", "description": "Upper Margins", "items": {"type": "number"}}, "lowerMargins": {"type": "array", "description": "Lower Margins", "items": {"type": "number"}}, "isAnomaly": {"type": "array", "description": "Is anomaly detected or not for each value", "items": {"type": "boolean"}}, "isPositiveAnomaly": {"type": "array", "description": "Is positive anomaly for each value", "items": {"type": "boolean"}}}, "type": "object"}, "CostAnomalyBilledCost": {"required": ["bill_date", "cost"], "properties": {"bill_date": {"type": "string", "format": "date-time", "description": "Bill date in yyyy-mm-dd format"}, "cost": {"type": "number", "description": "Billed cost for the bill date."}}, "type": "object"}, "CostAnomalyByCloud": {"properties": {"cloud": {"type": "string"}, "date": {"type": "string", "format": "date"}, "cost_anomaly": {"type": "number"}}, "type": "object"}, "CostAnomalyByCloudRequest": {"allOf": [{"$ref": "#/definitions/CommonCostRequest"}, {"required": ["granularity"], "properties": {"granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}}, "type": "object"}]}, "CostAnomalyByCloudWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["granularity"], "properties": {"granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}}, "type": "object"}], "x-cs-type-name": "CostAnomalyByCloudWidgetConfiguration"}, "CostAnomalyConfiguration": {"properties": {"threshold_configuration": {"description": "threshold configuration.", "$ref": "#/definitions/CostAnomalySetting"}, "notifications": {"type": "array", "description": "Notification configuration.", "items": {"$ref": "#/definitions/ConfigurationForCostAnomalyNotification"}}, "billing_source": {"type": "string", "description": "Base billing metric where the aggregation query will be executed.", "default": "raw_cost", "example": "raw_cost", "enum": ["raw_cost", "raw_effective_cost", "customer_true_cost"], "x-cs-enum-type": "CostAnomalyBillingMetrics"}}, "type": "object"}, "CostAnomalyDataPoint": {"required": ["timestamp", "value"], "properties": {"timestamp": {"type": "string", "format": "date-time", "description": "Bill date in yyyy-mm-dd format"}, "value": {"type": "number", "description": "Billed cost for the bill date."}}, "type": "object"}, "CostAnomalyDimensionTriggerRequest": {"required": ["dimension_id"], "properties": {"dimension_id": {"type": "string", "description": "Dimension ID"}, "grouping_rule_ids": {"type": "array", "items": {"type": "string", "description": "Grouping Rule IDs"}}}, "type": "object"}, "CostAnomalyGroupingRuleAggregate": {"required": ["actual_cost", "anomaly_type", "cost_impact", "expected_cost"], "properties": {"cost_impact": {"type": "number", "description": "Aggregate cost impact for the grouping rule"}, "expected_cost": {"type": "number", "description": "Expected aggregated cost"}, "actual_cost": {"type": "number", "description": "Actual aggregated cost"}, "anomaly_count": {"type": "integer", "description": "Grouping Rule wise anomaly count"}, "anomaly_type": {"type": "string", "description": "Aggregate anomaly type for the grouping rule", "example": "below_threshold", "enum": ["below_threshold", "above_threshold"], "x-cs-enum-type": "CostAnomalyType"}, "upper_bound": {"type": "number", "description": "Upper bound for the aggregate (if applicable)"}, "lower_bound": {"type": "number", "description": "Lower bound for the aggregate (if applicable)"}}, "type": "object"}, "CostAnomalyGroupingRuleDetail": {"required": ["actual_cost", "anomaly_type", "cost_impact", "expected_cost", "product_category", "resource_category", "service_account_id"], "properties": {"anomaly_type": {"type": "string", "description": "Anomaly type for this detail row", "example": "below_threshold", "enum": ["below_threshold", "above_threshold"], "x-cs-enum-type": "CostAnomalyType"}, "anomaly_count": {"type": "integer", "description": "Product category wise anomaly count"}, "cost_impact": {"type": "number", "description": "Cost impact for this anomaly"}, "expected_cost": {"type": "number", "description": "Expected cost for this anomaly"}, "actual_cost": {"type": "number", "description": "Actual cost for this anomaly"}, "service_account_id": {"type": "string", "description": "Service Account ID for this anomaly", "x-cs-type": "ObjectId"}, "product_category": {"type": "string", "description": "Product category, e.g. EC2"}, "resource_category": {"type": "string", "description": "Resource category, e.g. Compute"}, "resource_id": {"type": "string", "description": "Resource identifier, e.g. ec2:i-123"}, "region": {"type": "string", "description": "Region for the resource, e.g. us-east-1"}, "reject_until": {"type": "string", "format": "date-time", "description": "Rejected Until time for the anomaly"}, "reject_reason": {"type": "string", "description": "Rejected Reason"}}, "type": "object"}, "CostAnomalyGroupingRuleRejectRequest": {"required": ["bill_date", "currency", "dimension_id", "grouping_rule_id", "product_category", "reject_reason", "reject_until", "resource_category", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "dimension_id": {"type": "string", "description": "Dimension ID"}, "grouping_rule_id": {"type": "string", "description": "Grouping Rule ID"}, "reject_until": {"type": "string", "format": "date-time", "description": "Reject Until time for the anomaly"}, "reject_reason": {"type": "string", "description": "Rejected Reason"}, "product_category": {"type": "string", "description": "Product Category"}, "resource_category": {"type": "string", "description": "Resource Category"}, "bill_date": {"type": "string", "format": "date-time", "description": "Bill date in yyyy-mm-dd format"}, "currency": {"type": "string", "description": "Billing Currency", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "CostAnomalyGroupingRuleRequest": {"required": ["currency", "dimension_rule_mappings", "end_date", "start_date"], "properties": {"start_date": {"type": "string", "format": "date-time", "description": "specify the start date"}, "end_date": {"type": "string", "format": "date-time", "description": "specify the end date"}, "anomaly_status": {"type": "string", "description": "Required Anomaly status", "example": "active", "enum": ["active", "rejected"], "x-cs-enum-type": "AnomalyStatus"}, "time_zone": {"type": "string", "description": "Optional timezone of the caller"}, "filters": {"description": "Query expression to filter line items", "$ref": "#/definitions/QueryOperator"}, "currency": {"type": "string", "description": "Billing Currency", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "dimension_rule_mappings": {"type": "array", "description": "List of dimensions with their respective grouping rule IDs", "items": {"$ref": "#/definitions/DimensionRuleMapping"}}, "billing_source": {"type": "string", "description": "Records based on the actual metric that is used during anomaly detection"}}, "type": "object"}, "CostAnomalyGroupingRuleResourceLevel": {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "product_category": {"type": "string", "description": "Product Category"}, "resource_category": {"type": "string", "description": "Resource Category"}, "location": {"type": "string", "description": "Region"}, "resource_id": {"type": "string", "description": "Resource ID"}, "billed_cost": {"type": "array", "description": "Billed cost for the resource", "items": {"$ref": "#/definitions/CostAnomalyBilledCost"}}}, "type": "object"}, "CostAnomalyGroupingRuleResponse": {"required": ["bill_date", "billing_source", "currency", "dimension_id", "grouping_rule_id"], "properties": {"dimension_id": {"type": "string", "description": "Dimension id"}, "grouping_rule_id": {"type": "string", "description": "Grouping rule id"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "bill_date": {"type": "string", "format": "date-time", "description": "Bill date / day for this summary"}, "anomaly_summary": {"description": "Aggregate anomaly summary for the grouping rule", "$ref": "#/definitions/CostAnomalyGroupingRuleAggregate"}, "anomaly_details": {"type": "array", "description": "List of individual anomalies under the grouping rule", "items": {"$ref": "#/definitions/CostAnomalyGroupingRuleDetail"}}, "billing_source": {"type": "string", "description": "Records based on the actual metric that is used during anomaly detection"}}, "type": "object"}, "CostAnomalyImpactByBillingWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["categoryType"], "properties": {"categoryType": {"type": "string", "description": "Type of Category", "example": "CloudProvider", "enum": ["CloudProvider", "CloudAccount", "ProductCategory", "ResourceCategory", "TopResource"], "x-cs-enum-type": "CategoryType"}}, "type": "object"}], "x-cs-type-name": "CostAnomalyImpactByBillingWidgetConfiguration"}, "CostAnomalyImpactByCloudAccountWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostAnomalyImpactByCloudAccountWidgetConfiguration"}, "CostAnomalyImpactByEventWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["categoryType"], "properties": {"categoryType": {"type": "string", "description": "Type of Category", "example": "CloudProvider", "enum": ["CloudProvider", "CloudAccount", "ProductCategory", "ResourceCategory", "TopResource"], "x-cs-enum-type": "CategoryType"}}, "type": "object"}], "x-cs-type-name": "CostAnomalyImpactByEventWidgetConfiguration"}, "CostAnomalyImpactTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostAnomalyImpactTrendWidgetConfiguration"}, "CostAnomalyProductCategorySummary": {"allOf": [{"$ref": "#/definitions/CostAnomalySummary"}, {"required": ["product_category", "resource_category"], "properties": {"product_category": {"type": "string", "description": "Name of the Product category"}, "resource_category": {"type": "string", "description": "Name of the Resource category"}}, "type": "object"}]}, "CostAnomalyRejectRequest": {"required": ["bill_date", "product_category", "reject_reason", "reject_until", "resource_category", "service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "bill_date": {"type": "string", "format": "date-time", "description": "Bill date in yyyy-mm-dd format"}, "product_category": {"type": "string", "description": "Product Category name"}, "resource_category": {"type": "string", "description": "Resource Category name"}, "reject_until": {"type": "string", "format": "date-time"}, "reject_reason": {"type": "string"}}, "type": "object"}, "CostAnomalyResourceData": {"required": ["resource_id"], "properties": {"resource_id": {"type": "string", "description": "Name of the resource"}, "billed_cost": {"type": "array", "description": "Billed cost for the resource", "items": {"$ref": "#/definitions/CostAnomalyBilledCost"}}}, "type": "object"}, "CostAnomalyResourceDetails": {"required": ["anomaly_type", "cost_impact", "resource_id"], "properties": {"resource_id": {"type": "string", "description": "Name of the resource"}, "cost_impact": {"type": "number", "description": "Cost incurred by the resource"}, "anomaly_type": {"type": "string", "description": "Anomaly Type of the cost. Example 'anomaly_type':'above_threshold'", "example": "below_threshold", "enum": ["below_threshold", "above_threshold"], "x-cs-enum-type": "CostAnomalyType"}, "anomaly_count": {"type": "integer", "description": "Product category wise anomaly count"}, "upper_cost_bound": {"type": "number", "description": "Upper cost bound of daily cost anomaly summary"}, "lower_cost_bound": {"type": "number", "description": "Lower cost bound of daily cost anomaly summary"}, "expected_cost": {"type": "number", "description": "Expected cost of daily cost anomaly summary"}, "actual_cost": {"type": "number", "description": "Actual cost of daily cost anomaly"}}, "type": "object"}, "CostAnomalyResourcesRequest": {"required": ["end_date", "start_date"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "filters": {"description": "Query expression to filter line items", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "specify the start date"}, "end_date": {"type": "string", "format": "date-time", "description": "specify the end date"}, "time_zone": {"type": "string", "description": "Optional timezone of the caller"}, "billing_source": {"type": "string", "description": "Records based on the actual metric that is used during anomaly detection"}}, "type": "object"}, "CostAnomalyResourcesResponse": {"properties": {"details": {"type": "array", "description": "Cost Anomaly resource wise daily summary", "items": {"$ref": "#/definitions/CostAnomalySummaryResource"}}}, "type": "object"}, "CostAnomalySetting": {"properties": {"category": {"type": "string", "description": "Cost anomaly settings category.", "example": "all", "enum": ["all", "product_category", "resource_category"], "x-cs-enum-type": "CostAnomalySettingCategory"}, "category_values": {"type": "array", "description": "List of categories.", "items": {"type": "string"}}, "minimum_cost_spend": {"type": "integer", "description": "Minimum Cost Spend", "default": 0}, "minimum_cost_impact": {"type": "integer", "description": "Minimum Cost Impact", "default": 0}, "minimum_cost_impact_percentage": {"type": "integer", "description": "Minimum Cost Anomaly Impact Percentage", "default": 0}, "cost_impact_spend_operator": {"type": "string", "description": "Cost Impact and Spend condition", "default": "and", "example": "and", "enum": ["and", "or"], "x-cs-enum-type": "CostImpactSpendOperator"}}, "type": "object"}, "CostAnomalySpendTrendByResourceIdWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostAnomalySpendTrendByResourceIdWidgetConfiguration"}, "CostAnomalySpendTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostAnomalySpendTrendWidgetConfiguration"}, "CostAnomalyStatusQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["anomaly_status"], "properties": {"anomaly_status": {"type": "array", "description": "Cost Anomaly status to include", "items": {"type": "string", "description": "Required Anomaly status", "example": "active", "enum": ["active", "rejected"], "x-cs-enum-type": "AnomalyStatus"}}}, "type": "object"}], "x-cs-type-name": "CostAnomalyStatusQueryOperator"}, "CostAnomalySummary": {"required": ["anomaly_type"], "properties": {"anomaly_type": {"type": "string", "description": "Anomaly Type of the cost. Example 'anomaly_type':'above_threshold'", "example": "below_threshold", "enum": ["below_threshold", "above_threshold"], "x-cs-enum-type": "CostAnomalyType"}, "anomaly_count": {"type": "integer", "description": "Product category wise anomaly count"}, "cost_impact": {"type": "number", "description": "Product category level cost impact"}, "resources": {"type": "array", "description": "Anomalous resource details", "items": {"$ref": "#/definitions/CostAnomalyResourceDetails"}}, "upper_cost_bound": {"type": "number", "description": "Upper cost bound of daily cost anomaly summary"}, "lower_cost_bound": {"type": "number", "description": "Lower cost bound of daily cost anomaly summary"}, "expected_cost": {"type": "number", "description": "Expected cost of daily cost anomaly summary"}, "actual_cost": {"type": "number", "description": "Actual cost of daily cost anomaly"}, "reject_until": {"type": "string", "format": "date-time", "description": "Rejected Until time for the anomaly"}, "reject_reason": {"type": "string", "description": "Rejected Reason"}}, "type": "object"}, "CostAnomalySummaryAccount": {"required": ["bill_date", "billing_source", "cloud_account_id"], "properties": {"cloud_account_id": {"type": "string", "description": "service account id"}, "bill_date": {"type": "string", "format": "date-time", "description": "Time of results"}, "categories": {"type": "array", "description": "categories wise daily cost anomaly summary", "items": {"$ref": "#/definitions/CostAnomalyProductCategorySummary"}}, "service_account_level_anomalies": {"description": "Service account level anomalies", "$ref": "#/definitions/CostAnomalySummary"}, "billing_source": {"type": "string", "description": "Records based on the actual metric that is used during anomaly detection"}}, "type": "object"}, "CostAnomalySummaryRequest": {"required": ["end_date", "start_date"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "filters": {"description": "Query expression to filter line items", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "specify the start date"}, "end_date": {"type": "string", "format": "date-time", "description": "specify the end date"}, "anomaly_status": {"type": "string", "description": "Required Anomaly status", "example": "active", "enum": ["active", "rejected"], "x-cs-enum-type": "AnomalyStatus"}, "time_zone": {"type": "string", "description": "Optional timezone of the caller"}, "billing_source": {"type": "string", "description": "Records based on the actual metric that is used during anomaly detection"}}, "type": "object"}, "CostAnomalySummaryResource": {"required": ["bill_date", "billing_source", "product_category", "resource_category", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "service account id", "x-cs-type": "ObjectId"}, "bill_date": {"type": "string", "format": "date-time", "description": "Time of results"}, "product_category": {"type": "string", "description": "Name of the Product category"}, "resource_category": {"type": "string", "description": "Name of the Resource category"}, "anomalies": {"type": "array", "description": "categories wise daily cost anomaly summary", "items": {"$ref": "#/definitions/CostAnomalyResourceDetails"}}, "billing_source": {"type": "string", "description": "Records based on the actual metric that is used during anomaly detection"}}, "type": "object"}, "CostAnomalySummaryResponse": {"properties": {"details": {"type": "array", "description": "Cost Anomaly account  wise daily summary", "items": {"$ref": "#/definitions/CostAnomalySummaryAccount"}}}, "type": "object"}, "CostAwsEdpConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostAwsEdpConfiguration"}, "CostAzureMaccCommitmentBurndownConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostAzureMaccCommitmentBurndownConfiguration"}, "CostFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"cost_2601_f_budget_trend_widget": {"type": "boolean", "description": "Flag's default value", "default": true}, "cost_2601_a_limit_tags_in_cost_processing": {"type": "boolean", "description": "Flag's default value", "default": true}, "cost_2601_b_flush_balance_verification": {"type": "boolean", "description": "Flag's default value", "default": false}, "cost_2504_b_trend_observability": {"type": "boolean", "description": "Flag's default value", "default": false}, "cost_2602_f_cost_trend_hide_variance": {"type": "boolean", "description": "Flag's default value", "default": true}, "cost_2602_a_billing_inventory_resource_tags": {"type": "boolean", "description": "Flag's default value", "default": true}, "cost_2602_f_oci_compartment_based_cost_121002": {"type": "boolean", "description": "Flag's default value", "default": true}, "cost_2602_b_dimension_grouping_rule_conflict_resolution_119664": {"type": "boolean", "description": "Flag's default value", "default": true}, "cost_2602_f_summary_cloud_plus_k8_cost_spend_widget": {"type": "boolean", "description": "Flag's default value", "default": false}, "cost_2602_b_savings_plans_external_api": {"type": "boolean", "description": "Flag's default value", "default": true}}, "type": "object"}]}, "CostForAzureMaccCommitmentConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostForAzureMaccCommitmentConfiguration"}, "CostImpactByCategoryWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["categoryType"], "properties": {"categoryType": {"type": "string", "description": "Type of Category", "example": "CloudProvider", "enum": ["CloudProvider", "CloudAccount", "ProductCategory", "ResourceCategory", "TopResource"], "x-cs-enum-type": "CategoryType"}}, "type": "object"}], "x-cs-type-name": "CostImpactByCategoryWidgetConfiguration"}, "CostImpactByDimensionGroupWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostImpactByDimensionGroupWidgetConfiguration"}, "CostOptimizationByOptimizationTypeWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["optimizationType"], "properties": {"optimizationType": {"type": "string", "description": "Type of Optimization", "example": "Usage", "enum": ["Usage", "Rate", "Region", "ResourceType"], "x-cs-enum-type": "OptimizationType"}}, "type": "object"}], "x-cs-type-name": "CostOptimizationByOptimizationTypeWidgetConfiguration"}, "CostOptimizationByOptimizationTypes": {"properties": {"cost_savings": {"type": "number", "description": "savings of the optimization types"}, "cost_forecast": {"type": "number", "description": "forecast spend of the optimization type"}, "optimization_type": {"type": "string", "description": "optimization type"}, "cloud_account": {"type": "string", "description": "cloud account id"}, "cloud_provider": {"type": "string", "description": "Cloud Provider for the cloud account", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "region": {"type": "string", "description": "region"}, "resource_name": {"type": "string", "description": "resource name"}, "resource_type": {"type": "string", "description": "resource type"}, "resource_id": {"type": "string", "description": "resource_id"}, "resource_category": {"type": "string", "description": "resource category"}, "optimization_name": {"type": "string", "description": "optimization name"}}, "type": "object"}, "CostOptimizationByOptimizationTypesRequest": {"required": ["currency"], "properties": {"filter": {"$ref": "#/definitions/AccountFilters"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "deduplication": {"type": "boolean", "description": "Deduplication of the data", "default": false}}, "type": "object"}, "CostOptimizationCloudAccTypeResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "Response status on cloud account types"}, "message": {"type": "string", "description": "Listing Cloud account types retrieved successfully"}, "data": {"type": "object", "description": "cloud account type and cloud account name"}}, "type": "object"}, "CostOptimizationCloudAccountSummaryRequest": {"required": ["cloud_account_id", "cloud_account_type", "currency"], "properties": {"page": {"type": "integer", "description": "page number.Example 'page': 1"}, "limit": {"type": "integer", "description": "records limits.Example 'limit': 10"}, "currency": {"type": "string", "description": "currency type"}, "cloud_account_type": {"type": "array", "description": "Cloud account type", "items": {"type": "string"}}, "cloud_account_id": {"type": "array", "description": "Cloud account id", "items": {"type": "string"}}}, "type": "object"}, "CostOptimizationCloudAccountSummaryResponse": {"required": ["overall_savings_percentage", "page_count", "potential_cost_savings_total", "potential_cost_savings_total_info", "total_count"], "properties": {"total_count": {"type": "integer", "description": "Total Count"}, "page_count": {"type": "integer", "description": "Page Count"}, "overall_savings_percentage": {"type": "string", "description": "Total Saving Percentage"}, "potential_cost_savings_total_info": {"type": "string", "description": "Potential cost savings total info"}, "potential_cost_savings_total": {"type": "string", "description": "Potential cost savings total"}, "account_summary": {"type": "array", "items": {"$ref": "#/definitions/AccountSummary"}}}, "type": "object"}, "CostOptimizationCloudAccountTypeRequest": {"required": ["cloud_account_id", "cloud_account_type", "currency"], "properties": {"currency": {"type": "string", "description": "currency type"}, "cloud_account_type": {"type": "array", "description": "Cloud account type", "items": {"type": "string"}}, "cloud_account_id": {"type": "array", "description": "Cloud account id", "items": {"type": "string"}}}, "type": "object"}, "CostOptimizationTenResponse": {"required": ["message", "status", "tenant"], "properties": {"status": {"type": "string", "description": "Response status on tenant details"}, "message": {"type": "string", "description": "Listing tenants data retrieved successfully"}, "tenant": {"type": "object", "description": "tenant details"}}, "type": "object"}, "CostOptimizationTrend": {"properties": {"cloud": {"type": "string", "description": "Cloud Provider", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "cost_forecast": {"type": "number"}, "potential_forecasted_cost": {"type": "number"}, "potential_savings": {"type": "number"}, "date": {"type": "string", "format": "date-time"}}, "type": "object"}, "CostOptimizationTrendRequest": {"required": ["currency"], "properties": {"filter": {"$ref": "#/definitions/AccountFilters"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "CostOptimizationTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostOptimizationTrendWidgetConfiguration"}, "CostOptimizationViewRecommendationRequest": {"required": ["cloud_account_id", "currency"], "properties": {"page": {"type": "integer", "description": "page number.Example 'page': 1"}, "limit": {"type": "integer", "description": "records limits.Example 'limit': 10"}, "cloud_account_id": {"type": "string", "description": "Cloud account id"}, "currency": {"type": "string", "description": "currency type"}}, "type": "object"}, "CostOptimizationViewRecommendationResponse": {"required": ["overall_savings_percentage", "page_count", "potential_cost_savings_total", "potential_cost_savings_total_info", "total_count"], "properties": {"total_count": {"type": "integer", "description": "Total Count"}, "page_count": {"type": "integer", "description": "Page Count"}, "overall_savings_percentage": {"type": "string", "description": "Total Saving Percentage"}, "potential_cost_savings_total_info": {"type": "string", "description": "Potential cost savings total information"}, "potential_cost_savings_total": {"type": "string", "description": "Potential cost savings total"}, "recommendation_data": {"type": "array", "items": {"$ref": "#/definitions/RecommendationView"}}}, "type": "object"}, "CostProcessingMemoryForAws": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingMemoryForAwsPeriod"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForAws"}, "CostProcessingMemoryForAwsPeriod": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"processed_reports": {"type": "array", "description": "Fully processed reports", "items": {"type": "string"}}, "missing_reports": {"type": "array", "description": "Reports listed in the manifest but missing in the S3 bucket", "items": {"type": "string"}}}, "type": "object"}]}, "CostProcessingMemoryForAzure": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingPeriodMemoryForAzure"}}, "pending_reports": {"type": "array", "description": "Requested Billing reports", "items": {"$ref": "#/definitions/CostProcessingMemoryForAzurePendingPeriod"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForAzure"}, "CostProcessingMemoryForAzureCsp": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingPeriodMemoryForAzureCsp"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForAzureCsp"}, "CostProcessingMemoryForAzureEa": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingPeriodMemoryForAzureEa"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForAzureEa"}, "CostProcessingMemoryForAzureMca": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingPeriodMemoryForAzureMca"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForAzureMca"}, "CostProcessingMemoryForAzurePendingPeriod": {"properties": {"period_start": {"type": "string", "format": "date-time", "description": "The start date of the billing period"}, "period_end": {"type": "string", "format": "date-time", "description": "The end date of the billing period"}, "link": {"type": "string", "description": "URL to continuation API"}}, "type": "object"}, "CostProcessingMemoryForGcp": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingPeriodMemoryForGcp"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForGcp"}, "CostProcessingMemoryForKubernetesAgent": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingPeriodMemoryForKubernetesAgent"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForKubernetesAgent"}, "CostProcessingMemoryForOci": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingPeriodMemoryForOci"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForOci"}, "CostProcessingMemoryForSaas": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingMemory"}, {"properties": {"periods": {"type": "array", "description": "Processed billing periods", "items": {"$ref": "#/definitions/CostProcessingPeriodMemoryForSaas"}}}, "type": "object"}], "x-cs-type-name": "CostProcessingMemoryForSaas"}, "CostProcessingPeriodMemoryForAzure": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"oldest_line_item_without_invoice": {"type": "string", "format": "date-time", "description": "Timestamp of oldest entry without an invoice"}, "newest_line_item_with_invoice": {"type": "string", "format": "date-time", "description": "Timestamp of newest entry with an invoice"}}, "type": "object"}]}, "CostProcessingPeriodMemoryForAzureCsp": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"skipped_line_items": {"type": "integer", "description": "Number of skipped line items"}, "invoice_processed": {"type": "boolean", "description": "Processing completed or not"}, "processed_reports": {"type": "array", "description": "Fully processed reports", "items": {"type": "string"}}, "missing_reports": {"type": "array", "description": "Missing reports", "items": {"type": "string"}}}, "type": "object"}]}, "CostProcessingPeriodMemoryForAzureEa": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"processed_reports": {"type": "array", "description": "Fully processed reports", "items": {"type": "string"}}, "missing_reports": {"type": "array", "description": "Missing reports", "items": {"type": "string"}}}, "type": "object"}]}, "CostProcessingPeriodMemoryForAzureMca": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"processed_reports": {"type": "array", "description": "Fully processed reports", "items": {"type": "string"}}, "missing_reports": {"type": "array", "description": "Missing reports", "items": {"type": "string"}}}, "type": "object"}]}, "CostProcessingPeriodMemoryForEksAgent": {"allOf": [{"$ref": "#/definitions/CostProcessingPeriodMemoryForKubernetesAgent"}, {"properties": {}, "type": "object"}]}, "CostProcessingPeriodMemoryForGcp": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"processed_reports": {"type": "array", "description": "Fully processed reports", "items": {"type": "string"}}, "missing_reports": {"type": "array", "description": "Missing reports", "items": {"type": "string"}}}, "type": "object"}]}, "CostProcessingPeriodMemoryForKubernetesAgent": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"processed_files": {"type": "integer", "description": "Number of processed agent files"}, "processed_workloads": {"type": "integer", "description": "Number of processed workload objects"}, "last_processed_agent_file_date": {"type": "string", "format": "date-time", "description": "Datetime of last processed agent file"}, "last_full_refreshed_on": {"type": "string", "format": "date-time", "description": "The date of last full refresh of billing period"}}, "type": "object"}]}, "CostProcessingPeriodMemoryForOci": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"processed_reports": {"type": "array", "description": "Fully processed reports", "items": {"type": "string"}}}, "type": "object"}]}, "CostProcessingPeriodMemoryForSaas": {"allOf": [{"$ref": "#/definitions/BaseCostProcessingPeriodMemory"}, {"properties": {"processed_reports": {"type": "array", "description": "Fully processed reports", "items": {"type": "string"}}, "missing_reports": {"type": "array", "description": "Missing reports", "items": {"type": "string"}}}, "type": "object"}]}, "CostProcessingProgress": {"properties": {"total_records_processed": {"type": "integer", "description": "Total number of records processed from all files"}}, "type": "object"}, "CostProcessingSettings": {"properties": {"max_tag_value_count": {"type": "integer", "description": "Maximum number of unique values per tag to process for cost allocation tags"}, "number_of_months_to_backfill": {"type": "integer", "description": "Back filling value for cost processing (in months)"}}, "type": "object"}, "CostSavingResourceDetails": {"properties": {"currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "saving_per_day": {"type": "number", "description": "Cost saving per day by resource"}, "saving_per_month": {"type": "number", "description": "Cost saving per day by resource"}, "saving_per_year": {"type": "number", "description": "Cost saving per year by resource"}, "updated_at": {"type": "string", "format": "date-time", "description": "Recently Updated time"}}, "type": "object"}, "CostSavings": {"required": ["charge_unit", "cost", "currency_code"], "properties": {"charge_unit": {"type": "string", "description": "Charge Unit"}, "cost": {"type": "integer", "description": "Total cost"}, "currency_code": {"type": "string", "description": "Currency code"}}, "type": "object"}, "CostSavingsBase": {"properties": {"savings_source": {"type": "string", "description": "Indicates the source for the costs saving", "example": "Billing", "enum": ["Billing", "RateCard"], "x-cs-enum-type": "CostSavingSource"}, "start_date": {"type": "string", "format": "date-time", "description": "Time considered for generating the cost saving."}, "end_date": {"type": "string", "format": "date-time", "description": "Time considered for generating the cost saving."}, "unit_of_measure": {"type": "string", "description": "Time considered for generating the cost saving."}, "savings_details": {"type": "array", "items": {"$ref": "#/definitions/CostSavingsMetrics"}}}, "type": "object"}, "CostSavingsMetrics": {"properties": {"saving_per_month": {"type": "number", "description": "Cost of Savings per Month"}, "metric_name": {"type": "string", "description": "Name of the metric"}}, "type": "object"}, "CostSavingsRecommendationsResponse": {"required": ["currency_selected", "saving_wise_summary"], "properties": {"currency_selected": {"type": "string", "description": "Currency Selected"}, "saving_wise_summary": {"description": "data filter selected if any", "$ref": "#/definitions/SavingsWiseSummary"}}, "type": "object"}, "CostSpendByCloudAccountWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostSpendByCloudAccountWidgetConfiguration"}, "CostSpendByCloudResourceWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {"categoryType": {"type": "string", "description": "Type of Category", "example": "CloudProvider", "enum": ["CloudProvider", "CloudAccount", "ProductCategory", "ResourceCategory", "TopResource"], "x-cs-enum-type": "CategoryType"}}, "type": "object"}], "x-cs-type-name": "CostSpendByCloudResourceWidgetConfiguration"}, "CostSpendByCloudTenantWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostSpendByCloudTenantWidgetConfiguration"}, "CostSpendByCloudWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostSpendByCloudWidgetConfiguration"}, "CostSpendByDimensionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseDimensionWidgetConfiguration"}, {"properties": {"selectedAccountId": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "CostSpendByDimensionWidgetConfiguration"}, "CostSpendByHierarchyWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {"groupByDetails": {"$ref": "#/definitions/BillingGroupByDetails"}}, "type": "object"}], "x-cs-type-name": "CostSpendByHierarchyWidgetConfiguration"}, "CostSpendByRegionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostSpendByRegionWidgetConfiguration"}, "CostSpendByTagLevelWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["tagLevelType"], "properties": {"tagLevelType": {"type": "string", "description": "Type of Tag Level", "example": "Overall", "enum": ["Overall", "Cloud", "CloudAccount", "ProductCategory", "Region", "Tenant"], "x-cs-enum-type": "TagLevelType"}}, "type": "object"}], "x-cs-type-name": "CostSpendByTagLevelWidgetConfiguration"}, "CostSummaryWidgetConfigurationModel": {"allOf": [{"$ref": "#/definitions/BaseDataWidgetConfigurationModel"}, {"required": ["summaryType"], "properties": {"summaryType": {"type": "string", "description": "Type of cost summary", "example": "AiAgentActiveAssessments", "enum": ["AiAgentActiveAssessments", "AiAgentTotalAssessments", "AverageCostPerPeriod", "CombinedTotal", "CostOptimizationCloudAccounts", "CostOptimizationImpactedResources", "CostOptimizationPotentialSavings", "CostOptimizationRegions", "DimensionGroupWithMostAnomalies", "MaxPerPeriod", "MinPerPeriod", "TopCloud", "TopGroupBy", "TopRegion", "TopTenant", "Total", "TotalAnomaliesByBilling", "TotalAnomaliesByCloudAccount", "TotalAnomaliesByEvent", "TotalCostImpactByBilling", "TotalCostImpactByCloudAccount", "TotalCostImpactByEvent"], "x-cs-enum-type": "CostSummaryType"}, "groupByDetails": {"description": "Group by used when combined with the TopGroupBy summary type", "$ref": "#/definitions/BillingGroupByDetails"}, "groupByAccountType": {"description": "Type of Cloud Provider Account Type this applies to", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}}, "type": "object"}], "x-cs-type-name": "CostSummaryWidgetConfigurationModel"}, "CostTag": {"properties": {"key": {"type": "string", "description": "Tag key"}, "values": {"type": "array", "description": "Values for the tag key", "items": {"type": "string"}}}, "type": "object"}, "CostTagBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/CostTag"}}}, "type": "object"}, "CostTagListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/CostTagSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/AccountFilters"}}, "type": "object"}, "CostTagSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Key", "enum": ["Key"], "x-cs-enum-type": "CostTagSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "CostTrendByCloudWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["granularity"], "properties": {"granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}}, "type": "object"}], "x-cs-type-name": "CostTrendByCloudWidgetConfiguration"}, "CostTrendByDimensionGroupWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseGroupByDataWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostTrendByDimensionGroupWidgetConfiguration"}, "CostTrendByResourceCategoryWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["granularity"], "properties": {"granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}}, "type": "object"}], "x-cs-type-name": "CostTrendByResourceCategoryWidgetConfiguration"}, "CostTrendForecastWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/CostTrendWidgetConfiguration"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostTrendForecastWidgetConfiguration"}, "CostTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseCostTrendWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostTrendWidgetConfiguration"}, "CostVariationByDimensionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseDimensionWidgetConfiguration"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostVariationByDimensionWidgetConfiguration"}, "CostVariationWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseCostTrendWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CostVariationWidgetConfiguration"}, "CostWiseSummary": {"required": ["AWS", "Azure", "GCP", "total_cost"], "properties": {"total_cost": {"type": "number", "description": "Total cost saved"}, "Azure": {"type": "number", "description": "Cost saved for Azure based on recommendation"}, "AWS": {"type": "number", "description": "Cost saved for AWS based on recommendation"}, "GCP": {"type": "number", "description": "Cost saved for GCP based on recommendation"}}, "type": "object"}, "CostWithCurrency": {"properties": {"cost": {"type": "number", "description": "cost value"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "CountDetailsDataModel": {"required": ["cloud_account", "service"], "properties": {"cloud_account": {"type": "array", "description": "Id's for the cloud account", "items": {"$ref": "#/definitions/CloudAccountDetail"}}, "service": {"type": "string", "description": "Cloud service name", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "default_value": {"type": "boolean", "description": "Default value [by default: false]\nIf default = true, displays count only for that particular default_resource/default_category \nIf default = false, displays count for all the category/resource except that mentioned in default_resource/default_category.", "default": false}, "category": {"type": "string", "description": "Category value [by default: Compute]\n Give this value if the value of identifier is resource.\nDisplays all the resources for the particular category provided."}, "default_resource": {"type": "string", "description": "Default resource [by default: based upon Category]\nGive this value if the value of identifier is resource.\nDisplays count for resource."}, "default_category": {"type": "string", "description": "Default category [by default: Compute]\n Give this value if the value of identifier is category.\nDisplays count for category."}}, "type": "object"}, "CountUserNotificationsResponse": {"required": ["messages", "notifications"], "properties": {"notifications": {"type": "integer", "description": "Number of notifications"}, "messages": {"type": "integer", "description": "Number of messages"}}, "type": "object"}, "CreateAlertTemplateRequest": {"required": ["create_template_name", "is_default", "scope", "service"], "properties": {"service": {"type": "string", "description": "Specify the cloud service"}, "create_template_name": {"type": "string", "description": "Provide the create template name."}, "is_default": {"type": "boolean", "description": "Boolean value to set template as default not not"}, "cloud_account_id": {"type": "array", "description": "Provide cloud_account_id when scope is selected as cloud_account scope", "items": {"type": "string"}}, "regions": {"type": "array", "description": "Select regions when scope is selected as region for an AWS cloud", "items": {"type": "string"}}, "resource_groups": {"type": "array", "description": "Select resource_groups when scope is selected as resource_group for an Azure cloud", "items": {"type": "string"}}, "apply_to_existing_resource": {"type": "boolean", "description": "Select the check box, if wish to apply the configuration for existing resource also"}, "scope": {"type": "string", "description": "scope for the template to be created"}, "constraints": {"description": "Provide the constraints, if the template need to be mapped with constraints", "$ref": "#/definitions/ConstraintsRequest"}}, "type": "object"}, "CreateAlertTemplateResponse": {"required": ["data", "message"], "properties": {"message": {"type": "string", "description": "Create template response"}, "data": {"type": "object", "description": "Create Monitoring Template Details"}}, "type": "object"}, "CreateBackupReport": {"properties": {"span": {"type": "string", "description": "span name", "example": "PreviousMonth", "enum": ["PreviousMonth", "PreviousTwoMonths", "CurrentMonth"], "x-cs-enum-type": "BackupReportSpan"}, "cloud_account_id": {"type": "string", "description": "Specify the Cloud Account ID. This can be fetched from List CloudAccounts API call."}, "tenant_id": {"type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}}, "type": "object"}, "CreateBlueprintDetails": {"properties": {"blueprint_id": {"type": "string", "description": "Blueprint ID"}}, "type": "object"}, "CreateBlueprintRequest": {"required": ["name", "resources", "scope"], "properties": {"name": {"type": "string", "description": "Blueprint Name"}, "resources": {"type": "array", "description": "Resource Details", "items": {"$ref": "#/definitions/ResourceRequest"}}, "scope": {"type": "string", "description": "Scope of the Blueprint", "example": "private", "enum": ["private", "tenant", "global", "account"], "x-cs-enum-type": "BlueprintScope"}}, "type": "object"}, "CreateLineItemTier": {"allOf": [{"$ref": "#/definitions/Tier"}, {"properties": {"percentage": {"type": "number", "description": "Percentage of the tier"}}, "type": "object"}], "x-cs-type-name": "CreateLineItemTier"}, "CreateLockConfigRuleResponse": {"required": ["config_rule_id"], "properties": {"config_rule_id": {"type": "string", "description": "Config rule id"}}, "type": "object"}, "CreateLockFilterRequest": {"properties": {"regions": {"type": "array", "description": "Displays the list of regions", "items": {"$ref": "#/definitions/ScopeFilterRegion"}}, "resources": {"type": "array", "description": "Displays the list of resources", "items": {"type": "string"}}, "resource_groups": {"type": "array", "description": "Displays the list of resource groups", "items": {"$ref": "#/definitions/ScopeResourceGroup"}}, "tags": {"type": "array", "description": "applied tags for lock", "items": {"type": "object"}}, "zone": {"type": "array", "description": "List zone of cloud account", "items": {"$ref": "#/definitions/ScopeFilterZone"}}}, "type": "object"}, "CreateMarkupRequest": {"allOf": [{"$ref": "#/definitions/MarkupDetails"}, {"properties": {}, "type": "object"}]}, "CreateMarkupResponse": {"properties": {"name": {"type": "string", "description": "Created Rule name"}}, "type": "object"}, "CreateMasterAccountRequest": {"allOf": [{"$ref": "#/definitions/MasterAccountBase"}, {"required": ["name", "tenant_name"], "properties": {"name": {"type": "string", "description": "Name of the master account. It can be only alphanumeric"}, "tenant_name": {"type": "string", "description": "Tenant name. It can be only alphanumeric"}, "sso_tenant_id": {"type": "string", "description": "SSO tenant id"}, "third_party_subscription_details": {"description": "Third party subscription details", "$ref": "#/definitions/ThirdPartySubscription"}}, "type": "object"}]}, "CreateMasterAccountResponse": {"properties": {"id": {"type": "string", "description": "Account master id"}, "status": {"type": "string", "description": "Account master status"}, "tenant_id": {"type": "string", "description": "Tenant id"}, "role_info": {"description": "Role info", "$ref": "#/definitions/RoleInfoModel"}}, "type": "object"}, "CreatePolicyRequest": {"required": ["category", "classification", "content", "content_type", "description", "engine_type", "name", "scope", "severity", "sub_classification"], "properties": {"name": {"type": "string", "description": "policy name which is unique and does not allow special character or space"}, "display_name": {"type": "string", "description": "Display name of policy which allow space this is to mostly show on the ui"}, "description": {"type": "string", "description": "A brief explanation of the policy."}, "type": {"type": "array", "description": "Indicates the type of policy", "items": {"type": "string"}}, "category": {"type": "string", "description": "The category will be either service or resource"}, "content": {"type": "string", "description": "The policy content"}, "is_system_policy": {"type": "boolean", "description": "Flag to identify system policies"}, "engine_type": {"type": "string", "description": "Engine type of the policy", "example": "corestack_policy", "enum": ["corestack_policy", "aws_organization_policy", "azure_policy", "aws_config", "gcp_organization_policy", "gcp_policy", "kubernetes_policy", "oracle_cloud_guard"], "x-cs-enum-type": "PolicyEngineType"}, "cloud": {"type": "array", "description": "Displays the cloud associated with the policy", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "classification": {"type": "string", "description": "Policies are classified based on the basis of the activity they perform, for example provisioning, Account Management, Utilization, etc. This value is displayed in this field"}, "sub_classification": {"type": "string", "description": "Sub classification for policy"}, "scope": {"type": "string", "description": "The scope of the policy:\nAccount scope - All users under that account will have access to view and execute Only Account admins can update/delete the policies,\nTenant Scope - Users with access to the specific tenant will have access to policies who can describe or execute policies. Tenant admins can only update/delete.\nPrivate Scope - User who created will only have access", "example": "private", "enum": ["private", "account", "tenant"], "x-cs-enum-type": "AccountScope"}, "content_type": {"type": "string", "description": "Policy content source", "example": "git", "enum": ["git", "file"], "x-cs-enum-type": "ContentType"}, "content_password_or_key": {"type": "string", "description": "Password or private key to access of Git repo if repo is authenticated required only in case of content type git"}, "content_username": {"type": "string", "description": "Username of Git repo if repo is authenticated required only in case of content type git"}, "content_url": {"type": "string", "description": "Git project URL when the content type is git required only in case of content type git"}, "content_path": {"type": "string", "description": "Root path of the policy in git repo required only in case of content type git"}, "severity": {"type": "string", "description": "Severity of policy.", "example": "high", "enum": ["high", "low", "medium"], "x-cs-enum-type": "PolicySeverity"}}, "type": "object"}, "CreateRemediationResponse": {"properties": {"resource_enforce_tag_id": {"type": "string", "description": "Tag Remediation ID"}}, "type": "object"}, "CreateReportRequest": {"properties": {"html": {"type": "string", "description": "HTML content of report"}, "report_generation_url": {"type": "string", "description": "Relative URL used to generate the report."}, "report_configuration": {"description": "Dynamic report configuration. Cannot be used with 'html' field.", "$ref": "#/definitions/ReportConfiguration"}, "user_id": {"type": "string", "description": "User ID of user who requested the report"}, "report_options": {"$ref": "#/definitions/ReportGenerationOptions"}}, "type": "object"}, "CreateResourceLockRequest": {"required": ["cloud", "cloud_account_id", "cloud_account_name", "scope", "tenant_ids"], "properties": {"cloud_account_id": {"type": "string", "description": "cloud_acccount_id"}, "cloud_account_name": {"type": "string", "description": "cloud_account_name"}, "cloud": {"type": "string", "description": "The category will be either service or resource"}, "tenant_ids": {"type": "array", "description": "Displays the list of tenant ids", "items": {"type": "string"}}, "scope": {"type": "string", "description": "Account Scope - For account scope,user can apply lock to particular cloud account,Tenant Scope - Users with tenant can apply lock for multiple tenants., allowed values are tenant, cloud_account"}, "filters": {"type": "array", "description": "filters for cloud _account_scope", "items": {"$ref": "#/definitions/CreateLockFilterRequest"}}, "lock_type": {"type": "string", "description": "lock type"}, "config_rule_id": {"type": "string", "description": "config rule id to enable/disable config rule"}, "action": {"type": "string", "description": "action to enable/disable config rule. allowed values are enable or diable"}}, "type": "object"}, "CreateScheduleResponse": {"properties": {"schedule_id": {"type": "string", "description": "Schedule ID"}}, "type": "object"}, "CreateScriptRequest": {"required": ["category", "config_type", "name", "operating_system", "platform", "scope", "script_info"], "properties": {"name": {"type": "string", "description": "Name of the script and it should be unique."}, "uri": {"type": "string", "description": "Unique URI for script - eg: script/ansi/linux/lamp_install. If not provided, corestack will generate it automatically"}, "description": {"type": "string", "description": "Detailed description about script"}, "category": {"type": "array", "description": "Script Category", "items": {"type": "string", "example": "Application", "enum": ["Application", "Languages", "Database", "Security", "System", "Web Server", "Others"], "x-cs-enum-type": "ScriptCategory"}}, "platform": {"type": "array", "description": "Platforms supported by script.", "items": {"type": "string", "description": ["OS platform of the target machine (linux/windows)"], "example": "linux", "enum": ["linux", "windows"], "x-cs-enum-type": "Platform"}}, "operating_system": {"type": "array", "description": "OS supported by script", "items": {"type": "string", "example": "centos", "enum": ["centos", "ubuntu", "Win-2008(Server)", "Win-2012(Server)", "redhat", "fedora", "debian", "Win-2016(Server)", "Win-7(Desktop)", "Win-8(Desktop)"], "x-cs-enum-type": "Os"}}, "config_type": {"type": "string", "description": "Config type of the script. Create is supported for ansible type scripts alone for now", "example": "ansible", "enum": ["ansible"], "x-cs-enum-type": "ScriptConfigType"}, "scope": {"type": "string", "description": "The scope of the script:\nAccount scope - All users under that account will have access to view and execute Only Account admins can update/delete the scripts,\nTenant Scope - Users with access to the specific tenant will have access to scripts who can describe or execute scripts. Tenant admins can only update/delete.\nPrivate Scope - User who created will only have access", "example": "private", "enum": ["private", "account", "tenant"], "x-cs-enum-type": "AccountScope"}, "script_info": {"type": "array", "description": "script info", "items": {"$ref": "#/definitions/ScriptInfo"}}, "dependencies": {"type": "array", "description": "Details of the dependent scripts if any. For eg., A LAMP script will have apache, mysql, php as dependent scripts.This can be skipped if there are no dependent scripts or if the actual script takes care of installing all dependencies", "items": {"$ref": "#/definitions/ScriptInfo"}}, "minimum_requirement": {"description": "Minimum requirements of the target machine to install the script", "$ref": "#/definitions/ScriptMinimumRequirements"}, "playbook_yaml": {"type": "string", "description": "Playbook yaml path - mandatory for ansible scripts"}}, "type": "object"}, "CreateScriptResponse": {"properties": {"script_id": {"type": "string", "description": "Unique ID of the script"}}, "type": "object"}, "CreateTemplateRequest": {"required": ["classification", "content", "engine_type", "name", "services", "type"], "properties": {"name": {"type": "string", "description": "template name which is unique and does not allow special character or space"}, "description": {"type": "string", "description": "Usage of the template."}, "content": {"type": "string", "description": "The template content"}, "metadata": {"description": "Metadata like file name, file format", "$ref": "#/definitions/MetaDataModel"}, "status": {"type": "string", "description": "Status of the template [active/inactive].\nactive:- Templates which can be executed.\ninactive:- Template which cannot be executed"}, "classification": {"type": "array", "description": "Templates are classified based orchestration actions like Provision, Configure, Backup, Catalog Builder, Deployment, Autoscaling", "items": {"type": "string"}}, "scope": {"type": "string", "description": "The scope of the template:\nAccount scope - All users under that account will have access to view and execute Only Account admins can update/delete the templates,\nTenant Scope - Users with access to the specific tenant will have access to templates who can describe or execute templates. Tenant admins can only update/delete.\nPrivate Scope - User who created will only have access", "example": "private", "enum": ["private", "account", "tenant"], "x-cs-enum-type": "AccountScope"}, "type": {"type": "array", "description": "Type of the template (Cloud, Monitoring, Virtualization)", "items": {"type": "string"}}, "services": {"type": "array", "description": "Displays the service associated with the template, for example, AWS, AzureRM, Openstack., etc", "items": {"type": "string"}}, "engine_type": {"type": "string", "description": "Template formats such as AWS CFN, Azure ARM, Openstack Heat and Mistral", "example": "cfn", "enum": ["cfn", "arm", "terraform", "mistral", "heat", "oracle", "dm"], "x-cs-enum-type": "TemplateEngineType"}, "blueprint_support": {"type": "boolean", "description": "Flag to add template to blueprints"}}, "type": "object"}, "CreateTenantRequest": {"required": ["account_id", "name"], "properties": {"name": {"type": "string", "description": "Name of the new tenant to be created. Tenant Name must be globally unique within CoreStack. If the same tenant name is used in another account, creation wil fail. Tenant Name must start with alphabet and can contain 2-50 characters. Special characters ' \" # ? / \\ are not allowed."}, "description": {"type": "string", "description": "Description of the new tenant to be created."}, "metadata": {"type": "object", "description": "metadata is a freeform JSON. It allows to store custom keys and values. It will be useful for storing information about an external applications that will refer to CoreStack tenant."}, "account_id": {"type": "string", "description": "Id of the CoreStack account under which the new tenant to be created."}}, "type": "object"}, "CurrencyExchangeConfigurationBase": {"properties": {"sysId": {"type": "string", "description": "ID of the Currency Configuration component"}, "created_at": {"type": "string", "format": "date-time", "description": "Created datetime for the component"}, "updated_at": {"type": "string", "format": "date-time", "description": "Updated datetime for the component"}, "created_by": {"type": "string", "description": "Created by user name"}, "updated_by": {"type": "string", "description": "Updated by user name"}}, "type": "object"}, "CurrencyExchangeConfigurationBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/CurrencyExchangeConfigurationDefinition"}}}, "type": "object"}, "CurrencyExchangeConfigurationComponentBase": {"allOf": [{"$ref": "#/definitions/CurrencyExchangeConfigurationBase"}, {"properties": {"master_account_id": {"type": "string", "description": "Master account ID", "x-cs-type": "ObjectId"}, "tenant_ids": {"type": "array", "items": {"type": "string", "description": "Tenant IDs", "x-cs-type": "ObjectId"}}}, "type": "object"}]}, "CurrencyExchangeConfigurationDefinition": {"allOf": [{"$ref": "#/definitions/CurrencyExchangeConfigurationComponentBase"}, {"required": ["configurations", "conversion_type", "is_enabled", "name", "scope", "target_currency"], "properties": {"name": {"type": "string", "description": "Name of Currency Exchange Configuration"}, "description": {"type": "string", "description": "Description of Currency Exchange Configuration"}, "configurations": {"type": "array", "description": "Configured Currency Exchange Configuration", "items": {"$ref": "#/definitions/CurrencyRateConfiguration"}}, "conversion_type": {"type": "string", "description": "Conversion type of currency exchange configuration.", "example": "CustomExchangeRate", "enum": ["CustomExchangeRate", "DynamicExchangeRate", "CsvFileCustomExchangeRate"], "x-cs-enum-type": "CurrencyConversionType"}, "target_currency": {"type": "string", "description": "Target Currency for Exchange Configuration", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "is_enabled": {"type": "boolean", "description": "Is currency exchange enabled"}, "scope": {"type": "string", "description": "Scope of currency exchange configuration.", "example": "Account", "enum": ["Account", "Tenant"], "x-cs-enum-type": "CurrencyConversionScope"}}, "type": "object"}]}, "CurrencyExchangeConfigurationFilter": {"properties": {"tenant_ids": {"type": "array", "items": {"type": "string", "description": "Tenant IDs", "x-cs-type": "ObjectId"}}, "text_filter": {"type": "string", "description": "Text filter used to search names"}, "query": {"description": "Query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "CurrencyExchangeConfigurationListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/CurrencyExchangeConfigurationListSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/CurrencyExchangeConfigurationFilter"}}, "type": "object"}, "CurrencyExchangeConfigurationListSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedOn", "UpdatedOn"], "x-cs-enum-type": "CurrencyExchangeConfigurationListSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "CurrencyExchangeConfigurationQueryScope": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["scopes"], "properties": {"scopes": {"type": "array", "description": "Scopes for Currency Exchange Configuration", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "CurrencyExchangeConfigurationQueryScope"}, "CurrencyExchangeConfigurationQuerySourceCurrency": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["source_currencies"], "properties": {"source_currencies": {"type": "array", "description": "Source Currencies for Currency Exchange Configuration", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "CurrencyExchangeConfigurationQuerySourceCurrency"}, "CurrencyExchangeConfigurationQueryTargetCurrency": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["target_currencies"], "properties": {"target_currencies": {"type": "array", "description": "Target Currencies for Currency Exchange Configuration", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "CurrencyExchangeConfigurationQueryTargetCurrency"}, "CurrencyQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["currencies"], "properties": {"currencies": {"type": "array", "description": "Currencies to include", "items": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}}, "type": "object"}], "x-cs-type-name": "CurrencyQueryOperator"}, "CurrencyRateConfiguration": {"required": ["currency_rate", "start_date"], "properties": {"currency_rate": {"type": "array", "description": "Currency Rate of Currency Exchange Configuration", "items": {"$ref": "#/definitions/ExchangeCurrencyRate"}}, "start_date": {"type": "string", "format": "date-time", "description": "Start date of the Currency Exchange Configuration"}, "end_date": {"type": "string", "format": "date-time", "description": "End date of the Currency Exchange Configuration"}}, "type": "object"}, "CustomMetricConfigurationBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/CustomMetricConfigurationDetails"}}}, "type": "object"}, "CustomMetricConfigurationDetails": {"required": ["metric_namespace", "resource", "resource_category", "resource_type", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Cloud Account Id for which custom metrics needs to be created.", "x-cs-type": "ObjectId"}, "regions": {"type": "array", "description": "Region in which custom metrics to be created.", "items": {"type": "string"}}, "resource_category": {"type": "string", "description": "Name of the Resource category."}, "resource_type": {"type": "string", "description": "Type of the Resource."}, "resource": {"type": "string", "description": "Name of the Resource."}, "metric_namespace": {"type": "string", "description": "The namespace for the metric specified in metric_name."}, "metric_name": {"type": "string", "description": "The name for the metric associated with the alarm."}, "status": {"type": "string", "description": "Status of the custom Metric Configuration", "example": "completed", "enum": ["completed", "pending", "in_progress", "error"], "x-cs-enum-type": "CustomMetricConfigurationStatus"}, "threshold": {"type": "integer", "description": "The value against which the specified statistics is compared."}, "comparison_operator": {"type": "string", "description": "The arithmetic operation to use when comparing the specified statistics and threshold.", "example": "GreaterThanOrEqualTo", "enum": ["GreaterThanOrEqualTo", "GreaterThan", "LessThanOrEqualTo", "LessThan"], "x-cs-enum-type": "CustomMetricThresholdOperator"}, "statistic": {"type": "string", "description": "The statistics for the metric specified in MetricName.", "example": "Average", "enum": ["Average", "Maximum", "Minimum", "SampleCount", "Sum"], "x-cs-enum-type": "CustomMetricStatistics"}, "period": {"type": "integer", "description": "Length in seconds used each time when metric is evaluated. Valid values are 10, 30 and any multiple of 60."}, "evaluation_period": {"type": "integer", "description": "The number of periods over which data is compared to the specified threshold."}, "priority": {"type": "integer", "description": "Order of priority if there is multiple rules for same metric under a cloud account for a region"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "events": {"type": "array", "description": "List events for a selected resource in Event subscription", "items": {"type": "string", "description": "List of events in event subscription", "example": "maintenance", "enum": ["maintenance", "failure", "migration", "backtrack", "backup", "deletion", "restoration", "availability", "recovery", "failover", "notification", "read_replica", "creation", "low_storage", "configuration_change"], "x-cs-enum-type": "EventSubscriptionResourceType"}}}, "type": "object"}, "CustomMetricConfigurationListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/CustomMetricConfigurationListRequestSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/CustomMetricConfigurationListRequestContext"}}, "type": "object"}, "CustomMetricConfigurationListRequestContext": {"properties": {"tenant_id": {"type": "string", "description": "Tenant id to filter configurations.", "x-cs-type": "ObjectId"}, "service_account_id": {"type": "string", "description": "Cloud Account Id  associated with custom metrics.", "x-cs-type": "ObjectId"}, "regions": {"type": "array", "description": "Region in which custom metrics were created", "items": {"type": "string"}}, "resource": {"type": "string", "description": "Name of the Resource."}, "metric_namespace": {"type": "string", "description": "The namespace for the metric specified in metric_name."}, "status": {"type": "string", "description": "Status of the custom Metric Configuration", "example": "completed", "enum": ["completed", "pending", "in_progress", "error"], "x-cs-enum-type": "CustomMetricConfigurationStatus"}}, "type": "object"}, "CustomMetricConfigurationListRequestSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CreatedAt", "enum": ["CreatedAt"], "x-cs-enum-type": "CustomMetricConfigurationListRequestSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "CustomMetricConfigurationSyncRequest": {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Cloud Account ID for which the sync to be triggered.", "x-cs-type": "ObjectId"}}, "type": "object"}, "CustomerDashboardReportModel": {"required": ["data"], "properties": {"data": {"type": "object", "description": "catalog type"}}, "type": "object"}, "CustomerGuessForCostRange": {"properties": {"maximum": {"description": "Maximum cost of the stack version", "$ref": "#/definitions/CostWithCurrency"}, "minimum": {"description": "Minimum cost of the stack version", "$ref": "#/definitions/CostWithCurrency"}, "extra_costs": {"type": "array", "description": "Additional costs of a stack version", "items": {"$ref": "#/definitions/StacksMarketplaceAdditionalCostComponent"}}}, "type": "object"}, "CvssMetricScoreRangeQueryOperator": {"allOf": [{"$ref": "#/definitions/AppSecopsScoreRangeQueryOperator"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "CvssMetricScoreRangeQueryOperator"}, "DashboardBannerSegment": {"properties": {"widthRatio": {"type": "integer"}, "branding": {"$ref": "#/definitions/BrandingConfiguration"}}, "type": "object"}, "DashboardConfiguration": {"properties": {"title": {"type": "string"}, "description": {"type": "string"}, "showTitle": {"type": "boolean"}, "widgetPrimaryColor": {"type": "string"}, "widgetSecondaryColor": {"type": "string"}, "flavor": {"type": "string", "description": "Flavor of the dashboard", "example": "AiAgents", "enum": ["AiAgents", "AppSecOps", "FinOps", "Governance", "SecOps"], "x-cs-enum-type": "DashboardFlavor"}, "cloud": {"type": "string", "description": "Cloud provider for the dashboard. If not specified, the dashboard is considered multi-cloud.", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "platform": {"type": "string", "description": "Platform for the dashboard. If not specified, the dashboard is considered multi-platform.", "example": "kubernetes", "enum": ["kubernetes"], "x-cs-enum-type": "Platforms"}, "saas": {"type": "array", "items": {"type": "string", "description": "Saas tools for the dashboard. If not specified, the dashboard is considered multi-SaaS.", "example": "Anthropic", "enum": ["Anthropic", "OpenAI", "Databricks", "Snowflake", "CircleCI", "Datadog", "Dropbox", "Dynatrace", "Elastic", "Grafana", "IBM_Tencent", "Microsoft_Teams", "New_Relic", "Okta", "SaasCustomTool", "Salesforce_Sales_Cloud", "Splunk"], "x-cs-enum-type": "SaasServiceName"}}, "clusterType": {"type": "string"}, "bannerSegments": {"type": "array", "items": {"$ref": "#/definitions/DashboardBannerSegment"}}, "widgets": {"type": "array", "items": {"$ref": "#/definitions/WidgetComposition"}}, "portalFilter": {"$ref": "#/definitions/FilterWidgetConfiguration"}, "filterScope": {"type": "array", "description": "Scope for the data available in the dashboard", "items": {"$ref": "#/definitions/DashboardScopeNode"}}, "savedViews": {"type": "array", "items": {"$ref": "#/definitions/SavedView"}}, "serviceAccountEvaluationMode": {"type": "string", "description": "If not specified, the dashboard is considered eagerly evaluated", "example": "Lazy", "enum": ["Lazy", "Eager"], "x-cs-enum-type": "ServiceAccountEvaluationMode"}}, "type": "object"}, "DashboardDefinition": {"allOf": [{"$ref": "#/definitions/BaseDefinition"}, {"properties": {"user": {"$ref": "#/definitions/RecordIdentity"}}, "type": "object"}]}, "DashboardDefinitionAcl": {"properties": {"entries": {"type": "array", "items": {"$ref": "#/definitions/DashboardDefinitionAclEntry"}}, "portalPath": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "DashboardDefinitionAclContext": {"properties": {"is_product_admin": {"type": "boolean", "description": "True if user has product admin role"}, "is_account_admin": {"type": "boolean", "description": "True if user has account admin role"}, "product_bundles": {"type": "array", "description": "Product bundles for the user", "items": {"type": "string"}}, "role_types": {"type": "array", "description": "Role types for the user", "items": {"$ref": "#/definitions/DashboardDefinitionAclRoleType"}}, "roles": {"type": "array", "description": "Roles for the user", "items": {"$ref": "#/definitions/DashboardDefinitionAclRole"}}, "accounts": {"type": "array", "description": "Accounts for the user", "items": {"$ref": "#/definitions/DashboardDefinitionAclContextDetails"}}, "tenants": {"type": "array", "description": "Tenants for the user", "items": {"$ref": "#/definitions/DashboardDefinitionAclContextDetails"}}}, "type": "object"}, "DashboardDefinitionAclContextDetails": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}, "DashboardDefinitionAclEntry": {"required": ["scope"], "properties": {"users": {"type": "array", "items": {"type": "string"}}, "user_groups": {"type": "array", "items": {"type": "string"}}, "granted": {"type": "array", "description": "Actions granted for matching users", "items": {"type": "string"}}, "denied": {"type": "array", "description": "Actions denied for matching users", "items": {"type": "string"}}}, "discriminator": "scope", "type": "object", "x-cs-subtypes": [{"subtype_model": "DashboardDefinitionAclEntryGlobal", "subtype_name": "global"}, {"subtype_model": "DashboardDefinitionAclEntryTenant", "subtype_name": "tenant"}, {"subtype_model": "DashboardDefinitionAclEntryAccount", "subtype_name": "account"}]}, "DashboardDefinitionAclEntryAccount": {"allOf": [{"$ref": "#/definitions/DashboardDefinitionAclEntry"}, {"properties": {"account_id": {"type": "string"}, "role_types": {"type": "array", "items": {"$ref": "#/definitions/DashboardDefinitionAclRoleType"}}}, "type": "object"}], "x-cs-type-name": "account"}, "DashboardDefinitionAclEntryGlobal": {"allOf": [{"$ref": "#/definitions/DashboardDefinitionAclEntry"}, {"properties": {"role_types": {"type": "array", "items": {"$ref": "#/definitions/DashboardDefinitionAclRoleType"}}}, "type": "object"}], "x-cs-type-name": "global"}, "DashboardDefinitionAclEntryTenant": {"allOf": [{"$ref": "#/definitions/DashboardDefinitionAclEntry"}, {"properties": {"account_id": {"type": "string"}, "tenant_id": {"type": "string"}, "roles": {"type": "array", "items": {"$ref": "#/definitions/DashboardDefinitionAclRole"}}}, "type": "object"}], "x-cs-type-name": "tenant"}, "DashboardDefinitionAclEval": {"properties": {"is_owner": {"type": "boolean", "description": "True if user is the owner of the dashboard"}, "granted": {"type": "array", "description": "Actions granted to user", "items": {"type": "string"}}}, "type": "object"}, "DashboardDefinitionAclRole": {"properties": {"id": {"type": "string"}, "tenant_id": {"type": "string"}, "name": {"type": "string"}}, "type": "object"}, "DashboardDefinitionAclRoleType": {"properties": {"product_bundle": {"type": "string"}, "role_type": {"type": "string"}}, "type": "object"}, "DashboardDefinitionToPortal": {"properties": {"dashboard_id": {"type": "string"}, "portalPath": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "DashboardDefinitionVersion": {"allOf": [{"$ref": "#/definitions/BaseDefinitionVersion"}, {"properties": {"details": {"description": "Details of the version", "$ref": "#/definitions/DashboardConfiguration"}}, "type": "object"}]}, "DashboardReport": {"allOf": [{"$ref": "#/definitions/DashboardReportScheduleRequest"}, {"properties": {"sys_id": {"type": "string", "description": "Unique ID for the report"}, "background_job": {"description": "Identity of the background job used to generate the report, null if the job has completed", "$ref": "#/definitions/RecordIdentity"}, "attachment_id": {"type": "string", "description": "ID of the attachment where the report contents are stored."}}, "type": "object"}]}, "DashboardReportCreateRequest": {"required": ["report_configuration"], "properties": {"report_configuration": {"description": "Report configuration to generate report", "$ref": "#/definitions/ReportConfigurationForExecutiveDashboard"}}, "type": "object"}, "DashboardReportScheduleRequest": {"allOf": [{"$ref": "#/definitions/DashboardReportCreateRequest"}, {"required": ["user_id"], "properties": {"user_id": {"type": "string", "description": "User ID of user who scheduled the report"}, "schedule_id": {"type": "string", "description": "Schedule ID of which the report to be generated", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "DashboardScopeNode": {"required": ["visible"], "properties": {"visible": {"type": "boolean", "description": "whether filter dimension remains configurable in the dashboard"}, "condition": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "DashboardViewState": {"allOf": [{"$ref": "#/definitions/ViewState"}, {"properties": {"widgets": {"type": "array", "items": {"$ref": "#/definitions/WidgetViewState"}}}, "type": "object"}], "x-cs-type-name": "DashboardViewState"}, "DataContext": {"properties": {"filter": {"$ref": "#/definitions/AccountFilters"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "organizationCurrency": {"type": "boolean", "description": "Use organization currency rules to convert to the configured currency"}, "timeRange": {"$ref": "#/definitions/RangeSelection"}, "query": {"description": "Advanced query based filters. If present, will be used instead of hierarchical filters.", "$ref": "#/definitions/QueryOperator"}, "billingSource": {"type": "string", "description": "Billing source for the data"}, "granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}, "overrideQuery": {"type": "boolean"}, "overrideBillingSource": {"type": "boolean"}, "overrideGranularity": {"type": "boolean"}, "overrideTenants": {"type": "boolean"}, "overrideCloudProviders": {"type": "boolean"}, "overrideCloudAccounts": {"type": "boolean"}, "overrideCurrency": {"type": "boolean"}, "overrideTimeRange": {"type": "boolean"}, "overrideRegions": {"type": "boolean"}, "overrideProductCategories": {"type": "boolean"}, "hideBillingSource": {"type": "boolean"}, "hideGranularity": {"type": "boolean"}, "hideTenants": {"type": "boolean"}, "hideCloudProviders": {"type": "boolean"}, "hideCloudAccounts": {"type": "boolean"}, "hideCurrency": {"type": "boolean"}, "hideTimeRange": {"type": "boolean"}, "hideRegions": {"type": "boolean"}, "hideProductCategories": {"type": "boolean"}}, "type": "object"}, "DatatableColumnConfiguration": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}, "enabled": {"type": "boolean"}}, "type": "object"}, "DatatableConfiguration": {"properties": {"columns": {"type": "array", "items": {"$ref": "#/definitions/DatatableColumnConfiguration"}}}, "type": "object"}, "DateAndTimeDetails": {"required": ["dayofmonth", "month", "time", "weekday", "year"], "properties": {"month": {"type": "string", "description": "Month when the Template/Script/Policy is scheduled to run. Allowed values: 01-12"}, "time": {"description": "Time when the Template/Script/Policy is scheduled to run.", "$ref": "#/definitions/TimeDetails"}, "dayofmonth": {"description": "At which day of that month the Template/Script/Policy is scheduled to run.Note - weekday and dayofmonth are alternate.Allowed values: 01-31", "$ref": "#/definitions/DayDetails"}, "weekday": {"description": "At which day of that week the Template/Script/Policy is scheduled to run.Note - weekday and dayofmonth are alternate.Allowed values: 01-07", "$ref": "#/definitions/DayDetails"}, "year": {"type": "string", "description": "Year when the Template/Script/Policy is scheduled to run. Example:'year':'2022'"}}, "type": "object"}, "DayDetails": {"required": ["day"], "properties": {"day": {"type": "string", "description": "At which day of that month the Template/Script/Policy is scheduled to run.Allowed values: 01-31"}}, "type": "object"}, "DeleteLockConfigRuleRequest": {"properties": {"config_rule_id": {"type": "string", "description": "Config rule id, it can be fetched from List Resource Lock Config Rules API"}}, "type": "object"}, "DeleteMarkupResponse": {"properties": {"name": {"type": "string", "description": "Deleted Rule name"}}, "type": "object"}, "DeniedRolesAndUserGroups": {"properties": {"role_ids": {"type": "array", "description": "Role IDs explicitly denied access", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "user_group_ids": {"type": "array", "description": "User groups explicitly denied access", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "DependentDimension": {"required": ["dimension_id", "grouping_rule_ids"], "properties": {"dimension_id": {"type": "string", "description": "Id of the Dependent Dimension"}, "grouping_rule_ids": {"type": "array", "description": "Ids of the Dependent Dimension Grouping rules", "items": {"type": "string"}}, "priority": {"type": "integer", "description": "Priority of the Dependent Dimension Grouping Rule for evaluation order", "default": 0}}, "type": "object"}, "DependentResourcesListResponse": {"properties": {"resource_name": {"type": "string", "description": "Resource name for which associated resources are captured."}, "dependent_resources": {"type": "object", "description": "Associated resources"}}, "type": "object"}, "DescendantServiceAccountInTenantQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "Tenant IDs associated with the ancestor service accounts of matching accounts.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "DescendantServiceAccountInTenantQueryOperator"}, "DescendantServiceAccountQuery": {"required": ["service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service account IDs that belong to the ancestors of matching accounts.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "include_self": {"type": "boolean", "description": "Include the given service accounts in the result set"}, "include_billing_as_parent": {"type": "boolean", "description": "Also include accounts whose billing_account_id matches any of the given accounts."}, "include_resource_as_parent": {"type": "boolean", "description": "Also include accounts whose resource_service_account_id matches any of the given accounts."}, "include_commercial_as_parent": {"type": "boolean", "description": "Also include AWS GovCloud accounts whose commercial_account_id matches any of the given accounts."}, "exclude_service_account_ids": {"type": "array", "description": "Service account IDs to excluded with descendants.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "DescendantServiceAccountQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service account IDs that belong to the ancestors of matching accounts.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "include_self": {"type": "boolean", "description": "Include the given service accounts in the result set"}, "include_billing_as_parent": {"type": "boolean", "description": "Also include accounts whose billing_account_id matches any of the given accounts."}, "include_resource_as_parent": {"type": "boolean", "description": "Also include accounts whose resource_service_account_id matches any of the given accounts."}, "include_commercial_as_parent": {"type": "boolean", "description": "Also include AWS GovCloud accounts whose commercial_account_id matches any of the given accounts."}, "exclude_service_account_ids": {"type": "array", "description": "Service account IDs to excluded with descendants.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "DescendantServiceAccountQueryOperator"}, "DescriptorForRecommendation": {"allOf": [{"$ref": "#/definitions/RecommendationBase"}, {"properties": {"definition_sys_id": {"type": "string", "description": "Definition System ID"}, "touched_at": {"type": "string", "format": "date-time", "description": "Document updated Time"}, "impact": {"type": "string", "description": "Impact of the policy resource recommendation", "example": "critical", "enum": ["critical", "high", "informational", "low", "medium", "uncategorized"], "x-cs-enum-type": "PolicyResourceRecommendationImpact"}, "status": {"type": "string", "description": "Indicates the status of the recommendation which has been generated in corestack", "example": "open", "enum": ["open", "system_skipped", "user_rejected", "resolve_validation_pending", "resolved", "closed"], "x-cs-enum-type": "ResourceRecommendationStatus"}, "event_at": {"type": "string", "format": "date-time", "description": "Date and time when the recommendation was generated/resolved."}, "remarks": {"type": "string", "description": "Additional information which needs to be manually posted by the customers."}, "service_account_id": {"type": "string", "description": "Service Account Id", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "DescriptorForRecommendation"}, "DescriptorForResourceRecommendation": {"allOf": [{"$ref": "#/definitions/DescriptorForRecommendation"}, {"properties": {"resource_id": {"type": "string", "description": "Resource ID"}, "resource_name": {"type": "string", "description": "Resource Name"}, "service_resource_uri": {"type": "string", "description": "service resource uri of the recommendation definition"}, "inventory_id": {"type": "string", "description": "id for the resource inventory", "x-cs-type": "ObjectId"}, "resource_location": {"type": "string", "description": "region for the resource"}, "resource_filter": {"type": "string", "description": "Global filter for the resource"}, "inventory_tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}]}, "DetailTenantModel": {"required": ["id", "is_default", "name", "policy", "roles", "service_accounts", "services"], "properties": {"id": {"type": "string", "description": "Id of the tenant. This will be used for performing tenant level operations such as createPolicy, createScript, onboardCloudAccount and so on."}, "name": {"type": "string", "description": "Unique name of the tenant provided as input when creating."}, "roles": {"type": "array", "description": "Roles for a particular tenant", "items": {"$ref": "#/definitions/Role"}}, "is_default": {"type": "boolean", "description": "If user created under particular tenant it will be set to True or else False"}, "service_accounts": {"type": "array", "description": "Entitlements for a particular tenant", "items": {"type": "string"}}, "policy": {"type": "object", "description": "Policy for a particular tenant", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "services": {"type": "object", "description": "Services applicable for a particular tenant", "additionalProperties": {"type": "array", "items": {"type": "string"}}}, "dimension_settings": {"type": "array", "description": "Dimension settings for a particular tenant", "items": {"$ref": "#/definitions/DimensionTenantSettings"}}}, "type": "object"}, "DetailsRequest": {"required": ["all_tenants"], "properties": {"tenant_id": {"type": "string", "description": "ID of the tenant to filter the violation detail.\nPlease get tenant_id from cloud_accounts of AccessVisibilityFilters in Access Visibility Dashboard"}, "cloud_account_id": {"type": "string", "description": "ID of the cloud account to filter the violation detail.\nPlease get cloud_account_id from cloud_accounts of AccessVisibilityFilters in Access Visibility Dashboard"}, "all_tenants": {"type": "string", "description": "To get violations from all the tenants, please give Yes. If selected No, then it is mandatory to provide tenant_id and cloud_account_id", "example": "Yes", "enum": ["Yes", "No"], "x-cs-enum-type": "YesNo"}, "search": {"type": "string", "description": "Search by account_name wise"}}, "type": "object"}, "DetailsResponse": {"required": ["details", "page_count", "total_count"], "properties": {"total_count": {"type": "integer", "description": "Total violations count"}, "page_count": {"type": "string", "description": "Page count for the violations"}, "details": {"type": "array", "description": "Details of the violation", "items": {"type": "object"}}}, "type": "object"}, "DimensionBudgetWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseGroupByDataWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "DimensionBudgetWidgetConfiguration"}, "DimensionDefinition": {"allOf": [{"$ref": "#/definitions/BaseDefinition"}, {"required": ["dimension_template_type", "dimension_type", "is_active", "name", "source"], "properties": {"owner": {"type": "string", "description": "Owner of the dimension definition"}, "is_active": {"type": "boolean", "description": "States if the Dimension Definition is active or not"}, "name": {"type": "string", "description": "Name of the Dimension Definition"}, "description": {"type": "string", "description": "Description of Dimension Definition"}, "master_account_id": {"type": "string", "description": "Master account ID", "x-cs-type": "ObjectId"}, "source": {"type": "string", "description": "Source of  Dimension Definition", "example": "Billing", "enum": ["Billing"], "x-cs-enum-type": "DimensionSource"}, "dimension_type": {"type": "string", "description": "Type of  Dimension Definition", "example": "AccountGroup", "enum": ["AccountGroup", "Custom", "Lens", "Service", "VirtualTags"], "x-cs-enum-type": "DimensionType"}, "dimension_template_type": {"type": "string", "description": "Type of  Dimension Definition Template Used", "example": "Custom", "enum": ["Custom", "Default", "Global"], "x-cs-enum-type": "DimensionTemplateType"}, "is_cost_anomaly_detection_enabled": {"type": "boolean", "description": "If True, Cost Anomaly Detection will be enabled for all grouping rules under this Dimension", "default": false}}, "type": "object"}]}, "DimensionDefinitionBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/DimensionDefinition"}}}, "type": "object"}, "DimensionDefinitionConfiguration": {"required": ["end_date", "start_date"], "properties": {"start_date": {"type": "string", "format": "date-time", "description": "Start date of the Dimension Definition"}, "end_date": {"type": "string", "format": "date-time", "description": "End date of the Dimension Definition"}, "enable_cost_center": {"type": "boolean", "description": "Is cost center enabled for the Dimension Definition"}, "attributes": {"type": "array", "description": "Configured attributes for Dimension Definition", "items": {"$ref": "#/definitions/AttributeDefinitionBase"}}, "access_granted_identities": {"description": "Identities allowed to access this Dimension Definition", "$ref": "#/definitions/AccessGrantedRolesAndUserGroups"}, "grouping_rules": {"type": "array", "description": "Configured grouping rule for Dimension Definition", "items": {"$ref": "#/definitions/DimensionGroupingRule"}}, "precompute": {"type": "boolean", "description": "Enable precomputation tagging of Dimension tagging on billing line items", "default": false}, "include_unallocated_cost": {"type": "boolean", "description": "Enable Unallocated Cost grouping rule for this Dimension Version", "default": false}}, "type": "object"}, "DimensionDefinitionFilter": {"properties": {"text_filter": {"type": "string", "description": "Text filter used to search names"}, "query": {"description": "Query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "DimensionDefinitionSetStateRequest": {"required": ["is_active", "name"], "properties": {"is_active": {"type": "boolean", "description": "States if the Dimension Definition is active or not"}, "name": {"type": "string", "description": "Name of the Dimension Definition"}, "description": {"type": "string", "description": "Description of Dimension Definition"}, "is_cost_anomaly_detection_enabled": {"type": "boolean", "description": "If True, Cost Anomaly Detection will be enabled for all grouping rules under this Dimension", "default": false}}, "type": "object"}, "DimensionDefinitionVersion": {"allOf": [{"$ref": "#/definitions/BaseDefinitionVersion"}, {"properties": {"details": {"description": "Details of the version", "$ref": "#/definitions/DimensionDefinitionConfiguration"}}, "type": "object"}]}, "DimensionDefinitionVersionBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/DimensionDefinitionVersion"}}}, "type": "object"}, "DimensionGroupingRule": {"required": ["name"], "properties": {"name": {"type": "string", "description": "Name of the Grouping Rule"}, "description": {"type": "string", "description": "Grouping Rule Description"}, "grouping_rule_id": {"type": "string", "description": "ID of the Dimension grouping (system generated)"}, "rule_type": {"type": "string", "description": "Type of Grouping Rule", "example": "System", "enum": ["System", "UserDefined"], "x-cs-enum-type": "GroupingRuleType"}, "attributes": {"type": "array", "items": {"$ref": "#/definitions/AttributeValueBase"}}, "filters": {"description": "Conditions applied to the grouping", "$ref": "#/definitions/QueryOperator"}, "platform_filters": {"description": "Conditions applied to the grouping", "$ref": "#/definitions/QueryOperator"}, "access_granted_identities": {"description": "Identities allowed to access this grouping rule", "$ref": "#/definitions/AccessGrantedRolesAndUserGroups"}, "dependent_grouping_rule": {"type": "array", "description": "Other Dimension Groupings associated with the grouping rule", "items": {"$ref": "#/definitions/DependentDimension"}}, "cost_anomaly_configuration": {"description": "Cost Anomaly configuration for this grouping rule", "$ref": "#/definitions/GroupingRuleCostAnomalyConfiguration"}, "priority": {"type": "integer", "description": "Priority of the Grouping Rule for evaluation order"}}, "type": "object"}, "DimensionListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/DimensionSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/DimensionDefinitionFilter"}}, "type": "object"}, "DimensionMembershipKeyValuePair": {"required": ["dimension_id", "grouping_rule_id"], "properties": {"dimension_id": {"type": "string", "description": "Dimension ID"}, "grouping_rule_id": {"type": "string", "description": "Grouping Rule ID"}}, "type": "object"}, "DimensionPrecomputeAccountStatus": {"properties": {"service_account_id": {"type": "string", "description": "Billing/processing service account ID"}, "status": {"type": "string", "description": "Status: completed, failed, in_progress, no_data, pending", "example": "completed", "enum": ["completed", "disabled", "failed", "in_progress", "no_data", "pending"], "x-cs-enum-type": "DimensionPrecomputeStatus"}, "last_precomputed_version_id": {"type": "string", "description": "head_version sys_id at time of last successful precompute"}, "records_reprocessed": {"type": "integer", "description": "Records reprocessed in last run"}, "message": {"type": "string", "description": "Status message or error detail"}, "completed_at": {"type": "string", "format": "date-time", "description": "When this account last completed precompute"}}, "type": "object"}, "DimensionPrecomputeStatusEntry": {"properties": {"dimension_id": {"type": "string", "description": "Dimension definition ID"}, "status": {"type": "string", "description": "Per-dimension status: completed, failed, pending, disabled, no_data", "example": "completed", "enum": ["completed", "disabled", "failed", "in_progress", "no_data", "pending"], "x-cs-enum-type": "DimensionPrecomputeStatus"}, "last_precomputed_version_id": {"type": "string", "description": "head_version sys_id at time of last successful precompute"}, "records_reprocessed": {"type": "integer", "description": "Records reprocessed for this dimension in last run"}, "message": {"type": "string", "description": "Status message or error detail"}, "version_state": {"description": "Current version state of the dimension", "$ref": "#/definitions/DimensionPrecomputeVersionState"}}, "type": "object"}, "DimensionPrecomputeStatusResult": {"properties": {"dimension_id": {"type": "string", "description": "Dimension definition ID"}, "status": {"type": "string", "description": "Worst-case aggregate across all billing accounts", "example": "completed", "enum": ["completed", "disabled", "failed", "in_progress", "no_data", "pending"], "x-cs-enum-type": "DimensionPrecomputeStatus"}, "by_account": {"type": "array", "description": "Per-billing-account detail", "items": {"$ref": "#/definitions/DimensionPrecomputeAccountStatus"}}, "message": {"type": "string", "description": "Status message, e.g. reason a dimension was not found or not accessible"}}, "type": "object"}, "DimensionPrecomputeVersionState": {"properties": {"version_id": {"type": "string", "description": "sys_id of the dimension head version"}, "precompute": {"type": "boolean", "description": "Whether precompute is enabled in the head version"}}, "type": "object"}, "DimensionQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["dimension_id", "grouping_rule_ids"], "properties": {"dimension_id": {"type": "string", "description": "Dimension ID"}, "attribute": {"type": "string", "description": "Attribute to filter"}, "values": {"type": "array", "description": "Values for the given attribute", "items": {"type": "string"}}, "grouping_rule_ids": {"type": "array", "description": "Resolved group ids based on the attribute/values", "items": {"type": "string"}}, "filters": {"description": "Combined filters of the resolved group ids", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "DimensionQueryOperator"}, "DimensionRuleMapping": {"required": ["dimension_id", "grouping_rule_ids"], "properties": {"dimension_id": {"type": "string", "description": "Dimension ID"}, "grouping_rule_ids": {"type": "array", "description": "Grouping Rule IDs that belong to this dimension", "items": {"type": "string"}}}, "type": "object"}, "DimensionSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "createdOn"], "x-cs-enum-type": "DimensionSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "DimensionSourceQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["dimension_sources"], "properties": {"dimension_sources": {"type": "array", "description": "Sources for Dimension Definition", "items": {"type": "string", "description": "Source of Dimension.", "example": "Billing", "enum": ["Billing"], "x-cs-enum-type": "DimensionSource"}}}, "type": "object"}], "x-cs-type-name": "DimensionSourceQueryOperator"}, "DimensionTenantSettings": {"required": ["product"], "properties": {"product": {"type": "string", "description": "Name of the product", "example": "AppSecOps", "enum": ["AppSecOps", "Assessments", "CloudOps", "FinOps", "Product_Admin", "SecOps", "Self Service", "StackOps"], "x-cs-enum-type": "ProductEnum"}, "mandate_dimension_selection": {"type": "boolean", "description": "Mandate Dimension Selection"}}, "type": "object"}, "DiskStatus": {"properties": {"enabled": {"type": "boolean", "description": "Indicates if disk monitoring is supported"}, "metric_name": {"type": "string", "description": "Disk metric name"}, "path": {"type": "string", "description": "Disk mount path"}, "disk_used": {"type": "number", "description": "Used disk space"}, "disk_free": {"type": "number", "description": "Free disk space"}, "total_disk_space": {"type": "number", "description": "Total disk space"}, "is_critical": {"type": "boolean", "description": "Indicates if disk usage is critical"}, "status_at": {"type": "string", "format": "date-time", "description": "Timestamp of disk status"}}, "type": "object"}, "DiskUtilizationBatchResponse": {"properties": {"path": {"type": "string", "description": "Path For which metrics are being measured."}, "device": {"type": "string", "description": "Device name For which metrics are being measured."}, "fstype": {"type": "string", "description": "Type of the disk partition for which metrics are being measured."}, "values": {"type": "array", "description": "Data Related to the Disk Utilization Metric.", "items": {"$ref": "#/definitions/DiskUtilizationMetricDetail"}}}, "type": "object"}, "DiskUtilizationMetricDetail": {"properties": {"date": {"type": "string", "description": "Time stamp in string for which metrics are being measured."}, "free": {"type": "number", "description": "Free Space for the metric in the provided time frame."}, "used": {"type": "number", "description": "Utilized Space for the metric in the provided time frame."}}, "type": "object"}, "DiskUtilizationSetting": {"properties": {"settings": {"type": "array", "items": {"$ref": "#/definitions/DiskUtilizationWorkspaceConfiguration"}}}, "type": "object"}, "DiskUtilizationWorkspaceConfiguration": {"properties": {"workspace_ids": {"type": "array", "description": "Log Analytics Workspace Ids", "items": {"type": "string"}}, "service_account_id": {"type": "string", "description": "Service Account Id", "x-cs-type": "ObjectId"}}, "type": "object"}, "DurationInMonthsQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"duration": {"type": "integer", "description": "Time Duration (in months) to filter the data. The allowed values are 2, 3, 6, and 12 months."}}, "type": "object"}], "x-cs-type-name": "DurationInMonthsQueryOperator"}, "EditTemplateNameRequest": {"required": ["name"], "properties": {"name": {"type": "string", "description": "Provide the name for the template to be updated"}}, "type": "object"}, "EditTemplateRequest": {"required": ["configuration_data"], "properties": {"configuration_data": {"type": "object", "description": "Refer the View configuration response for data formation\n                                                                             For AWS\n                                                                             ex:\n                                                                             {\n                                                                             \"Compute\": {\n                                                                                 \"EC2\": {\n                                                                                     \"Instances\": [{\n                                                                                         \"threshold_settings\": {\n                                                                                             \"EvaluationPeriods\": 2,\n                                                                                             \"Dimensions\": [],\n                                                                                             \"AlarmActions\": [],\n                                                                                             \"AlarmDescription\": \"\",\n                                                                                             \"Namespace\": \"\",\n                                                                                             \"Period\": 5,\n                                                                                             \"ComparisonOperator\": \"GreaterThanOrEqualToThreshold\",\n                                                                                             \"Statistic\": \"Average\",\n                                                                                             \"Threshold\": 75,\n                                                                                             \"OKActions\": []\n                                                                                         },\n                                                                                         \"service_resource_metric_uri\": \"AWS/Compute/EC2/Instances/CPUUtilization\",\n                                                                                         \"status\": \"enabled/disabled\",\n                                                                                         \"metric_name\": \"CPUUtilization\"\n                                                                                     }]\n                                                                                 }\n                                                                             }\n                                                                             For Azure\n                                                                             ex:\n                                                                             {\n                                                                             \"Compute\": {\n                                                                                 \"Virtual_Machines\": {\n                                                                                     \"Virtual_Machines\": [{\n                                                                                         \"threshold_settings\": {\n                                                                                             \"threshold\" : 95,\n                                                                                             \"operator\" : \"GreaterThan\",\n                                                                                             \"window_size\" : \"PT15M\",\n                                                                                             \"aggregation\" : \"Total\"\n                                                                                         },\n                                                                                         \"service_resource_metric_uri\": \"Azure/Compute/Virtual_Machines/Virtual_Machines/Percentage CPU\",\n                                                                                         \"status\": \"enabled/disabled\",\n                                                                                         \"metric_name\": \"Percentage CPU\"\n                                                                                     }]\n                                                                                 }\n                                                                             }\n                                                                             }\n                                                                             For GCP\n                                                                             ex:\n                                                                             {\n                                                                             \"Compute\": {\n                                                                                 \"Compute_Engine\": {\n                                                                                     \"VM_Instances\": [{\n                                                                                         \"threshold_settings\": {\n                                                                                             \"Comparison\" : \"COMPARISON_GT\",\n                                                                                             \"Aggregator\" : \"REDUCE_MEAN\",\n                                                                                             \"Period\" : 5,\n                                                                                             \"Aligner\" : \"ALIGN_MEAN\",\n                                                                                             \"Threshold\" : 90,\n                                                                                             \"Duration\" : 1\n                                                                                         },\n                                                                                         \"service_resource_metric_uri\": \"GCP/Compute/Compute_Engine/VM_Instances/compute.googleapis.com/instance/cpu/utilization\",\n                                                                                         \"status\": \"enabled/disabled\",\n                                                                                         \"metric_name\": \"compute.googleapis.com/instance/cpu/utilization\"\n                                                                                     }]\n                                                                                 }\n                                                                             }\n                                                                             }\n                                                                             "}}, "type": "object"}, "EdpCommitmentDetails": {"properties": {"start_date": {"type": "string", "format": "date-time", "description": "Enterprise Discount Program start date."}, "end_date": {"type": "string", "format": "date-time", "description": "Enterprise Discount Program end date."}, "committed_amount": {"type": "number", "description": "Amount for the specified period."}}, "type": "object"}, "EpssScoreRangeQueryOperator": {"allOf": [{"$ref": "#/definitions/AppSecopsScoreRangeQueryOperator"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "EpssScoreRangeQueryOperator"}, "ExchangeCurrencyRate": {"required": ["exchange_rate", "source_currency"], "properties": {"source_currency": {"type": "string", "description": "Source Currency for Exchange Configuration", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "exchange_rate": {"type": "number", "description": "Exchange Rate of Currency Exchange Configuration"}}, "type": "object"}, "ExecuteActionRecommendationResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "Status of pre-execute"}, "message": {"type": "string", "description": "pre-execute"}, "data": {"type": "object", "description": "Data for pre-execute"}}, "type": "object"}, "ExecuteRecommendationRequest": {"required": ["action_name", "resources"], "properties": {"action_name": {"type": "string", "description": "action to perform to resolve violations, the name can be obtained from the view recommendation api.  Example: action_name : skip or unskip"}, "resources": {"type": "array", "description": "resource resource_recommendation_id list for which the recommendation will be executed, this value can be obtained from the view recommendation api", "items": {"type": "string"}}, "args": {"type": "object", "description": "arguments to execute recommendation if any. The values are dynamic in nature can change from recommendation to recommendation"}}, "type": "object"}, "ExecuteRecommendationRespModel": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "Status of that HTTP call"}, "message": {"type": "string", "description": "Message of HTTP call"}, "data": {"type": "object", "description": "response data"}}, "type": "object"}, "ExecuteResolveActionRecommendationsRequest": {"required": ["action_name", "resources"], "properties": {"action_name": {"type": "string", "description": "Action Name to resolve the recommendation"}, "resources": {"type": "array", "description": "Specify the Resource IDs. It will be fetched from list recommendation api", "items": {"type": "string"}}}, "type": "object"}, "ExecuteResolveRecommendationsRequest": {"required": ["action_name", "apply_for_all", "resources"], "properties": {"action_name": {"type": "string", "description": "Action Name to resolve the recommendation"}, "resources": {"type": "array", "description": "Resource ID", "items": {"type": "string"}}, "apply_for_all": {"type": "boolean", "description": "Apply for all the resources.Allowed Values true or false"}}, "type": "object"}, "ExecuteResponse": {"properties": {"script_job_id": {"type": "string", "description": "Unique ID of the Script Job. Use this ID in describeScriptJob API and check the execution status"}}, "type": "object"}, "ExecuteScriptJobData": {"required": ["host", "keypair_flag", "parameters", "platform", "port", "script_name", "username"], "properties": {"host": {"type": "string", "description": "Target machine's IP/DNS"}, "username": {"type": "string", "description": "Username of the target machine"}, "keypair_flag": {"type": "string", "description": "Flag to indicate whether to connect using keypair or not"}, "password": {"type": "string", "description": "Password of the target machine's IP/DNS"}, "key_file": {"type": "string", "description": "Private key content if keypair_flag is true"}, "port": {"type": "string", "description": "SSH/WinRM port"}, "platform": {"type": "string", "description": ["OS platform of the target machine (linux/windows)"], "example": "linux", "enum": ["linux", "windows"], "x-cs-enum-type": "Platform"}, "script_name": {"type": "array", "description": "Name of the scripts to execute. This can be fetched from listScripts/describeScript API", "items": {"type": "string"}}, "playbook_hosts": {"type": "array", "description": "Required only for ansible scripts. Name of the hostgroup to be referred as per playbook. For eg, if you are installing a 3 tier app, you might have hostgroup such as dbserver, appserver, uiserver of the scripts to execute and the playbook tasks will be based on the hostgroups. The hostgroup initialized in a playbook can be fetched from scanScript API", "items": {"type": "string"}}, "parameters": {"type": "object", "description": "A JSON object which contains the parameters of the script. Refer scanned_parameters from scanScript/viewScript API response to view parameter available. Parameter JSON should be as follows.{\"<script_name_as_available_in_path>\": {\"parameter_key\" : \"parameter_value\"},\"<dependent_script_name_as_available_in_path>\": {\"parameter_key\" : \"parameter_value\"}}. \nFor Eg.{\"ansible_lamp\": {\"mysql_port\" : \"3307\"}}", "example": {"ansible_lamp": {"mysql_port": "3307"}}}, "parameter_source": {"type": "string", "description": "Parameter source - whether as per the one defined in script or custom json", "default": "script", "example": "script", "enum": ["script", "json"], "x-cs-enum-type": "ParameterSource"}}, "type": "object"}, "ExecuteScriptRequest": {"required": ["job_details", "job_name"], "properties": {"job_name": {"type": "string", "description": "Name of the script job"}, "job_details": {"type": "array", "description": "Execution input such as script/host details", "items": {"$ref": "#/definitions/ExecuteScriptJobData"}}}, "type": "object"}, "ExecutionLogDetails": {"required": ["name", "run_time", "status"], "properties": {"status": {"type": "string", "description": "Status of the Execution Log"}, "run_time": {"type": "string", "description": "Run Time Execution of the schedule"}, "name": {"type": "string", "description": "Job Name of the schedule execution log"}}, "type": "object"}, "ExtrasValueRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["extra_key", "extras_value_regex"], "properties": {"extra_key": {"type": "string", "description": "Extra key to identify which field to select"}, "extras_value_regex": {"description": "Include response that follows the regex pattern", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ExtrasValueRegexQueryOperator"}, "FeatureFlag": {"allOf": [{"$ref": "#/definitions/FeatureFlagBase"}, {"properties": {"feature_category": {"type": "string", "description": "This is logical category defined for existing services specific feature flags", "example": "AI", "enum": ["AI", "AI_AGENT", "BROKER", "COMPLIANCE", "CORESTACK_IDENTITY", "COST", "GOVERNANCE", "HEATSTACK", "OPERATIONS_GOVERNANCE", "OTHERS", "REPORT_GENERATION", "REPORTS", "RESOURCE_INVENTORY", "SECURITY_GOVERNANCE", "UI"], "x-cs-enum-type": "FeatureCategory"}, "feature_category_prefix": {"type": "string", "description": "This is logical prefix defined for each logical feature categories", "example": "AI", "enum": ["AI", "AIAG", "BR", "COMP", "IDEN", "COST", "GOVN", "HEAT", "OPGN", "OTHR", "REGN", "REPT", "REIN", "SEGN", "UI"], "x-cs-enum-type": "FeatureCategoryPrefix"}, "flag_type": {"type": "string", "description": "The feature flag's type", "example": "F", "enum": ["F", "B", "A"], "x-cs-enum-type": "FeatureFlagType"}}, "type": "object"}], "x-cs-type-name": "FeatureFlag"}, "FeatureFlagBase": {"required": ["__type", "category", "default", "enabled", "flag_name"], "properties": {"category": {"type": "string", "description": "The main category of the feature flag", "example": "RELEASE", "enum": ["RELEASE", "FEATURE"], "x-cs-enum-type": "FeatureFlagCategory"}, "flag_name": {"type": "string", "description": "Name of the feature flag"}, "description": {"type": "string", "description": "Description of the feature flag"}, "enabled": {"type": "boolean", "description": "Whether the feature flag is enabled or not"}, "default": {"type": "boolean", "description": "The feature flag's enabled by default or not"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "FeatureFlag", "subtype_name": "FeatureFlag"}, {"subtype_model": "ReleaseFlag", "subtype_name": "ReleaseFlag"}]}, "FeatureFlagContext": {"required": ["email", "master_account_id", "role_id", "tenant_id", "user_id"], "properties": {"user_id": {"type": "string", "description": "User id of the user to whom feature flag state is needed"}, "email": {"type": "string", "description": "The context user's email id."}, "master_account_id": {"type": "string", "description": "Master account id to which flag state is needed."}, "tenant_id": {"type": "string", "description": "Tenant id to which flag state is needed."}, "role_id": {"type": "string", "description": "Role id to which flag state is needed."}, "group_id": {"type": "string", "description": "The group id to which flag state is needed"}, "ip_address": {"type": "string", "description": "Ip address to which feature flag state is needed"}, "country": {"type": "string", "description": "Country to which feature flag state is needed"}, "region": {"type": "string", "description": "Region to which feature flag state is needed"}}, "type": "object"}, "FeatureFlagRequest": {"allOf": [{"$ref": "#/definitions/FeatureFlagRequestBase"}, {"properties": {"feature_category": {"type": "string", "description": "The logical category of existing services", "example": "AI", "enum": ["AI", "AI_AGENT", "BROKER", "COMPLIANCE", "CORESTACK_IDENTITY", "COST", "GOVERNANCE", "HEATSTACK", "OPERATIONS_GOVERNANCE", "OTHERS", "REPORT_GENERATION", "REPORTS", "RESOURCE_INVENTORY", "SECURITY_GOVERNANCE", "UI"], "x-cs-enum-type": "FeatureCategory"}}, "type": "object"}], "x-cs-type-name": "FeatureFlagRequest"}, "FeatureFlagRequestBase": {"required": ["__type", "category"], "properties": {"category": {"type": "string", "description": "The main category of the feature flags", "example": "RELEASE", "enum": ["RELEASE", "FEATURE"], "x-cs-enum-type": "FeatureFlagCategory"}, "flag_name": {"type": "string", "description": "Feature flag's name"}, "context": {"description": "Feature flag's context", "$ref": "#/definitions/FeatureFlagContext"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ReleaseFlagRequest", "subtype_name": "ReleaseFlagRequest"}, {"subtype_model": "FeatureFlagRequest", "subtype_name": "FeatureFlagRequest"}]}, "FeatureFlagsWithDefaults": {"properties": {}, "type": "object"}, "FileDetails": {"properties": {"file_name": {"type": "string", "description": "Name of the file"}, "file_size": {"type": "integer", "description": "Size of the file"}, "multipart_metadata": {"description": "Multi part upload metadata details", "$ref": "#/definitions/MultipartUploadMetadata"}}, "type": "object"}, "FileWiseViolations": {"allOf": [{"$ref": "#/definitions/ViolationBase"}, {"properties": {"resource_identifier": {"type": "string", "description": "Identifier Name for the resource for which the scanning is being done."}, "output_details": {"type": "array", "description": "The violated params resulted from the scanner.", "items": {"type": "string"}}, "violation_message": {"type": "string", "description": "Message available for the rule violated."}}, "type": "object"}]}, "FilterContextWidgetConfigurationModel": {"allOf": [{"$ref": "#/definitions/BaseDataWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "FilterContextWidgetConfigurationModel"}, "FilterData": {"required": ["regions", "resource_groups"], "properties": {"regions": {"type": "array", "description": "Displays the list of regions", "items": {"$ref": "#/definitions/ResourceFilterModel"}}, "resource_groups": {"type": "array", "description": "Displays the list of resource groups", "items": {"$ref": "#/definitions/ResourceFilterModel"}}}, "type": "object"}, "FilterIdNameModel": {"required": ["id", "name"], "properties": {"id": {"type": "string", "description": "Id of filter key"}, "name": {"type": "string", "description": "Id of filter name"}}, "type": "object"}, "FilterOptions": {"properties": {"tenants": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsTenant"}}}, "type": "object"}, "FilterOptionsBase": {"properties": {"tenant_id": {"type": "string"}, "has_active_accounts": {"type": "boolean", "description": "Has active accounts", "default": false}, "tenant_name": {"type": "string"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "FilterOptionsCloudAccount": {"properties": {"status": {"type": "string", "description": "Indicates the status of the cloud account in corestack", "example": "not_validated", "enum": ["not_validated", "validated", "not_onboarded", "not_onboarded_validated", "active", "inactive", "retired", "deleting"], "x-cs-enum-type": "ServiceAccountStatus"}, "cloud_account_id": {"type": "string", "description": "ID of the account"}, "cloud_account_name": {"type": "string", "description": "Name of the account"}, "currency": {"type": "string", "description": "Currency for the account", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "scope": {"type": "string", "description": "Scope of the Cloud account", "example": "global", "enum": ["global", "account", "tenant"], "x-cs-enum-type": "ServiceAccountScope"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "FilterOptionsCloudProvider": {"allOf": [{"$ref": "#/definitions/FilterOptionsCloudProviderLight"}, {"properties": {"cloud_accounts": {"type": "array", "description": "List of accounts for this Cloud Provider", "items": {"$ref": "#/definitions/FilterOptionsCloudAccount"}}}, "type": "object"}]}, "FilterOptionsCloudProviderLight": {"properties": {"cloud": {"type": "string", "description": "Cloud Provider for the accounts", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "currencies": {"type": "array", "description": "Currencies", "items": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}}, "type": "object"}, "FilterOptionsContainerProviders": {"allOf": [{"$ref": "#/definitions/FilterOptionsCloudProvider"}, {"properties": {}, "type": "object"}]}, "FilterOptionsDimensionCostCenterAccount": {"properties": {"status": {"type": "string", "description": "Indicates the status of the cloud account in corestack", "example": "not_validated", "enum": ["not_validated", "validated", "not_onboarded", "not_onboarded_validated", "active", "inactive", "retired", "deleting"], "x-cs-enum-type": "ServiceAccountStatus"}, "service_account_id": {"type": "string", "description": "ID of the account"}, "service_account_name": {"type": "string", "description": "Name of the account"}, "currency": {"type": "string", "description": "Currency for the account", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "scope": {"type": "string", "description": "Scope of the account", "example": "global", "enum": ["global", "account", "tenant"], "x-cs-enum-type": "ServiceAccountScope"}}, "type": "object"}, "FilterOptionsForSaasAiServices": {"allOf": [{"$ref": "#/definitions/FilterOptionsForSaasBase"}, {"properties": {"saas": {"type": "string", "description": "List of SaaS services supported for the role template", "example": "Anthropic", "enum": ["Anthropic", "OpenAI"], "x-cs-enum-type": "SaasAiServiceName"}}, "type": "object"}]}, "FilterOptionsForSaasBase": {"properties": {"saas_accounts": {"type": "array", "description": "List of accounts for this SaaS Provider", "items": {"$ref": "#/definitions/FilterOptionsSaasAccount"}}, "currencies": {"type": "array", "description": "Currencies", "items": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}}, "type": "object"}, "FilterOptionsForSaasDataServices": {"allOf": [{"$ref": "#/definitions/FilterOptionsForSaasBase"}, {"properties": {"saas": {"type": "string", "description": "List of SaaS services supported for the role template", "example": "Databricks", "enum": ["Databricks", "Snowflake"], "x-cs-enum-type": "SaasDataServiceName"}}, "type": "object"}]}, "FilterOptionsForSaasOtherServices": {"allOf": [{"$ref": "#/definitions/FilterOptionsForSaasBase"}, {"properties": {"saas": {"type": "string", "description": "List of SaaS services supported for the role template", "example": "CircleCI", "enum": ["CircleCI", "Datadog", "Dropbox", "Dynatrace", "Elastic", "Grafana", "IBM_Tencent", "Microsoft_Teams", "New_Relic", "Okta", "SaasCustomTool", "Salesforce_Sales_Cloud", "Splunk"], "x-cs-enum-type": "SaasOtherServiceName"}}, "type": "object"}]}, "FilterOptionsIntegratedToolAccount": {"properties": {"status": {"type": "string", "description": "Indicates the status of the cloud account in corestack", "example": "not_validated", "enum": ["not_validated", "validated", "not_onboarded", "not_onboarded_validated", "active", "inactive", "retired", "deleting"], "x-cs-enum-type": "ServiceAccountStatus"}, "tool_type": {"type": "string", "description": "Type of the integrated tool"}, "tool_account_id": {"type": "string", "description": "ID of the account"}, "tool_account_name": {"type": "string", "description": "Name of the account"}, "scope": {"type": "string", "description": "Scope of the Integrated Tool account", "example": "global", "enum": ["global", "account", "tenant"], "x-cs-enum-type": "ServiceAccountScope"}}, "type": "object"}, "FilterOptionsIntegratedToolProvider": {"properties": {"tool": {"type": "string", "description": "Integrated Tool for the account", "example": "Anomaly_Detector", "enum": ["Anomaly_Detector", "AppDynamics", "App_Insights", "ArrowSphere", "Azure_Devops", "Azure_Security_Graph", "Azure_Sentinel", "Corestack", "DockerHub", "ElasticSearch", "Freshservice", "GitHub", "JIRA_DataCenter", "JIRA_ServiceDesk", "JIRA_ServiceManagement", "Jenkins", "Logstash", "Microsoft_Teams", "Nagios", "Newrelic", "Prometheus", "Qualys", "RedHat_Satellite", "ServiceNow", "TCL_ITSM", "Tenable_Nessus", "ZOHO_ServiceDesk", "Zabbix"], "x-cs-enum-type": "IntegratedToolName"}, "tool_accounts": {"type": "array", "description": "List of accounts for this Integrated Tool Provider", "items": {"$ref": "#/definitions/FilterOptionsIntegratedToolAccount"}}}, "type": "object"}, "FilterOptionsLight": {"properties": {"tenants": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsTenantLight"}}}, "type": "object"}, "FilterOptionsSaasAccount": {"properties": {"status": {"type": "string", "description": "Indicates the status of the cloud account in corestack", "example": "not_validated", "enum": ["not_validated", "validated", "not_onboarded", "not_onboarded_validated", "active", "inactive", "retired", "deleting"], "x-cs-enum-type": "ServiceAccountStatus"}, "saas_account_id": {"type": "string", "description": "ID of the Saas account"}, "saas_account_name": {"type": "string", "description": "Name of the Saas account"}, "scope": {"type": "string", "description": "Scope of the Saas account", "example": "global", "enum": ["global", "account", "tenant"], "x-cs-enum-type": "ServiceAccountScope"}, "currency": {"type": "string", "description": "Currency for the SaaS account", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "FilterOptionsTenant": {"allOf": [{"$ref": "#/definitions/FilterOptionsBase"}, {"properties": {"cloud_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsCloudProvider"}}, "integrated_tool_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsIntegratedToolProvider"}}, "ai_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsForSaasAiServices"}}, "data_service_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsForSaasDataServices"}}, "other_service_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsForSaasOtherServices"}}, "dimension_cost_centers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsDimensionCostCenterAccount"}}, "container_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsContainerProviders"}}}, "type": "object"}]}, "FilterOptionsTenantLight": {"allOf": [{"$ref": "#/definitions/FilterOptionsBase"}, {"properties": {"cloud_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsCloudProviderLight"}}, "ai_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsForSaasAiServices"}}, "data_service_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsForSaasDataServices"}}, "other_service_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsForSaasOtherServices"}}, "dimension_currencies": {"type": "array", "description": "Currencies", "items": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "container_providers": {"type": "array", "items": {"$ref": "#/definitions/FilterOptionsCloudProviderLight"}}}, "type": "object"}]}, "FilterServices": {"required": ["cloud account type", "currency"], "properties": {"cloud account type": {"type": "array", "description": "cloud account type", "items": {"type": "object"}}, "currency": {"type": "array", "description": "currency types", "items": {"type": "object"}}}, "type": "object"}, "FilterValue": {"required": ["cloud_account", "payment_option", "region", "reservation_sku", "reservation_type", "tenant"], "properties": {"reservation_sku": {"type": "array", "description": "Reservation SKU Details", "items": {"type": "string"}}, "payment_option": {"type": "array", "description": "Available payment option", "items": {"type": "string"}}, "region": {"type": "array", "description": "Region available", "items": {"type": "string"}}, "reservation_type": {"type": "array", "description": "Reservation Type", "items": {"type": "string"}}, "cloud_account": {"type": "array", "description": "Cloud Account Details", "items": {"$ref": "#/definitions/RangeValue"}}, "tenant": {"type": "array", "description": "Tenant name", "items": {"type": "string"}}}, "type": "object"}, "FilterWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseProducerDataWidgetConfigurationModel"}, {"properties": {"timeRangeOptions": {"type": "string", "example": "RecentMonths", "enum": ["RecentMonths", "MonthsQuartersYears", "DaysMonthsQuartersYears", "DaysMonthsQuartersYearsGroup1", "DaysMonthsQuartersYearsT2"], "x-cs-enum-type": "TimeRangeOptionId"}, "automaticallyApply": {"type": "boolean", "description": "If false, use button to submit filter updates"}}, "type": "object"}], "x-cs-type-name": "FilterWidgetConfiguration"}, "FilterWidgetViewState": {"allOf": [{"$ref": "#/definitions/WidgetViewState"}, {"required": ["context"], "properties": {"context": {"$ref": "#/definitions/DataContext"}}, "type": "object"}], "x-cs-type-name": "FilterWidgetViewState"}, "FinOpsConsolidatedReportScheduleRequest": {"allOf": [{"$ref": "#/definitions/NextGenReportScheduleRequest"}, {"properties": {"configuration": {"description": "Report configuration to generate report", "$ref": "#/definitions/ConfigurationForNextGenReportBase"}}, "type": "object"}], "x-cs-type-name": "FinOpsConsolidatedReportScheduleRequest"}, "FinopsAssessmentHistory": {"properties": {"assessment_run_id": {"type": "string", "description": "Assessment run id"}, "assessment_status": {"type": "string", "description": "Assessment run id status", "example": "in_progress", "enum": ["in_progress", "pending", "failed", "completed"], "x-cs-enum-type": "AssessmentRunStatus"}, "assessment_status_message": {"type": "string", "description": "Assessment run id status message"}, "assessment_start_time": {"type": "string", "format": "date-time", "description": "Assessment run start date and time"}}, "type": "object"}, "FinopsAssessmentTriggerRequest": {"required": ["action", "category"], "properties": {"action": {"type": "string", "description": "Action that needs to be performed", "example": "re_trigger_assessment", "enum": ["re_trigger_assessment", "trigger_data_collection"], "x-cs-enum-type": "AssessmentAction"}, "category": {"type": "string", "description": "Category of assessment validation for the cloud account", "example": "operations", "enum": ["operations", "security", "access", "cost", "resource", "compliance"], "x-cs-enum-type": "AssessmentCategory"}}, "type": "object"}, "FinopsAssessmentTriggerResponse": {"properties": {"assessment_run_id": {"type": "string", "description": "Assessment run id"}}, "type": "object"}, "FinopsAssessmentTriggerStatusResponse": {"properties": {"status": {"type": "string", "description": "Assessment run id status", "example": "in_progress", "enum": ["in_progress", "pending", "failed", "completed"], "x-cs-enum-type": "AssessmentRunStatus"}, "status_message": {"type": "string", "description": "Assessment run id status message"}}, "type": "object"}, "FiscalYearConfiguration": {"properties": {"start": {"type": "string", "description": "Start Date for Financial Year in DD-MMM format"}, "end": {"type": "string", "description": "End Date for Financial Year in DD-MMM format"}}, "type": "object"}, "ForecastDuration": {"properties": {"count": {"type": "integer"}, "granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}}, "type": "object"}, "ForgetPasswordRequest": {"required": ["email_id"], "properties": {"email_id": {"type": "string", "description": "User email id."}}, "type": "object"}, "FreshserviceAlertsMapping": {"allOf": [{"$ref": "#/definitions/FreshserviceMappingBase"}, {"properties": {"description_attributes": {"type": "array", "description": "List of Alert attribute enums for Freshservice", "items": {"type": "string", "description": "Allowed attributes for Alerts Description", "example": "account_id", "enum": ["account_id", "alarm_name", "cloud", "location", "metric_name", "metric_value", "operator", "resource", "resource_group", "resource_id", "resource_name", "resource_type", "service_account_name", "subscription_id", "tenant_name", "threshold", "time_aggregation"], "x-cs-enum-type": "DescriptionAttributeForItsmAlert"}}, "attribute_mappings": {"type": "array", "description": "List of Freshservice attribute mappings", "items": {"$ref": "#/definitions/FreshserviceIncidentConfigurationMappingForAlerts"}}}, "type": "object"}]}, "FreshserviceBudgetAlertsMapping": {"allOf": [{"$ref": "#/definitions/FreshserviceMappingBase"}, {"properties": {"description_attributes": {"type": "array", "description": "List of Budget Alert attribute enums for Freshservice", "items": {"type": "string", "description": "Allowed attributes for Budget Alerts Description", "example": "actual_amount", "enum": ["actual_amount", "budget_amount", "budget_frequency", "budget_name", "budget_type", "configuration_type", "created_at", "currency", "impacted_accounts", "threshold_percentage", "updated_at"], "x-cs-enum-type": "DescriptionAttributeForItsmBudgetAlert"}}, "attribute_mappings": {"type": "array", "description": "List of Freshservice attribute mappings", "items": {"$ref": "#/definitions/FreshserviceIncidentConfigurationMappingForBudgetAlerts"}}}, "type": "object"}]}, "FreshserviceDepartmentDetails": {"properties": {"department_id": {"type": "integer", "description": "Department Id"}, "name": {"type": "string", "description": "Department Name"}}, "type": "object"}, "FreshserviceIncidentConfigurationMappingBase": {"properties": {"name": {"type": "string", "description": "Freshservice incident attribute.", "example": "category", "enum": ["category", "department_id", "group_id", "item_category", "priority", "requester_id", "responder_id", "source", "status", "sub_category", "workspace_id"], "x-cs-enum-type": "FreshserviceIncidentAttribute"}}, "type": "object"}, "FreshserviceIncidentConfigurationMappingForAlerts": {"allOf": [{"$ref": "#/definitions/FreshserviceIncidentConfigurationMappingBase"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Alerts Description", "example": "account_id", "enum": ["account_id", "alarm_name", "cloud", "location", "metric_name", "metric_value", "operator", "resource", "resource_group", "resource_id", "resource_name", "resource_type", "service_account_name", "subscription_id", "tenant_name", "threshold", "time_aggregation"], "x-cs-enum-type": "DescriptionAttributeForItsmAlert"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "FreshserviceIncidentConfigurationMappingForBudgetAlerts": {"allOf": [{"$ref": "#/definitions/FreshserviceIncidentConfigurationMappingBase"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Budget Alerts Description", "example": "actual_amount", "enum": ["actual_amount", "budget_amount", "budget_frequency", "budget_name", "budget_type", "configuration_type", "created_at", "currency", "impacted_accounts", "threshold_percentage", "updated_at"], "x-cs-enum-type": "DescriptionAttributeForItsmBudgetAlert"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "FreshserviceIncidentConfigurationMappingForPolicyViolation": {"allOf": [{"$ref": "#/definitions/FreshserviceIncidentConfigurationMappingBase"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Policy Description", "example": "tenant_name", "enum": ["tenant_name", "master_account_name", "service_name", "account_id", "service_account_name", "policy_classification", "policy_name", "policy_description", "resource_type", "resource_id", "resource_name", "subscription_id", "subscription_name", "resource_group", "location"], "x-cs-enum-type": "DescriptionAttributeForItsmPolicy"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "FreshserviceIncidentConfigurationMappingForSecurityAlert": {"allOf": [{"$ref": "#/definitions/FreshserviceIncidentConfigurationMappingBase"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Security Alerts Description", "example": "tenant_name", "enum": ["tenant_name", "service_account_name", "service_name", "account_id", "findings_type", "severity", "status", "alert_description", "intent", "affected_resource", "count", "resource_type", "resource_id", "resource_name", "resource_group", "subscription_name", "location"], "x-cs-enum-type": "DescriptionAttributeForItsmSecurityAlert"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "FreshserviceMappingBase": {"properties": {"description_text": {"type": "string", "description": "Sample Format text of incident description by selected description attributes."}}, "type": "object"}, "FreshservicePolicyMapping": {"allOf": [{"$ref": "#/definitions/FreshserviceMappingBase"}, {"properties": {"description_attributes": {"type": "array", "description": "List of Policy attribute enums for Freshservice", "items": {"type": "string", "description": "Allowed attributes for Policy Description", "example": "tenant_name", "enum": ["tenant_name", "master_account_name", "service_name", "account_id", "service_account_name", "policy_classification", "policy_name", "policy_description", "resource_type", "resource_id", "resource_name", "subscription_id", "subscription_name", "resource_group", "location"], "x-cs-enum-type": "DescriptionAttributeForItsmPolicy"}}, "attribute_mappings": {"type": "array", "description": "List of Freshservice attribute mappings", "items": {"$ref": "#/definitions/FreshserviceIncidentConfigurationMappingForPolicyViolation"}}}, "type": "object"}]}, "FreshserviceSecurityAlertMapping": {"allOf": [{"$ref": "#/definitions/FreshserviceMappingBase"}, {"properties": {"description_attributes": {"type": "array", "description": "List of Security Alert attribute enums for Freshservice", "items": {"type": "string", "description": "Allowed attributes for Security Alerts Description", "example": "tenant_name", "enum": ["tenant_name", "service_account_name", "service_name", "account_id", "findings_type", "severity", "status", "alert_description", "intent", "affected_resource", "count", "resource_type", "resource_id", "resource_name", "resource_group", "subscription_name", "location"], "x-cs-enum-type": "DescriptionAttributeForItsmSecurityAlert"}}, "attribute_mappings": {"type": "array", "description": "List of Freshservice attribute mappings", "items": {"$ref": "#/definitions/FreshserviceIncidentConfigurationMappingForSecurityAlert"}}}, "type": "object"}]}, "FreshserviceSupportTicketListResponse": {"properties": {"results": {"type": "array", "description": "Tickets List", "items": {"$ref": "#/definitions/FreshserviceTicketDetails"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "FreshserviceTicketAttachment": {"properties": {"name": {"type": "string", "description": "Name"}, "content_type": {"type": "string", "description": "Content Type"}, "attachment_url": {"type": "string", "description": "Attachment Url"}}, "type": "object"}, "FreshserviceTicketCreateRequest": {"required": ["description", "priority", "subject"], "properties": {"subject": {"type": "string", "description": "Subject"}, "description": {"type": "string", "description": "Description of the ticket"}, "priority": {"type": "string", "description": "Filter By Priority", "example": "urgent", "enum": ["urgent", "high", "medium", "low"], "x-cs-enum-type": "FreshserviceTicketPriority"}, "department_id": {"type": "integer", "description": "Department Id"}, "attachments": {"type": "array", "description": "List of Attachment Ids", "items": {"type": "string"}}}, "type": "object"}, "FreshserviceTicketDetails": {"properties": {"ticket_id": {"type": "string", "description": "Unique Id"}, "subject": {"type": "string", "description": "Subject"}, "description": {"type": "string", "description": "Description of the ticket"}, "email": {"type": "string", "description": "Requester Email"}, "status": {"type": "string", "description": "Status"}, "source": {"type": "integer", "description": "Source"}, "urgency": {"type": "integer", "description": "Urgency"}, "resolution_notes": {"type": "string", "description": "Resolution Notes"}, "priority": {"type": "string", "description": "Priority"}, "ticket_type": {"type": "string", "description": "Ticket Type"}, "workspace_id": {"type": "string", "description": "Workspace Id"}, "department": {"type": "string", "description": "Department"}, "group_id": {"type": "string", "description": "Group Id"}, "category": {"type": "string", "description": "Category"}, "sub_category": {"type": "string", "description": "Sub Category"}, "item_category": {"type": "string"}, "responder_id": {"type": "string", "description": "Responder Id"}, "requested_for_id": {"type": "string", "description": "Requested for Id"}, "to_emails": {"type": "array", "description": "To Emails", "items": {"type": "string"}}, "fwd_emails": {"type": "array", "description": "Forward Emails", "items": {"type": "string"}}, "cc_emails": {"type": "array", "description": "CC Emails", "items": {"type": "string"}}, "reply_cc_emails": {"type": "array", "description": "Reply CC Emails", "items": {"type": "string"}}, "due_by": {"type": "string", "format": "date-time", "description": "Due By"}, "created_at": {"type": "string", "format": "date-time", "description": "Created At"}, "updated_at": {"type": "string", "format": "date-time", "description": "Updated At"}, "is_deleted": {"type": "boolean", "description": "Is Deleted"}, "is_spam": {"type": "boolean", "description": "Is Spam"}, "is_escalated": {"type": "boolean", "description": "Is Escalated"}, "attachments": {"type": "array", "description": "Attachments Info", "items": {"$ref": "#/definitions/FreshserviceTicketAttachment"}}}, "type": "object"}, "FreshserviceTicketFilterElement": {"properties": {"id": {"type": "string", "description": "Id"}, "name": {"type": "string", "description": "Name"}}, "type": "object"}, "FreshserviceTicketFilters": {"properties": {"status": {"type": "array", "items": {"type": "string", "description": "Status", "example": "open", "enum": ["open", "pending", "resolved", "closed"], "x-cs-enum-type": "FreshserviceTicketStatus"}}, "priority": {"type": "array", "items": {"type": "string", "description": "Filter By Priority", "example": "urgent", "enum": ["urgent", "high", "medium", "low"], "x-cs-enum-type": "FreshserviceTicketPriority"}}, "department_id": {"type": "array", "items": {"type": "integer", "description": "Filter By department"}}, "start_date": {"type": "string", "format": "date", "description": "specify the start date"}, "end_date": {"type": "string", "format": "date", "description": "specify the end date"}}, "type": "object"}, "FreshserviceTicketFiltersResponse": {"properties": {"status": {"type": "array", "description": "Status List", "items": {"$ref": "#/definitions/FreshserviceTicketFilterElement"}}, "priority": {"type": "array", "description": "Priority List", "items": {"$ref": "#/definitions/FreshserviceTicketFilterElement"}}, "department": {"type": "array", "description": "Department List", "items": {"$ref": "#/definitions/FreshserviceTicketFilterElement"}}}, "type": "object"}, "FreshserviceTicketListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/FreshserviceTicketFilters"}}, "type": "object"}, "FromToValue": {"properties": {"from": {"type": "integer", "description": "Starting value of the range.Example 'from': 1000"}, "to": {"type": "integer", "description": "Ending value of the range.Example 'to': 100000"}}, "type": "object"}, "GcpResourceSkuDetailsRequest": {"properties": {"service_account_id": {"type": "string", "description": "ID of the service account", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Id of the resource"}, "resource_type": {"type": "string", "description": "Type of the resource"}, "resource_category": {"type": "string", "description": "Category of the resource"}, "resource": {"type": "string", "description": "Name of the resource"}, "region": {"description": "Optional region details", "$ref": "#/definitions/LocationDetailsBase"}}, "type": "object"}, "GcpResourceSkuDetailsResponse": {"properties": {"sku_list": {"type": "array", "description": "SKU list", "items": {"type": "string"}}}, "type": "object"}, "GeoCoordinatesForRegion": {"properties": {"latitude": {"type": "number"}, "longitude": {"type": "number"}, "iso_a3_code": {"type": "string"}, "region": {"type": "string"}, "normalized_region": {"type": "string"}}, "type": "object"}, "GeoCoordinatesForRegionRequest": {"properties": {"regions": {"type": "array", "items": {"type": "string", "description": "Region of the cloud"}}}, "type": "object"}, "GetResourceDetailsResponse": {"required": ["data"], "properties": {"data": {"type": "object", "description": "Resource Details"}}, "type": "object"}, "GetServiceDetails": {"required": ["data", "message"], "properties": {"message": {"type": "string"}, "data": {"type": "object", "description": "get service details response"}}, "type": "object"}, "GetTenantResponse": {"allOf": [{"$ref": "#/definitions/TenantDetails"}, {"required": ["account_name", "created_by", "metadata", "updated_at", "updated_by"], "properties": {"metadata": {"type": "object", "description": "metadata is a freeform JSON. It allows to store custom keys and values. It will be useful for storing information about an external applications that will refer to CoreStack tenant"}, "created_by": {"type": "string", "description": "Name of the user created this tenant."}, "updated_by": {"type": "string", "description": "Name of the user last updated this tenant."}, "updated_at": {"type": "string", "description": "DateTime in UTC when the tenant was last updated."}, "account_name": {"type": "string", "description": "Name of the CoreStack account under which this tenant resides."}}, "type": "object"}]}, "GovernanceConfiguration": {"properties": {"settings": {"type": "array", "description": "Governance Configuration settings", "items": {"$ref": "#/definitions/GovernanceConfigurationBase"}}}, "type": "object"}, "GovernanceConfigurationApplicationByContext": {"properties": {"context": {"description": "Governance Configuration settings to apply", "$ref": "#/definitions/GovernanceConfigurationBase"}, "steps": {"type": "array", "description": "Steps to apply configuration", "items": {"$ref": "#/definitions/GovernanceConfigurationApplicationStep"}}}, "type": "object"}, "GovernanceConfigurationApplicationStep": {"properties": {"label": {"type": "string", "description": "Description of the step"}, "status": {"type": "string", "description": "Status of the step", "example": "validating", "enum": ["validating", "validated", "applying", "completed", "failed"], "x-cs-enum-type": "GovernanceConfigurationApplicationStepStatus"}, "failure": {"type": "string", "description": "Reason for failure"}}, "type": "object"}, "GovernanceConfigurationBase": {"required": ["type"], "properties": {"version_number": {"type": "integer", "description": "Version number of this setting"}}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "GovernanceConfigurationForCostAnomaly", "subtype_name": "GovernanceConfigurationForCostAnomaly"}, {"subtype_model": "GovernanceConfigurationForCompliance", "subtype_name": "GovernanceConfigurationForCompliance"}, {"subtype_model": "GovernanceConfigurationForCostRecommendationAzure", "subtype_name": "GovernanceConfigurationForCostRecommendationAzure"}, {"subtype_model": "GovernanceConfigurationForEDPAws", "subtype_name": "GovernanceConfigurationForEDPAws"}, {"subtype_model": "GovernanceConfigurationForActivityLogAws", "subtype_name": "GovernanceConfigurationForActivityLogAws"}, {"subtype_model": "GovernanceConfigurationForActivityLogAzure", "subtype_name": "GovernanceConfigurationForActivityLogAzure"}, {"subtype_model": "GovernanceConfigurationForActivityLogGcp", "subtype_name": "GovernanceConfigurationForActivityLogGcp"}, {"subtype_model": "GovernanceConfigurationForActivityLogOci", "subtype_name": "GovernanceConfigurationForActivityLogOci"}, {"subtype_model": "GovernanceConfigurationForAlertsAws", "subtype_name": "GovernanceConfigurationForAlertsAws"}, {"subtype_model": "GovernanceConfigurationForAlertsAzure", "subtype_name": "GovernanceConfigurationForAlertsAzure"}, {"subtype_model": "GovernanceConfigurationForAlertsGcp", "subtype_name": "GovernanceConfigurationForAlertsGcp"}, {"subtype_model": "GovernanceConfigurationForAlertsOci", "subtype_name": "GovernanceConfigurationForAlertsOci"}, {"subtype_model": "GovernanceConfigurationForLogAnalyticsWorkspacesAzure", "subtype_name": "GovernanceConfigurationForLogAnalyticsWorkspacesAzure"}, {"subtype_model": "GovernanceConfigurationForPatchManagementAzure", "subtype_name": "GovernanceConfigurationForPatchManagementAzure"}, {"subtype_model": "GovernanceConfigurationForMetricData", "subtype_name": "GovernanceConfigurationForMetricData"}, {"subtype_model": "GovernanceConfigurationForThreatsAws", "subtype_name": "GovernanceConfigurationForThreatsAws"}, {"subtype_model": "GovernanceConfigurationForThreatsAzure", "subtype_name": "GovernanceConfigurationForThreatsAzure"}, {"subtype_model": "GovernanceConfigurationForThreatsGcp", "subtype_name": "GovernanceConfigurationForThreatsGcp"}, {"subtype_model": "GovernanceConfigurationForThreatsOci", "subtype_name": "GovernanceConfigurationForThreatsOci"}, {"subtype_model": "GovernanceConfigurationForVulnerabilitiesAws", "subtype_name": "GovernanceConfigurationForVulnerabilitiesAws"}, {"subtype_model": "GovernanceConfigurationForVulnerabilitiesAzure", "subtype_name": "GovernanceConfigurationForVulnerabilitiesAzure"}, {"subtype_model": "GovernanceConfigurationForVulnerabilitiesGcp", "subtype_name": "GovernanceConfigurationForVulnerabilitiesGcp"}, {"subtype_model": "GovernanceConfigurationForVulnerabilitiesOci", "subtype_name": "GovernanceConfigurationForVulnerabilitiesOci"}, {"subtype_model": "GovernanceConfigurationForSecurityRecommendationAws", "subtype_name": "GovernanceConfigurationForSecurityRecommendationAws"}, {"subtype_model": "GovernanceConfigurationForServiceNowChangeManagement", "subtype_name": "GovernanceConfigurationForServiceNowChangeManagement"}, {"subtype_model": "GovernanceConfigurationForServiceNowIncidentManagement", "subtype_name": "GovernanceConfigurationForServiceNowIncidentManagement"}, {"subtype_model": "GovernanceConfigurationForServiceNowRequestManagement", "subtype_name": "GovernanceConfigurationForServiceNowRequestManagement"}, {"subtype_model": "GovernanceConfigurationForJiraDataCenterIncidentManagement", "subtype_name": "GovernanceConfigurationForJiraDataCenterIncidentManagement"}, {"subtype_model": "GovernanceConfigurationForJiraServiceDeskIncidentManagement", "subtype_name": "GovernanceConfigurationForJiraServiceDeskIncidentManagement"}, {"subtype_model": "GovernanceConfigurationForZohoServiceDeskIncidentManagement", "subtype_name": "GovernanceConfigurationForZohoServiceDeskIncidentManagement"}, {"subtype_model": "GovernanceConfigurationForTclItsmUserConfiguration", "subtype_name": "GovernanceConfigurationForTclItsmUserConfiguration"}, {"subtype_model": "GovernanceConfigurationForTclItsmCmdbConfiguration", "subtype_name": "GovernanceConfigurationForTclItsmCmdbConfiguration"}, {"subtype_model": "GovernanceConfigurationForPolicyAws", "subtype_name": "GovernanceConfigurationForPolicyAws"}, {"subtype_model": "GovernanceConfigurationForPolicyAzure", "subtype_name": "GovernanceConfigurationForPolicyAzure"}, {"subtype_model": "GovernanceConfigurationForFreshserviceIncidentManagement", "subtype_name": "GovernanceConfigurationForFreshserviceIncidentManagement"}, {"subtype_model": "GovernanceConfigurationForJiraServiceManagementIncidentManagement", "subtype_name": "GovernanceConfigurationForJiraServiceManagementIncidentManagement"}, {"subtype_model": "GovernanceConfigurationForJiraServiceManagementChangeManagement", "subtype_name": "GovernanceConfigurationForJiraServiceManagementChangeManagement"}, {"subtype_model": "GovernanceConfigurationForGithubProActiveScanner", "subtype_name": "GovernanceConfigurationForGithubProActiveScanner"}, {"subtype_model": "GovernanceConfigurationForGithubCopilot", "subtype_name": "GovernanceConfigurationForGithubCopilot"}, {"subtype_model": "GovernanceConfigurationForCostSavings", "subtype_name": "GovernanceConfigurationForCostSavings"}, {"subtype_model": "GovernanceConfigurationForKubernetesCluster", "subtype_name": "GovernanceConfigurationForKubernetesCluster"}]}, "GovernanceConfigurationBaseForActivityLog": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForOperations"}, {"properties": {"apply_default_activity_log_template": {"type": "boolean", "description": "Specifies whether default configuration templates from tenant|master_account should applied or not"}}, "type": "object"}]}, "GovernanceConfigurationBaseForAlerts": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForOperations"}, {"properties": {"apply_default_alerts_template": {"type": "boolean", "description": "Specifies whether default configuration templates from tenant|master_account should applied or not"}}, "type": "object"}]}, "GovernanceConfigurationBaseForCost": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBase"}, {"properties": {"notifications": {"description": "Notifications Settings For Cost", "$ref": "#/definitions/ConfigurationForNotifications"}}, "type": "object"}]}, "GovernanceConfigurationBaseForCostAnomaly": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForCost"}, {"properties": {"enable_realtime_notification": {"type": "boolean", "description": "Specifies whether realtime notification enabled or not."}, "enable_daily_summary_notification": {"type": "boolean", "description": "Specifies whether daily summary notification enabled or not."}}, "type": "object"}]}, "GovernanceConfigurationBaseForCostRecommendation": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForCost"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForEdp": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForCost"}, {"properties": {"notes": {"type": "string", "description": "Notes for the mentioned time period Enterprise Discount Program"}}, "type": "object"}]}, "GovernanceConfigurationBaseForForTclItsm": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForItsm"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForFreshservice": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForItsm"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForGithub": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForOperations"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForItsm": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBase"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForJiraDataCenter": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForItsm"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForJiraServiceDesk": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForItsm"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForJiraServiceManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForItsm"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForOperations": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBase"}, {"properties": {"notifications": {"description": "Notifications Settings For Operations", "$ref": "#/definitions/ConfigurationForNotifications"}}, "type": "object"}]}, "GovernanceConfigurationBaseForPolicy": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBase"}, {"properties": {"engine_preferences": {"type": "array", "description": "Policy Engine Preferences", "items": {"type": "string", "description": "Engine type of the policy", "example": "corestack_policy", "enum": ["corestack_policy", "aws_organization_policy", "azure_policy", "aws_config", "gcp_organization_policy", "gcp_policy", "kubernetes_policy", "oracle_cloud_guard"], "x-cs-enum-type": "PolicyEngineType"}}}, "type": "object"}]}, "GovernanceConfigurationBaseForResource": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBase"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForSecurity": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBase"}, {"properties": {"notifications": {"description": "Notifications Settings For Security", "$ref": "#/definitions/ConfigurationForNotifications"}, "enable_daily_summary_notification": {"type": "boolean", "description": "Specifies whether daily summary notification enabled or not"}}, "type": "object"}]}, "GovernanceConfigurationBaseForSecurityRecommendation": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForSecurity"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForServiceNow": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForItsm"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForThreats": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForSecurity"}, {"properties": {"enable_realtime_notification": {"type": "boolean", "description": "Specifies whether realtime notification enabled or not"}}, "type": "object"}]}, "GovernanceConfigurationBaseForVulnerabilities": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForSecurity"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationBaseForZohoServiceDesk": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForItsm"}, {"properties": {}, "type": "object"}]}, "GovernanceConfigurationForActivityLogAws": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForActivityLog"}, {"properties": {"region": {"type": "string", "description": "Region Id"}, "trail_name": {"type": "string", "description": "Name of the trail"}, "bucket_name": {"type": "string", "description": "S3 bucket designated for publishing log files"}, "is_multi_region_trail": {"type": "boolean", "description": "Specifies whether the trail is created in the current Region or in all Regions"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForActivityLogAws"}, "GovernanceConfigurationForActivityLogAzure": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForActivityLog"}, {"properties": {"resource_group": {"type": "string", "description": "Resource Group Name"}, "rule_name": {"type": "string", "description": "Alert Rule Name"}, "action_group": {"type": "string", "description": "Action Group"}, "is_subscription_scope": {"type": "boolean", "description": "Specifies whether the trail is created in the current Region or in all Regions"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForActivityLogAzure"}, "GovernanceConfigurationForActivityLogGcp": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForActivityLog"}, {"properties": {"sink_router_name": {"type": "string", "description": "Sink Router Name"}, "topic_name": {"type": "string", "description": "Topic Name"}, "subscription_name": {"type": "string", "description": "Subscription Name"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForActivityLogGcp"}, "GovernanceConfigurationForActivityLogOci": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForActivityLog"}, {"properties": {"region": {"type": "string", "description": "Region Id"}, "service_connector_name": {"type": "string", "description": "Service Connector Name"}, "topic_name": {"type": "string", "description": "Topic Name"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForActivityLogOci"}, "GovernanceConfigurationForAlertsAws": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForAlerts"}, {"properties": {"enabled": {"type": "boolean", "description": "Specifies whether metric alert configuration enabled or not"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForAlertsAws"}, "GovernanceConfigurationForAlertsAzure": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForAlerts"}, {"properties": {"resource_group": {"type": "string", "description": "Resource Group Name"}, "action_group": {"type": "string", "description": "Action Group"}, "is_subscription_scope": {"type": "boolean", "description": "Specifies the alert configuration level."}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForAlertsAzure"}, "GovernanceConfigurationForAlertsGcp": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForAlerts"}, {"properties": {"notification_channel_name": {"type": "string", "description": "Notification Channel Name"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForAlertsGcp"}, "GovernanceConfigurationForAlertsOci": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForAlerts"}, {"properties": {"region": {"type": "string", "description": "Region Id"}, "topic_name": {"type": "string", "description": "Topic Name"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForAlertsOci"}, "GovernanceConfigurationForCompliance": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBase"}, {"properties": {"notifications": {"description": "Notification settings for Compliance", "$ref": "#/definitions/ConfigurationForNotifications"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForCompliance"}, "GovernanceConfigurationForCostAnomaly": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForCostAnomaly"}, {"properties": {"category": {"type": "string", "description": "Cost anomaly settings category.", "example": "all", "enum": ["all", "product_category", "resource_category"], "x-cs-enum-type": "CostAnomalySettingCategory"}, "category_values": {"type": "array", "description": "List of categories.", "items": {"type": "string"}}, "minimum_cost_spend": {"type": "integer", "description": "Minimum Cost Spend", "default": 0}, "minimum_cost_impact": {"type": "integer", "description": "Minimum Cost Impact", "default": 0}, "minimum_cost_impact_percentage": {"type": "integer", "description": "Minimum Cost Anomaly Impact Percentage", "default": 0}, "cost_impact_spend_operator": {"type": "string", "description": "Cost Impact and Spend condition", "default": "and", "example": "and", "enum": ["and", "or"], "x-cs-enum-type": "CostImpactSpendOperator"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForCostAnomaly"}, "GovernanceConfigurationForCostRecommendationAzure": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForCostRecommendation"}, {"properties": {"hybrid_benefits_enabled": {"type": "boolean", "description": "Whether Hybrid Benefits Enabled Or Not"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForCostRecommendationAzure"}, "GovernanceConfigurationForCostSavings": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForCost"}, {"properties": {"true_cost_calculation": {"type": "boolean", "description": "True if the savings cost calculation has to be done through True cost. False for legacy cost calculation."}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForCostSavings"}, "GovernanceConfigurationForEDPAws": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForEdp"}, {"properties": {"commitments": {"type": "array", "description": "Enterprise Discount Program Commitment details for AWS", "items": {"$ref": "#/definitions/EdpCommitmentDetails"}}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForEDPAws"}, "GovernanceConfigurationForFreshserviceIncidentManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForFreshservice"}, {"properties": {"requester_email": {"type": "string", "description": "Email Address for Requester"}, "alerts_mapping": {"description": "Attribute mapping for Freshservice Alert", "$ref": "#/definitions/FreshserviceAlertsMapping"}, "budget_alerts_mapping": {"description": "Attribute mapping for Freshservice Budget Alerts", "$ref": "#/definitions/FreshserviceBudgetAlertsMapping"}, "security_alerts_mapping": {"description": "Attribute mapping for Freshservice Security Alerts", "$ref": "#/definitions/FreshserviceSecurityAlertMapping"}, "policy_alerts_mapping": {"description": "Attribute mapping for Freshservice Policy Alerts", "$ref": "#/definitions/FreshservicePolicyMapping"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForFreshserviceIncidentManagement"}, "GovernanceConfigurationForGithubCopilot": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForGithub"}, {"properties": {"enabled": {"type": "boolean", "description": "Specifies if GitHub Copilot governance metrics collection is enabled"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForGithubCopilot"}, "GovernanceConfigurationForGithubProActiveScanner": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForGithub"}, {"properties": {"configured_repositories": {"type": "array", "description": "list of github repository names configured for left shift scan", "items": {"type": "string"}}, "auto_provisioning_enabled": {"type": "boolean", "description": "Specifies if the provisioning state is enabled or not"}, "rule_overrides": {"type": "array", "description": "List of all the Pro Active Scanner Rules", "items": {"$ref": "#/definitions/ProActiveScannerRule"}}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForGithubProActiveScanner"}, "GovernanceConfigurationForJiraDataCenterIncidentManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForJiraDataCenter"}, {"properties": {"incident_management": {"description": "Incident management for JIRA Datacenter setting", "$ref": "#/definitions/JiraDataCenterIncidentManagementConfiguration"}, "policy_mapping": {"description": "Attribute mapping for JIRA Datacenter Policy", "$ref": "#/definitions/JiraDataCenterPolicyMapping"}, "alerts_mapping": {"description": "Attribute mapping for JIRA Datacenter Alerts", "$ref": "#/definitions/JiraDataCenterAlertMapping"}, "budget_alerts_mapping": {"description": "Attribute mapping for JIRA Datacenter Budget Alerts", "$ref": "#/definitions/JiraDataCenterBudgetAlertMapping"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForJiraDataCenterIncidentManagement"}, "GovernanceConfigurationForJiraServiceDeskIncidentManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForJiraServiceDesk"}, {"properties": {"project": {"$ref": "#/definitions/JiraProject"}, "summary": {"type": "string", "description": "Summary of the Incident"}, "selected_description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for JIRA ServiceDesk Incident Description", "example": "resource_name", "enum": ["resource_name", "resource_id", "resource_type"], "x-cs-enum-type": "JiraServiceDeskIncidentDescriptionAttribute"}}, "assignee": {"type": "string", "description": "Assignee of the Incident"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForJiraServiceDeskIncidentManagement"}, "GovernanceConfigurationForJiraServiceManagementChangeManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForJiraServiceManagement"}, {"properties": {"cost_recommendation_mapping": {"description": " Attribute mapping for Jira Service Management Cost Recommendation", "$ref": "#/definitions/JiraServiceManagementCostRecommendationMapping"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForJiraServiceManagementChangeManagement"}, "GovernanceConfigurationForJiraServiceManagementIncidentManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForJiraServiceManagement"}, {"properties": {"requester_email": {"type": "string", "description": "Email Address for Requester"}, "alerts_mapping": {"description": "Attribute mapping for Jira Service Management Alerts", "$ref": "#/definitions/JiraServiceManagementAlertsMapping"}, "budget_alerts_mapping": {"description": "Attribute mapping for Jira Service Management Budget Alerts", "$ref": "#/definitions/JiraServiceManagementBudgetAlertsMapping"}, "security_alerts_mapping": {"description": "Attribute mapping for Jira Service Management Security Alerts", "$ref": "#/definitions/JiraServiceManagementSecurityAlertMapping"}, "policy_alerts_mapping": {"description": "Attribute mapping for Jira Service Management Policy Alerts", "$ref": "#/definitions/JiraServiceManagementPolicyMapping"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForJiraServiceManagementIncidentManagement"}, "GovernanceConfigurationForKubernetesCluster": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForResource"}, {"properties": {"frequency": {"description": "Kubernetes Cluster Frequency configuration.", "$ref": "#/definitions/KubernetesClusterFrequency"}, "cost_weightage": {"description": "Kubernetes Cluster Cost weightage configuration.", "$ref": "#/definitions/KubernetesCostWeightage"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForKubernetesCluster"}, "GovernanceConfigurationForLogAnalyticsWorkspacesAzure": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForOperations"}, {"properties": {"workspace_id": {"type": "string", "description": "Workspaces Id"}, "workspace_name": {"type": "string", "description": "Workspaces Name"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForLogAnalyticsWorkspacesAzure"}, "GovernanceConfigurationForMetricData": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForOperations"}, {"properties": {"refresh_interval": {"type": "integer", "description": "Metric Data Refresh Interval"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForMetricData"}, "GovernanceConfigurationForPatchManagementAzure": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForOperations"}, {"properties": {"enabled": {"type": "boolean", "description": "Specifies whether patch management configuration enabled or not"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForPatchManagementAzure"}, "GovernanceConfigurationForPolicyAws": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForPolicy"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForPolicyAws"}, "GovernanceConfigurationForPolicyAzure": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForPolicy"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForPolicyAzure"}, "GovernanceConfigurationForSecurityRecommendationAws": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForSecurityRecommendation"}, {"properties": {"security_hub_enabled": {"type": "boolean", "description": "Specifies whether Security Hub enabled or not"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForSecurityRecommendationAws"}, "GovernanceConfigurationForServiceNowChangeManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForServiceNow"}, {"properties": {"attribute_mapping": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowConfigurationComponent"}}, "risk_assessments": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowConfigurationComponent"}}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForServiceNowChangeManagement"}, "GovernanceConfigurationForServiceNowIncidentManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForServiceNow"}, {"properties": {"policy_mapping": {"description": "Attribute mapping for ServiceNow Policy", "$ref": "#/definitions/ServiceNowPolicyMapping"}, "alerts_mapping": {"description": "Attribute mapping for ServiceNow Alert", "$ref": "#/definitions/ServiceNowAlertMapping"}, "budget_alerts_mapping": {"description": "Attribute mapping for ServiceNow Budget Alert", "$ref": "#/definitions/ServiceNowBudgetAlertMapping"}, "security_alerts_mapping": {"description": "Attribute mapping for ServiceNow Security Alert", "$ref": "#/definitions/ServiceNowSecurityAlertMapping"}, "custom_endpoint": {"description": "Custom Endpoint for Incident management", "$ref": "#/definitions/ServiceNowIncidentManagementCustomEndpoint"}, "custom_fields_mapping": {"type": "array", "description": "Custom Fields Mapping of Incident Management", "items": {"$ref": "#/definitions/ServiceNowIncidentManagementCustomFieldsMapping"}}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForServiceNowIncidentManagement"}, "GovernanceConfigurationForServiceNowRequestManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForServiceNow"}, {"properties": {"request_attribute": {"type": "array", "description": "List of Request numbers for Request Management", "items": {"type": "string"}}, "request_attribute_mapping": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowRequestManagementAttributeMapping"}}, "action_mapping": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowRequestManagementActionMapping"}}, "status_mapping": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowRequestManagementStatusMapping"}}, "catalog_details": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowRequestManagementCatalogDetails"}}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForServiceNowRequestManagement"}, "GovernanceConfigurationForTclItsmCmdbConfiguration": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForForTclItsm"}, {"properties": {"cmdb_configuration_mapping": {"type": "array", "description": "Attribute mapping for  TCL ITSM CMDB", "items": {"$ref": "#/definitions/TclItsmCorestackResourceMapping"}}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForTclItsmCmdbConfiguration"}, "GovernanceConfigurationForTclItsmUserConfiguration": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForForTclItsm"}, {"properties": {"action_mapping": {"type": "array", "description": "Action mapping for TCL ITSM", "items": {"$ref": "#/definitions/TclItsmUserActionmapping"}}, "attribute_encryption": {"type": "array", "description": "Attribute encryption for TCL ITSM", "items": {"$ref": "#/definitions/TclItsmUserAttributeEncryption"}}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForTclItsmUserConfiguration"}, "GovernanceConfigurationForThreatsAws": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForThreats"}, {"properties": {"region": {"type": "string", "description": "Region Id"}, "bucket_name": {"type": "string", "description": "S3 bucket designated for publishing"}, "kms_key": {"type": "string", "description": "KMS Key name for encryption"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForThreatsAws"}, "GovernanceConfigurationForThreatsAzure": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForThreats"}, {"properties": {"resource_group": {"type": "string", "description": "Resource Group Name"}, "action_group": {"type": "string", "description": "Action Group"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForThreatsAzure"}, "GovernanceConfigurationForThreatsGcp": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForThreats"}, {"properties": {"event_threat_detection": {"type": "boolean", "description": "Specifies whether Event Threat Detection enabled or not"}, "container_threat_detection": {"type": "boolean", "description": "Specifies whether Container Threat Detection enabled or not"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForThreatsGcp"}, "GovernanceConfigurationForThreatsOci": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForThreats"}, {"properties": {"cloud_guard_enabled": {"type": "boolean", "description": "Specifies whether OCI CloudGuard enabled or not"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForThreatsOci"}, "GovernanceConfigurationForVulnerabilitiesAws": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForVulnerabilities"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForVulnerabilitiesAws"}, "GovernanceConfigurationForVulnerabilitiesAzure": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForVulnerabilities"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForVulnerabilitiesAzure"}, "GovernanceConfigurationForVulnerabilitiesGcp": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForVulnerabilities"}, {"properties": {"security_health_analytics_enabled": {"type": "boolean", "description": "Specified whether security health analytics enabled or not"}, "web_security_scanner_enabled": {"type": "boolean", "description": "Specified whether Web security scanner enabled or not"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForVulnerabilitiesGcp"}, "GovernanceConfigurationForVulnerabilitiesOci": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForVulnerabilities"}, {"properties": {"host_scan_enabled": {"type": "boolean", "description": "Specified whether host scan enabled or not"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForVulnerabilitiesOci"}, "GovernanceConfigurationForZohoServiceDeskIncidentManagement": {"allOf": [{"$ref": "#/definitions/GovernanceConfigurationBaseForZohoServiceDesk"}, {"properties": {"incident_management": {"description": "Incident management for ZOHO ServiceDesk settings", "$ref": "#/definitions/ZohoServiceDeskIncidentManagementConfiguration"}, "policy_mapping": {"description": "Attribute mapping for ZOHO ServiceDesk Policy", "$ref": "#/definitions/ZohoServiceDeskPolicyMapping"}, "alerts_mapping": {"description": "Attribute mapping for ZOHO ServiceDesk Alerts", "$ref": "#/definitions/ZohoServiceDeskAlertMapping"}, "budget_alerts_mapping": {"description": "Attribute mapping for ZOHO ServiceDesk Budget Alerts", "$ref": "#/definitions/ZohoServiceDeskBudgetAlertMapping"}}, "type": "object"}], "x-cs-type-name": "GovernanceConfigurationForZohoServiceDeskIncidentManagement"}, "GovernanceFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"govn_2504_a_test_flag": {"type": "boolean", "description": "Flag's default value", "default": false}}, "type": "object"}]}, "GraphionScoreRangeQueryOperator": {"allOf": [{"$ref": "#/definitions/AppSecopsScoreRangeQueryOperator"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "GraphionScoreRangeQueryOperator"}, "GroupingRuleCostAnomalyConfiguration": {"required": ["notification", "threshold"], "properties": {"threshold": {"description": "Cost Anomaly Threshold for Grouping Rule", "$ref": "#/definitions/GroupingRuleCostAnomalyThreshold"}, "notification": {"description": "Cost Anomaly Notification Configuration for Grouping Rule", "$ref": "#/definitions/GroupingRuleCostAnomalyNotification"}}, "type": "object"}, "GroupingRuleCostAnomalyImpact": {"required": ["op"], "properties": {"minimum_cost_impact": {"type": "number", "description": "Minimum cost impact to trigger anomaly detection for this dimension", "default": 0.0}, "minimum_cost_impact_percentage": {"type": "number", "description": "Minimum cost impact to trigger anomaly detection for this dimension", "default": 0.0}, "op": {"type": "string", "description": "Operator to combine the cost impact conditions", "example": "OR", "enum": ["OR"], "x-cs-enum-type": "CostAnomalyDimensionImpactOperator"}}, "type": "object"}, "GroupingRuleCostAnomalyNotification": {"required": ["daily_summary_email_enabled", "notifications_enabled", "notify_on_detection"], "properties": {"notifications_enabled": {"type": "boolean", "description": "Is Notifications Enabled for Grouping Rule"}, "daily_summary_email_enabled": {"type": "boolean", "description": "Is Daily Summary Notification Enabled for Grouping Rule"}, "notify_on_detection": {"type": "boolean", "description": "Is Notify On Detection Enabled for Grouping Rule"}, "notify_on_detection_emails": {"type": "array", "description": "Emails to notify immediately on anomaly detection", "default": [], "items": {"type": "string"}}, "daily_summary_emails": {"type": "array", "description": "Emails to send daily summary notification", "default": [], "items": {"type": "string"}}, "notify_on_detection_teams_webhooks": {"type": "array", "description": "Microsoft Teams webhook URLs to notify on anomaly detection", "default": [], "items": {"type": "string"}}, "notify_on_detection_webhooks": {"type": "array", "description": "Webhook URLs (Slack or generic) to notify on anomaly detection", "default": [], "items": {"type": "string"}}, "daily_summary_teams_webhooks": {"type": "array", "description": "Microsoft Teams webhook URLs for daily summary notification", "default": [], "items": {"type": "string"}}, "daily_summary_webhooks": {"type": "array", "description": "Webhook URLs (Slack or generic) for daily summary notification", "default": [], "items": {"type": "string"}}}, "type": "object"}, "GroupingRuleCostAnomalyThreshold": {"required": ["impact", "op"], "properties": {"impact": {"description": "Cost impact conditions to trigger anomaly detection for this dimension", "$ref": "#/definitions/GroupingRuleCostAnomalyImpact"}, "minimum_cost_spend": {"type": "number", "description": "Minimum cost spend to trigger anomaly detection for this Grouping Rule", "default": 0.0}, "op": {"type": "string", "description": "Operator to combine the threshold conditions", "example": "AND", "enum": ["AND", "OR"], "x-cs-enum-type": "CostAnomalyThresholdOperator"}}, "type": "object"}, "GroupingWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/WidgetConfiguration"}, {"properties": {"numCols": {"type": "integer"}, "numRows": {"type": "integer"}, "widgets": {"type": "array", "items": {"$ref": "#/definitions/WidgetComposition"}}}, "type": "object"}], "x-cs-type-name": "GroupingWidgetConfiguration"}, "GuardrailModel": {"required": ["category", "label", "name"], "properties": {"category": {"type": "string", "description": "Category of the guardrail"}, "name": {"type": "string", "description": "Name of the guardrail"}, "label": {"type": "string", "description": "Label of the guardrail"}}, "type": "object"}, "HeatstackFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"heat_2601_a_cost_rate_optimization": {"type": "boolean", "description": "Flag's default value", "default": false}, "heat_2601_a_azure_aks_cluster": {"type": "boolean", "description": "Flag's default value", "default": false}, "heat_2601_a_google_gke_cluster": {"type": "boolean", "description": "Flag's default value", "default": false}, "heat_2602_a_master_account_policy_config": {"type": "boolean", "description": "Flag's default value", "default": true}, "heat_2603_b_ai_observability_119985": {"type": "boolean", "description": "Flag's default value", "default": false}}, "type": "object"}]}, "IdentityFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"iden_2601_f_csp_blob_storage_cost_discovery": {"type": "boolean", "description": "Flag's default value", "default": true}, "iden_2601_a_scim_2_0_provisioning": {"type": "boolean", "description": "Flag's default value", "default": false}, "iden_2603_f_tenant_rename_enabled": {"type": "boolean", "description": "Flag's default value", "default": false}, "iden_2603_a_saved_views": {"type": "boolean", "description": "Flag's default value", "default": true}}, "type": "object"}]}, "ImageWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/WidgetConfiguration"}, {"properties": {"image": {"$ref": "#/definitions/BrandingConfiguration"}}, "type": "object"}], "x-cs-type-name": "ImageWidgetConfiguration"}, "IndividualCostOutput": {"allOf": [{"$ref": "#/definitions/ViolationBase"}, {"properties": {"cost": {"type": "number", "description": "Predicted cost of the resource."}, "unit_of_measure": {"type": "string", "description": "The unit of the resource."}, "attributes": {"type": "string", "description": "Value for the attribute with which the cost prediction happens."}, "quantity": {"type": "number", "description": "The quantity of the resource."}}, "type": "object"}]}, "IndividualKpiBase": {"properties": {"name": {"type": "string", "description": "Name of the metric for which kpi needs to be shown.", "example": "cpu_utilization", "enum": ["cpu_utilization", "memory_utilization", "disk_utilization"], "x-cs-enum-type": "MetricNamesForKpi"}, "supported_resources": {"type": "integer", "description": "Total number of resources for which the dashboard needs to present the data."}, "maximum_utilized_resources": {"type": "integer", "description": "Number of resources which has crossed the high utilization base condition."}, "minimum_utilized_resources": {"type": "integer", "description": "Number of resources which has fallen under the minimum utilization base condition."}, "partially_utilized_resources": {"type": "integer", "description": "Number of resources which has been partially utilized."}, "average_utilization_for_resources": {"type": "number", "description": "Average Utilization Crossed for the instance/vm."}}, "type": "object"}, "InfraIssuesTimeRangeFilter": {"required": ["granularity", "start_date"], "properties": {"start_date": {"type": "string", "format": "date-time", "description": "Start date of the time period"}, "end_date": {"type": "string", "format": "date-time", "description": "End date of the time period"}, "granularity": {"type": "string", "description": "Granularity for aggregating issues trend data", "example": "day", "enum": ["day", "month"], "x-cs-enum-type": "InfraIssuesTrendGranularity"}}, "type": "object"}, "InfraMisConfiguration": {"properties": {"snapshot_date": {"type": "string", "format": "date-time", "description": "Snapshot date of the recommendation (YYYY-MM-DD format)"}, "status": {"type": "string", "description": "Status of the policy resource recommendation", "example": "error", "enum": ["error", "in_progress", "open", "resolved", "skipped", "system_skipped"], "x-cs-enum-type": "PolicyResourceRecommendationStatus"}, "count": {"type": "integer", "description": "Count value (0 for deleted, 1 for active)"}, "policy_id": {"type": "string", "description": "Policy ID associated with the recommendation", "x-cs-type": "ObjectId"}, "recommendation_definition_id": {"type": "string", "description": "Recommendation definition ID", "x-cs-type": "ObjectId"}, "created_at": {"type": "string", "format": "date-time", "description": "Timestamp when the recommendation was created"}, "service_account_id": {"type": "string", "description": "Cloud provider name", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Unique ID of the resource"}, "resource": {"type": "string", "description": "Resource identifier"}, "resource_name": {"type": "string", "description": "Name of the resource"}, "region": {"type": "string", "description": "Region of the resource"}, "resource_type": {"type": "string", "description": "Type of the resource"}, "resource_category": {"type": "string", "description": "Category of the resource"}, "resource_group": {"type": "string", "description": "Resource group of the resource"}, "current_sku": {"type": "string", "description": "Current SKU (cost recommendations only)"}, "recommended_sku": {"type": "string", "description": "Recommended SKU (cost recommendations only)"}, "currency": {"type": "string", "description": "Currency code (cost recommendations only)", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "saving_per_day": {"type": "number", "description": "Estimated daily cost savings(cost recommendations only)"}, "saving_per_month": {"type": "number", "description": "Estimated monthly cost saving(cost recommendations only)"}, "saving_per_year": {"type": "number", "description": "Estimated yearly cost saving(cost recommendations only)"}}, "type": "object"}, "InfraMisConfigurationsTrendListFiltersSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "resource", "enum": ["resource", "severity", "service_name", "resource_id", "resource_name"], "x-cs-enum-type": "InfraMisConfigurationsTrendListFiltersSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "InfraMisConfigurationsTrendListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/InfraMisConfigurationsTrendListFiltersSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/InfraMisConfigurationsTrendListRequestFilters"}}, "type": "object"}, "InfraMisConfigurationsTrendListRequestFilters": {"allOf": [{"$ref": "#/definitions/InfraIssuesTimeRangeFilter"}, {"properties": {"filters": {"description": "Filters applied to the issues trend data.", "$ref": "#/definitions/SecurityInfraIssuesDashboardFilters"}, "search": {"type": "string", "description": "Search text to filter the infrastructure misconfigurations based on resource name, resource id, service name, etc."}}, "type": "object"}]}, "InfraMisConfigurationsTrendSummary": {"properties": {"date": {"type": "string", "format": "date", "description": "Date of the time period"}, "severity": {"type": "string", "description": "Severity of the misconfiguration", "example": "critical", "enum": ["critical", "high", "medium", "low", "informational"], "x-cs-enum-type": "MisconfigurationSeverity"}, "count": {"type": "integer", "description": "Count of misconfigurations for the given date and severity"}}, "type": "object"}, "InfraMisConfigurationsTrendSummaryRequest": {"allOf": [{"$ref": "#/definitions/InfraIssuesTimeRangeFilter"}, {"properties": {"group_by": {"type": "array", "description": "Fields to group the infrastructure misconfigurations results", "items": {"type": "string", "description": "Field to group the infrastructure misconfigurations results", "example": "severity", "enum": ["severity"], "x-cs-enum-type": "InfraMisConfigurationsTrendGroupBy"}}, "filters": {"description": "Filters applied to the issues trend data.", "$ref": "#/definitions/SecurityInfraIssuesDashboardFilters"}}, "type": "object"}]}, "InfraMisconfigurationTrendResponse": {"properties": {"items": {"type": "array", "description": "List of infra misconfiguration trend recommendation items", "items": {"$ref": "#/definitions/InfraMisConfiguration"}}, "next_list_context": {"description": "Pagination context for the next batch", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "InfraResourceActivityEvent": {"properties": {"history_id": {"type": "string", "description": "Unique change event identifier."}, "changed_at": {"type": "string", "format": "date-time", "description": "Timestamp when the change was detected."}, "change_type": {"type": "string", "description": "Type of change: new, modified, discovered"}, "changed_attributes": {"type": "object", "description": "Post-change attribute values. Present only in Mode 2 (when event_ids are provided). Removed attributes appear as null."}}, "type": "object"}, "InfraResourceActivityRequest": {"required": ["resource", "resource_category", "resource_id", "resource_type", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID. Can be fetched from the List Tenants API.", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Unique provider resource identifier."}, "resource_category": {"type": "string", "description": "Category of the resource (e.g. Compute, Storage, Network)."}, "resource_type": {"type": "string", "description": "Type of the resource."}, "resource": {"type": "string", "description": "Resources of the cloud provider (e.g. Instances, SecurityGroups)."}, "start_date": {"type": "string", "format": "date-time", "description": "Start of retention window. Defaults to now minus 90 days."}, "end_date": {"type": "string", "format": "date-time", "description": "End of retention window. Defaults to today."}, "change_type_filter": {"type": "array", "items": {"type": "string", "description": "Filter timeline by InfraResourceChangeStatus values (e.g. new, modified, deleted).", "example": "added", "enum": ["added", "unchanged", "modified", "deleted"], "x-cs-enum-type": "InfraResourceChangeStatus"}}, "event_ids": {"type": "array", "description": "If provided (1-2 IDs), returns attribute details for these events (Mode 2). If absent, returns paginated timeline (Mode 1).", "items": {"type": "string"}}, "list_context": {"description": "Pagination context. Used in Mode 1 only. Default batch_size=25.", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "InfraResourceActivityResponse": {"properties": {"events": {"type": "array", "description": "List of activity events.", "items": {"$ref": "#/definitions/InfraResourceActivityEvent"}}, "next_list_context": {"description": "Pagination context for next page. Present only in Mode 1.", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "InfraResourceDetailRequest": {"required": ["resource", "resource_category", "resource_id", "resource_type", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID. Can be fetched from the List Tenants API.", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Unique provider resource identifier."}, "service_account_id": {"type": "string", "description": "Cloud account ID to scope the lookup.", "x-cs-type": "ObjectId"}, "resource_category": {"type": "string", "description": "Category of the resource (e.g. Compute, Storage, Network)."}, "resource_type": {"type": "string", "description": "Type of the resource."}, "resource": {"type": "string", "description": "Resources of the cloud provider (e.g. Instances, SecurityGroups)."}}, "type": "object"}, "InfraResourceDetailResponse": {"properties": {"canonical_type": {"type": "string", "description": "Canonical resource type (e.g. ComputeInstance, VirtualNetwork)."}, "created_at": {"type": "string", "format": "date-time", "description": "Timestamp when the resource was first discovered."}, "attributes": {"type": "object", "description": "All canonical properties for this resource type. Keys vary by canonical_type (e.g. instanceType, vCpus for ComputeInstance; addressSpace for VirtualNetwork)."}}, "type": "object"}, "InfraResourceTrendListBaseFilters": {"allOf": [{"$ref": "#/definitions/InfraResourceTrendSummaryBaseFilters"}, {"properties": {"search": {"type": "string", "description": "Search based on resource category, resource type,resource name or resource ID."}}, "type": "object"}]}, "InfraResourceTrendRequestBase": {"required": ["start_date"], "properties": {"start_date": {"type": "string", "format": "date-time", "description": "Start date of the trend analysis period."}, "end_date": {"type": "string", "format": "date-time", "description": "End date of the trend analysis period."}}, "type": "object"}, "InfraResourceTrendResource": {"properties": {"cloud_account_id": {"type": "string", "description": "ID of the cloud account", "x-cs-type": "ObjectId"}, "inventory_id": {"type": "string", "description": "Internal inventory identifier for the resource.", "x-cs-type": "ObjectId"}, "cloud_provider": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "region": {"type": "string", "description": "Region of the resource"}, "resource_category": {"type": "string", "description": "Category of the resource"}, "resource_type": {"type": "string", "description": "Type of the resource"}, "resource": {"type": "string", "description": "Specific resource name or instance identifier "}, "resource_id": {"type": "string", "description": "Unique ID of the resource"}, "resource_name": {"type": "string", "description": "Name of the resource"}, "belongs_to_canonical_resource": {"type": "string", "description": "Canonical resource IRI linked from the workload resource via belongsToCanonicalResource."}, "tags": {"type": "array", "description": "Resource tags as key/value pairs.", "items": {"$ref": "#/definitions/InfraResourceTrendResourceTag"}}, "added_at": {"type": "string", "format": "date-time", "description": "Timestamp when the resource was added"}, "changed_at": {"type": "string", "format": "date-time", "description": "Timestamp when the resource change was detected"}, "deleted_at": {"type": "string", "format": "date-time", "description": "Timestamp when the resource was deleted"}}, "type": "object"}, "InfraResourceTrendResourceChangeStatusQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["change_statuses"], "properties": {"change_statuses": {"type": "array", "description": "Resource Change Statuses to include", "items": {"type": "string", "description": "Change status of the infrastructure resource", "example": "added", "enum": ["added", "unchanged", "modified", "deleted"], "x-cs-enum-type": "InfraResourceChangeStatus"}}}, "type": "object"}], "x-cs-type-name": "InfraResourceTrendResourceChangeStatusQueryOperator"}, "InfraResourceTrendResourceResponse": {"properties": {"resources": {"type": "array", "description": "List of resources matching the trend criteria.", "items": {"$ref": "#/definitions/InfraResourceTrendResource"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "InfraResourceTrendResourceTag": {"properties": {"key": {"type": "string", "description": "Tag key"}, "value": {"type": "string", "description": "Tag value"}}, "type": "object"}, "InfraResourceTrendSummary": {"properties": {"date": {"type": "string", "format": "date", "description": "Date of the trend data point."}, "category": {"type": "string", "description": "Resource category"}, "change_status": {"type": "string", "description": "Change status of the infrastructure resource", "example": "added", "enum": ["added", "unchanged", "modified", "deleted"], "x-cs-enum-type": "InfraResourceChangeStatus"}, "count": {"type": "integer", "description": "Count of resources for the given date and category."}}, "type": "object"}, "InfraResourceTrendSummaryBaseFilters": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID to filter the resources. This can be fetched from the List Tenants API call.", "x-cs-type": "ObjectId"}, "query": {"description": "Query based on Cloud Providers, Cloud Account Ids, Statuses, Severities, ResourceCategories, ResourceTypes, Resources, Resource ID(s)", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "InfraResourceTrendSummaryListRequest": {"allOf": [{"$ref": "#/definitions/InfraResourceTrendRequestBase"}, {"properties": {"filters": {"description": "Filters applied to the trend data.", "$ref": "#/definitions/InfraResourceTrendListBaseFilters"}, "list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}}, "type": "object"}]}, "InfraResourceTrendSummaryRequest": {"allOf": [{"$ref": "#/definitions/InfraResourceTrendRequestBase"}, {"required": ["granularity", "group_by"], "properties": {"filters": {"description": "Filters applied to the trend data.", "$ref": "#/definitions/InfraResourceTrendSummaryBaseFilters"}, "granularity": {"type": "string", "description": "Granularity for aggregating resource trend data", "example": "day", "enum": ["day", "month"], "x-cs-enum-type": "InfraIssuesTrendGranularity"}, "group_by": {"type": "string", "description": "Grouping criteria for the trend data.", "example": "category", "enum": ["category", "change_status"], "x-cs-enum-type": "InfraResourceTrendGroupBy"}}, "type": "object"}]}, "InfraThreatsTrendListFiltersSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "resource", "enum": ["resource", "severity", "service_name", "resource_id", "status", "resource_name"], "x-cs-enum-type": "InfraThreatsTrendListFiltersSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "InfraThreatsTrendListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/InfraThreatsTrendListFiltersSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/InfraThreatsTrendListRequestFilters"}}, "type": "object"}, "InfraThreatsTrendListRequestFilters": {"allOf": [{"$ref": "#/definitions/InfraIssuesTimeRangeFilter"}, {"properties": {"filters": {"description": "Filters applied to the issues trend data.", "$ref": "#/definitions/SecurityInfraIssuesDashboardFilters"}, "search": {"type": "string", "description": "Search text to filter the infrastructure threats based on resource name, resource id, service name, etc."}}, "type": "object"}]}, "InfraThreatsTrendSummary": {"properties": {"date": {"type": "string", "format": "date", "description": "Date of the time period"}, "severity": {"type": "string", "description": "Severity of the threat", "example": "Critical", "enum": ["Critical", "High", "Info", "Low", "Medium", "None", "Unknown"], "x-cs-enum-type": "Severity"}, "count": {"type": "integer", "description": "Count of threats for the given date and severity"}}, "type": "object"}, "InfraThreatsTrendSummaryRequest": {"allOf": [{"$ref": "#/definitions/InfraIssuesTimeRangeFilter"}, {"properties": {"group_by": {"type": "array", "description": "Fields to group the infrastructure threat result", "items": {"type": "string", "description": "Field to group the infrastructure threat results", "example": "severity", "enum": ["severity"], "x-cs-enum-type": "InfraThreatsTrendGroupBy"}}, "filters": {"description": "Filters applied to the issues trend data.", "$ref": "#/definitions/SecurityInfraIssuesDashboardFilters"}}, "type": "object"}]}, "InfraVulnerabilitiesTrendListFiltersSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "resource", "enum": ["resource", "severity", "service_name", "resource_id", "status", "resource_name", "findings_id"], "x-cs-enum-type": "InfraVulnerabilitiesTrendListFiltersSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "InfraVulnerabilitiesTrendListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/InfraVulnerabilitiesTrendListFiltersSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/InfraVulnerabilitiesTrendListRequestFilters"}}, "type": "object"}, "InfraVulnerabilitiesTrendListRequestFilters": {"allOf": [{"$ref": "#/definitions/InfraIssuesTimeRangeFilter"}, {"properties": {"filters": {"description": "Filters applied to the issues trend data.", "$ref": "#/definitions/SecurityInfraIssuesDashboardFilters"}, "search": {"type": "string", "description": "Search text to filter the infrastructure vulnerabilities based on resource name, resource id, service name, etc."}}, "type": "object"}]}, "InfraVulnerabilitiesTrendSummary": {"properties": {"date": {"type": "string", "format": "date", "description": "Date of the time period"}, "severity": {"type": "string", "description": "Severity of the Vulnerability", "example": "Critical", "enum": ["Critical", "High", "Info", "Low", "Medium", "None", "Unknown"], "x-cs-enum-type": "Severity"}, "count": {"type": "integer", "description": "Count of vulnerabilities for the given date and severity"}}, "type": "object"}, "InfraVulnerabilitiesTrendSummaryRequest": {"allOf": [{"$ref": "#/definitions/InfraIssuesTimeRangeFilter"}, {"properties": {"group_by": {"type": "array", "description": "Fields to group the infrastructure vulnerability results", "items": {"type": "string", "description": "Field to group the infrastructure vulnerability results", "example": "severity", "enum": ["severity"], "x-cs-enum-type": "InfraVulnerabilitiesTrendGroupBy"}}, "filters": {"description": "Filters applied to the issues trend data.", "$ref": "#/definitions/SecurityInfraIssuesDashboardFilters"}}, "type": "object"}]}, "InfrastructureResourcesByResourceCategoryWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "InfrastructureResourcesByResourceCategoryWidgetConfiguration"}, "InfrastructureResourcesInventoryOverviewWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "InfrastructureResourcesInventoryOverviewWidgetConfiguration"}, "InfrastructureResourcesIssuesFlowWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "InfrastructureResourcesIssuesFlowWidgetConfiguration"}, "InputStream": {"properties": {"bytes": {"type": "object"}}, "type": "object"}, "IntegratedToolAccount": {"properties": {"id": {"type": "string", "description": "Tool Account ID", "x-cs-type": "ObjectId"}}, "type": "object"}, "IntegratedToolProductActivation": {"properties": {"resource_category": {"type": "string", "description": "Resource category for Integrated Tool product activation"}, "resource": {"type": "array", "description": "List of Resources in Integrated Tool Product Activation", "items": {"type": "string"}}}, "type": "object"}, "InventoryData": {"required": ["data", "type"], "properties": {"data": {"type": "array", "description": "Filters available in inventory", "items": {"type": "object"}}, "type": {"type": "string", "description": "Type of the data available in models list"}}, "type": "object"}, "InventoryFilterRequest": {"required": ["cloud_account"], "properties": {"cloud_account": {"type": "array", "description": "Cloud accounts", "items": {"$ref": "#/definitions/InventoryFilterRequestDataModel"}}}, "type": "object"}, "InventoryFilterRequestDataModel": {"required": ["id", "name", "preferred_regions"], "properties": {"name": {"type": "string", "description": "Name of the cloud account"}, "id": {"type": "string", "description": "ID of the cloud account"}, "preferred_regions": {"type": "array", "description": "Preferred region of AWS account", "items": {"type": "string"}}}, "type": "object"}, "InventoryResourceDetailsDataModel": {"required": ["category", "cloud_account", "component", "resource", "service"], "properties": {"cloud_account": {"type": "array", "description": "Id of the cloud account", "items": {"$ref": "#/definitions/CloudAccountDetail"}}, "service": {"type": "string", "description": "Cloud service name", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "category": {"type": "string", "description": "Name of the resource category. It can be fetched from the Get Inventory Count Api"}, "component": {"type": "string", "description": "Name of the resource type. It can be fetched from the Get Inventory Count Api"}, "resource": {"type": "string", "description": "Name of the resource. It can be fetched from the Get Inventory Count Api"}, "operation_id": {"type": "string", "description": "Specify the Operation ID. It can be fetched from the Get Inventory Count Api"}, "fetch_live_status": {"type": "boolean", "description": "Specify to fetch the live ping status of the AWS SSM enabled instance."}}, "type": "object"}, "InventoryResourceDetailsModelList": {"required": ["cloud", "cloud_account_id", "cloud_account_name", "corestack_resource_id", "resource", "resource_category", "resource_type", "summary_details", "tags", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "tenant_id of the resource inventory"}, "cloud": {"type": "string", "description": "Name of the cloud"}, "cloud_account_id": {"type": "string", "description": "Id of the cloud account"}, "cloud_account_name": {"type": "string", "description": "Inventory summary details"}, "resource_category": {"type": "string", "description": "Name of the category"}, "resource_type": {"type": "string", "description": "Name of the component"}, "resource": {"type": "string", "description": "Name of the resource"}, "corestack_resource_id": {"type": "string", "description": "Unique element for the resource"}, "tags": {"type": "object", "description": "Tags associated with the resource"}, "summary_details": {"type": "object", "description": "Inventory summary details"}}, "type": "object"}, "InventoryResourceDetailsRequest": {"required": ["filters"], "properties": {"filters": {"description": "Filter resource details", "$ref": "#/definitions/InventoryResourceDetailsDataModel"}}, "type": "object"}, "InventoryResourceDetailsResponse": {"required": ["count", "resource_details"], "properties": {"count": {"type": "string", "description": "Inventory summary details"}, "resource_details": {"type": "array", "description": "Inventory summary details", "items": {"$ref": "#/definitions/InventoryResourceDetailsModelList"}}}, "type": "object"}, "InventoryResponse": {"required": ["filters"], "properties": {"filters": {"type": "array", "description": "Filters available in inventory", "items": {"$ref": "#/definitions/InventoryData"}}}, "type": "object"}, "InventoryWiseUsage": {"properties": {"service_name": {"type": "string", "description": "Name of the service"}, "tenant_name": {"type": "string", "description": "Name of the tenant"}, "service_accounts": {"type": "array", "items": {"type": "string", "description": "List of cloud accounts"}}, "total_count": {"type": "integer", "description": "Total count of the inventory usage"}, "top_consumption": {"type": "array", "description": "List of top consumption usage data", "items": {"$ref": "#/definitions/TopConsumptionUsage"}}}, "type": "object"}, "JiraDataCenterAlertMapping": {"allOf": [{"$ref": "#/definitions/JiraDataCenterMappingBase"}, {"properties": {"selected_description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for JIRA DataCenter Alerts Description", "example": "cloud", "enum": ["cloud", "project_name", "classification", "sub_classification", "alert_type", "cost_impact", "created_date", "baseline_value"], "x-cs-enum-type": "JiraDataCenterAlertDescriptionAttribute"}}, "selected_summary_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for JIRA DataCenter Alerts Summary", "example": "cloud_account_name", "enum": ["cloud_account_name", "resource_id"], "x-cs-enum-type": "JiraDataCenterAlertSummaryAttribute"}}}, "type": "object"}]}, "JiraDataCenterAvatarUrl": {"properties": {"url_16x16": {"type": "string", "description": "Avatar URL of type 16x16"}, "url_24x24": {"type": "string", "description": "Avatar URL of type 24x24"}, "url_32x32": {"type": "string", "description": "Avatar URL of type 32x32"}, "url_48x48": {"type": "string", "description": "Avatar URL of type 48x48"}}, "type": "object"}, "JiraDataCenterBudgetAlertMapping": {"allOf": [{"$ref": "#/definitions/JiraDataCenterMappingBase"}, {"properties": {"issue_type": {"description": "IssueType attribute mapping for JIRA DataCenter", "$ref": "#/definitions/JiraDataCenterIssueType"}, "selected_description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for JIRA DataCenter Budget Alerts Description", "example": "actual_amount", "enum": ["actual_amount", "budget_amount", "budget_frequency", "budget_name", "budget_type", "configuration_type", "created_at", "currency", "threshold_percentage", "updated_at"], "x-cs-enum-type": "JiraDataCenterBudgetAlertDescriptionAttribute"}}}, "type": "object"}]}, "JiraDataCenterIncidentManagementConfiguration": {"properties": {"project": {"$ref": "#/definitions/JiraProject"}, "summary": {"type": "string", "description": "Summary of the Incident"}, "selected_description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for JIRA ServiceDesk Incident Description", "example": "resource_name", "enum": ["resource_name", "resource_id", "resource_type"], "x-cs-enum-type": "JiraServiceDeskIncidentDescriptionAttribute"}}, "assignee": {"type": "string", "description": "Assignee of the Incident"}}, "type": "object"}, "JiraDataCenterIssueType": {"properties": {"item": {"type": "string", "description": "Attribute of the JIRA issue"}, "item_id": {"type": "string", "description": "ID of the Issue"}, "description": {"type": "string", "description": "Description of the Issue"}, "iconUrl": {"type": "string", "description": "Icon URL of the Issue"}, "name": {"type": "string", "description": "Name of the Issue"}, "subtask": {"type": "string", "description": "Subtask of the issue"}, "avatarId": {"type": "integer", "description": "Avatar ID of the issue"}}, "type": "object"}, "JiraDataCenterMappingBase": {"properties": {"project": {"description": "Projects attribute mapping for JIRA DataCenter", "$ref": "#/definitions/JiraDataCenterProject"}, "priority": {"type": "string", "description": "Priority for JIRA DataCenter Policy", "example": "low", "enum": ["low", "medium", "high"], "x-cs-enum-type": "JiraDataCenterPriority"}}, "type": "object"}, "JiraDataCenterPolicyMapping": {"allOf": [{"$ref": "#/definitions/JiraDataCenterMappingBase"}, {"properties": {"issue_type": {"description": "IssueType attribute mapping for JIRA DataCenter", "$ref": "#/definitions/JiraDataCenterIssueType"}, "selected_description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for JIRA DataCenter Policy Description", "example": "classification", "enum": ["classification", "content_type", "created_at", "created_by", "display_name", "engine_type", "operating_system", "policy_id", "policy_type", "resources", "services", "severity", "status", "sub_classification", "updated_at", "updated_by", "uri"], "x-cs-enum-type": "JiraDataCenterPolicyDescriptionAttribute"}}, "selected_summary_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for JIRA DataCenter Policy Summary", "example": "policy_name", "enum": ["policy_name", "cloud_account_name"], "x-cs-enum-type": "JiraDataCenterPolicySummaryAttribute"}}}, "type": "object"}]}, "JiraDataCenterProject": {"allOf": [{"$ref": "#/definitions/JiraProject"}, {"properties": {"expand": {"type": "string", "description": "Expansion attribute of the project"}, "avatarUrls": {"description": "Avatar Urls for Integrated Tools Projects", "$ref": "#/definitions/JiraDataCenterAvatarUrl"}}, "type": "object"}]}, "JiraProject": {"properties": {"name": {"type": "string", "description": "Name of the project"}, "key": {"type": "string", "description": "Key of the project"}, "item_id": {"type": "string", "description": "ID of the project"}, "url": {"type": "string", "description": "URL of the project"}}, "type": "object"}, "JiraServiceManagementAlertsMapping": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementMappingBase"}, {"properties": {"description_attributes": {"type": "array", "description": "List of Alert Attribute enums.", "items": {"type": "string", "description": "Allowed attributes for Alerts Description", "example": "account_id", "enum": ["account_id", "alarm_name", "cloud", "location", "metric_name", "metric_value", "operator", "resource", "resource_group", "resource_id", "resource_name", "resource_type", "service_account_name", "subscription_id", "tenant_name", "threshold", "time_aggregation"], "x-cs-enum-type": "DescriptionAttributeForItsmAlert"}}, "attribute_mappings": {"type": "array", "description": "List of Alert Attribute mappings.", "items": {"$ref": "#/definitions/JiraServiceManagementIncidentManagementConfigurationMappingForAlerts"}}}, "type": "object"}]}, "JiraServiceManagementBudgetAlertsMapping": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementMappingBase"}, {"properties": {"description_attributes": {"type": "array", "description": "List of Budget Alert attribute enums.", "items": {"type": "string", "description": "Allowed attributes for Budget Alerts Description", "example": "actual_amount", "enum": ["actual_amount", "budget_amount", "budget_frequency", "budget_name", "budget_type", "configuration_type", "created_at", "currency", "impacted_accounts", "threshold_percentage", "updated_at"], "x-cs-enum-type": "DescriptionAttributeForItsmBudgetAlert"}}, "attribute_mappings": {"type": "array", "description": "List of Budget Alert attribute mappings.", "items": {"$ref": "#/definitions/JiraServiceManagementIncidentManagementConfigurationMappingForBudgetAlerts"}}}, "type": "object"}]}, "JiraServiceManagementChangeManagementConfigurationMapping": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementConfigurationMappingBase"}, {"properties": {}, "type": "object"}]}, "JiraServiceManagementChangeManagementConfigurationMappingForCostRecommendation": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementChangeManagementConfigurationMapping"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Cost Recommendation Description", "example": "action_name", "enum": ["action_name", "classification", "current_sku", "impact", "optimization_type", "project_name", "recommendation_id", "recommended_sku", "resource_id", "resource_name", "service_account_name", "sub_classification"], "x-cs-enum-type": "DescriptionAttributeForChangeManagementForCostRecommendation"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "JiraServiceManagementConfigurationMappingBase": {"properties": {"name": {"type": "string", "description": "Name of the attribute"}}, "type": "object"}, "JiraServiceManagementCostRecommendationMapping": {"properties": {"attribute_mappings": {"type": "array", "description": "List of Cost Recommendation attribute mappings.", "items": {"$ref": "#/definitions/JiraServiceManagementChangeManagementConfigurationMappingForCostRecommendation"}}}, "type": "object"}, "JiraServiceManagementIncidentManagementConfigurationMapping": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementConfigurationMappingBase"}, {"properties": {}, "type": "object"}]}, "JiraServiceManagementIncidentManagementConfigurationMappingForAlerts": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementIncidentManagementConfigurationMapping"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Alerts Description", "example": "account_id", "enum": ["account_id", "alarm_name", "cloud", "location", "metric_name", "metric_value", "operator", "resource", "resource_group", "resource_id", "resource_name", "resource_type", "service_account_name", "subscription_id", "tenant_name", "threshold", "time_aggregation"], "x-cs-enum-type": "DescriptionAttributeForItsmAlert"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "JiraServiceManagementIncidentManagementConfigurationMappingForBudgetAlerts": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementIncidentManagementConfigurationMapping"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Budget Alerts Description", "example": "actual_amount", "enum": ["actual_amount", "budget_amount", "budget_frequency", "budget_name", "budget_type", "configuration_type", "created_at", "currency", "impacted_accounts", "threshold_percentage", "updated_at"], "x-cs-enum-type": "DescriptionAttributeForItsmBudgetAlert"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "JiraServiceManagementIncidentManagementConfigurationMappingForPolicyViolation": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementIncidentManagementConfigurationMapping"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Policy Description", "example": "tenant_name", "enum": ["tenant_name", "master_account_name", "service_name", "account_id", "service_account_name", "policy_classification", "policy_name", "policy_description", "resource_type", "resource_id", "resource_name", "subscription_id", "subscription_name", "resource_group", "location"], "x-cs-enum-type": "DescriptionAttributeForItsmPolicy"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "JiraServiceManagementIncidentManagementConfigurationMappingForSecurityAlert": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementIncidentManagementConfigurationMapping"}, {"properties": {"value": {"type": "string", "description": "Allowed attributes for Security Alerts Description", "example": "tenant_name", "enum": ["tenant_name", "service_account_name", "service_name", "account_id", "findings_type", "severity", "status", "alert_description", "intent", "affected_resource", "count", "resource_type", "resource_id", "resource_name", "resource_group", "subscription_name", "location"], "x-cs-enum-type": "DescriptionAttributeForItsmSecurityAlert"}, "value_direct": {"type": "string"}}, "type": "object"}]}, "JiraServiceManagementListProjectFieldsResponse": {"properties": {"fields": {"type": "array", "items": {"$ref": "#/definitions/JiraServiceManagementProjectFields"}}}, "type": "object"}, "JiraServiceManagementMappingBase": {"properties": {"description_text": {"type": "string", "description": "Sample Format text of incident description by selected description attributes."}}, "type": "object"}, "JiraServiceManagementPolicyMapping": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementMappingBase"}, {"properties": {"description_attributes": {"type": "array", "description": "List of Policy attribute enums.", "items": {"type": "string", "description": "Allowed attributes for Policy Description", "example": "tenant_name", "enum": ["tenant_name", "master_account_name", "service_name", "account_id", "service_account_name", "policy_classification", "policy_name", "policy_description", "resource_type", "resource_id", "resource_name", "subscription_id", "subscription_name", "resource_group", "location"], "x-cs-enum-type": "DescriptionAttributeForItsmPolicy"}}, "attribute_mappings": {"type": "array", "description": "List of Policy attribute mappings.", "items": {"$ref": "#/definitions/JiraServiceManagementIncidentManagementConfigurationMappingForPolicyViolation"}}}, "type": "object"}]}, "JiraServiceManagementProjectFields": {"properties": {"key": {"type": "string", "description": "Key associated with the field"}, "name": {"type": "string", "description": "Name of the field"}}, "type": "object"}, "JiraServiceManagementProjectFieldsRequest": {"required": ["issue_type", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "issue_type": {"type": "string", "description": "Jira Service Management Issue Type", "example": "ChangeManagement", "enum": ["ChangeManagement", "IncidentManagement"], "x-cs-enum-type": "JiraServiceManagementIssueType"}}, "type": "object"}, "JiraServiceManagementSecurityAlertMapping": {"allOf": [{"$ref": "#/definitions/JiraServiceManagementMappingBase"}, {"properties": {"description_attributes": {"type": "array", "description": "List of Security Alert attribute enums.", "items": {"type": "string", "description": "Allowed attributes for Security Alerts Description", "example": "tenant_name", "enum": ["tenant_name", "service_account_name", "service_name", "account_id", "findings_type", "severity", "status", "alert_description", "intent", "affected_resource", "count", "resource_type", "resource_id", "resource_name", "resource_group", "subscription_name", "location"], "x-cs-enum-type": "DescriptionAttributeForItsmSecurityAlert"}}, "attribute_mappings": {"type": "array", "description": "List of Security Alert attribute mappings.", "items": {"$ref": "#/definitions/JiraServiceManagementIncidentManagementConfigurationMappingForSecurityAlert"}}}, "type": "object"}]}, "JobDetails": {"required": ["host", "keypair_flag", "parameters", "platform", "port", "script_name", "username"], "properties": {"username": {"type": "string", "description": "User name of virtual machine where the script will be scheduled"}, "parameters": {"description": "Parameters (Chef and Shell) or the manifest files to the execution", "$ref": "#/definitions/ParameterDetails"}, "keypair_flag": {"type": "string", "description": "Status of the key value pair set in Virtual Machine", "example": "true", "enum": ["true", "false"], "x-cs-enum-type": "TrueFalse"}, "script_name": {"type": "array", "description": "Script Name to be scheduled", "items": {"type": "string"}}, "platform": {"type": "string", "description": "OS(Operating System) Platform of the virtual machine"}, "host": {"type": "string", "description": "Host IP address of virtual machine"}, "key_file": {"type": "string", "description": "Key Value Pair(.pem file).Note - If key_file field is given, password field can be empty"}, "password": {"type": "string", "description": "Password of virtual machine.Note - If password is given, key_file field can be empty"}, "port": {"type": "string", "description": "Port of the Virtual Machine"}}, "type": "object"}, "JobExecutionDetailsResponse": {"required": ["arguments", "cloud_accounts", "created_at", "created_by", "engine", "execution_type", "job_id", "name", "policy_id", "policy_name", "status_reason", "tenant_name", "updated_at", "updated_by"], "properties": {"job_id": {"type": "string", "description": "Job Id"}, "name": {"type": "string", "description": "Name of the Job"}, "status": {"type": "string", "description": "Status of policy job execution", "example": "COMPLETED", "enum": ["COMPLETED", "FAILED", "IN_PROGRESS"], "x-cs-enum-type": "PolicyJobStatus"}, "status_reason": {"type": "string", "description": "Reason for the job status"}, "engine": {"type": "string", "description": "Policy engine used for job execution"}, "arguments": {"type": "string", "description": "arguments provided for job execution"}, "cloud_accounts": {"type": "string", "description": "Cloud account used for job execution"}, "execution_type": {"type": "string", "description": "Policy execution type can be on demand or scheduled"}, "created_by": {"type": "string", "description": "Policy Job created by"}, "created_at": {"type": "string", "description": "Policy Job create time in UTC"}, "updated_by": {"type": "string", "description": "Policy Job updated by"}, "updated_at": {"type": "string", "description": "Policy Job update time in UTC"}, "tenant_name": {"type": "string", "description": "tenant name where job was created"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "policy_id": {"type": "string", "description": "Policy id of the Policy executed"}, "policy_name": {"type": "string", "description": "Policy id of the Policy executed"}, "output": {"type": "array", "description": "Job output details", "items": {"$ref": "#/definitions/JobExecutionOutputDetails"}}}, "type": "object"}, "JobExecutionOutputDetails": {"properties": {"resource_id": {"type": "string", "description": "Resource Id"}, "resource_name": {"type": "string", "description": "Resource Name"}, "category": {"type": "string", "description": "Resource Category"}, "resource_type": {"type": "string", "description": "Resource Type"}, "resource": {"type": "string", "description": "Resource"}, "location": {"type": "string", "description": "Location"}, "evidence": {"type": "string", "description": "Evidence"}}, "type": "object"}, "KeyValuePair": {"properties": {"key": {"type": "string", "description": "Key of the pair"}, "value": {"type": "string", "description": "Value of the pair"}}, "type": "object"}, "KeyValuePairKind": {"allOf": [{"$ref": "#/definitions/KeyValuePair"}, {"properties": {"kind": {"type": "string", "description": "Type of the key"}}, "type": "object"}]}, "KeyValues": {"properties": {"key": {"type": "string", "description": "Key of the pair"}, "values": {"type": "array", "description": "Values of the key", "items": {"type": "string"}}}, "type": "object"}, "KnownExploitedVulnerability": {"properties": {"cve_id": {"type": "string", "description": "The CVE ID of the vulnerability in the format CVE-YYYY-NNNN, note that the number portion can have more than 4 digits"}, "vendor_project": {"type": "string", "description": "The vendor or project name for the vulnerability"}, "product": {"type": "string", "description": "The product name for the vulnerability"}, "vulnerability_name": {"type": "string", "description": "The name of the vulnerability"}, "vulnerability_added_date": {"type": "string", "format": "date", "description": "The date the vulnerability was added to the catalog"}, "short_description": {"type": "string", "description": "A short description of the vulnerability"}, "required_action": {"type": "string", "description": "The required action to address the vulnerability"}, "vulnerability_due_date": {"type": "string", "format": "date", "description": "The date the required action is due"}, "is_known_ransomware_campaign": {"type": "boolean", "description": "'True' if this vulnerability is known to have been leveraged as part of a ransomware campaign; 'False' if CISA lacks confirmation that the vulnerability has been utilized for ransomware"}, "notes": {"type": "string", "description": "Any additional notes about the vulnerability"}, "cwe_codes": {"type": "array", "items": {"type": "string", "description": "Common Weakness Enumeration (CWE) codes associated with this vulnerability. CWEs are in the format CWE-NNNN; note that the number portion can have any number of digits"}}, "created_at": {"type": "string", "format": "date-time", "description": "Vulnerability created time"}, "updated_at": {"type": "string", "format": "date-time", "description": "Vulnerability updated time"}}, "type": "object"}, "KpiMetricAggregate": {"properties": {"cpu_utilization": {"type": "array", "description": "Statistics about the CPU Utilization.", "items": {"$ref": "#/definitions/MetricDetailedData"}}, "memory_utilization": {"type": "array", "description": "Statistics about the Memory Utilization.", "items": {"$ref": "#/definitions/MetricDetailedData"}}, "disk_space_utilization": {"type": "array", "description": "Statistics about the Disk Space Utilization.", "items": {"$ref": "#/definitions/DiskUtilizationBatchResponse"}}}, "type": "object"}, "KubernetesAgentCompletePartPreSignedUrlRequest": {"properties": {"file_name": {"type": "string", "description": "Name of the file"}, "upload_id": {"type": "string", "description": "Upload ID for the multipart upload"}, "multi_parts": {"type": "array", "items": {"$ref": "#/definitions/MultiPartDetail"}}}, "type": "object"}, "KubernetesAgentPreSignedUrlRequest": {"properties": {"file_data": {"type": "array", "items": {"$ref": "#/definitions/FileDetails"}}}, "type": "object"}, "KubernetesAgentPreSignedUrlResponse": {"properties": {"signed_url_details": {"type": "array", "items": {"$ref": "#/definitions/SignedUrlDetails"}}}, "type": "object"}, "KubernetesClusterFrequency": {"properties": {"cost_resolution": {"description": "Cost Resolution Details", "$ref": "#/definitions/ClusterFrequencyTimeDetails"}}, "type": "object"}, "KubernetesClusterPrometheusDetails": {"properties": {"prometheus_url": {"type": "string", "description": "Prometheus URL"}, "certificate_path": {"type": "string", "description": "Certificate Path"}}, "type": "object"}, "KubernetesClusterSyncUpdateRequest": {"allOf": [{"$ref": "#/definitions/ProgressDetailsForKubernetesAgentSyncStatus"}, {"required": ["syncer_type"], "properties": {"syncer_type": {"type": "string", "description": "Kubernetes Sync Status Types", "example": "heartbeat", "enum": ["heartbeat", "data_sync"], "x-cs-enum-type": "KubernetesSyncStatusTypes"}}, "type": "object"}]}, "KubernetesCostSpendByDimensionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseDimensionWidgetConfiguration"}, {"properties": {"selectedAccountId": {"type": "string"}}, "type": "object"}], "x-cs-type-name": "KubernetesCostSpendByDimensionWidgetConfiguration"}, "KubernetesCostSummaryWidgetConfigurationModel": {"allOf": [{"$ref": "#/definitions/BaseDataWidgetConfigurationModel"}, {"required": ["summaryType"], "properties": {"summaryType": {"type": "string", "description": "Type of cost summary", "example": "AiAgentActiveAssessments", "enum": ["AiAgentActiveAssessments", "AiAgentTotalAssessments", "AverageCostPerPeriod", "CombinedTotal", "CostOptimizationCloudAccounts", "CostOptimizationImpactedResources", "CostOptimizationPotentialSavings", "CostOptimizationRegions", "DimensionGroupWithMostAnomalies", "MaxPerPeriod", "MinPerPeriod", "TopCloud", "TopGroupBy", "TopRegion", "TopTenant", "Total", "TotalAnomaliesByBilling", "TotalAnomaliesByCloudAccount", "TotalAnomaliesByEvent", "TotalCostImpactByBilling", "TotalCostImpactByCloudAccount", "TotalCostImpactByEvent"], "x-cs-enum-type": "CostSummaryType"}, "groupByDetails": {"description": "Group by used when combined with the TopGroupBy summary type", "$ref": "#/definitions/BillingGroupByDetails"}, "groupByAccountType": {"description": "Type of Cloud Provider Account Type this applies to", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}}, "type": "object"}], "x-cs-type-name": "KubernetesCostSummaryWidgetConfigurationModel"}, "KubernetesCostTrendForecastWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/KubernetesCostTrendWidgetConfiguration"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "KubernetesCostTrendForecastWidgetConfiguration"}, "KubernetesCostTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseCostTrendWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "KubernetesCostTrendWidgetConfiguration"}, "KubernetesCostWeightage": {"properties": {"cpu_weight": {"type": "number", "description": "CPU cost weight"}, "memory_weight": {"type": "number", "description": "Memory cost weight"}, "gpu_weight": {"type": "number", "description": "GPU cost weight"}}, "type": "object"}, "KubernetesDefinitions": {"properties": {"resource_type": {"type": "string", "description": "Kubernetes Resource types", "example": "compute", "enum": ["compute", "control_plane", "cpu", "gpu", "memory", "network", "storage", "unallocated"], "x-cs-enum-type": "KubernetesResourceType"}, "utilization_type": {"type": "string", "description": "Kubernetes Utilization Type", "example": "FixedFee", "enum": ["FixedFee", "ReservedUtilized", "ReservedUnutilized", "HostWaste", "Unallocated", "HostShared"], "x-cs-enum-type": "KubernetesUtilizationType"}, "workload": {"type": "string", "description": "Kubernetes workloads", "example": "namespace", "enum": ["namespace", "pod", "container", "deployment", "replicaset", "cronjob", "job", "statefulset", "daemonset"], "x-cs-enum-type": "KubernetesWorkload"}, "cluster_component": {"type": "string", "description": "Kubernetes cluster infra component", "example": "node", "enum": ["node", "cluster", "loadbalancer", "disk"], "x-cs-enum-type": "KubernetesInClusterComponent"}}, "type": "object"}, "KubernetesManifestResponse": {"properties": {"attachment_id": {"type": "string", "description": "Yaml content"}}, "type": "object"}, "LegendDisplayConfiguration": {"properties": {"horizontalAlignment": {"type": "string", "example": "Left", "enum": ["Left", "Center", "Right"], "x-cs-enum-type": "HorizontalAlignment"}, "verticalAlignment": {"type": "string", "example": "Top", "enum": ["Top", "Middle", "Bottom"], "x-cs-enum-type": "VerticalAlignment"}, "fontSize": {"type": "string", "description": "Legend Text Size", "example": "Small", "enum": ["Small", "Medium", "Large"], "x-cs-enum-type": "LegendDisplayFontSizeSelection"}, "enabled": {"type": "boolean", "description": "Legend visibility"}}, "type": "object"}, "LicenseBenefitHubDiscountsRequest": {"required": ["currency", "limit", "page"], "properties": {"page": {"type": "integer", "description": "page number.Example 'page':'1'"}, "limit": {"type": "integer", "description": "records limits.Example 'limit':'10'"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "cloud_provider": {"type": "string", "description": "Cloud Provider for the cloud account", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "type": "object"}, "LicenseBenefitHubDiscountsResponse": {"properties": {"total_count": {"type": "integer", "description": "total count of records"}, "page_count": {"type": "integer", "description": "total number of page count"}, "summary_data": {"type": "array", "description": "Data Summary", "items": {"$ref": "#/definitions/LicenseSummaryData"}}}, "type": "object"}, "LicenseBenefitSavingRequest": {"required": ["currency", "tenant_id"], "properties": {"currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "service_names": {"type": "array", "items": {"type": "string", "description": "Cloud Provider for the cloud account", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "tenant_id": {"type": "array", "description": "Specify the tenant ID. This is a unique ID  and can be retrieved using the List Tenants API.", "items": {"type": "string"}}}, "type": "object"}, "LicenseBenefitSavingResponse": {"properties": {"recommendations_count": {"type": "integer", "description": "Recommendations Count"}, "impacted_resource_count": {"type": "integer", "description": "Impacted Resource Count"}, "potential_cost_saving": {"type": "string", "description": "Potential Cost Saving"}, "savings_percentage": {"type": "number", "description": "Savings Percentage"}, "info": {"type": "string", "description": "Potential Savings % compared to the Forecasted Spend"}}, "type": "object"}, "LicenseSummaryData": {"properties": {"virtual_machine_name": {"type": "string", "description": "Virtual Machine Name"}, "virtual_machine_id": {"type": "string", "description": "Virtual Machine ID"}, "azure_hybrid_benefit": {"type": "string", "description": "Azure Hybrid Benefit"}, "resource_location": {"type": "string", "description": "Resource Location"}, "recommendation_id": {"type": "string", "description": "Recommendation ID"}, "cloud_provider": {"type": "string", "description": "Cloud Provider for the cloud account", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "potential_cost_saving": {"type": "number", "description": "Potential Cost Saving"}, "service_account_name": {"type": "string", "description": "Service Account Name"}, "tenant_name": {"type": "string", "description": "Tenant Name"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "subscription_name": {"type": "string", "description": "Subscription Name"}, "subscription_id": {"type": "string", "description": "Subscription Id"}, "cloud_account_id": {"type": "string", "description": "Cloud Account ID"}, "info": {"type": "string", "description": "Potential Savings % compared to the Forecasted Spend"}, "savings_percentage": {"type": "number", "description": "Savings Percentage"}}, "type": "object"}, "LineItemDescriptionQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["line_item_descriptions"], "properties": {"line_item_descriptions": {"type": "array", "description": "Line item descriptions by exact description match", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "LineItemDescriptionQueryOperator"}, "LineItemDescriptionRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["line_item_description"], "properties": {"line_item_description": {"description": "Line item description by regex match", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "LineItemDescriptionRegexQueryOperator"}, "ListAlertTemplates": {"required": ["metric_alert_templates", "page_count", "total_count"], "properties": {"total_count": {"type": "integer", "description": "total records count"}, "page_count": {"type": "integer", "description": "Count of number of pages"}, "metric_alert_templates": {"type": "array", "items": {"type": "object"}}}, "type": "object"}, "ListBlueprintDetails": {"required": ["blueprints", "page_count", "total_count"], "properties": {"page_count": {"type": "integer", "description": "Page count"}, "total_count": {"type": "integer", "description": "Total count"}, "blueprints": {"type": "array", "description": "Blueprints Details", "items": {"$ref": "#/definitions/BlueprintDetails"}}}, "type": "object"}, "ListBudgetsModel": {"required": ["actual_amount", "budget_amount", "budget_frequency", "budget_id", "budget_name", "budget_type", "budget_uri", "created_at", "currency", "end_date", "forecasted_amount", "metadata", "start_date", "status"], "properties": {"budget_name": {"type": "string", "description": "budget name"}, "billing_source": {"type": "string", "description": "Cost metric used to calculate the budget amount"}, "budget_type": {"type": "string", "description": "budget type"}, "budget_frequency": {"type": "string", "description": "Specify the budget frequency. Example: 'budget frequency':'Daily' Allowed values - Daily,Monthly,Quarterly,Annually"}, "budget_amount": {"type": "number", "description": "budget amount"}, "actual_amount": {"type": "number", "description": "budget actual amount"}, "forecasted_amount": {"type": "number", "description": "budget forecasted amount"}, "currency": {"type": "string", "description": "budget currency"}, "start_date": {"type": "string", "description": "budget start data"}, "end_date": {"type": "string", "description": "budget end date"}, "last_threshold": {"type": "string", "format": "date-time", "description": "last threshold"}, "status": {"type": "string", "description": "budget created status"}, "budget_uri": {"type": "string", "description": "budget uri"}, "created_at": {"type": "string", "description": "budget created at"}, "metadata": {"type": "object", "description": "metadata to maintain step"}, "budget_id": {"type": "string", "description": "budget id"}, "budget_engine": {"type": "string", "description": "budget engine can be Cloud_Native or System", "example": "Cloud_Native", "enum": ["Cloud_Native", "System"], "x-cs-enum-type": "BudgetEngine"}, "budget_scope": {"type": "string", "description": "budget scope", "example": "cloud", "enum": ["cloud", "tenant", "custom"], "x-cs-enum-type": "BudgetScope"}, "scope": {"description": "scope of the budget further defined for each scope", "$ref": "#/definitions/BudgetScopeDetails"}}, "type": "object"}, "ListCloudAccountConfiguration": {"required": ["cloud_account_configuration", "page_count", "total_count"], "properties": {"total_count": {"type": "integer", "description": "total records count"}, "page_count": {"type": "integer", "description": "Count of number of pages"}, "cloud_account_configuration": {"type": "array", "items": {"type": "object"}}}, "type": "object"}, "ListContext": {"properties": {"batch_size": {"type": "integer", "description": "Max number of ids in the response"}, "batch_offset": {"type": "integer", "description": "Offset of batches into the results. First batch is 0"}, "total": {"type": "integer", "description": "Total number of results"}}, "type": "object"}, "ListDetailedResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"$ref": "#/definitions/RecordIdentity"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "ListLockConfigRuleResponse": {"properties": {"lock_rules": {"type": "array", "items": {"$ref": "#/definitions/ListLockRuleModel"}}}, "type": "object"}, "ListLockRuleModel": {"required": ["applicability_by", "cloud", "config_rule_id", "is_active", "lock_type", "tenant_id", "tenant_name"], "properties": {"tenant_name": {"type": "string", "description": "cloud_account_name"}, "tenant_id": {"type": "string", "description": "cloud_account_name"}, "cloud_account_id": {"type": "string", "description": "cloud_acccount_id"}, "cloud_account_name": {"type": "string", "description": "cloud_account_name"}, "cloud": {"type": "string", "description": "cloud name"}, "applicability_by": {"description": "filters for cloud _account_scope", "$ref": "#/definitions/FilterData"}, "lock_type": {"type": "string", "description": "lock type"}, "config_rule_id": {"type": "string", "description": "cloud_acccount_id"}, "is_active": {"type": "boolean", "description": "Flag to identify config rule is active or not"}}, "type": "object"}, "ListLogAnalyticsWorkspaceRequest": {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "list of all tenant ids for which log analytics workspace details are required", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "service_account_ids": {"type": "array", "description": "list of service account ids for which log analytics workspace details are required", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "ListOperationsResponse": {"required": ["data"], "properties": {"data": {"type": "array", "description": "Operations List", "items": {"type": "string"}}}, "type": "object"}, "ListPolicyRecommendationsResponse": {"required": ["actions", "classification", "cloud_account_id", "cloud_account_name", "created_at", "description", "impact", "name", "page_count", "policy_description", "policy_id", "policy_name", "resource_counts", "resources", "service_name", "status", "sub_classification", "tenant_name", "total_count"], "properties": {"policy_id": {"type": "array", "description": "Policy ID", "items": {"type": "string"}}, "policy_name": {"type": "string", "description": "Policy Name"}, "policy_description": {"type": "string", "description": "Policy Description"}, "name": {"type": "string", "description": "Name of the policy recommendation"}, "status": {"type": "string", "description": "Status"}, "impact": {"type": "string", "description": "Impact"}, "classification": {"type": "string", "description": "Oscar Classification"}, "sub_classification": {"type": "string", "description": "Sub classification of the above classification"}, "cloud_account_id": {"type": "string", "description": "Cloud Account ID"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}, "service_name": {"type": "string", "description": "Cloud Service Name"}, "tenant_name": {"type": "string", "description": "Tenant Name"}, "created_at": {"type": "string", "description": "Time of creation"}, "resource_counts": {"description": "Count of the resource that are open", "$ref": "#/definitions/ResourceCount"}, "description": {"type": "string", "description": "Description of the policy"}, "actions": {"type": "array", "description": "Action to be taken for that policy recommendation", "items": {"$ref": "#/definitions/ActionDetails"}}, "total_count": {"type": "integer", "description": "Total count"}, "page_count": {"type": "integer", "description": "Page count"}, "resources": {"type": "array", "description": "Resources Details", "items": {"type": "object"}}}, "type": "object"}, "ListRIRecommendationsRequest": {"required": ["currency", "term"], "properties": {"currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "services": {"type": "array", "items": {"type": "string", "description": "Cloud Provider for the cloud account", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "term": {"type": "string", "description": "Year, it can be 1 or 3"}, "compute_forecast": {"type": "boolean", "description": "flag to indicate whether to include compute forecast in the response"}, "payment_option": {"type": "string", "description": "Select a payment option, it can be No_Upfront, Partial_Upfront or All_Upfront. payment_option: No_Upfront", "default": "No_Upfront"}}, "type": "object"}, "ListRIRecommendationsResponse": {"properties": {"total_count": {"type": "integer", "description": "Total count"}, "page_count": {"type": "integer", "description": "Page wise count"}, "recommendations": {"type": "array", "description": "Recommendations suggested", "items": {"$ref": "#/definitions/Recommendations"}}}, "type": "object"}, "ListRecommendationByAccountRequest": {"properties": {"service_account_id": {"type": "string", "x-cs-type": "ObjectId"}, "policy_id": {"type": "string", "x-cs-type": "ObjectId"}}, "type": "object"}, "ListRecommendationByAccountResponse": {"required": ["page_count", "recommendations", "total_count"], "properties": {"page_count": {"type": "integer", "description": "Page count"}, "total_count": {"type": "integer", "description": "Total count"}, "recommendations": {"type": "array", "description": "Recommendation Details", "items": {"$ref": "#/definitions/RecommendationByAccount"}}}, "type": "object"}, "ListRecommendationByCategoryResponse": {"required": ["page_count", "recommendations", "total_count"], "properties": {"page_count": {"type": "integer", "description": "Page count"}, "total_count": {"type": "integer", "description": "Total count"}, "recommendations": {"type": "array", "description": "Recommendation Details", "items": {"$ref": "#/definitions/RecommendationByCategory"}}}, "type": "object"}, "ListRecommendationFilters": {"allOf": [{"$ref": "#/definitions/RecommendationFilterBase"}, {"properties": {"policy_classifications": {"description": "Policy classification with sub-classifications.", "$ref": "#/definitions/PolicyClassificationWithSubClassifications"}, "policy_ids": {"type": "array", "description": "List of policy ids to get the recommendations.", "items": {"type": "string"}}, "resource_ids": {"type": "array", "description": "List of resource ids to get the recommendations.", "items": {"type": "string"}}, "resource_types": {"type": "array", "description": "List of resource types to get the recommendations.", "items": {"type": "string"}}, "resources": {"type": "array", "description": "List of resources to get the recommendations.", "items": {"type": "string"}}, "service_names": {"type": "array", "description": "List of cloud service name", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "sources": {"type": "array", "description": "List of recommendation source to filter the recommendations.", "items": {"type": "string", "description": "Recommendation source", "example": "AWS-compute-optimizer", "enum": ["AWS-compute-optimizer", "AWS-ec2-compute-optimizer", "AWS-lambda-compute-optimizer", "AWS_advisor", "Corestack-Profiler", "Custom", "GCP_advisor", "OCI_advisor", "activity_log", "azure_advisor", "policy", "security_threats"], "x-cs-enum-type": "RecommendationSource"}}, "statuses": {"type": "array", "description": "List of recommendation status to filter the recommendations.", "items": {"type": "string", "description": "Status of the policy resource recommendation", "example": "error", "enum": ["error", "in_progress", "open", "resolved", "skipped", "system_skipped"], "x-cs-enum-type": "PolicyResourceRecommendationStatus"}}}, "type": "object"}]}, "ListRecommendationRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ListRecommendationFilters"}}, "type": "object"}, "ListRecommendationsRequest": {"required": ["cloud_account_id"], "properties": {"page": {"type": "integer", "description": "page number.Example 'page': 1"}, "limit": {"type": "integer", "description": "records limits. Example 'limit': 10"}, "classification": {"type": "string", "description": "Classifications based on OSCAR pillars. Accepted values: Operation, Security, Cost, Access, Resource"}, "sub_classification": {"type": "string", "description": "Sub-Classification based on the Classification selected.\n                                                                                                    Accepted Values:\n                                                                                                        \"Operation\": Performance, Availability, Standards, Logging, Monitoring\n                                                                                                        \"Security\": Data, Network, Host, Application, End Point protection, Standards\n                                                                                                        \"Cost\": Orphaned, Config, Idle, Underutilized, Anomaly, Billing, Budget, Overutilized, Optimized\n                                                                                                        \"Access\": Standards, Utilization\n                                                                                                        \"Resource\": Naming Standards, Tag Pattern, Locks"}, "recommendation_group": {"type": "string", "description": "Mention the Recommendation group. Accepted values: Policy, Advisor, Right-Size"}, "status": {"type": "string", "description": "Status. Acceptable values: open, resolved, skipped, system_skipped"}, "cloud_account_id": {"type": "string", "description": "Specify the Cloud account ID. This can be retrieved from  List Cloud account API call."}, "service_name": {"type": "string", "description": "Cloud Service Name. Example: 'service_name': 'AWS'/'Azure'/'GCP'"}}, "type": "object"}, "ListRecommendationsResponse": {"required": ["page_count", "recommendations", "total_count"], "properties": {"total_count": {"type": "integer", "description": "Total count"}, "page_count": {"type": "integer", "description": "Page count"}, "recommendations": {"type": "array", "description": "Recommendations", "items": {"$ref": "#/definitions/Recommendation"}}}, "type": "object"}, "ListRecommendationsTenantRequest": {"properties": {"page": {"type": "integer", "description": "page number.Example 'page': 1"}, "limit": {"type": "integer", "description": "records limits.Example 'limit': 10"}, "classifications": {"type": "string", "description": "Classifications based on OSCAR pillars. Accepted values: Operation, Security, Cost, Access, Resource"}, "sub_classification": {"type": "string", "description": "Sub-Classification based on the Classification selected.\n                                                                                                          Accepted Values:\n                                                                                                              \"Operation\": Performance, Availability, Standards, Logging, Monitoring\n                                                                                                              \"Security\": Data, Network, Host, Application, End Point protection, Standards\n                                                                                                              \"Cost\": Orphaned, Config, Idle, Underutilized, Anomaly, Billing, Budget, Overutilized, Optimized\n                                                                                                              \"Access\": Standards, Utilization\n                                                                                                              \"Resource\": Naming Standards, Tag Pattern, Locks"}, "service_name": {"type": "string", "description": "Name of the Cloud. Accepted values - AWS, Azure, GCP"}, "status": {"type": "string", "description": "Status. Acceptable values: open, resolved, skipped, system_skipped"}, "service_account_id": {"type": "string", "description": "Mention the Cloud Account ID. Cloud Account ID can be retrieved from List Cost Savings Account Summary call."}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "ListRecommendationsTenantResponse": {"required": ["page_count", "recommendations", "total_count"], "properties": {"total_count": {"type": "integer", "description": "Total count"}, "page_count": {"type": "integer", "description": "Page count"}, "recommendations": {"type": "array", "description": "Recommendations", "items": {"$ref": "#/definitions/RecommendationTenant"}}}, "type": "object"}, "ListRecommendationsViewResponse": {"required": ["classification", "cloud_account_id", "cloud_account_name", "cost_savings", "created_at", "description", "id", "impact", "name", "page_count", "policy_id", "policy_name", "projected_cost_savings_month", "resource_counts", "resources", "service_name", "source", "status", "sub_classification", "tenant_id", "tenant_name", "total_count"], "properties": {"id": {"type": "string", "description": "Recommendation id"}, "policy_id": {"type": "string", "description": "Policy Id"}, "policy_name": {"type": "string", "description": "Policy Name"}, "name": {"type": "string", "description": "Name"}, "status": {"type": "string", "description": "Status"}, "impact": {"type": "string", "description": "Impact based on recommendation"}, "classification": {"type": "string", "description": "Classification"}, "sub_classification": {"type": "string", "description": "Sub Classification based on classification"}, "cloud_account_id": {"type": "string", "description": "Cloud account id"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}, "tenant_name": {"type": "string", "description": "Tenant Name"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "service_name": {"type": "string", "description": "Cloud Service Name"}, "source": {"type": "string", "description": "Source"}, "created_at": {"type": "string", "description": "Time of creation"}, "projected_cost_savings_month": {"type": "string", "description": "Projected Cost Saving per Month"}, "resource_counts": {"description": "The resources that are open based on recommendation", "$ref": "#/definitions/ResourceCount"}, "description": {"type": "string", "description": "Description"}, "cost_savings": {"description": "Cost Saving based on recommendation", "$ref": "#/definitions/CostSavings"}, "total_count": {"type": "integer", "description": "Total Count"}, "page_count": {"type": "integer", "description": "Page Count"}, "resources": {"type": "array", "description": "Resources", "items": {"type": "object"}}}, "type": "object"}, "ListReservationsResponse": {"required": ["expiring_in_thirty_days", "filters", "net_savings", "on_demand_cost", "page_count", "potential_cost_savings_recommended", "reservation_cost", "reservations", "total_count"], "properties": {"filters": {"description": "Filters available", "$ref": "#/definitions/FilterValue"}, "net_savings": {"type": "integer", "description": "Net savings value"}, "expiring_in_thirty_days": {"type": "integer", "description": "How many days are left out for expiry in that month"}, "on_demand_cost": {"type": "integer", "description": "On Demand Cost Value"}, "reservations": {"type": "array", "description": "Reservation", "items": {"$ref": "#/definitions/ReservationDetails"}}, "page_count": {"type": "integer", "description": "Page Count"}, "reservation_cost": {"type": "integer", "description": "Reservation Cost Value"}, "total_count": {"type": "integer", "description": "Total Count"}, "potential_cost_savings_recommended": {"type": "number", "description": "Cost saved based on recommendation"}}, "type": "object"}, "ListReservationsServiceAccountResponse": {"required": ["cloud_account_details", "overview_details", "usage_details", "utilization"], "properties": {"cloud_account_details": {"description": "Cloud Account Details", "$ref": "#/definitions/CloudAccountDetailsExtended"}, "utilization": {"type": "array", "description": "Utilization", "items": {"$ref": "#/definitions/UtilizationDetails"}}, "overview_details": {"description": "Overview", "$ref": "#/definitions/OverviewDetails"}, "usage_details": {"description": "Usage details", "$ref": "#/definitions/UsageDetails"}}, "type": "object"}, "ListReservationsV2Request": {"required": ["currency", "date_filter"], "properties": {"date_filter": {"type": "string", "description": "Date Filter to select", "example": "current_month", "enum": ["current_month", "current_month_minus_1", "current_month_minus_2", "current_month_minus_3", "current_month_minus_4", "current_month_minus_5", "current_month_minus_6", "current_month_minus_7", "current_month_minus_8", "current_month_minus_9", "current_month_minus_10", "current_month_minus_11", "current_month_minus_12"], "x-cs-enum-type": "DashboardDateFilter"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "service": {"type": "string", "description": "cloud service name", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "tenant_ids": {"type": "array", "description": "One or more tenant IDs to fetch reservations across. Omit to scope to a single tenant.", "items": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}}}, "type": "object"}, "ListResourceRecommendationFilters": {"allOf": [{"$ref": "#/definitions/RecommendationFilterBase"}, {"properties": {"recommendation_ids": {"type": "array", "description": "List of recommendation IDs to get the resource recommendations.", "items": {"type": "string"}}, "rule_ids": {"type": "array", "description": "List of exclusion rule Ids to get resources to exclude.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "search": {"type": "string", "description": "Search based on resource_id, resource_name, resource, resource category, resource type and region/location."}, "filters": {"description": "Query based on Resource Group, Region, resource_id, resource_name and resource", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}]}, "ListResourceRecommendationRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/ResourceRecommendationsSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ListResourceRecommendationFilters"}}, "type": "object"}, "ListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "ListScheduleResponse": {"required": ["page_count", "schedules", "total_count"], "properties": {"page_count": {"type": "integer", "description": "Page count"}, "total_count": {"type": "integer", "description": "Total count"}, "schedules": {"type": "array", "description": "Schedule Details", "items": {"$ref": "#/definitions/ScheduleData"}}}, "type": "object"}, "ListTenantResponse": {"required": ["tenants"], "properties": {"tenants": {"type": "array", "description": "Tenants List.", "items": {"$ref": "#/definitions/TenantDetails"}}}, "type": "object"}, "LocationDetailsBase": {"required": ["type"], "properties": {"location_id": {"type": "string", "description": "Unique Id"}, "name": {"type": "string", "description": "Display Name"}, "description": {"type": "string", "description": "Description"}}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "LocationDetailsForAws", "subtype_name": "LocationDetailsForAws"}, {"subtype_model": "LocationDetailsForAzure", "subtype_name": "LocationDetailsForAzure"}, {"subtype_model": "LocationDetailsForGcp", "subtype_name": "LocationDetailsForGcp"}, {"subtype_model": "LocationDetailsForOci", "subtype_name": "LocationDetailsForOci"}, {"subtype_model": "LocationDetailsForOpenstack", "subtype_name": "LocationDetailsForOpenstack"}]}, "LocationDetailsForAws": {"allOf": [{"$ref": "#/definitions/LocationDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "LocationDetailsForAws"}, "LocationDetailsForAzure": {"allOf": [{"$ref": "#/definitions/LocationDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "LocationDetailsForAzure"}, "LocationDetailsForGcp": {"allOf": [{"$ref": "#/definitions/LocationDetailsBase"}, {"properties": {"region": {"type": "string", "description": "Full URL reference to the region which hosts the zone."}, "self_link": {"type": "string", "description": "Server-defined URL for the resource."}, "status": {"type": "string", "description": "Status of the zone, either UP or DOWN."}}, "type": "object"}], "x-cs-type-name": "LocationDetailsForGcp"}, "LocationDetailsForOci": {"allOf": [{"$ref": "#/definitions/LocationDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "LocationDetailsForOci"}, "LocationDetailsForOpenstack": {"allOf": [{"$ref": "#/definitions/LocationDetailsBase"}, {"properties": {"domain_id": {"type": "string", "description": "Domain of the location"}}, "type": "object"}], "x-cs-type-name": "LocationDetailsForOpenstack"}, "LocationQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["locations"], "properties": {"locations": {"type": "array", "description": "Locations to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "LocationQueryOperator"}, "ManageRecommendationAction": {"properties": {"action_type": {"type": "string", "description": "Type of the Actions to be passed in the request.", "example": "Approve", "enum": ["Approve", "Reject", "Pending Approval"], "x-cs-enum-type": "RequestsActionsType"}, "resource_id": {"type": "string", "description": "Unique Id for the resource."}, "recommendation_sys_id": {"type": "string", "description": "Unique Id for the Recommendation."}, "workflow_id": {"type": "string", "description": "Unique Id for the workflow."}, "rejection_duration_days": {"type": "integer", "description": "Duration of the rejected period."}, "rejection_reason": {"type": "string", "description": "Reason for the recommendation rejection."}, "is_preidentified": {"type": "boolean", "description": "Boolean to determine whether the recommendation is pre-identified or not."}}, "type": "object"}, "MarkupDetails": {"required": ["applicable_to", "end_date", "markup_amount", "markup_type", "rule_name", "rule_scope", "rule_type", "service", "start_date"], "properties": {"start_date": {"type": "string", "format": "date", "description": "Start date of the rule"}, "end_date": {"type": "string", "format": "date", "description": "End date for that rule"}, "rule_name": {"type": "string", "description": "Rule name. Enter an existing Rule name or else a new one will be created"}, "rule_scope": {"type": "string", "description": "Scope of the rule. This field cannot be updated use the same Rule Scope. If you want to update this create a new Rule", "example": "tenant", "enum": ["tenant", "cloud_account"], "x-cs-enum-type": "DiscountMarkupRuleScope"}, "rule_type": {"type": "string", "description": "Type of the markup/discount rule", "example": "discount", "enum": ["discount", "markup", "RI_discount", "RI_markup", "Third_Party_License"], "x-cs-enum-type": "MarkupRuleType"}, "is_active": {"type": "boolean", "description": "States if the rule is active or not"}, "markup_type": {"type": "string", "description": "Type of the markup", "example": "fixed_amount", "enum": ["fixed_amount", "percentage"], "x-cs-enum-type": "DiscountMarkupType"}, "markup_amount": {"type": "number", "description": "Markup/Discount amount depending on the  markup type selected"}, "service": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "applicable_to": {"description": "It is applicable to which cloud account or tenant based on rule scope. Cloud account Id can be retrieved from  api(/governance/account/{tenant_id}/get/cloud_accounts) This field cannot be updated enter the same one as entered before If you want to update this create a new Rule ", "$ref": "#/definitions/ApplicableToDetails"}}, "type": "object"}, "MasterAccountAuthConfig": {"properties": {"auth_type": {"type": "string", "description": "Type of Authentication"}, "domain_info": {"type": "array", "description": "Domain information", "items": {"$ref": "#/definitions/MasterAccountDomainInfo"}}}, "type": "object"}, "MasterAccountBalanceUpdateRequest": {"required": ["transaction_type"], "properties": {"amount": {"type": "number", "description": "Balance amount to updated for the master account"}, "transaction_id": {"type": "string", "description": "Transaction id for the balance update"}, "user_name": {"type": "string", "description": "Name of the user who made the balance update."}, "tenant_id": {"type": "string", "description": "Id of the tenant where the balance is updated.", "x-cs-type": "ObjectId"}, "conversation_id": {"type": "string", "description": "Id of conversation where the balance is updated.", "x-cs-type": "ObjectId"}, "transaction_type": {"type": "string", "description": "Type of billing transaction.", "example": "credit", "enum": ["credit", "debit"], "x-cs-enum-type": "BillingTransactionType"}}, "type": "object"}, "MasterAccountBalanceUpdateResponse": {"properties": {"transaction_id": {"type": "string", "description": "Transaction id for the balance update."}, "previous_balance": {"type": "number", "description": "Balance amount before the update in master account balance."}, "current_balance": {"type": "number", "description": "Balance amount after the update in master account balance."}}, "type": "object"}, "MasterAccountBase": {"properties": {"name": {"type": "string", "description": "Master account name"}, "subscription_info": {"description": "Subscription Info", "$ref": "#/definitions/MasterAccountSubscription"}, "notification_settings": {"description": "Notification settings", "$ref": "#/definitions/MasterAccountNotificationSetting"}, "fiscal_year_configuration": {"description": "Fiscal Year settings", "$ref": "#/definitions/FiscalYearConfiguration"}, "crm_id": {"type": "string", "description": "CRM id"}, "mfa_enabled": {"type": "boolean", "description": "Flag to enable MFA for the master account"}, "custom_tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "hierarchy_level": {"type": "string", "description": "Hierarchy level"}, "parent_master_account_id": {"type": "string", "description": "ID of the parent master account."}, "products": {"type": "array", "description": "Products", "items": {"type": "string"}}, "require_access_key": {"type": "boolean", "description": "Flag to set API keys generation is allowed or not for the users of this master account."}, "priority": {"type": "integer", "description": "Priority of the master account."}}, "type": "object"}, "MasterAccountBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/MasterAccountDetails"}}}, "type": "object"}, "MasterAccountBillingBalanceGetResponse": {"properties": {"current_balance": {"type": "number", "description": "Current balance for the master account."}}, "type": "object"}, "MasterAccountBillingListTransactionRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/MasterAccountBillingListTransactionsSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/MasterAccountBillingTransactionRequestContext"}}, "type": "object"}, "MasterAccountBillingListTransactionsSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "created_at", "enum": ["created_at"], "x-cs-enum-type": "MasterAccountBillingListTransactionsSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "MasterAccountBillingQueryConversations": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["conversation_ids"], "properties": {"conversation_ids": {"type": "array", "description": "ID of conversations", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "MasterAccountBillingQueryConversations"}, "MasterAccountBillingQueryMasterAccounts": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["master_account_ids"], "properties": {"master_account_ids": {"type": "array", "description": "ID of master accounts", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "MasterAccountBillingQueryMasterAccounts"}, "MasterAccountBillingQueryTenants": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tenants_ids"], "properties": {"tenants_ids": {"type": "array", "description": "ID of tenants", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "MasterAccountBillingQueryTenants"}, "MasterAccountBillingQueryTransactionType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["transaction_types"], "properties": {"transaction_types": {"type": "array", "description": "Type of the Transaction", "items": {"type": "string", "description": "Type of billing transaction.", "example": "credit", "enum": ["credit", "debit"], "x-cs-enum-type": "BillingTransactionType"}}}, "type": "object"}], "x-cs-type-name": "MasterAccountBillingQueryTransactionType"}, "MasterAccountBillingQueryUsers": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["user_names"], "properties": {"user_names": {"type": "array", "description": "Names of user", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "MasterAccountBillingQueryUsers"}, "MasterAccountBillingSummaryResponse": {"properties": {"current_balance": {"type": "number", "description": "Current balance for the master account."}, "total_spend": {"type": "number", "description": "Total spend for the master account."}}, "type": "object"}, "MasterAccountBillingTransactionDocument": {"required": ["status", "transaction_type"], "properties": {"sysId": {"type": "string", "description": "Id of the document."}, "transaction_id": {"type": "string", "description": "Transaction id for the balance update"}, "tenant_id": {"type": "string", "description": "Id of the tenant where the balance is updated.", "x-cs-type": "ObjectId"}, "conversation_id": {"type": "string", "description": "Id of conversation where the balance is updated.", "x-cs-type": "ObjectId"}, "master_account_id": {"type": "string", "description": "Id of master account where the balance is updated.", "x-cs-type": "ObjectId"}, "amount": {"type": "number", "description": "Amount for the transaction."}, "transaction_type": {"type": "string", "description": "Type of billing transaction.", "example": "credit", "enum": ["credit", "debit"], "x-cs-enum-type": "BillingTransactionType"}, "previous_balance": {"type": "number", "description": "Balance before the transaction."}, "after_balance": {"type": "number", "description": "Balance after the transaction."}, "status": {"type": "string", "description": "Type of billing transaction status.", "example": "pending", "enum": ["pending", "completed", "failed"], "x-cs-enum-type": "BillingTransactionStatus"}, "created_by": {"type": "string", "description": "Name of the user who made the balance update."}, "created_at": {"type": "string", "format": "date-time", "description": "Time when the transaction is initiated."}, "processed_at": {"type": "string", "format": "date-time", "description": "Time when the transaction is completed."}}, "type": "object"}, "MasterAccountBillingTransactionRequestContext": {"required": ["end_date", "start_date"], "properties": {"query": {"description": "Query expression to filter the transactions", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "Start of the transactions period"}, "end_date": {"type": "string", "format": "date-time", "description": "End of the transactions period"}}, "type": "object"}, "MasterAccountBillingTransactionsBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/MasterAccountBillingTransactionDocument"}}}, "type": "object"}, "MasterAccountCostRecommendationSettings": {"required": ["product"], "properties": {"product": {"type": "string", "description": "Name of the product", "example": "AppSecOps", "enum": ["AppSecOps", "Assessments", "CloudOps", "FinOps", "Product_Admin", "SecOps", "Self Service", "StackOps"], "x-cs-enum-type": "ProductEnum"}, "cloud_native_recommendation_sync_enabled": {"type": "boolean", "description": "Enable/Disable cloud native recommendation sync for the product"}}, "type": "object"}, "MasterAccountDetails": {"allOf": [{"$ref": "#/definitions/MasterAccountBase"}, {"properties": {"status": {"type": "string", "description": "Master account status"}, "created_by": {"type": "string", "description": "Name of the user created this master account."}, "updated_by": {"type": "string", "description": "Name of the user last updated this master account."}, "updated_at": {"type": "string", "format": "date-time", "description": "DateTime in UTC when the master account was last updated."}, "created_at": {"type": "string", "format": "date-time", "description": "DateTime in UTC when the master account was created."}, "auth_config": {"type": "array", "description": "Auth Configuration", "items": {"$ref": "#/definitions/MasterAccountAuthConfig"}}, "mcp_server_enabled": {"type": "boolean", "description": "Checks if the account is mcp server enabled or not"}, "automation_workflow_enabled": {"type": "boolean", "description": "Checks if the accounts automation workflow configuration has enabled or not"}, "cost_anomaly_settings": {"$ref": "#/definitions/CostAnomalyConfiguration"}, "cost_recommendation_settings": {"type": "array", "items": {"$ref": "#/definitions/MasterAccountCostRecommendationSettings"}}, "dimension_pre_computation_enabled": {"type": "boolean", "description": "Flag to enable dimension precomputation for this master account"}, "discover_azure_csp_partner_accounts": {"type": "boolean", "description": "Flag to enable Azure CSP Partner account discovery for this master account"}, "cost_processing_settings": {"$ref": "#/definitions/CostProcessingSettings"}, "nextgen_report_settings": {"$ref": "#/definitions/NextgenReportSettings"}}, "type": "object"}]}, "MasterAccountDetailsSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CreatedAt", "enum": ["CreatedAt"], "x-cs-enum-type": "MasterAccountDetailsSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "MasterAccountDomainInfo": {"properties": {"domain_name": {"type": "string", "description": "Domain Name"}, "role_ids": {"type": "array", "description": "list of role ids", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "allow_auto_signup": {"type": "boolean", "description": "Flag set to allow auto signup for new users"}}, "type": "object"}, "MasterAccountEmailSetting": {"required": ["email", "password", "smtp", "smtp_port", "username"], "properties": {"smtp": {"type": "string", "description": "SMTP"}, "smtp_port": {"type": "integer", "description": "Smtp port no"}, "username": {"type": "string", "description": "User name"}, "email": {"type": "string", "description": "Email"}, "password": {"type": "string", "description": "Password for email", "x-cs-type": "SensitiveString"}, "enable_starttls": {"type": "boolean", "description": "Enable Starttls"}}, "type": "object"}, "MasterAccountListFilters": {"properties": {"search": {"type": "string", "description": "Text query to search by name and status"}, "status": {"type": "string", "description": "Status of the master account", "example": "active", "enum": ["active", "inactive"], "x-cs-enum-type": "MasterAccountStatus"}, "account_status": {"type": "string", "description": "Status of the master account subscription", "example": "pending", "enum": ["pending", "active", "expired", "cancelled"], "x-cs-enum-type": "MasterAccountSubscriptionStatus"}, "auth_type": {"type": "string", "description": "Auth type of the master account", "example": "azure_active_directory", "enum": ["azure_active_directory", "corestack", "azure_sso", "AD_LDAP", "CAS", "Okta", "onelogin", "openid_connect"], "x-cs-enum-type": "MasterAccountAuthType"}, "created_from": {"type": "string", "description": "Datetime string to filter accounts by created date. Format: yyyy-mm-dd hh:mm:ss.fff"}}, "type": "object"}, "MasterAccountListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/MasterAccountDetailsSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/MasterAccountListFilters"}}, "type": "object"}, "MasterAccountNotificationSetting": {"properties": {"organization_name": {"type": "string", "description": "Organization name"}, "support_email": {"type": "string", "description": "Support email"}, "activation_email": {"type": "string", "description": "Activation email"}, "activation_email_type": {"type": "string", "description": "Activation email type"}, "email_template": {"type": "string", "description": "Email Template"}, "custom_domain_name": {"type": "string", "description": "Custom domain name"}, "header_logo": {"type": "string", "description": "Header Logo"}, "banner_logo": {"type": "string", "description": "Banner Logo"}, "footer_text": {"type": "string", "description": "Footer text"}, "template_type": {"type": "string", "description": "Type of template"}, "email_settings": {"description": "Email settings", "$ref": "#/definitions/MasterAccountEmailSetting"}, "to_address": {"type": "string", "description": "To Address"}, "subject": {"type": "string", "description": "Subject"}, "message": {"type": "string", "description": "Message"}, "user_guide_url": {"type": "string", "description": "User Guide URL"}, "support_url": {"type": "string", "description": "Support URL"}, "terms_and_conditions_url": {"type": "string", "description": "Terms and Conditions URL"}, "support_tool_account_id": {"type": "string", "description": "Integrated Tool for support system", "x-cs-type": "ObjectId"}}, "type": "object"}, "MasterAccountSubscription": {"properties": {"action": {"type": "string", "description": "Action will be create for project master creation"}, "subscription_id": {"type": "string", "description": "Subscription id of user"}}, "type": "object"}, "MasterAccountTenantSummary": {"required": ["id"], "properties": {"id": {"type": "string", "description": "Tenant id"}, "name": {"type": "string", "description": "Name of Tenant"}, "status": {"type": "string", "description": "Indicates the status of the Tenant", "example": "active", "enum": ["active", "suspended"], "x-cs-enum-type": "TenantStatus"}, "is_default": {"type": "boolean", "description": "Is this a default tenant"}}, "type": "object"}, "MasterAccountUserGroupSummary": {"properties": {"id": {"type": "string", "description": "UserGroup id"}, "name": {"type": "string", "description": "Name of UserGroup"}}, "type": "object"}, "MasterDataCategoryDetails": {"properties": {"cloud": {"type": "string", "description": "Cloud provider (eg : AWS, Azure, GCP & OCI)"}, "service_code": {"type": "string", "description": "Service Code that is provided by Cloud provider"}, "service_name": {"type": "string", "description": "Services Name that is provided by Cloud provider"}, "display_name": {"type": "string", "description": "Display Name that is provided by Cloud provider"}, "description": {"type": "string", "description": "Short Description that is provided by Cloud provider"}, "generalized_category": {"type": "string", "description": "Service Category defined by Corestack based on Service Code and FOCUS Specification"}, "service_category": {"type": "string", "description": "Service Category defined by Cloud provider"}, "service_type": {"type": "string", "description": "Service Type defined by Corestack based on the Service Code (eg : Iaas, PaaS, SaaS, ....)"}, "service_sub_category": {"type": "string", "description": "Filter By service_sub_category"}}, "type": "object"}, "MasterDataCategoryFilters": {"properties": {"cloud": {"type": "array", "description": "Filter By cloud", "items": {"type": "string"}}, "service_code": {"type": "array", "description": "Filter By service_code", "items": {"type": "string"}}, "service_name": {"type": "array", "description": "Filter By service_name", "items": {"type": "string"}}, "display_name": {"type": "array", "description": "Filter By display_name", "items": {"type": "string"}}, "generalized_category": {"type": "array", "description": "Filter By generalized_category", "items": {"type": "string"}}, "service_category": {"type": "array", "description": "Filter By service_category", "items": {"type": "string"}}, "service_type": {"type": "array", "description": "Filter By service_type", "items": {"type": "string"}}, "service_sub_category": {"type": "array", "description": "Filter By service_sub_category", "items": {"type": "string"}}}, "type": "object"}, "MasterDataCategoryListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/MasterDataCategoryFilters"}}, "type": "object"}, "MasterDataCategoryListResponse": {"properties": {"results": {"type": "array", "description": "Master Data Category List", "items": {"$ref": "#/definitions/MasterDataCategoryDetails"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "McpServerItem": {"allOf": [{"$ref": "#/definitions/McpServerRequest"}, {"properties": {"sys_id": {"type": "string", "description": "Unique server ID for MCP", "x-cs-type": "ObjectId"}, "created_by": {"type": "string", "description": "Name of the user who registered the server."}, "created_at": {"type": "string", "description": "Timestamp when the server was registered"}, "updated_by": {"type": "string", "description": "Name of the user who last updated the server."}, "updated_at": {"type": "string", "description": "Timestamp when the server was last updated"}}, "type": "object"}]}, "McpServerListRequest": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "ID of the tenant", "x-cs-type": "ObjectId"}, "is_enabled": {"type": "boolean", "description": "Filter by enabled/disabled status."}}, "type": "object"}, "McpServerListResponse": {"properties": {"total_count": {"type": "integer", "description": "Total number of servers."}, "mcp_servers": {"type": "array", "description": "MCP Server list.", "items": {"$ref": "#/definitions/McpServerItem"}}}, "type": "object"}, "McpServerRequest": {"required": ["business_agents", "name", "tenant_id", "transport"], "properties": {"name": {"type": "string", "description": "Server name for MCP"}, "display_name": {"type": "string", "description": "Human-readable display name for the MCP server."}, "description": {"type": "string", "description": "MCP Server description."}, "transport": {"type": "string", "description": "MCP transport type (stdio, streamable-http, or rss).", "example": "stdio", "enum": ["stdio", "streamable-http", "rss"], "x-cs-enum-type": "McpTransport"}, "tenant_id": {"type": "string", "description": "ID of the tenant", "x-cs-type": "ObjectId"}, "command": {"type": "string", "description": "Command for stdio transport."}, "args": {"type": "array", "description": "Command arguments.", "items": {"type": "string"}}, "env": {"type": "object", "description": "Environment variables (values are sensitive).", "additionalProperties": {"type": "string", "x-cs-type": "SensitiveString"}}, "base_url": {"type": "string", "description": "Base URL for HTTP transport."}, "headers": {"type": "object", "description": "HTTP headers (values are sensitive).", "additionalProperties": {"type": "string", "x-cs-type": "SensitiveString"}}, "is_enabled": {"type": "boolean", "description": "Whether the server is active."}, "business_agents": {"type": "array", "description": "Agents allowed to use this server.", "items": {"type": "string", "description": "AI agents available in the system", "example": "Assessment Agent", "enum": ["Assessment Agent", "Graphion Agent", "Rate Optimization Agent"], "x-cs-enum-type": "Agents"}}, "timeout_ms": {"type": "integer", "description": "Timeout in milliseconds."}, "tools": {"type": "array", "description": "Tool definitions.", "items": {"type": "object"}}, "freshness": {"type": "string", "description": "Data freshness hint used for tool selection: real_time | daily | weekly | static."}, "priority": {"type": "integer", "description": "Tool selection priority \u2014 lower value means higher preference (e.g. 10 beats 100)."}}, "type": "object"}, "McpServerSetEnabledRequest": {"required": ["is_enabled"], "properties": {"is_enabled": {"type": "boolean", "description": "Set to true to enable the server, false to disable."}}, "type": "object"}, "McpToolsRequest": {"required": ["business_agent", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "ID of the tenant", "x-cs-type": "ObjectId"}, "business_agent": {"type": "string", "description": "Business agent name used to scope the tool list.", "example": "Assessment Agent", "enum": ["Assessment Agent", "Graphion Agent", "Rate Optimization Agent"], "x-cs-enum-type": "Agents"}}, "type": "object"}, "McpToolsResponse": {"properties": {"total_count": {"type": "integer", "description": "Total number of tools across all matching servers."}, "tools": {"type": "array", "description": "Flat list of MCP tools available for the given tenant and business agent.", "items": {"type": "object"}}}, "type": "object"}, "MetaDataModel": {"required": ["tags"], "properties": {"tags": {"type": "object", "description": "template tags"}}, "type": "object"}, "MeterSubCategoryQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["meter_sub_categories"], "properties": {"meter_sub_categories": {"type": "array", "description": "Meter sub categories to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "MeterSubCategoryQueryOperator"}, "MetricConfigItems": {"properties": {"EvaluationPeriods": {"type": "integer", "description": "Evaluation periods retrieved successfully"}, "Dimensions": {"type": "array", "description": "Dimensions retrieved successfully", "items": {"type": "string"}}, "AlarmActions": {"type": "array", "description": "Alarm actions retrieved successfully", "items": {"type": "string"}}, "AlarmDescription": {"type": "string", "description": "Alarm description retrieved successfully"}, "Namespace": {"type": "string", "description": "Namespace retrieved successfully"}, "Period": {"type": "integer", "description": "Period retrieved successfully"}, "ComparisonOperator": {"type": "string", "description": "Comparison Operator retrieved successfully"}, "Statistic": {"type": "string", "description": "Statistic retrieved successfully"}, "Threshold": {"type": "integer", "description": "Threshold retrieved successfully"}, "OKActions": {"type": "array", "description": "Okactions retrieved successfully", "items": {"type": "string"}}}, "type": "object"}, "MetricDetailedData": {"properties": {"date": {"type": "string", "format": "date-time", "description": "Time stamp For which metrics are being measured."}, "value": {"type": "number", "description": "Value for the metric in the provided time frame."}}, "type": "object"}, "MetricListRequest": {"required": ["end_date", "is_cost_metric", "start_date"], "properties": {"is_cost_metric": {"type": "boolean", "description": "Indicates if this is a cost metric request (true) or usage metric request (false)"}, "service_account_ids": {"type": "array", "description": "Service Account Ids to Filter", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "filters": {"description": "Query operator for filtering", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "Start date for metrics"}, "end_date": {"type": "string", "format": "date-time", "description": "End date for metrics"}}, "type": "object"}, "MetricNameQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["metric_names"], "properties": {"metric_names": {"type": "array", "description": "Metric names to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "MetricNameQueryOperator"}, "MetricValuesOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["metrics"], "properties": {"metrics": {"type": "array", "description": "Metrics for the findings", "items": {"type": "integer"}}}, "type": "object"}], "x-cs-type-name": "MetricValuesOperator"}, "MinimizedWorkFlowForBaseVersion": {"allOf": [{"$ref": "#/definitions/WorkFlowDefinitionsBase"}, {"properties": {"owners": {"type": "array", "description": "Owners of the workflow.", "items": {"type": "string"}}}, "type": "object"}]}, "MisconfigurationExplorerWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "MisconfigurationExplorerWidgetConfiguration"}, "MisconfigurationViolationsByCloudAccountWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "MisconfigurationViolationsByCloudAccountWidgetConfiguration"}, "MisconfigurationViolationsByCloudProviderWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "MisconfigurationViolationsByCloudProviderWidgetConfiguration"}, "MisconfigurationViolationsByRegionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "MisconfigurationViolationsByRegionWidgetConfiguration"}, "MisconfigurationViolationsTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "MisconfigurationViolationsTrendWidgetConfiguration"}, "ModelClassifier": {"allOf": [{"$ref": "#/definitions/AggregateMetricsBase"}, {"properties": {"model_id": {"type": "string", "description": "Model ID"}, "provider": {"type": "string", "description": "LLM Provider"}}, "type": "object"}]}, "ModelError": {"required": ["message"], "properties": {"message": {"type": "string", "description": "Error response message."}}, "type": "object"}, "MultiPartDetail": {"properties": {"part_number": {"type": "integer", "description": "Part number of the file part"}, "etag": {"type": "string", "description": "ETag of the uploaded part"}}, "type": "object"}, "MultipartUploadMetadata": {"properties": {"upload_id": {"type": "string", "description": "Unique identifier for the multipart upload session"}, "part_number": {"type": "integer", "description": "The sequential number of the current part in the multipart upload."}, "upload_part_size": {"type": "integer", "description": "Size of each uploaded part in bytes."}}, "type": "object"}, "NameChangeHistoryEntry": {"required": ["new_name", "previous_name", "updated_at", "updated_by"], "properties": {"previous_name": {"type": "string", "description": "Previous tenant name before the rename."}, "new_name": {"type": "string", "description": "New tenant name after the rename."}, "updated_by": {"type": "string", "description": "User who performed the rename."}, "updated_at": {"type": "string", "format": "date-time", "description": "DateTime in UTC when the rename was performed."}}, "type": "object"}, "NameChangeHistoryResponse": {"required": ["name_change_history"], "properties": {"name_change_history": {"type": "array", "description": "List of tenant name changes in reverse chronological order.", "items": {"$ref": "#/definitions/NameChangeHistoryEntry"}}}, "type": "object"}, "NamedParameter": {"required": ["is_required", "name", "schema"], "properties": {"name": {"type": "string", "description": "Name of the parameter"}, "display_name": {"type": "string", "description": "Display Name of the parameter"}, "is_required": {"type": "boolean", "description": "Whether the parameter is required."}, "schema": {"$ref": "#/definitions/ParameterBase"}}, "type": "object"}, "NextGenReportCreateRequest": {"properties": {"configuration": {"description": "Report configuration to generate report", "$ref": "#/definitions/ConfigurationForNextGenReportBase"}}, "type": "object"}, "NextGenReportGetRequest": {"properties": {"refresh_download_link": {"type": "boolean", "description": "If true, generates a new download link for the report if the existing link has expired.", "default": false}}, "type": "object"}, "NextGenReportResponse": {"properties": {"sys_id": {"type": "string", "description": "Unique ID for the report.", "x-cs-type": "ObjectId"}, "background_job_id": {"type": "string", "description": "ID of the background job responsible for generating the report."}, "attachments": {"type": "array", "description": "List of attachment storage types. Can be CoreStack Attachment or Azure Blob Storage.", "items": {"$ref": "#/definitions/AttachmentStorageBase"}}, "status": {"type": "string", "description": "Status of the report", "example": "Unknown", "enum": ["Unknown", "Queued", "Processing", "Success", "Failure"], "x-cs-enum-type": "ReportStatus"}}, "type": "object"}, "NextGenReportScheduleRequest": {"allOf": [{"$ref": "#/definitions/NextGenReportScheduleRequestBase"}, {"required": ["created_by", "email_recipients", "report_type", "schedule_id"], "properties": {"created_by": {"type": "string", "description": "User ID of user who scheduled the report"}, "schedule_id": {"type": "string", "description": "Schedule ID of which the report to be generated", "x-cs-type": "ObjectId"}, "email_recipients": {"type": "array", "description": "List of Email IDs for which the scheduled report will be sent.", "items": {"type": "string"}}, "report_type": {"type": "string", "description": "NextGen Report type", "example": "ConsolidatedChargesReport", "enum": ["ConsolidatedChargesReport", "DistributorConsolidatedReport"], "x-cs-enum-type": "NextGenReportType"}, "report_run_id": {"type": "string", "description": "Run ID of which the report to be re-triggered."}, "filters": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "NextGenReportScheduleRequest"}, "NextGenReportScheduleRequestBase": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "NextGenReportScheduleRequest", "subtype_name": "NextGenReportScheduleRequest"}, {"subtype_model": "FinOpsConsolidatedReportScheduleRequest", "subtype_name": "FinOpsConsolidatedReportScheduleRequest"}]}, "NextgenReportSettings": {"properties": {"max_allowed_groupby_count": {"type": "integer", "description": "Maximum number of group by fields allowed in a report"}}, "type": "object"}, "NotificationConfigurationModel": {"required": ["name", "notification_details"], "properties": {"name": {"type": "string", "description": "notification name"}, "notification_details": {"type": "array", "description": "Notification Details", "items": {"$ref": "#/definitions/NotificationDetailsModel"}}}, "type": "object"}, "NotificationDetailsModel": {"required": ["notification_input", "notification_type"], "properties": {"notification_type": {"type": "string", "description": "notification type like emails/ITSM/Webhook"}, "notification_input": {"description": "Notification Input", "$ref": "#/definitions/NotificationInputModel"}}, "type": "object"}, "NotificationInputModel": {"properties": {"emails": {"type": "array", "description": "Email id List", "items": {"type": "string"}}, "webhook_urls": {"type": "array", "description": "Webhook Urls to send alerts", "items": {"type": "string"}}}, "type": "object"}, "NotificationMessageResponse": {"required": ["data", "message", "status"], "properties": {"status": {"type": "string", "description": "Status of the notification & message api"}, "message": {"type": "string", "description": "Message of the notification & message api"}, "data": {"type": "object", "description": "data for the notification & message api"}}, "type": "object"}, "NotificationReportEmailDetails": {"required": ["message", "to"], "properties": {"to": {"type": "array", "description": "List of recipient email addresses", "items": {"type": "string"}}, "message": {"type": "string", "description": "Email body content"}, "subject": {"type": "string", "description": "Email subject line"}}, "type": "object"}, "NotificationReportRequest": {"required": ["email_details"], "properties": {"smtp_default": {"type": "boolean", "description": "Use default SMTP config when true"}, "master_account_id": {"type": "string", "description": "Master Account ID for org-level SMTP/template override"}, "report_name": {"type": "string", "description": "Name of the report being shared (used in audit log)"}, "email_details": {"description": "Email addressing and content", "$ref": "#/definitions/NotificationReportEmailDetails"}}, "type": "object"}, "NotificationReportResponse": {"required": ["message"], "properties": {"status": {"type": "string", "description": "Result status"}, "message": {"type": "string", "description": "Result message"}}, "type": "object"}, "ObjectIdBatchRequest": {"properties": {"ids": {"type": "array", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "OnPremisesMonitoringRequest": {"required": ["aggregation", "metric_name", "resource_id"], "properties": {"service_account_id": {"type": "string", "description": "ID of the service account"}, "resource_id": {"type": "string", "description": "Resource identifier"}, "aggregation": {"type": "string", "description": "Aggregation type (e.g., average, sum, maximum)"}, "metric_name": {"type": "array", "description": "List of metric names", "items": {"type": "string"}}, "from_date": {"type": "string", "format": "date-time", "description": "Start timestamp (ISO string or epoch). If not provided, defaults to 7 days ago."}, "to_date": {"type": "string", "format": "date-time", "description": "End timestamp (ISO string or epoch). If not provided, defaults to now."}}, "type": "object"}, "OpenInfrastructureVulnerabilitiesByTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "OpenInfrastructureVulnerabilitiesByTrendWidgetConfiguration"}, "OpenVulnerabilitiesBySeverityWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "OpenVulnerabilitiesBySeverityWidgetConfiguration"}, "OpenstackTenant": {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID"}, "name": {"type": "string", "description": "Tenant Name"}, "domain_id": {"type": "string", "description": "Tenant Domain"}}, "type": "object"}, "OperationAccountModel": {"required": ["cloud_account_name", "count"], "properties": {"cloud_account_name": {"type": "string", "description": "cloud account name"}, "count": {"type": "integer", "description": "total count details"}}, "type": "object"}, "OperationPostureCloudCounts": {"properties": {"GCP": {"type": "number", "description": "GCP count"}, "AWS": {"type": "number", "description": "AWS count"}, "Azure": {"type": "number", "description": "Azure count"}, "OCI": {"type": "number", "description": "OCI count"}}, "type": "object"}, "OperationPostureCloudData": {"required": ["cloud_account_id", "cloud_account_name"], "properties": {"cloud_account_name": {"type": "string", "description": "cloud account name"}, "cloud_account_id": {"type": "string", "description": "cloud account id"}, "alerts": {"type": "integer", "description": "alerts count"}, "activities": {"type": "integer", "description": "activities cost"}, "automation_failures": {"type": "integer", "description": "automation count"}, "tenant_name": {"type": "string", "description": "Name of the tenant"}, "cloud": {"type": "string", "description": "cloud name"}}, "type": "object"}, "OperationPostureCloudProvider": {"properties": {"alerts": {"description": "alerts count", "$ref": "#/definitions/OperationPostureCloudCounts"}, "activities": {"description": "activities cost", "$ref": "#/definitions/OperationPostureCloudCounts"}, "automation_failures": {"description": "automation count", "$ref": "#/definitions/OperationPostureCloudCounts"}}, "type": "object"}, "OperationPostureRequest": {"properties": {"filter_by": {"type": "string", "description": "to filter data by cloud provider or cloud account wise or tenant.By default tenant wise data displayed", "example": "cloud_account", "enum": ["cloud_account", "cloud_provider", "tenant"], "x-cs-enum-type": "OperationPostureFilter"}, "tenant_ids": {"type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}, "service_name": {"type": "string", "description": "select the cloud account type", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "limit": {"type": "integer", "description": "Limit"}, "page": {"type": "integer", "description": "Page"}, "search": {"type": "string", "description": "Search by account_name wise"}}, "type": "object"}, "OperationPostureResponse": {"required": ["cloud_account_data", "clouds", "tenants", "total_count"], "properties": {"total_count": {"type": "integer", "description": "count details"}, "tenants": {"type": "array", "description": "List of tenant data", "items": {"$ref": "#/definitions/OperationPostureTenant"}}, "cloud_account_data": {"type": "array", "description": "List of cloud account data", "items": {"$ref": "#/definitions/OperationPostureCloudData"}}, "clouds": {"type": "array", "description": "List of tenant data", "items": {"$ref": "#/definitions/OperationPostureCloudProvider"}}}, "type": "object"}, "OperationPostureTenant": {"required": ["tenant_id", "tenant_name"], "properties": {"tenant_name": {"type": "string", "description": "Name of the tenant"}, "tenant_id": {"type": "string", "description": "Id of the tenant"}, "alerts": {"type": "integer", "description": "alerts count"}, "activities": {"type": "integer", "description": "activities cost"}, "automation_failures": {"type": "integer", "description": "automation count"}}, "type": "object"}, "OperationRegionModel": {"required": ["count", "region"], "properties": {"region": {"type": "string", "description": "region name"}, "count": {"type": "integer", "description": "total count details"}}, "type": "object"}, "OperationResourceGroupModel": {"required": ["count", "resource_group"], "properties": {"resource_group": {"type": "string", "description": "resource group name"}, "count": {"type": "integer", "description": "total count details"}}, "type": "object"}, "OperationResourceListModel": {"required": ["alert_type", "analysis", "blueprint_id", "cloud_account_id", "cloud_account_name", "description", "eventDataId", "event_action", "event_creation_time", "job_type", "location", "metric_name", "metric_value", "operator", "region", "resource", "resourceGroupId", "resourceId", "resource_group", "resource_name", "resource_type", "snooze", "status", "template_id", "threshold", "username", "windowSize", "zone"], "properties": {"cloud_account_name": {"type": "string", "description": "cloud account name"}, "cloud_account_id": {"type": "string", "description": "cloud account id"}, "tenant_name": {"type": "string", "description": "Name of the tenant"}, "tenant_id": {"type": "string", "description": "Id of the tenant"}, "username": {"type": "string", "description": "user name"}, "alert_type": {"type": "string", "description": "alert type"}, "eventDataId": {"type": "string", "description": "event data id"}, "resource_name": {"type": "string", "description": "resource_name"}, "region": {"type": "string", "description": "region name"}, "resource_group": {"type": "string", "description": "resource_group name"}, "zone": {"type": "string", "description": "zone name"}, "location": {"type": "string", "description": "location name"}, "resourceId": {"type": "string", "description": "resource id name"}, "resourceGroupId": {"type": "string", "description": "resource group id name"}, "status": {"type": "string", "description": "status"}, "description": {"type": "string", "description": "description"}, "resource": {"type": "string", "description": "resource"}, "event_action": {"type": "object", "description": "event_action"}, "resource_type": {"type": "string", "description": "resource_type name"}, "event_creation_time": {"type": "string", "description": "event creation time (UTC)"}, "metric_name": {"type": "string", "description": "metric name"}, "metric_value": {"type": "string", "description": "metric value"}, "threshold": {"type": "string", "description": "threshold"}, "operator": {"type": "string", "description": "operator"}, "windowSize": {"type": "string", "description": "windowSize"}, "snooze": {"type": "string", "description": "snooze"}, "analysis": {"type": "string", "description": "analysis"}, "action": {"type": "array", "description": "action", "items": {"type": "string"}}, "cloud": {"type": "string", "description": "cloud name"}, "job_type": {"type": "string", "description": "job type"}, "template_id": {"type": "string", "description": "Id of template"}, "blueprint_id": {"type": "string", "description": "Id of blueprint"}}, "type": "object"}, "OperationResourceModel": {"required": ["count", "resource"], "properties": {"resource": {"type": "string", "description": "resource name"}, "count": {"type": "integer", "description": "total count details"}}, "type": "object"}, "OperationVisibilityResponse": {"required": ["account_wise_count", "region_wise_count", "resource_group_wise_count", "resource_list_data", "resource_wise_count", "total_count", "zone_wise_count"], "properties": {"total_count": {"type": "integer", "description": "count details"}, "account_wise_count": {"type": "array", "description": "List of account wise count data", "items": {"$ref": "#/definitions/OperationAccountModel"}}, "resource_wise_count": {"type": "array", "description": "List of resource wise count data", "items": {"$ref": "#/definitions/OperationResourceModel"}}, "region_wise_count": {"type": "array", "description": "List of region wise count data", "items": {"$ref": "#/definitions/OperationRegionModel"}}, "resource_group_wise_count": {"type": "array", "description": "List of resource group wise data", "items": {"$ref": "#/definitions/OperationResourceGroupModel"}}, "zone_wise_count": {"type": "array", "description": "List of zone wise count data", "items": {"$ref": "#/definitions/ZoneModel"}}, "resource_list_data": {"type": "array", "description": "List of account wise count data", "items": {"$ref": "#/definitions/OperationResourceListModel"}}}, "type": "object"}, "OperationsFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"opgn_2504_a_test_flag": {"type": "boolean", "description": "Flag's default value", "default": false}}, "type": "object"}]}, "OptimizationSummary": {"required": ["estimated_cost", "impacted_resources", "info", "recommendations", "savings_percentage", "total_Cost"], "properties": {"total_Cost": {"type": "object", "description": "Total Cost"}, "recommendations": {"type": "object", "description": "Total Count"}, "savings_percentage": {"type": "string", "description": "Saving Percentage"}, "info": {"type": "string", "description": "Information"}, "estimated_cost": {"type": "number", "description": "forecasted cost"}, "impacted_resources": {"type": "object", "description": "Impacted resources"}}, "type": "object"}, "OrderHistoryReportModel": {"required": ["data"], "properties": {"data": {"type": "string", "description": "Order details"}}, "type": "object"}, "OthersFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"othr_2601_b_vpa_scaling": {"type": "boolean", "description": "Flag's default value", "default": false}, "othr_2602_b_vpa_scaling_for_cost": {"type": "boolean", "description": "Flag's default value", "default": false}, "othr_2602_b_vpa_scaling_for_corestack_identity": {"type": "boolean", "description": "Flag's default value", "default": false}, "othr_2602_b_vpa_scaling_for_heatstack": {"type": "boolean", "description": "Flag's default value", "default": false}}, "type": "object"}]}, "OverviewDetails": {"required": ["cloud_account_name", "expiry_date", "instance_flexibility", "number_of_RIs", "payment_option", "purchase_date", "region", "reservation_name", "reservation_sku", "reservation_type", "scope"], "properties": {"payment_option": {"type": "string", "description": "Payment method which is monthly or yearly"}, "instance_flexibility": {"type": "string", "description": "Instance Flexibility Should be on"}, "reservation_name": {"type": "string", "description": "Reservation Name"}, "reservation_type": {"type": "string", "description": "Reservation Type"}, "expiry_date": {"type": "string", "description": "Expiry date"}, "reservation_sku": {"type": "string", "description": "Reservation SKU details"}, "region": {"type": "string", "description": "Region where the resource is created"}, "cloud_account_name": {"type": "string", "description": "Name of the cloud account"}, "purchase_date": {"type": "string", "description": "Date of purchase"}, "number_of_RIs": {"type": "integer", "description": "How many RIs are present"}, "scope": {"type": "string", "description": "scope of the ri utilization"}}, "type": "object"}, "ParameterArray": {"allOf": [{"$ref": "#/definitions/ParameterBaseWithSchema"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ParameterArray"}, "ParameterBase": {"required": ["__type"], "properties": {"description": {"type": "string", "description": "A brief explanation of the policy parameter"}, "default_value": {"type": "string", "description": "Default value of the parameter, encoded as a JSON string"}, "hide_parameter": {"type": "boolean", "description": "Hide/Show a parameter for visibility as part of deployment"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ParameterStringType", "subtype_name": "ParameterStringType"}, {"subtype_model": "ParameterNumberType", "subtype_name": "ParameterNumberType"}, {"subtype_model": "ParameterBooleanType", "subtype_name": "ParameterBooleanType"}, {"subtype_model": "ParameterBaseWithSchema", "subtype_name": "ParameterBaseWithSchema"}, {"subtype_model": "ParameterArray", "subtype_name": "ParameterArray"}, {"subtype_model": "ParameterMap", "subtype_name": "ParameterMap"}, {"subtype_model": "ParameterObject", "subtype_name": "ParameterObject"}, {"subtype_model": "ParameterJsonBlob", "subtype_name": "ParameterJsonBlob"}]}, "ParameterBaseWithSchema": {"allOf": [{"$ref": "#/definitions/ParameterBase"}, {"required": ["values_schema"], "properties": {"values_schema": {"$ref": "#/definitions/ParameterBase"}}, "type": "object"}], "x-cs-type-name": "ParameterBaseWithSchema"}, "ParameterBooleanType": {"allOf": [{"$ref": "#/definitions/ParameterBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ParameterBooleanType"}, "ParameterConstraintAllowedValue": {"properties": {"display_name": {"type": "string", "description": "Name of the allowed value of the parameter's constraint field"}, "value": {"type": "string", "description": "Value of the allowed value of the parameter's constraint field"}}, "type": "object"}, "ParameterConstraintBase": {"required": ["__type"], "properties": {"description": {"type": "string", "description": "Description of the parameter's constraint field."}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ParameterConstraintForNumericRange", "subtype_name": "ParameterConstraintForNumericRange"}, {"subtype_model": "ParameterConstraintForAllowedValues", "subtype_name": "ParameterConstraintForAllowedValues"}, {"subtype_model": "ParameterConstraintForRegexPattern", "subtype_name": "ParameterConstraintForRegexPattern"}, {"subtype_model": "ParameterConstraintForLength", "subtype_name": "ParameterConstraintForLength"}]}, "ParameterConstraintBaseForNumber": {"allOf": [{"$ref": "#/definitions/ParameterConstraintBase"}, {"properties": {}, "type": "object"}]}, "ParameterConstraintBaseForString": {"allOf": [{"$ref": "#/definitions/ParameterConstraintBase"}, {"properties": {}, "type": "object"}]}, "ParameterConstraintForAllowedValues": {"allOf": [{"$ref": "#/definitions/ParameterConstraintBaseForString"}, {"properties": {"allowed_values": {"type": "array", "description": "List of allowed values for the parameter", "items": {"$ref": "#/definitions/ParameterConstraintAllowedValue"}}}, "type": "object"}], "x-cs-type-name": "ParameterConstraintForAllowedValues"}, "ParameterConstraintForLength": {"allOf": [{"$ref": "#/definitions/ParameterConstraintBaseForString"}, {"properties": {"min_length": {"type": "integer", "description": "Minimum length of the parameter's constraint field"}, "max_length": {"type": "integer", "description": "Maximum length of the parameter's constraint field"}}, "type": "object"}], "x-cs-type-name": "ParameterConstraintForLength"}, "ParameterConstraintForNumericRange": {"allOf": [{"$ref": "#/definitions/ParameterConstraintBaseForNumber"}, {"properties": {"min": {"type": "integer", "description": "Minimum value of the parameter's constraint field"}, "max": {"type": "integer", "description": "Maximum value of the parameter's constraint field"}}, "type": "object"}], "x-cs-type-name": "ParameterConstraintForNumericRange"}, "ParameterConstraintForRegexPattern": {"allOf": [{"$ref": "#/definitions/ParameterConstraintBaseForString"}, {"properties": {"allowed_pattern": {"type": "string", "description": "RegEx pattern for the value of the parameter"}}, "type": "object"}], "x-cs-type-name": "ParameterConstraintForRegexPattern"}, "ParameterDetails": {"required": ["ansible", "chef", "puppet", "shell"], "properties": {"chef": {"type": "object", "description": "Input for the Chef Script to be executed"}, "shell": {"type": "object", "description": "Input for the Shell Script to be executed"}, "puppet": {"type": "object", "description": "Input for the Puppet Script to be executed"}, "ansible": {"type": "object", "description": "Input for the Ansible Script to be executed"}}, "type": "object"}, "ParameterJsonBlob": {"allOf": [{"$ref": "#/definitions/ParameterBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ParameterJsonBlob"}, "ParameterMap": {"allOf": [{"$ref": "#/definitions/ParameterBaseWithSchema"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ParameterMap"}, "ParameterNumberType": {"allOf": [{"$ref": "#/definitions/ParameterBase"}, {"properties": {"constraints": {"type": "array", "items": {"$ref": "#/definitions/ParameterConstraintBaseForNumber"}}}, "type": "object"}], "x-cs-type-name": "ParameterNumberType"}, "ParameterObject": {"allOf": [{"$ref": "#/definitions/ParameterBase"}, {"properties": {"properties": {"type": "array", "items": {"$ref": "#/definitions/NamedParameter"}}}, "type": "object"}], "x-cs-type-name": "ParameterObject"}, "ParameterStringType": {"allOf": [{"$ref": "#/definitions/ParameterBase"}, {"properties": {"constraints": {"type": "array", "items": {"$ref": "#/definitions/ParameterConstraintBaseForString"}}}, "type": "object"}], "x-cs-type-name": "ParameterStringType"}, "PasswordResetRequest": {"properties": {"password": {"type": "string", "description": "Set new password"}, "reset_key": {"type": "string"}}, "type": "object"}, "PatchCompliance": {"properties": {"enabled": {"type": "boolean", "description": "Indicates if patch compliance is supported"}, "status": {"type": "boolean", "description": "True if compliant with patches, False if not"}}, "type": "object"}, "PatchComplianceReportReq": {"properties": {"span": {"type": "string", "description": "span name", "example": "PreviousMonth", "enum": ["PreviousMonth", "PreviousTwoMonths", "CurrentMonth", "PreviousThreeMonths", "PreviousSixMonths"], "x-cs-enum-type": "PatchComplianceReportSpan"}, "cloud_account_id": {"type": "string", "description": "Specify the Azure Cloud Account ID. This can be fetched from List CloudAccounts API call."}, "tenant_id": {"type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}}, "type": "object"}, "PatchComplianceReportRes": {"properties": {"status": {"type": "string", "description": "status response"}, "message": {"type": "string", "description": "message response"}, "data": {"type": "object", "description": "compliance data"}}, "type": "object"}, "PatchManagementAwsPatchGroupBaselineData": {"properties": {"patch_group": {"type": "string", "description": "Name of the patch group registered with the patch baseline"}, "baseline_id": {"type": "string", "description": "ID of the patch baseline"}, "name": {"type": "string", "description": "Name of the patch baseline"}, "operating_system": {"type": "string", "description": "Operating system the patch baseline"}, "description": {"type": "string", "description": "Description of the patch baseline"}}, "type": "object"}, "PatchManagementAwsPlatformDetails": {"properties": {"version": {"type": "string", "description": "Version of the OS platform"}, "type": {"type": "string", "description": "Operating system platform type"}, "name": {"type": "string", "description": "Name of the operating system platform"}}, "type": "object"}, "PatchManagementAwsResourceDetails": {"properties": {"operation": {"type": "string", "description": "Type of patching operation that was performed"}, "snapshot_id": {"type": "string", "description": "ID of the patch baseline snapshot"}, "status": {"type": "string", "description": "Compliance status for the resource"}, "computer_name": {"type": "string", "description": "The fully qualified host name of the managed node"}, "reboot_option": {"type": "string", "description": "Reboot option specified in the patch baseline"}, "statistics": {"description": "AWS statistics details", "$ref": "#/definitions/PatchManagementAwsStatisticsDetails"}, "platform": {"description": "Platform details", "$ref": "#/definitions/PatchManagementAwsPlatformDetails"}, "patch_group_baseline_data": {"description": "Patch group details", "$ref": "#/definitions/PatchManagementAwsPatchGroupBaselineData"}}, "type": "object"}, "PatchManagementAwsStatisticsDetails": {"properties": {"installed_count": {"type": "integer", "description": "Number of patches from the patch baseline that are installed"}, "installed_other_count": {"type": "integer", "description": "Number of patches not specified in the patch baseline that are installed"}, "installed_pending_reboot_count": {"type": "integer", "description": "Number of patches installed by Patch Manager since the last time the managed node was rebooted"}, "installed_rejected_count": {"type": "integer", "description": "Number of Rejected Patches count"}, "missing_count": {"type": "integer", "description": "Number of patches from the baseline that are applicable for the managed node but not currently installed"}, "failed_count": {"type": "integer", "description": "Number of patches from the patch baseline that were attempted to be installed during the last patching operation, but failed to install"}, "unreported_not_applicable_count": {"type": "integer", "description": "Number of patches beyond the supported limit of NotApplicableCount that not reported by name to Inventory"}, "not_applicable_count": {"type": "integer", "description": "Number of patches from the patch baseline not applicable for the managed node"}, "critical_non_compliant_count": {"type": "integer", "description": "Number of patches per node that are specified as Critical for compliance reporting in the patch baseline not installed"}, "security_non_compliant_count": {"type": "integer", "description": "Number of patches per node that are specified as Security in a patch advisory not installed"}, "other_non_compliant_count": {"type": "integer", "description": "Number of patches per node that are specified as other than Critical or Security but not  compliant with the patch baseline"}}, "type": "object"}, "PatchManagementAzureErrorContext": {"properties": {"message": {"type": "string", "description": "Error message"}, "code": {"type": "string", "description": "Error code"}}, "type": "object"}, "PatchManagementAzureResourceDetails": {"required": ["os_type", "status"], "properties": {"assessment_activity_id": {"type": "string", "description": "ID of the assessment activity"}, "patch_details": {"description": "Patch details", "$ref": "#/definitions/PatchManagementAzureResourcePatchDetails"}, "status": {"type": "string", "description": "Patch assessment status", "example": "Succeeded", "enum": ["Succeeded", "Failed", "InProgress"], "x-cs-enum-type": "PatchAssessmentStatus"}, "reboot_pending": {"type": "boolean", "description": "Flag to indicate if a reboot is pending"}, "failure_details": {"description": "Error details", "$ref": "#/definitions/PatchManagementAzureResourcePatchErrorDetails"}, "started_by": {"type": "string", "description": "Name of the user who started the patching operation"}, "os_type": {"type": "string", "description": ["OS platform of the target machine (linux/windows)"], "example": "linux", "enum": ["linux", "windows"], "x-cs-enum-type": "Platform"}}, "type": "object"}, "PatchManagementAzureResourcePatchDetails": {"properties": {"security_count": {"type": "integer", "description": "Number of security patches"}, "other_count": {"type": "integer", "description": "Number of other patches"}, "update_rollup_count": {"type": "integer", "description": "Number of update rollup patches"}, "feature_pack_count": {"type": "integer", "description": "Number of feature pack patches"}, "service_pack_count": {"type": "integer", "description": "Number of service pack patches"}, "definition_count": {"type": "integer", "description": "Number of definition patches"}, "critical_count": {"type": "integer", "description": "Number of critical patches"}, "updates_count": {"type": "integer", "description": "Number of update patches"}, "tools_count": {"type": "integer", "description": "Number of tools patches"}, "last_installed_count": {"type": "integer", "description": "Number of patches installed in the last patching operation"}, "last_installation_activity_id": {"type": "string", "description": "ID of the last installation activity"}, "critical_update_required": {"type": "boolean", "description": "Flag to indicate if a critical update is required"}, "security_update_required": {"type": "boolean", "description": "Flag to indicate if a security update is required"}, "other_update_required": {"type": "boolean", "description": "Flag to indicate if other updates are required"}}, "type": "object"}, "PatchManagementAzureResourcePatchErrorDetails": {"allOf": [{"$ref": "#/definitions/PatchManagementAzureErrorContext"}, {"properties": {"details": {"type": "array", "description": "Error details", "items": {"$ref": "#/definitions/PatchManagementAzureErrorContext"}}}, "type": "object"}]}, "PatchManagementResourceHistory": {"properties": {"cloud_account_id": {"type": "string", "description": "ID of the cloud account"}, "cloud_native_resource_id": {"type": "string", "description": "Resource identifier id of the resource"}, "region": {"type": "string", "description": "Region name"}, "resource_group": {"type": "string", "description": "Resource group name"}, "location": {"type": "string", "description": "Location of the resource"}, "resource_category": {"type": "string", "description": "Name of the category"}, "resource_type": {"type": "string", "description": "Name of the component"}, "resource": {"type": "string", "description": "Name of the resource"}, "created_at": {"type": "string", "format": "date-time", "description": "Resource Patch history record creation time"}, "updated_at": {"type": "string", "format": "date-time", "description": "Resource Patch history last updated time"}, "last_no_reboot_install_operation_time": {"type": "string", "format": "date-time", "description": "Time of the last attempt to patch the managed node"}, "operation_start_time": {"type": "string", "format": "date-time", "description": "Patch operation started time for the node"}, "operation_end_time": {"type": "string", "format": "date-time", "description": "Patch operation completed time for the node"}, "AWS": {"description": "AWS patch details", "$ref": "#/definitions/PatchManagementAwsResourceDetails"}, "Azure": {"description": "Azure patch details", "$ref": "#/definitions/PatchManagementAzureResourceDetails"}, "next_maintenance": {"type": "string", "format": "date-time", "description": "Next maintenance window for the resource"}, "previous_maintenance": {"type": "string", "format": "date-time", "description": "Previous maintenance window for the resource"}}, "type": "object"}, "PatchReadinessStatistics": {"properties": {"supported_resources": {"type": "integer", "description": "Total number of resources for which the dashboard needs to present the data."}, "ready_to_update": {"type": "integer", "description": "Total number of instance/vm which is ready for updating the patch."}}, "type": "object"}, "PatchReadinessStatusQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["patch_readiness_status"], "properties": {"patch_readiness_status": {"type": "array", "description": "Patch Readiness status to include", "items": {"type": "string", "description": "Patch Readiness Status Type is required", "example": "Ready", "enum": ["Ready", "Partially Ready", "Not Ready"], "x-cs-enum-type": "PatchReadinessStatusTypes"}}}, "type": "object"}], "x-cs-type-name": "PatchReadinessStatusQueryOperator"}, "PeriodicBackgroundJobPayloadBase": {"allOf": [{"$ref": "#/definitions/BackgroundJobPayloadBase"}, {"properties": {}, "type": "object"}]}, "PlatFormAccountQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"service_type": {"type": "string", "description": "Service type of the platform. Eg, kubernetes"}, "cluster_type": {"type": "string", "description": "Cluster type of the platform. Eg, EKS, AKS and etc"}, "platform_account_ids": {"type": "array", "description": "Platform account IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "PlatFormAccountQueryOperator"}, "PlatformAssignedTasks": {"properties": {"task_id": {"type": "string", "description": "Unique ID of the assigned task"}, "assigned_task": {"type": "string", "description": "Assigned task", "example": "backfill", "enum": ["backfill", "push_logs", "restart"], "x-cs-enum-type": "PlatformTasks"}, "properties": {"description": "Task specific properties (number of days for backfill)", "$ref": "#/definitions/PlatformTaskProperties"}}, "type": "object"}, "PlatformKeyValues": {"allOf": [{"$ref": "#/definitions/KeyValues"}, {"required": ["kind"], "properties": {"kind": {"type": "string", "description": "Type of the platform kind (e.g. namespace, deployment, node)"}}, "type": "object"}]}, "PlatformLogs": {"properties": {"log_type": {"type": "string", "description": "Type of logs to push"}, "timestamp": {"type": "string", "format": "date-time", "description": "Start time for logs to be pushed"}, "message": {"type": "string", "description": "Log message to be pushed"}, "trace_back": {"type": "string", "description": "Traceback information if any"}, "run_id": {"type": "string", "description": "Run ID associated with the log"}, "cluster": {"type": "string", "description": "Cluster name"}, "namespace": {"type": "string", "description": "Namespace name"}, "pod_name": {"type": "string", "description": "Pod name"}, "container": {"type": "string", "description": "Container name"}, "node": {"type": "string", "description": "Node name"}}, "type": "object"}, "PlatformLogsRequest": {"properties": {"logs_list": {"type": "array", "description": "List of log entries", "items": {"$ref": "#/definitions/PlatformLogs"}}}, "type": "object"}, "PlatformLogsResponse": {"properties": {"message": {"type": "string", "description": "Additional information about the log submission"}}, "type": "object"}, "PlatformTaskProperties": {"properties": {"days": {"type": "integer", "description": "Number of days for backfill", "default": 30}}, "type": "object"}, "PlatformTaskRequest": {"required": ["service_account_id", "task"], "properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}, "task": {"type": "string", "description": "Platform related background tasks", "example": "backfill", "enum": ["backfill", "push_logs", "restart"], "x-cs-enum-type": "PlatformTasks"}, "properties": {"description": "Task specific properties (number of days for backfill)", "$ref": "#/definitions/PlatformTaskProperties"}}, "type": "object"}, "PlatformTaskResponse": {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID"}, "assigned_tasks": {"type": "array", "description": "Assigned tasks", "items": {"$ref": "#/definitions/PlatformAssignedTasks"}}}, "type": "object"}, "PlatformTaskUpdateRequest": {"required": ["status", "task", "task_id"], "properties": {"task_id": {"type": "string", "description": "Unique ID of the task to be updated"}, "task": {"type": "string", "description": "Task to be updated", "example": "backfill", "enum": ["backfill", "push_logs", "restart"], "x-cs-enum-type": "PlatformTasks"}, "status": {"type": "string", "description": "Updated status of the task", "example": "new", "enum": ["new", "in_progress", "completed", "failed"], "x-cs-enum-type": "PlatformTaskStatus"}}, "type": "object"}, "PodIdRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["pod_id_regex"], "properties": {"pod_id_regex": {"description": "Kubernetes Pod ID by regex match (resource_id, resource_group=Pod)", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "PodIdRegexQueryOperator"}, "PodIdsQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["pod_ids"], "properties": {"pod_ids": {"type": "array", "description": "Pod Ids to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "PodIdsQueryOperator"}, "PodNameRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["pod_name_regex"], "properties": {"pod_name_regex": {"description": "Kubernetes Pod name by regex match", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "PodNameRegexQueryOperator"}, "PodNamesQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["pod_names"], "properties": {"pod_names": {"type": "array", "description": "Pod Names to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "PodNamesQueryOperator"}, "PolicyActionPair": {"properties": {"policy": {"type": "string", "description": "Name of the policy", "example": "access_governance_dashboard", "enum": ["access_governance_dashboard", "access_posture", "account_governance", "accountmaster_support_dashboard", "ai_observability_dashboard", "alarms", "anomaly_detector", "application", "application_management", "approve_assessment", "approver_dashboard_tenant", "appscripts", "appsecops_agent", "assessment_agent", "rate_optimization_agent", "appsecops_dashboard", "assessment_approver", "assessment_contributor", "assessment_execution", "assessment_management", "associated_accounts", "audit", "automation_dashboard", "automation_workflow", "aws_security_hub", "aws_security_hub_dashboard", "aws_ssm", "azure_devops_dashboard", "azure_security_graph", "azure_sentinel", "basic_access", "billing_inventory", "billing_metric", "billing_plans", "blueprint_jobs", "blueprints", "browse_catalog", "budget_management", "builds_dashboard", "catalogs", "cloud_and_tool_accounts", "cloudaccount_support_dashboard", "compass_administrator", "compliance_control", "compliance_control_definitions", "compliance_control_mapping", "compliance_dashboard", "cost_analysis_report", "cost_anomaly", "cost_billing_operations", "cost_budget_management", "cost_dashboard", "cost_posture", "cost_savings_and_recommendations", "create_reports", "currency_exchange_plans", "custom_reports", "customer_support_dashboard", "dashboard_subscribe", "dashboard_v2", "dimension", "dpo", "faq", "finance_dashboard_account", "iaas", "inventory", "inventory_actions", "inventory_elements", "itsm_cmdb", "itsm_configuration", "itsm_request", "maintenance", "manage_workload_owner", "marketplace_support_dashboard", "markup_discount", "master_account", "milestone_management", "monitoring_alerts", "my_approvals", "my_cloud_apps", "notification_service", "operation_posture", "operations_activity", "operations_dashboard", "operations_report", "order_history", "payment", "policies", "policy_data", "policy_exclusions", "policy_jobs", "portfolio_management", "product_bundle", "project_management", "quota_management", "recommendations", "recommendations_dashboard", "recommendations_dashboard_v2", "reports", "request", "reservation_recommendations", "reservation_utilization", "resource_consistency_dashboard", "resource_list", "resource_locks", "resource_posture", "resource_tags", "roles", "sbom_management", "schedules", "scope", "script_jobs", "scripts", "secops_dashboard_v2", "security_operations_dashboard", "security_posture", "self_service_catalog", "self_service_dashboard", "signup_users", "stackops__auto_approve", "stackops__deployments", "stackops__products", "stackops__stacks", "stackops__stacks_cost_estimation", "stackops__stacks_delegation", "subscription", "tag_pattern", "tagging_governance_baselines", "template_generator", "template_jobs", "templates", "tenant_support_dashboard", "tenants", "terms_conditions", "tools_integrations", "transaction", "user_delegation", "user_support_dashboard", "usergroup", "users", "utilization_metrics", "visualiser", "wellarchitected_frameworks", "workload", "workload_component", "workload_contributor", "workload_management"], "x-cs-enum-type": "PolicyEnum"}, "action": {"type": "string", "description": "Action supported for the policy", "example": "access_analytics", "enum": ["access_analytics", "access_governance", "account", "activate", "activity_analytics", "admin_dashboard", "admin_reports", "approval", "approve", "assessment_reports", "automation_analytics", "availability_reports", "backup_analytics", "cancel", "clone", "cloud_inventory_reports", "cloud_service_analytics", "compliance_analytics", "compliance_reports", "contribute", "cost_analytics", "cost_governance", "cost_recommendations", "cost_reports", "cost_usage_reports", "create", "delegate", "delete", "detail", "execute", "extend_trial", "generate_posture", "global", "inventory_analytics", "inventory_report", "inventory_reports", "manage", "manage_acl", "manage_owner", "manage_children", "manager_dashboard", "monitoring_analytics", "monitoring_reports", "operations_governance", "partner_cost_reports", "patch_analytics", "patch_compliance_report", "patch_management", "policy_reports", "private", "publish", "read", "read_children", "reject", "remediate", "resolve", "resource_governance", "revoke", "security_analytics", "security_governance", "security_reports", "self_service_reports", "share", "show_menu", "status", "system_reports", "tenant", "terminate_trial", "threat_analytics", "update", "utilization_reports", "view_quota", "vulnerability_analytics"], "x-cs-enum-type": "ActionEnum"}}, "type": "object"}, "PolicyClassificationWithSubClassifications": {"properties": {"access": {"type": "array", "description": "List of Access sub-classifications", "items": {"type": "string", "description": "Access Sub Classifications", "example": "Data", "enum": ["Data", "Operation", "Security", "Standards", "Utilization"], "x-cs-enum-type": "PolicyAccessSubClassification"}}, "cost": {"type": "array", "description": "List of Cost sub-classifications", "items": {"type": "string", "description": "Security Sub Classifications", "example": "Anomaly", "enum": ["Anomaly", "Billing", "Budget", "Config", "Governance", "Idle", "Logging", "Optimized", "Orphaned", "Standards", "Tags", "Underutilized", "Utilization"], "x-cs-enum-type": "PolicyCostSubClassification"}}, "data": {"type": "array", "description": "List of Data sub-classifications", "items": {"type": "string", "description": "Data Sub Classifications", "example": "Security", "enum": ["Security"], "x-cs-enum-type": "PolicyDataSubClassification"}}, "network": {"type": "array", "description": "List of Network sub-classifications", "items": {"type": "string", "description": "Network Sub Classifications", "example": "Application", "enum": ["Application"], "x-cs-enum-type": "PolicyNetworkSubClassification"}}, "operation": {"type": "array", "description": "List of Operation sub-classifications", "items": {"type": "string", "description": "Security Sub Classifications", "example": "Application", "enum": ["Application", "Availability", "Backup", "Config", "Data", "Host", "Logging", "Monitoring", "Optimized", "Performance", "Standards", "Underutilized"], "x-cs-enum-type": "PolicyOperationSubClassification"}}, "performance": {"type": "array", "description": "List of performance sub-classifications", "items": {"type": "string", "description": "Performance Sub Classifications", "example": "Standards", "enum": ["Standards"], "x-cs-enum-type": "PolicyPerformanceSubClassification"}}, "resource": {"type": "array", "description": "List of Resource sub-classifications", "items": {"type": "string", "description": "Resource Sub Classifications", "example": "Naming Standards", "enum": ["Naming Standards"], "x-cs-enum-type": "PolicyResourceSubClassification"}}, "security": {"type": "array", "description": "List of security sub classifications", "items": {"type": "string", "description": "Security Sub Classifications", "example": "Access", "enum": ["Access", "Application", "Application_Integration", "Availability", "Data", "Databases", "Encryption", "End Point Protection", "High", "Host", "Identity", "Logging", "Monitoring", "Network", "SNS", "Standards", "Storage", "medium"], "x-cs-enum-type": "PolicySecuritySubClassification"}}}, "type": "object"}, "PolicyConfigurationAccountListRequest": {"properties": {"service_account_ids": {"type": "array", "description": "List of service account ids for which policies are configured.", "items": {"type": "string"}}}, "type": "object"}, "PolicyCounts": {"properties": {"violations": {"type": "string", "description": "Number of policies which are in violation status."}, "success": {"type": "string", "description": "Number of policies which are in success status."}, "error": {"type": "string", "description": "Number of policies which are in error status."}, "in_progress": {"type": "string", "description": "Number of policies which are in in_progress status."}, "none": {"type": "string", "description": "Number of policies which are not having any status or in none status"}}, "type": "object"}, "PolicyData": {"required": ["policy_id"], "properties": {"policy_id": {"type": "string", "description": "unique policy Id returned"}}, "type": "object"}, "PolicyDataList": {"required": ["content_type", "description", "display_name", "engine_type", "name", "policy_id", "scope", "services", "status", "uri"], "properties": {"policy_id": {"type": "string", "description": "Policy Id is unique identifier of a policy"}, "name": {"type": "string", "description": "Policy Name is unique can allow only"}, "display_name": {"type": "string", "description": "Display name of policy"}, "uri": {"type": "string", "description": "Unique URI for policy"}, "description": {"type": "string", "description": "A brief explanation of the policy."}, "status": {"type": "string", "description": "Indicates whether the policy is active or inactive."}, "services": {"type": "array", "description": "Displays the service associated with the policy, for example, AWS, AzureRM, Openstack., etc", "items": {"type": "string"}}, "engine_type": {"type": "string", "description": "Engine type of policy where it will execute"}, "policy_type": {"type": "string", "description": "Type of the policy."}, "content_type": {"type": "string", "description": "Content type of policy (Git or File)"}, "classification": {"type": "string", "description": "Classification of policy", "example": "Access", "enum": ["Access", "Cost", "Data", "Network", "Operation", "Performance", "Resource", "Security"], "x-cs-enum-type": "PolicyClassification"}, "sub_classification": {"type": "string", "description": "Sub classification of policy"}, "category": {"type": "string", "description": "Category of policy"}, "resource_type": {"type": "string", "description": "Resource type of policy"}, "service_resources": {"type": "array", "items": {"type": "string", "description": "Service resource of policy"}}, "scope": {"type": "string", "description": "The scope of the policy. Account scope: All users under that account will have access to view and execute. Only Account admins can update or delete the policies. Tenant scope: Users with access to the specific tenant will have access to policies and can describe or execute policies. Tenant admins can only update or delete. Private scope: Only the user who created the policy will have access."}, "severity": {"type": "string", "description": "Severity of policy", "example": "critical", "enum": ["critical", "high", "info", "low", "medium", "none", "unknown"], "x-cs-enum-type": "PolicySeverityRisk"}, "parameters": {"type": "string", "description": "Parameters associated with the policy as JSON string."}}, "type": "object"}, "PolicyDescription": {"properties": {"uri": {"type": "string", "description": "Unique URI for policy"}, "policy_id": {"type": "string", "description": "Policy Id is unique identifier of a policy"}, "name": {"type": "string", "description": "Policy name is unique identifier of a policy"}, "display_name": {"type": "string", "description": "Display name of the policy"}, "description": {"type": "string", "description": "A brief explanation of the policy"}, "parameters": {"type": "array", "items": {"$ref": "#/definitions/NamedParameter"}}, "created_at": {"type": "string", "format": "date-time"}, "services": {"type": "array", "items": {"type": "string", "description": "Displays the service associated with the policy", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_EA", "Azure_MCA", "GCP", "OCI", "Openstack", "OpenstackPublic"], "x-cs-enum-type": "PolicyServiceName"}}, "engine_type": {"type": "string", "description": "Engine type of the policy", "example": "corestack_policy", "enum": ["corestack_policy", "aws_organization_policy", "azure_policy", "aws_config", "gcp_organization_policy", "gcp_policy", "kubernetes_policy", "oracle_cloud_guard"], "x-cs-enum-type": "PolicyEngineType"}, "scope": {"type": "string", "description": "Scope of the policy", "example": "global", "enum": ["global", "account", "tenant", "user_private"], "x-cs-enum-type": "PolicyScope"}, "tenant_id": {"type": "string", "description": "ID of the tenant within the CoreStack account"}, "account_id": {"type": "string", "description": "Id of the CoreStack account under which this tenant resides."}, "classification": {"type": "string", "description": "Policies are classified based on the basis of the activity they perform. For example: Provisioning, Account Management, Utilization, etc."}, "sub_classification": {"type": "string", "description": "Sub classification for policy"}, "resource_category": {"type": "string", "description": "Category of resource"}, "resource_type": {"type": "string", "description": "Type of resource"}, "service_resources": {"type": "array", "description": "Service resources of policy", "items": {"type": "string"}}, "severity": {"type": "string", "description": "Severity of policy", "example": "critical", "enum": ["critical", "high", "info", "low", "medium", "none", "unknown"], "x-cs-enum-type": "PolicySeverityRisk"}, "recommendation_description": {"type": "string", "description": "Recommendation description of the policy"}, "recommendation_actions": {"type": "array", "description": "Recommendation actions of the policy", "items": {"$ref": "#/definitions/PolicyRecommendationActions"}}, "equivalent_policies": {"type": "array", "description": "Equivalent policy names", "items": {"type": "string"}}}, "type": "object"}, "PolicyDescriptionRequest": {"properties": {"policy_uris": {"type": "array", "description": "Unique URI for policy", "items": {"type": "string"}}}, "type": "object"}, "PolicyExecuteRequest": {"required": ["args", "cloud_accounts"], "properties": {"args": {"type": "object", "description": "arguments to execute policy for example values can be in the below format {'listOfAllowedSKUs':['Basic_A0']} or {'requiredRetentionDays':'365','effect':'AuditIfNotExists'} etc.The values are dynamic in nature can change from policy to policy.The arguments required can be changed in the policy content in the view policy api"}, "cloud_accounts": {"type": "array", "description": "cloud account details to execute the policy", "items": {"$ref": "#/definitions/PolicyServiceAccountDetails"}}}, "type": "object"}, "PolicyExecuteResponse": {"required": ["job_id"], "properties": {"job_id": {"type": "string", "description": "Job identifier of the executed policy"}}, "type": "object"}, "PolicyExecutionRequest": {"required": ["cloud_account_id", "policy_uri"], "properties": {"policy_uri": {"type": "string", "description": "Unique URI for the policy"}, "cloud_account_id": {"type": "string", "description": "Account to execute the policy against"}, "params": {"type": "string", "description": "Policy execution parameters, encoded as a JSON string"}, "execution_group": {"type": "string", "description": "Policy execution group name"}, "execution_reference": {"type": "string", "description": "Policy execution reference ID"}}, "type": "object"}, "PolicyFailureData": {"required": ["assessment_by", "policy_execution_status", "policy_job_id", "policy_name", "region", "resource_group", "status_reason"], "properties": {"policy_name": {"type": "string", "description": "policy job name"}, "policy_job_id": {"type": "string", "description": "policy job id"}, "policy_execution_status": {"type": "string", "description": "policy execution status"}, "status_reason": {"type": "string", "description": "status reason"}, "assessment_by": {"type": "string", "description": "assessment by"}, "region": {"type": "string", "description": "region"}, "resource_group": {"type": "string", "description": "resource group"}}, "type": "object"}, "PolicyJobBatchRequest": {"required": ["policy_job_ids"], "properties": {"policy_job_ids": {"type": "array", "description": "Unique IDs of Policy Jobs", "items": {"type": "string"}}}, "type": "object"}, "PolicyJobExecutionStatusRequest": {"required": ["assessment_job_number", "policy_id"], "properties": {"assessment_job_number": {"type": "string", "description": "Specify the assessment_job_number.This can be fetched from List Compliance Control Assessment History API."}, "policy_id": {"type": "string", "description": "Specify the policy ID. This can be fetched from List compliance control mapping, get_on_audit_entries API."}}, "type": "object"}, "PolicyJobExecutionStatusResponse": {"properties": {"total_count": {"type": "string"}, "page_count": {"type": "string", "description": "page count"}, "failures": {"type": "array", "description": "Reason for policy failure", "items": {"$ref": "#/definitions/PolicyFailureData"}}}, "type": "object"}, "PolicyListRequest": {"properties": {"name": {"type": "string", "description": "Name of the policy"}, "display_name": {"type": "string", "description": "Display name of the policy"}, "scope": {"type": "string", "description": "Scope of the policy."}, "policy_uris": {"type": "array", "items": {"type": "string", "description": "Policy uri."}}, "services": {"type": "array", "items": {"type": "string", "description": "Displays the service associated with the policy", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_EA", "Azure_MCA", "GCP", "OCI", "Openstack", "OpenstackPublic"], "x-cs-enum-type": "PolicyServiceName"}}, "category": {"type": "string", "description": "Category of the policy."}, "status": {"type": "string", "description": "Status of the policy."}, "policy_type": {"type": "string", "description": "Type of the policy."}, "engine_type": {"type": "string", "description": "Engine type of the policy."}, "classification": {"type": "string", "description": "Classification of the policy.", "example": "Access", "enum": ["Access", "Cost", "Data", "Network", "Operation", "Performance", "Resource", "Security"], "x-cs-enum-type": "PolicyClassification"}, "sub_classification": {"type": "string", "description": "Sub-classification of the policy."}, "resource_type": {"type": "string", "description": "Resource type of the policy."}, "service_resource": {"type": "string", "description": "Service resource of the policy."}, "remediation_supported": {"type": "boolean", "description": "When true, returns only policies that support remediation(s)."}}, "type": "object"}, "PolicyListResponse": {"required": ["policies"], "properties": {"policies": {"type": "array", "description": "Policy Metadata Info.", "items": {"$ref": "#/definitions/PolicyDataList"}}}, "type": "object"}, "PolicyMetadata": {"properties": {"file": {"type": "string", "description": "Metadata about policy"}}, "type": "object"}, "PolicyNamedParameterValidationRequest": {"required": ["params", "policy_uri"], "properties": {"policy_uri": {"type": "string", "description": "Unique URI for policy"}, "params": {"type": "string", "description": "Policy execution parameters, encoded as a JSON string"}}, "type": "object"}, "PolicyParameterConfiguration": {"properties": {"parameters_configuration": {"type": "array", "items": {"$ref": "#/definitions/NamedParameter"}}}, "type": "object"}, "PolicyRecommendation": {"required": ["classification", "cloud", "cloud_account_id", "created_at", "impact", "policy_id", "recommendation_id", "recommendation_name", "status", "tenant_name"], "properties": {"recommendation_id": {"type": "string", "description": "unique recommendation Id"}, "recommendation_name": {"type": "string", "description": "recommendation name"}, "policy_id": {"type": "array", "description": "list of policy ids for which the recommendation exists", "items": {"type": "string"}}, "status": {"type": "string", "description": "resolution status of the recommendation the values will be open, resolved"}, "impact": {"type": "string", "description": "impact of recommended changes"}, "classification": {"type": "string", "description": "classified based on the kind of recommendation provided to the user can be cost, security etc"}, "cloud_account_id": {"type": "string", "description": "cloud account id impacted by the recommendation"}, "cloud": {"type": "string", "description": "cloud on which this account exits for which the recommendations exists"}, "tenant_name": {"type": "string", "description": "tenant for which the recommendation exits "}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "created_at": {"type": "string", "description": "UTC time at which the recommendation was created"}}, "type": "object"}, "PolicyRecommendationActions": {"properties": {"name": {"type": "string", "description": "Name of the recommendation action"}, "description": {"type": "string", "description": "Description of the recommendation action"}, "terms_and_conditions": {"type": "string", "description": "T&C of the recommendation action"}, "preexecute_required": {"type": "boolean", "description": "Flag to check if pre-execute is required or not"}}, "type": "object"}, "PolicyRecommendationClassificationQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["classifications"], "properties": {"classifications": {"type": "array", "description": "Classifications to include. Please note that if this is defined, only policy-related recommendations will be fetched.", "items": {"type": "string", "description": "Classification of the policy", "example": "Access", "enum": ["Access", "Cost", "Data", "Network", "Operation", "Performance", "Resource", "Security"], "x-cs-enum-type": "PolicyClassification"}}}, "type": "object"}], "x-cs-type-name": "PolicyRecommendationClassificationQueryOperator"}, "PolicyRecommendationListResponse": {"required": ["recommendations"], "properties": {"recommendations": {"description": "Policy recommendation Info list", "$ref": "#/definitions/PolicyRecommendation"}}, "type": "object"}, "PolicyRecommendationViewResponse": {"required": ["actions", "classification", "cloud", "cloud_account_id", "created_at", "description", "impact", "policy_id", "recommendation_id", "recommendation_name", "resources", "status", "tenant_name"], "properties": {"recommendation_id": {"type": "string", "description": "unique recommendation Id"}, "recommendation_name": {"type": "string", "description": "recommendation name"}, "policy_id": {"type": "array", "description": "list of policy ids for which the recommendation exists", "items": {"type": "string"}}, "status": {"type": "string", "description": "resolution status of the recommendation the values will be open, resolved"}, "impact": {"type": "string", "description": "impact of recommended changes"}, "classification": {"type": "string", "description": "classified based on the kind of recommendation provided to the user can be cost, security etc"}, "cloud_account_id": {"type": "string", "description": "cloud account id impacted by the recommendation"}, "cloud": {"type": "string", "description": "cloud on which this account exits for which the recommendations exists"}, "tenant_name": {"type": "string", "description": "tenant for which the recommendation exits "}, "created_at": {"type": "string", "description": "UTC time at which the recommendation was created"}, "description": {"type": "string", "description": "Description about the recommendation in details"}, "actions": {"type": "array", "description": "List of actions which can be performed to resolve the policy violations", "items": {"$ref": "#/definitions/RecommendationActionResponse"}}, "resources": {"type": "array", "description": "List of resources on which the recommendations can be performed", "items": {"$ref": "#/definitions/ResourceRecommendationModel"}}}, "type": "object"}, "PolicyRequest": {"allOf": [{"$ref": "#/definitions/PolicyDescriptionRequest"}, {"properties": {"policy_ids": {"type": "array", "description": "List of policy IDs to fetch policy details", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}]}, "PolicyResourceRecommendationPolicyIdsQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["policy_ids"], "properties": {"policy_ids": {"type": "array", "description": "Policy ID(s) to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "PolicyResourceRecommendationPolicyIdsQueryOperator"}, "PolicyResourceRecommendationSeverityQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["severities"], "properties": {"severities": {"type": "array", "description": "Policy resource recommendation severities to include", "items": {"type": "string", "description": "Severity of the policy", "example": "critical", "enum": ["critical", "high", "info", "low", "medium", "none", "unknown"], "x-cs-enum-type": "PolicySeverityRisk"}}}, "type": "object"}], "x-cs-type-name": "PolicyResourceRecommendationSeverityQueryOperator"}, "PolicyResourceRecommendationStatusQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["statuses"], "properties": {"statuses": {"type": "array", "description": "Policy resource recommendation statuses to include", "items": {"type": "string", "description": "Status of the policy resource recommendation", "example": "error", "enum": ["error", "in_progress", "open", "resolved", "skipped", "system_skipped"], "x-cs-enum-type": "PolicyResourceRecommendationStatus"}}}, "type": "object"}], "x-cs-type-name": "PolicyResourceRecommendationStatusQueryOperator"}, "PolicyServiceAccountDetails": {"required": ["cloud_account_id"], "properties": {"cloud": {"type": "string", "description": "The cloud name of the account for which the policywill be executed ex: AWS, Azure, GCP, OCI etc"}, "cloud_account_id": {"type": "string", "description": "Identifier of the cloud account on boarded in the on boarding section"}, "region": {"type": "string", "description": "The region of the service account where it needs to be executed, if this is not provided the policy will execute for all the region"}, "resourcegroup": {"type": "string", "description": "Resource group for which you need to execute the policy for, this is not a mandatory parameter to be passed"}}, "type": "object"}, "PolicyTriggerInfo": {"properties": {"policy_uri": {"type": "string", "description": "URI of the Policy"}, "ondemand_job_id": {"type": "string", "description": "Compliance Ondemand job id"}, "args": {"type": "string", "description": "Policy Parameters, encoded as a JSON string"}, "instance": {"type": "array", "items": {"type": "string"}}}, "type": "object"}, "PolicyViewResponse": {"required": ["category", "classification", "content", "content_type", "description", "engine_type", "git_content_path", "git_content_url", "git_content_username", "is_system_policy", "policy_id", "policy_name", "scope", "services", "status", "sub_classification", "uri"], "properties": {"policy_id": {"type": "string", "description": "The unique identifier created for each policy."}, "policy_name": {"type": "string", "description": "The name of the policy without space or special character "}, "description": {"type": "string", "description": "A brief explanation of the policy."}, "status": {"type": "string", "description": "Indicates whether the policy is active or inactive."}, "category": {"type": "string", "description": "The category will be either service or resource."}, "engine_type": {"type": "string", "description": "Engine type of policy"}, "services": {"type": "array", "description": "Displays the service associated with the policy for example, AWS, AzureRM, Openstack., etc", "items": {"type": "string"}}, "scope": {"type": "string", "description": "The scope of the policy:\nAccount scope - All users under that account will have access to view and execute Only Account admins can update/delete the policies,\nTenant Scope - Users with access to the specific tenant will have access to policies who can describe or execute policies. Tenant admins can only update/delete.\nPrivate Scope - User who created will only have access", "example": "private", "enum": ["private", "account", "tenant"], "x-cs-enum-type": "AccountScope"}, "content_type": {"type": "string", "description": "Content type of policy (Git or File)"}, "content": {"type": "string", "description": "The policy content."}, "git_content_url": {"type": "string", "description": "Git project URL when the content type is git."}, "git_content_username": {"type": "string", "description": "Username of Git repo if repo is authenticated"}, "git_content_path": {"type": "string", "description": "Root path of the policy in git repo."}, "classification": {"type": "string", "description": "Policies are classified based on the basis of the activity they perform, for example provisioning, Account Management, Utilization, etc. This value is displayed in this field."}, "sub_classification": {"type": "string", "description": "Sub classification of policy"}, "severity": {"type": "string", "description": "Severity of policy", "example": "critical", "enum": ["critical", "high", "info", "low", "medium", "none", "unknown"], "x-cs-enum-type": "PolicySeverityRisk"}, "is_system_policy": {"type": "string", "description": "Flag to identify system policy"}, "uri": {"type": "string", "description": "Unique URI for policy"}}, "type": "object"}, "PostureAccountModel": {"required": ["billable", "cloud_account_name", "count", "non_billable"], "properties": {"cloud_account_name": {"type": "string", "description": "cloud account name"}, "count": {"type": "integer", "description": "total count details"}, "billable": {"type": "integer", "description": "billable count details"}, "non_billable": {"type": "integer", "description": "non_billable count details"}}, "type": "object"}, "PostureCategoryModel": {"required": ["billable", "category", "count", "non_billable"], "properties": {"category": {"type": "string", "description": "category name"}, "count": {"type": "integer", "description": "total count details"}, "billable": {"type": "integer", "description": "billable count details"}, "non_billable": {"type": "integer", "description": "non_billable count details"}}, "type": "object"}, "PostureCloudDataModel": {"required": ["cloud_account_id", "cloud_account_name"], "properties": {"cloud_account_name": {"type": "string", "description": "cloud account name"}, "cloud_account_id": {"type": "string", "description": "cloud account id"}, "tenant_name": {"type": "string", "description": "Name of the tenant"}, "resource_wo_tag": {"type": "integer", "description": "resource without tag count"}, "total_resources": {"type": "integer", "description": "total resources"}, "resource_wo_naming_std": {"type": "string", "description": "resource without naming std"}, "billable_resources": {"type": "integer", "description": "billable resources"}, "new_resources": {"type": "integer", "description": "new resources"}, "increase_percentage": {"type": "number", "description": "increase percentage"}, "resource_wo_lock": {"type": "integer", "description": "resources without lock"}, "cloud": {"type": "string", "description": "cloud name"}, "deleted_resources": {"type": "integer", "description": "deleted resources"}, "last_discovery": {"type": "string", "description": "DateTime when the user was created"}}, "type": "object"}, "PostureCloudModel": {"properties": {"total_resources": {"type": "integer", "description": "total resources"}, "cloud": {"type": "string", "description": "cloud name"}}, "type": "object"}, "PostureRegionModel": {"required": ["billable", "count", "non_billable", "region"], "properties": {"region": {"type": "string", "description": "region name"}, "count": {"type": "integer", "description": "total count details"}, "billable": {"type": "integer", "description": "billable count details"}, "non_billable": {"type": "integer", "description": "non_billable count details"}}, "type": "object"}, "PostureResourceGroupModel": {"required": ["billable", "count", "non_billable", "resource_group"], "properties": {"resource_group": {"type": "string", "description": "resource group name"}, "count": {"type": "integer", "description": "total count details"}, "billable": {"type": "integer", "description": "billable count details"}, "non_billable": {"type": "integer", "description": "non_billable count details"}}, "type": "object"}, "PostureResourceListModel": {"required": ["category", "cloud_account_name", "component", "region_resourceGroup", "resource", "resource_id"], "properties": {"cloud_account_name": {"type": "string", "description": "region name"}, "category": {"type": "string", "description": "category name"}, "component": {"type": "string", "description": "component name"}, "resource": {"type": "string", "description": "resource name"}, "resource_id": {"type": "string", "description": "resource id name"}, "region_resourceGroup": {"type": "string", "description": "region/ resource group name"}}, "type": "object"}, "PostureResourceModel": {"required": ["billable", "count", "non_billable", "resource"], "properties": {"resource": {"type": "string", "description": "resource name"}, "count": {"type": "integer", "description": "total count details"}, "billable": {"type": "integer", "description": "billable count details"}, "non_billable": {"type": "integer", "description": "non_billable count details"}}, "type": "object"}, "PostureTenantModel": {"required": ["tenant_id", "tenant_name"], "properties": {"tenant_name": {"type": "string", "description": "Name of the tenant"}, "tenant_id": {"type": "string", "description": "Name of the tenant"}, "resource_wo_tag": {"type": "integer", "description": "resource without tag count"}, "total_resources": {"type": "integer", "description": "total resources"}, "resource_wo_naming_std": {"type": "string", "description": "resource without naming std"}, "billable_resources": {"type": "integer", "description": "billable resources"}, "new_resources": {"type": "integer", "description": "new resources"}, "increase_percentage": {"type": "number", "description": "increase percentage"}, "resource_wo_lock": {"type": "integer", "description": "resources without lock"}, "deleted_resources": {"type": "integer", "description": "deleted resources"}}, "type": "object"}, "PresignedUrlDetails": {"properties": {"part_number": {"type": "integer", "description": "Part number of the file part"}, "url": {"type": "string", "description": "Presigned URL for uploading the file part"}}, "type": "object"}, "PricingCategoryQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["pricing_categories"], "properties": {"pricing_categories": {"type": "array", "description": "Pricing categories to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "PricingCategoryQueryOperator"}, "PricingPurchaseOptionQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["pricing_purchase_options"], "properties": {"pricing_purchase_options": {"type": "array", "description": "Pricing purchase options to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "PricingPurchaseOptionQueryOperator"}, "PricingRateItem": {"properties": {"pricing_type": {"type": "string", "description": "ON_DEMAND | RESERVED | SAVINGS_PLAN | SPOT"}, "payment_option": {"type": "string", "description": "NO_UPFRONT | PARTIAL_UPFRONT | ALL_UPFRONT \u2014 RESERVED only"}, "commitment_term": {"type": "string", "description": "1yr | 3yr \u2014 RESERVED only"}, "price": {"type": "string", "description": "Hourly rate as a string Decimal (e.g. \"0.1920000000\")"}, "upfront_cost": {"type": "string", "description": "One-time upfront fee for RESERVED pricing"}, "on_demand_rate": {"type": "string", "description": "On-demand baseline rate \u2014 populated on RESERVED docs after backfill"}, "effective_date": {"type": "string", "description": "ISO 8601 date the rate became effective"}, "description": {"type": "string", "description": "Human-readable rate description from AWS"}}, "type": "object"}, "PricingResponse": {"properties": {"sku_id": {"type": "string", "description": "Canonical SKU identifier e.g. AWS#EC2#us-east-1#m5.xlarge"}, "provider": {"type": "string", "description": "aws | azure"}, "servicecode": {"type": "string", "description": "AWS service code e.g. AmazonEC2, AmazonRDS"}, "sku_name": {"type": "string", "description": "Instance / node type e.g. m5.xlarge"}, "region": {"type": "string", "description": "Region code e.g. us-east-1"}, "location": {"type": "string", "description": "Human-readable location e.g. US East (N. Virginia)"}, "currency": {"type": "string", "description": "Always USD"}, "unit": {"type": "string", "description": "hours | gb-mo | requests"}, "data_source": {"type": "string", "description": "mongodb"}, "as_of": {"type": "string", "description": "ISO 8601 timestamp of the cached record"}, "match_confidence": {"type": "string", "description": "\"approximate\" for EC2, \"exact\" for all other services"}, "rates": {"type": "array", "description": "One entry per pricing dimension", "items": {"$ref": "#/definitions/PricingRateItem"}}, "attributes": {"type": "object", "description": "Service-specific attributes: vcpu, memory_gib, database_engine, etc."}}, "type": "object"}, "ProActiveGovernanceScannerMasterDetail": {"allOf": [{"$ref": "#/definitions/ScannerRuleBase"}, {"properties": {"classification": {"type": "string", "description": "Classification of the policy", "example": "Access", "enum": ["Access", "Cost", "Data", "Network", "Operation", "Performance", "Resource", "Security"], "x-cs-enum-type": "PolicyClassification"}, "reference_id": {"type": "string", "description": "reference id for the rule which will be used in engine"}, "source": {"type": "string", "description": "Source for the scanner.", "example": "custom_checkov", "enum": ["custom_checkov", "native_checkov", "cs_dsl_parser", "cs_cost_predictor"], "x-cs-enum-type": "GovernanceScannerSource"}, "is_global": {"type": "boolean", "description": "A Boolean Field which represents whether the rule is being scanned is global or not.", "default": false}, "output_attribute": {"type": "string", "description": "The Attribute which will be used while posting the comment for a finding."}, "default_output_message": {"type": "string", "description": "The default output message which will append with the finding for each configuration."}, "scanner_resource_type": {"type": "string", "description": "Name of the resource type which will be used in checkov"}}, "type": "object"}]}, "ProActiveScannerRule": {"properties": {"rule_id": {"type": "string", "description": "master rule sys id"}, "is_active": {"type": "boolean", "description": "Specifies if the rule is active"}, "default_inputs": {"type": "array", "description": "input parameters the user wants to override", "items": {"type": "string"}}}, "type": "object"}, "ProductBundleDetails": {"properties": {"name": {"type": "string", "description": "Name of the product bundle"}, "description": {"type": "string", "description": "Description of the product bundle"}, "products": {"type": "array", "description": "Products included in the bundle", "items": {"type": "string"}}}, "type": "object"}, "ProductCategoryQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["product_categories"], "properties": {"product_categories": {"type": "array", "description": "Product categories to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ProductCategoryQueryOperator"}, "ProductCategoryRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["product_category"], "properties": {"product_category": {"description": "Include response that has the given product_category filter that has the given value", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ProductCategoryRegexQueryOperator"}, "ProductCategoryWiseUsage": {"properties": {"name": {"type": "string", "description": "Product category of the usage"}, "cost": {"type": "number", "description": "Cost of the resource in the usage"}}, "type": "object"}, "ProductDetails": {"required": ["name"], "properties": {"name": {"type": "string", "description": "Name of the product", "example": "AppSecOps", "enum": ["AppSecOps", "Assessments", "CloudOps", "FinOps", "Product_Admin", "SecOps", "Self Service", "StackOps"], "x-cs-enum-type": "ProductEnum"}, "description": {"type": "string", "description": "Description of the product"}, "features": {"type": "array", "items": {"type": "string", "description": "Feature for the account", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}}, "role_templates": {"type": "array", "description": "Role templates mapped for the product", "items": {"type": "string"}}}, "type": "object"}, "ProductFamilyQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["product_families"], "properties": {"product_families": {"type": "array", "description": "Product families to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ProductFamilyQueryOperator"}, "ProductServiceCodeQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["product_service_codes"], "properties": {"product_service_codes": {"type": "array", "description": "Product service codes to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ProductServiceCodeQueryOperator"}, "ProductSkuQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["product_skus"], "properties": {"product_skus": {"type": "array", "description": "Product SKUs to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ProductSkuQueryOperator"}, "ProfileResponse": {"properties": {"user_id": {"type": "string", "description": "user id"}, "source_user_id": {"type": "string", "description": "source user id"}, "username": {"type": "string", "description": "username"}, "status": {"type": "string", "description": "status"}, "email": {"type": "string", "description": "email"}, "first_name": {"type": "string", "description": "first name"}, "last_name": {"type": "string", "description": "last name"}, "timezone": {"type": "string", "description": "timezone"}, "mobile": {"type": "string", "description": "mobile number"}, "sso_userid": {"type": "string", "description": "sso user id"}, "access_key": {"type": "string", "description": "access_key"}, "valid_till": {"type": "string", "description": "valid date"}, "last_login_time": {"type": "string", "description": "last login time"}, "preferred_language": {"type": "string", "description": "Preferred language of the user.", "example": "en", "enum": ["en", "ja"], "x-cs-enum-type": "PreferredLanguage"}}, "type": "object"}, "ProgressDetails": {"properties": {"status": {"type": "string", "description": "Sync status. This is a required field.", "example": "completed", "enum": ["completed", "failed", "in_progress"], "x-cs-enum-type": "AccountSyncProgressStatus"}, "initiated_at": {"type": "string", "format": "date-time", "description": "Sync initiated time."}, "completed_at": {"type": "string", "format": "date-time", "description": "Sync completion time."}, "message": {"type": "string", "description": "Sync information."}, "background_job_id": {"description": "Background Job Id of the run", "$ref": "#/definitions/RecordIdentity"}}, "type": "object"}, "ProgressDetailsForAccessValidation": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"by_context": {"type": "array", "description": "Validation results by context", "items": {"$ref": "#/definitions/AccessValidationByContext"}}}, "type": "object"}]}, "ProgressDetailsForBackupData": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"pre_fill": {"type": "boolean", "description": "Prefill Flag"}}, "type": "object"}]}, "ProgressDetailsForCostProcessing": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"processing_memory": {"description": "Processing history", "$ref": "#/definitions/BaseCostProcessingMemory"}}, "type": "object"}]}, "ProgressDetailsForCredentialsValidation": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"key_id": {"type": "string", "description": "Key Id"}, "displayName": {"type": "string", "description": "Display Name"}, "start_time": {"type": "string", "format": "date-time", "description": "Start Time"}, "expire_time": {"type": "string", "format": "date-time", "description": "Expire Time"}}, "type": "object"}]}, "ProgressDetailsForDimensionPrecompute": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"by_dimension": {"type": "array", "description": "Per-dimension precompute status", "items": {"$ref": "#/definitions/DimensionPrecomputeStatusEntry"}}}, "type": "object"}]}, "ProgressDetailsForEaUnitRate": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"records_processed": {"type": "integer", "description": "Number of records processed in the run"}, "has_price_sheet_access": {"type": "boolean", "description": "is the having price sheet access"}, "is_unit_rate_required": {"type": "boolean", "description": "is unit rate required to be pulled"}}, "type": "object"}]}, "ProgressDetailsForGovernanceConfiguration": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"settings": {"type": "array", "description": "Governance Configuration settings", "items": {"$ref": "#/definitions/GovernanceConfigurationApplicationByContext"}}}, "type": "object"}]}, "ProgressDetailsForKubernetesAgentSyncStatus": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"run_id": {"type": "string", "description": "run id from the agent about the sync"}, "log_trace": {"type": "array", "description": "log trace from the agent about the sync", "items": {"type": "string"}}, "data_collection_start": {"type": "string", "format": "date-time", "description": "Data Collection Start Datetime"}, "data_collection_end": {"type": "string", "format": "date-time", "description": "Data Collection end Datetime"}}, "type": "object"}]}, "ProgressDetailsForMetricData": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"run_id": {"type": "string", "description": "Run Id"}}, "type": "object"}]}, "ProgressDetailsForReservedInstances": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"back_filled": {"type": "boolean", "description": "If set, back fill was completed"}}, "type": "object"}]}, "ProgressDetailsForSavingsPlans": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"total_purchased_plans_retrieved": {"type": "integer", "description": "Total number of plans retrieved in the run."}, "total_recommendations_retrieved": {"type": "integer", "description": "Total number of recommendations retrieved in the run."}}, "type": "object"}]}, "ProgressDetailsForSecureScore": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"secure_score": {"type": "string", "description": "Secure Score"}}, "type": "object"}]}, "ProgressDetailsForSecurityHub": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"by_location": {"type": "array", "items": {"$ref": "#/definitions/ProgressDetailsMessagePerLocation"}}}, "type": "object"}]}, "ProgressDetailsForServiceNowCmdbSync": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"progress": {"description": "Progress of the ServiceNow Cmdb sync", "$ref": "#/definitions/ServiceNowCmdbSyncProgress"}}, "type": "object"}]}, "ProgressDetailsForSsmData": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"sync_type": {"type": "string", "description": "Manual or Automation sync"}}, "type": "object"}]}, "ProgressDetailsForThreat": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"by_location": {"type": "array", "items": {"$ref": "#/definitions/ProgressDetailsMessagePerLocation"}}}, "type": "object"}]}, "ProgressDetailsForVulnerability": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"by_location": {"type": "array", "items": {"$ref": "#/definitions/ProgressDetailsMessagePerLocation"}}}, "type": "object"}]}, "ProgressDetailsForWellArchitectedAutoAssessment": {"allOf": [{"$ref": "#/definitions/ProgressDetails"}, {"properties": {"default_workload_created": {"type": "boolean", "description": "If set, default workload is created"}, "default_assessment_created": {"type": "boolean", "description": "If set, default assessment is created"}, "report_generated": {"type": "boolean", "description": "If set, assessment run report is generated"}, "notification_triggered": {"type": "boolean", "description": "If set, auto assessment notification is triggered"}}, "type": "object"}]}, "ProgressDetailsMessagePerLocation": {"properties": {"location": {"description": "Optional region details", "$ref": "#/definitions/LocationDetailsBase"}, "message": {"type": "string", "description": "status message on the sync"}}, "type": "object"}, "ProjectsModel": {"required": ["tenant_id", "tenant_name"], "properties": {"tenant_name": {"type": "string", "description": "Name of the tenant"}, "tenant_id": {"type": "string", "description": "ID of the tenant"}}, "type": "object"}, "Prompt": {"allOf": [{"$ref": "#/definitions/AgentFieldsBase"}, {"properties": {"prompt": {"type": "string", "description": "Input given to the agent"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "agent_id": {"type": "string", "description": "ID of the agent", "x-cs-type": "ObjectId"}, "created_by": {"type": "string", "description": "Name of the user who created the prompt."}, "prompt_type": {"type": "string", "description": "Type of the prompt", "example": "default", "enum": ["default", "custom"], "x-cs-enum-type": "AgentPromptTypes"}}, "type": "object"}]}, "PromptBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/Prompt"}}}, "type": "object"}, "PromptFilters": {"allOf": [{"$ref": "#/definitions/PromptFiltersRequest"}, {"properties": {"prompt": {"type": "string", "description": "Name of the prompt"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}]}, "PromptFiltersRequest": {"required": ["agent_ids", "prompt_type"], "properties": {"agent_ids": {"type": "array", "description": "IDs of the agent", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "prompt_type": {"type": "string", "description": "Type of the prompt", "example": "default", "enum": ["default", "custom"], "x-cs-enum-type": "AgentPromptTypes"}}, "type": "object"}, "PromptFiltersResponse": {"properties": {"tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "PromptListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/PromptSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/PromptFilters"}}, "type": "object"}, "PromptListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "PromptSaveRequest": {"required": ["prompt"], "properties": {"prompt": {"type": "string", "description": "Input given to the agent"}, "agent_id": {"type": "string", "description": "ID of the agent", "x-cs-type": "ObjectId"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "PromptSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CreatedAt", "enum": ["CreatedAt"], "x-cs-enum-type": "PromptSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ProtectionStatus": {"properties": {"enabled": {"type": "boolean", "description": "Indicates if protection status is supported"}, "status": {"type": "boolean", "description": "Indicates if the resource is protected"}}, "type": "object"}, "PublisherQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["publishers"], "properties": {"publishers": {"type": "array", "description": "Publishers to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "PublisherQueryOperator"}, "PullRequestCollectionBase": {"properties": {"pull_request_number": {"type": "string", "description": "Unique Number which represents the pull request resides with in a repository."}, "pull_request_id": {"type": "string", "description": "A long id which describes the pull request resides with in a repository."}, "service_account_id": {"type": "string", "description": "Service account which has been onboarded for the organization in github.", "x-cs-type": "ObjectId"}, "sys_id": {"type": "string", "description": "Unique Identifier for the pull request which is auto generated", "x-cs-type": "ObjectId"}, "auto_provisioning_status": {"type": "string", "description": "Status of the auto provisioning job applied for the pull request..", "example": "completed", "enum": ["completed", "failed", "skipped"], "x-cs-enum-type": "AutoProvisioningStatus"}, "status": {"type": "string", "description": "Status of the pull request.", "example": "open", "enum": ["open", "closed"], "x-cs-enum-type": "GithubPullRequestStatus"}, "is_locked": {"type": "boolean", "description": "A Boolean Field which represents the pull request has been locked for merging or not."}, "created_at": {"type": "string", "format": "date-time", "description": "The time when the pull request was created."}, "updated_at": {"type": "string", "format": "date-time", "description": "The time when the pull request was lastly updated."}, "merged_at": {"type": "string", "format": "date-time", "description": "The time when the pull request was merged in to the target branch."}, "touched_at": {"type": "string", "format": "date-time", "description": "Recently updated datetime of the document."}, "title": {"type": "string", "description": "The title for the pull request."}, "labels": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "repo_id": {"type": "string", "description": "A long id which is an unique number for an each repository with in the organization."}, "repo_name": {"type": "string", "description": "A display Name for the repository."}, "target_branch": {"type": "string", "description": "Name of the branch against which the pull request has been raised."}, "owner": {"type": "string", "description": "Owner of the pull request."}, "repo_visibility": {"type": "string", "description": "status for the repository.", "example": "internal", "enum": ["internal", "private", "public"], "x-cs-enum-type": "GithubRepositoryVisibility"}, "overall_comments": {"type": "array", "description": "String which contains all the comments available for a pull request including both scanner and other sources.", "items": {"type": "string"}}, "commit_details": {"type": "array", "items": {"$ref": "#/definitions/CommitDetails"}}}, "type": "object"}, "QueryOperator": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "QueryOperatorTrue", "subtype_name": "QueryOperatorTrue"}, {"subtype_model": "QueryOperatorFalse", "subtype_name": "QueryOperatorFalse"}, {"subtype_model": "QueryOperatorBinary", "subtype_name": "QueryOperatorBinary"}, {"subtype_model": "QueryOperatorBinaryLogic", "subtype_name": "QueryOperatorBinaryLogic"}, {"subtype_model": "QueryOperatorNary", "subtype_name": "QueryOperatorNary"}, {"subtype_model": "QueryOperatorNaryLogic", "subtype_name": "QueryOperatorNaryLogic"}, {"subtype_model": "QueryOperatorComparator", "subtype_name": "QueryOperatorComparator"}, {"subtype_model": "QueryOperatorComparatorLogic", "subtype_name": "QueryOperatorComparatorLogic"}, {"subtype_model": "QueryOperatorUnary", "subtype_name": "QueryOperatorUnary"}, {"subtype_model": "QueryOperatorUnaryNot", "subtype_name": "QueryOperatorUnaryNot"}, {"subtype_model": "QueryOperatorBinaryForGraph", "subtype_name": "QueryOperatorBinaryForGraph"}, {"subtype_model": "QueryOperatorBinaryLogicForGraph", "subtype_name": "QueryOperatorBinaryLogicForGraph"}, {"subtype_model": "QueryOperatorNaryForGraph", "subtype_name": "QueryOperatorNaryForGraph"}, {"subtype_model": "QueryOperatorNaryLogicForGraph", "subtype_name": "QueryOperatorNaryLogicForGraph"}, {"subtype_model": "QueryOperatorUnaryForGraph", "subtype_name": "QueryOperatorUnaryForGraph"}, {"subtype_model": "QueryOperatorUnaryNotForGraph", "subtype_name": "QueryOperatorUnaryNotForGraph"}, {"subtype_model": "ServiceAccountQueryOperator", "subtype_name": "ServiceAccountQueryOperator"}, {"subtype_model": "TenantQueryOperator", "subtype_name": "TenantQueryOperator"}, {"subtype_model": "DescendantServiceAccountQueryOperator", "subtype_name": "DescendantServiceAccountQueryOperator"}, {"subtype_model": "DescendantServiceAccountInTenantQueryOperator", "subtype_name": "DescendantServiceAccountInTenantQueryOperator"}, {"subtype_model": "TenantTagKeyQueryOperator", "subtype_name": "TenantTagKeyQueryOperator"}, {"subtype_model": "TenantTagKeyValueQueryOperator", "subtype_name": "TenantTagKeyValueQueryOperator"}, {"subtype_model": "LocationQueryOperator", "subtype_name": "LocationQueryOperator"}, {"subtype_model": "AvailabilityZoneQueryOperator", "subtype_name": "AvailabilityZoneQueryOperator"}, {"subtype_model": "BillingSourceQueryOperator", "subtype_name": "BillingSourceQueryOperator"}, {"subtype_model": "CurrencyQueryOperator", "subtype_name": "CurrencyQueryOperator"}, {"subtype_model": "ProductCategoryQueryOperator", "subtype_name": "ProductCategoryQueryOperator"}, {"subtype_model": "ProductFamilyQueryOperator", "subtype_name": "ProductFamilyQueryOperator"}, {"subtype_model": "ProductServiceCodeQueryOperator", "subtype_name": "ProductServiceCodeQueryOperator"}, {"subtype_model": "ProductSkuQueryOperator", "subtype_name": "ProductSkuQueryOperator"}, {"subtype_model": "PublisherQueryOperator", "subtype_name": "PublisherQueryOperator"}, {"subtype_model": "ResourceCategoryQueryOperator", "subtype_name": "ResourceCategoryQueryOperator"}, {"subtype_model": "ResourceIdQueryOperator", "subtype_name": "ResourceIdQueryOperator"}, {"subtype_model": "ResourceGroupQueryOperator", "subtype_name": "ResourceGroupQueryOperator"}, {"subtype_model": "ResourceNameQueryOperator", "subtype_name": "ResourceNameQueryOperator"}, {"subtype_model": "ResourceOperationQueryOperator", "subtype_name": "ResourceOperationQueryOperator"}, {"subtype_model": "ResourceQueryExtraPresence", "subtype_name": "ResourceQueryExtraPresence"}, {"subtype_model": "ResourceQueryExtraKey", "subtype_name": "ResourceQueryExtraKey"}, {"subtype_model": "ScopeContainsTenantQueryOperator", "subtype_name": "ScopeContainsTenantQueryOperator"}, {"subtype_model": "ScopeContainsServiceAccountQueryOperator", "subtype_name": "ScopeContainsServiceAccountQueryOperator"}, {"subtype_model": "ScopeIsQueryOperator", "subtype_name": "ScopeIsQueryOperator"}, {"subtype_model": "ServiceCategoryQueryOperator", "subtype_name": "ServiceCategoryQueryOperator"}, {"subtype_model": "ServiceTypeQueryOperator", "subtype_name": "ServiceTypeQueryOperator"}, {"subtype_model": "CompartmentNameQueryOperator", "subtype_name": "CompartmentNameQueryOperator"}, {"subtype_model": "ResourceQueryExtraKeyValue", "subtype_name": "ResourceQueryExtraKeyValue"}, {"subtype_model": "WorkFlowIdQueryOperator", "subtype_name": "WorkFlowIdQueryOperator"}, {"subtype_model": "RecommendationSubClassificationQueryOperator", "subtype_name": "RecommendationSubClassificationQueryOperator"}, {"subtype_model": "ServiceNowCmdbQuerySyncLogResourceId", "subtype_name": "ServiceNowCmdbQuerySyncLogResourceId"}, {"subtype_model": "ServiceNowCmdbQuerySyncLogResourceType", "subtype_name": "ServiceNowCmdbQuerySyncLogResourceType"}, {"subtype_model": "ServiceNowCmdbQuerySyncLogAction", "subtype_name": "ServiceNowCmdbQuerySyncLogAction"}, {"subtype_model": "ServiceNowCmdbQuerySyncLogStatus", "subtype_name": "ServiceNowCmdbQuerySyncLogStatus"}, {"subtype_model": "ServiceNowCmdbQuerySyncLogService", "subtype_name": "ServiceNowCmdbQuerySyncLogService"}, {"subtype_model": "ServiceAccountNativeDetailsQueryOperator", "subtype_name": "ServiceAccountNativeDetailsQueryOperator"}, {"subtype_model": "ServiceAccountStatusQueryOperator", "subtype_name": "ServiceAccountStatusQueryOperator"}, {"subtype_model": "ServiceAccountTagKeyQueryOperator", "subtype_name": "ServiceAccountTagKeyQueryOperator"}, {"subtype_model": "ServiceAccountTagKeyRegexQueryOperator", "subtype_name": "ServiceAccountTagKeyRegexQueryOperator"}, {"subtype_model": "ServiceAccountTagKeyValueQueryOperator", "subtype_name": "ServiceAccountTagKeyValueQueryOperator"}, {"subtype_model": "ApplicableHealthMetricsQueryOperator", "subtype_name": "ApplicableHealthMetricsQueryOperator"}, {"subtype_model": "EpssScoreRangeQueryOperator", "subtype_name": "EpssScoreRangeQueryOperator"}, {"subtype_model": "CvssMetricScoreRangeQueryOperator", "subtype_name": "CvssMetricScoreRangeQueryOperator"}, {"subtype_model": "GraphionScoreRangeQueryOperator", "subtype_name": "GraphionScoreRangeQueryOperator"}, {"subtype_model": "AppSecopsApplicationIdQueryOperator", "subtype_name": "AppSecopsApplicationIdQueryOperator"}, {"subtype_model": "AppSecopsPortfolioIdQueryOperator", "subtype_name": "AppSecopsPortfolioIdQueryOperator"}, {"subtype_model": "AppSecopsProjectIdQueryOperator", "subtype_name": "AppSecopsProjectIdQueryOperator"}, {"subtype_model": "AppSecopsSbomComponentIdQueryOperator", "subtype_name": "AppSecopsSbomComponentIdQueryOperator"}, {"subtype_model": "AppSecopsSbomVersionIdQueryOperator", "subtype_name": "AppSecopsSbomVersionIdQueryOperator"}, {"subtype_model": "AppSecopsComponentProductQueryOperator", "subtype_name": "AppSecopsComponentProductQueryOperator"}, {"subtype_model": "AppSecopsSbomComponentTypeQueryOperator", "subtype_name": "AppSecopsSbomComponentTypeQueryOperator"}, {"subtype_model": "AppSecopsSbomVersionSubmittedByQueryOperator", "subtype_name": "AppSecopsSbomVersionSubmittedByQueryOperator"}, {"subtype_model": "AppSecopsSbomVersionSubmittedDateQueryOperator", "subtype_name": "AppSecopsSbomVersionSubmittedDateQueryOperator"}, {"subtype_model": "AppSecopsSbomVersionBuildIdQueryOperator", "subtype_name": "AppSecopsSbomVersionBuildIdQueryOperator"}, {"subtype_model": "AppSecopsSbomNameQueryOperator", "subtype_name": "AppSecopsSbomNameQueryOperator"}, {"subtype_model": "AppSecopsCveIdQueryOperator", "subtype_name": "AppSecopsCveIdQueryOperator"}, {"subtype_model": "AppSecopsEpssScoreQueryOperator", "subtype_name": "AppSecopsEpssScoreQueryOperator"}, {"subtype_model": "AppSecopsCvssScoreQueryOperator", "subtype_name": "AppSecopsCvssScoreQueryOperator"}, {"subtype_model": "AppSecopsGraphionScoreQueryOperator", "subtype_name": "AppSecopsGraphionScoreQueryOperator"}, {"subtype_model": "SecopsVulnerabilitySeverityQueryOperator", "subtype_name": "SecopsVulnerabilitySeverityQueryOperator"}, {"subtype_model": "AppSecopsIsKnownExploitedVulnerabilityQueryOperator", "subtype_name": "AppSecopsIsKnownExploitedVulnerabilityQueryOperator"}, {"subtype_model": "AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator", "subtype_name": "AppSecopsVulnerabilityExploitabilityMetricAttackVectorV31QueryOperator"}, {"subtype_model": "AppSecopsFixAvailableQueryOperator", "subtype_name": "AppSecopsFixAvailableQueryOperator"}, {"subtype_model": "AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator", "subtype_name": "AppSecopsVulnerabilityExploitabilityMetricAttackComplexityV31QueryOperator"}, {"subtype_model": "AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator", "subtype_name": "AppSecopsVulnerabilityExploitabilityMetricPrivilegesRequiredV31QueryOperator"}, {"subtype_model": "AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator", "subtype_name": "AppSecopsVulnerabilityExploitabilityMetricScopeV31QueryOperator"}, {"subtype_model": "AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator", "subtype_name": "AppSecopsVulnerabilityExploitabilityUserInteractionV31QueryOperator"}, {"subtype_model": "AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator", "subtype_name": "AppSecopsVulnerabilityImpactMetricConfidentialityImpactV31QueryOperator"}, {"subtype_model": "AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator", "subtype_name": "AppSecopsVulnerabilityImpactMetricIntegrityImpactV31QueryOperator"}, {"subtype_model": "AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator", "subtype_name": "AppSecopsVulnerabilityImpactMetricAvailabilityImpactV31QueryOperator"}, {"subtype_model": "AppSecopsContainerFindingsSBOMVersionIdsQueryOperator", "subtype_name": "AppSecopsContainerFindingsSBOMVersionIdsQueryOperator"}, {"subtype_model": "AppSecopsContainerFindingsCategoryQueryOperator", "subtype_name": "AppSecopsContainerFindingsCategoryQueryOperator"}, {"subtype_model": "AppSecopsContainerFindingsExecutionPhaseQueryOperator", "subtype_name": "AppSecopsContainerFindingsExecutionPhaseQueryOperator"}, {"subtype_model": "AppSecopsContainerFindingsSeverityQueryOperator", "subtype_name": "AppSecopsContainerFindingsSeverityQueryOperator"}, {"subtype_model": "AppSecopsContainerFindingsStatusQueryOperator", "subtype_name": "AppSecopsContainerFindingsStatusQueryOperator"}, {"subtype_model": "DimensionSourceQueryOperator", "subtype_name": "DimensionSourceQueryOperator"}, {"subtype_model": "DimensionQueryOperator", "subtype_name": "DimensionQueryOperator"}, {"subtype_model": "ResourceTypeQueryOperator", "subtype_name": "ResourceTypeQueryOperator"}, {"subtype_model": "PodIdRegexQueryOperator", "subtype_name": "PodIdRegexQueryOperator"}, {"subtype_model": "PodNameRegexQueryOperator", "subtype_name": "PodNameRegexQueryOperator"}, {"subtype_model": "ContainerIdRegexQueryOperator", "subtype_name": "ContainerIdRegexQueryOperator"}, {"subtype_model": "PodNamesQueryOperator", "subtype_name": "PodNamesQueryOperator"}, {"subtype_model": "PodIdsQueryOperator", "subtype_name": "PodIdsQueryOperator"}, {"subtype_model": "UtilizationTypeQueryOperator", "subtype_name": "UtilizationTypeQueryOperator"}, {"subtype_model": "ResourceIdRegexQueryOperator", "subtype_name": "ResourceIdRegexQueryOperator"}, {"subtype_model": "ResourceNameRegexQueryOperator", "subtype_name": "ResourceNameRegexQueryOperator"}, {"subtype_model": "ExtrasValueRegexQueryOperator", "subtype_name": "ExtrasValueRegexQueryOperator"}, {"subtype_model": "TagKeyValueRegexQueryOperator", "subtype_name": "TagKeyValueRegexQueryOperator"}, {"subtype_model": "ResourceQueryTagKeyKind", "subtype_name": "ResourceQueryTagKeyKind"}, {"subtype_model": "ResourceQueryTagKeyValuesKind", "subtype_name": "ResourceQueryTagKeyValuesKind"}, {"subtype_model": "TagKeyStringValueRegexQueryOperator", "subtype_name": "TagKeyStringValueRegexQueryOperator"}, {"subtype_model": "TagKindStringKeyRegexQueryOperator", "subtype_name": "TagKindStringKeyRegexQueryOperator"}, {"subtype_model": "ServiceAccountNameRegexQueryOperator", "subtype_name": "ServiceAccountNameRegexQueryOperator"}, {"subtype_model": "TenantNameRegexQueryOperator", "subtype_name": "TenantNameRegexQueryOperator"}, {"subtype_model": "PlatFormAccountQueryOperator", "subtype_name": "PlatFormAccountQueryOperator"}, {"subtype_model": "BillingLineItemTypeQueryOperator", "subtype_name": "BillingLineItemTypeQueryOperator"}, {"subtype_model": "BillingEntityQueryOperator", "subtype_name": "BillingEntityQueryOperator"}, {"subtype_model": "LineItemDescriptionQueryOperator", "subtype_name": "LineItemDescriptionQueryOperator"}, {"subtype_model": "LineItemDescriptionRegexQueryOperator", "subtype_name": "LineItemDescriptionRegexQueryOperator"}, {"subtype_model": "MeterSubCategoryQueryOperator", "subtype_name": "MeterSubCategoryQueryOperator"}, {"subtype_model": "PricingCategoryQueryOperator", "subtype_name": "PricingCategoryQueryOperator"}, {"subtype_model": "PricingPurchaseOptionQueryOperator", "subtype_name": "PricingPurchaseOptionQueryOperator"}, {"subtype_model": "TagKeyRegexQueryOperator", "subtype_name": "TagKeyRegexQueryOperator"}, {"subtype_model": "BillingLineItemTypeRegexQueryOperator", "subtype_name": "BillingLineItemTypeRegexQueryOperator"}, {"subtype_model": "ResourceGroupRegexQueryOperator", "subtype_name": "ResourceGroupRegexQueryOperator"}, {"subtype_model": "ResourceCategoryRegexQueryOperator", "subtype_name": "ResourceCategoryRegexQueryOperator"}, {"subtype_model": "ProductCategoryRegexQueryOperator", "subtype_name": "ProductCategoryRegexQueryOperator"}, {"subtype_model": "BillingEntityRegexQueryOperator", "subtype_name": "BillingEntityRegexQueryOperator"}, {"subtype_model": "ResourceOperationRegexQueryOperator", "subtype_name": "ResourceOperationRegexQueryOperator"}, {"subtype_model": "ResourceQueryFieldPresence", "subtype_name": "ResourceQueryFieldPresence"}, {"subtype_model": "AssessmentRunReportDetailQuerySection", "subtype_name": "AssessmentRunReportDetailQuerySection"}, {"subtype_model": "AssessmentRunReportSummaryQuerySection", "subtype_name": "AssessmentRunReportSummaryQuerySection"}, {"subtype_model": "AssessmentQueryAssessmentName", "subtype_name": "AssessmentQueryAssessmentName"}, {"subtype_model": "AssessmentQueryAssessmentOwner", "subtype_name": "AssessmentQueryAssessmentOwner"}, {"subtype_model": "AssessmentQueryAssessmentApprover", "subtype_name": "AssessmentQueryAssessmentApprover"}, {"subtype_model": "AssessmentQueryWorkload", "subtype_name": "AssessmentQueryWorkload"}, {"subtype_model": "AssessmentQueryFramework", "subtype_name": "AssessmentQueryFramework"}, {"subtype_model": "AssessmentQueryPillar", "subtype_name": "AssessmentQueryPillar"}, {"subtype_model": "AssessmentViewQueryNature", "subtype_name": "AssessmentViewQueryNature"}, {"subtype_model": "AssessmentViewQueryQuestionRisk", "subtype_name": "AssessmentViewQueryQuestionRisk"}, {"subtype_model": "AssessmentViewQueryBestPracticeRisk", "subtype_name": "AssessmentViewQueryBestPracticeRisk"}, {"subtype_model": "AssessmentViewQueryQuestionStatus", "subtype_name": "AssessmentViewQueryQuestionStatus"}, {"subtype_model": "AssessmentViewQueryBestPracticeStatus", "subtype_name": "AssessmentViewQueryBestPracticeStatus"}, {"subtype_model": "AssessmentViewQueryOwner", "subtype_name": "AssessmentViewQueryOwner"}, {"subtype_model": "AssessmentViewQueryAssignedTo", "subtype_name": "AssessmentViewQueryAssignedTo"}, {"subtype_model": "AssessmentViewQueryComment", "subtype_name": "AssessmentViewQueryComment"}, {"subtype_model": "AssessmentReportQueryAssessmentName", "subtype_name": "AssessmentReportQueryAssessmentName"}, {"subtype_model": "AssessmentReportQueryFramework", "subtype_name": "AssessmentReportQueryFramework"}, {"subtype_model": "AssessmentReportQueryReportType", "subtype_name": "AssessmentReportQueryReportType"}, {"subtype_model": "AssessmentReportQueryWorkloadId", "subtype_name": "AssessmentReportQueryWorkloadId"}, {"subtype_model": "ScheduleQueryName", "subtype_name": "ScheduleQueryName"}, {"subtype_model": "ScheduleQueryCreatedBy", "subtype_name": "ScheduleQueryCreatedBy"}, {"subtype_model": "ScheduleQueryEmailRecipients", "subtype_name": "ScheduleQueryEmailRecipients"}, {"subtype_model": "ScheduleQueryRecurrence", "subtype_name": "ScheduleQueryRecurrence"}, {"subtype_model": "ScheduleQueryReportType", "subtype_name": "ScheduleQueryReportType"}, {"subtype_model": "ScheduleQueryNextGenReportType", "subtype_name": "ScheduleQueryNextGenReportType"}, {"subtype_model": "ScheduleQueryAssessmentAgentReportType", "subtype_name": "ScheduleQueryAssessmentAgentReportType"}, {"subtype_model": "AutomationTemplateQueryEngineType", "subtype_name": "AutomationTemplateQueryEngineType"}, {"subtype_model": "AutomationTemplateQueryRepoType", "subtype_name": "AutomationTemplateQueryRepoType"}, {"subtype_model": "AutomationTemplateQueryService", "subtype_name": "AutomationTemplateQueryService"}, {"subtype_model": "AutomationTemplateQueryTenant", "subtype_name": "AutomationTemplateQueryTenant"}, {"subtype_model": "AwsSecurityHubFindingQueryLocation", "subtype_name": "AwsSecurityHubFindingQueryLocation"}, {"subtype_model": "AwsSecurityHubFindingQuerySeverity", "subtype_name": "AwsSecurityHubFindingQuerySeverity"}, {"subtype_model": "AwsSecurityHubFindingQueryProductName", "subtype_name": "AwsSecurityHubFindingQueryProductName"}, {"subtype_model": "AwsSecurityHubFindingQueryResource", "subtype_name": "AwsSecurityHubFindingQueryResource"}, {"subtype_model": "AwsSecurityHubFindingQueryCloudAccount", "subtype_name": "AwsSecurityHubFindingQueryCloudAccount"}, {"subtype_model": "AwsSecurityHubFindingQueryRecordState", "subtype_name": "AwsSecurityHubFindingQueryRecordState"}, {"subtype_model": "AwsSsmDocumentQueryCloudAccount", "subtype_name": "AwsSsmDocumentQueryCloudAccount"}, {"subtype_model": "AwsSsmDocumentQueryRegion", "subtype_name": "AwsSsmDocumentQueryRegion"}, {"subtype_model": "AwsSsmDocumentQueryOwner", "subtype_name": "AwsSsmDocumentQueryOwner"}, {"subtype_model": "AwsSsmDocumentQueryCategory", "subtype_name": "AwsSsmDocumentQueryCategory"}, {"subtype_model": "AwsSsmDocumentQueryStatus", "subtype_name": "AwsSsmDocumentQueryStatus"}, {"subtype_model": "AwsSsmDocumentQueryName", "subtype_name": "AwsSsmDocumentQueryName"}, {"subtype_model": "AwsSsmDocumentQueryExecutedBy", "subtype_name": "AwsSsmDocumentQueryExecutedBy"}, {"subtype_model": "ComplianceURIQueryOperator", "subtype_name": "ComplianceURIQueryOperator"}, {"subtype_model": "DurationInMonthsQueryOperator", "subtype_name": "DurationInMonthsQueryOperator"}, {"subtype_model": "UniqueIdQueryOperator", "subtype_name": "UniqueIdQueryOperator"}, {"subtype_model": "ThreatVulnerabilityStatusQueryOperator", "subtype_name": "ThreatVulnerabilityStatusQueryOperator"}, {"subtype_model": "ThreatVulnerabilitySeverityQueryOperator", "subtype_name": "ThreatVulnerabilitySeverityQueryOperator"}, {"subtype_model": "ThreatVulnerabilityIssueTypeQueryOperator", "subtype_name": "ThreatVulnerabilityIssueTypeQueryOperator"}, {"subtype_model": "ThreatIntentQueryOperator", "subtype_name": "ThreatIntentQueryOperator"}, {"subtype_model": "VulnerabilityReferenceIdQueryOperator", "subtype_name": "VulnerabilityReferenceIdQueryOperator"}, {"subtype_model": "CostAnomalyStatusQueryOperator", "subtype_name": "CostAnomalyStatusQueryOperator"}, {"subtype_model": "CurrencyExchangeConfigurationQuerySourceCurrency", "subtype_name": "CurrencyExchangeConfigurationQuerySourceCurrency"}, {"subtype_model": "CurrencyExchangeConfigurationQueryTargetCurrency", "subtype_name": "CurrencyExchangeConfigurationQueryTargetCurrency"}, {"subtype_model": "CurrencyExchangeConfigurationQueryScope", "subtype_name": "CurrencyExchangeConfigurationQueryScope"}, {"subtype_model": "MetricValuesOperator", "subtype_name": "MetricValuesOperator"}, {"subtype_model": "PatchReadinessStatusQueryOperator", "subtype_name": "PatchReadinessStatusQueryOperator"}, {"subtype_model": "MasterAccountBillingQueryMasterAccounts", "subtype_name": "MasterAccountBillingQueryMasterAccounts"}, {"subtype_model": "MasterAccountBillingQueryTenants", "subtype_name": "MasterAccountBillingQueryTenants"}, {"subtype_model": "MasterAccountBillingQueryUsers", "subtype_name": "MasterAccountBillingQueryUsers"}, {"subtype_model": "MasterAccountBillingQueryConversations", "subtype_name": "MasterAccountBillingQueryConversations"}, {"subtype_model": "MasterAccountBillingQueryTransactionType", "subtype_name": "MasterAccountBillingQueryTransactionType"}, {"subtype_model": "PolicyResourceRecommendationStatusQueryOperator", "subtype_name": "PolicyResourceRecommendationStatusQueryOperator"}, {"subtype_model": "PolicyResourceRecommendationPolicyIdsQueryOperator", "subtype_name": "PolicyResourceRecommendationPolicyIdsQueryOperator"}, {"subtype_model": "PolicyResourceRecommendationSeverityQueryOperator", "subtype_name": "PolicyResourceRecommendationSeverityQueryOperator"}, {"subtype_model": "PolicyRecommendationClassificationQueryOperator", "subtype_name": "PolicyRecommendationClassificationQueryOperator"}, {"subtype_model": "InfraResourceTrendResourceChangeStatusQueryOperator", "subtype_name": "InfraResourceTrendResourceChangeStatusQueryOperator"}, {"subtype_model": "VmAgentsQueryOsTypes", "subtype_name": "VmAgentsQueryOsTypes"}, {"subtype_model": "VmAgentsQueryInstantState", "subtype_name": "VmAgentsQueryInstantState"}, {"subtype_model": "VmAgentsQueryQualysStatus", "subtype_name": "VmAgentsQueryQualysStatus"}, {"subtype_model": "VmAgentsQueryCrowdStrikeStatus", "subtype_name": "VmAgentsQueryCrowdStrikeStatus"}, {"subtype_model": "VmAgentsQuerySplunkStatus", "subtype_name": "VmAgentsQuerySplunkStatus"}, {"subtype_model": "StacksMarketplaceStackQueryArchived", "subtype_name": "StacksMarketplaceStackQueryArchived"}, {"subtype_model": "StacksMarketplaceStackQueryAutoApproved", "subtype_name": "StacksMarketplaceStackQueryAutoApproved"}, {"subtype_model": "StacksMarketplaceStackQueryOwner", "subtype_name": "StacksMarketplaceStackQueryOwner"}, {"subtype_model": "StacksMarketplaceStackQueryName", "subtype_name": "StacksMarketplaceStackQueryName"}, {"subtype_model": "StacksMarketplaceStackQueryProduct", "subtype_name": "StacksMarketplaceStackQueryProduct"}, {"subtype_model": "StacksMarketplaceDeploymentQueryName", "subtype_name": "StacksMarketplaceDeploymentQueryName"}, {"subtype_model": "StacksMarketplaceDeploymentQueryStack", "subtype_name": "StacksMarketplaceDeploymentQueryStack"}, {"subtype_model": "StacksMarketplaceDeploymentQueryAccount", "subtype_name": "StacksMarketplaceDeploymentQueryAccount"}, {"subtype_model": "StacksMarketplaceDeploymentQueryRegion", "subtype_name": "StacksMarketplaceDeploymentQueryRegion"}, {"subtype_model": "StacksMarketplaceStackDeploymentQueryExecutionStatus", "subtype_name": "StacksMarketplaceStackDeploymentQueryExecutionStatus"}, {"subtype_model": "MetricNameQueryOperator", "subtype_name": "MetricNameQueryOperator"}, {"subtype_model": "ResourceQueryCategory", "subtype_name": "ResourceQueryCategory"}, {"subtype_model": "ResourceQueryLocation", "subtype_name": "ResourceQueryLocation"}, {"subtype_model": "ResourceQueryResource", "subtype_name": "ResourceQueryResource"}, {"subtype_model": "ResourceQueryResourceGroup", "subtype_name": "ResourceQueryResourceGroup"}, {"subtype_model": "ResourceQueryResourceName", "subtype_name": "ResourceQueryResourceName"}, {"subtype_model": "ResourceQueryResourceType", "subtype_name": "ResourceQueryResourceType"}, {"subtype_model": "ResourceQueryTagPresence", "subtype_name": "ResourceQueryTagPresence"}, {"subtype_model": "ResourceQueryTagKey", "subtype_name": "ResourceQueryTagKey"}, {"subtype_model": "ResourceQueryTagKeyValue", "subtype_name": "ResourceQueryTagKeyValue"}, {"subtype_model": "WorkloadQueryWorkloadName", "subtype_name": "WorkloadQueryWorkloadName"}, {"subtype_model": "WorkloadQueryWorkloadOwner", "subtype_name": "WorkloadQueryWorkloadOwner"}, {"subtype_model": "WorkloadQueryCloud", "subtype_name": "WorkloadQueryCloud"}, {"subtype_model": "WorkloadQueryCloudAccount", "subtype_name": "WorkloadQueryCloudAccount"}, {"subtype_model": "WorkloadQueryWorkloadType", "subtype_name": "WorkloadQueryWorkloadType"}, {"subtype_model": "WorkloadQueryWorkloadId", "subtype_name": "WorkloadQueryWorkloadId"}]}, "QueryOperatorBinary": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["a", "b"], "properties": {"a": {"description": "Left side of binary query operator", "$ref": "#/definitions/QueryOperator"}, "b": {"description": "Right side of binary query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorBinary"}, "QueryOperatorBinaryForGraph": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["a", "b"], "properties": {"a": {"description": "Left side of binary query operator", "$ref": "#/definitions/QueryOperator"}, "b": {"description": "Right side of binary query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorBinaryForGraph"}, "QueryOperatorBinaryLogic": {"allOf": [{"$ref": "#/definitions/QueryOperatorBinary"}, {"required": ["op"], "properties": {"op": {"type": "string", "description": "Type of binary operation", "example": "And", "enum": ["And", "Or", "Xor"], "x-cs-enum-type": "ResourceQueryCondition"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorBinaryLogic"}, "QueryOperatorBinaryLogicForGraph": {"allOf": [{"$ref": "#/definitions/QueryOperatorBinaryForGraph"}, {"required": ["op"], "properties": {"op": {"type": "string", "description": "Type of binary operation", "example": "And", "enum": ["And", "Or", "Xor"], "x-cs-enum-type": "ResourceQueryCondition"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorBinaryLogicForGraph"}, "QueryOperatorComparator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["a"], "properties": {"a": {"description": "value of comparator query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorComparator"}, "QueryOperatorComparatorLogic": {"allOf": [{"$ref": "#/definitions/QueryOperatorComparator"}, {"required": ["op"], "properties": {"op": {"type": "string", "description": "Type of comparison operation", "example": "EqualTo", "enum": ["EqualTo", "GreaterThan", "LessThan"], "x-cs-enum-type": "ComparisonQueryCondition"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorComparatorLogic"}, "QueryOperatorFalse": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "QueryOperatorFalse"}, "QueryOperatorNary": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"terms": {"type": "array", "items": {"description": "List of QueryOperator terms for n-ary evaluation", "$ref": "#/definitions/QueryOperator"}}}, "type": "object"}], "x-cs-type-name": "QueryOperatorNary"}, "QueryOperatorNaryForGraph": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"terms": {"type": "array", "items": {"description": "List of QueryOperator terms for n-ary evaluation", "$ref": "#/definitions/QueryOperator"}}}, "type": "object"}], "x-cs-type-name": "QueryOperatorNaryForGraph"}, "QueryOperatorNaryLogic": {"allOf": [{"$ref": "#/definitions/QueryOperatorNary"}, {"required": ["op"], "properties": {"op": {"type": "string", "description": "Type of n-ary operation", "example": "Any", "enum": ["Any", "All", "NotAny"], "x-cs-enum-type": "ResourceNaryQueryCondition"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorNaryLogic"}, "QueryOperatorNaryLogicForGraph": {"allOf": [{"$ref": "#/definitions/QueryOperatorNaryForGraph"}, {"required": ["op"], "properties": {"op": {"type": "string", "description": "Type of n-ary operation", "example": "Any", "enum": ["Any", "All", "NotAny"], "x-cs-enum-type": "ResourceNaryQueryCondition"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorNaryLogicForGraph"}, "QueryOperatorTrue": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "QueryOperatorTrue"}, "QueryOperatorUnary": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["a"], "properties": {"a": {"description": "Sub-expression of the unary query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorUnary"}, "QueryOperatorUnaryForGraph": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["a"], "properties": {"a": {"description": "Sub-expression of the unary query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "QueryOperatorUnaryForGraph"}, "QueryOperatorUnaryNot": {"allOf": [{"$ref": "#/definitions/QueryOperatorUnary"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "QueryOperatorUnaryNot"}, "QueryOperatorUnaryNotForGraph": {"allOf": [{"$ref": "#/definitions/QueryOperatorUnaryForGraph"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "QueryOperatorUnaryNotForGraph"}, "RangeSelection": {"properties": {"range": {"type": "string", "example": "Last15Minutes", "enum": ["Last15Minutes", "Last30Minutes", "Last60Minutes", "Hour", "PreviousHour", "Last3Hours", "Last6Hours", "Last12Hours", "Last24Hours", "FullDay", "Today", "Yesterday", "Last2Days", "Last3Days", "Last7Days", "Last14Days", "Week", "WeekToDate", "LastWeekToNow", "Last2WeeksToNow", "PreviousWeek", "Previous2Weeks", "Previous4Weeks", "FullMonth", "Month", "MonthToDate", "PreviousMonth", "LastMonthToNow", "Previous3Months", "Previous6Months", "Previous12Months", "TwoMonthsAgo", "ThreeMonthsAgo", "Last30Days", "FullQuarter", "Quarter", "QuarterToDate", "LastQuarterToNow", "LastQuarterToDate", "PreviousQuarter", "Previous2Quarters", "Previous3Quarters", "Previous4Quarters", "Last3Months", "Last3MonthsToNow", "Last6MonthsToNow", "Last12MonthsToNow", "FullYear", "Year", "YearToDate", "PreviousYear", "Previous3Years", "Last365Days", "BillingCurrentMonth", "BillingPreviousMonth", "BillingCurrentQuarter", "BillingPreviousQuarter", "BillingPrevious3Months", "BillingPrevious6Months", "FiscalPreviousQuarter", "FiscalCurrentQuarter", "FiscalCurrentQuarterToNow", "FiscalPreviousHalfYear", "FiscalCurrentHalfYear", "FiscalPreviousYear", "FiscalCurrentYear", "FiscalCurrentYearToNow", "FiscalLast3Years", "FiscalYearToDate", "WeekToDateT2", "LastWeekToDateT2", "Last2WeeksToDateT2", "MonthToDateT2", "LastMonthToDateT2", "Last3MonthsToDateT2", "Last6MonthsToDateT2", "Last12MonthsToDateT2", "LastQuarterToDateT2", "YearToDateT2", "FiscalLastQuarterToDateT2", "FiscalCurrentQuarterToDateT2", "FiscalCurrentYearToDateT2", "All"], "x-cs-enum-type": "TimeRangeId"}, "start": {"type": "string", "format": "date-time"}, "end": {"type": "string", "format": "date-time"}, "zoneCreated": {"type": "string"}, "zone": {"type": "string"}}, "type": "object"}, "RangeValue": {"properties": {"range": {"description": "Range value", "$ref": "#/definitions/FromToValue"}}, "type": "object"}, "RawImport": {"properties": {"contentsAsJSON": {"type": "string"}}, "type": "object"}, "RealizationSavingDashboardSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "savings_amount", "enum": ["savings_amount"], "x-cs-enum-type": "RealizationSavingDashboardSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "RealizationSavingsListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/RealizationSavingDashboardSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/RecommendationListFilters"}}, "type": "object"}, "RealizedSavingDashboard": {"properties": {"resource_id": {"type": "string", "description": "Unique id for the resource."}, "service_account_id": {"type": "string", "description": "Id for the service account to which the recommendation belongs to."}, "resource_name": {"type": "string", "description": "Name for the Resource."}, "resource_filter": {"type": "string", "description": "Name for the resource filter"}, "resource_location": {"type": "string", "description": "location for the resource"}, "resource_category": {"type": "string", "description": "Category for the Resource."}, "resource_type": {"type": "string", "description": "Type for the Resource."}, "resource": {"type": "string", "description": "Low level hierarchy for the resource."}, "impact": {"type": "string", "description": "impact for the recommendation"}, "current_sku": {"type": "string", "description": "Current sku for the resource."}, "recommended_sku": {"type": "string", "description": "Recommended sku for the resource."}, "recommendation_type": {"type": "string", "description": "Recommendation type for the resource."}, "savings_amount": {"type": "number", "description": "Savings amount for the resource."}, "workflow_history": {"type": "array", "items": {"$ref": "#/definitions/WorkFlowEventHistory"}}, "recommendation_sys_id": {"type": "string", "description": "Unique Id for the Recommendation."}, "workflow_status": {"type": "string", "description": "over all status of the workflow.", "example": "Approved", "enum": ["Approved", "Auto Approved", "Pending Approval", "Rejected"], "x-cs-enum-type": "WorkFlowImpactStatus"}, "workflow_id": {"type": "string", "description": "Sys Id of the workflow belongs to"}, "tenant_id": {"type": "string", "description": "Sys Id of the tenant where the resource belongs to", "x-cs-type": "ObjectId"}}, "type": "object"}, "Recommendation": {"required": ["classification", "cloud_account_id", "cloud_account_name", "created_at", "id", "impact", "name", "policy_id", "policy_name", "projected_cost_savings_month", "resource_counts", "service_name", "source", "status", "sub_classification", "tenant_id", "tenant_name"], "properties": {"id": {"type": "string", "description": "Recommendation id"}, "policy_id": {"type": "string", "description": "Policy Id"}, "policy_name": {"type": "string", "description": "Policy Name"}, "name": {"type": "string", "description": "Name"}, "status": {"type": "string", "description": "Status"}, "impact": {"type": "string", "description": "Impact"}, "classification": {"type": "string", "description": "Classification based on OSCAR pillar"}, "sub_classification": {"type": "string", "description": "Sub Classification for the classification"}, "cloud_account_id": {"type": "string", "description": "Cloud account id"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}, "tenant_name": {"type": "string", "description": "Tenant Name"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "service_name": {"type": "string", "description": "Cloud Service Name"}, "source": {"type": "string", "description": "Source"}, "created_at": {"type": "string", "description": "Time of creation"}, "projected_cost_savings_month": {"type": "string", "description": "Projected Cost Saving per Month"}, "resource_counts": {"description": "The resources that are open based on the recommendation", "$ref": "#/definitions/ResourceCount"}}, "type": "object"}, "RecommendationActionResponse": {"required": ["action_resource_name", "action_type", "description", "name", "resource_level", "terms_and_conditions"], "properties": {"name": {"type": "string", "description": "recommendation action name"}, "terms_and_conditions": {"type": "string", "description": "Terms and conditions for performing the recommended action"}, "resource_level": {"type": "string", "description": "if the action will be performed at the resource level"}, "action_type": {"type": "string", "description": "Type of action will be always template"}, "action_resource_name": {"type": "string", "description": "Name of template"}, "description": {"type": "string", "description": "Description about the action in details"}}, "type": "object"}, "RecommendationActionsBase": {"properties": {"name": {"type": "string", "description": "Name of the recommendation action"}, "description": {"type": "string", "description": "Description of the recommendation action"}, "action_type": {"type": "string", "description": "Indicates the action for the resource recommendation", "example": "ChangeSku", "enum": ["ChangeSku", "DeleteResource", "ReservationMigration", "RenewReservation", "PurchaseReservation", "ShutDownResource"], "x-cs-enum-type": "ResourceRecommendationSupportedAction"}, "action_resource_name": {"type": "string", "description": "action resource name mapped to template for recommendation"}, "default_params_for_action": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "RecommendationAudits": {"properties": {"workflow_details": {"type": "array", "items": {"$ref": "#/definitions/WorkFlowImpacts"}}, "dimension_ids": {"type": "array", "description": "Ids for the dimension which impacted this resource", "items": {"type": "string"}}, "exclusion_rule_ids": {"type": "array", "description": "Ids for the exclusion rules which impacted this resource", "items": {"type": "string"}}}, "type": "object"}, "RecommendationBase": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "DescriptorForRecommendation", "subtype_name": "DescriptorForRecommendation"}, {"subtype_model": "RecommendationBaseForFinOps", "subtype_name": "RecommendationBaseForFinOps"}, {"subtype_model": "RecommendationForFinopsUnderutilizedCorestackProfilerResource", "subtype_name": "RecommendationForFinopsUnderutilizedCorestackProfilerResource"}, {"subtype_model": "RecommendationForFinopsUnderUtilizedSystemResource", "subtype_name": "RecommendationForFinopsUnderUtilizedSystemResource"}, {"subtype_model": "RecommendationForFinopsIdleSystemResource", "subtype_name": "RecommendationForFinopsIdleSystemResource"}, {"subtype_model": "RecommendationForFinopsConfigSystemResource", "subtype_name": "RecommendationForFinopsConfigSystemResource"}, {"subtype_model": "RecommendationForFinopsOrphanedSystemResource", "subtype_name": "RecommendationForFinopsOrphanedSystemResource"}, {"subtype_model": "RecommendationForFinopsBudgetSystem", "subtype_name": "RecommendationForFinopsBudgetSystem"}, {"subtype_model": "RecommendationForFinopsAnomalySystem", "subtype_name": "RecommendationForFinopsAnomalySystem"}, {"subtype_model": "RecommendationForFinopsTagsSystem", "subtype_name": "RecommendationForFinopsTagsSystem"}, {"subtype_model": "RecommendationForFinopsGovernanceSystem", "subtype_name": "RecommendationForFinopsGovernanceSystem"}, {"subtype_model": "RecommendationForFinopsConfigAHBResource", "subtype_name": "RecommendationForFinopsConfigAHBResource"}, {"subtype_model": "RecommendationForFinopsConfigAwsAdvisorResource", "subtype_name": "RecommendationForFinopsConfigAwsAdvisorResource"}, {"subtype_model": "RecommendationForFinopsUnderUtilizedAwsComputeOptimizerResource", "subtype_name": "RecommendationForFinopsUnderUtilizedAwsComputeOptimizerResource"}, {"subtype_model": "RecommendationForFinopsUnderUtilizedAwsEC2ComputeOptimizerResource", "subtype_name": "RecommendationForFinopsUnderUtilizedAwsEC2ComputeOptimizerResource"}, {"subtype_model": "RecommendationForFinopsUnderUtilizedAwsLambdaComputeOptimizerResource", "subtype_name": "RecommendationForFinopsUnderUtilizedAwsLambdaComputeOptimizerResource"}, {"subtype_model": "RecommendationForFinopsIdleAwsAdvisorResource", "subtype_name": "RecommendationForFinopsIdleAwsAdvisorResource"}, {"subtype_model": "RecommendationForFinopsOptimizedAwsAdvisorResource", "subtype_name": "RecommendationForFinopsOptimizedAwsAdvisorResource"}, {"subtype_model": "RecommendationForFinopsOrphanedAwsAdvisorResource", "subtype_name": "RecommendationForFinopsOrphanedAwsAdvisorResource"}, {"subtype_model": "RecommendationForFinopsUnderUtilizedAzureAdvisorResource", "subtype_name": "RecommendationForFinopsUnderUtilizedAzureAdvisorResource"}, {"subtype_model": "RecommendationForFinopsBillingAzureAdvisor", "subtype_name": "RecommendationForFinopsBillingAzureAdvisor"}, {"subtype_model": "RecommendationForFinopsIdleAzureAdvisorResource", "subtype_name": "RecommendationForFinopsIdleAzureAdvisorResource"}, {"subtype_model": "RecommendationForFinopsOptimizesAzureAdvisorResource", "subtype_name": "RecommendationForFinopsOptimizesAzureAdvisorResource"}, {"subtype_model": "RecommendationForFinopsUtilizationAzureAdvisorResource", "subtype_name": "RecommendationForFinopsUtilizationAzureAdvisorResource"}, {"subtype_model": "RecommendationForFinopsConfigAzureAdvisorResource", "subtype_name": "RecommendationForFinopsConfigAzureAdvisorResource"}, {"subtype_model": "RecommendationForFinopsUnderutilizedGcpAdvisorResource", "subtype_name": "RecommendationForFinopsUnderutilizedGcpAdvisorResource"}, {"subtype_model": "RecommendationForFinopsIdleGcpAdvisorResource", "subtype_name": "RecommendationForFinopsIdleGcpAdvisorResource"}, {"subtype_model": "RecommendationForFinopsOrphanedGcpAdvisorResource", "subtype_name": "RecommendationForFinopsOrphanedGcpAdvisorResource"}, {"subtype_model": "RecommendationForFinopsConfigGcpAdvisorResource", "subtype_name": "RecommendationForFinopsConfigGcpAdvisorResource"}, {"subtype_model": "RecommendationForFinopsUnderUtilizedOciAdvisorResource", "subtype_name": "RecommendationForFinopsUnderUtilizedOciAdvisorResource"}, {"subtype_model": "RecommendationForFinopsIdleOciAdvisorResource", "subtype_name": "RecommendationForFinopsIdleOciAdvisorResource"}, {"subtype_model": "RecommendationForFinopsOrphanedOciAdvisorResource", "subtype_name": "RecommendationForFinopsOrphanedOciAdvisorResource"}, {"subtype_model": "RecommendationForFinopsConfigOciAdvisorResource", "subtype_name": "RecommendationForFinopsConfigOciAdvisorResource"}, {"subtype_model": "RecommendationBaseForFinopsCustomResource", "subtype_name": "RecommendationBaseForFinopsCustomResource"}, {"subtype_model": "RecommendationForFinopsCustomBillingResource", "subtype_name": "RecommendationForFinopsCustomBillingResource"}, {"subtype_model": "RecommendationForFinopsCustomConfigResource", "subtype_name": "RecommendationForFinopsCustomConfigResource"}, {"subtype_model": "RecommendationForFinopsCustomIdleResource", "subtype_name": "RecommendationForFinopsCustomIdleResource"}, {"subtype_model": "RecommendationForFinopsCustomOrphanedResource", "subtype_name": "RecommendationForFinopsCustomOrphanedResource"}, {"subtype_model": "RecommendationForFinopsCustomUnderUtilizedResource", "subtype_name": "RecommendationForFinopsCustomUnderUtilizedResource"}]}, "RecommendationBaseForFinOps": {"allOf": [{"$ref": "#/definitions/DescriptorForResourceRecommendation"}, {"properties": {"current_sku_id": {"type": "string", "description": "Unique Identifier for the current Sku."}, "additional_sku_details": {"$ref": "#/definitions/RecommendationSkuDetailsBase"}, "recommendation_options": {"type": "array", "items": {"$ref": "#/definitions/RecommendationOptionsBase"}}}, "type": "object"}], "x-cs-type-name": "RecommendationBaseForFinOps"}, "RecommendationBaseForFinopsCustomResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationBaseForFinopsCustomResource"}, "RecommendationBaseForFinopsResource": {"allOf": [{"$ref": "#/definitions/DescriptorForResourceRecommendation"}, {"properties": {"current_sku_id": {"type": "string", "description": "Unique Identifier for the current Sku."}, "additional_sku_details": {"$ref": "#/definitions/RecommendationSkuDetailsBase"}, "recommendation_options": {"type": "array", "items": {"$ref": "#/definitions/RecommendationOptionsBase"}}, "recommender_sys_id": {"type": "string", "description": "Unique Identifier for the Recommendation generated from the system.Map this with  policy id for cloud provider recommendations."}, "recommendation_sys_id": {"type": "string", "description": "Unique Identifier for the Recommendation generated from the system.Map this with reference id for cloud provider recommendations."}}, "type": "object"}]}, "RecommendationByAccount": {"required": ["classification", "cloud_account_id", "cloud_account_name", "created_at", "id", "impact", "name", "policy_id", "policy_name", "resource_counts", "service_name", "source", "status", "sub_classification", "tenant_name"], "properties": {"id": {"type": "string", "description": "Recommendation ID"}, "policy_id": {"type": "string", "description": "Policy ID"}, "policy_name": {"type": "string", "description": "Policy Name"}, "name": {"type": "string", "description": "Name of the policy recommendation"}, "status": {"type": "string", "description": "Status"}, "impact": {"type": "string", "description": "Impact"}, "classification": {"type": "string", "description": "Oscar Classification"}, "sub_classification": {"type": "string", "description": "Sub classification of the above classification"}, "cloud_account_id": {"type": "string", "description": "Cloud Account ID"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}, "service_name": {"type": "string", "description": "Cloud Service Name"}, "tenant_name": {"type": "string", "description": "Tenant Name"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "created_at": {"type": "string", "description": "Time of creation"}, "source": {"type": "string", "description": "Source"}, "resource_counts": {"description": "Count of the resource that are open", "$ref": "#/definitions/ResourceCountByAccount"}}, "type": "object"}, "RecommendationByCategory": {"required": ["classification", "cloud_account_id", "cloud_account_name", "created_at", "id", "impact", "name", "policy_id", "policy_name", "resource_counts", "service_name", "source", "status", "sub_classification", "tenant_name"], "properties": {"id": {"type": "string", "description": "Recommendation ID"}, "policy_id": {"type": "string", "description": "Policy ID"}, "policy_name": {"type": "string", "description": "Policy Name"}, "name": {"type": "string", "description": "Name of the policy recommendation"}, "status": {"type": "string", "description": "Status"}, "impact": {"type": "string", "description": "Impact"}, "classification": {"type": "string", "description": "Oscar Classification"}, "sub_classification": {"type": "string", "description": "Sub classification of the above classification"}, "cloud_account_id": {"type": "string", "description": "Cloud Account ID"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}, "service_name": {"type": "string", "description": "Cloud Service Name"}, "tenant_name": {"type": "string", "description": "Tenant Name"}, "created_at": {"type": "string", "description": "Time of creation"}, "source": {"type": "string", "description": "Source"}, "resource_counts": {"description": "Count of the resource that are open", "$ref": "#/definitions/ResourceCountByCategory"}}, "type": "object"}, "RecommendationClassificationFilter": {"allOf": [{"$ref": "#/definitions/RecommendationFilterBase"}, {"properties": {"policy_classifications": {"type": "array", "description": "List of Policy Classifications", "items": {"type": "string", "description": "Classification of the policy", "example": "Access", "enum": ["Access", "Cost", "Data", "Network", "Operation", "Performance", "Resource", "Security"], "x-cs-enum-type": "PolicyClassification"}}, "policy_sub_classifications": {"type": "array", "description": "List of Policy Sub Classifications", "items": {"type": "string", "description": "Sub-Classification of the policy", "example": "Access", "enum": ["Access", "Anomaly", "Application", "Application_Integration", "Availability", "Backup", "Billing", "Budget", "Config", "Data", "Databases", "Encryption", "End Point Protection", "Governance", "High", "Host", "Identity", "Idle", "Logging", "Monitoring", "Naming Standards", "Network", "Operation", "Optimized", "Orphaned", "Performance", "SNS", "Security", "Standards", "Storage", "Tags", "Underutilized", "Utilization", "medium"], "x-cs-enum-type": "PolicySubClassification"}}}, "type": "object"}]}, "RecommendationDefinitions": {"properties": {"name": {"type": "string", "description": "Name of the recommendation definition"}, "description": {"type": "string", "description": "description of the recommendation definition"}, "definition_sys_id": {"type": "string", "description": "Sys id of the recommendation definition"}, "api_reference_id": {"type": "string", "description": "Id from the cloud provider which needs to be called"}, "service_resource_uri": {"type": "string", "description": "service resource uri of the recommendation definition"}, "classification": {"type": "string", "description": "Classification of the policy", "example": "Access", "enum": ["Access", "Cost", "Data", "Network", "Operation", "Performance", "Resource", "Security"], "x-cs-enum-type": "PolicyClassification"}, "sub_classification": {"type": "string", "description": "Sub-Classification of the policy", "example": "Access", "enum": ["Access", "Anomaly", "Application", "Application_Integration", "Availability", "Backup", "Billing", "Budget", "Config", "Data", "Databases", "Encryption", "End Point Protection", "Governance", "High", "Host", "Identity", "Idle", "Logging", "Monitoring", "Naming Standards", "Network", "Operation", "Optimized", "Orphaned", "Performance", "SNS", "Security", "Standards", "Storage", "Tags", "Underutilized", "Utilization", "medium"], "x-cs-enum-type": "PolicySubClassification"}, "source": {"type": "string", "description": "Recommendation source V2", "example": "AWS-compute-optimizer", "enum": ["AWS-compute-optimizer", "AWS-ec2-compute-optimizer", "AWS-lambda-compute-optimizer", "AWS_advisor", "Corestack-Profiler", "Custom", "GCP_advisor", "OCI_advisor", "activity_log", "azure_advisor", "policy", "security_threats", "AHB"], "x-cs-enum-type": "RecommendationSourceV2"}, "recommendation_group": {"type": "string", "description": "Indicates the group for the resource recommendation", "example": "Advisor", "enum": ["Advisor", "AHB", "Right-Sizing"], "x-cs-enum-type": "RecommendationGroupMapping"}, "impact": {"type": "string", "description": "Impact of the policy resource recommendation", "example": "critical", "enum": ["critical", "high", "informational", "low", "medium", "uncategorized"], "x-cs-enum-type": "PolicyResourceRecommendationImpact"}, "recommendation_actions": {"type": "array", "items": {"$ref": "#/definitions/RecommendationActionsBase"}}, "key_for_sku": {"type": "string", "description": "The provided key will be used to parse the current sku value from the resource details "}, "resolution_validators": {"type": "array", "items": {"$ref": "#/definitions/RecommendationResolutionBase"}}, "additional_resource_details_mapper": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "RecommendationDetails": {"properties": {"name": {"type": "string", "description": "Name of the recommendation"}, "tenant_id": {"type": "string", "description": "Recommendation tenant ID", "x-cs-type": "ObjectId"}, "service_account_id": {"type": "string", "description": "Recommendation service account ID", "x-cs-type": "ObjectId"}, "policy_ids": {"type": "array", "description": "List of policy IDs for which the recommendation is generated", "items": {"type": "string"}}, "policy_classification": {"type": "string", "description": "Policy Classification", "example": "Access", "enum": ["Access", "Cost", "Data", "Network", "Operation", "Performance", "Resource", "Security"], "x-cs-enum-type": "PolicyClassification"}, "policy_sub_classification": {"type": "string", "description": "Policy Sub Classification", "example": "Access", "enum": ["Access", "Anomaly", "Application", "Application_Integration", "Availability", "Backup", "Billing", "Budget", "Config", "Data", "Databases", "Encryption", "End Point Protection", "Governance", "High", "Host", "Identity", "Idle", "Logging", "Monitoring", "Naming Standards", "Network", "Operation", "Optimized", "Orphaned", "Performance", "SNS", "Security", "Standards", "Storage", "Tags", "Underutilized", "Utilization", "medium"], "x-cs-enum-type": "PolicySubClassification"}, "recommendation_source": {"type": "string", "description": "Source of the recommendation", "example": "AWS-compute-optimizer", "enum": ["AWS-compute-optimizer", "AWS-ec2-compute-optimizer", "AWS-lambda-compute-optimizer", "AWS_advisor", "Corestack-Profiler", "Custom", "GCP_advisor", "OCI_advisor", "activity_log", "azure_advisor", "policy", "security_threats"], "x-cs-enum-type": "RecommendationSource"}, "impact": {"type": "string", "description": "Impact of the recommendation", "example": "critical", "enum": ["critical", "high", "informational", "low", "medium", "uncategorized"], "x-cs-enum-type": "PolicyResourceRecommendationImpact"}, "status": {"type": "string", "description": "Status of the recommendation", "example": "error", "enum": ["error", "in_progress", "open", "resolved", "skipped", "system_skipped"], "x-cs-enum-type": "PolicyResourceRecommendationStatus"}}, "type": "object"}, "RecommendationDetailsBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/RecommendationDetails"}}}, "type": "object"}, "RecommendationExclusionRule": {"allOf": [{"$ref": "#/definitions/RecommendationExclusionRuleBase"}, {"properties": {"policy_classification": {"$ref": "#/definitions/PolicyClassificationWithSubClassifications"}, "rule_id": {"type": "string", "description": "ID of the Rule", "x-cs-type": "ObjectId"}, "created_by": {"type": "string", "description": "Name of the user who created the rule."}, "created_at": {"type": "string", "format": "date-time", "description": "Recommendation exclusion rule created time"}, "updated_by": {"type": "string", "description": "Name of the user who recently updated the rule."}, "updated_at": {"type": "string", "format": "date-time", "description": "Recommendation exclusion rule updated time"}}, "type": "object"}]}, "RecommendationExclusionRuleApplyRequest": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Rules to apply on provided tenant.", "x-cs-type": "ObjectId"}}, "type": "object"}, "RecommendationExclusionRuleBase": {"required": ["name", "resource_scope", "scope"], "properties": {"name": {"type": "string", "description": "Recommendation Exclusion Rule Name"}, "activation_date": {"type": "string", "format": "date-time", "description": "Rule Activation date"}, "description": {"type": "string", "description": "Rule Description"}, "expiry_date": {"type": "string", "format": "date-time", "description": "Rule expiry date"}, "is_enabled": {"type": "boolean", "description": "Rule status"}, "scope": {"type": "string", "description": "Rule Scope", "example": "account", "enum": ["account", "tenant"], "x-cs-enum-type": "RecommendationExclusionRuleScope"}, "resource_scope": {"description": "Filter for the rule.", "$ref": "#/definitions/RecommendationResourceScopeBase"}}, "type": "object"}, "RecommendationExclusionRuleBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/RecommendationExclusionRule"}}}, "type": "object"}, "RecommendationExclusionRuleFilters": {"allOf": [{"$ref": "#/definitions/RecommendationClassificationFilter"}, {"properties": {"search": {"type": "string", "description": "Search based on name, classification, sub_classification"}}, "type": "object"}]}, "RecommendationExclusionRuleGetResponse": {"allOf": [{"$ref": "#/definitions/RecommendationExclusionRule"}, {"properties": {}, "type": "object"}]}, "RecommendationExclusionRuleRequest": {"allOf": [{"$ref": "#/definitions/RecommendationExclusionRuleBase"}, {"required": ["policy_classification"], "properties": {"policy_classification": {"description": "Policy classification with sub-classifications.", "$ref": "#/definitions/PolicyClassificationWithSubClassifications"}}, "type": "object"}]}, "RecommendationExclusionRuleResponse": {"allOf": [{"$ref": "#/definitions/RecommendationExclusionRule"}, {"properties": {}, "type": "object"}]}, "RecommendationExclusionRulesListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/RecommendationExclusionRulesSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/RecommendationExclusionRuleFilters"}}, "type": "object"}, "RecommendationExclusionRulesSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "name", "enum": ["name", "created_at"], "x-cs-enum-type": "RecommendationExclusionRulesSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "RecommendationFilterBase": {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "List of Tenant Ids to get the recommendation rules.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "service_account_ids": {"type": "array", "description": "List of service account IDs to get the recommendation details. If empty, all accounts will be selected by default.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "RecommendationForFinopsAnomalySystem": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinOps"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsAnomalySystem"}, "RecommendationForFinopsBillingAzureAdvisor": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinOps"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsBillingAzureAdvisor"}, "RecommendationForFinopsBudgetSystem": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinOps"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsBudgetSystem"}, "RecommendationForFinopsConfigAHBResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsConfigAHBResource"}, "RecommendationForFinopsConfigAwsAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsConfigAwsAdvisorResource"}, "RecommendationForFinopsConfigAzureAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsConfigAzureAdvisorResource"}, "RecommendationForFinopsConfigGcpAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsConfigGcpAdvisorResource"}, "RecommendationForFinopsConfigOciAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsConfigOciAdvisorResource"}, "RecommendationForFinopsConfigSystemResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsConfigSystemResource"}, "RecommendationForFinopsCustomBillingResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsCustomResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsCustomBillingResource"}, "RecommendationForFinopsCustomConfigResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsCustomResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsCustomConfigResource"}, "RecommendationForFinopsCustomIdleResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsCustomResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsCustomIdleResource"}, "RecommendationForFinopsCustomOrphanedResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsCustomResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsCustomOrphanedResource"}, "RecommendationForFinopsCustomUnderUtilizedResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsCustomResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsCustomUnderUtilizedResource"}, "RecommendationForFinopsGovernanceSystem": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsGovernanceSystem"}, "RecommendationForFinopsIdleAwsAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsIdleAwsAdvisorResource"}, "RecommendationForFinopsIdleAzureAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsIdleAzureAdvisorResource"}, "RecommendationForFinopsIdleGcpAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsIdleGcpAdvisorResource"}, "RecommendationForFinopsIdleOciAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsIdleOciAdvisorResource"}, "RecommendationForFinopsIdleSystemResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsIdleSystemResource"}, "RecommendationForFinopsOptimizedAwsAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsOptimizedAwsAdvisorResource"}, "RecommendationForFinopsOptimizesAzureAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsOptimizesAzureAdvisorResource"}, "RecommendationForFinopsOrphanedAwsAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsOrphanedAwsAdvisorResource"}, "RecommendationForFinopsOrphanedGcpAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsOrphanedGcpAdvisorResource"}, "RecommendationForFinopsOrphanedOciAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsOrphanedOciAdvisorResource"}, "RecommendationForFinopsOrphanedSystemResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsOrphanedSystemResource"}, "RecommendationForFinopsTagsSystem": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinOps"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsTagsSystem"}, "RecommendationForFinopsUnderUtilizedAwsComputeOptimizerResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUnderUtilizedAwsComputeOptimizerResource"}, "RecommendationForFinopsUnderUtilizedAwsEC2ComputeOptimizerResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUnderUtilizedAwsEC2ComputeOptimizerResource"}, "RecommendationForFinopsUnderUtilizedAwsLambdaComputeOptimizerResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUnderUtilizedAwsLambdaComputeOptimizerResource"}, "RecommendationForFinopsUnderUtilizedAzureAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUnderUtilizedAzureAdvisorResource"}, "RecommendationForFinopsUnderUtilizedOciAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUnderUtilizedOciAdvisorResource"}, "RecommendationForFinopsUnderUtilizedSystemResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUnderUtilizedSystemResource"}, "RecommendationForFinopsUnderutilizedCorestackProfilerResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUnderutilizedCorestackProfilerResource"}, "RecommendationForFinopsUnderutilizedGcpAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUnderutilizedGcpAdvisorResource"}, "RecommendationForFinopsUtilizationAzureAdvisorResource": {"allOf": [{"$ref": "#/definitions/RecommendationBaseForFinopsResource"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationForFinopsUtilizationAzureAdvisorResource"}, "RecommendationListFilters": {"allOf": [{"$ref": "#/definitions/RecommendationsFilterBase"}, {"required": ["dashboard_type"], "properties": {"dashboard_type": {"type": "string", "description": "Field represents whether the dashboard is for open or closed", "example": "open", "enum": ["open", "closed", "pre_identified"], "x-cs-enum-type": "RecommendationDashboardType"}, "search": {"type": "string", "description": "Search based on resource id, location, hierarchical metadata"}}, "type": "object"}]}, "RecommendationOptionsBase": {"required": ["__type"], "properties": {"action_name": {"type": "string", "description": "Indicates the action for the resource recommendation", "example": "ChangeSku", "enum": ["ChangeSku", "DeleteResource", "ReservationMigration", "RenewReservation", "PurchaseReservation", "ShutDownResource"], "x-cs-enum-type": "ResourceRecommendationSupportedAction"}, "cost_saving_details": {"$ref": "#/definitions/CostSavingsBase"}, "resolved_at": {"type": "string", "format": "date-time", "description": "Time at which the recommendation has been resolved."}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "RecommendationOptionsForCostSavings", "subtype_name": "RecommendationOptionsForCostSavings"}, {"subtype_model": "RecommendationOptionsForSkuDetails", "subtype_name": "RecommendationOptionsForSkuDetails"}]}, "RecommendationOptionsForCostSavings": {"allOf": [{"$ref": "#/definitions/RecommendationOptionsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "RecommendationOptionsForCostSavings"}, "RecommendationOptionsForSkuDetails": {"allOf": [{"$ref": "#/definitions/RecommendationOptionsBase"}, {"properties": {"additional_sku_details": {"$ref": "#/definitions/RecommendationSkuDetailsBase"}, "recommended_sku": {"type": "string", "description": "recommended sku for the resource"}, "optimization_finding": {"type": "string", "description": "optimization finding"}, "safety_score": {"type": "number", "description": "safety score"}}, "type": "object"}], "x-cs-type-name": "RecommendationOptionsForSkuDetails"}, "RecommendationResolutionBase": {"properties": {"validator_name": {"type": "string", "description": "Name for the validator action"}, "source": {"type": "string", "description": "Indicates the source for checking the resolution of resource recommendation", "example": "inventory", "enum": ["inventory"], "x-cs-enum-type": "ResourceRecommendationResolutionSource"}, "action_type": {"type": "string", "description": "Indicates the action for the resource recommendation", "example": "ChangeSku", "enum": ["ChangeSku", "DeleteResource", "ReservationMigration", "RenewReservation", "PurchaseReservation", "ShutDownResource"], "x-cs-enum-type": "ResourceRecommendationSupportedAction"}, "condition_checker": {"type": "string", "description": "Indicates the list of conditions supported  for the resource recommendation validation check", "example": "EQUALS_TO", "enum": ["EQUALS_TO", "EXISTS"], "x-cs-enum-type": "RecommendationSupportedValidators"}, "key_value_mapper": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "eligible_for_closure": {"type": "boolean", "description": "key to indicate after validation should the record consider for closure", "default": false}}, "type": "object"}, "RecommendationResourceScopeBase": {"required": ["service_name", "tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "List of tenant IDs to which the recommendation rule is applied.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "service_name": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "service_account_ids": {"type": "array", "description": "List of service account IDs to which the recommendation rule is applied.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "filters": {"description": "Query based on Resource Group, Region, resource_id, resource_name and resource", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "RecommendationSkuDetailsBase": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "RecommendationSkuDetailsForAwsEndUserComputingWorkspace", "subtype_name": "RecommendationSkuDetailsForAwsEndUserComputingWorkspace"}]}, "RecommendationSkuDetailsForAwsEndUserComputingWorkspace": {"allOf": [{"$ref": "#/definitions/RecommendationSkuDetailsBase"}, {"required": ["compute_type_name", "root_volume", "running_mode", "state", "user_volume"], "properties": {"compute_type_name": {"type": "string", "description": "Compute Type"}, "root_volume": {"type": "integer", "description": "Root Volume"}, "user_volume": {"type": "integer", "description": "User Volume"}, "running_mode": {"type": "string", "description": "Running Mode"}, "state": {"type": "string", "description": "State"}}, "type": "object"}], "x-cs-type-name": "RecommendationSkuDetailsForAwsEndUserComputingWorkspace"}, "RecommendationStatisticsRequest": {"allOf": [{"$ref": "#/definitions/RecommendationsFilterBase"}, {"properties": {"workflow_sys_id": {"type": "string", "description": "workflow sys id for which the rules are required"}}, "type": "object"}]}, "RecommendationStatisticsResponse": {"properties": {"pre_identified_recommendations": {"type": "integer", "description": "Total number of pre-identified recommendations for the applied filter"}, "pre_identified_savings_amount": {"type": "number", "description": "Potential savings amount for the pre-identified recommendations for the applied filter"}, "potential_savings_amount": {"type": "number", "description": "Potential savings amount for the applied filter"}, "realized_savings_amount": {"type": "number", "description": "Realized savings amount for the applied filter"}, "total_recommendations": {"type": "integer", "description": "Total number of recommendations for the applied filter"}, "realized_recommendations": {"type": "integer", "description": "Total number of realized recommendations for the applied filter"}, "pending_for_approval": {"type": "integer", "description": "Number of pending approvals for the applied filter"}, "approved_recommendations": {"type": "integer", "description": "Number of approved recommendations for the applied filter"}, "rejected_recommendations": {"type": "integer", "description": "Number of rejected recommendations for the applied filter"}, "approved_potential_savings_amount": {"type": "number", "description": "Potential savings amount for Approved workflow status"}, "rejected_potential_savings_amount": {"type": "number", "description": "Potential savings amount for rejected workflow status"}, "pending_approval_potential_savings_amount": {"type": "number", "description": "Potential savings amount for Pending Approval workflow status"}, "pending_approval_realized_savings_amount": {"type": "number", "description": "Realized savings amount for Pending Approval workflow status"}}, "type": "object"}, "RecommendationSubClassificationQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["recommendation_sub_classifications"], "properties": {"recommendation_sub_classifications": {"type": "array", "description": "Id of the workflow", "items": {"type": "string", "description": "Field represents the subclassifications of the recommendation", "example": "Commitment", "enum": ["Commitment", "Config", "Idle", "Optimized", "Orphaned", "Underutilized"], "x-cs-enum-type": "RecommendationV2SubClassifications"}}}, "type": "object"}], "x-cs-type-name": "RecommendationSubClassificationQueryOperator"}, "RecommendationTenant": {"required": ["classification", "cloud_account_id", "cloud_account_name", "created_at", "id", "impact", "name", "policy_id", "policy_name", "projected_cost_savings_month", "resource_counts", "service_name", "source", "status", "sub_classification", "tenant_id", "tenant_name"], "properties": {"id": {"type": "string", "description": "Recommendation id"}, "policy_id": {"type": "string", "description": "Policy Id"}, "policy_name": {"type": "string", "description": "Policy Name"}, "name": {"type": "string", "description": "Name"}, "status": {"type": "string", "description": "Status"}, "impact": {"type": "string", "description": "Impact"}, "classification": {"type": "string", "description": "Classification based on OSCAR pillar"}, "sub_classification": {"type": "string", "description": "Sub Classification for the classification"}, "cloud_account_id": {"type": "string", "description": "Cloud account id"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}, "tenant_name": {"type": "string", "description": "Tenant Name"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "service_name": {"type": "string", "description": "Cloud Service Name"}, "source": {"type": "string", "description": "Source"}, "created_at": {"type": "string", "description": "Time of creation"}, "projected_cost_savings_month": {"type": "string", "description": "Projected Cost Saving per Month"}, "resource_counts": {"description": "The resources that are open based on the recommendation", "$ref": "#/definitions/ResourceCountTenant"}}, "type": "object"}, "RecommendationV2BatchRequest": {"properties": {"recommendation_ids": {"description": "ids for the recommendation", "$ref": "#/definitions/BatchRequest"}, "for_open_recommendation": {"type": "boolean", "description": "Bool determines whether the requested ids are retrieved from open or realized", "default": false}, "workflow_sys_id": {"type": "string", "description": "workflow sys id for which the rules are required"}, "workflow_status": {"type": "string", "description": "over all status of the workflow.", "example": "Approved", "enum": ["Approved", "Auto Approved", "Pending Approval", "Rejected"], "x-cs-enum-type": "WorkFlowImpactStatus"}}, "type": "object"}, "RecommendationV2BatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/RealizedSavingDashboard"}}}, "type": "object"}, "RecommendationView": {"required": ["current_sku", "estimated_cost", "estimated_cost_saving", "estimated_cost_saving_info", "impact_level", "optimization_type", "recommendation_id", "recommended_sku", "region", "resource_id", "resource_name", "resource_recommendation_id", "resource_type", "savings_percentage", "status", "summary"], "properties": {"resource_recommendation_id": {"type": "string", "description": "Identifier for resource recommendation"}, "recommendation_id": {"type": "string", "description": "Recommendation id"}, "resource_name": {"type": "string", "description": "Resource name"}, "resource_type": {"type": "string", "description": "Resource type"}, "resource_id": {"type": "string", "description": "Resource id"}, "status": {"type": "string", "description": "Status"}, "summary": {"type": "string", "description": "Summary"}, "impact_level": {"type": "string", "description": "Impact level"}, "estimated_cost": {"type": "number", "description": "Estimated cost"}, "region": {"type": "string", "description": "Region"}, "estimated_cost_saving": {"type": "number", "description": "Estimated cost saving"}, "optimization_type": {"type": "string", "description": "Optimization type"}, "recommended_sku": {"type": "string", "description": "Recommended SKU"}, "current_sku": {"type": "string", "description": "Current SKU"}, "savings_percentage": {"type": "string", "description": "Savings percentage"}, "estimated_cost_saving_info": {"type": "string", "description": "Estimated cost saving information"}}, "type": "object"}, "Recommendations": {"properties": {"tenant_name": {"type": "string", "description": "Tenant Name"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}, "reservation_type": {"type": "string", "description": "Reservation type"}, "reservation_sku": {"type": "string", "description": "Reservation SKU Details"}, "region": {"type": "string", "description": "Region"}, "quantity": {"type": "integer", "description": "Quantity"}, "estimated_cost_savings": {"type": "number", "description": "How much cost is saved based on recommendation suggested"}, "cloud_account_id": {"type": "string", "description": "Cloud Account ID"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "service": {"type": "string", "description": "Cloud Service"}, "info": {"type": "string", "description": "Information"}, "savings_percentage": {"type": "string", "description": "Saving Percentage"}}, "type": "object"}, "RecommendationsFilterBase": {"required": ["end_date", "service_account_ids", "start_date"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account Ids to Filter", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "query": {"description": "Query expression to filter line items.", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "specify the start date."}, "end_date": {"type": "string", "format": "date-time", "description": "specify the end date."}}, "type": "object"}, "RecommendedReservationsSavingsSummaryRequest": {"required": ["currency", "term"], "properties": {"tenant_ids": {"type": "array", "items": {"type": "string", "description": "Please provide one or more tenant IDs"}}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "services": {"type": "array", "items": {"type": "string", "description": "List of cloud providers.", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "term": {"type": "string", "description": "Year, it can be OneYear or ThreeYears.", "default": "OneYear", "example": "OneYear", "enum": ["OneYear", "ThreeYears"], "x-cs-enum-type": "PaymentTerms"}, "payment_option": {"type": "string", "description": "Select a payment option, it can be No_Upfront, Partial_Upfront or All_Upfront.", "default": "No_Upfront", "example": "No_Upfront", "enum": ["No_Upfront", "Partial_Upfront", "All_Upfront"], "x-cs-enum-type": "PaymentOptions"}}, "type": "object"}, "RecommendedReservationsSavingsSummaryResponse": {"properties": {"recommendations_count": {"type": "integer", "description": "Recommendations Count."}, "potential_cost_saving": {"type": "number", "description": "Potential Cost Saving."}, "total_reservations": {"type": "integer", "description": "Total reservations."}, "potential_current_estimated_cost": {"type": "number", "description": "Potential current estimated cost."}}, "type": "object"}, "RecordIdentity": {"properties": {"sysId": {"type": "string", "description": "Unique Identifier of the tracked item"}, "lastUpdate": {"type": "string", "format": "date-time", "description": "Last update of the tracked item"}, "table": {"type": "string", "description": "Context of the tracked item"}}, "type": "object"}, "RecordIdentityBatchRequest": {"properties": {"ids": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}, "type": "object"}, "RecoveryServiceReportReq": {"properties": {"cloud_account_id": {"type": "string", "description": "Specify the Cloud Account ID. This can be fetched from List CloudAccounts API call."}, "tenant_id": {"type": "string", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API."}}, "type": "object"}, "RecoveryServiceReportRes": {"properties": {"status": {"type": "string", "description": "status response"}, "message": {"type": "string", "description": "message response"}, "data": {"type": "object", "description": "recovery service data"}}, "type": "object"}, "RediscoverResponse": {"required": ["cloud_account"], "properties": {"cloud_account": {"type": "array", "description": "Cloud Account Details", "items": {"type": "object"}}}, "type": "object"}, "ReferenceModelList": {"required": ["visible"], "properties": {"visible": {"type": "boolean", "description": "Visible"}}, "type": "object"}, "ReferenceResponse": {"required": ["Abstracted Control URI", "Control Baseline", "Control Family", "Control Name", "Control Statement", "Services"], "properties": {"Control Baseline": {"description": "Control Baseline", "$ref": "#/definitions/ReferenceModelList"}, "Control Family": {"description": "Control Family", "$ref": "#/definitions/ReferenceModelList"}, "Control Statement": {"description": "Control Statement", "$ref": "#/definitions/ReferenceModelList"}, "Control Name": {"description": "Control Name", "$ref": "#/definitions/ReferenceModelList"}, "Abstracted Control URI": {"description": "Abstracted Control URI", "$ref": "#/definitions/ReferenceModelList"}, "Services": {"description": "Services", "$ref": "#/definitions/ReferenceModelList"}}, "type": "object"}, "RefreshTokenRequest": {"required": ["access_token"], "properties": {"access_token": {"type": "string", "description": "access token obtained from the auth token api"}}, "type": "object"}, "RefreshTokenResponse": {"required": ["access_token", "expires_at", "issued_at", "refresh_count"], "properties": {"access_token": {"type": "string", "description": "access token obtained from the auth token api"}, "issued_at": {"type": "string", "description": "Time in UTC at which the token was issued  at"}, "expires_at": {"type": "string", "description": "Time in UTC till which the token will be valid till"}, "refresh_count": {"type": "integer", "description": "The count of refresh token used.It can be used for 3 max refresh count after which the token will expired."}}, "type": "object"}, "Regex": {"required": ["pattern"], "properties": {"pattern": {"type": "string", "description": "Regex pattern to match against"}, "ignore_case": {"type": "boolean", "description": "Ignore case when matching"}, "op": {"type": "string", "description": "Type of pattern matching operation", "example": "Contains", "enum": ["Contains", "NotContains", "StartsWith"], "x-cs-enum-type": "RegexQueryCondition"}}, "type": "object"}, "ReleaseFlag": {"allOf": [{"$ref": "#/definitions/FeatureFlagBase"}, {"properties": {"release_prefix": {"type": "string", "description": "The release flag's prefix value", "example": "RELEASE", "enum": ["RELEASE"], "x-cs-enum-type": "ReleasePrefix"}, "release_id": {"type": "string", "description": "Release id to be controlled"}}, "type": "object"}], "x-cs-type-name": "ReleaseFlag"}, "ReleaseFlagRequest": {"allOf": [{"$ref": "#/definitions/FeatureFlagRequestBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ReleaseFlagRequest"}, "ReleaseFlagsWithDefaults": {"properties": {"release_2504": {"type": "boolean", "description": "Flag's default value", "default": false}, "release_2601": {"type": "boolean", "description": "Flag's default value", "default": true}, "release_2602": {"type": "boolean", "description": "Flag's default value", "default": true}, "release_2603": {"type": "boolean", "description": "Flag's default value", "default": true}}, "type": "object"}, "ReportConfiguration": {"required": ["__type"], "properties": {"export_format": {"type": "string", "description": "Specifies the format of the file being exported.", "default": "PDF", "example": "PDF", "enum": ["PDF", "CSV"], "x-cs-enum-type": "ExportFormat"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ReportConfigurationForAiAgent", "subtype_name": "ReportConfigurationForAiAgent"}, {"subtype_model": "BaseReportConfigurationForAssessmentAgent", "subtype_name": "BaseReportConfigurationForAssessmentAgent"}, {"subtype_model": "ReportConfigurationForAssessment", "subtype_name": "ReportConfigurationForAssessment"}, {"subtype_model": "ReportConfigurationForWorkload", "subtype_name": "ReportConfigurationForWorkload"}, {"subtype_model": "ReportConfigurationForExecutiveDashboard", "subtype_name": "ReportConfigurationForExecutiveDashboard"}, {"subtype_model": "ConfigurationForNextGenReportBase", "subtype_name": "ConfigurationForNextGenReportBase"}, {"subtype_model": "ConfigurationForFinOpsConsolidatedReport", "subtype_name": "ConfigurationForFinOpsConsolidatedReport"}, {"subtype_model": "ConfigurationForAwsConsolidatedChargesReport", "subtype_name": "ConfigurationForAwsConsolidatedChargesReport"}, {"subtype_model": "ConfigurationForAzureConsolidatedChargesReport", "subtype_name": "ConfigurationForAzureConsolidatedChargesReport"}, {"subtype_model": "ConfigurationForGcpConsolidatedChargesReport", "subtype_name": "ConfigurationForGcpConsolidatedChargesReport"}, {"subtype_model": "ConfigurationForOciConsolidatedChargesReport", "subtype_name": "ConfigurationForOciConsolidatedChargesReport"}, {"subtype_model": "ConfigurationForDistributorConsolidatedReport", "subtype_name": "ConfigurationForDistributorConsolidatedReport"}, {"subtype_model": "ReportConfigurationForAssessmentRun", "subtype_name": "ReportConfigurationForAssessmentRun"}, {"subtype_model": "ReportConfigurationForAssessmentRunDetail", "subtype_name": "ReportConfigurationForAssessmentRunDetail"}, {"subtype_model": "ReportConfigurationForAssessmentRunSummary", "subtype_name": "ReportConfigurationForAssessmentRunSummary"}, {"subtype_model": "ReportConfigurationForAssessmentRunViolation", "subtype_name": "ReportConfigurationForAssessmentRunViolation"}]}, "ReportConfigurationForAiAgent": {"allOf": [{"$ref": "#/definitions/ReportConfiguration"}, {"required": ["agent_id"], "properties": {"agent_id": {"type": "string", "description": "Id of the Agent.", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "ReportConfigurationForAiAgent"}, "ReportConfigurationForAssessment": {"allOf": [{"$ref": "#/definitions/BaseReportConfigurationForAssessmentAgent"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ReportConfigurationForAssessment"}, "ReportConfigurationForAssessmentRun": {"allOf": [{"$ref": "#/definitions/ReportConfiguration"}, {"required": ["assessment_run", "framework_id"], "properties": {"assessment_run": {"description": "The Assessment Run this report is for", "$ref": "#/definitions/RecordIdentity"}, "framework_id": {"type": "string", "description": "Identity of the Framework"}, "filter_model": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "ReportConfigurationForAssessmentRun"}, "ReportConfigurationForAssessmentRunDetail": {"allOf": [{"$ref": "#/definitions/ReportConfigurationForAssessmentRun"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ReportConfigurationForAssessmentRunDetail"}, "ReportConfigurationForAssessmentRunSummary": {"allOf": [{"$ref": "#/definitions/ReportConfigurationForAssessmentRun"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ReportConfigurationForAssessmentRunSummary"}, "ReportConfigurationForAssessmentRunViolation": {"allOf": [{"$ref": "#/definitions/ReportConfigurationForAssessmentRun"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ReportConfigurationForAssessmentRunViolation"}, "ReportConfigurationForExecutiveDashboard": {"allOf": [{"$ref": "#/definitions/ReportConfiguration"}, {"required": ["dashboard", "subscription_type"], "properties": {"dashboard": {"$ref": "#/definitions/DashboardConfiguration"}, "subscription_type": {"type": "string", "description": "Executive Dashboard Report subscription type", "example": "Dashboard", "enum": ["Dashboard", "Drilldown", "Widget"], "x-cs-enum-type": "ExecutiveDashboardReportSubscriptionType"}}, "type": "object"}], "x-cs-type-name": "ReportConfigurationForExecutiveDashboard"}, "ReportConfigurationForWorkload": {"allOf": [{"$ref": "#/definitions/BaseReportConfigurationForAssessmentAgent"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ReportConfigurationForWorkload"}, "ReportDetails": {"properties": {"report_id": {"type": "string", "description": "Id of the report"}, "views": {"type": "array", "description": "List of Views", "items": {"$ref": "#/definitions/ReportViewDetails"}}}, "type": "object"}, "ReportGenerationFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"regn_2504_a_test_flag": {"type": "boolean", "description": "Flag's default value", "default": false}}, "type": "object"}]}, "ReportGenerationOptions": {"properties": {"orientation": {"type": "string", "description": "Orientation of the report structure", "example": "Landscape", "enum": ["Landscape", "Portrait"], "x-cs-enum-type": "ReportOrientation"}, "page_size": {"type": "string", "description": "Page-size of the report structure", "example": "A4", "enum": ["A4", "A5", "LEGAL", "LETTER"], "x-cs-enum-type": "ReportPageSize"}, "header_html": {"type": "string", "description": "header-html content of the report"}, "footer_html": {"type": "string", "description": "footer-html content of the report"}, "footer_left": {"type": "string", "description": "Left aligned footer text"}, "footer_font_size": {"type": "string", "description": "footer font size"}, "footer_font_name": {"type": "string", "description": "footer font name"}, "margin_top": {"type": "string", "description": "Page top margin size"}, "margin_right": {"type": "string", "description": "Page right margin size"}, "margin_bottom": {"type": "string", "description": "Page bottom margin size"}, "margin_left": {"type": "string", "description": "Page left margin size"}, "timeout": {"type": "integer", "description": "Max time in seconds to wait for report to generate."}}, "type": "object"}, "ReportStatusResponse": {"properties": {"status": {"type": "string", "description": "Status of the report", "example": "Unknown", "enum": ["Unknown", "Queued", "Processing", "Success", "Failure"], "x-cs-enum-type": "ReportStatus"}, "failure_message": {"type": "string", "description": "Error message when report generation failed."}}, "type": "object"}, "ReportViewDetails": {"properties": {"view_name": {"type": "string", "description": "Name of the View"}, "state_id": {"type": "string", "description": "powerBI unique state id"}, "default_view": {"type": "boolean", "description": "Boolean to indicate default view"}, "created_at": {"type": "string", "format": "date-time", "description": "view created datetime"}, "updated_at": {"type": "string", "format": "date-time", "description": "view latest update datetime"}}, "type": "object"}, "ReportsFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"rept_2504_f_test_flag": {"type": "boolean", "description": "Flag's default value", "default": false}}, "type": "object"}]}, "ReportsUserViewCreateRequest": {"properties": {"report_id": {"type": "string", "description": "Id of the report"}, "view_name": {"type": "string", "description": "Name of the View"}, "state_id": {"type": "string", "description": "powerBI unique state id"}, "default_view": {"type": "boolean", "description": "default view", "default": false}}, "type": "object"}, "ReportsUserViewDeleteRequest": {"properties": {"report_id": {"type": "string", "description": "unique report id"}, "view_name": {"type": "string", "description": "name of the view"}}, "type": "object"}, "ReportsUserViewUpdateRequest": {"properties": {"report_id": {"type": "string", "description": "Id of the report"}, "view_name": {"type": "string", "description": "Name of the View"}, "state_id": {"type": "string", "description": "powerBI unique state id"}, "default_view": {"type": "boolean", "description": "default view", "default": false}}, "type": "object"}, "RepositoryDetail": {"properties": {"repository_id": {"type": "string", "description": "Unique Identifier of the Repository."}, "repository_name": {"type": "string", "description": "Unique Name of the Repository."}}, "type": "object"}, "RequestAuditBaseRequest": {"required": ["executor"], "properties": {"executor": {"type": "string", "description": "Target executor", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}}, "type": "object"}, "RequestAuditBatchRequest": {"allOf": [{"$ref": "#/definitions/ObjectIdBatchRequest"}, {"properties": {"include_profile": {"type": "boolean", "description": "Include payload details if true"}}, "type": "object"}]}, "RequestAuditBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/RequestAuditEntry"}}}, "type": "object"}, "RequestAuditCacheCounters": {"properties": {"hits": {"description": "Counter for cache hits.", "$ref": "#/definitions/RequestAuditPerformanceCounter"}, "misses": {"description": "Counter for cache misses.", "$ref": "#/definitions/RequestAuditPerformanceCounter"}, "invalidations": {"description": "Counter for cache invalidations.", "$ref": "#/definitions/RequestAuditPerformanceCounter"}}, "type": "object"}, "RequestAuditCacheFlushRequest": {"allOf": [{"$ref": "#/definitions/RequestAuditBaseRequest"}, {"properties": {}, "type": "object"}]}, "RequestAuditDescribeRequest": {"allOf": [{"$ref": "#/definitions/RequestAuditBaseRequest"}, {"properties": {}, "type": "object"}]}, "RequestAuditEndpointObservability": {"properties": {"payload": {"type": "string", "description": "Compressed request payload (zstd + base64)."}, "pool_stats": {"type": "array", "description": "MongoDB connection pool stats at request entry.", "items": {"$ref": "#/definitions/RequestAuditPoolServerStats"}}, "stages": {"description": "Stage-level timing breakdown.", "$ref": "#/definitions/RequestAuditObservabilityStages"}, "cache_key": {"type": "string", "description": "Memoization cache key (SHA-256)."}, "cache_hit": {"type": "boolean", "description": "Whether served from memoization cache."}}, "type": "object"}, "RequestAuditEndpointStatisticsRequest": {"allOf": [{"$ref": "#/definitions/RequestAuditBaseRequest"}, {"required": ["end_time", "start_time"], "properties": {"endpoint": {"type": "string", "description": "Collect statistics about this endpoint"}, "start_time": {"type": "string", "format": "date-time", "description": "Start time"}, "end_time": {"type": "string", "format": "date-time", "description": "End time"}}, "type": "object"}]}, "RequestAuditEndpointStatisticsResponse": {"properties": {"counts": {"type": "object", "description": "Number of calls for each endpoint or path.", "additionalProperties": {"type": "integer"}}}, "type": "object"}, "RequestAuditEntry": {"properties": {"executor": {"type": "string", "description": "The executor for this request", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "endpoint": {"type": "string", "description": "Request Endpoint"}, "status_code": {"type": "integer", "description": "Result of the request"}, "method": {"type": "string", "description": "Request verb"}, "path": {"type": "string", "description": "Resource path"}, "params": {"type": "object", "description": "Query parameters", "additionalProperties": {"type": "string"}}, "source_ip": {"type": "string", "description": "Source IP"}, "request_id": {"type": "string", "description": "Correlation ID"}, "user_id": {"type": "string", "description": "User ID"}, "user_name": {"type": "string", "description": "User name"}, "from_service": {"type": "string", "description": "Source service"}, "start_time": {"type": "string", "format": "date-time", "description": "Start time"}, "end_time": {"type": "string", "format": "date-time", "description": "End time"}, "duration": {"type": "number", "description": "Duration in seconds"}, "memory_end": {"type": "integer", "description": "Memory used at the end of the request"}, "memory_delta": {"type": "integer", "description": "Memory usage change during the request"}, "overlapping_requests": {"type": "integer", "description": "Number of requests that happened at the same time."}, "active_requests_at_start": {"type": "integer", "description": "Number of requests active at start."}, "active_requests_at_end": {"type": "integer", "description": "Number of requests active at end."}, "cache": {"description": "Cache performance counters.", "$ref": "#/definitions/RequestAuditCacheCounters"}, "has_profile": {"type": "boolean", "description": "Set if there's a profile associated with this request."}, "profile_html": {"type": "string", "description": "Profiler output"}, "payload": {"type": "string", "description": "Request payload."}, "observability": {"description": "Endpoint observability data. Present when observability is enabled for the endpoint.", "$ref": "#/definitions/RequestAuditEndpointObservability"}}, "type": "object"}, "RequestAuditFilter": {"properties": {"executor": {"type": "string", "description": "Limit results to requests from this executor", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "endpoint": {"type": "string", "description": "Limit results to requests to this endpoint"}, "status_code": {"type": "integer", "description": "Limit results to requests to this status code"}, "method": {"type": "string", "description": "Limit results to requests to this method"}, "path": {"type": "string", "description": "Limit results to requests to this path"}, "request_id": {"type": "string", "description": "Limit results to requests to this Correlation ID"}, "active_after": {"type": "string", "format": "date-time", "description": "Limit to requests active after this time"}, "active_before": {"type": "string", "format": "date-time", "description": "Limit to requests active before this time"}, "duration": {"type": "number", "description": "Limit to requests that took longer than this amount (it requires an activation range as well)"}, "only_with_profile": {"type": "boolean", "description": "Limit to requests that have a profile trace"}}, "type": "object"}, "RequestAuditListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/RequestAuditSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/RequestAuditFilter"}}, "type": "object"}, "RequestAuditListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "RequestAuditObservabilityStages": {"properties": {"path": {"type": "string", "description": "Code path taken within the handler."}, "timings": {"type": "object", "description": "Stage name to duration in milliseconds.", "additionalProperties": {"type": "number"}}, "total_ms": {"type": "number", "description": "Total execution time in milliseconds."}, "counters": {"type": "object", "description": "Endpoint-specific counters (e.g. doc_count, identity_count).", "additionalProperties": {"type": "integer"}}}, "type": "object"}, "RequestAuditPerformanceCounter": {"properties": {"count": {"type": "integer", "description": "Number of events."}, "execution_time": {"type": "number", "description": "Execution time in seconds."}, "wait_time": {"type": "number", "description": "Lock contention time in seconds."}}, "type": "object"}, "RequestAuditPoolServerStats": {"properties": {"address": {"type": "string", "description": "Server address (host:port)."}, "active": {"type": "integer", "description": "Connections checked out by application threads."}, "idle": {"type": "integer", "description": "Idle connections in the pool."}, "waiting": {"type": "integer", "description": "Threads waiting for a connection."}}, "type": "object"}, "RequestAuditProfileAutoTrigger": {"allOf": [{"$ref": "#/definitions/RequestAuditBaseRequest"}, {"properties": {"activations": {"type": "integer", "description": "Number of activations for each auto trigger run."}, "execution_time_threshold": {"type": "number", "description": "Trigger profiling only for requests that take longer than this time."}, "backoff_time": {"type": "number", "description": "Number of seconds to wait before re-enabling auto trigger."}}, "type": "object"}]}, "RequestAuditProfileDescribeRequest": {"allOf": [{"$ref": "#/definitions/RequestAuditBaseRequest"}, {"properties": {}, "type": "object"}]}, "RequestAuditProfileRequest": {"allOf": [{"$ref": "#/definitions/RequestAuditBaseRequest"}, {"properties": {"endpoint": {"type": "string", "description": "Target endpoint"}, "path": {"type": "string", "description": "Target resource path"}, "activations": {"type": "integer", "description": "Number of activations."}, "execution_time_threshold": {"type": "number", "description": "Only log profiles that take longer than this time."}}, "type": "object"}]}, "RequestAuditProfileStatus": {"properties": {"executor": {"type": "string", "description": "Target executor", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "endpoint": {"type": "string", "description": "Target endpoint"}, "path": {"type": "string", "description": "Target resource path"}, "activations": {"type": "integer", "description": "Number of activations."}, "execution_time_threshold": {"type": "number", "description": "Only log profiles that take longer than this time."}}, "type": "object"}, "RequestAuditSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Endpoint", "enum": ["Endpoint", "Path", "StartTime", "EndTime", "Duration", "MemoryIncrease"], "x-cs-enum-type": "RequestAuditSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ResendTokenResponse": {"required": ["user_id"], "properties": {"user_id": {"type": "string", "description": "user id"}}, "type": "object"}, "ReservationDetails": {"required": ["cloud_account_id", "cloud_account_name", "expiry_date", "payment_option", "region", "reservation_id", "reservation_sku", "ri_hours_used", "tenant_name", "utilization_percentage"], "properties": {"tenant_name": {"type": "string", "description": "Tenant Name"}, "tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "reservation_id": {"type": "string", "description": "Reservation Id"}, "payment_option": {"type": "string", "description": "What is the payment option"}, "ri_hours_used": {"type": "string", "description": "RI hours being used"}, "expiry_date": {"type": "string", "description": "Date of expiry"}, "reservation_sku": {"type": "string", "description": "Reservation SKU Details"}, "region": {"type": "string", "description": "Region"}, "cloud_account_name": {"type": "string", "description": "Cloud Account Name"}, "cloud_account_id": {"type": "string", "description": "Cloud Account Id"}, "utilization_percentage": {"type": "string", "description": "Utilization by percentage"}}, "type": "object"}, "ResetPasswordRequest": {"required": ["email_id", "url"], "properties": {"email_id": {"type": "string", "description": "User email id."}, "url": {"type": "string", "description": "Please Provide the URl"}}, "type": "object"}, "ResetPasswordResponse": {"properties": {"status": {"type": "string", "description": "Status of Reset Password API call."}, "message": {"type": "string", "description": "Message of reset Password API call."}, "data": {"type": "string", "description": "Link for Reset Password"}}, "type": "object"}, "ResolveCostSavingsRecommendationsRequest": {"required": ["action_name", "resources"], "properties": {"action_name": {"type": "string", "description": "Action to be applied to resolve the recommendation", "example": "remediate_now", "enum": ["remediate_now", "submit_for_approval", "schedule", "reject_it"], "x-cs-enum-type": "ResolveCostSavingsRecommendationsAction"}, "resources": {"type": "array", "description": "Resource Id to which the recommendation should be applied. Can be fetched from 'CostSavingViewRecommendation' api.", "items": {"type": "string"}}}, "type": "object"}, "ResolveDefRecommendationsRequest": {"required": ["action_name", "resources"], "properties": {"action_name": {"type": "string", "description": "Action Name to resolve the recommendation"}, "resources": {"type": "array", "description": "Specify the Resource IDs. It will be fetched from list recommendation api", "items": {"type": "string"}}}, "type": "object"}, "ResolveRecommendationsRequest": {"required": ["action_name", "apply_for_all", "resources"], "properties": {"action_name": {"type": "string", "description": "Action Name to resolve the recommendation"}, "resources": {"type": "array", "description": "Resource ID", "items": {"type": "string"}}, "apply_for_all": {"type": "boolean", "description": "Apply for all the resources.Allowed Values true or false"}, "args": {"type": "object", "description": "arguments to resolve action"}}, "type": "object"}, "ResourceByProductCategoryWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["resourceSelection"], "properties": {"resourceSelection": {"type": "string", "description": "Type of Resources", "example": "Tagged", "enum": ["Tagged", "Untagged"], "x-cs-enum-type": "ResourceSelection"}}, "type": "object"}], "x-cs-type-name": "ResourceByProductCategoryWidgetConfiguration"}, "ResourceCatalogAttributeDataModel": {"required": ["cost", "name", "resource", "resource_id"], "properties": {"DiskSize": {"type": "string", "description": "Disk size", "example": "32", "enum": ["32", "64", "128", "256", "512", "1024", "2048", "4096", "8192", "16384", "32767"], "x-cs-enum-type": "DiskSize"}, "disk_type": {"type": "string", "description": "Disk type", "example": "Premium SSD", "enum": ["Premium SSD", "Standard HDD", "Standard SSD"], "x-cs-enum-type": "DiskType"}, "cost": {"description": "Cost attribute.", "$ref": "#/definitions/ResourceCatalogCostDataModel"}, "name": {"type": "string", "description": "Cloud account catalog name."}, "resource": {"type": "string", "description": "Specify the resource, This can be retrieved using the List Resource Catalog API"}, "resource_id": {"type": "string", "description": "Specify the resource_id, This can be retrieved using the List Resource Catalog API"}}, "type": "object"}, "ResourceCatalogCostDataModel": {"required": ["value"], "properties": {"value": {"type": "integer", "description": "Cloud account resource cost. for example, 0.1, 10, etc"}}, "type": "object"}, "ResourceCatalogCreateDataModel": {"required": ["data", "message"], "properties": {"message": {"type": "string", "description": "Resource created"}, "data": {"type": "string", "description": "Catalog Id"}}, "type": "object"}, "ResourceCatalogGetDataModel": {"required": ["data"], "properties": {"data": {"type": "object", "description": "Resource Data"}}, "type": "object"}, "ResourceCatalogServiceLevelDataModel": {"required": ["classification", "name", "resource", "resource_attributes", "resource_type", "scope", "service_account", "service_levels"], "properties": {"classification": {"type": "string", "description": "Account classification is by default its 'default'. for example, default"}, "name": {"type": "string", "description": "Cloud account catalog name."}, "resource": {"type": "string", "description": "Specify the resource, This can be retrieved using the List Resource Catalog API"}, "resource_attributes": {"description": "Resource attributes includes.", "$ref": "#/definitions/ResourceCatalogAttributeDataModel"}, "resource_type": {"type": "string", "description": "Cloud account resource type. for example, disk_sku"}, "scope": {"type": "string", "description": "Cloud account scope . for example, tenant, private, etc"}, "service_account": {"type": "string", "description": "Cloud service account id . for example, '60xxxxxxxxxxxxxxxxxxxxxxxx0b'"}, "service_levels": {"type": "array", "description": "Update Activity Request Body. Example:[\"gold, silver, bronze, iron\"]", "items": {"type": "string"}}, "tenant_info": {"description": "tenants information.", "$ref": "#/definitions/ResourceCatalogTenantDataModel"}}, "type": "object"}, "ResourceCatalogTenantDataModel": {"properties": {"location": {"type": "string", "description": "Location.for example, /subscriptions/subscription_id->'eg:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'/location/location->'eg:northeurope"}, "resourcegroup": {"type": "string", "description": "Resource group. for example, /subscriptions/subscription_id->'eg:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'/resourceGroups/rg_name->'eg:default_rg"}}, "type": "object"}, "ResourceCategoryQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_categories"], "properties": {"resource_categories": {"type": "array", "description": "Resource categories to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceCategoryQueryOperator"}, "ResourceCategoryRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_category"], "properties": {"resource_category": {"description": "Include response that has the given resource_category", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ResourceCategoryRegexQueryOperator"}, "ResourceCount": {"required": ["open"], "properties": {"open": {"type": "integer", "description": "The resources that are open based on the recommendation"}}, "type": "object"}, "ResourceCountByAccount": {"required": ["open"], "properties": {"open": {"type": "integer", "description": "Resource count that are open"}}, "type": "object"}, "ResourceCountByCategory": {"required": ["open"], "properties": {"open": {"type": "integer", "description": "Resource count that are open"}}, "type": "object"}, "ResourceCountTenant": {"required": ["open"], "properties": {"open": {"type": "integer", "description": "The resources that are open based on the recommendation"}}, "type": "object"}, "ResourceDetails": {"required": ["id", "name"], "properties": {"id": {"type": "string", "description": "ID of that Template/Script/Policy that is scheduled to run"}, "name": {"type": "string", "description": "Name of the Template/Script/Policy that is scheduled to run"}}, "type": "object"}, "ResourceDetailsOverview": {"properties": {"cpu": {"type": "array", "description": "Resource Details By CPU", "items": {"$ref": "#/definitions/ResourceRecord"}}, "memory": {"type": "array", "description": "Resource Details by Memory", "items": {"$ref": "#/definitions/ResourceRecord"}}}, "type": "object"}, "ResourceFilterModel": {"required": ["id", "name"], "properties": {"id": {"type": "string", "description": "ID of resource filter"}, "name": {"type": "string", "description": "Name of resource filter"}}, "type": "object"}, "ResourceGroupDetailsBase": {"required": ["type"], "properties": {"resource_group_id": {"type": "string", "description": "Unique Id"}, "name": {"type": "string", "description": "Display Name"}, "description": {"type": "string", "description": "Description"}}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ResourceGroupDetailsForAws", "subtype_name": "ResourceGroupDetailsForAws"}, {"subtype_model": "ResourceGroupDetailsForAzure", "subtype_name": "ResourceGroupDetailsForAzure"}]}, "ResourceGroupDetailsForAws": {"allOf": [{"$ref": "#/definitions/ResourceGroupDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ResourceGroupDetailsForAws"}, "ResourceGroupDetailsForAzure": {"allOf": [{"$ref": "#/definitions/ResourceGroupDetailsBase"}, {"properties": {"location": {"type": "string", "description": "Location of resource group, if any."}}, "type": "object"}], "x-cs-type-name": "ResourceGroupDetailsForAzure"}, "ResourceGroupQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_groups"], "properties": {"resource_groups": {"type": "array", "description": "Resourcegroups to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceGroupQueryOperator"}, "ResourceGroupRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_group"], "properties": {"resource_group": {"description": "Include response that has the given resource_group", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ResourceGroupRegexQueryOperator"}, "ResourceIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_ids"], "properties": {"resource_ids": {"type": "array", "description": "Resource IDs to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceIdQueryOperator"}, "ResourceIdRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_id_regex"], "properties": {"resource_id_regex": {"description": "Resource ID by regex match", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ResourceIdRegexQueryOperator"}, "ResourceInventoryFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"rein_2504_a_test_flag": {"type": "boolean", "description": "Flag's default value", "default": false}, "rein_2601_b_resource_changes_trend": {"type": "boolean", "description": "Flag's default value", "default": true}, "rein_2602_a_resource_detail_view": {"type": "boolean", "description": "Flag's default value", "default": true}}, "type": "object"}]}, "ResourceLevelUtilizationAggregate": {"properties": {"resource_id": {"type": "string", "description": "Unique Id of the resource for which utilization detail is being shown."}, "service_account_id": {"type": "string", "description": "Id of the service account to which the resource belongs to.", "x-cs-type": "ObjectId"}, "platform": {"type": "string", "description": "Name of the os for the instance or vm."}, "resource_name": {"type": "string", "description": "Name of the resource for which utilization detail is being shown."}, "metric_data": {"$ref": "#/definitions/KpiMetricAggregate"}}, "type": "object"}, "ResourceListingRequest": {"required": ["action", "cloud", "cloud_account_id", "cloud_type"], "properties": {"cloud_type": {"type": "string", "description": "Service Type like cloud"}, "cloud": {"type": "string", "description": "Type of cloud from cloud provider like AWS/Azure", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "region": {"type": "string", "description": "The region of the cloud account where it needs to be executed mandatory for AWS"}, "cloud_account_id": {"type": "string", "description": "Specify the Cloud account ID. This is a unique ID and can be retrieved from the List Cloud Account API."}, "resource_group": {"type": "string", "description": "Resource groups preferred by the user in that particular Azure account."}, "location": {"type": "string", "description": "Provide the location. Based on the action"}, "action": {"type": "string", "description": "Provide the action name. Example: virtual_network.list_virtual_network"}}, "type": "object"}, "ResourceListingResponse": {"properties": {"id": {"type": "string", "description": "Id of the resources"}, "name": {"type": "string", "description": "Name of the resource"}}, "type": "object"}, "ResourceMetricHierarchyRequest": {"required": ["service", "template_uri"], "properties": {"template_uri": {"type": "string", "description": "Template URI"}, "service": {"type": "string", "description": "Cloud Service Name", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "type": "object"}, "ResourceMetricHierarchyResponse": {"required": ["data", "message"], "properties": {"message": {"type": "string", "description": "Message of Resource Metric Hierarchy"}, "data": {"type": "object", "description": "Resource Metric Hierarchy Listing"}}, "type": "object"}, "ResourceNameQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_names"], "properties": {"resource_names": {"type": "array", "description": "Resource names to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceNameQueryOperator"}, "ResourceNameRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_name_regex"], "properties": {"resource_name_regex": {"description": "Resource name by regex match", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ResourceNameRegexQueryOperator"}, "ResourceOperationQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_operations"], "properties": {"resource_operations": {"type": "array", "description": "Resource operations to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceOperationQueryOperator"}, "ResourceOperationRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_operation"], "properties": {"resource_operation": {"description": "Include response that has the given resource_operation pattern", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ResourceOperationRegexQueryOperator"}, "ResourcePostureResponse": {"required": ["cloud_account_data", "cloud_data", "tenants", "total_count"], "properties": {"total_count": {"type": "integer", "description": "count details"}, "tenants": {"type": "array", "description": "List of tenant data", "items": {"$ref": "#/definitions/PostureTenantModel"}}, "cloud_data": {"type": "array", "description": "List of cloud data", "items": {"$ref": "#/definitions/PostureCloudModel"}}, "cloud_account_data": {"type": "array", "description": "List of cloud account data", "items": {"$ref": "#/definitions/PostureCloudDataModel"}}}, "type": "object"}, "ResourceQueryCategory": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["categories"], "properties": {"categories": {"type": "array", "description": "Categories for the resources", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceQueryCategory"}, "ResourceQueryExtraKey": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["extra_keys"], "properties": {"extra_keys": {"type": "array", "description": "Extra keys for the resources", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceQueryExtraKey"}, "ResourceQueryExtraKeyValue": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["extra_key", "extra_values"], "properties": {"extra_key": {"type": "string", "description": "Extra key for the given resources"}, "extra_values": {"type": "array", "description": "Extra values for the given key", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceQueryExtraKeyValue"}, "ResourceQueryExtraPresence": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["has_extras"], "properties": {"has_extras": {"type": "boolean", "description": "Matches against resources with or without extra dimensions"}}, "type": "object"}], "x-cs-type-name": "ResourceQueryExtraPresence"}, "ResourceQueryFieldPresence": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["field", "has_field"], "properties": {"field": {"type": "string", "description": "Field to match.", "example": "availability_zone", "enum": ["availability_zone", "billing_entity", "meter_sub_category", "pricing_category", "pricing_purchase_option", "product_category", "product_family", "product_service_code", "product_sku", "publisher", "resource_category", "resource_group", "resource_id", "resource_name", "resource_operation"], "x-cs-enum-type": "BillingLineItemsOptionalFields"}, "has_field": {"type": "boolean", "description": "Matches against resources with or without the given field"}}, "type": "object"}], "x-cs-type-name": "ResourceQueryFieldPresence"}, "ResourceQueryLocation": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["regions"], "properties": {"regions": {"type": "array", "description": "Regions for the resources", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceQueryLocation"}, "ResourceQueryResource": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resources"], "properties": {"resources": {"type": "array", "description": "Resource fields for the resources", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceQueryResource"}, "ResourceQueryResourceGroup": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_groups"], "properties": {"resource_groups": {"type": "array", "description": "Group to which the resource belongs to.", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceQueryResourceGroup"}, "ResourceQueryResourceName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["starts_with"], "properties": {"starts_with": {"type": "string", "description": "Matches against the start of a resource name"}}, "type": "object"}], "x-cs-type-name": "ResourceQueryResourceName"}, "ResourceQueryResourceType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_types"], "properties": {"resource_types": {"type": "array", "description": "Resource Type for the resources", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceQueryResourceType"}, "ResourceQueryTagKey": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_keys"], "properties": {"tag_keys": {"type": "array", "description": "Tag key for the given resources", "items": {"type": "string"}}, "tag_kind": {"type": "string", "description": "Tag kind if applicable"}}, "type": "object"}], "x-cs-type-name": "ResourceQueryTagKey"}, "ResourceQueryTagKeyKind": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key", "tag_kind"], "properties": {"tag_key": {"type": "string", "description": "Tag key for the given resources"}, "tag_kind": {"type": "string", "description": "Tag kind for the given key"}}, "type": "object"}], "x-cs-type-name": "ResourceQueryTagKeyKind"}, "ResourceQueryTagKeyValue": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key", "tag_values"], "properties": {"tag_key": {"type": "string", "description": "Tag key for the given resources"}, "tag_values": {"type": "array", "description": "Tag values for the given key", "items": {"type": "string"}}, "tag_kind": {"type": "string", "description": "Tag kind if applicable"}}, "type": "object"}], "x-cs-type-name": "ResourceQueryTagKeyValue"}, "ResourceQueryTagKeyValuesKind": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key", "tag_kind", "tag_values"], "properties": {"tag_key": {"type": "string", "description": "Tag key for the given resources"}, "tag_kind": {"type": "string", "description": "Tag kind for the given key"}, "tag_values": {"type": "array", "description": "Tag values for the given key", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceQueryTagKeyValuesKind"}, "ResourceQueryTagPresence": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["has_tags"], "properties": {"has_tags": {"type": "boolean", "description": "Matches against resources with or without tags"}}, "type": "object"}], "x-cs-type-name": "ResourceQueryTagPresence"}, "ResourceRecommendationDetailsRequest": {"required": ["policy_id", "resource_ids", "service_account_id"], "properties": {"resource_ids": {"type": "array", "description": "List of resource IDs to get the resource recommendations.", "items": {"type": "string"}}, "service_account_id": {"type": "string", "description": "Service account ID to filter the resource recommendations.", "x-cs-type": "ObjectId"}, "policy_id": {"type": "string", "description": "Policy ID to filter the resource recommendations.", "x-cs-type": "ObjectId"}}, "type": "object"}, "ResourceRecommendationExtras": {"properties": {"audits": {"$ref": "#/definitions/RecommendationAudits"}, "recommendation_id": {"type": "string", "description": "recommendation_id", "x-cs-type": "ObjectId"}, "is_preidentified": {"type": "boolean", "description": "Boolean to describe the recommendation is preidentified or not"}, "utilization_metrics": {"type": "array", "items": {"$ref": "#/definitions/UtilizationMetricsForRecommendation"}}, "touched_at": {"type": "string", "format": "date-time", "description": "Document updated Time"}, "additional_resource_details": {"$ref": "#/definitions/AdditionalResourceDetailsBase"}}, "type": "object"}, "ResourceRecommendationITSMEvent": {"properties": {"service": {"type": "string", "description": "Name of the integrated ITSM service where the event was raised (e.g. ServiceNow, Jira)", "example": "Anomaly_Detector", "enum": ["Anomaly_Detector", "AppDynamics", "App_Insights", "ArrowSphere", "Azure_Devops", "Azure_Security_Graph", "Azure_Sentinel", "Corestack", "DockerHub", "ElasticSearch", "Freshservice", "GitHub", "JIRA_DataCenter", "JIRA_ServiceDesk", "JIRA_ServiceManagement", "Jenkins", "Logstash", "Microsoft_Teams", "Nagios", "Newrelic", "Prometheus", "Qualys", "RedHat_Satellite", "ServiceNow", "TCL_ITSM", "Tenable_Nessus", "ZOHO_ServiceDesk", "Zabbix"], "x-cs-enum-type": "IntegratedToolName"}, "service_account_id": {"type": "string", "description": "Service account ID associated with the ITSM integration", "x-cs-type": "ObjectId"}, "event_type": {"type": "string", "description": "Type of ITSM event raised for the remediation (e.g. incident creation)"}, "status": {"type": "string", "description": "Status of the ITSM event raised for the remediation (e.g. success, failure)", "example": "success", "enum": ["success", "failed"], "x-cs-enum-type": "ITSMEventStatus"}, "incident_id": {"type": "string", "description": "Incident number created in the integrated ITSM tool for the resource"}}, "type": "object"}, "ResourceRecommendationModel": {"required": ["resource_id", "resource_name", "resource_recommendation_id", "resource_type", "resourcegroup_location", "status"], "properties": {"resource_recommendation_id": {"type": "string", "description": "unique identifier for resource recommendation"}, "resource_id": {"type": "string", "description": " Resource identifier id of resource recommendation"}, "resource_name": {"type": "string", "description": "Resource identifier name of resource recommendation"}, "resource_type": {"type": "string", "description": "Type of resource"}, "resourcegroup_location": {"type": "string", "description": "resource group location"}, "status": {"type": "string", "description": "Status of resource recommendation"}}, "type": "object"}, "ResourceRecommendationResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/ResourceRecommendationsBatchResponse"}}}, "type": "object"}, "ResourceRecommendationSkippedDetails": {"properties": {"action": {"type": "string", "description": "Action name for skipped resource"}, "id": {"type": "string", "description": "ID from where the resource is being skipped."}}, "type": "object"}, "ResourceRecommendationsBatchResponse": {"properties": {"cost_saving_details": {"description": "Cost saving details for the resource", "$ref": "#/definitions/CostSavingResourceDetails"}, "service_account_id": {"type": "string", "description": "Service account id for the resource", "x-cs-type": "ObjectId"}, "recommendation_id": {"type": "string", "description": "Recommendation ID", "x-cs-type": "ObjectId"}, "region": {"type": "string", "description": "Impacted Resource Region"}, "resource": {"type": "string", "description": "Resource type for the impacted resource"}, "resource_category": {"type": "string", "description": "Resource Category for the impacted resource"}, "resource_group": {"type": "string", "description": "Resource Group for the impacted resource"}, "resource_id": {"type": "string", "description": "Impacted Resource ID"}, "resource_name": {"type": "string", "description": "Impacted Resource Name"}, "resource_type": {"type": "string", "description": "Resource Type for the impacted resource"}, "policy_id": {"type": "string", "description": "Policy ID for which the resource recommendation is generated"}, "policy_name": {"type": "string", "description": "Display Name of the policy"}, "policy_job_id": {"type": "string", "description": "Unique ID of the policy execution job (run) that generated this resource recommendation"}, "status": {"type": "string", "description": "Status of the policy resource recommendation", "example": "error", "enum": ["error", "in_progress", "open", "resolved", "skipped", "system_skipped"], "x-cs-enum-type": "PolicyResourceRecommendationStatus"}, "remediation_action_details": {"type": "array", "description": "Details of the remediation actions triggered for the resource (template action, execution job and status)", "items": {"$ref": "#/definitions/ResourceRemediationActionDetails"}}, "itsm_action_details": {"type": "array", "description": "ITSM integration events raised as part of the remediation (e.g. incidents created in the integrated ITSM tool)", "items": {"$ref": "#/definitions/ResourceRecommendationITSMEvent"}}, "impact": {"type": "string", "description": "Impact of the policy resource recommendation", "example": "critical", "enum": ["critical", "high", "informational", "low", "medium", "uncategorized"], "x-cs-enum-type": "PolicyResourceRecommendationImpact"}, "skipped_by": {"$ref": "#/definitions/ResourceRecommendationSkippedDetails"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "ResourceRecommendationsSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "resource_id", "enum": ["resource_id", "resource_name", "resource_type", "resource_category", "resource"], "x-cs-enum-type": "ResourceRecommendationsSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ResourceRecord": {"properties": {"name": {"type": "string", "description": "Name of Resource Property"}, "value": {"type": "string", "description": "Value of Property"}}, "type": "object"}, "ResourceRemediationActionDetails": {"properties": {"action_name": {"type": "string", "description": "Name of the remediation action triggered for the resource"}, "job_id": {"type": "string", "description": "Unique ID of the remediation job triggered for the resource"}, "auto_triggered": {"type": "boolean", "description": "Indicates whether the remediation was triggered automatically (true) or manually by a user (false)"}, "status_reason": {"type": "string", "description": "Reason explaining the current status of the remediation action"}}, "type": "object"}, "ResourceRequest": {"required": ["action", "execution_type", "id", "name", "param_mapper", "type"], "properties": {"execution_type": {"type": "string", "description": "Indicates whether this template/script will be executed immediately on executing the blueprint or will be scheduled for  one/more occurrences", "example": "on_demand", "enum": ["on_demand", "scheduled"], "x-cs-enum-type": "ExecutionType"}, "action": {"type": "string", "description": "A short name that represents the action performed by the template. Useful while viewing the job output while executing the blueprint."}, "name": {"type": "string", "description": "Resource Name"}, "param_mapper": {"type": "object", "description": "mapping of input parameter for this template to the output parameter of any of the previous templates"}, "type": {"type": "string", "description": "Type for the blueprint", "example": "template", "enum": ["template", "script"], "x-cs-enum-type": "BlueprintType"}, "id": {"type": "string", "description": "Object Id of the Template or Script. You can get this from Describe Template/Script call"}}, "type": "object"}, "ResourceTypeQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_types"], "properties": {"resource_types": {"type": "array", "description": "resource types to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ResourceTypeQueryOperator"}, "ResourceUnitPriceCheapestSkuRequest": {"properties": {"service_account_id": {"type": "string", "description": "ID of the service account", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Id of the resource"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "ResourceUnitPriceCheapestSkuResponse": {"properties": {"daily_cost": {"type": "number", "description": "Daily cost value"}}, "type": "object"}, "ResourceUnitPriceRequest": {"properties": {"service_account_id": {"type": "string", "description": "ID of the service account", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Id of the resource"}, "resource_type": {"type": "string", "description": "Type of the resource"}}, "type": "object"}, "ResourceUnitPriceResponse": {"properties": {"key": {"type": "string", "description": "Id of the resource"}, "price": {"type": "number", "description": "Price for the resource"}, "unit": {"type": "string", "description": "Unit value for the resource"}}, "type": "object"}, "ResourceUtilizationMetric": {"properties": {"unit": {"type": "string", "description": "Unit of the metric"}, "metric_name": {"type": "string", "description": "Name of the metric"}, "timeseries": {"type": "array", "items": {"$ref": "#/definitions/TimeSeriesPoint"}}}, "type": "object"}, "ResourceUtilizationOverview": {"properties": {"from_time": {"type": "integer", "description": "Utilization Start Hour Of Day (0-23)"}, "to_time": {"type": "integer", "description": "Utilization End Hour Of Day (0-23)"}, "day": {"type": "string", "example": "MONDAY", "enum": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"], "x-cs-enum-type": "DayOfWeek"}, "utilization": {"type": "string", "description": "Schedule Recommendation Utilization", "example": "LOW", "enum": ["LOW", "MEDIUM", "HIGH"], "x-cs-enum-type": "ScheduleRecommendationUtilization"}}, "type": "object"}, "ResourceUtilizationSummary": {"properties": {"from_time": {"type": "integer", "description": "Utilization Start Hour Of Day (0-23)"}, "day": {"type": "string", "example": "MONDAY", "enum": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"], "x-cs-enum-type": "DayOfWeek"}, "utilization": {"type": "number", "description": "Utilization Value"}}, "type": "object"}, "ResourceViewDetails": {"required": ["resource_details"], "properties": {"resource_details": {"type": "array", "description": "Template/Scripts/Policies Details that is scheduled to run", "items": {"$ref": "#/definitions/ResourceDetails"}}}, "type": "object"}, "ResourceVisibilityListResponse": {"required": ["resource_list_data", "total_count"], "properties": {"total_count": {"type": "integer", "description": "count details"}, "resource_list_data": {"type": "array", "description": "List of account wise count data", "items": {"$ref": "#/definitions/PostureResourceListModel"}}}, "type": "object"}, "ResourceVisibilityResponse": {"required": ["account_wise_count", "category_wise_count", "last_sync_time", "region_wise_count", "resource_group_wise_count", "resource_wise_count"], "properties": {"last_sync_time": {"type": "string", "description": "last sync time"}, "account_wise_count": {"type": "array", "description": "List of account wise count data", "items": {"$ref": "#/definitions/PostureAccountModel"}}, "resource_wise_count": {"type": "array", "description": "List of resource wise count data", "items": {"$ref": "#/definitions/PostureResourceModel"}}, "region_wise_count": {"type": "array", "description": "List of region wise count data", "items": {"$ref": "#/definitions/PostureRegionModel"}}, "resource_group_wise_count": {"type": "array", "description": "List of resource group wise data", "items": {"$ref": "#/definitions/PostureResourceGroupModel"}}, "category_wise_count": {"type": "array", "description": "List of category wise data", "items": {"$ref": "#/definitions/PostureCategoryModel"}}}, "type": "object"}, "ResourcesDetails": {"required": ["action", "execution_type", "id", "name", "param_mapper"], "properties": {"param_mapper": {"type": "object", "description": "Mapping of input parameter for this template to the output parameter of any of the previous templates"}, "execution_type": {"type": "string", "description": "Can be \u201con_demand\u201d or \u201cscheduled\u201d. Indicates whether this template/script will be executed immediately on executing the blueprint or will be scheduled for one/more occurrences"}, "action": {"type": "string", "description": "A short name that represents the action performed by the template. Useful while viewing the job output while executing the blueprint"}, "name": {"type": "string", "description": "Resource Name"}, "id": {"type": "string", "description": "Resource ID"}}, "type": "object"}, "ResponseForAgentActionForm": {"allOf": [{"$ref": "#/definitions/BaseForAgentResponse"}, {"required": ["action_id", "form_type"], "properties": {"action_id": {"type": "string", "description": "PendingAction document ID"}, "form_type": {"type": "string", "description": "Registered action form type key"}, "title": {"type": "string", "description": "Form title shown in UI"}, "summary": {"type": "string", "description": "Short description shown below title"}, "warning": {"type": "string", "description": "Destructive-action warning; null if safe"}, "fields": {"type": "array", "description": "User-editable input fields", "items": {"$ref": "#/definitions/ActionFormField"}}, "task_list": {"type": "array", "description": "Per-task status items (policy execute only)", "items": {"type": "object"}}, "sections": {"type": "array", "description": "Visual groupings for fields", "items": {"$ref": "#/definitions/ActionFormSection"}}, "payload_preview": {"type": "object", "description": "Pre-computed execution payload from build_form()"}}, "type": "object"}], "x-cs-type-name": "ActionForm"}, "ResponseForAgentChart": {"allOf": [{"$ref": "#/definitions/BaseForAgentResponse"}, {"properties": {"value": {"description": "Chat response", "$ref": "#/definitions/AgentChartData"}}, "type": "object"}], "x-cs-type-name": "Chart"}, "ResponseForAgentLimitation": {"allOf": [{"$ref": "#/definitions/BaseForAgentResponse"}, {"properties": {"value": {"type": "array", "description": "Limitation response", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "Limitation"}, "ResponseForAgentTable": {"allOf": [{"$ref": "#/definitions/BaseForAgentResponse"}, {"properties": {"value": {"description": "Table response", "$ref": "#/definitions/AgentTableData"}}, "type": "object"}], "x-cs-type-name": "Table"}, "ResponseForAgentText": {"allOf": [{"$ref": "#/definitions/BaseForAgentResponse"}, {"properties": {"value": {"type": "string", "description": "Text response"}}, "type": "object"}], "x-cs-type-name": "Text"}, "ResponseForAggregatedMetricsList": {"properties": {"metrics": {"type": "array", "description": "List of cost metrics", "items": {"$ref": "#/definitions/AggregatedMetricsResponse"}}}, "type": "object"}, "Role": {"properties": {"id": {"type": "string"}, "name": {"type": "string"}, "role_type": {"type": "string"}}, "type": "object"}, "RoleAssignment": {"required": ["roles", "tenant_id", "tenant_name"], "properties": {"tenant_name": {"type": "string", "description": "Name of the tenant within the CoreStack account"}, "tenant_id": {"type": "string", "description": "ID of the tenant within the CoreStack account"}, "roles": {"type": "array", "description": "List of roles for this tenant. User can have multiple roles within a tenant", "items": {"$ref": "#/definitions/RoleAssignmentRole"}}}, "type": "object"}, "RoleAssignmentRole": {"required": ["id", "name"], "properties": {"name": {"type": "string", "description": "Name of the Role assigned to the user under a tenant"}, "id": {"type": "string", "description": "ID of the Role assigned to the user under a tenant"}}, "type": "object"}, "RoleDetails": {"required": ["access", "category", "created_at", "description", "id", "name", "status", "users"], "properties": {"id": {"type": "string", "description": "ID of the Role. This is an auto generated and unique in the CoreStack system"}, "tenant_id": {"type": "string", "description": "Tenant Id for the Role"}, "name": {"type": "string", "description": "Name of the role. This is unique in the CoreStack system for a specific tenant"}, "status": {"type": "string", "description": "Status of the Role"}, "access": {"type": "array", "description": "List of access the role can perform in the tenant", "items": {"type": "string"}}, "users": {"type": "integer", "description": "Count of users having the role attached under a tenant"}, "description": {"type": "string", "description": "Description of the role"}, "created_at": {"type": "string", "description": "Date and time of role creation"}, "category": {"type": "string", "description": "Category of the specific role. Either default or custom"}, "policies": {"type": "object", "description": "List of policy available for a role"}}, "type": "object"}, "RoleInfoModel": {"properties": {"tenant_id": {"type": "string", "description": "Tenant id"}, "roles": {"type": "array", "description": "list of role ids assigned to user", "items": {"type": "string"}}}, "type": "object"}, "RoleListResponse": {"required": ["roles", "total_count"], "properties": {"total_count": {"type": "integer", "description": "Total number of roles available in the specific tenant"}, "roles": {"type": "array", "description": "List of roles available in specific tenant", "items": {"$ref": "#/definitions/RoleDetails"}}}, "type": "object"}, "RoleSummary": {"properties": {"name": {"type": "string", "description": "Name of the User"}, "role_type": {"type": "string", "description": "User role type"}, "category": {"type": "string", "description": "User category"}, "tenant_name": {"type": "string", "description": "Tenant name"}}, "type": "object"}, "RoleSummaryBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/RoleSummary"}}}, "type": "object"}, "RoleTemplatesDetails": {"properties": {"name": {"type": "string", "description": "Name of the role_template"}, "role": {"type": "string", "description": "Role of the template defined"}, "description": {"type": "string", "description": "Description of the role template"}, "policies": {"type": "array", "description": "List of policy defined for corresponding role template", "items": {"$ref": "#/definitions/PolicyActionPair"}}, "cloud_services": {"type": "array", "description": "List of cloud services supported for the role template", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "integrated_tools": {"type": "array", "description": "List of integrated tools supported for the role template", "items": {"type": "string", "description": "Integrated Tool to select", "example": "Anomaly_Detector", "enum": ["Anomaly_Detector", "AppDynamics", "App_Insights", "ArrowSphere", "Azure_Devops", "Azure_Security_Graph", "Azure_Sentinel", "Corestack", "DockerHub", "ElasticSearch", "Freshservice", "GitHub", "JIRA_DataCenter", "JIRA_ServiceDesk", "JIRA_ServiceManagement", "Jenkins", "Logstash", "Microsoft_Teams", "Nagios", "Newrelic", "Prometheus", "Qualys", "RedHat_Satellite", "ServiceNow", "TCL_ITSM", "Tenable_Nessus", "ZOHO_ServiceDesk", "Zabbix"], "x-cs-enum-type": "IntegratedToolName"}}, "resources": {"type": "array", "description": "List of resources supported for the role template", "items": {"type": "string", "description": "Resource Service to select", "example": "kubernetes_cluster", "enum": ["kubernetes_cluster"], "x-cs-enum-type": "ResourceName"}}, "saas_services": {"type": "array", "description": "List of SaaS services supported for the role template", "items": {"type": "string", "description": "SaaS Service to select", "example": "Anthropic", "enum": ["Anthropic", "OpenAI", "Databricks", "Snowflake", "CircleCI", "Datadog", "Dropbox", "Dynatrace", "Elastic", "Grafana", "IBM_Tencent", "Microsoft_Teams", "New_Relic", "Okta", "SaasCustomTool", "Salesforce_Sales_Cloud", "Splunk"], "x-cs-enum-type": "SaasServiceName"}}}, "type": "object"}, "SavedView": {"properties": {"name": {"type": "string"}, "roles": {"type": "array", "items": {"type": "string"}}, "view": {"$ref": "#/definitions/ViewState"}, "updated_at": {"type": "string", "format": "date-time"}}, "type": "object"}, "SavedViewBase": {"required": ["module", "name", "view"], "properties": {"name": {"type": "string", "description": "View label"}, "module": {"type": "string", "example": "finops_dashboard", "enum": ["finops_dashboard", "billing_inventory", "next_gen_reports", "cost_anomaly"], "x-cs-enum-type": "SavedViewModule"}, "dashboard_id": {"type": "string", "description": "Dashboard this view belongs to"}, "visibility": {"type": "string", "example": "shared", "enum": ["shared", "private"], "x-cs-enum-type": "SavedViewVisibility"}, "roles": {"type": "array", "description": "Role-based access metadata, e.g. ['admin', 'finops_viewer']", "items": {"type": "string"}}, "view": {"description": "Polymorphic view payload (DashboardViewState)", "$ref": "#/definitions/ViewState"}}, "type": "object"}, "SavedViewCreateRequest": {"allOf": [{"$ref": "#/definitions/SavedViewBase"}, {"properties": {}, "type": "object"}]}, "SavedViewDetail": {"allOf": [{"$ref": "#/definitions/SavedViewBase"}, {"properties": {"id": {"type": "string", "description": "Unique identifier of the saved view"}}, "type": "object"}]}, "SavedViewFilter": {"properties": {"dashboard_id": {"type": "string", "description": "Optional dashboard filter"}, "module": {"type": "string", "example": "finops_dashboard", "enum": ["finops_dashboard", "billing_inventory", "next_gen_reports", "cost_anomaly"], "x-cs-enum-type": "SavedViewModule"}, "visibility": {"type": "string", "example": "shared", "enum": ["shared", "private"], "x-cs-enum-type": "SavedViewVisibility"}}, "type": "object"}, "SavedViewListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/SavedViewFilter"}}, "type": "object"}, "SavedViewListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"$ref": "#/definitions/SavedViewDetail"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "SavedViewUpdateRequest": {"allOf": [{"$ref": "#/definitions/SavedViewBase"}, {"properties": {}, "type": "object"}]}, "SavingsPlanBase": {"properties": {"plan_id": {"type": "string", "description": "Savings plan ID"}, "plan_name": {"type": "string", "description": "Savings plan name"}, "plan_type": {"type": "string", "description": "Type of savings plan"}, "service_account_id": {"type": "string", "description": "Associated service account ID", "x-cs-type": "ObjectId"}, "utilization_percentage": {"type": "number", "description": "Overall utilization percentage"}}, "type": "object"}, "SavingsPlanDetailsData": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"$ref": "#/definitions/SavingsPlanItem"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "SavingsPlanDetailsFilters": {"properties": {"service_account_ids": {"type": "array", "description": "Service account IDs to filter", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "SavingsPlanDetailsRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/SavingsPlanDetailsFilters"}}, "type": "object"}, "SavingsPlanItem": {"allOf": [{"$ref": "#/definitions/SavingsPlanBase"}, {"properties": {"plan_scope": {"type": "string", "description": "Scope of the savings plan"}, "start_date": {"type": "string", "format": "date-time", "description": "Plan start date"}, "end_date": {"type": "string", "format": "date-time", "description": "Plan end date"}, "term": {"type": "string", "description": "Plan term"}, "payment_option": {"type": "string", "description": "Payment option"}, "commitment_amount": {"type": "number", "description": "Committed spend per hour"}, "upfront_cost": {"type": "number", "description": "Upfront cost of the plan"}, "currency": {"type": "string", "description": "Currency of monetary values"}, "instance_family": {"type": "string", "description": "Instance family (AWS compute plans)"}, "provisioning_state": {"type": "string", "description": "Current provisioning/status of the plan"}}, "type": "object"}]}, "SavingsPlanRecommendation": {"properties": {"recommendation_id": {"type": "string", "description": "Recommendation ID"}, "service_account_id": {"type": "string", "description": "Associated service account ID", "x-cs-type": "ObjectId"}, "plan_type": {"type": "string", "description": "Type of savings plan"}, "payment_option": {"type": "string", "description": "Payment option"}, "recommendation_scope": {"type": "string", "description": "Scope of the recommendation"}, "lookback_period": {"type": "string", "description": "Historical usage window used for the recommendation"}, "usage_hours": {"type": "number", "description": "Usage hours considered"}, "term": {"type": "string", "description": "Plan term"}, "commitment_granularity": {"type": "string", "description": "Commitment granularity"}, "commitment_amount": {"type": "number", "description": "Recommended committed spend per hour"}, "savings_percentage": {"type": "number", "description": "Estimated savings percentage"}, "savings_amount": {"type": "number", "description": "Estimated savings amount"}, "utilization_percentage": {"type": "number", "description": "Projected utilization percentage"}, "cost_without_recommendation": {"type": "number", "description": "On-demand cost without the recommendation"}, "cost_with_recommendation": {"type": "number", "description": "Projected cost with the recommendation applied"}, "currency": {"type": "string", "description": "Currency of monetary values"}, "number_of_plans": {"type": "integer", "description": "Number of plans recommended"}, "instance_family": {"type": "string", "description": "Instance family (AWS compute plans)"}}, "type": "object"}, "SavingsPlanRecommendationsData": {"required": ["recommendations"], "properties": {"recommendations": {"type": "array", "description": "Savings plan purchase recommendations.", "items": {"$ref": "#/definitions/SavingsPlanRecommendation"}}}, "type": "object"}, "SavingsPlanRecommendationsRequest": {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "One or more tenant IDs to fetch savings plan recommendations across.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "SavingsPlanUtilizationData": {"allOf": [{"$ref": "#/definitions/SavingsPlanBase"}, {"properties": {"utilization_metrics": {"description": "Paginated utilization time-series", "$ref": "#/definitions/SavingsPlanUtilizationMetricsData"}}, "type": "object"}]}, "SavingsPlanUtilizationFilters": {"required": ["plan_id"], "properties": {"plan_id": {"type": "string", "description": "Plan ID of the purchased savings plan"}, "service_account_ids": {"type": "array", "description": "Service account IDs to filter", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "start_date": {"type": "string", "format": "date-time", "description": "Filter metrics on or after this date"}, "end_date": {"type": "string", "format": "date-time", "description": "Filter metrics on or before this date"}}, "type": "object"}, "SavingsPlanUtilizationMetric": {"properties": {"usage_date": {"type": "string", "format": "date-time", "description": "Date of the utilization record"}, "avg_utilization_percentage": {"type": "number", "description": "Average utilization percentage for the period"}, "max_utilization_percentage": {"type": "number", "description": "Maximum utilization percentage for the period"}, "min_utilization_percentage": {"type": "number", "description": "Minimum utilization percentage for the period"}}, "type": "object"}, "SavingsPlanUtilizationMetricsData": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"$ref": "#/definitions/SavingsPlanUtilizationMetric"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "SavingsPlanUtilizationRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/SavingsPlanUtilizationFilters"}}, "type": "object"}, "SavingsWiseSummary": {"required": ["cost_saved_current_month", "cost_saved_till_date", "potential_cost_saving_recommended"], "properties": {"cost_saved_till_date": {"type": "array", "description": "Details about cost saved till date", "items": {"$ref": "#/definitions/CostWiseSummary"}}, "cost_saved_current_month": {"type": "array", "description": "Cost saved for the current month", "items": {"$ref": "#/definitions/CostWiseSummary"}}, "potential_cost_saving_recommended": {"type": "array", "description": "recommendations on cost savings", "items": {"$ref": "#/definitions/CostWiseSummary"}}}, "type": "object"}, "ScanScriptResponse": {"required": ["hosts", "scanned_parameters"], "properties": {"scanned_parameters": {"type": "object", "description": "A JSON object which contains the scanned parameters of the script."}, "hosts": {"type": "array", "description": "Hosts available in the playbook if any", "items": {"type": "string"}}}, "type": "object"}, "ScannerListResponseDetails": {"allOf": [{"$ref": "#/definitions/ScannerRuleBase"}, {"properties": {"is_rule_override": {"type": "boolean", "description": "Boolean to check whether the input has been override in this github account."}, "is_rule_available": {"type": "boolean", "description": "Boolean to check whether the rule is available in this github account."}, "values": {"type": "array", "description": "inputs with which the rules are getting scanned.", "items": {"type": "string"}}, "applicable_service": {"type": "string", "description": "resource types which are scanned against the resource configurations."}}, "type": "object"}]}, "ScannerRuleBase": {"properties": {"name": {"type": "string", "description": "name of the rule which are scanned against the resource configurations."}, "description": {"type": "string", "description": "description of the rule which are scanned against the resource configurations."}, "applicable_resource": {"type": "string", "description": "resource type which are scanned against the resource configurations."}, "input_details": {"type": "array", "description": "The input with which the rules are getting scanned.", "items": {"type": "string"}}, "sys_id": {"type": "string", "description": "Identity of the rule which are scanned against the resource configurations."}, "attribute_name": {"type": "string", "description": "attribute name for which the values are going to be stored."}}, "type": "object"}, "ScannerRuleList": {"properties": {"rules": {"type": "array", "description": "The list of scanner rules.", "items": {"$ref": "#/definitions/ScannerListResponseDetails"}}}, "type": "object"}, "ScannerViolationComments": {"properties": {"pr_sys_id": {"type": "string", "description": "Unique Identifier of the Pull Request which is auto generated.", "x-cs-type": "ObjectId"}, "provision_details": {"type": "string", "description": "This Field will contain fields such as terraform state whenever provisioning happens for a  pull request."}, "governance_findings": {"type": "array", "items": {"$ref": "#/definitions/FileWiseViolations"}}, "cost_findings": {"type": "array", "items": {"$ref": "#/definitions/IndividualCostOutput"}}, "commit_id": {"type": "string", "description": "ShA Id of the commit which was committed."}, "directory_name": {"type": "string", "description": "name of the directory against which the violation has been generated."}, "classification": {"type": "string", "description": "name of the classification"}, "touched_at": {"type": "string", "format": "date-time", "description": "Date time at which the sync recently happened for a commit."}, "notification_details": {"type": "array", "items": {"$ref": "#/definitions/StepWiseNotifications"}}}, "type": "object"}, "ScheduleData": {"required": ["args", "created_at", "created_by", "description", "id", "name", "next_run", "recurrence", "resource_details", "schedule", "type"], "properties": {"id": {"type": "string", "description": "Schedule ID"}, "name": {"type": "string", "description": "Schedule Name"}, "type": {"type": "string", "description": "Schedule type", "example": "template", "enum": ["template", "script", "policy"], "x-cs-enum-type": "ScheduleType"}, "description": {"type": "string", "description": "Description of the schedule"}, "recurrence": {"type": "string", "description": "Re-occurrence of the schedule"}, "next_run": {"type": "string", "description": "When will the schedule run for the next time"}, "schedule": {"type": "object", "description": "Schedule date and time details"}, "args": {"type": "object", "description": "Input Parameters for that Template/Script/Policy that is scheduled"}, "resource_details": {"type": "array", "description": "Template/Script/Policy Details that is scheduled", "items": {"$ref": "#/definitions/ResourceDetails"}}, "created_at": {"type": "string", "description": "When the schedule is created"}, "created_by": {"type": "string", "description": "Who has created the schedule"}}, "type": "object"}, "ScheduleDetails": {"required": ["category", "name", "resource", "schedule"], "properties": {"schedule_id": {"type": "string", "description": "ID of the schedule", "x-cs-type": "ObjectId"}, "name": {"type": "string", "description": "Schedule Name"}, "category": {"type": "string", "description": "Category of the schedule.", "example": "ComplianceStandard", "enum": ["ComplianceStandard", "Policy", "PolicyRemediation", "Reports", "Script", "Template"], "x-cs-enum-type": "ScheduleCategory"}, "source": {"type": "string", "description": "Source of the schedule creation", "example": "Report", "enum": ["Report", "ScheduleRecommendation"], "x-cs-enum-type": "ScheduleSource"}, "description": {"type": "string", "description": "Description of the schedule"}, "recurrence": {"type": "string", "description": "Re-occurrence of the schedule", "example": "Once", "enum": ["Once", "Minutes", "Hours", "Daily", "Weekly", "Monthly", "Annually"], "x-cs-enum-type": "ScheduleRecurrence"}, "next_run": {"type": "string", "format": "date-time", "description": "When will the schedule run for the next time"}, "last_run": {"type": "string", "format": "date-time", "description": "When the last schedule triggered"}, "end_run": {"type": "string", "format": "date-time", "description": "Upto when the schedule should run"}, "schedule": {"description": "Schedule date and time details", "$ref": "#/definitions/SchedulingDetails"}, "timezone": {"type": "string", "description": "Timezone of the schedule"}, "resource": {"type": "string", "description": "ID of the resource which is scheduled. Can be retrieved using the respective List API"}, "resource_args": {"type": "string", "description": "Input Parameters for the resource that is scheduled which is a JSON string"}, "execution_params": {"type": "array", "description": "Execution parameters for the schedule.", "items": {"$ref": "#/definitions/ScheduleExecutionParameterBase"}}, "notification_configuration": {"description": "Notification configuration for the schedule.", "$ref": "#/definitions/ScheduleExecutionNotificationConfiguration"}, "is_active": {"type": "boolean", "description": "Flag to represent whether the schedule is active or not."}, "is_system_schedule": {"type": "boolean", "description": "Flag to represent whether the schedule is system scheduled or not."}, "tenant_id": {"type": "string", "description": "Tenant owning the schedule.", "x-cs-type": "ObjectId"}, "created_at": {"type": "string", "format": "date-time", "description": "When the schedule is created"}, "created_by": {"type": "string", "description": "Who has created the schedule"}, "updated_at": {"type": "string", "format": "date-time", "description": "When the schedule is updated"}, "updated_by": {"type": "string", "description": "Who has updated the schedule"}, "background_job": {"description": "Identity of the background job used for processing schedule. null if the job has completed", "$ref": "#/definitions/RecordIdentity"}}, "type": "object"}, "ScheduleExecutionNotificationConfiguration": {"properties": {"email_recipients": {"type": "array", "description": "List of Email IDs", "items": {"type": "string"}}, "webhooks": {"type": "array", "description": "Webhooks to trigger notifications", "items": {"$ref": "#/definitions/ScheduleExecutionNotificationWebHookForStandardType"}}}, "type": "object"}, "ScheduleExecutionNotificationWebHookForStandardType": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionNotificationWebhook"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionNotificationWebHookForStandardType"}, "ScheduleExecutionNotificationWebhook": {"required": ["__type"], "properties": {"webhook_id": {"type": "string", "description": "Webhook ID to trigger notification"}}, "discriminator": "__type", "type": "object", "x-cs-type-name": "ScheduleExecutionNotificationWebhook", "x-cs-subtypes": [{"subtype_model": "ScheduleExecutionNotificationWebHookForStandardType", "subtype_name": "ScheduleExecutionNotificationWebHookForStandardType"}]}, "ScheduleExecutionParameterBase": {"required": ["type"], "properties": {}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ScheduleExecutionParameterServiceAccountBase", "subtype_name": "ScheduleExecutionParameterServiceAccountBase"}, {"subtype_model": "ScheduleExecutionParameterForTemplateBase", "subtype_name": "ScheduleExecutionParameterForTemplateBase"}, {"subtype_model": "ScheduleExecutionParameterForTemplateAwsProvider", "subtype_name": "ScheduleExecutionParameterForTemplateAwsProvider"}, {"subtype_model": "ScheduleExecutionParameterForTemplateAzureProvider", "subtype_name": "ScheduleExecutionParameterForTemplateAzureProvider"}, {"subtype_model": "ScheduleExecutionParameterForTemplateGcpProvider", "subtype_name": "ScheduleExecutionParameterForTemplateGcpProvider"}, {"subtype_model": "ScheduleExecutionParameterForTemplateOciProvider", "subtype_name": "ScheduleExecutionParameterForTemplateOciProvider"}, {"subtype_model": "ScheduleExecutionParameterForPolicy", "subtype_name": "ScheduleExecutionParameterForPolicy"}, {"subtype_model": "ScheduleExecutionParameterForPolicyRemediation", "subtype_name": "ScheduleExecutionParameterForPolicyRemediation"}, {"subtype_model": "ScheduleExecutionParameterForComplianceStandard", "subtype_name": "ScheduleExecutionParameterForComplianceStandard"}, {"subtype_model": "ScheduleExecutionParameterForAssessmentRunReport", "subtype_name": "ScheduleExecutionParameterForAssessmentRunReport"}, {"subtype_model": "ScheduleExecutionParameterForExecutiveDashboardReport", "subtype_name": "ScheduleExecutionParameterForExecutiveDashboardReport"}, {"subtype_model": "ScheduleExecutionParameterForNextGenReport", "subtype_name": "ScheduleExecutionParameterForNextGenReport"}, {"subtype_model": "ScheduleExecutionParameterForAssessmentAgentAgenticFeed", "subtype_name": "ScheduleExecutionParameterForAssessmentAgentAgenticFeed"}, {"subtype_model": "ScheduleExecutionParameterForScript", "subtype_name": "ScheduleExecutionParameterForScript"}]}, "ScheduleExecutionParameterForAssessmentAgentAgenticFeed": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterBase"}, {"required": ["configuration", "report_type"], "properties": {"configuration": {"$ref": "#/definitions/BaseReportConfigurationForAssessmentAgent"}, "report_type": {"type": "string", "description": "AI agentic feed Report type", "example": "assessments", "enum": ["assessments", "workload", "rate_optimization", "waste_analysis", "expiry_dashboard"], "x-cs-enum-type": "AiAgenticFeedReportType"}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForAssessmentAgentAgenticFeed"}, "ScheduleExecutionParameterForAssessmentRunReport": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterBase"}, {"required": ["framework_id", "report_type"], "properties": {"framework_id": {"type": "string", "description": "Identity of the Framework"}, "report_type": {"type": "string", "description": "Report type for assessment run", "example": "AssessmentRunDetail", "enum": ["AssessmentRunDetail", "AssessmentRunSummary", "AssessmentRunViolation"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunReportType"}, "filters": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForAssessmentRunReport"}, "ScheduleExecutionParameterForComplianceStandard": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterServiceAccountBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForComplianceStandard"}, "ScheduleExecutionParameterForExecutiveDashboardReport": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterBase"}, {"required": ["dashboard", "subscription_type"], "properties": {"dashboard": {"$ref": "#/definitions/DashboardConfiguration"}, "subscription_type": {"type": "string", "description": "Executive Dashboard Report subscription type", "example": "Dashboard", "enum": ["Dashboard", "Drilldown", "Widget"], "x-cs-enum-type": "ExecutiveDashboardReportSubscriptionType"}, "export_format": {"type": "string", "description": "Specifies the format of the file being exported.", "default": "PDF", "example": "PDF", "enum": ["PDF", "CSV"], "x-cs-enum-type": "ExportFormat"}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForExecutiveDashboardReport"}, "ScheduleExecutionParameterForNextGenReport": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterBase"}, {"required": ["configuration", "report_type"], "properties": {"configuration": {"$ref": "#/definitions/ConfigurationForNextGenReportBase"}, "report_type": {"type": "string", "description": "NextGen Report type", "example": "ConsolidatedChargesReport", "enum": ["ConsolidatedChargesReport", "DistributorConsolidatedReport"], "x-cs-enum-type": "NextGenReportType"}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForNextGenReport"}, "ScheduleExecutionParameterForPolicy": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterServiceAccountBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForPolicy"}, "ScheduleExecutionParameterForPolicyRemediation": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterServiceAccountBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForPolicyRemediation"}, "ScheduleExecutionParameterForScript": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterBase"}, {"properties": {"log_level": {"type": "string", "description": "Log level for the script", "default": "INFO", "example": "INFO", "enum": ["INFO", "DEBUG"], "x-cs-enum-type": "ScheduleLogLevel"}, "timeout": {"type": "string", "description": "The maximum time for an execution to run. Time in seconds, or specify time units: 120m, 2h, 3d. Use blank or 0 to indicate no timeout"}, "retry": {"type": "integer", "description": "Maximum number of times to retry execution when this job is directly invoked. Retry will occur if the job fails or times out, but not if it is manually killed"}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForScript"}, "ScheduleExecutionParameterForTemplateAwsProvider": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterForTemplateBase"}, {"properties": {"region": {"type": "string", "description": "The region of the cloud account where it needs to be executed."}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForTemplateAwsProvider"}, "ScheduleExecutionParameterForTemplateAzureProvider": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterForTemplateBase"}, {"properties": {"resource_group": {"type": "string", "description": "Resource group for which you need to execute the template for."}, "location": {"type": "string", "description": "Location under which you need to execute the template for."}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForTemplateAzureProvider"}, "ScheduleExecutionParameterForTemplateBase": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterServiceAccountBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForTemplateBase"}, "ScheduleExecutionParameterForTemplateGcpProvider": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterForTemplateBase"}, {"properties": {"zone": {"type": "string", "description": "The zone of the cloud account where it needs to be executed."}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForTemplateGcpProvider"}, "ScheduleExecutionParameterForTemplateOciProvider": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterForTemplateBase"}, {"properties": {"region": {"type": "string", "description": "The region of the cloud account where it needs to be executed."}, "compartment": {"type": "string", "description": "The compartment for which you need to execute the template for."}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterForTemplateOciProvider"}, "ScheduleExecutionParameterServiceAccountBase": {"allOf": [{"$ref": "#/definitions/ScheduleExecutionParameterBase"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service account ID, can be obtained from the List Service Accounts API.", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "ScheduleExecutionParameterServiceAccountBase"}, "ScheduleFilter": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "category": {"type": "string", "description": "Category of the schedule", "example": "ComplianceStandard", "enum": ["ComplianceStandard", "Policy", "PolicyRemediation", "Reports", "Script", "Template"], "x-cs-enum-type": "ScheduleCategory"}, "is_active": {"type": "boolean", "description": "Flag to represent whether the schedule is active or not."}, "query": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "ScheduleListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/ScheduleListSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ScheduleFilter"}}, "type": "object"}, "ScheduleListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "ScheduleListSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedAt", "UpdatedAt", "NextRun"], "x-cs-enum-type": "ScheduleListSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ScheduleQueryAssessmentAgentReportType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["assessment_agent_report_types"], "properties": {"assessment_agent_report_types": {"type": "array", "description": "Ai Assessment Agent Report Type of the Schedule for category reports", "items": {"type": "string", "description": "AI agentic feed Report type", "example": "assessments", "enum": ["assessments", "workload", "rate_optimization", "waste_analysis", "expiry_dashboard"], "x-cs-enum-type": "AiAgenticFeedReportType"}}}, "type": "object"}], "x-cs-type-name": "ScheduleQueryAssessmentAgentReportType"}, "ScheduleQueryCreatedBy": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["created_by"], "properties": {"created_by": {"type": "array", "description": "Schedule Created by", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ScheduleQueryCreatedBy"}, "ScheduleQueryEmailRecipients": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["email_recipients"], "properties": {"email_recipients": {"type": "array", "description": "Scheduled Notification Email Recipients", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ScheduleQueryEmailRecipients"}, "ScheduleQueryName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["name"], "properties": {"name": {"type": "string", "description": "Regular expression to match against Schedule name"}}, "type": "object"}], "x-cs-type-name": "ScheduleQueryName"}, "ScheduleQueryNextGenReportType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["nextgen_report_types"], "properties": {"nextgen_report_types": {"type": "array", "description": "NextGen Report Type of the Schedule for category reports", "items": {"type": "string", "description": "NextGen Report type", "example": "ConsolidatedChargesReport", "enum": ["ConsolidatedChargesReport", "DistributorConsolidatedReport"], "x-cs-enum-type": "NextGenReportType"}}}, "type": "object"}], "x-cs-type-name": "ScheduleQueryNextGenReportType"}, "ScheduleQueryRecurrence": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["recurrences"], "properties": {"recurrences": {"type": "array", "description": "Recurrence of the Schedule", "items": {"type": "string", "description": "Recurrence of the schedule", "example": "Once", "enum": ["Once", "Minutes", "Hours", "Daily", "Weekly", "Monthly", "Annually"], "x-cs-enum-type": "ScheduleRecurrence"}}}, "type": "object"}], "x-cs-type-name": "ScheduleQueryRecurrence"}, "ScheduleQueryReportType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["report_types"], "properties": {"report_types": {"type": "array", "description": "Report Type of the Schedule for category reports", "items": {"type": "string", "description": "Report type for assessment run", "example": "AssessmentRunDetail", "enum": ["AssessmentRunDetail", "AssessmentRunSummary", "AssessmentRunViolation"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunReportType"}}}, "type": "object"}], "x-cs-type-name": "ScheduleQueryReportType"}, "ScheduleRecommendationActionBaseRequest": {"required": ["recommendation_id", "schedule_finding", "schedule_periods", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant Id"}, "recommendation_id": {"type": "string", "description": "Recommendation id"}, "schedule_finding": {"type": "string", "description": "Schedule Finding Type", "example": "hourly", "enum": ["hourly", "weekly"], "x-cs-enum-type": "ScheduleFinding"}, "schedule_periods": {"type": "array", "description": "List of from_times or days for the recommendation", "items": {"type": "string"}}}, "type": "object"}, "ScheduleRecommendationCalculateCostSavings": {"required": ["service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account Ids", "items": {"type": "string"}}}, "type": "object"}, "ScheduleRecommendationDetails": {"properties": {"service_account_id": {"type": "string", "description": "Service Account Id", "x-cs-type": "ObjectId"}, "potential_cost_savings_daily": {"type": "number", "description": "Daily Cost Savings"}, "potential_cost_savings_monthly": {"type": "number", "description": "Monthly Cost Savings"}, "potential_cost_savings_yearly": {"type": "number", "description": "Yearly Cost Savings"}, "savings_percentage": {"type": "number", "description": "Potential Savings Percentage"}, "resources_count": {"type": "integer", "description": "Count of recommendations resources"}, "hourly_recommendations": {"type": "integer", "description": "Count of hourly recommendations"}, "weekly_recommendations": {"type": "integer", "description": "Count of weekly recommendations"}}, "type": "object"}, "ScheduleRecommendationDetailsBaseRequest": {"required": ["resource_id", "schedule_finding", "service_account_id", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant Id"}, "service_account_id": {"type": "string", "description": "Service Account Id"}, "resource_id": {"type": "string", "description": "Unique Resource Id of Inventory"}, "schedule_finding": {"type": "string", "description": "Schedule Finding Type", "example": "hourly", "enum": ["hourly", "weekly"], "x-cs-enum-type": "ScheduleFinding"}}, "type": "object"}, "ScheduleRecommendationDetailsOverviewRequest": {"allOf": [{"$ref": "#/definitions/ScheduleRecommendationDetailsBaseRequest"}, {"properties": {}, "type": "object"}]}, "ScheduleRecommendationDetailsOverviewResponse": {"properties": {"resource_utilization_level": {"type": "array", "description": "Resource Utilization Level Overview", "items": {"$ref": "#/definitions/ResourceUtilizationOverview"}}, "resource_utilization_summary": {"type": "array", "description": "Utilization Summary Details", "items": {"$ref": "#/definitions/ResourceUtilizationSummary"}}, "resource_details": {"description": "Resource Details By CPU and Memory", "$ref": "#/definitions/ResourceDetailsOverview"}}, "type": "object"}, "ScheduleRecommendationFiltersRequest": {"properties": {"tenant_ids": {"type": "array", "description": "Tenant Ids", "items": {"type": "string"}}, "service_account_ids": {"type": "array", "description": "Service Account Ids", "items": {"type": "string"}}, "service_names": {"type": "array", "description": "Service Names", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}}, "type": "object"}, "ScheduleRecommendationFiltersResponse": {"properties": {"currencies": {"type": "array", "description": "Currencies", "items": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "services": {"type": "array", "description": "Service Names", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "tenant_ids": {"type": "array", "description": "Tenant Ids", "items": {"type": "string"}}, "service_account_ids": {"type": "array", "description": "Service Account Ids", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "ScheduleRecommendationPostponeRequest": {"allOf": [{"$ref": "#/definitions/ScheduleRecommendationActionBaseRequest"}, {"required": ["duration", "emails", "unit"], "properties": {"duration": {"type": "integer", "description": "Duration of Delay to perform postpone"}, "unit": {"type": "string", "description": "Unit for duration", "example": "hours", "enum": ["hours", "days"], "x-cs-enum-type": "ScheduleRecommendationDurationUnit"}, "emails": {"type": "array", "description": "Email addresses to notify", "items": {"type": "string"}}, "resource_type": {"type": "string", "description": "Name of the resource component"}, "resource": {"type": "string", "description": "Name of the resource"}, "day": {"type": "string", "example": "MONDAY", "enum": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"], "x-cs-enum-type": "DayOfWeek"}, "from_time": {"type": "string", "format": "date-time", "description": "FromTime of the calculation"}, "to_time": {"type": "string", "format": "date-time", "description": "ToTime of the calculation"}, "potential_cost_savings_monthly": {"type": "number", "description": "Monthly Cost Savings of the Recommendation"}}, "type": "object"}]}, "ScheduleRecommendationReactivateRequest": {"allOf": [{"$ref": "#/definitions/ScheduleRecommendationActionBaseRequest"}, {"properties": {}, "type": "object"}]}, "ScheduleRecommendationRejectRequest": {"allOf": [{"$ref": "#/definitions/ScheduleRecommendationActionBaseRequest"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account Id"}, "reason": {"type": "string", "description": "Reason for Rejection"}}, "type": "object"}]}, "ScheduleRecommendationRemediateRequest": {"allOf": [{"$ref": "#/definitions/ScheduleRecommendationActionBaseRequest"}, {"required": ["emails", "resource_id", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Service Account Id"}, "resource_id": {"type": "string", "description": "Unique Resource Id of Inventory"}, "emails": {"type": "array", "description": "Email addresses to notify", "items": {"type": "string"}}, "day": {"type": "string", "example": "MONDAY", "enum": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"], "x-cs-enum-type": "DayOfWeek"}, "start_time": {"type": "string", "format": "date-time", "description": "Schedule Start Time"}, "end_time": {"type": "string", "format": "date-time", "description": "Schedule End Time"}}, "type": "object"}]}, "ScheduleRecommendationResourceDetails": {"properties": {"currency": {"type": "string", "description": "Currency", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "resource": {"type": "string", "description": "Name of the resource"}, "resource_type": {"type": "string", "description": "Name of the resource component"}, "potential_cost_savings_daily": {"type": "number", "description": "Daily Cost Savings of the Recommendation"}, "potential_cost_savings_monthly": {"type": "number", "description": "Monthly Cost Savings of the Recommendation"}, "potential_cost_savings_yearly": {"type": "number", "description": "Yearly Cost Savings of the Recommendation"}, "schedule_finding": {"type": "string", "description": "Schedule Finding Type", "example": "hourly", "enum": ["hourly", "weekly"], "x-cs-enum-type": "ScheduleFinding"}, "recommendation_id": {"type": "string", "description": "Recommendation Id"}, "show_remediation_action": {"type": "boolean", "description": "If set indicates remediation action should be shown"}, "statistical_method": {"type": "string", "description": "Schedule Recommendation Statistical Method Name", "example": "Average", "enum": ["Average", "Minimum", "Maximum"], "x-cs-enum-type": "ScheduleRecommendationStatisticalMethod"}, "schedule_periods": {"type": "array", "description": "List of from_times or days for the recommendation", "items": {"type": "string"}}, "schedule_status": {"type": "string", "description": "Schedule status of the recommendation"}, "day": {"type": "string", "example": "MONDAY", "enum": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"], "x-cs-enum-type": "DayOfWeek"}, "from_time": {"type": "string", "format": "date-time", "description": "Schedule Start Time"}, "to_time": {"type": "string", "format": "date-time", "description": "Schedule End Time"}}, "type": "object"}, "ScheduleRecommendationResourceDetailsRequest": {"allOf": [{"$ref": "#/definitions/ScheduleRecommendationDetailsBaseRequest"}, {"properties": {}, "type": "object"}]}, "ScheduleRecommendationResourceScheduleDetails": {"properties": {"schedule_recommendation_id": {"type": "string", "description": "Schedule Recommendation ID", "x-cs-type": "ObjectId"}, "service_resource_inventory_id": {"type": "string", "description": "Service Resource Inventory Id", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "Cloud Resource Identifier"}, "resource_name": {"type": "string", "description": "Name of the resource"}, "resource_type": {"type": "string", "description": "Name of the resource component"}, "currency": {"type": "string", "description": "Currency", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "info": {"type": "string", "description": "recommendation confidence based on statistical method"}, "potential_cost_savings_daily": {"type": "number", "description": "Daily Cost Savings"}, "potential_cost_savings_monthly": {"type": "number", "description": "Monthly Cost Savings"}, "potential_cost_savings_yearly": {"type": "number", "description": "Yearly Cost Savings"}, "schedule_finding": {"type": "string", "description": "Schedule Finding Type", "example": "hourly", "enum": ["hourly", "weekly"], "x-cs-enum-type": "ScheduleFinding"}, "statistical_method": {"type": "string", "description": "Schedule Recommendation Statistical Method Name", "example": "Average", "enum": ["Average", "Minimum", "Maximum"], "x-cs-enum-type": "ScheduleRecommendationStatisticalMethod"}}, "type": "object"}, "ScheduleRecommendationResourceScheduleRequest": {"required": ["service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account Ids", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "schedule_finding": {"type": "string", "description": "Schedule Finding Type", "example": "hourly", "enum": ["hourly", "weekly"], "x-cs-enum-type": "ScheduleFinding"}, "statistical_method": {"type": "string", "description": "Schedule Recommendation Statistical Method Name", "example": "Average", "enum": ["Average", "Minimum", "Maximum"], "x-cs-enum-type": "ScheduleRecommendationStatisticalMethod"}, "min_saving": {"type": "number", "description": "Minimum Cost Savings Filter"}, "max_saving": {"type": "number", "description": "Maximum Cost Savings Filter"}, "search": {"type": "string", "description": "Search resource_name and resource_type fields"}}, "type": "object"}, "ScheduleRecommendationScheduleRequest": {"required": ["currencies", "services", "tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "Tenant Ids", "items": {"type": "string"}}, "currencies": {"type": "array", "description": "Currencies", "items": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "services": {"type": "array", "description": "Service Names", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "page_number": {"type": "integer", "description": "Page Number"}, "page_size": {"type": "integer", "description": "Number of records per page"}, "filters": {"description": "List Schedule Filters", "$ref": "#/definitions/ScheduleRecommendationScheduleRequestFilter"}, "search": {"type": "string", "description": "Search String for filter Service Accounts"}}, "type": "object"}, "ScheduleRecommendationScheduleRequestFilter": {"properties": {"estimate_minimum": {"type": "integer", "description": "Minimum Estimated Cost to Filter"}, "estimate_maximum": {"type": "integer", "description": "Maximum Estimated Cost to Filter"}}, "type": "object"}, "ScheduleRecommendationScheduleResponse": {"properties": {"recommendations": {"type": "array", "description": "Recommendation Details By Account", "items": {"$ref": "#/definitions/ScheduleRecommendationDetails"}}, "overall_savings_percentage": {"type": "number", "description": "Overall Savings Percentage"}, "total_count": {"type": "integer", "description": "Total Count of Resources"}}, "type": "object"}, "ScheduleRecommendationSummaryRequest": {"properties": {"tenant_ids": {"type": "array", "description": "Tenant Ids", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "service_account_ids": {"type": "array", "description": "Service Account Ids", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "service_names": {"type": "array", "description": "Service Names", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "currency": {"type": "string", "description": "Currency", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}, "ScheduleRecommendationSummaryResponse": {"properties": {"potential_savings": {"type": "number", "description": "Potential Cost Savings"}, "weekly_recommendations": {"type": "integer", "description": "Count of Weekly Recommendations"}, "hourly_recommendations": {"type": "integer", "description": "Count of Hourly Recommendations"}, "impacting_resources": {"type": "integer", "description": "Count of Impacting Resources"}}, "type": "object"}, "ScheduleRecommendationUtilizationDefinition": {"properties": {"metric_name": {"type": "string", "description": "Name of the Metric"}, "metric_unit": {"type": "string", "description": "Unit of the metric"}, "minimum_value": {"type": "number", "description": "Minimum Metric Value"}, "maximum_value": {"type": "number", "description": "Maximum Metric Value"}, "low_utilization": {"type": "number", "description": "Minimum Utilization Value"}, "high_utilization": {"type": "number", "description": "Maximum Utilization Value"}}, "type": "object"}, "ScheduleRecommendationUtilizationDefinitionRequest": {"allOf": [{"$ref": "#/definitions/ScheduleRecommendationDetailsBaseRequest"}, {"properties": {}, "type": "object"}]}, "ScheduleRecommendationUtilizationMetric": {"properties": {"time": {"type": "string", "format": "date-time", "description": "StartTime of Utilization"}, "day": {"type": "string", "example": "MONDAY", "enum": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY"], "x-cs-enum-type": "DayOfWeek"}, "utilization": {"type": "number", "description": "Utilization Value"}}, "type": "object"}, "ScheduleRecommendationUtilizationMetricRequest": {"allOf": [{"$ref": "#/definitions/ScheduleRecommendationDetailsBaseRequest"}, {"required": ["metric_name"], "properties": {"metric_name": {"type": "string", "description": "Name of the Metric"}, "elapsed_days": {"type": "integer", "description": "Number of Days to return Utilization Metrics"}}, "type": "object"}]}, "ScheduleSetNextExecutionRequest": {"required": ["next_run"], "properties": {"next_run": {"type": "string", "format": "date-time", "description": "When the next run of schedule to be triggered"}}, "type": "object"}, "SchedulingDayDetails": {"required": ["day"], "properties": {"day": {"type": "string", "description": "At which day of that month or week the given category is scheduled to run.Allowed values: 1-31, for month and 0-7 or SUN-SAT for week. Both 0 and 7 represent Sunday."}}, "type": "object"}, "SchedulingDetails": {"required": ["month", "time"], "properties": {"month": {"type": "string", "description": "Month when the given category is scheduled to run. Allowed values: 1-12 or JAN-DEC"}, "time": {"description": "Time when the given category is scheduled to run.", "$ref": "#/definitions/SchedulingTimeDetails"}, "dayofmonth": {"description": "At which day of that month the given category is scheduled to run. Note: If both weekday and dayofmonth are specified, dayofmonth takes precedence.", "$ref": "#/definitions/SchedulingDayDetails"}, "weekday": {"description": "At which day of that week the given category is scheduled to run. Note: If both weekday and dayofmonth are specified, dayofmonth takes precedence.", "$ref": "#/definitions/SchedulingDayDetails"}, "year": {"type": "string", "description": "Year when the given category is scheduled to run. Example:'2024-2099'"}}, "type": "object"}, "SchedulingTimeDetails": {"required": ["hour", "minute", "seconds"], "properties": {"seconds": {"type": "string", "description": "Scheduled at which second, allowed values: 0-59"}, "minute": {"type": "string", "description": "Scheduled at which minute, allowed values: 0-59"}, "hour": {"type": "string", "description": "Scheduled at which hour, allowed values: 0-23"}}, "type": "object"}, "ScopeContainsServiceAccountQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service account IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "ScopeContainsServiceAccountQueryOperator"}, "ScopeContainsTenantQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "Tenant IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "ScopeContainsTenantQueryOperator"}, "ScopeFilter": {"properties": {"scope": {"type": "array", "description": "ID of resource filter", "items": {"type": "string"}}, "applicability_by": {"type": "array", "description": "List applicability filters of cloud account", "items": {"type": "string"}}, "tag_keys": {"type": "array", "description": "Get tags keys of cloud account", "items": {"type": "string"}}, "regions": {"type": "array", "description": "List of regions of cloud account", "items": {"$ref": "#/definitions/ScopeFilterRegion"}}, "resources": {"type": "array", "description": "Get resource filters of cloud account", "items": {"type": "string"}}, "resource_groups": {"type": "array", "description": "List of resource groups of cloud account", "items": {"$ref": "#/definitions/ScopeResourceGroup"}}, "zone": {"type": "array", "description": "List zone of cloud account", "items": {"$ref": "#/definitions/ScopeFilterZone"}}}, "type": "object"}, "ScopeFilterRegion": {"properties": {"type": {"type": "string", "description": "Type for region"}, "key": {"type": "string", "description": "Key for region"}, "name": {"type": "string", "description": "Name for region"}, "id": {"type": "string", "description": "Id for region"}}, "type": "object"}, "ScopeFilterZone": {"properties": {"name": {"type": "string", "description": "Name for zone"}, "id": {"type": "string", "description": "Id for zone"}, "zone_id": {"type": "string", "description": "Zone_id for zone"}, "region": {"type": "string", "description": "Region for zone"}}, "type": "object"}, "ScopeIsQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"scope": {"description": "Query operator to include in the scope", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}], "x-cs-type-name": "ScopeIsQueryOperator"}, "ScopeResourceGroup": {"properties": {"name": {"type": "string", "description": "Name for resource"}, "id": {"type": "string", "description": "Id for resource"}}, "type": "object"}, "ScriptDataList": {"required": ["category", "description", "operating_system", "platform", "scope", "script_id", "script_name", "status", "type", "uri"], "properties": {"script_id": {"type": "string", "description": "Unique Id of the script"}, "script_name": {"type": "string", "description": "Name of the script"}, "uri": {"type": "string", "description": "Unique URI for script"}, "description": {"type": "string", "description": "Description about script"}, "status": {"type": "string", "description": "Status of the script"}, "category": {"type": "array", "description": "Category of the script", "items": {"type": "string"}}, "platform": {"type": "array", "description": "Platforms supported by script.", "items": {"type": "string", "description": ["OS platform of the target machine (linux/windows)"], "example": "linux", "enum": ["linux", "windows"], "x-cs-enum-type": "Platform"}}, "operating_system": {"type": "array", "description": "OS supported by script", "items": {"type": "string"}}, "type": {"type": "string", "description": "Config type of the script"}, "scope": {"type": "string", "description": "Scope of the script (global/account/tenant/private)"}}, "type": "object"}, "ScriptDataView": {"required": ["category", "cookbook_name", "cookbook_path", "created_at", "created_by", "description", "module_name", "module_path", "operating_system", "parameters", "path_type", "platform", "playbook_name", "playbook_path", "scope", "script_id", "script_name", "shell_script_name", "shell_script_path", "status", "type", "updated_at", "updated_by", "uri"], "properties": {"script_id": {"type": "string", "description": "Unique Id of the script"}, "script_name": {"type": "string", "description": "Name of the script"}, "uri": {"type": "string", "description": "Unique URI for script"}, "description": {"type": "string", "description": "Description about script"}, "status": {"type": "string", "description": "Status of the script(active/inactive). Only active scripts can be executed"}, "category": {"type": "array", "description": "Category the script belongs to the script", "items": {"type": "string", "example": "Application", "enum": ["Application", "Languages", "Database", "Security", "System", "Web Server", "Others"], "x-cs-enum-type": "ScriptCategory"}}, "platform": {"type": "array", "description": "Platforms supported by script.", "items": {"type": "string", "description": ["OS platform of the target machine (linux/windows)"], "example": "linux", "enum": ["linux", "windows"], "x-cs-enum-type": "Platform"}}, "operating_system": {"type": "array", "description": "OS supported by script", "items": {"type": "object"}}, "type": {"type": "string", "description": "Config type of the script (chef/ansible/shell/puppet)"}, "scope": {"type": "string", "description": "Scope of the script  (global/account/tenant/private)"}, "path_type": {"type": "string", "description": "Script path type such as git/url/repository(puppet_alone)/galaxy(ansible)."}, "playbook_path": {"type": "string", "description": "Playbook path - available for ansible alone"}, "playbook_name": {"type": "string", "description": "Playbook name - available for ansible alone"}, "cookbook_path": {"type": "string", "description": "Cookbook path - available for chef alone."}, "cookbook_name": {"type": "string", "description": "Cookbook path - available for chef alone"}, "shell_script_path": {"type": "string", "description": "Shell script path - available for shell alone"}, "shell_script_name": {"type": "string", "description": "Shell script path - available for shell alone"}, "module_path": {"type": "string", "description": "Module path - available for puppet alone"}, "module_name": {"type": "string", "description": "Module path - available for puppet alone."}, "parameters": {"type": "object", "description": "A JSON object which contains the parameters of the script."}, "created_by": {"type": "string", "description": "Name of the user who created the script."}, "created_at": {"type": "string", "description": "Script creation time in UTC"}, "updated_by": {"type": "string", "description": "Name of the user who updated the script. "}, "updated_at": {"type": "string", "description": "Script update time in UTC"}}, "type": "object"}, "ScriptInfo": {"required": ["name", "path", "path_type"], "properties": {"name": {"type": "string", "description": "Script Name as available in the path"}, "path_type": {"type": "string", "description": "Path type for script", "example": "file", "enum": ["file", "git", "local", "repository", "url"], "x-cs-enum-type": "ScriptPathType"}, "content": {"type": "string", "description": "File content, if path type is specified as file"}, "path": {"type": "string", "description": "Path of the script. ExamplesFor git path_type: https://github.com/ansible/test-playbooks.git,For url path_type: https://s3.amazonaws.com/ansible/test-playbooks.tar,For galaxy: https://galaxy.ansible.com/community/zabbix."}}, "type": "object"}, "ScriptJobDataView": {"required": ["completed_at", "execution_type", "initiated_by", "started_at", "status", "status_reason"], "properties": {"script_job_id": {"type": "string", "description": "Unique ID of the Script Job"}, "script_job_name": {"type": "string", "description": "Name of the Script Job"}, "status": {"type": "string", "description": "Overall status of the script execution"}, "status_reason": {"type": "string", "description": "Error message if failed"}, "started_at": {"type": "string", "description": "Script Job start time in UTC"}, "completed_at": {"type": "string", "description": "Script Job completion time in UTC"}, "execution_type": {"type": "string", "description": "Script Job execution type (on_demand/scheduled)"}, "initiated_by": {"type": "string", "description": "User who initiated script execution"}, "job_info": {"description": "Script execution details", "$ref": "#/definitions/ScriptJobInfo"}}, "type": "object"}, "ScriptJobInfo": {"required": ["host", "platform", "username"], "properties": {"host": {"type": "string", "description": "Target machine's IP/DNS"}, "username": {"type": "string", "description": "Username of the target machine"}, "platform": {"type": "string", "description": "Platform of the target machine."}, "script_info": {"description": "Script execution details", "$ref": "#/definitions/ScriptJobScriptInfo"}}, "type": "object"}, "ScriptJobListModel": {"required": ["completed_at", "execution_type", "initiated_by", "started_at", "status", "status_reason"], "properties": {"script_job_id": {"type": "string", "description": "Unique ID of the Script Job"}, "script_job_name": {"type": "string", "description": "Name of the Script Job"}, "status": {"type": "string", "description": "Overall status of the script execution"}, "status_reason": {"type": "string", "description": "Error message if failed"}, "started_at": {"type": "string", "description": "Script Job start time in UTC"}, "completed_at": {"type": "string", "description": "Script Job completion time in UTC"}, "execution_type": {"type": "string", "description": "Script Job execution type (on_demand/scheduled)"}, "initiated_by": {"type": "string", "description": "User who initiated the script execution"}}, "type": "object"}, "ScriptJobListResponse": {"required": ["script_jobs", "total_pages", "total_script_jobs"], "properties": {"total_script_jobs": {"type": "string", "description": "Total number of script jobs available"}, "total_pages": {"type": "string", "description": "Total number of pages"}, "script_jobs": {"description": "Script Jobs List.", "$ref": "#/definitions/ScriptJobListModel"}}, "type": "object"}, "ScriptJobScriptInfo": {"required": ["config_type", "output_parameters", "parameters", "script_id", "script_name", "started_at", "status", "status_reason"], "properties": {"script_id": {"type": "string", "description": "Script Id"}, "script_name": {"type": "string", "description": "Script Name"}, "config_type": {"type": "string", "description": "Config type of the script(s)"}, "parameters": {"type": "object", "description": "Parameters of the script."}, "parameter_source": {"type": "string", "description": "Parameter source - whether as per the one defined in script or custom json", "default": "script", "example": "script", "enum": ["script", "json"], "x-cs-enum-type": "ParameterSource"}, "output_parameters": {"type": "object", "description": "Output parameters of the script (all applied parameters)."}, "status": {"type": "string", "description": "Status of the script execution"}, "status_reason": {"type": "string", "description": "Error message if failed"}, "started_at": {"type": "string", "description": "Execution start time in UTC"}}, "type": "object"}, "ScriptListResponse": {"required": ["scripts", "total_pages", "total_scripts"], "properties": {"total_scripts": {"type": "string", "description": "Total number of scripts available"}, "total_pages": {"type": "string", "description": "Total number of pages"}, "scripts": {"description": "Scripts List.", "$ref": "#/definitions/ScriptDataList"}}, "type": "object"}, "ScriptMinimumRequirements": {"properties": {"ram(MB)": {"type": "number", "description": "Minimum RAM required(in MB) to install the script.", "default": 0.0}, "cpu": {"type": "integer", "description": "Minimum CPU core required(in MB) to install the script.", "default": 0}, "disk(MB)": {"type": "number", "description": "Minimum disk space required(in MB) to install the script.", "default": 0.0}}, "type": "object"}, "ScriptScanRequest": {"required": ["config_type", "script_info"], "properties": {"config_type": {"type": "string", "description": "Config type of the script", "example": "chef", "enum": ["chef", "ansible", "puppet", "shell"], "x-cs-enum-type": "ConfigType"}, "script_info": {"type": "array", "description": "script info", "items": {"$ref": "#/definitions/ScriptInfo"}}, "dependencies": {"type": "array", "description": "Details of the dependent scripts if any", "items": {"$ref": "#/definitions/ScriptInfo"}}, "playbook_yaml": {"type": "string", "description": "Playbook yaml path - mandatory for ansible scripts"}}, "type": "object"}, "SecopsVulnerabilitySeverityQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["severity"], "properties": {"severity": {"type": "array", "description": "Severity values to include", "items": {"type": "string", "description": "Severity values", "example": "Critical", "enum": ["Critical", "High", "Info", "Low", "Medium", "None", "Unknown"], "x-cs-enum-type": "Severity"}}}, "type": "object"}], "x-cs-type-name": "SecopsVulnerabilitySeverityQueryOperator"}, "SecureDetails": {"properties": {"id": {"type": "string", "description": "ID"}, "cloud_account_id": {"type": "string", "description": "cloud account id"}, "subscription_id": {"type": "string", "description": "Azure Subscription ID."}, "created_at": {"type": "string", "description": "When the schedule is created"}, "created_by": {"type": "string", "description": "Who has created the schedule"}, "tenant_id": {"type": "string", "description": "Id of the tenant"}, "tenant_name": {"type": "string", "description": "Name of the tenant"}, "secure_scores": {"description": "secure score for the cloud account", "$ref": "#/definitions/SecureScoreDetails"}, "cloud_account_name": {"type": "string", "description": "Cloud Service Name"}, "cloud_name": {"type": "string", "description": "Cloud Service Name"}, "subscription_name": {"type": "string", "description": "Name of the subscription from Azure"}, "updated_at": {"type": "string", "description": "Date and Time of Update"}, "updated_by": {"type": "string", "description": "Who has updated the secure score"}, "recommendations": {"description": "Secure score deatils", "$ref": "#/definitions/SecureScoreDerivedDetails"}}, "type": "object"}, "SecureScore": {"properties": {"max": {"type": "integer", "description": "SecureScore max for the tenant"}, "current": {"type": "number", "description": "SecureScore current for the tenant"}, "percentage": {"type": "number", "description": "SecureScore percentage for the tenant"}}, "type": "object"}, "SecureScoreDerivedDetails": {"properties": {"display_name": {"type": "string", "description": "Display name of policy which allow space this is to mostly show on the ui"}, "healthy_resource_count": {"type": "integer", "description": "Number of healthy resources in the control"}, "unhealthy_resource_count": {"type": "integer", "description": "Number of unhealthy resources in the control"}, "non_applicable_resource_count": {"type": "integer", "description": "Number of not applicable resources in the control"}, "score": {"description": "Secure score for the tenant", "$ref": "#/definitions/SecureScore"}, "weight": {"type": "integer", "description": "Secure score for the tenant"}}, "type": "object"}, "SecureScoreDetails": {"properties": {"id": {"type": "string", "description": "ID of the cloud account subscription"}, "name": {"type": "string", "description": "Secure score name for azure subscription"}, "type": {"type": "string", "description": "Microsoft api for secure scores"}, "properties": {"description": "Secure score value", "$ref": "#/definitions/SecureScoreDerivedDetails"}}, "type": "object"}, "SecurityDashboardAccessViolationByTrend": {"properties": {"month": {"type": "string", "format": "date", "description": "Access Violation Month"}, "count_by_severity": {"description": "Access Violations Severity Values", "$ref": "#/definitions/SecurityDashboardSeverity"}}, "type": "object"}, "SecurityDashboardAccountFilters": {"properties": {"tenants": {"type": "array", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.", "items": {"type": "string"}}, "clouds": {"type": "array", "description": "Define the Cloud Providers to include.", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "cloud_accounts": {"type": "array", "description": "Specify the Cloud Account IDs.", "items": {"type": "string"}}}, "type": "object"}, "SecurityDashboardCompliance": {"properties": {"cloud_account_id": {"type": "string", "description": "Cloud Account Id"}, "high": {"$ref": "#/definitions/SecurityDashboardComplianceSeverity"}, "medium": {"$ref": "#/definitions/SecurityDashboardComplianceSeverity"}, "low": {"$ref": "#/definitions/SecurityDashboardComplianceSeverity"}}, "type": "object"}, "SecurityDashboardComplianceControlHealth": {"properties": {"control_family": {"type": "string", "description": "Name of Compliance Control Family"}, "trend": {"type": "array", "items": {"$ref": "#/definitions/SecurityDashboardComplianceControlHealthTrend"}}}, "type": "object"}, "SecurityDashboardComplianceControlHealthTrend": {"properties": {"month": {"type": "string", "format": "date", "description": "Control Health Month"}, "measured_risk": {"type": "string", "description": "Compliance Measured Risk Levels", "example": "High", "enum": ["High", "Medium", "Low", "Not_Assessed"], "x-cs-enum-type": "ComplianceMeasuredRisk"}}, "type": "object"}, "SecurityDashboardComplianceSeverity": {"properties": {"total": {"type": "integer", "description": "Total Severity Count"}, "violations": {"type": "integer", "description": "Total Violations Count"}}, "type": "object"}, "SecurityDashboardComplianceStatus": {"properties": {"compliance_name": {"type": "string", "description": "Name of Compliance"}, "cloud_accounts_status": {"type": "array", "description": "Security Dashboard Compliance", "items": {"$ref": "#/definitions/SecurityDashboardCompliance"}}}, "type": "object"}, "SecurityDashboardConfigViolationMonth": {"properties": {"month": {"type": "string", "format": "date", "description": "Config Violation Month"}, "count_by_severity": {"description": "Config Violations Severity Values", "$ref": "#/definitions/SecurityDashboardSeverity"}}, "type": "object"}, "SecurityDashboardRequest": {"properties": {"filter": {"$ref": "#/definitions/SecurityDashboardAccountFilters"}}, "type": "object"}, "SecurityDashboardSeverity": {"properties": {"critical": {"type": "integer", "description": "Critical Total Count", "default": 0}, "high": {"type": "integer", "description": "High Total Count", "default": 0}, "medium": {"type": "integer", "description": "Medium Total Count", "default": 0}, "low": {"type": "integer", "description": "Low Total Count", "default": 0}, "none": {"type": "integer", "description": "None Total Count", "default": 0}, "info": {"type": "integer", "description": "Info Total Count", "default": 0}, "unknown": {"type": "integer", "description": "Unknown Total Count", "default": 0}}, "type": "object"}, "SecurityDashboardThreatSummaryMonthResponse": {"properties": {"summary_by_month": {"type": "array", "description": "Visibility of the Threats by Month", "items": {"$ref": "#/definitions/SecurityDashboardThreatsMonth"}}}, "type": "object"}, "SecurityDashboardThreatsAccountDetails": {"properties": {"tenant_id": {"type": "string", "description": "Tenant value"}, "cloud_account_id": {"type": "string", "description": "Cloud Account value"}, "service_account_name": {"type": "string", "description": "Service Account Name"}, "cloud_provider": {"type": "string", "description": "Visibility for the Cloud Provider", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "count_by_severity": {"description": "Threats Severity Values", "$ref": "#/definitions/SecurityDashboardSeverity"}}, "type": "object"}, "SecurityDashboardThreatsByRegionCount": {"properties": {"cloud_provider": {"type": "string", "description": "Visibility for the Cloud Provider", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "region": {"type": "string", "description": "Threats Count by region name"}, "threat_count": {"type": "integer", "description": "Threats Total Count by region"}}, "type": "object"}, "SecurityDashboardThreatsByRegionResponse": {"properties": {"summary_by_cloudprovider": {"type": "array", "description": "Visibility of the threats by CloudProvider", "items": {"$ref": "#/definitions/SecurityDashboardThreatsByRegionCount"}}}, "type": "object"}, "SecurityDashboardThreatsByResourceCategoryCount": {"properties": {"cloud_account_id": {"type": "string", "description": "Cloud Account Id"}, "resource_category": {"type": "string", "description": "Name of the Resource Category"}, "threat_count": {"type": "integer", "description": "Threats Total Count by resource category"}, "resource_count": {"type": "integer", "description": "Total Count by Resource"}}, "type": "object"}, "SecurityDashboardThreatsByResourceCategoryResponse": {"properties": {"summary_by_provider_category": {"type": "array", "description": "Visibility of the threats by CloudProvider", "items": {"$ref": "#/definitions/SecurityDashboardThreatsByResourceCategoryCount"}}}, "type": "object"}, "SecurityDashboardThreatsMonth": {"properties": {"month": {"type": "string", "format": "date", "description": "Threats Month"}, "count_by_severity": {"description": "Threats Severity Values", "$ref": "#/definitions/SecurityDashboardSeverity"}}, "type": "object"}, "SecurityDashboardThreatsSummaryAccountResponse": {"properties": {"summary_by_accounts": {"type": "array", "description": "Visibility of the Threats by Account", "items": {"$ref": "#/definitions/SecurityDashboardThreatsAccountDetails"}}}, "type": "object"}, "SecurityDashboardViolationAccountDetails": {"properties": {"tenant_id": {"type": "string", "description": "Tenant value"}, "cloud_account_id": {"type": "string", "description": "Cloud Account value"}, "service_account_name": {"type": "string", "description": "Service Account Name"}, "cloud_provider": {"type": "string", "description": "Visibility for the Cloud Provider", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "count_by_severity": {"description": "Severity Values", "$ref": "#/definitions/SecurityDashboardSeverity"}}, "type": "object"}, "SecurityDashboardViolationByRegionCount": {"properties": {"cloud_provider": {"type": "string", "description": "Visibility for the Cloud Provider", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "region": {"type": "string", "description": "Config Violation Count by region name"}, "guardrail_violation_count": {"type": "integer", "description": "Violation Total Count by region"}}, "type": "object"}, "SecurityDashboardViolationByResourceCategoryCount": {"properties": {"cloud_account_id": {"type": "string", "description": "Cloud Account ID"}, "resource_category": {"type": "string", "description": "Name of Resource Category"}, "guardrail_violation_count": {"type": "integer", "description": "Violation Total Count by Resource Category"}, "resource_count": {"type": "integer", "description": "Total Resource Count"}}, "type": "object"}, "SecurityDashboardViolationsByAccountResponse": {"properties": {"summary_by_accounts": {"type": "array", "description": "Visibility of the Violations by Account", "items": {"$ref": "#/definitions/SecurityDashboardViolationAccountDetails"}}}, "type": "object"}, "SecurityDashboardViolationsByMonthResponse": {"properties": {"summary_by_month": {"type": "array", "description": "Visibility of the Threats by Month", "items": {"$ref": "#/definitions/SecurityDashboardConfigViolationMonth"}}}, "type": "object"}, "SecurityDashboardViolationsByRegionResponse": {"properties": {"summary_by_cloudprovider": {"type": "array", "description": "Visibility of the Config Violation by CloudProvider", "items": {"$ref": "#/definitions/SecurityDashboardViolationByRegionCount"}}}, "type": "object"}, "SecurityDashboardViolationsByResourceCategoryResponse": {"properties": {"summary_by_provider_category": {"type": "array", "description": "Visibility of the Config Violation by CloudProvider", "items": {"$ref": "#/definitions/SecurityDashboardViolationByResourceCategoryCount"}}}, "type": "object"}, "SecurityDashboardVulnerabilityAccountDetails": {"required": ["cloud_account_id", "service_account_name", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant value"}, "cloud_account_id": {"type": "string", "description": "Cloud Account value"}, "service_account_name": {"type": "string", "description": "Service Account Name"}, "cloud_provider": {"type": "string", "description": "Visibility for the Cloud Provider", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "count_by_severity": {"description": "Vulnerability Severity Values", "$ref": "#/definitions/SecurityDashboardSeverity"}}, "type": "object"}, "SecurityDashboardVulnerabilityMonth": {"properties": {"month": {"type": "string", "description": "Vulnerability Month"}, "count_by_severity": {"description": "Vulnerability Severity Values", "$ref": "#/definitions/SecurityDashboardSeverity"}}, "type": "object"}, "SecurityDashboardVulnerabilityRegionCount": {"properties": {"cloud_provider": {"type": "string", "description": "Visibility for the Cloud Provider", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "count_by_regions": {"type": "array", "description": "Vulnerability Count by region", "items": {"$ref": "#/definitions/SecurityDashboardVulnerabilityRegionValue"}}}, "type": "object"}, "SecurityDashboardVulnerabilityRegionValue": {"properties": {"region": {"type": "string", "description": "Visibility of Region Name"}, "vulnerabilityCount": {"type": "integer", "description": "Visibility of Vulnerability Count by region", "default": 0}}, "type": "object"}, "SecurityDashboardVulnerabilitySummaryAccountResponse": {"properties": {"summary_by_accounts": {"type": "array", "description": "Visibility of the vulnerabilities by Account", "items": {"$ref": "#/definitions/SecurityDashboardVulnerabilityAccountDetails"}}}, "type": "object"}, "SecurityDashboardVulnerabilitySummaryRegionResponse": {"properties": {"summary_by_cloudprovider": {"type": "array", "description": "Visibility of the vulnerabilities by Account", "items": {"$ref": "#/definitions/SecurityDashboardVulnerabilityRegionCount"}}}, "type": "object"}, "SecurityFinding": {"required": ["category", "created_at", "execution_phase", "layer", "severity", "source_tool", "status", "title", "updated_at"], "properties": {"finding_id": {"type": "string", "description": "Unique identifier for the security finding record in the system", "x-cs-type": "ObjectId"}, "category": {"type": "string", "description": "High-level classification of the security finding type (Misconfiguration, Vulnerability, or Threat)", "example": "Misconfiguration", "enum": ["Misconfiguration", "Vulnerability", "Threat"], "x-cs-enum-type": "SecurityFindingsCategory"}, "source_tool": {"type": "string", "description": "Name of the security scanning tool that originally detected and reported this finding", "example": "Hadolint", "enum": ["Hadolint", "Dockle", "AzureDefender", "InspectorV2", "InspectorClassic", "SecurityCommandCenter", "CloudGuard", "Guardduty"], "x-cs-enum-type": "SecurityFindingsSourceTool"}, "execution_phase": {"type": "string", "description": "Phase in the software development lifecycle when this security issue was detected (Build or Runtime)", "example": "Build", "enum": ["Build", "Runtime"], "x-cs-enum-type": "SecurityFindingsExecutionPhase"}, "layer": {"type": "string", "description": "Architectural layer where the security issue exists (Container, Infrastructure, Supplychain, or API)", "example": "Container", "enum": ["Container", "Infrastructure", "Supplychain", "API"], "x-cs-enum-type": "SecurityFindingsLayer"}, "severity": {"type": "string", "description": "Normalized severity level indicating the criticality and potential impact of the security finding", "example": "critical", "enum": ["critical", "high", "medium", "low", "informational", "none"], "x-cs-enum-type": "SecurityFindingsSeverity"}, "status": {"type": "string", "description": "Current resolution status of the security finding (open for unresolved, resolved for fixed)", "example": "open", "enum": ["open", "resolved"], "x-cs-enum-type": "SecurityFindingsStatus"}, "title": {"type": "string", "description": "Concise, human-readable summary title describing the specific security issue found"}, "description": {"type": "string", "description": "Detailed explanation of the security finding, including what was detected and why it is a concern"}, "recommendation": {"type": "string", "description": "Actionable guidance and best practices for addressing and resolving the security finding"}, "remediation": {"type": "string", "description": "Specific step-by-step instructions for fixing the security issue and preventing recurrence"}, "created_at": {"type": "string", "format": "date-time", "description": "Timestamp indicating when this security finding was first discovered and recorded in the system"}, "updated_at": {"type": "string", "format": "date-time", "description": "Timestamp of the most recent modification or status change to this security finding record"}}, "type": "object"}, "SecurityFindingNativeDetailsBase": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "SecurityFindingNativeDetailsBaseForCloud", "subtype_name": "SecurityFindingNativeDetailsBaseForCloud"}, {"subtype_model": "SecurityFindingNativeDetailsBaseForContainer", "subtype_name": "SecurityFindingNativeDetailsBaseForContainer"}, {"subtype_model": "SecurityFindingNativeDetailsForDockle", "subtype_name": "SecurityFindingNativeDetailsForDockle"}, {"subtype_model": "SecurityFindingNativeDetailsForHadolint", "subtype_name": "SecurityFindingNativeDetailsForHadolint"}]}, "SecurityFindingNativeDetailsBaseForCloud": {"allOf": [{"$ref": "#/definitions/SecurityFindingNativeDetailsBase"}, {"properties": {"resource_id": {"type": "string", "description": "Unique identifier of the cloud resource where the security finding was detected"}, "resource_category": {"type": "string", "description": "High-level category classification of the cloud resource (e.g., compute, storage, network)"}, "resource_type": {"type": "string", "description": "Specific type of cloud resource (e.g., EC2 instance, S3 bucket, RDS database)"}, "resource": {"type": "string", "description": "Human-readable name or identifier of the specific cloud resource instance"}, "inventory_id": {"type": "string", "description": "Internal inventory system identifier for tracking the cloud resource", "x-cs-type": "ObjectId"}, "tenant_id": {"type": "string", "description": "Unique identifier of the tenant organization that owns the resource", "x-cs-type": "ObjectId"}, "service_account_id": {"type": "string", "description": "Identifier of the cloud service account used to access and scan the resource", "x-cs-type": "ObjectId"}, "source_service_account_id": {"type": "string", "description": "Identifier of the original service account when using delegate or cross-account access (e.g., AWS Inspector)", "x-cs-type": "ObjectId"}, "finding_id": {"type": "string", "description": "Original finding identifier as provided by the external security scanning tool"}, "finding_type": {"type": "string", "description": "Classification type of the security finding as defined by the external scanning tool"}, "region": {"type": "string", "description": "Geographic region or availability zone where the cloud resource is located"}, "resource_group": {"type": "string", "description": "Logical grouping or organizational unit containing the cloud resource"}, "vulnerability_id": {"type": "string", "description": "Internal reference identifier linking to detailed vulnerability information", "x-cs-type": "ObjectId"}, "detected_at": {"type": "string", "format": "date-time", "description": "Timestamp indicating when the security finding was first detected by the scanning tool"}, "source_data": {"type": "object", "description": "Complete raw data payload from the external security tool containing all original finding details"}}, "type": "object"}], "x-cs-type-name": "SecurityFindingNativeDetailsBaseForCloud"}, "SecurityFindingNativeDetailsBaseForContainer": {"allOf": [{"$ref": "#/definitions/SecurityFindingNativeDetailsBase"}, {"properties": {"sbom_version_id": {"type": "string", "description": "Unique identifier of the SBOM version associated with the container or Dockerfile that was scanned", "x-cs-type": "ObjectId"}, "code": {"type": "string", "description": "Unique rule identifier code for the specific security check that detected this finding"}, "detected_at": {"type": "string", "format": "date-time", "description": "Timestamp indicating when the security finding was first detected by the scanning tool"}}, "type": "object"}], "x-cs-type-name": "SecurityFindingNativeDetailsBaseForContainer"}, "SecurityFindingNativeDetailsForDockle": {"allOf": [{"$ref": "#/definitions/SecurityFindingNativeDetailsBaseForContainer"}, {"properties": {"image": {"type": "string", "description": "Full name and tag of the container image that was analyzed by Dockle for security vulnerabilities"}, "alert": {"type": "string", "description": "Specific alert message from Dockle that represents this individual finding"}, "source_data": {"description": "Complete original data from Dockle containing detailed finding information and scan results", "$ref": "#/definitions/SecurityFindingSourceDetailsForDockle"}}, "type": "object"}], "x-cs-type-name": "SecurityFindingNativeDetailsForDockle"}, "SecurityFindingNativeDetailsForHadolint": {"allOf": [{"$ref": "#/definitions/SecurityFindingNativeDetailsBaseForContainer"}, {"properties": {"file": {"type": "string", "description": "File path of the Dockerfile that was scanned by Hadolint for best practices and security issues"}, "line": {"type": "integer", "description": "Line number in the Dockerfile where the security issue was detected"}, "column": {"type": "integer", "description": "Column position within the line where the security issue begins"}, "source_data": {"description": "Complete original data from Hadolint containing detailed finding information and scan results", "$ref": "#/definitions/SecurityFindingSourceDetailsForHadolint"}}, "type": "object"}], "x-cs-type-name": "SecurityFindingNativeDetailsForHadolint"}, "SecurityFindingSourceDetailsForDockle": {"properties": {"image": {"type": "string", "description": "Name and tag of the container image that was scanned by Dockle for security issues"}, "summary": {"description": "Statistical summary of all security findings categorized by severity level", "$ref": "#/definitions/ContainerFindingDockleSummary"}, "details": {"type": "array", "description": "Detailed list of individual security findings discovered during the Dockle scan", "items": {"$ref": "#/definitions/ContainerFindingDockleDetails"}}}, "type": "object"}, "SecurityFindingSourceDetailsForHadolint": {"properties": {"file": {"type": "string", "description": "File path of the Dockerfile that was analyzed by Hadolint"}, "line": {"type": "integer", "description": "Line number in the Dockerfile where the security issue was detected"}, "column": {"type": "integer", "description": "Column position within the line where the security issue begins"}, "level": {"type": "string", "description": "Severity level of the Dockerfile security issue as classified by Hadolint", "example": "error", "enum": ["error", "warning", "info", "style", "ignore"], "x-cs-enum-type": "ContainerFindingsHadolintFindingLevel"}, "code": {"type": "string", "description": "Unique rule identifier code for the specific Hadolint security check that was violated"}, "message": {"type": "string", "description": "Detailed explanation of the security issue and recommended remediation steps"}}, "type": "object"}, "SecurityGovernanceFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"segn_2601_b_security_issues_point_in_time": {"type": "boolean", "description": "Flag's default value", "default": true}, "segn_2601_b_security_issues_trend": {"type": "boolean", "description": "Flag's default value", "default": true}, "segn_2602_a_resource_detail_view": {"type": "boolean", "description": "Flag's default value", "default": true}, "segn_2602_a_application_with_bcs_questions": {"type": "boolean", "description": "Flag's default value", "default": true}, "segn_2603_a_application_to_workload": {"type": "boolean", "description": "Flag's default value", "default": true}}, "type": "object"}]}, "SecurityInfraDashboardBaseFilters": {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "List of Tenant IDs to filter the threats/vulnerabilities. This can be fetched from the List Tenants API call.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "filters": {"description": "Query based on Cloud Providers, Cloud Account Ids, Statuses, Severities, ResourceCategories, ResourceTypes, Resources, Resource ID(s)", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "SecurityInfraDashboardSummaryDetails": {"properties": {"cloud_provider": {"type": "string", "description": "Cloud Provider of the service account", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "service_account_id": {"type": "string", "description": "ID of the service account to which the threat/vulnerability/misconfiguration belongs to.", "x-cs-type": "ObjectId"}, "severity": {"type": "string", "description": "Severity values", "example": "Critical", "enum": ["Critical", "High", "Info", "Low", "Medium", "None", "Unknown"], "x-cs-enum-type": "Severity"}, "region": {"type": "string", "description": "Region the impacted resource is located in."}, "resource_category": {"type": "string", "description": "Category of the resource to which the threat/vulnerability/misconfiguration belongs to."}, "resource_type": {"type": "string", "description": "Type of the resource to which the threat/vulnerability/misconfiguration belongs to."}, "resource_ids": {"type": "array", "description": "List of Resource ID(s) where the vulnerability/threat/misconfiguration is observed.", "items": {"type": "string"}}, "ids": {"type": "array", "description": "List of Unique ID(s) for vulnerability/threat/misconfiguration depending on the context.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "SecurityInfraDashboardSummaryRequest": {"allOf": [{"$ref": "#/definitions/SecurityInfraDashboardBaseFilters"}, {"required": ["group_by"], "properties": {"group_by": {"type": "array", "items": {"type": "string", "description": "Group by field to aggregate the summary data.", "example": "Region", "enum": ["Region", "Service_Account", "Resource_Category", "Resource_Type", "Severity"], "x-cs-enum-type": "SecurityInfraDashboardSummaryGroupBy"}}}, "type": "object"}]}, "SecurityInfraIssuesDashboardFilters": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID to filter the issues. This can be fetched from the List Tenants API call.", "x-cs-type": "ObjectId"}, "query": {"description": "Query based on Cloud Providers, Cloud Account Ids, Severities, ResourceCategories, ResourceTypes, Resources", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "SecurityPostureResponse": {"required": ["cloud_account", "page_count", "service", "total_count"], "properties": {"service": {"type": "object", "description": "Service wise details of the security findings"}, "cloud_account": {"type": "object", "description": "Cloud Account wise details of the security findings"}, "total_count": {"type": "integer", "description": "Total count of cloud accounts"}, "page_count": {"type": "integer", "description": "Total number of page count"}}, "type": "object"}, "SecurityPostureTenantResponse": {"required": ["page_count", "tenants", "total_count"], "properties": {"page_count": {"type": "integer", "description": "Total number of page count"}, "tenants": {"type": "object", "description": "Tenant wise count details"}, "total_count": {"type": "integer", "description": "Number of Tenants"}}, "type": "object"}, "SecurityThreatValidationForGCPResponse": {"properties": {"event_threat_detection": {"type": "boolean", "description": "If set, Event Threat Detection is enabled."}, "container_threat_detection": {"type": "boolean", "description": "If set, Container Threat Detection is enabled."}}, "type": "object"}, "SecurityThreatValidationForOCIResponse": {"properties": {"cloud_guard": {"type": "boolean", "description": "If set, Cloud Guard is enabled."}}, "type": "object"}, "SecurityVisibilityResponse": {"required": ["cloud_accounts", "count_summary", "findings_type", "intent", "resource_types"], "properties": {"cloud_accounts": {"type": "object", "description": "Visibility of the findings by cloud_accounts"}, "findings_type": {"type": "object", "description": "Visibility of the findings by findings_type"}, "resource_types": {"type": "object", "description": "Visibility of the findings by resource_types"}, "intent": {"type": "object", "description": "Visibility of the findings by intent"}, "count_summary": {"type": "object", "description": "Visibility of the findings count_summary"}}, "type": "object"}, "SecurityVulnerabilityResponse": {"required": ["cloud_accounts", "count_summary", "findings_type", "resource_types"], "properties": {"findings_type": {"type": "object", "description": "Visibility of the vulnerabilities by findings_type"}, "resource_types": {"type": "object", "description": "Visibility of the vulnerabilities by resource_types"}, "cloud_accounts": {"type": "object", "description": "Visibility of the vulnerabilities by cloud_accounts"}, "count_summary": {"type": "object", "description": "Visibility of the vulnerabilities by count_summary"}}, "type": "object"}, "SecurityVulnerabilitySummaryMonthResponse": {"properties": {"summary_by_month": {"type": "array", "description": "Visibility of the vulnerabilities by Month", "items": {"$ref": "#/definitions/SecurityDashboardVulnerabilityMonth"}}}, "type": "object"}, "SecurityVulnerabilityValidationForGCPResponse": {"properties": {"web_security_scanner": {"type": "boolean", "description": "If set, Web Security Scanner is enabled."}, "security_health_analytics": {"type": "boolean", "description": "If set, Security Health Analytics is enabled."}}, "type": "object"}, "SecurityVulnerabilityValidationForOCIResponse": {"properties": {"host_scan_target": {"type": "boolean", "description": "If set, Host Scan Target is enabled."}}, "type": "object"}, "SelfServiceCatalogHierarchyComponent": {"properties": {"level1": {"type": "string", "description": "Catalog Classification First Level"}, "level2": {"type": "string", "description": "Catalog Classification Second Level"}, "level3": {"type": "string", "description": "Catalog Classification Third Level"}, "classification_name": {"type": "string", "description": "Catalog Classification Name"}}, "type": "object"}, "SelfServiceDefaultValuesBase": {"properties": {}, "type": "object"}, "SelfServiceDefaultValuesForAws": {"allOf": [{"$ref": "#/definitions/SelfServiceDefaultValuesBase"}, {"properties": {"regions": {"type": "string", "description": "Default Region"}, "subnet": {"type": "string", "description": "Default Subnet"}}, "type": "object"}]}, "SelfServiceDefaultValuesForAzure": {"allOf": [{"$ref": "#/definitions/SelfServiceDefaultValuesBase"}, {"properties": {"locations": {"type": "string", "description": "Default Location"}, "resource_group": {"type": "string", "description": "Default ResourceGroup"}, "virtual_network": {"type": "string", "description": "Default Virtual Network"}, "storage_account": {"type": "string", "description": "Default Storage Account"}, "subnet": {"type": "string", "description": "Default Subnet"}, "is_resource_group_configurable": {"type": "boolean", "description": "Whether resourceGroup configurable or not"}}, "type": "object"}]}, "SelfServiceDefaultValuesForCloudstack": {"allOf": [{"$ref": "#/definitions/SelfServiceDefaultValuesBase"}, {"properties": {"network": {"type": "string", "description": "Default Network"}, "zone": {"type": "string", "description": "Default Zone"}}, "type": "object"}]}, "SelfServiceDefaultValuesForGcp": {"allOf": [{"$ref": "#/definitions/SelfServiceDefaultValuesBase"}, {"properties": {"zone": {"type": "string", "description": "Default Zone"}, "network": {"type": "string", "description": "Default network"}, "subnetwork": {"type": "string", "description": "Default subnetwork"}}, "type": "object"}]}, "SelfServiceDefaultValuesForOpenstack": {"allOf": [{"$ref": "#/definitions/SelfServiceDefaultValuesBase"}, {"properties": {"tenants": {"type": "string", "description": "Default Tenant"}, "public_network": {"type": "string", "description": "Default Public Network"}, "private_network": {"type": "string", "description": "Default Private Network"}}, "type": "object"}]}, "ServiceAccountAssessmentDetails": {"properties": {"score": {"type": "integer", "description": "Assessment Score"}, "grade": {"type": "string", "description": "Assessment Grade"}, "last_assessed_time": {"type": "string", "description": "Last Assessment Time"}}, "type": "object"}, "ServiceAccountBatchRequest": {"allOf": [{"$ref": "#/definitions/RecordIdentityBatchRequest"}, {"properties": {"include_billing_as_parent": {"type": "boolean", "description": "Also include billing accounts as parents.", "default": false}, "include_fields": {"type": "array", "description": "List of fields to include in the response. Must be a subset of ServiceAccountDetails keys.", "items": {"type": "string", "example": "created_by", "enum": ["created_by", "created_at", "updated_by", "updated_at", "parent_id", "source_account_id", "billing_account_id", "resource_service_account_id", "tenant_id", "name", "description", "currency", "use_in_self_service", "status", "keystone_tenant_id", "scope", "onboarding_type", "onboarded_features", "native_details", "credentials", "credentials_temp", "custom_tags", "assessment_details", "governance_configuration", "is_active_in_cloud", "skip_access_validation"], "x-cs-enum-type": "ServiceAccountDetailsField"}}, "include_sync_status": {"type": "array", "description": "List of fields to include in the response. Must be a subset of ServiceAccountSync keys.", "items": {"type": "string", "example": "access_governance", "enum": ["access_governance", "access_validation", "advisor_data", "application_performance_data", "aws_compute_optimizer_data", "aws_security_hub", "azure_ea_unit_price", "azure_hub_discount", "billing_info", "cloud_account_tag", "cloudops__activity_assessment", "cloudops__backup", "cloudops__bigquery_metric", "cloudops__custom_metric", "cloudops__log_analytics_query", "cloudops__metric", "cloudops__monitoring_alert_assessment", "cloudops__patch_management", "cloudops__ssm", "credential_validation", "dimension_precompute", "daily_cost_report", "finops__assessment_report", "finops__budget_data", "finops__cost_anomaly", "finops__cost_savings", "finops__crp_recommendation", "finops__enterprise_discount_program", "finops__recommendation_v2", "finops__ri_ontology_sync", "finops__savings_plans", "finops__schedule_recommendation", "finops__sp_ontology_sync", "gcp_security_command_center", "governance_configuration", "governance_configuration_validation", "governance_report", "hierarchy_data", "inventory_data", "inventory_data__dashboard_sync", "inventory_data__dependency_sync", "inventory_data__lock_sync", "inventory_data__relationship_sync", "inventory_report", "kubernetes_cluster_agent_sync_job", "kubernetes_cluster_agent_health", "metric_utilization_data", "monthly_cost_report", "network_data", "proactive_scanner", "recovery_data", "reserved_instances_recommendation", "reserved_instances_utilization", "secure_score_data", "security__azure_sentinel", "security__tenable_nessus", "servicenow_cmdb_sync_job", "system_policy_execution", "threat_data", "utilization_metrics_data", "vulnerability_data", "wellarchitected__auto_assessment"], "x-cs-enum-type": "ServiceAccountSyncField"}}, "additional_fields": {"type": "array", "items": {"type": "string", "description": "Additional fields to include in the response", "example": "child_account_count", "enum": ["child_account_count", "parent_accounts_info"], "x-cs-enum-type": "ServiceAccountDetailsAdditionalField"}}}, "type": "object"}]}, "ServiceAccountBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/ServiceAccountDetailsWithAdditionalInfo"}}}, "type": "object"}, "ServiceAccountChild": {"properties": {"native_details": {"description": "Native details of the account. This is a required field.", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, "count": {"type": "integer", "description": "Number of child accounts."}}, "type": "object"}, "ServiceAccountCloudAccessPolicy": {"properties": {"access_type": {"type": "string", "description": "Cloud access type to select", "example": "read", "enum": ["read", "write"], "x-cs-enum-type": "CloudAccountAccessType"}, "access_policy": {"type": "string", "description": "Cloud Access Policy"}}, "type": "object"}, "ServiceAccountCredentialsBase": {"required": ["type"], "properties": {}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ServiceAccountCredentialsBaseForAws", "subtype_name": "ServiceAccountCredentialsBaseForAws"}, {"subtype_model": "ServiceAccountCredentialsForAwsAccessKeyProtocol", "subtype_name": "ServiceAccountCredentialsForAwsAccessKeyProtocol"}, {"subtype_model": "ServiceAccountCredentialsForAwsAssumeRoleProtocol", "subtype_name": "ServiceAccountCredentialsForAwsAssumeRoleProtocol"}, {"subtype_model": "ServiceAccountCredentialsBaseForAzure", "subtype_name": "ServiceAccountCredentialsBaseForAzure"}, {"subtype_model": "ServiceAccountCredentialsBaseForAzureApplication", "subtype_name": "ServiceAccountCredentialsBaseForAzureApplication"}, {"subtype_model": "ServiceAccountCredentialsBaseForAzureApiKey", "subtype_name": "ServiceAccountCredentialsBaseForAzureApiKey"}, {"subtype_model": "ServiceAccountCredentialsForAzureSubscription", "subtype_name": "ServiceAccountCredentialsForAzureSubscription"}, {"subtype_model": "ServiceAccountCredentialsBaseForAzureCsp", "subtype_name": "ServiceAccountCredentialsBaseForAzureCsp"}, {"subtype_model": "ServiceAccountCredentialsForAzureCspApplication", "subtype_name": "ServiceAccountCredentialsForAzureCspApplication"}, {"subtype_model": "ServiceAccountCredentialsForAzureCspAuthorizationCode", "subtype_name": "ServiceAccountCredentialsForAzureCspAuthorizationCode"}, {"subtype_model": "ServiceAccountCredentialsForAzureEaApiKey", "subtype_name": "ServiceAccountCredentialsForAzureEaApiKey"}, {"subtype_model": "ServiceAccountCredentialsForAzureEaApplication", "subtype_name": "ServiceAccountCredentialsForAzureEaApplication"}, {"subtype_model": "ServiceAccountCredentialsForAzureMcaApplication", "subtype_name": "ServiceAccountCredentialsForAzureMcaApplication"}, {"subtype_model": "ServiceAccountCredentialsBaseForOci", "subtype_name": "ServiceAccountCredentialsBaseForOci"}, {"subtype_model": "ServiceAccountCredentialsForOci", "subtype_name": "ServiceAccountCredentialsForOci"}, {"subtype_model": "ServiceAccountCredentialsBaseForGcp", "subtype_name": "ServiceAccountCredentialsBaseForGcp"}, {"subtype_model": "ServiceAccountCredentialsBaseForGcpOauthProtocol", "subtype_name": "ServiceAccountCredentialsBaseForGcpOauthProtocol"}, {"subtype_model": "ServiceAccountCredentialsBaseForGcpServiceAccountProtocol", "subtype_name": "ServiceAccountCredentialsBaseForGcpServiceAccountProtocol"}, {"subtype_model": "ServiceAccountCredentialsForGcpBillingAccountOauthProtocol", "subtype_name": "ServiceAccountCredentialsForGcpBillingAccountOauthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForGcpBillingAccountServiceAccountProtocol", "subtype_name": "ServiceAccountCredentialsForGcpBillingAccountServiceAccountProtocol"}, {"subtype_model": "ServiceAccountCredentialsForGcpParentBillingAccountOauthProtocol", "subtype_name": "ServiceAccountCredentialsForGcpParentBillingAccountOauthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForGcpParentBillingAccountServiceAccountProtocol", "subtype_name": "ServiceAccountCredentialsForGcpParentBillingAccountServiceAccountProtocol"}, {"subtype_model": "ServiceAccountCredentialsForGcpLinkedProjectAccountOauthProtocol", "subtype_name": "ServiceAccountCredentialsForGcpLinkedProjectAccountOauthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForGcpServiceAccountProtocol", "subtype_name": "ServiceAccountCredentialsForGcpServiceAccountProtocol"}, {"subtype_model": "ServiceAccountCredentialsForGcpInherited", "subtype_name": "ServiceAccountCredentialsForGcpInherited"}, {"subtype_model": "ServiceAccountCredentialsForAzureStack", "subtype_name": "ServiceAccountCredentialsForAzureStack"}, {"subtype_model": "ServiceAccountCredentialsForCloudStack", "subtype_name": "ServiceAccountCredentialsForCloudStack"}, {"subtype_model": "ServiceAccountCredentialsBaseForOpenStack", "subtype_name": "ServiceAccountCredentialsBaseForOpenStack"}, {"subtype_model": "ServiceAccountCredentialsForOpenStack", "subtype_name": "ServiceAccountCredentialsForOpenStack"}, {"subtype_model": "ServiceAccountCredentialsForBasicAuth", "subtype_name": "ServiceAccountCredentialsForBasicAuth"}, {"subtype_model": "ServiceAccountCredentialsForRackspace", "subtype_name": "ServiceAccountCredentialsForRackspace"}, {"subtype_model": "ServiceAccountCredentialsForMsVmm", "subtype_name": "ServiceAccountCredentialsForMsVmm"}, {"subtype_model": "ServiceAccountCredentialsForVmware", "subtype_name": "ServiceAccountCredentialsForVmware"}, {"subtype_model": "ServiceAccountCredentialsForVcenter", "subtype_name": "ServiceAccountCredentialsForVcenter"}, {"subtype_model": "ServiceAccountCredentialsBaseForVmwareVcd", "subtype_name": "ServiceAccountCredentialsBaseForVmwareVcd"}, {"subtype_model": "ServiceAccountCredentialsForVmwareVcdMaster", "subtype_name": "ServiceAccountCredentialsForVmwareVcdMaster"}, {"subtype_model": "ServiceAccountCredentialsForVmwareVcdOrganizationVdc", "subtype_name": "ServiceAccountCredentialsForVmwareVcdOrganizationVdc"}, {"subtype_model": "ServiceAccountCredentialsForPrivateCloud", "subtype_name": "ServiceAccountCredentialsForPrivateCloud"}, {"subtype_model": "ServiceAccountCredentialsForAppDynamics", "subtype_name": "ServiceAccountCredentialsForAppDynamics"}, {"subtype_model": "ServiceAccountCredentialsForAppInsights", "subtype_name": "ServiceAccountCredentialsForAppInsights"}, {"subtype_model": "ServiceAccountCredentialsForAzureDevops", "subtype_name": "ServiceAccountCredentialsForAzureDevops"}, {"subtype_model": "ServiceAccountCredentialsBaseForAzureSecurityGraph", "subtype_name": "ServiceAccountCredentialsBaseForAzureSecurityGraph"}, {"subtype_model": "ServiceAccountCredentialsForAzureSecurityGraphBasicAuthProtocol", "subtype_name": "ServiceAccountCredentialsForAzureSecurityGraphBasicAuthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForAzureSecurityGraphOAuthProtocol", "subtype_name": "ServiceAccountCredentialsForAzureSecurityGraphOAuthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForAzureSentinel", "subtype_name": "ServiceAccountCredentialsForAzureSentinel"}, {"subtype_model": "ServiceAccountCredentialsForCorestack", "subtype_name": "ServiceAccountCredentialsForCorestack"}, {"subtype_model": "ServiceAccountCredentialsForDockerHub", "subtype_name": "ServiceAccountCredentialsForDockerHub"}, {"subtype_model": "ServiceAccountCredentialsForElasticSearch", "subtype_name": "ServiceAccountCredentialsForElasticSearch"}, {"subtype_model": "ServiceAccountCredentialsForFreshservice", "subtype_name": "ServiceAccountCredentialsForFreshservice"}, {"subtype_model": "ServiceAccountCredentialsBaseForGitHub", "subtype_name": "ServiceAccountCredentialsForGitHub"}, {"subtype_model": "ServiceAccountCredentialsForGitHubAppProtocol", "subtype_name": "ServiceAccountCredentialsForGitHubAppProtocol"}, {"subtype_model": "ServiceAccountCredentialsForGitHubPersonalAccessTokenProtocol", "subtype_name": "ServiceAccountCredentialsForGitHubPersonalAccessTokenProtocol"}, {"subtype_model": "ServiceAccountCredentialsForJiraDatacenter", "subtype_name": "ServiceAccountCredentialsForJiraDatacenter"}, {"subtype_model": "ServiceAccountCredentialsForJiraServicedesk", "subtype_name": "ServiceAccountCredentialsForJiraServicedesk"}, {"subtype_model": "ServiceAccountCredentialsForJiraServiceManagementBasicAuthProtocol", "subtype_name": "ServiceAccountCredentialsForJiraServiceManagementBasicAuthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForJiraServiceManagementInherited", "subtype_name": "ServiceAccountCredentialsForJiraServiceManagementInherited"}, {"subtype_model": "ServiceAccountCredentialsForJenkins", "subtype_name": "ServiceAccountCredentialsForJenkins"}, {"subtype_model": "ServiceAccountCredentialsForLogstash", "subtype_name": "ServiceAccountCredentialsForLogstash"}, {"subtype_model": "ServiceAccountCredentialsForMicrosoftTeams", "subtype_name": "ServiceAccountCredentialsForMicrosoftTeams"}, {"subtype_model": "ServiceAccountCredentialsForNagios", "subtype_name": "ServiceAccountCredentialsForNagios"}, {"subtype_model": "ServiceAccountCredentialsForNewrelic", "subtype_name": "ServiceAccountCredentialsForNewrelic"}, {"subtype_model": "ServiceAccountCredentialsForPrometheus", "subtype_name": "ServiceAccountCredentialsForPrometheus"}, {"subtype_model": "ServiceAccountCredentialsForQualys", "subtype_name": "ServiceAccountCredentialsForQualys"}, {"subtype_model": "ServiceAccountCredentialsForRedhatSatellite", "subtype_name": "ServiceAccountCredentialsForRedhatSatellite"}, {"subtype_model": "ServiceAccountCredentialsBaseForServiceNow", "subtype_name": "ServiceAccountCredentialsBaseForServiceNow"}, {"subtype_model": "ServiceAccountCredentialsForServiceNowOauthProtocol", "subtype_name": "ServiceAccountCredentialsForServiceNowOauthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForServiceNowBasicAuthProtocol", "subtype_name": "ServiceAccountCredentialsForServiceNowBasicAuthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForArrowSphere", "subtype_name": "ServiceAccountCredentialsForArrowSphere"}, {"subtype_model": "ServiceAccountCredentialsForTclItsm", "subtype_name": "ServiceAccountCredentialsForTclItsm"}, {"subtype_model": "ServiceAccountCredentialsForTenableNessus", "subtype_name": "ServiceAccountCredentialsForTenableNessus"}, {"subtype_model": "ServiceAccountCredentialsForZohoServiceDeskCloud", "subtype_name": "ServiceAccountCredentialsForZohoServiceDeskCloud"}, {"subtype_model": "ServiceAccountCredentialsForZohoServiceDeskOnPremise", "subtype_name": "ServiceAccountCredentialsForZohoServiceDeskOnPremise"}, {"subtype_model": "ServiceAccountCredentialsForZabbix", "subtype_name": "ServiceAccountCredentialsForZabbix"}, {"subtype_model": "ServiceAccountCredentialsBaseForKubernetesCluster", "subtype_name": "ServiceAccountCredentialsBaseForKubernetesCluster"}, {"subtype_model": "ServiceAccountCredentialsForKubernetesClusterPlatformManaged", "subtype_name": "ServiceAccountCredentialsForKubernetesClusterPlatformManaged"}, {"subtype_model": "ServiceAccountCredentialsForKubernetesClusterOnboarded", "subtype_name": "ServiceAccountCredentialsForKubernetesClusterOnboarded"}, {"subtype_model": "ServiceAccountCredentialsForKubernetesClusterAzureApplication", "subtype_name": "ServiceAccountCredentialsForKubernetesClusterAzureApplication"}, {"subtype_model": "ServiceAccountCredentialsBaseForKubernetesClusterAws", "subtype_name": "ServiceAccountCredentialsBaseForKubernetesClusterAws"}, {"subtype_model": "ServiceAccountCredentialsForKubernetesClusterAwsAccessKeyProtocol", "subtype_name": "ServiceAccountCredentialsForKubernetesClusterAwsAccessKeyProtocol"}, {"subtype_model": "ServiceAccountCredentialsForKubernetesClusterAwsAssumeRoleProtocol", "subtype_name": "ServiceAccountCredentialsForKubernetesClusterAwsAssumeRoleProtocol"}, {"subtype_model": "ServiceAccountCredentialsForKubernetesClusterOci", "subtype_name": "ServiceAccountCredentialsForKubernetesClusterOci"}, {"subtype_model": "ServiceAccountCredentialsBaseForKubernetesClusterGcp", "subtype_name": "ServiceAccountCredentialsBaseForKubernetesClusterGcp"}, {"subtype_model": "ServiceAccountCredentialsForKubernetesClusterGcpServiceAccountProtocol", "subtype_name": "ServiceAccountCredentialsForKubernetesClusterGcpServiceAccountProtocol"}, {"subtype_model": "ServiceAccountCredentialsForKubernetesClusterGcpOauthProtocol", "subtype_name": "ServiceAccountCredentialsForKubernetesClusterGcpOauthProtocol"}, {"subtype_model": "ServiceAccountCredentialsBaseForSaas", "subtype_name": "ServiceAccountCredentialsForSaas"}, {"subtype_model": "ServiceAccountCredentialsForSaasOnboarded", "subtype_name": "ServiceAccountCredentialsForSaasOnboarded"}, {"subtype_model": "ServiceAccountCredentialsBaseForSaasAws", "subtype_name": "ServiceAccountCredentialsBaseForSaasAws"}, {"subtype_model": "ServiceAccountCredentialsForSaasAwsAccessKeyProtocol", "subtype_name": "ServiceAccountCredentialsForSaasAwsAccessKeyProtocol"}, {"subtype_model": "ServiceAccountCredentialsForSaasAwsAssumeRoleProtocol", "subtype_name": "ServiceAccountCredentialsForSaasAssumeRoleProtocol"}, {"subtype_model": "ServiceAccountCredentialsForSaasOci", "subtype_name": "ServiceAccountCredentialsForSaasOci"}, {"subtype_model": "ServiceAccountCredentialsBaseForSaasGcp", "subtype_name": "ServiceAccountCredentialsBaseForSaasGcp"}, {"subtype_model": "ServiceAccountCredentialsForSaasGcpServiceAccountProtocol", "subtype_name": "ServiceAccountCredentialsForSaasGcpServiceAccountProtocol"}, {"subtype_model": "ServiceAccountCredentialsForSaasGcpOauthProtocol", "subtype_name": "ServiceAccountCredentialsForSaasGcpOauthProtocol"}, {"subtype_model": "ServiceAccountCredentialsForSaasAzureApplication", "subtype_name": "ServiceAccountCredentialsForSaasAzureApplication"}]}, "ServiceAccountCredentialsBaseForAws": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForAws"}, "ServiceAccountCredentialsBaseForAzure": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"managed_identity_client_id": {"type": "string", "description": "Managed Identity Client Id."}, "virtual_machine_id": {"type": "string", "description": "Virtual Machine Id attached to the managed identity."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForAzure"}, "ServiceAccountCredentialsBaseForAzureApiKey": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzure"}, {"properties": {"api_key": {"type": "string", "description": "API Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForAzureApiKey"}, "ServiceAccountCredentialsBaseForAzureApplication": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzure"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id. This is a required field."}, "application_id": {"type": "string", "description": "Application Id. This is a required field."}, "application_secret": {"type": "string", "description": "Application Secret. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForAzureApplication"}, "ServiceAccountCredentialsBaseForAzureCsp": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureApplication"}, {"properties": {"storage_account_tenant_id": {"type": "string", "description": "Storage Account Tenant Id."}, "storage_account_application_id": {"type": "string", "description": "Storage Account Application Id."}, "storage_account_application_secret": {"type": "string", "description": "Storage Account Application Secret.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForAzureCsp"}, "ServiceAccountCredentialsBaseForAzureSecurityGraph": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id. This is a required field."}, "application_id": {"type": "string", "description": "Application Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForAzureSecurityGraph"}, "ServiceAccountCredentialsBaseForGcp": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForGcp"}, "ServiceAccountCredentialsBaseForGcpOauthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcp"}, {"properties": {"client_id": {"type": "string", "description": "Client Id. This is a required field."}, "client_secret": {"type": "string", "description": "Client Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "redirect_uri": {"type": "string", "description": "Redirect URI. This is a required field."}, "authorization_code": {"type": "string", "description": "Authorization Code. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForGcpOauthProtocol"}, "ServiceAccountCredentialsBaseForGcpServiceAccountProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcp"}, {"properties": {"client_email": {"type": "string", "description": "Client Email.  This is a required field."}, "client_id": {"type": "string", "description": "Client Id. This is a required field."}, "private_key": {"type": "string", "description": "Private Key. This is a required field.", "x-cs-type": "SensitiveString"}, "private_key_id": {"type": "string", "description": "Private Key Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForGcpServiceAccountProtocol"}, "ServiceAccountCredentialsBaseForGitHub": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"auth_url": {"type": "string", "description": "URL for the authentication."}, "organization_name": {"type": "string", "description": "Organization Name. This is a required field"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGitHub"}, "ServiceAccountCredentialsBaseForJiraServiceManagement": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {}, "type": "object"}]}, "ServiceAccountCredentialsBaseForKubernetesCluster": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForKubernetesCluster"}, "ServiceAccountCredentialsBaseForKubernetesClusterAws": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesCluster"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForKubernetesClusterAws"}, "ServiceAccountCredentialsBaseForKubernetesClusterGcp": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesCluster"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForKubernetesClusterGcp"}, "ServiceAccountCredentialsBaseForOci": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForOci"}, "ServiceAccountCredentialsBaseForOpenStack": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "password": {"type": "string", "description": "Password. This is a required field.", "x-cs-type": "SensitiveString"}, "auth_url": {"type": "string", "description": "Auth URL. This is a required field."}, "domain": {"type": "string", "description": "Domain Name"}, "insecure": {"type": "boolean", "description": "SSL Verification disabled or not"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForOpenStack"}, "ServiceAccountCredentialsBaseForSaas": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForSaas"}, "ServiceAccountCredentialsBaseForSaasAws": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaas"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForSaasAws"}, "ServiceAccountCredentialsBaseForSaasGcp": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaas"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForSaasGcp"}, "ServiceAccountCredentialsBaseForServiceNow": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"auth_url": {"type": "string", "description": "Auth URL. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForServiceNow"}, "ServiceAccountCredentialsBaseForStackOpsIntegration": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {}, "type": "object"}]}, "ServiceAccountCredentialsBaseForVmwareVcd": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"domain": {"type": "string", "description": "Domain. This is a required field."}, "api_key": {"type": "string", "description": "API Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsBaseForVmwareVcd"}, "ServiceAccountCredentialsForAppDynamics": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"appdynamics_url": {"type": "string", "description": "API Endpoint. This is a required field."}, "client_id": {"type": "string", "description": "Client Id. This is a required field."}, "client_secret": {"type": "string", "description": "Client Secret. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAppDynamics"}, "ServiceAccountCredentialsForAppInsights": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"application_id": {"type": "string", "description": "Application Id. This is a required field."}, "secret_key": {"type": "string", "description": "Secret Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAppInsights"}, "ServiceAccountCredentialsForArrowSphere": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForStackOpsIntegration"}, {"properties": {"url": {"type": "string", "description": "URL. This is a required field."}, "api_key": {"type": "string", "description": "API Key. This is a required field."}, "api_secret": {"type": "string", "description": "Secret Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForArrowSphere"}, "ServiceAccountCredentialsForAwsAccessKeyProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAws"}, {"properties": {"access_key": {"type": "string", "description": "Access Key Id. This is a required field."}, "secret_key": {"type": "string", "description": "Secret Access Key Id. This is a required field.", "x-cs-type": "SensitiveString"}, "s3_access_key": {"type": "string", "description": "Access Key Id to access S3 bucket in which CUR export available."}, "s3_secret_key": {"type": "string", "description": "Secret Access Key Id to access S3 bucket in which CUR export is available.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAwsAccessKeyProtocol"}, "ServiceAccountCredentialsForAwsAssumeRoleProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAws"}, {"properties": {"assume_role_arn": {"type": "string", "description": "Role ARN. This is a required field."}, "assume_role_external_id": {"type": "string", "description": "External ID configured in Assume Role. This is a required field."}, "assume_role_mfa_enabled": {"type": "boolean", "description": "Whether MFA enabled or not in Assume Role. This is a required field."}, "s3_access_key": {"type": "string", "description": "Access Key Id to access S3 bucket in which CUR export available."}, "s3_secret_key": {"type": "string", "description": "Secret Access Key Id to access S3 bucket in which CUR export is available.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAwsAssumeRoleProtocol"}, "ServiceAccountCredentialsForAzureCspApplication": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureCsp"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureCspApplication"}, "ServiceAccountCredentialsForAzureCspAuthorizationCode": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureCsp"}, {"properties": {"redirect_uri": {"type": "string", "description": "Redirection URI. This is a required field."}, "authorization_code": {"type": "string", "description": "Authorization Code for Token refresh. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureCspAuthorizationCode"}, "ServiceAccountCredentialsForAzureDevops": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "personalaccesstoken": {"type": "string", "description": "Personal Access Token. This is a required field.", "x-cs-type": "SensitiveString"}, "auth_url": {"type": "string", "description": "Auth URL. This is a required field."}, "organization": {"type": "string", "description": "Organization. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureDevops"}, "ServiceAccountCredentialsForAzureEaApiKey": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureApiKey"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureEaApiKey"}, "ServiceAccountCredentialsForAzureEaApplication": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureApplication"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureEaApplication"}, "ServiceAccountCredentialsForAzureMcaApplication": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureApplication"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureMcaApplication"}, "ServiceAccountCredentialsForAzureSecurityGraphBasicAuthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureSecurityGraph"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "password": {"type": "string", "description": "Password. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureSecurityGraphBasicAuthProtocol"}, "ServiceAccountCredentialsForAzureSecurityGraphOAuthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureSecurityGraph"}, {"properties": {"application_secret": {"type": "string", "description": "Application Secret. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureSecurityGraphOAuthProtocol"}, "ServiceAccountCredentialsForAzureSentinel": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id. This is a required field."}, "application_id": {"type": "string", "description": "Application Id. This is a required field."}, "application_secret": {"type": "string", "description": "Application Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "workspace_id": {"type": "string", "description": "Workspace Id. This is a required field."}, "shared_key": {"type": "string", "description": "Shared Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureSentinel"}, "ServiceAccountCredentialsForAzureStack": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id. This is a required field."}, "application_id": {"type": "string", "description": "Application Id. This is a required field."}, "application_secret": {"type": "string", "description": "Application Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "azurestack_endpoint": {"type": "string", "description": "Authentication Endpoint. This is a required field."}, "resource_endpoint": {"type": "string", "description": "Resource Endpoint. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureStack"}, "ServiceAccountCredentialsForAzureSubscription": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForAzureApplication"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForAzureSubscription"}, "ServiceAccountCredentialsForBasicAuth": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "password": {"type": "string", "description": "Password. This is a required field.", "x-cs-type": "SensitiveString"}, "auth_url": {"type": "string", "description": "Auth URL. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForBasicAuth"}, "ServiceAccountCredentialsForCloudStack": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"api_key": {"type": "string", "description": "API Key. This is a required field.", "x-cs-type": "SensitiveString"}, "secret_key": {"type": "string", "description": "Secret Key. This is a required field.", "x-cs-type": "SensitiveString"}, "auth_url": {"type": "string", "description": "Auth URL. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForCloudStack"}, "ServiceAccountCredentialsForCorestack": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForCorestack"}, "ServiceAccountCredentialsForDockerHub": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForDockerHub"}, "ServiceAccountCredentialsForElasticSearch": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForElasticSearch"}, "ServiceAccountCredentialsForFreshservice": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"domain": {"type": "string", "description": "Name of the domain. This is a required field."}, "api_key": {"type": "string", "description": "API Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForFreshservice"}, "ServiceAccountCredentialsForGcpBillingAccountOauthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcpOauthProtocol"}, {"properties": {"project_id": {"type": "string", "description": "Project Id in which the billing bucket exists. This is a required field."}, "bucket_name": {"type": "string", "description": "Bucket Name. This is a required field."}, "data_set_id": {"type": "string", "description": "DataSet Id. This is a required field."}, "export_type": {"type": "string", "description": "Export Type. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGcpBillingAccountOauthProtocol"}, "ServiceAccountCredentialsForGcpBillingAccountServiceAccountProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcpServiceAccountProtocol"}, {"properties": {"project_id": {"type": "string", "description": "Project Id in which the billing bucket exists. This is a required field."}, "bucket_name": {"type": "string", "description": "Bucket Name. This is a required field."}, "data_set_id": {"type": "string", "description": "DataSet Id. This is a required field."}, "export_type": {"type": "string", "description": "Export Type. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGcpBillingAccountServiceAccountProtocol"}, "ServiceAccountCredentialsForGcpInherited": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcp"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGcpInherited"}, "ServiceAccountCredentialsForGcpLinkedProjectAccountOauthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcpOauthProtocol"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGcpLinkedProjectAccountOauthProtocol"}, "ServiceAccountCredentialsForGcpParentBillingAccountOauthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcpOauthProtocol"}, {"properties": {"project_id": {"type": "string", "description": "Project Id in which the billing bucket exists. This is a required field."}, "bucket_name": {"type": "string", "description": "Bucket Name. This is a required field."}, "data_set_id": {"type": "string", "description": "DataSet Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGcpParentBillingAccountOauthProtocol"}, "ServiceAccountCredentialsForGcpParentBillingAccountServiceAccountProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcpServiceAccountProtocol"}, {"properties": {"project_id": {"type": "string", "description": "Project Id in which the billing bucket exists. This is a required field."}, "bucket_name": {"type": "string", "description": "Bucket Name. This is a required field."}, "data_set_id": {"type": "string", "description": "DataSet Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGcpParentBillingAccountServiceAccountProtocol"}, "ServiceAccountCredentialsForGcpServiceAccountProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGcpServiceAccountProtocol"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGcpServiceAccountProtocol"}, "ServiceAccountCredentialsForGitHubAppProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGitHub"}, {"properties": {"application_id": {"type": "string", "description": "Application Id. This is a required Field."}, "private_key": {"type": "string", "description": "Private Key. This is a required Field", "x-cs-type": "SensitiveString"}, "installation_id": {"type": "string", "description": "Installation Id. This is a required Field"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGitHubAppProtocol"}, "ServiceAccountCredentialsForGitHubPersonalAccessTokenProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForGitHub"}, {"properties": {"access_token": {"type": "string", "description": "Personal Access Token. This is a required Field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForGitHubPersonalAccessTokenProtocol"}, "ServiceAccountCredentialsForJenkins": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForJenkins"}, "ServiceAccountCredentialsForJiraDatacenter": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForJiraDatacenter"}, "ServiceAccountCredentialsForJiraServiceManagementBasicAuthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForJiraServiceManagement"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "api_token": {"type": "string", "description": "API Token. This is a required field.", "x-cs-type": "SensitiveString"}, "domain": {"type": "string", "description": "Domain. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForJiraServiceManagementBasicAuthProtocol"}, "ServiceAccountCredentialsForJiraServiceManagementInherited": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForJiraServiceManagement"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForJiraServiceManagementInherited"}, "ServiceAccountCredentialsForJiraServicedesk": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "api_token": {"type": "string", "description": "API Token. This is a required field.", "x-cs-type": "SensitiveString"}, "auth_url": {"type": "string", "description": "Auth URL. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForJiraServicedesk"}, "ServiceAccountCredentialsForKubernetesClusterAwsAccessKeyProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesClusterAws"}, {"properties": {"access_key": {"type": "string", "description": "Access Key Id. This is a required field."}, "secret_key": {"type": "string", "description": "Secret Access Key Id. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForKubernetesClusterAwsAccessKeyProtocol"}, "ServiceAccountCredentialsForKubernetesClusterAwsAssumeRoleProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesClusterAws"}, {"properties": {"assume_role_arn": {"type": "string", "description": "Role ARN. This is a required field."}, "assume_role_external_id": {"type": "string", "description": "External ID configured in Assume Role. This is a required field."}, "assume_role_mfa_enabled": {"type": "boolean", "description": "Whether MFA enabled or not in Assume Role. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForKubernetesClusterAwsAssumeRoleProtocol"}, "ServiceAccountCredentialsForKubernetesClusterAzureApplication": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesCluster"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id. This is a required field."}, "application_id": {"type": "string", "description": "Application Id. This is a required field."}, "application_secret": {"type": "string", "description": "Application Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "subscription_id": {"type": "string", "description": "Subscription Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForKubernetesClusterAzureApplication"}, "ServiceAccountCredentialsForKubernetesClusterGcpOauthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesClusterGcp"}, {"properties": {"project_id": {"type": "string", "description": "Project Id in which the bucket exists. This is a required field."}, "client_id": {"type": "string", "description": "Client Id. This is a required field."}, "client_secret": {"type": "string", "description": "Client Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "redirect_uri": {"type": "string", "description": "Redirect URI. This is a required field."}, "authorization_code": {"type": "string", "description": "Authorization Code. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForKubernetesClusterGcpOauthProtocol"}, "ServiceAccountCredentialsForKubernetesClusterGcpServiceAccountProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesClusterGcp"}, {"properties": {"project_id": {"type": "string", "description": "Project Id in which the bucket exists. This is a required field."}, "client_email": {"type": "string", "description": "Client Email.  This is a required field."}, "client_id": {"type": "string", "description": "Client Id. This is a required field."}, "private_key": {"type": "string", "description": "Private Key. This is a required field.", "x-cs-type": "SensitiveString"}, "private_key_id": {"type": "string", "description": "Private Key Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForKubernetesClusterGcpServiceAccountProtocol"}, "ServiceAccountCredentialsForKubernetesClusterOci": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesCluster"}, {"properties": {"user": {"type": "string", "description": "Auth User Id. This is a required field."}, "fingerprint": {"type": "string", "description": "Key Fingerprint. This is a required field.", "x-cs-type": "SensitiveString"}, "private_key": {"type": "string", "description": "Private Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForKubernetesClusterOci"}, "ServiceAccountCredentialsForKubernetesClusterOnboarded": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesCluster"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForKubernetesClusterOnboarded"}, "ServiceAccountCredentialsForKubernetesClusterPlatformManaged": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForKubernetesCluster"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForKubernetesClusterPlatformManaged"}, "ServiceAccountCredentialsForLogstash": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {"certificate_file": {"type": "string", "description": "Certificate File. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForLogstash"}, "ServiceAccountCredentialsForMicrosoftTeams": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id. This is a required field."}, "application_id": {"type": "string", "description": "Application Id. This is a required field."}, "application_secret": {"type": "string", "description": "Application Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "auth_url": {"type": "string", "description": "Auth URL. This is a required field."}, "group_id": {"type": "string", "description": "Group Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForMicrosoftTeams"}, "ServiceAccountCredentialsForMsVmm": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForMsVmm"}, "ServiceAccountCredentialsForNagios": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForNagios"}, "ServiceAccountCredentialsForNewrelic": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"user_api_key": {"type": "string", "description": "User API Key. This is a required field.", "x-cs-type": "SensitiveString"}, "newrelic_url": {"type": "string", "description": "NewRelic URL. This is a required field."}, "service_account_type": {"type": "string", "description": "Cloud Provider. This is a required field.", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "service_account": {"type": "string", "description": "ServiceAccount Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForNewrelic"}, "ServiceAccountCredentialsForOci": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForOci"}, {"properties": {"user": {"type": "string", "description": "Auth User Id. This is a required field."}, "fingerprint": {"type": "string", "description": "Key Fingerprint. This is a required field.", "x-cs-type": "SensitiveString"}, "private_key": {"type": "string", "description": "Private Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForOci"}, "ServiceAccountCredentialsForOpenStack": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForOpenStack"}, {"properties": {"insecure": {"type": "boolean", "description": "SSL Verification disabled or not"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForOpenStack"}, "ServiceAccountCredentialsForPrivateCloud": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForPrivateCloud"}, "ServiceAccountCredentialsForPrometheus": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "password": {"type": "string", "description": "Password. This is a required field.", "x-cs-type": "SensitiveString"}, "prometheus_url": {"type": "string", "description": "Endpoint URL. This is a required field."}, "service_account_type": {"type": "string", "description": "Cloud Provider. This is a required field.", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "service_account": {"type": "string", "description": "ServiceAccount Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForPrometheus"}, "ServiceAccountCredentialsForQualys": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"api_gateway_url": {"type": "string", "description": "API Gateway URL. This is a required field."}, "api_server_url": {"type": "string", "description": "API Server URL. This is a required field."}, "username": {"type": "string", "description": "Username. This is a required field."}, "password": {"type": "string", "description": "Password. This is a required field.", "x-cs-type": "SensitiveString"}, "service_account_type": {"type": "string", "description": "Cloud Provider. This is a required field.", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "service_account": {"type": "string", "description": "ServiceAccount Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForQualys"}, "ServiceAccountCredentialsForRackspace": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForRackspace"}, "ServiceAccountCredentialsForRedhatSatellite": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {"ssl_verify": {"type": "boolean", "description": "SSL enabled or not"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForRedhatSatellite"}, "ServiceAccountCredentialsForSaasAwsAccessKeyProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaasAws"}, {"properties": {"access_key": {"type": "string", "description": "Access Key Id. This is a required field."}, "secret_key": {"type": "string", "description": "Secret Access Key Id. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForSaasAwsAccessKeyProtocol"}, "ServiceAccountCredentialsForSaasAwsAssumeRoleProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaasAws"}, {"properties": {"assume_role_arn": {"type": "string", "description": "Role ARN. This is a required field."}, "assume_role_external_id": {"type": "string", "description": "External ID configured in Assume Role. This is a required field."}, "assume_role_mfa_enabled": {"type": "boolean", "description": "Whether MFA enabled or not in Assume Role. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForSaasAssumeRoleProtocol"}, "ServiceAccountCredentialsForSaasAzureApplication": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaas"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id. This is a required field."}, "application_id": {"type": "string", "description": "Application Id. This is a required field."}, "application_secret": {"type": "string", "description": "Application Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "subscription_id": {"type": "string", "description": "Subscription Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForSaasAzureApplication"}, "ServiceAccountCredentialsForSaasGcpOauthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaasGcp"}, {"properties": {"project_id": {"type": "string", "description": "Project Id in which the bucket exists. This is a required field."}, "client_id": {"type": "string", "description": "Client Id. This is a required field."}, "client_secret": {"type": "string", "description": "Client Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "redirect_uri": {"type": "string", "description": "Redirect URI. This is a required field."}, "authorization_code": {"type": "string", "description": "Authorization Code. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForSaasGcpOauthProtocol"}, "ServiceAccountCredentialsForSaasGcpServiceAccountProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaasGcp"}, {"properties": {"project_id": {"type": "string", "description": "Project Id in which the bucket exists. This is a required field."}, "client_email": {"type": "string", "description": "Client Email.  This is a required field."}, "client_id": {"type": "string", "description": "Client Id. This is a required field."}, "private_key": {"type": "string", "description": "Private Key. This is a required field.", "x-cs-type": "SensitiveString"}, "private_key_id": {"type": "string", "description": "Private Key Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForSaasGcpServiceAccountProtocol"}, "ServiceAccountCredentialsForSaasOci": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaas"}, {"properties": {"user": {"type": "string", "description": "Auth User Id. This is a required field."}, "fingerprint": {"type": "string", "description": "Key Fingerprint. This is a required field.", "x-cs-type": "SensitiveString"}, "private_key": {"type": "string", "description": "Private Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForSaasOci"}, "ServiceAccountCredentialsForSaasOnboarded": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForSaas"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForSaasOnboarded"}, "ServiceAccountCredentialsForServiceNowBasicAuthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForServiceNow"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "password": {"type": "string", "description": "Password. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForServiceNowBasicAuthProtocol"}, "ServiceAccountCredentialsForServiceNowOauthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForServiceNow"}, {"properties": {"client_id": {"type": "string", "description": "Client Id. This is a required field."}, "client_secret": {"type": "string", "description": "Client Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "grant_type": {"type": "string", "description": "Grant Type. This is a required field.", "example": "client_credentials", "enum": ["client_credentials"], "x-cs-enum-type": "ServiceNowGrantType"}, "scope": {"type": "string", "description": "API Scope. This is a required field.", "example": "api", "enum": ["api"], "x-cs-enum-type": "ServiceNowAPIScope"}, "token_url": {"type": "string", "description": "Token URL. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForServiceNowOauthProtocol"}, "ServiceAccountCredentialsForTclItsm": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {"encryption_key": {"type": "string", "description": "Encryption key for User configuration", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForTclItsm"}, "ServiceAccountCredentialsForTenableNessus": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"accesskey": {"type": "string", "description": "Access Key Id. This is a required field."}, "secretkey": {"type": "string", "description": "Secret Access Key Id. This is a required field.", "x-cs-type": "SensitiveString"}, "auth_url": {"type": "string", "description": "Auth URL. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForTenableNessus"}, "ServiceAccountCredentialsForVcenter": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"username": {"type": "string", "description": "Username. This is a required field."}, "password": {"type": "string", "description": "Password. This is a required field.", "x-cs-type": "SensitiveString"}, "host": {"type": "string", "description": "Auth Host. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForVcenter"}, "ServiceAccountCredentialsForVmware": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"api_key": {"type": "string", "description": "API Key. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForVmware"}, "ServiceAccountCredentialsForVmwareVcdMaster": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForVmwareVcd"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForVmwareVcdMaster"}, "ServiceAccountCredentialsForVmwareVcdOrganizationVdc": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBaseForVmwareVcd"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForVmwareVcdOrganizationVdc"}, "ServiceAccountCredentialsForZabbix": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsForBasicAuth"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForZabbix"}, "ServiceAccountCredentialsForZohoServiceDeskCloud": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"data_center": {"type": "string", "description": "Zoho ServiceDesk Datacenter. This is a required field.", "example": "UNITED_STATES", "enum": ["UNITED_STATES", "JAPAN", "AUSTRALIA", "INDIA", "CHINA", "EUROPE"], "x-cs-enum-type": "ZohoServiceDeskDataCenter"}, "client_id": {"type": "string", "description": "Client Id. This is a required field."}, "client_secret": {"type": "string", "description": "Client Secret. This is a required field.", "x-cs-type": "SensitiveString"}, "authorization_code": {"type": "string", "description": "Authorization Code. This is a required field.", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForZohoServiceDeskCloud"}, "ServiceAccountCredentialsForZohoServiceDeskOnPremise": {"allOf": [{"$ref": "#/definitions/ServiceAccountCredentialsBase"}, {"properties": {"auth_url": {"type": "string", "description": "Auth URL. This is a required field."}, "auth_token": {"type": "string", "description": "Auth Token. This is a required field.", "x-cs-type": "SensitiveString"}, "ssl_verify": {"type": "boolean", "description": "SSL Verify enabled or not"}, "api_version": {"type": "string", "description": "API version", "example": "v1", "enum": ["v1", "v3"], "x-cs-enum-type": "ZohoServiceDeskAPIVersion"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountCredentialsForZohoServiceDeskOnPremise"}, "ServiceAccountDetails": {"properties": {"created_by": {"type": "string", "description": "Name of the user who created the account."}, "created_at": {"type": "string", "format": "date-time", "description": "Account creation timestamp"}, "updated_by": {"type": "string", "description": "Name of the user who recently updated the account."}, "updated_at": {"type": "string", "format": "date-time", "description": "Account last updated timestamp."}, "parent_id": {"type": "string", "description": "Parent account of the account.", "x-cs-type": "ObjectId"}, "source_account_id": {"type": "string", "description": "Source account id in case of created from associated accounts."}, "billing_account_id": {"type": "string", "description": "Link to Service Account that is used to retrieve billing information.", "x-cs-type": "ObjectId"}, "resource_service_account_id": {"type": "string", "description": "Reference to the Service Account under which the resource is provisioned.", "x-cs-type": "ObjectId"}, "tenant_id": {"type": "string", "description": "Tenant Id. This is a required field.", "x-cs-type": "ObjectId"}, "name": {"type": "string", "description": "Name of the account. This is a required field."}, "description": {"type": "string", "description": "A brief description of the account."}, "currency": {"type": "string", "description": "Billing currency of the account.", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}, "use_in_self_service": {"type": "boolean", "description": "If set, the account will be used in self service for its tenant."}, "status": {"type": "string", "description": "Indicates the status of the account. This is a required field.", "example": "not_validated", "enum": ["not_validated", "validated", "not_onboarded", "not_onboarded_validated", "active", "inactive", "retired", "deleting"], "x-cs-enum-type": "ServiceAccountStatus"}, "keystone_tenant_id": {"type": "string", "description": "Id of the keystone tenant for mistral template executions."}, "scope": {"type": "string", "description": "Scope of the account. This is a required field.", "example": "global", "enum": ["global", "account", "tenant"], "x-cs-enum-type": "ServiceAccountScope"}, "onboarding_type": {"type": "string", "description": "Type of the onboarding. This is a required field.", "example": "manual", "enum": ["manual", "on_demand", "automatic"], "x-cs-enum-type": "ServiceAccountOnboardingType"}, "onboarded_features": {"type": "array", "items": {"$ref": "#/definitions/ServiceAccountFeatureDetails"}}, "native_details": {"description": "Native details of the account. This is a required field.", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, "credentials": {"description": "Authentication credentials of account.", "$ref": "#/definitions/ServiceAccountCredentialsBase"}, "credentials_temp": {"description": "Temporary storage for Authentication credentials of account before validation.", "$ref": "#/definitions/ServiceAccountCredentialsBase"}, "custom_tags": {"type": "array", "description": "List of tag key/value and kind", "items": {"$ref": "#/definitions/KeyValuePairKind"}}, "assessment_details": {"description": "Assessment result of the account.", "$ref": "#/definitions/ServiceAccountAssessmentDetails"}, "governance_configuration": {"description": "Governance configuration.", "$ref": "#/definitions/GovernanceConfiguration"}, "is_active_in_cloud": {"type": "boolean", "description": "Indicates whether the account is active in the native cloud.", "default": true}, "skip_access_validation": {"type": "boolean", "description": "If set, access validation checks will be skipped for this account.", "default": false}}, "type": "object"}, "ServiceAccountDetailsWithAdditionalInfo": {"allOf": [{"$ref": "#/definitions/ServiceAccountDetails"}, {"properties": {"child_account_count": {"type": "array", "description": "List of child account counts for each account.", "items": {"$ref": "#/definitions/ServiceAccountChild"}}, "parent_accounts_info": {"type": "array", "description": "List of parent account hierarchy information for each account.", "items": {"$ref": "#/definitions/ServiceAccountParentInfo"}}, "sync_status": {"description": "Sync status for each account.", "$ref": "#/definitions/ServiceAccountSync"}}, "type": "object"}]}, "ServiceAccountEphemeralCredentialsBase": {"required": ["type"], "properties": {"valid_until": {"type": "string", "format": "date-time", "description": "Expiration Time of Credentials"}, "failure_reason": {"type": "string", "description": "Invalid credentials"}, "retry_after": {"type": "integer", "description": "Request submitted, in the queue. Retry after X seconds."}}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ServiceAccountEphemeralCredentialsForAwsAssumeRoleProtocol", "subtype_name": "ServiceAccountEphemeralCredentialsForAwsAssumeRoleProtocol"}, {"subtype_model": "ServiceAccountEphemeralCredentialsBaseForAzure", "subtype_name": "ServiceAccountEphemeralCredentialsBaseForAzure"}, {"subtype_model": "ServiceAccountEphemeralCredentialsForAzureCsp", "subtype_name": "ServiceAccountEphemeralCredentialsForAzureCsp"}, {"subtype_model": "ServiceAccountEphemeralCredentialsForAzureManagedIdentity", "subtype_name": "ServiceAccountEphemeralCredentialsForAzureManagedIdentity"}, {"subtype_model": "ServiceAccountEphemeralCredentialsForGcpOauthProtocol", "subtype_name": "ServiceAccountEphemeralCredentialsForGcpOauthProtocol"}, {"subtype_model": "ServiceAccountEphemeralCredentialsForGcpServiceAccountProtocol", "subtype_name": "ServiceAccountEphemeralCredentialsForGcpServiceAccountProtocol"}, {"subtype_model": "ServiceAccountEphemeralCredentialsForVmware", "subtype_name": "ServiceAccountEphemeralCredentialsForVmware"}, {"subtype_model": "ServiceAccountEphemeralCredentialsForGitHubAppProtocol", "subtype_name": "ServiceAccountEphemeralCredentialsForGitHubAppProtocol"}, {"subtype_model": "ServiceAccountEphemeralCredentialsForZohoServiceDeskCloud", "subtype_name": "ServiceAccountEphemeralCredentialsForZohoServiceDeskCloud"}]}, "ServiceAccountEphemeralCredentialsBaseForAzure": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsBaseForAzure"}, "ServiceAccountEphemeralCredentialsForAwsAssumeRoleProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBase"}, {"properties": {"access_key": {"type": "string", "description": "Access Key Id"}, "secret_key": {"type": "string", "description": "Secret Access Key Id", "x-cs-type": "SensitiveString"}, "session_token": {"type": "string", "description": "Session Token", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsForAwsAssumeRoleProtocol"}, "ServiceAccountEphemeralCredentialsForAzureCsp": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBaseForAzure"}, {"properties": {"access_token": {"type": "string", "description": "Access Token", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsForAzureCsp"}, "ServiceAccountEphemeralCredentialsForAzureManagedIdentity": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBaseForAzure"}, {"properties": {"access_token": {"type": "string", "description": "Access Token", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsForAzureManagedIdentity"}, "ServiceAccountEphemeralCredentialsForGcpOauthProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBase"}, {"properties": {"access_token": {"type": "string", "description": "Access Token", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsForGcpOauthProtocol"}, "ServiceAccountEphemeralCredentialsForGcpServiceAccountProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBase"}, {"properties": {"authorization_token": {"type": "string", "description": "Access Token", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsForGcpServiceAccountProtocol"}, "ServiceAccountEphemeralCredentialsForGitHubAppProtocol": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBase"}, {"properties": {"authorization_token": {"type": "string", "description": "Authorization Token", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsForGitHubAppProtocol"}, "ServiceAccountEphemeralCredentialsForVmware": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBase"}, {"properties": {"access_token": {"type": "string", "description": "Access Token", "x-cs-type": "SensitiveString"}, "token_created_at": {"type": "string", "format": "date-time", "description": "Access Token Generated Timestamp"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsForVmware"}, "ServiceAccountEphemeralCredentialsForZohoServiceDeskCloud": {"allOf": [{"$ref": "#/definitions/ServiceAccountEphemeralCredentialsBase"}, {"properties": {"access_token": {"type": "string", "description": "Access Token", "x-cs-type": "SensitiveString"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountEphemeralCredentialsForZohoServiceDeskCloud"}, "ServiceAccountFeatureDetails": {"properties": {"feature": {"type": "string", "description": "Feature for the account", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}, "status": {"type": "string", "description": "Status of an account feature", "example": "onboarding", "enum": ["onboarding", "onboarding_failed", "onboarded", "offboarding", "offboarding_failed"], "x-cs-enum-type": "ServiceAccountFeatureStatus"}, "inactive": {"type": "boolean", "description": "If set, feature is temporarily inactive"}, "silence": {"type": "boolean", "description": "If set, feature failures will not raise a warning in the UI"}, "desired_status": {"type": "string", "description": "The desired status of the service account", "example": "onboarding", "enum": ["onboarding", "onboarding_failed", "onboarded", "offboarding", "offboarding_failed"], "x-cs-enum-type": "ServiceAccountFeatureStatus"}, "failure_reason": {"type": "string", "description": "Failure reason"}, "tool_account_id": {"type": "string", "description": "Optional tool account linked to this feature.", "x-cs-type": "ObjectId"}, "onboarded_at": {"type": "string", "format": "date-time", "description": "Onboarding timestamp"}, "onboarded_by": {"type": "string", "description": "Name of the user who onboarded the feature."}, "updated_at": {"type": "string", "format": "date-time", "description": "Last update timestamp"}, "background_job_id": {"description": "Background Job Id for onboarding/offboarding", "$ref": "#/definitions/RecordIdentity"}}, "type": "object"}, "ServiceAccountFeatureRequirement": {"properties": {"feature": {"type": "string", "description": "CoreStack Feature", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}, "access_type": {"type": "string", "description": "Limit to matching access types", "example": "read", "enum": ["read", "write"], "x-cs-enum-type": "CloudAccountAccessType"}, "providers": {"type": "array", "description": "Requirements for this feature, based on Provider", "items": {"$ref": "#/definitions/ServiceAccountFeatureRequirementPerProvider"}}, "executor": {"type": "string", "description": "Executor responsible for this feature", "example": "AI", "enum": ["AI", "AI_AGENT", "AI_BG", "BROKER", "COMPLIANCE", "COST", "COST_BG", "COST_BG_CLOUD_BILLING", "COST_BG_K8S_BILLING", "FEATURE_FLAGS", "GOVERNANCE", "HEATSTACK", "HEATSTACK_BG", "IDENTITY", "IDENTITY_BG", "OPERATIONS", "REPORT_GENERATION", "RESOURCE_INVENTORY", "RESOURCE_INVENTORY_BG", "SECURITY"], "x-cs-enum-type": "BackgroundJobExecutor"}, "system_only": {"type": "boolean", "description": "If set, managed by the system"}, "all_products": {"type": "boolean", "description": "If set, allowed in any account"}}, "type": "object"}, "ServiceAccountFeatureRequirementPerProvider": {"properties": {"provider": {"description": "Type of Provider this applies to", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, "mandatory_dependent_features": {"type": "array", "description": "List of sub-features that are always needed. They block onboarding until onboarded themselves.", "items": {"type": "string", "description": "Feature for the account", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}}, "optional_dependent_features": {"type": "array", "description": "List of sub-features that can be optionally enabled. They don't block onboarding until onboarded themselves.", "items": {"type": "string", "description": "Feature for the account", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}}, "ondemand_dependent_features": {"type": "array", "description": "List of sub-features that can be enabled after onboarding. They are included in access validation but don't directly participate in onboarding.", "items": {"type": "string", "description": "Feature for the account", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}}, "access_policies": {"type": "array", "description": "Cloud Access Policies required for this Provider", "items": {"$ref": "#/definitions/ServiceAccountCloudAccessPolicy"}}}, "type": "object"}, "ServiceAccountFilter": {"properties": {"name": {"type": "string", "description": "Regular expression to match against the name"}, "name_matches_any_descendants": {"type": "boolean", "description": "If set, includes accounts that have any descendant whose name matches the given name expression.", "default": false}, "search_text": {"type": "array", "description": "Free-text search terms (e.g. comma-separated values from a single search box). An account matches when any term is a case-insensitive substring of any of its identity fields: name, source account id, and the provider native details for Azure (CSP/EA/MCA partner, customer, subscription, department, billing profile, invoice section, enrollment), AWS (account, organization unit), GCP (project, folder, organization, billing account) and OCI (tenancy). Terms do not target a specific field.", "items": {"type": "string"}}, "scope": {"type": "string", "description": "Scope of the account.", "example": "global", "enum": ["global", "account", "tenant"], "x-cs-enum-type": "ServiceAccountScope"}, "master_account_ids": {"type": "array", "description": "Only include accounts from these master accounts.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "only_active_tenants": {"type": "boolean", "description": "Only include accounts from active Tenants"}, "tenant_ids": {"type": "array", "description": "Only include accounts from these Tenants.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "parent_ids": {"type": "array", "description": "Include accounts directly under these parents.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "include_parents_in_results": {"type": "boolean", "description": "Also include accounts whose ID matches any of the given parent_ids directly, in addition to their descendants.", "default": false}, "include_children_recursively": {"type": "boolean", "description": "Also include accounts that are in the descendant hierarchy in any of given parent_ids.", "default": false}, "include_billing_as_parent": {"type": "boolean", "description": "Also include accounts whose billing_account_id matches any of the given parent_ids, or their descendants when include_children_recursively is set.", "default": false}, "include_resource_as_parent": {"type": "boolean", "description": "Also include accounts whose resource_service_account_id matches any of the given parent_ids, or their descendants when include_children_recursively is set.", "default": false}, "include_commercial_as_parent": {"type": "boolean", "description": "Also include AWS GovCloud accounts whose commercial_account_id matches any of the given parent_ids, or their descendants when include_children_recursively is set.", "default": false}, "exclude_service_account_ids": {"type": "array", "description": "Add to exclude the specified accounts from results; when include_children_recursively is set along with parent_ids, their descendants are also excluded", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "with_parent": {"type": "boolean", "description": "Only include accounts with a parent."}, "without_parent": {"type": "boolean", "description": "Only include accounts without a parent."}, "currencies": {"type": "array", "description": "Only include accounts using these currencies.", "items": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "statuses": {"type": "array", "description": "Only include accounts with these statuses.", "items": {"type": "string", "description": "Indicates the status of the cloud account in corestack", "example": "not_validated", "enum": ["not_validated", "validated", "not_onboarded", "not_onboarded_validated", "active", "inactive", "retired", "deleting"], "x-cs-enum-type": "ServiceAccountStatus"}}, "include_draft_accounts": {"type": "boolean", "description": "Include accounts created by caller that are in draft mode"}, "onboarded_any": {"type": "array", "description": "Include accounts with any of these features onboarded", "items": {"type": "string", "description": "Feature for the account", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}}, "onboarded_all": {"type": "array", "description": "Include accounts with all of these features onboarded", "items": {"type": "string", "description": "Feature for the account", "example": "appsecops__onboarding", "enum": ["appsecops__onboarding", "assessments__wellarchitected", "assessments__wellarchitected__auto_assessment", "assessments__wellarchitected__auto_assessment__aws_sync", "assessments__wellarchitected__custom_framework__aws_sync", "cloudops__activity", "cloudops__activity__periodic", "cloudops__activity__real_time_sync_read", "cloudops__activity__real_time_sync_write", "cloudops__backup_management", "cloudops__cloudwatch_agent", "cloudops__monitoring_alerts", "cloudops__monitoring_alerts__periodic", "cloudops__monitoring_alerts__real_time_sync_read", "cloudops__monitoring_alerts__real_time_sync_write", "cloudops__patch_management", "cloudops__runbooks", "cloudops__utilization", "core__inventory", "core__inventory__management", "core__policy_engine", "core__policy_engine__aws_config", "core__policy_engine__azure_policy", "core__resource_discovery", "core__resource_discovery_extra", "core__tagging_governance", "core__tagging_governance_extra", "finops__assessments", "finops__azurehybridbenefit_recommendations", "finops__budget", "finops__cloud_native_recommendations", "finops__cost_anomaly", "finops__cost_processing", "finops__cost_savings", "finops__enterprise_discount_program", "finops__reservation", "finops__right_size_recommendations", "finops__savings_plans", "finops__schedule_recommendations", "governance__request", "integration__application_performance_monitoring", "integration__azure_security_graph", "integration__azure_sentinel", "integration__tenable_nessus", "secops__access", "secops__aws_security_hub", "secops__cloud_native_security_information_event_management", "secops__compliance", "secops__threats", "secops__threats__posture_read", "secops__threats__posture_write", "secops__threats__realtime_alerts_read", "secops__threats__realtime_alerts_write", "secops__vulnerabilities", "secops__vulnerabilities__read", "secops__vulnerabilities__write", "selfservice__governance", "stackops", "stackops__deployment", "system__roles"], "x-cs-enum-type": "ServiceAccountFeature"}}, "skip_inactive_features": {"type": "boolean", "description": "If set, onboarded_any and onboarded_all will also check if the features are actives"}, "check_onboarding": {"type": "boolean", "description": "If set, onboarded_any and onboarded_all will use desired_status instead of status"}, "strict_onboarded": {"type": "boolean", "description": "If set, onboarded_any and onboarded_all will ignore features in onboarding state"}, "only_restricted_cloud": {"type": "boolean", "description": "Only include accounts in restricted datacenters"}, "exclude_restricted_cloud": {"type": "boolean", "description": "Exclude all accounts in restricted datacenters"}, "native_details": {"type": "array", "description": "Only include accounts with these native types.", "items": {"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}}, "credentials": {"type": "array", "description": "Only include accounts with these credentials types.", "items": {"$ref": "#/definitions/ServiceAccountCredentialsBase"}}, "custom_tags": {"type": "array", "description": "Only include accounts with all these key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "sync_status": {"description": "Only include accounts with these sync statuses", "$ref": "#/definitions/ServiceAccountSync"}, "resource_service_account_ids": {"type": "array", "description": "Resource service account ID", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "cluster_agent_statuses": {"type": "array", "description": "Only include cluster accounts with these agent statuses.", "items": {"type": "string", "description": "Indicates the status of the Cluster Agent", "example": "active", "enum": ["active", "inactive", "in_progress"], "x-cs-enum-type": "ClusterAgentStatus"}}}, "type": "object"}, "ServiceAccountKeyValues": {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "values_by_key": {"type": "array", "description": "List of tag key/value pairs for an account", "items": {"$ref": "#/definitions/KeyValues"}}}, "type": "object"}, "ServiceAccountListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/ServiceAccountSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ServiceAccountFilter"}}, "type": "object"}, "ServiceAccountListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "ServiceAccountNameRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["service_account_name"], "properties": {"service_account_name": {"description": "Service account name regex pattern", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNameRegexQueryOperator"}, "ServiceAccountNativeDetailsBase": {"required": ["type"], "properties": {}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ServiceAccountNativeDetailsBaseForCostCenter", "subtype_name": "ServiceAccountNativeDetailsBaseForCostCenter"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForStructure", "subtype_name": "ServiceAccountNativeDetailsBaseForStructure"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForCostCenterCloud", "subtype_name": "ServiceAccountNativeDetailsBaseForCostCenterCloud"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForCostCenterDimension", "subtype_name": "ServiceAccountNativeDetailsBaseForCostCenterDimension"}, {"subtype_model": "ServiceAccountNativeDetailsForCostCenterDimension", "subtype_name": "ServiceAccountNativeDetailsForCostCenterDimension"}, {"subtype_model": "ServiceAccountNativeDetailsForCostCenterDimensionGroupingRule", "subtype_name": "ServiceAccountNativeDetailsForCostCenterDimensionGroupingRule"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForCloud", "subtype_name": "ServiceAccountNativeDetailsBaseForCloud"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForAws", "subtype_name": "ServiceAccountNativeDetailsBaseForAws"}, {"subtype_model": "ServiceAccountNativeDetailsForAwsOrganizationUnit", "subtype_name": "ServiceAccountNativeDetailsForAwsOrganizationUnit"}, {"subtype_model": "ServiceAccountNativeDetailsForAwsManagementAccount", "subtype_name": "ServiceAccountNativeDetailsForAwsManagementAccount"}, {"subtype_model": "ServiceAccountNativeDetailsForAwsMemberAccount", "subtype_name": "ServiceAccountNativeDetailsForAwsMemberAccount"}, {"subtype_model": "ServiceAccountNativeDetailsForCostCenterAws", "subtype_name": "ServiceAccountNativeDetailsForCostCenterAws"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForAzure", "subtype_name": "ServiceAccountNativeDetailsBaseForAzure"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureCspMaster", "subtype_name": "ServiceAccountNativeDetailsForAzureCspMaster"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureCspPartner", "subtype_name": "ServiceAccountNativeDetailsForAzureCspPartner"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureCspCustomer", "subtype_name": "ServiceAccountNativeDetailsForAzureCspCustomer"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForAzureSubscription", "subtype_name": "ServiceAccountNativeDetailsBaseForAzureSubscription"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureSubscription", "subtype_name": "ServiceAccountNativeDetailsForAzureSubscription"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureCspSubscription", "subtype_name": "ServiceAccountNativeDetailsForAzureCspSubscription"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForAzureEaMaster", "subtype_name": "ServiceAccountNativeDetailsBaseForAzureEaMaster"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureEaApiKeyMaster", "subtype_name": "ServiceAccountNativeDetailsForAzureEaApiKeyMaster"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureEaApplicationMaster", "subtype_name": "ServiceAccountNativeDetailsForAzureEaApplicationMaster"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureEaDepartment", "subtype_name": "ServiceAccountNativeDetailsForAzureEaDepartment"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureEaAccount", "subtype_name": "ServiceAccountNativeDetailsForAzureEaAccount"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureEaSubscription", "subtype_name": "ServiceAccountNativeDetailsForAzureEaSubscription"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureMcaBillingAccount", "subtype_name": "ServiceAccountNativeDetailsForAzureMcaBillingAccount"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureMcaBillingProfile", "subtype_name": "ServiceAccountNativeDetailsForAzureMcaBillingProfile"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureMcaInvoiceSection", "subtype_name": "ServiceAccountNativeDetailsForAzureMcaInvoiceSection"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureMcaSubscription", "subtype_name": "ServiceAccountNativeDetailsForAzureMcaSubscription"}, {"subtype_model": "ServiceAccountNativeDetailsForCostCenterAzure", "subtype_name": "ServiceAccountNativeDetailsForCostCenterAzure"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForGcp", "subtype_name": "ServiceAccountNativeDetailsBaseForGcp"}, {"subtype_model": "ServiceAccountNativeDetailsForGcpBillingAccount", "subtype_name": "ServiceAccountNativeDetailsForGcpBillingAccount"}, {"subtype_model": "ServiceAccountNativeDetailsForGcpParentBillingAccount", "subtype_name": "ServiceAccountNativeDetailsForGcpParentBillingAccount"}, {"subtype_model": "ServiceAccountNativeDetailsForGcpBillingSubAccount", "subtype_name": "ServiceAccountNativeDetailsForGcpBillingSubAccount"}, {"subtype_model": "ServiceAccountNativeDetailsForGcpOrganization", "subtype_name": "ServiceAccountNativeDetailsForGcpOrganization"}, {"subtype_model": "ServiceAccountNativeDetailsForGcpFolder", "subtype_name": "ServiceAccountNativeDetailsForGcpFolder"}, {"subtype_model": "ServiceAccountNativeDetailsForGcpProject", "subtype_name": "ServiceAccountNativeDetailsForGcpProject"}, {"subtype_model": "ServiceAccountNativeDetailsForCostCenterGcp", "subtype_name": "ServiceAccountNativeDetailsForCostCenterGcp"}, {"subtype_model": "ServiceAccountNativeDetailsForOciTenancy", "subtype_name": "ServiceAccountNativeDetailsForOciTenancy"}, {"subtype_model": "ServiceAccountNativeDetailsForCostCenterOci", "subtype_name": "ServiceAccountNativeDetailsForCostCenterOci"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureStack", "subtype_name": "ServiceAccountNativeDetailsForAzureStack"}, {"subtype_model": "ServiceAccountNativeDetailsForCloudstack", "subtype_name": "ServiceAccountNativeDetailsForCloudstack"}, {"subtype_model": "ServiceAccountNativeDetailsForOpenstack", "subtype_name": "ServiceAccountNativeDetailsForOpenstack"}, {"subtype_model": "ServiceAccountNativeDetailsForRackspace", "subtype_name": "ServiceAccountNativeDetailsForRackspace"}, {"subtype_model": "ServiceAccountNativeDetailsForVmware", "subtype_name": "ServiceAccountNativeDetailsForVmware"}, {"subtype_model": "ServiceAccountNativeDetailsForVcenter", "subtype_name": "ServiceAccountNativeDetailsForVcenter"}, {"subtype_model": "ServiceAccountNativeDetailsForMsVmm", "subtype_name": "ServiceAccountNativeDetailsForMsVmm"}, {"subtype_model": "ServiceAccountNativeDetailsForVmwareVcdMaster", "subtype_name": "ServiceAccountNativeDetailsForVmwareVcdMaster"}, {"subtype_model": "ServiceAccountNativeDetailsForVmwareVcdOrganization", "subtype_name": "ServiceAccountNativeDetailsForVmwareVcdOrganization"}, {"subtype_model": "ServiceAccountNativeDetailsForVmwareVcdOrganizationVdc", "subtype_name": "ServiceAccountNativeDetailsForVmwareVcdOrganizationVdc"}, {"subtype_model": "ServiceAccountNativeDetailsForPrivateCloud", "subtype_name": "ServiceAccountNativeDetailsForPrivateCloud"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForIntegratedTool", "subtype_name": "ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"subtype_model": "ServiceAccountNativeDetailsForAppDynamics", "subtype_name": "ServiceAccountNativeDetailsForAppDynamics"}, {"subtype_model": "ServiceAccountNativeDetailsForAppInsights", "subtype_name": "ServiceAccountNativeDetailsForAppInsights"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureDevops", "subtype_name": "ServiceAccountNativeDetailsForAzureDevops"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureSecurityGraph", "subtype_name": "ServiceAccountNativeDetailsForAzureSecurityGraph"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureSentinel", "subtype_name": "ServiceAccountNativeDetailsForAzureSentinel"}, {"subtype_model": "ServiceAccountNativeDetailsForCorestack", "subtype_name": "ServiceAccountNativeDetailsForCorestack"}, {"subtype_model": "ServiceAccountNativeDetailsForDockerHub", "subtype_name": "ServiceAccountNativeDetailsForDockerHub"}, {"subtype_model": "ServiceAccountNativeDetailsForElasticSearch", "subtype_name": "ServiceAccountNativeDetailsForElasticSearch"}, {"subtype_model": "ServiceAccountNativeDetailsForFreshservice", "subtype_name": "ServiceAccountNativeDetailsForFreshservice"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForJiraServiceManagement", "subtype_name": "ServiceAccountNativeDetailsBaseForJiraServiceManagement"}, {"subtype_model": "ServiceAccountNativeDetailsForJiraServiceManagementParent", "subtype_name": "ServiceAccountNativeDetailsForJiraServiceManagementParent"}, {"subtype_model": "ServiceAccountNativeDetailsForJiraServiceManagementProject", "subtype_name": "ServiceAccountNativeDetailsForJiraServiceManagementProject"}, {"subtype_model": "ServiceAccountNativeDetailsForGithub", "subtype_name": "ServiceAccountNativeDetailsForGithub"}, {"subtype_model": "ServiceAccountNativeDetailsForJiraDataCenter", "subtype_name": "ServiceAccountNativeDetailsForJiraDataCenter"}, {"subtype_model": "ServiceAccountNativeDetailsForJiraServiceDesk", "subtype_name": "ServiceAccountNativeDetailsForJiraServiceDesk"}, {"subtype_model": "ServiceAccountNativeDetailsForJenkins", "subtype_name": "ServiceAccountNativeDetailsForJenkins"}, {"subtype_model": "ServiceAccountNativeDetailsForLogstash", "subtype_name": "ServiceAccountNativeDetailsForLogstash"}, {"subtype_model": "ServiceAccountNativeDetailsForMicrosoftTeams", "subtype_name": "ServiceAccountNativeDetailsForMicrosoftTeams"}, {"subtype_model": "ServiceAccountNativeDetailsForNagios", "subtype_name": "ServiceAccountNativeDetailsForNagios"}, {"subtype_model": "ServiceAccountNativeDetailsForNewrelic", "subtype_name": "ServiceAccountNativeDetailsForNewrelic"}, {"subtype_model": "ServiceAccountNativeDetailsForPrometheus", "subtype_name": "ServiceAccountNativeDetailsForPrometheus"}, {"subtype_model": "ServiceAccountNativeDetailsForQualys", "subtype_name": "ServiceAccountNativeDetailsForQualys"}, {"subtype_model": "ServiceAccountNativeDetailsForRedhatSatellite", "subtype_name": "ServiceAccountNativeDetailsForRedhatSatellite"}, {"subtype_model": "ServiceAccountNativeDetailsForServiceNow", "subtype_name": "ServiceAccountNativeDetailsForServiceNow"}, {"subtype_model": "ServiceAccountNativeDetailsForArrowSphere", "subtype_name": "ServiceAccountNativeDetailsForArrowSphere"}, {"subtype_model": "ServiceAccountNativeDetailsForTclItsm", "subtype_name": "ServiceAccountNativeDetailsForTclItsm"}, {"subtype_model": "ServiceAccountNativeDetailsForTenableNessus", "subtype_name": "ServiceAccountNativeDetailsForTenableNessus"}, {"subtype_model": "ServiceAccountNativeDetailsForZohoServiceDesk", "subtype_name": "ServiceAccountNativeDetailsForZohoServiceDesk"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForResource", "subtype_name": "ServiceAccountNativeDetailsBaseForResource"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForKubernetesCluster", "subtype_name": "ServiceAccountNativeDetailsBaseForKubernetesCluster"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForKubernetesClusterCloud", "subtype_name": "ServiceAccountNativeDetailsBaseForKubernetesClusterCloud"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForKubernetesClusterOthers", "subtype_name": "ServiceAccountNativeDetailsBaseForKubernetesClusterOthers"}, {"subtype_model": "ServiceAccountNativeDetailsForAwsEksCluster", "subtype_name": "ServiceAccountNativeDetailsForAwsEksCluster"}, {"subtype_model": "ServiceAccountNativeDetailsForAzureAksCluster", "subtype_name": "ServiceAccountNativeDetailsForAzureAksCluster"}, {"subtype_model": "ServiceAccountNativeDetailsForGcpGkeCluster", "subtype_name": "ServiceAccountNativeDetailsForGcpGkeCluster"}, {"subtype_model": "ServiceAccountNativeDetailsForOciOkeCluster", "subtype_name": "ServiceAccountNativeDetailsForOciOkeCluster"}, {"subtype_model": "ServiceAccountNativeDetailsForSelfManagedCluster", "subtype_name": "ServiceAccountNativeDetailsForSelfManagedCluster"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForSaas", "subtype_name": "ServiceAccountNativeDetailsBaseForSaas"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForSaasAiServices", "subtype_name": "ServiceAccountNativeDetailsBaseForSaasAiServices"}, {"subtype_model": "ServiceAccountNativeDetailsForOpenAI", "subtype_name": "ServiceAccountNativeDetailsForOpenAI"}, {"subtype_model": "ServiceAccountNativeDetailsForAnthropic", "subtype_name": "ServiceAccountNativeDetailsForAnthropic"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForSaasDataServices", "subtype_name": "ServiceAccountNativeDetailsBaseForSaasDataServices"}, {"subtype_model": "ServiceAccountNativeDetailsForSnowflake", "subtype_name": "ServiceAccountNativeDetailsForSnowflake"}, {"subtype_model": "ServiceAccountNativeDetailsForDataBricks", "subtype_name": "ServiceAccountNativeDetailsForDataBricks"}, {"subtype_model": "ServiceAccountNativeDetailsBaseForSaasOtherServices", "subtype_name": "ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"subtype_model": "ServiceAccountNativeDetailsForDataDog", "subtype_name": "ServiceAccountNativeDetailsForDataDog"}, {"subtype_model": "ServiceAccountNativeDetailsForSplunk", "subtype_name": "ServiceAccountNativeDetailsForSplunk"}, {"subtype_model": "ServiceAccountNativeDetailsForCircleCI", "subtype_name": "ServiceAccountNativeDetailsForCircleCI"}, {"subtype_model": "ServiceAccountNativeDetailsForElastic", "subtype_name": "ServiceAccountNativeDetailsForElastic"}, {"subtype_model": "ServiceAccountNativeDetailsForSaasMicrosoftTeams", "subtype_name": "ServiceAccountNativeDetailsForSaasMicrosoftTeams"}, {"subtype_model": "ServiceAccountNativeDetailsForSalesForceSalesCloud", "subtype_name": "ServiceAccountNativeDetailsForSalesForceSalesCloud"}, {"subtype_model": "ServiceAccountNativeDetailsForDropbox", "subtype_name": "ServiceAccountNativeDetailsForDropbox"}, {"subtype_model": "ServiceAccountNativeDetailsForOkta", "subtype_name": "ServiceAccountNativeDetailsForOkta"}, {"subtype_model": "ServiceAccountNativeDetailsForSaasNewRelic", "subtype_name": "ServiceAccountNativeDetailsForSaasNewRelic"}, {"subtype_model": "ServiceAccountNativeDetailsForDynatrace", "subtype_name": "ServiceAccountNativeDetailsForDynatrace"}, {"subtype_model": "ServiceAccountNativeDetailsForGrafana", "subtype_name": "ServiceAccountNativeDetailsForGrafana"}, {"subtype_model": "ServiceAccountNativeDetailsForIbmTencent", "subtype_name": "ServiceAccountNativeDetailsForIbmTencent"}, {"subtype_model": "ServiceAccountNativeDetailsForCustomSaasTool", "subtype_name": "ServiceAccountNativeDetailsForCustomSaasTool"}, {"subtype_model": "ServiceAccountNativeDetailsForZabbix", "subtype_name": "ServiceAccountNativeDetailsForZabbix"}]}, "ServiceAccountNativeDetailsBaseForAws": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {"account_id": {"type": "string", "description": "Account Id"}, "account_name": {"type": "string", "description": "Account Name"}, "cloud_type": {"type": "string", "description": "Aws Cloud Type. This is a required field.", "example": "aws_standard", "enum": ["aws_standard", "aws_gov_cloud"], "x-cs-enum-type": "AwsCloudType"}, "regions": {"type": "array", "description": "Preferred Regions List By User. This is a required field.", "items": {"type": "string"}}, "default_values": {"description": "SelfService Default Values", "$ref": "#/definitions/SelfServiceDefaultValuesForAws"}, "cost_report_access": {"type": "string", "description": "Cost Report access", "example": "current_account", "enum": ["current_account", "commercial_account", "delegated_account", "master_account"], "x-cs-enum-type": "AwsCostReportAccess"}, "bucket_name_or_uri": {"type": "string", "description": "S3 Bucket Name or URI that is configured in Cost Usage Report"}, "custom_billing_required": {"type": "boolean", "description": "Whether custom billing processing applicable or not"}, "commercial_account_id": {"type": "string", "description": "Link to Service Account that is used to retrieve billing information for AWS GovCloud Account.", "x-cs-type": "ObjectId"}, "standard_account_id": {"type": "string", "description": "AWS Account ID of the standard account in which the billing data for the GovCloud account is stored (via S3 access key and secret key)."}, "aggregated_bucket_name_or_uri": {"type": "string", "description": "S3 Bucket Name or URI that is configured for Cost Usage Report Aggregation"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForAws"}, "ServiceAccountNativeDetailsBaseForAzure": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {"cloud_type": {"type": "string", "description": "Azure Cloud Type. This is a required field.", "example": "Azure_Global", "enum": ["Azure_Global", "Azure_China", "Azure_Government"], "x-cs-enum-type": "AzureCloudType"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForAzure"}, "ServiceAccountNativeDetailsBaseForAzureEaMaster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzure"}, {"properties": {"enrollment_id": {"type": "string", "description": "Enrollment Id. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForAzureEaMaster"}, "ServiceAccountNativeDetailsBaseForAzureSubscription": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzure"}, {"properties": {"subscription_id": {"type": "string", "description": "Subscription Id. This is a required field"}, "subscription_name": {"type": "string", "description": "Subscription Name"}, "subscription_type": {"type": "string", "description": "Azure Subscription Type. This is a required field.", "example": "Azure_CSP-Direct", "enum": ["Azure_CSP-Direct", "Enterprise", "Pay_as_You_Go", "Azure_Sponsorship", "Microsoft_Customer_Agreement", "Azure_CSP-InDirect"], "x-cs-enum-type": "AzureSubscriptionType"}, "default_values": {"description": "SelfService Default Values", "$ref": "#/definitions/SelfServiceDefaultValuesForAzure"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForAzureSubscription"}, "ServiceAccountNativeDetailsBaseForCloud": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, {"properties": {"access_type": {"type": "string", "description": "Cloud access type to select", "example": "read", "enum": ["read", "write"], "x-cs-enum-type": "CloudAccountAccessType"}, "servicenow_cmdb_configuration": {"description": "ServiceNow CMDB Configuration", "$ref": "#/definitions/ServiceNowCmdbConfigCreateRequest"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForCloud"}, "ServiceAccountNativeDetailsBaseForCostCenter": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForCostCenter"}, "ServiceAccountNativeDetailsBaseForCostCenterCloud": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCostCenter"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForCostCenterCloud"}, "ServiceAccountNativeDetailsBaseForCostCenterDimension": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCostCenter"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForCostCenterDimension"}, "ServiceAccountNativeDetailsBaseForGcp": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForGcp"}, "ServiceAccountNativeDetailsBaseForIntegratedTool": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForIntegratedTool"}, "ServiceAccountNativeDetailsBaseForJiraServiceManagement": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForJiraServiceManagement"}, "ServiceAccountNativeDetailsBaseForKubernetesCluster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForResource"}, {"properties": {"cluster_id": {"type": "string", "description": "Cluster Id."}, "cluster_name": {"type": "string", "description": "Cluster Name."}, "cluster_description": {"type": "string", "description": "Cluster Description if any."}, "prometheus_details": {"description": "Kubernetes Cluster Prometheus Details", "$ref": "#/definitions/KubernetesClusterPrometheusDetails"}, "storage": {"description": "Storage Configuration", "$ref": "#/definitions/StorageConfigurationBaseForKubernetes"}, "deployment_method": {"type": "string", "description": "Kubernetes Cluster Deployment Method.", "example": "kubernetes_deployment", "enum": ["kubernetes_deployment"], "x-cs-enum-type": "KubernetesDeploymentMethods"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForKubernetesCluster"}, "ServiceAccountNativeDetailsBaseForKubernetesClusterCloud": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForKubernetesCluster"}, {"properties": {"location": {"type": "string", "description": "Region/Zone/Resource group where the cluster is hosted."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForKubernetesClusterCloud"}, "ServiceAccountNativeDetailsBaseForKubernetesClusterOthers": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForKubernetesCluster"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForKubernetesClusterOthers"}, "ServiceAccountNativeDetailsBaseForResource": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForResource"}, "ServiceAccountNativeDetailsBaseForSaas": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForSaas"}, "ServiceAccountNativeDetailsBaseForSaasAiServices": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsForSaas"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForSaasAiServices"}, "ServiceAccountNativeDetailsBaseForSaasDataServices": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsForSaas"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForSaasDataServices"}, "ServiceAccountNativeDetailsBaseForSaasOtherServices": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsForSaas"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForSaasOtherServices"}, "ServiceAccountNativeDetailsBaseForStackOpsIntegration": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}]}, "ServiceAccountNativeDetailsBaseForStructure": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsBaseForStructure"}, "ServiceAccountNativeDetailsForAnthropic": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasAiServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAnthropic"}, "ServiceAccountNativeDetailsForAppDynamics": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAppDynamics"}, "ServiceAccountNativeDetailsForAppInsights": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAppInsights"}, "ServiceAccountNativeDetailsForArrowSphere": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStackOpsIntegration"}, {"properties": {"partner_name": {"type": "string", "description": "Partner Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForArrowSphere"}, "ServiceAccountNativeDetailsForAwsEksCluster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForKubernetesClusterCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAwsEksCluster"}, "ServiceAccountNativeDetailsForAwsManagementAccount": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAws"}, {"properties": {"root_id": {"type": "string", "description": "Id of AWS Organization Hierarchy Root"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAwsManagementAccount"}, "ServiceAccountNativeDetailsForAwsMemberAccount": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAws"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAwsMemberAccount"}, "ServiceAccountNativeDetailsForAwsOrganizationUnit": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"organization_unit_name": {"type": "string", "description": "Organization Unit Name"}, "organization_unit_id": {"type": "string", "description": "Organization Unit Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAwsOrganizationUnit"}, "ServiceAccountNativeDetailsForAzureAksCluster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForKubernetesClusterCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureAksCluster"}, "ServiceAccountNativeDetailsForAzureCspCustomer": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"customer_id": {"type": "string", "description": "Customer Id"}, "customer_name": {"type": "string", "description": "Customer Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureCspCustomer"}, "ServiceAccountNativeDetailsForAzureCspMaster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzure"}, {"properties": {"cost_report_type": {"type": "string", "description": "Cost Report Type.", "default": "billing_api", "example": "billing_api", "enum": ["billing_api", "storage_account"], "x-cs-enum-type": "CspStorageType"}, "storage_account": {"$ref": "#/definitions/StorageAccountDetailsForAzureCspMaster"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureCspMaster"}, "ServiceAccountNativeDetailsForAzureCspPartner": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"partner_mpn_id": {"type": "string", "description": "MPN ID of the Indirect Partner (Tier2MpnId)"}, "partner_name": {"type": "string", "description": "Partner Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureCspPartner"}, "ServiceAccountNativeDetailsForAzureCspSubscription": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzureSubscription"}, {"properties": {"offer_type": {"type": "string", "description": "Offer Type of the Subscription"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureCspSubscription"}, "ServiceAccountNativeDetailsForAzureDevops": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureDevops"}, "ServiceAccountNativeDetailsForAzureEaAccount": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"account_id": {"type": "string", "description": "Account Id"}, "account_name": {"type": "string", "description": "Account Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureEaAccount"}, "ServiceAccountNativeDetailsForAzureEaApiKeyMaster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzureEaMaster"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureEaApiKeyMaster"}, "ServiceAccountNativeDetailsForAzureEaApplicationMaster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzureEaMaster"}, {"properties": {"subscription_id": {"type": "string", "description": "Subscription Id in which cost export configured. This is a required field."}, "storage_account": {"type": "string", "description": "Storage account name configured in cost export. This is a required field."}, "report_path": {"type": "string", "description": "Report path for actual cost. This is a required field. Eg. {container_name}/{directory_path}/{export_report_name}."}, "amortized_report_path": {"type": "string", "description": "Report path for amortized cost. This is a optional field. Eg. {container_name}/{directory_path}/{export_report_name}."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureEaApplicationMaster"}, "ServiceAccountNativeDetailsForAzureEaDepartment": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"department_id": {"type": "string", "description": "Department Id"}, "department_name": {"type": "string", "description": "Department Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureEaDepartment"}, "ServiceAccountNativeDetailsForAzureEaSubscription": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzureSubscription"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureEaSubscription"}, "ServiceAccountNativeDetailsForAzureMcaBillingAccount": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzure"}, {"properties": {"billing_account_id": {"type": "string", "description": "Billing Account Id. This is a required field."}, "subscription_id": {"type": "string", "description": "Subscription Id in which cost export configured. This is a required field."}, "storage_account": {"type": "string", "description": "Storage account name configured in cost export. This is a required field."}, "report_path": {"type": "string", "description": "Report path for actual cost. This is a required field. Eg. {container_name}/{directory_path}/{export_report_name}."}, "amortized_report_path": {"type": "string", "description": "Report path for amortized cost. This is a optional field. Eg. {container_name}/{directory_path}/{export_report_name}."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureMcaBillingAccount"}, "ServiceAccountNativeDetailsForAzureMcaBillingProfile": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"billing_profile_id": {"type": "string", "description": "Billing Profile Id"}, "billing_profile_name": {"type": "string", "description": "Billing Profile Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureMcaBillingProfile"}, "ServiceAccountNativeDetailsForAzureMcaInvoiceSection": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"invoice_section_id": {"type": "string", "description": "Invoice Section Id"}, "invoice_section_name": {"type": "string", "description": "Invoice Section Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureMcaInvoiceSection"}, "ServiceAccountNativeDetailsForAzureMcaSubscription": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzureSubscription"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureMcaSubscription"}, "ServiceAccountNativeDetailsForAzureSecurityGraph": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {"cloud_type": {"type": "string", "description": "Azure Cloud Type. This is a required field.", "example": "Azure_Global", "enum": ["Azure_Global", "Azure_China", "Azure_Government"], "x-cs-enum-type": "AzureCloudType"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureSecurityGraph"}, "ServiceAccountNativeDetailsForAzureSentinel": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {"cloud_type": {"type": "string", "description": "Azure Cloud Type. This is a required field.", "example": "Azure_Global", "enum": ["Azure_Global", "Azure_China", "Azure_Government"], "x-cs-enum-type": "AzureCloudType"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureSentinel"}, "ServiceAccountNativeDetailsForAzureStack": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {"subscription_id": {"type": "string", "description": "Subscription Id. This is a required field."}, "default_values": {"description": "SelfService Default Values", "$ref": "#/definitions/SelfServiceDefaultValuesForAzure"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureStack"}, "ServiceAccountNativeDetailsForAzureSubscription": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForAzureSubscription"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForAzureSubscription"}, "ServiceAccountNativeDetailsForCircleCI": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCircleCI"}, "ServiceAccountNativeDetailsForCloudstack": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {"default_values": {"description": "SelfService Default Values", "$ref": "#/definitions/SelfServiceDefaultValuesForCloudstack"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCloudstack"}, "ServiceAccountNativeDetailsForCorestack": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCorestack"}, "ServiceAccountNativeDetailsForCostCenterAws": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCostCenterCloud"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCostCenterAws"}, "ServiceAccountNativeDetailsForCostCenterAzure": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCostCenterCloud"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCostCenterAzure"}, "ServiceAccountNativeDetailsForCostCenterDimension": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCostCenterDimension"}, {"properties": {"dimension_id": {"type": "string", "description": "Dimension Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCostCenterDimension"}, "ServiceAccountNativeDetailsForCostCenterDimensionGroupingRule": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCostCenterDimension"}, {"properties": {"dimension_id": {"type": "string", "description": "Dimension Id"}, "grouping_rule_id": {"type": "string", "description": "Dimension Group Rule Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCostCenterDimensionGroupingRule"}, "ServiceAccountNativeDetailsForCostCenterGcp": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCostCenterCloud"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCostCenterGcp"}, "ServiceAccountNativeDetailsForCostCenterOci": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCostCenterCloud"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCostCenterOci"}, "ServiceAccountNativeDetailsForCustomSaasTool": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {"tool_name": {"type": "string", "description": "Tool Name."}, "tool_description": {"type": "string", "description": "Description about the tool."}, "tool_logo_file_path": {"type": "string", "description": "File Path for Logo."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForCustomSaasTool"}, "ServiceAccountNativeDetailsForDataBricks": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasDataServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForDataBricks"}, "ServiceAccountNativeDetailsForDataDog": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForDataDog"}, "ServiceAccountNativeDetailsForDockerHub": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForDockerHub"}, "ServiceAccountNativeDetailsForDropbox": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForDropbox"}, "ServiceAccountNativeDetailsForDynatrace": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForDynatrace"}, "ServiceAccountNativeDetailsForElastic": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForElastic"}, "ServiceAccountNativeDetailsForElasticSearch": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForElasticSearch"}, "ServiceAccountNativeDetailsForFreshservice": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {"product_activation": {"type": "array", "items": {"$ref": "#/definitions/IntegratedToolProductActivation"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForFreshservice"}, "ServiceAccountNativeDetailsForGcpBillingAccount": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForGcp"}, {"properties": {"billing_account_id": {"type": "string", "description": "Billing Account Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGcpBillingAccount"}, "ServiceAccountNativeDetailsForGcpBillingSubAccount": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"billing_account_id": {"type": "string", "description": "Billing Account Id"}, "organization_id": {"type": "string", "description": "Organization Id"}, "organization_name": {"type": "string", "description": "Organization Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGcpBillingSubAccount"}, "ServiceAccountNativeDetailsForGcpFolder": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForGcp"}, {"properties": {"folder_id": {"type": "string", "description": "Folder Id. This is a required field."}, "folder_name": {"type": "string", "description": "Folder Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGcpFolder"}, "ServiceAccountNativeDetailsForGcpGkeCluster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForKubernetesClusterCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGcpGkeCluster"}, "ServiceAccountNativeDetailsForGcpOrganization": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForGcp"}, {"properties": {"organization_id": {"type": "string", "description": "Organization Id"}, "organization_name": {"type": "string", "description": "Organization Name"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGcpOrganization"}, "ServiceAccountNativeDetailsForGcpParentBillingAccount": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForGcp"}, {"properties": {"billing_account_id": {"type": "string", "description": "Billing Account Id"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGcpParentBillingAccount"}, "ServiceAccountNativeDetailsForGcpProject": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForGcp"}, {"properties": {"project_id": {"type": "string", "description": "Project Id. This is a required field."}, "project_sys_generated_name": {"type": "string", "description": "Unique resource name of the project"}, "project_name": {"type": "string", "description": "Project Name"}, "default_values": {"description": "Self Service Default Values", "$ref": "#/definitions/SelfServiceDefaultValuesForGcp"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGcpProject"}, "ServiceAccountNativeDetailsForGithub": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {"organization_id": {"type": "string", "description": "Organization Id. This is a required field"}, "product_activation": {"type": "array", "items": {"$ref": "#/definitions/IntegratedToolProductActivation"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGithub"}, "ServiceAccountNativeDetailsForGrafana": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForGrafana"}, "ServiceAccountNativeDetailsForIbmTencent": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForIbmTencent"}, "ServiceAccountNativeDetailsForJenkins": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForJenkins"}, "ServiceAccountNativeDetailsForJiraDataCenter": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForJiraDataCenter"}, "ServiceAccountNativeDetailsForJiraServiceDesk": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForJiraServiceDesk"}, "ServiceAccountNativeDetailsForJiraServiceManagementParent": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForJiraServiceManagement"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForJiraServiceManagementParent"}, "ServiceAccountNativeDetailsForJiraServiceManagementProject": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForJiraServiceManagement"}, {"properties": {"product_activation": {"type": "array", "items": {"$ref": "#/definitions/IntegratedToolProductActivation"}}, "project_id": {"type": "string", "description": "Project Id. This is a required field."}, "project_name": {"type": "string", "description": "Project Name. This is a required field."}, "project_key": {"type": "string", "description": "Project Key. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForJiraServiceManagementProject"}, "ServiceAccountNativeDetailsForLogstash": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForLogstash"}, "ServiceAccountNativeDetailsForMicrosoftTeams": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {"cloud_type": {"type": "string", "description": "Azure Cloud Type. This is a required field.", "example": "Azure_Global", "enum": ["Azure_Global", "Azure_China", "Azure_Government"], "x-cs-enum-type": "AzureCloudType"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForMicrosoftTeams"}, "ServiceAccountNativeDetailsForMsVmm": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForMsVmm"}, "ServiceAccountNativeDetailsForNagios": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForNagios"}, "ServiceAccountNativeDetailsForNewrelic": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForNewrelic"}, "ServiceAccountNativeDetailsForOciOkeCluster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForKubernetesClusterCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForOciOkeCluster"}, "ServiceAccountNativeDetailsForOciTenancy": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {"tenancy_id": {"type": "string", "description": "Tenancy Id. This is a required field."}, "region": {"type": "string", "description": "Default Region. This is a required field."}, "tenancy_name": {"type": "string", "description": "Tenancy Name."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForOciTenancy"}, "ServiceAccountNativeDetailsForOkta": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForOkta"}, "ServiceAccountNativeDetailsForOpenAI": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasAiServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForOpenAI"}, "ServiceAccountNativeDetailsForOpenstack": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {"default_values": {"description": "SelfService Default Values", "$ref": "#/definitions/SelfServiceDefaultValuesForOpenstack"}, "tenants": {"type": "array", "description": "Tenants for account", "items": {"$ref": "#/definitions/OpenstackTenant"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForOpenstack"}, "ServiceAccountNativeDetailsForPrivateCloud": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {"organization_name": {"type": "string", "description": "Organization Name. Used as the unique identifier for the private cloud environment. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForPrivateCloud"}, "ServiceAccountNativeDetailsForPrometheus": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForPrometheus"}, "ServiceAccountNativeDetailsForQualys": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForQualys"}, "ServiceAccountNativeDetailsForRackspace": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForRackspace"}, "ServiceAccountNativeDetailsForRedhatSatellite": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForRedhatSatellite"}, "ServiceAccountNativeDetailsForSaas": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaas"}, {"properties": {"application_name": {"type": "string", "description": "Name of the SaaS Application."}, "storage": {"$ref": "#/definitions/StorageConfigurationBaseForSaas"}}, "type": "object"}]}, "ServiceAccountNativeDetailsForSaasMicrosoftTeams": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForSaasMicrosoftTeams"}, "ServiceAccountNativeDetailsForSaasNewRelic": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForSaasNewRelic"}, "ServiceAccountNativeDetailsForSalesForceSalesCloud": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForSalesForceSalesCloud"}, "ServiceAccountNativeDetailsForSelfManagedCluster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForKubernetesClusterOthers"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForSelfManagedCluster"}, "ServiceAccountNativeDetailsForServiceNow": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {"product_activation": {"type": "array", "items": {"$ref": "#/definitions/IntegratedToolProductActivation"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForServiceNow"}, "ServiceAccountNativeDetailsForSnowflake": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasDataServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForSnowflake"}, "ServiceAccountNativeDetailsForSplunk": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForSaasOtherServices"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForSplunk"}, "ServiceAccountNativeDetailsForTclItsm": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {"product_activation": {"type": "array", "items": {"$ref": "#/definitions/IntegratedToolProductActivation"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForTclItsm"}, "ServiceAccountNativeDetailsForTenableNessus": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForTenableNessus"}, "ServiceAccountNativeDetailsForVcenter": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForVcenter"}, "ServiceAccountNativeDetailsForVmware": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForVmware"}, "ServiceAccountNativeDetailsForVmwareVcdMaster": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForVmwareVcdMaster"}, "ServiceAccountNativeDetailsForVmwareVcdOrganization": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForStructure"}, {"properties": {"org_id": {"type": "string", "description": "Organization Id. This is a required field."}, "org_name": {"type": "string", "description": "Organization Name. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForVmwareVcdOrganization"}, "ServiceAccountNativeDetailsForVmwareVcdOrganizationVdc": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForCloud"}, {"properties": {"vdc_id": {"type": "string", "description": "Organization VDC Id. This is a required field."}, "vdc_name": {"type": "string", "description": "Organization VDC Name. This is a required field."}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForVmwareVcdOrganizationVdc"}, "ServiceAccountNativeDetailsForZabbix": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {"configuration": {"type": "array", "description": "Configuration for Zabbix Management", "items": {"$ref": "#/definitions/ZabbixConfiguration"}}, "host_configuration": {"type": "array", "description": "Host Configuration for Zabbix Management", "items": {"$ref": "#/definitions/ZabbixHostConfiguration"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForZabbix"}, "ServiceAccountNativeDetailsForZohoServiceDesk": {"allOf": [{"$ref": "#/definitions/ServiceAccountNativeDetailsBaseForIntegratedTool"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsForZohoServiceDesk"}, "ServiceAccountNativeDetailsQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["native_details"], "properties": {"native_details": {"type": "array", "description": "Service Account Native Details to include", "items": {"$ref": "#/definitions/ServiceAccountNativeDetailsBase"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountNativeDetailsQueryOperator"}, "ServiceAccountParentInfo": {"properties": {"parent_id": {"type": "string", "description": "ID of the parent account."}, "parent_name": {"type": "string", "description": "Name of the parent account."}, "native_details": {"description": "Native details of the account. This is a required field.", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}}, "type": "object"}, "ServiceAccountPlatformKeyValues": {"properties": {"service_account_id": {"type": "string", "description": "Service Account ID", "x-cs-type": "ObjectId"}, "values_by_key": {"type": "array", "description": "List of platform tag key/value pairs for an account", "items": {"$ref": "#/definitions/PlatformKeyValues"}}}, "type": "object"}, "ServiceAccountQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service Accounts to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountQueryOperator"}, "ServiceAccountSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedAt"], "x-cs-enum-type": "ServiceAccountSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ServiceAccountStatusQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["statuses"], "properties": {"statuses": {"type": "array", "description": "Service Account statuses to include", "items": {"type": "string", "description": "Indicates the status of the cloud account in corestack", "example": "not_validated", "enum": ["not_validated", "validated", "not_onboarded", "not_onboarded_validated", "active", "inactive", "retired", "deleting"], "x-cs-enum-type": "ServiceAccountStatus"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountStatusQueryOperator"}, "ServiceAccountSummary": {"properties": {"native_details": {"description": "Native details of the account", "$ref": "#/definitions/ServiceAccountNativeDetailsBase"}, "status": {"type": "string", "description": "Status of the account", "example": "not_validated", "enum": ["not_validated", "validated", "not_onboarded", "not_onboarded_validated", "active", "inactive", "retired", "deleting"], "x-cs-enum-type": "ServiceAccountStatus"}, "count": {"type": "integer", "description": "Number of accounts in the bucket"}}, "type": "object"}, "ServiceAccountSummaryRequest": {"required": ["filters"], "properties": {"filters": {"description": "Filter for the service accounts", "$ref": "#/definitions/ServiceAccountFilter"}}, "type": "object"}, "ServiceAccountSync": {"properties": {"access_governance": {"description": "Access Governance current status", "$ref": "#/definitions/ProgressDetails"}, "access_validation": {"description": "Access Validation current status", "$ref": "#/definitions/ProgressDetailsForAccessValidation"}, "advisor_data": {"description": "Advisor Data current status", "$ref": "#/definitions/ProgressDetails"}, "application_performance_data": {"description": "Application Performance data current status", "$ref": "#/definitions/ProgressDetails"}, "aws_compute_optimizer_data": {"description": "AWS Compute Optimizer Data current status", "$ref": "#/definitions/ProgressDetails"}, "aws_security_hub": {"description": "AWS Security Hub Sync Details current status", "$ref": "#/definitions/ProgressDetailsForSecurityHub"}, "azure_ea_unit_price": {"description": "Azure EA Unit Price Data current status", "$ref": "#/definitions/ProgressDetailsForEaUnitRate"}, "azure_hub_discount": {"description": "Azure Hub Discount Details current status", "$ref": "#/definitions/ProgressDetails"}, "billing_info": {"description": "Billing Info current status", "$ref": "#/definitions/ProgressDetailsForCostProcessing"}, "cloud_account_tag": {"description": "Cloud Account Tag Sync current status", "$ref": "#/definitions/ProgressDetails"}, "cloudops__activity_assessment": {"description": "Activity Assessment Data current status", "$ref": "#/definitions/ProgressDetails"}, "cloudops__backup": {"description": "Backup Data current status", "$ref": "#/definitions/ProgressDetailsForBackupData"}, "cloudops__bigquery_metric": {"description": "BigQuery Metric Data current status", "$ref": "#/definitions/ProgressDetails"}, "cloudops__custom_metric": {"description": "Custom Metric Data current status", "$ref": "#/definitions/ProgressDetails"}, "cloudops__log_analytics_query": {"description": "Log Analytics Query Data current status", "$ref": "#/definitions/ProgressDetails"}, "cloudops__metric": {"description": "Metric Data current status", "$ref": "#/definitions/ProgressDetailsForMetricData"}, "cloudops__monitoring_alert_assessment": {"description": "Monitoring Alert Assessment Data current status", "$ref": "#/definitions/ProgressDetails"}, "cloudops__patch_management": {"description": "Patch Management Data current status", "$ref": "#/definitions/ProgressDetails"}, "cloudops__ssm": {"description": "SSM Data current status", "$ref": "#/definitions/ProgressDetailsForSsmData"}, "credential_validation": {"description": "Credential Check Info current status", "$ref": "#/definitions/ProgressDetailsForCredentialsValidation"}, "dimension_precompute": {"description": "Dimension Precompute current status", "$ref": "#/definitions/ProgressDetailsForDimensionPrecompute"}, "daily_cost_report": {"description": "Daily Cost Report current status", "$ref": "#/definitions/ProgressDetails"}, "finops__assessment_report": {"description": "Finops Assessment Report current status", "$ref": "#/definitions/ProgressDetails"}, "finops__budget_data": {"description": "Budget Data current status", "$ref": "#/definitions/ProgressDetails"}, "finops__cost_anomaly": {"description": "Cost Anomaly current status", "$ref": "#/definitions/ProgressDetails"}, "finops__cost_savings": {"description": "Schedule Recommendation Cost Savings current status", "$ref": "#/definitions/ProgressDetails"}, "finops__crp_recommendation": {"description": "CRP Recommendation current status", "$ref": "#/definitions/ProgressDetails"}, "finops__enterprise_discount_program": {"description": "Enterprise Discount Program current status", "$ref": "#/definitions/ProgressDetails"}, "finops__recommendation_v2": {"description": "Finops Recommendations V2 current status", "$ref": "#/definitions/ProgressDetails"}, "finops__ri_ontology_sync": {"description": "Billing & Cost Analytics \u2014 RI ontology projection into GraphDB current status", "$ref": "#/definitions/ProgressDetails"}, "finops__savings_plans": {"description": "Savings Plans current status", "$ref": "#/definitions/ProgressDetailsForSavingsPlans"}, "finops__schedule_recommendation": {"description": "Schedule Recommendation current status", "$ref": "#/definitions/ProgressDetails"}, "finops__sp_ontology_sync": {"description": "Billing & Cost Analytics \u2014 SP ontology projection into GraphDB current status", "$ref": "#/definitions/ProgressDetails"}, "gcp_security_command_center": {"description": "GCP Security Command Center Data current status", "$ref": "#/definitions/ProgressDetails"}, "governance_configuration": {"description": "Application of Governance Configurations current status", "$ref": "#/definitions/ProgressDetailsForGovernanceConfiguration"}, "governance_configuration_validation": {"description": "Validation of Governance Configurations current status", "$ref": "#/definitions/ProgressDetailsForGovernanceConfiguration"}, "governance_report": {"description": "Governance Report current status", "$ref": "#/definitions/ProgressDetails"}, "hierarchy_data": {"description": "Service Account Hierarchy current status", "$ref": "#/definitions/ProgressDetails"}, "inventory_data": {"description": "Inventory Data current status", "$ref": "#/definitions/ProgressDetails"}, "inventory_data__dashboard_sync": {"description": "Inventory Dashboard Data Sync current status", "$ref": "#/definitions/ProgressDetails"}, "inventory_data__dependency_sync": {"description": "Inventory Dependency Data Sync current status", "$ref": "#/definitions/ProgressDetails"}, "inventory_data__lock_sync": {"description": "Inventory Lock Data Sync current status", "$ref": "#/definitions/ProgressDetails"}, "inventory_data__relationship_sync": {"description": "Inventory Relationship Data Sync current status", "$ref": "#/definitions/ProgressDetails"}, "inventory_report": {"description": "Inventory Report current status", "$ref": "#/definitions/ProgressDetails"}, "kubernetes_cluster_agent_sync_job": {"description": "Kubernetes Agent Sync Job Data current status", "$ref": "#/definitions/ProgressDetailsForKubernetesAgentSyncStatus"}, "kubernetes_cluster_agent_health": {"description": "Kubernetes Agent Health current status", "$ref": "#/definitions/ProgressDetails"}, "metric_utilization_data": {"description": "Utilization Dashboard Metric Sync current status", "$ref": "#/definitions/ProgressDetails"}, "monthly_cost_report": {"description": "Monthly Cost Report current status", "$ref": "#/definitions/ProgressDetails"}, "network_data": {"description": "Network Data current status", "$ref": "#/definitions/ProgressDetails"}, "proactive_scanner": {"description": "ProActive Scanner current status", "$ref": "#/definitions/ProgressDetails"}, "recovery_data": {"description": "Recovery Data current status", "$ref": "#/definitions/ProgressDetails"}, "reserved_instances_recommendation": {"description": "Reserved Instance Recommendations current status", "$ref": "#/definitions/ProgressDetailsForReservedInstances"}, "reserved_instances_utilization": {"description": "Reserved Instance utilization current status", "$ref": "#/definitions/ProgressDetailsForReservedInstances"}, "secure_score_data": {"description": "Secure Score Data current status", "$ref": "#/definitions/ProgressDetailsForSecureScore"}, "security__azure_sentinel": {"description": "Azure Sentinel Data Collection current status", "$ref": "#/definitions/ProgressDetails"}, "security__tenable_nessus": {"description": "Tenable Nessus Vulnerability Data current status", "$ref": "#/definitions/ProgressDetails"}, "servicenow_cmdb_sync_job": {"description": "ServiceNow CMDB Sync Job Data current status", "$ref": "#/definitions/ProgressDetailsForServiceNowCmdbSync"}, "system_policy_execution": {"description": "System Policy Execution Data current status", "$ref": "#/definitions/ProgressDetails"}, "threat_data": {"description": "Threat Data current status", "$ref": "#/definitions/ProgressDetailsForThreat"}, "utilization_metrics_data": {"description": "Utilization Metrics Dashboard for Metric Sync current status", "$ref": "#/definitions/ProgressDetails"}, "vulnerability_data": {"description": "Vulnerability Data current status", "$ref": "#/definitions/ProgressDetailsForVulnerability"}, "wellarchitected__auto_assessment": {"description": "WellArchitected Auto Assessment Details current status", "$ref": "#/definitions/ProgressDetailsForWellArchitectedAutoAssessment"}}, "type": "object"}, "ServiceAccountSyncHistory": {"properties": {"access_governance": {"type": "array", "description": "Access Governance status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "access_validation": {"type": "array", "description": "Access Validation status history", "items": {"$ref": "#/definitions/ProgressDetailsForAccessValidation"}}, "advisor_data": {"type": "array", "description": "Advisor Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "application_performance_data": {"type": "array", "description": "Application Performance data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "aws_compute_optimizer_data": {"type": "array", "description": "AWS Compute Optimizer Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "aws_security_hub": {"type": "array", "description": "AWS Security Hub Sync Details status history", "items": {"$ref": "#/definitions/ProgressDetailsForSecurityHub"}}, "azure_ea_unit_price": {"type": "array", "description": "Azure EA Unit Price Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForEaUnitRate"}}, "azure_hub_discount": {"type": "array", "description": "Azure Hub Discount Details status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "billing_info": {"type": "array", "description": "Billing Info status history", "items": {"$ref": "#/definitions/ProgressDetailsForCostProcessing"}}, "cloud_account_tag": {"type": "array", "description": "Cloud Account Tag Sync status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "cloudops__activity_assessment": {"type": "array", "description": "Activity Assessment Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "cloudops__backup": {"type": "array", "description": "Backup Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForBackupData"}}, "cloudops__bigquery_metric": {"type": "array", "description": "BigQuery Metric Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "cloudops__custom_metric": {"type": "array", "description": "Custom Metric Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "cloudops__log_analytics_query": {"type": "array", "description": "Log Analytics Query Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "cloudops__metric": {"type": "array", "description": "Metric Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForMetricData"}}, "cloudops__monitoring_alert_assessment": {"type": "array", "description": "Monitoring Alert Assessment Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "cloudops__patch_management": {"type": "array", "description": "Patch Management Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "cloudops__ssm": {"type": "array", "description": "SSM Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForSsmData"}}, "credential_validation": {"type": "array", "description": "Credential Check Info status history", "items": {"$ref": "#/definitions/ProgressDetailsForCredentialsValidation"}}, "dimension_precompute": {"type": "array", "description": "Dimension Precompute status history", "items": {"$ref": "#/definitions/ProgressDetailsForDimensionPrecompute"}}, "daily_cost_report": {"type": "array", "description": "Daily Cost Report status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__assessment_report": {"type": "array", "description": "Finops Assessment Report status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__budget_data": {"type": "array", "description": "Budget Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__cost_anomaly": {"type": "array", "description": "Cost Anomaly status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__cost_savings": {"type": "array", "description": "Schedule Recommendation Cost Savings status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__crp_recommendation": {"type": "array", "description": "CRP Recommendation status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__enterprise_discount_program": {"type": "array", "description": "Enterprise Discount Program status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__recommendation_v2": {"type": "array", "description": "Finops Recommendations V2 status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__ri_ontology_sync": {"type": "array", "description": "Billing & Cost Analytics \u2014 RI ontology projection into GraphDB status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__savings_plans": {"type": "array", "description": "Savings Plans status history", "items": {"$ref": "#/definitions/ProgressDetailsForSavingsPlans"}}, "finops__schedule_recommendation": {"type": "array", "description": "Schedule Recommendation status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "finops__sp_ontology_sync": {"type": "array", "description": "Billing & Cost Analytics \u2014 SP ontology projection into GraphDB status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "gcp_security_command_center": {"type": "array", "description": "GCP Security Command Center Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "governance_configuration": {"type": "array", "description": "Application of Governance Configurations status history", "items": {"$ref": "#/definitions/ProgressDetailsForGovernanceConfiguration"}}, "governance_configuration_validation": {"type": "array", "description": "Validation of Governance Configurations status history", "items": {"$ref": "#/definitions/ProgressDetailsForGovernanceConfiguration"}}, "governance_report": {"type": "array", "description": "Governance Report status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "hierarchy_data": {"type": "array", "description": "Service Account Hierarchy status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "inventory_data": {"type": "array", "description": "Inventory Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "inventory_data__dashboard_sync": {"type": "array", "description": "Inventory Dashboard Data Sync status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "inventory_data__dependency_sync": {"type": "array", "description": "Inventory Dependency Data Sync status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "inventory_data__lock_sync": {"type": "array", "description": "Inventory Lock Data Sync status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "inventory_data__relationship_sync": {"type": "array", "description": "Inventory Relationship Data Sync status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "inventory_report": {"type": "array", "description": "Inventory Report status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "kubernetes_cluster_agent_sync_job": {"type": "array", "description": "Kubernetes Agent Sync Job Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForKubernetesAgentSyncStatus"}}, "kubernetes_cluster_agent_health": {"type": "array", "description": "Kubernetes Agent Health status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "metric_utilization_data": {"type": "array", "description": "Utilization Dashboard Metric Sync status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "monthly_cost_report": {"type": "array", "description": "Monthly Cost Report status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "network_data": {"type": "array", "description": "Network Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "proactive_scanner": {"type": "array", "description": "ProActive Scanner status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "recovery_data": {"type": "array", "description": "Recovery Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "reserved_instances_recommendation": {"type": "array", "description": "Reserved Instance Recommendations status history", "items": {"$ref": "#/definitions/ProgressDetailsForReservedInstances"}}, "reserved_instances_utilization": {"type": "array", "description": "Reserved Instance utilization status history", "items": {"$ref": "#/definitions/ProgressDetailsForReservedInstances"}}, "secure_score_data": {"type": "array", "description": "Secure Score Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForSecureScore"}}, "security__azure_sentinel": {"type": "array", "description": "Azure Sentinel Data Collection status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "security__tenable_nessus": {"type": "array", "description": "Tenable Nessus Vulnerability Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "servicenow_cmdb_sync_job": {"type": "array", "description": "ServiceNow CMDB Sync Job Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForServiceNowCmdbSync"}}, "system_policy_execution": {"type": "array", "description": "System Policy Execution Data status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "threat_data": {"type": "array", "description": "Threat Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForThreat"}}, "utilization_metrics_data": {"type": "array", "description": "Utilization Metrics Dashboard for Metric Sync status history", "items": {"$ref": "#/definitions/ProgressDetails"}}, "vulnerability_data": {"type": "array", "description": "Vulnerability Data status history", "items": {"$ref": "#/definitions/ProgressDetailsForVulnerability"}}, "wellarchitected__auto_assessment": {"type": "array", "description": "WellArchitected Auto Assessment Details status history", "items": {"$ref": "#/definitions/ProgressDetailsForWellArchitectedAutoAssessment"}}}, "type": "object"}, "ServiceAccountTagKeyQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_keys"], "properties": {"tag_keys": {"type": "array", "description": "Tag keys to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountTagKeyQueryOperator"}, "ServiceAccountTagKeyRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key"], "properties": {"tag_key": {"description": "Include response that has the given tag key pattern", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "ServiceAccountTagKeyRegexQueryOperator"}, "ServiceAccountTagKeyValueQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key", "tag_values"], "properties": {"tag_key": {"type": "string", "description": "Tag key for the given cloud account"}, "tag_values": {"type": "array", "description": "Tag values for the given key", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ServiceAccountTagKeyValueQueryOperator"}, "ServiceAccountsModel": {"required": ["cloud_account_id", "cloud_account_name", "tenant_id"], "properties": {"cloud_account_id": {"type": "string", "description": "ID of the cloud account"}, "tenant_id": {"type": "string", "description": "ID of the tenant"}, "cloud_account_name": {"type": "string", "description": "Name of the cloud account"}}, "type": "object"}, "ServiceCatalogGetDataModel": {"required": ["data"], "properties": {"data": {"type": "string", "description": "catalog type"}}, "type": "object"}, "ServiceCategoryQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["service_categories"], "properties": {"service_categories": {"type": "array", "description": "Service categories to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ServiceCategoryQueryOperator"}, "ServiceNameWiseUsage": {"properties": {"service_name": {"type": "string", "description": "Name of the service"}, "group_by": {"type": "string", "description": "Group by field for the service usage"}, "day": {"type": "string", "description": "Day of the usage data"}, "service_accounts": {"type": "array", "description": "List of cloud account-wise usage data", "items": {"$ref": "#/definitions/CloudAccountWiseUsage"}}}, "type": "object"}, "ServiceNowAlertMapping": {"allOf": [{"$ref": "#/definitions/ServiceNowMappingBase"}, {"properties": {"description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for ServiceNow Alerts Description", "example": "AccountId", "enum": ["AccountId", "AlarmName", "Cloud", "Location", "MetricName", "MetricValue", "Operator", "ProjectId", "Resource", "ResourceGroup", "ResourceId", "ResourceName", "ResourceType", "ServiceAccountId", "ServiceAccountName", "SubscriptionId", "TenantName", "Threshold", "TimeAggregation"], "x-cs-enum-type": "ServiceNowAlertDescriptionAttribute"}}}, "type": "object"}]}, "ServiceNowAssignmentGroup": {"properties": {"group_name": {"type": "string", "description": "Assignment Group Name"}, "filter": {"$ref": "#/definitions/ServiceNowAssignmentGroupFilter"}}, "type": "object"}, "ServiceNowAssignmentGroupFilter": {"properties": {"cloud": {"type": "string", "description": "Cloud Service Name", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "resource_categories": {"type": "array", "description": "List of Resource Categories", "items": {"type": "string"}}, "resource_types": {"type": "array", "description": "List of Resource Types", "items": {"type": "string"}}, "resources": {"type": "array", "description": "List of Resources", "items": {"type": "string"}}}, "type": "object"}, "ServiceNowBudgetAlertMapping": {"allOf": [{"$ref": "#/definitions/ServiceNowMappingBase"}, {"properties": {"description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for ServiceNow Budget Alerts Description", "example": "actual_amount", "enum": ["actual_amount", "budget_amount", "budget_frequency", "budget_name", "budget_type", "configuration_type", "created_at", "currency", "impacted_accounts", "threshold_percentage", "updated_at"], "x-cs-enum-type": "ServiceNowBudgetAlertDescriptionAttribute"}}}, "type": "object"}]}, "ServiceNowCmdbActionResourceMapping": {"properties": {"create": {"type": "array", "description": "ServiceNow Cmdb CI create attributes mapping", "items": {"$ref": "#/definitions/ServiceNowCmdbAttributeMapping"}}, "update": {"type": "array", "description": "ServiceNow Cmdb CI update attributes mapping", "items": {"$ref": "#/definitions/ServiceNowCmdbAttributeMapping"}}, "delete": {"type": "array", "description": "ServiceNow Cmdb CI delete attributes mapping", "items": {"$ref": "#/definitions/ServiceNowCmdbAttributeMapping"}}}, "type": "object"}, "ServiceNowCmdbAssignmentGroup": {"properties": {"name": {"type": "string", "description": "Name of the ServiceNow User Group"}, "sys_id": {"type": "string", "description": "Sys_id of the ServiceNow User Group"}}, "type": "object"}, "ServiceNowCmdbAttributeMapping": {"required": ["target_column"], "properties": {"target_column": {"type": "string", "description": "Column Name in ServiceNow Cmdb table"}, "literal_value": {"type": "string", "description": "Literal Value"}, "attribute_id": {"type": "string", "description": "Identifier for the Inventory attribute"}}, "type": "object"}, "ServiceNowCmdbCiClass": {"properties": {"name": {"type": "string", "description": "Name of the Cmdb Ci Class"}, "label": {"type": "string", "description": "Display Name of the Cmdb Ci Class"}}, "type": "object"}, "ServiceNowCmdbCiClassAttribute": {"properties": {"name": {"type": "string", "description": "Name of the Cmdb Ci Class"}, "label": {"type": "string", "description": "Display Name of the Cmdb Ci Class"}, "mandatory": {"type": "boolean", "description": "Mandatory attribute Flag"}}, "type": "object"}, "ServiceNowCmdbCloudSchemaCategory": {"properties": {"hierarchy": {"type": "array", "description": "Service Hierarchy", "items": {"$ref": "#/definitions/ServiceNowCmdbResourceCategory"}}}, "type": "object"}, "ServiceNowCmdbCloudSchemaRequest": {"required": ["service_name"], "properties": {"service_name": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "monitoring_support_schema": {"type": "boolean", "description": "flag to return inventory hierarchy for monitoring support resources"}}, "type": "object"}, "ServiceNowCmdbConfig": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseResponse"}, {"properties": {"created_at": {"type": "string", "description": "When the configuration was created"}, "updated_at": {"type": "string", "description": "When the configuration was updated"}, "created_by": {"type": "string", "description": "Name of the user who created this configuration"}, "updated_by": {"type": "string", "description": "Name of the user who updated this configuration"}}, "type": "object"}]}, "ServiceNowCmdbConfigBaseRequest": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbScopeDetails"}, {"properties": {}, "type": "object"}]}, "ServiceNowCmdbConfigBaseResponse": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbScopeDetails"}, {"properties": {}, "type": "object"}]}, "ServiceNowCmdbConfigCreateRequest": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseRequest"}, {"required": ["cmdb_account_id", "cmdb_service", "configuration"], "properties": {"cmdb_account_id": {"type": "string", "description": "Id of the ServiceNow Account"}, "cmdb_service": {"type": "string", "description": "Name of the Cmdb Service"}, "configuration": {"type": "object", "description": "ServiceNow Cmdb Sync Configuration, indexed by CloudServiceName", "additionalProperties": {"$ref": "#/definitions/ServiceNowCmdbServiceConfig"}}}, "type": "object"}]}, "ServiceNowCmdbConfigCreateResponse": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseResponse"}, {"properties": {}, "type": "object"}]}, "ServiceNowCmdbConfigDeleteRequest": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseRequest"}, {"properties": {}, "type": "object"}]}, "ServiceNowCmdbConfigDeleteResponse": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseResponse"}, {"properties": {}, "type": "object"}]}, "ServiceNowCmdbConfigListRequest": {"required": ["cmdb_account_id", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Id of the Tenant that user has access to"}, "cmdb_account_id": {"type": "string", "description": "Id of the ServiceNow Account in Corestack"}}, "type": "object"}, "ServiceNowCmdbConfigUpdateRequest": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseRequest"}, {"required": ["cmdb_account_id", "cmdb_service", "configuration"], "properties": {"cmdb_account_id": {"type": "string", "description": "Id of the ServiceNow Account"}, "cmdb_service": {"type": "string", "description": "Name of the Cmdb Service"}, "configuration": {"type": "object", "description": "ServiceNow Cmdb Sync Configuration, indexed by CloudServiceName", "additionalProperties": {"$ref": "#/definitions/ServiceNowCmdbServiceConfig"}}}, "type": "object"}]}, "ServiceNowCmdbConfigUpdateResponse": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseResponse"}, {"properties": {}, "type": "object"}]}, "ServiceNowCmdbConfigView": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseResponse"}, {"properties": {"cmdb_account_id": {"type": "string", "description": "Id of the ServiceNow Account"}, "cmdb_service": {"type": "string", "description": "Name of the Cmdb Service"}, "configuration": {"type": "object", "description": "ServiceNow Cmdb Sync Configuration, indexed by CloudServiceName", "additionalProperties": {"$ref": "#/definitions/ServiceNowCmdbServiceConfig"}}}, "type": "object"}]}, "ServiceNowCmdbConfigViewRequest": {"allOf": [{"$ref": "#/definitions/ServiceNowCmdbConfigBaseRequest"}, {"required": ["cmdb_account_id"], "properties": {"cmdb_account_id": {"type": "string", "description": "Id of the ServiceNow Account in Corestack"}}, "type": "object"}]}, "ServiceNowCmdbInventoryAttribute": {"properties": {"attribute_id": {"type": "string", "description": "Identifier for the Inventory attribute"}, "display_name": {"type": "string", "description": "Display Name of the Inventory attribute"}}, "type": "object"}, "ServiceNowCmdbListAssignmentGroupRequest": {"required": ["cmdb_account_id", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Id of the Tenant that user has access to"}, "cmdb_account_id": {"type": "string", "description": "Id of the ServiceNow Account in Corestack"}}, "type": "object"}, "ServiceNowCmdbListAssignmentGroupResponse": {"properties": {"results": {"type": "array", "description": "List of ServiceNow User Groups", "items": {"$ref": "#/definitions/ServiceNowCmdbAssignmentGroup"}}}, "type": "object"}, "ServiceNowCmdbListClassAttributesRequest": {"required": ["cmdb_account_id", "cmdb_ci_class_name", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Id of the Tenant that user has access to"}, "cmdb_account_id": {"type": "string", "description": "Id of the ServiceNow Account in Corestack"}, "cmdb_ci_class_name": {"type": "string", "description": "Cmdb CI Class Name"}}, "type": "object"}, "ServiceNowCmdbListClassAttributesResponse": {"properties": {"results": {"type": "array", "description": "List of Cmdb CI Class Attributes", "items": {"$ref": "#/definitions/ServiceNowCmdbCiClassAttribute"}}}, "type": "object"}, "ServiceNowCmdbListCmdbClassRequest": {"required": ["cmdb_account_id", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Id of the Tenant that user has access to"}, "cmdb_account_id": {"type": "string", "description": "Id of the ServiceNow Account in Corestack"}}, "type": "object"}, "ServiceNowCmdbListCmdbClassResponse": {"properties": {"results": {"type": "array", "description": "List of Cmdb CI Classes", "items": {"$ref": "#/definitions/ServiceNowCmdbCiClass"}}}, "type": "object"}, "ServiceNowCmdbQuerySyncLogAction": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["actions"], "properties": {"actions": {"type": "array", "description": "Type of synchronization operation, which can be create, update, or delete", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ServiceNowCmdbQuerySyncLogAction"}, "ServiceNowCmdbQuerySyncLogResourceId": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_ids"], "properties": {"resource_ids": {"type": "array", "description": "Unique identifiers for the synchronized resource", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ServiceNowCmdbQuerySyncLogResourceId"}, "ServiceNowCmdbQuerySyncLogResourceType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["resource_types"], "properties": {"resource_types": {"type": "array", "description": "Synchronized resource types", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ServiceNowCmdbQuerySyncLogResourceType"}, "ServiceNowCmdbQuerySyncLogService": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["services"], "properties": {"services": {"type": "array", "description": "Type or category of the cloud resource being synchronized", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ServiceNowCmdbQuerySyncLogService"}, "ServiceNowCmdbQuerySyncLogStatus": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["statuses"], "properties": {"statuses": {"type": "array", "description": "Resource Sync Status", "items": {"type": "string", "description": "Resource Sync Status", "example": "in_progress", "enum": ["in_progress", "success", "failed"], "x-cs-enum-type": "ServiceNowCmdbSyncLogStatus"}}}, "type": "object"}], "x-cs-type-name": "ServiceNowCmdbQuerySyncLogStatus"}, "ServiceNowCmdbResourceCategory": {"properties": {"resource_category": {"type": "string", "description": "Name of the Resource Category"}, "resource_types": {"type": "array", "description": "List of Resource Type", "items": {"$ref": "#/definitions/ServiceNowCmdbResourceType"}}}, "type": "object"}, "ServiceNowCmdbResourceMapping": {"required": ["resource", "resource_category", "resource_type"], "properties": {"resource_category": {"type": "string", "description": "Resource Category"}, "resource_type": {"type": "string", "description": "Resource Type"}, "resource": {"type": "string", "description": "Resource"}, "cmdb_ci_class_name": {"type": "string", "description": "Name of the ServiceNow Cmdb CI Instance Class"}, "attribute_mapping": {"description": "ServiceNow Cmdb CI attributes mapping", "$ref": "#/definitions/ServiceNowCmdbActionResourceMapping"}}, "type": "object"}, "ServiceNowCmdbResourceType": {"properties": {"resource_type": {"type": "string", "description": "Name of the Resource Type"}, "resources": {"type": "array", "description": "List of Resource", "items": {"type": "string"}}}, "type": "object"}, "ServiceNowCmdbRuleMapping": {"properties": {"locations": {"type": "array", "description": "List of locations to filter", "items": {"type": "string"}}, "cloud_accounts": {"type": "array", "description": "List of Cloud Account to filter", "items": {"type": "string"}}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "ServiceNowCmdbScopeDetails": {"required": ["scope"], "properties": {"scope": {"type": "string", "description": "Scope to Apply", "example": "master_account", "enum": ["master_account", "tenant", "cloud_account"], "x-cs-enum-type": "ServiceNowCmdbScope"}, "master_account_id": {"type": "string", "description": "Master Account Id"}, "tenant_id": {"type": "string", "description": "Id of the tenants that user has access to"}, "cloud_account_id": {"type": "string", "description": "Id of the Cloud Account"}}, "type": "object"}, "ServiceNowCmdbServiceConfig": {"properties": {"resource_mapping": {"type": "array", "description": "ServiceNow Cmdb sync resource level mapping", "items": {"$ref": "#/definitions/ServiceNowCmdbResourceMapping"}}, "rule_mapping": {"description": "ServiceNow Cmdb Sync Configuration Rule Details", "$ref": "#/definitions/ServiceNowCmdbRuleMapping"}}, "type": "object"}, "ServiceNowCmdbSyncLog": {"properties": {"ci": {"type": "string", "description": "Identifier for the ServiceNow Configuration Item (CI) being synchronized."}, "resource_id": {"type": "string", "description": "Unique identifier for the synchronized resource."}, "resource_type": {"type": "string", "description": "Synchronized resource type."}, "action": {"type": "string", "description": "Type of synchronization operation, which can be create, update, or delete."}, "status": {"type": "string", "description": "Status of the synchronization operation, indicating success or failure."}, "service": {"type": "string", "description": "Type or category of the cloud resource being synchronized."}, "sys_id_link": {"type": "string", "description": "ServiceNow URL link to access the specific Configuration Item (CI)."}, "target_args": {"type": "string", "description": "The request body sent when creating a Configuration Item (CI)."}, "sync_time": {"type": "string", "format": "date-time", "description": "Timestamp representing the time when the resource synchronization occurred."}}, "type": "object"}, "ServiceNowCmdbSyncLogBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/ServiceNowCmdbSyncLog"}}}, "type": "object"}, "ServiceNowCmdbSyncLogFilters": {"required": ["action", "service_account_id", "snow_account_id"], "properties": {"action": {"type": "string", "description": "action for CMDB logs dashboard", "example": "download", "enum": ["download", "dashboard"], "x-cs-enum-type": "ServiceNowCmdbSyncLogAction"}, "service_account_id": {"type": "string", "description": "Cloud Account ID"}, "snow_account_id": {"type": "string", "description": "ServiceNow Account ID"}, "query": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "ServiceNowCmdbSyncLogListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/ServiceNowCmdbSyncLogSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ServiceNowCmdbSyncLogFilters"}}, "type": "object"}, "ServiceNowCmdbSyncLogSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "SyncTime", "enum": ["SyncTime", "Service", "Status", "Action", "ResourceType", "ResourceId"], "x-cs-enum-type": "ServiceNowCmdbSyncLogSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ServiceNowCmdbSyncProgress": {"properties": {"total": {"type": "integer", "description": "Total number of resources identified for ServiceNow Cmdb sync"}, "success": {"type": "integer", "description": "Number of resources that have been synced"}, "failed": {"type": "integer", "description": "Number of resources that have been failed to sync"}}, "type": "object"}, "ServiceNowCmdbSyncProgressResponse": {"properties": {"status": {"type": "string", "description": "ServiceNow Cmdb sync status", "example": "Ready", "enum": ["Ready", "Pending", "Waiting", "Failed", "Completed", "Cancelled"], "x-cs-enum-type": "BackgroundJobStatus"}, "progress": {"description": "Progress of the ServiceNow Cmdb sync", "$ref": "#/definitions/ServiceNowCmdbSyncProgress"}}, "type": "object"}, "ServiceNowCmdbViewInventorySchemaRequest": {"required": ["resource_category", "resource_type", "service_name"], "properties": {"service_name": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "resource_category": {"type": "string", "description": "Resource Category"}, "resource_type": {"type": "string", "description": "Resource Type"}, "resource": {"type": "string", "description": "Resource"}}, "type": "object"}, "ServiceNowConfigurationComponent": {"properties": {"source": {"type": "string", "description": "Source for ServiceNow ToolsConfiguration setting", "example": "Direct", "enum": ["Direct", "Request"], "x-cs-enum-type": "ServiceNowToolsConfigurationSource"}, "name": {"type": "string", "description": "Name for ServiceNow ToolsConfiguration setting", "example": "affected_ci", "enum": ["affected_ci", "assigned_to", "caller_id", "category", "close", "cmdb_ci", "company", "control_effectiveness", "correlation_id", "impact_if_realized", "occurrence_probability", "owning_country", "priority", "reason", "short_description", "state", "type", "u_cmdb_ci", "u_comments", "u_company", "u_contact_type", "u_correlation_id", "u_event_class", "u_owner_group", "u_severity", "u_source", "u_state", "u_task_caller", "urgency"], "x-cs-enum-type": "ServiceNowToolsConfigurationName"}, "value": {"type": "string", "description": "Value for ServiceNow ToolsConfiguration setting"}}, "type": "object"}, "ServiceNowIncidentCustomAttributeField": {"properties": {"field": {"type": "string", "description": "Field Id"}, "field_name": {"type": "string", "description": "Field Name"}, "table_name": {"type": "string", "description": "Reference table name of field"}}, "type": "object"}, "ServiceNowIncidentManagementCustomEndpoint": {"properties": {"url": {"type": "string", "description": "Custom endpoint URL for Incident management"}, "username": {"type": "string", "description": "Username for Custom Endpoint URL"}, "password": {"type": "string", "description": "Password for Custom Endpoint URL", "x-cs-type": "SensitiveString"}}, "type": "object"}, "ServiceNowIncidentManagementCustomFieldValueMapping": {"properties": {"value": {"type": "string", "description": "Value for Mapping field"}, "actual_value": {"type": "string", "description": "Actual value to use instead value"}}, "type": "object"}, "ServiceNowIncidentManagementCustomFieldsMapping": {"properties": {"field": {"type": "string", "description": "ServiceNow Incident Custom Field Name"}, "value": {"type": "string", "description": "Direct value to use for custom field"}, "mapping_field": {"type": "string", "description": "ServiceNow Incident Management Custom Field Mapping Keys", "example": "tenant_name", "enum": ["tenant_name"], "x-cs-enum-type": "ServiceNowIncidentManagementCustomFieldValueMappingKey"}, "mapping_values": {"type": "array", "description": "Value mapping for custom field", "items": {"$ref": "#/definitions/ServiceNowIncidentManagementCustomFieldValueMapping"}}}, "type": "object"}, "ServiceNowMappingBase": {"properties": {"attribute_mapping": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowConfigurationComponent"}}, "assignment_groups": {"type": "array", "items": {"$ref": "#/definitions/ServiceNowAssignmentGroup"}}}, "type": "object"}, "ServiceNowPolicyMapping": {"allOf": [{"$ref": "#/definitions/ServiceNowMappingBase"}, {"properties": {"description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for ServiceNow Policy Description", "example": "AccountId", "enum": ["AccountId", "AccountMaster", "Location", "PolicyClassification", "PolicyDescription", "PolicyInput", "PolicyName", "ProjectId", "Region", "ResourceGroup", "ResourceId", "ResourceName", "ResourceType", "ServiceAccountId", "ServiceAccountName", "ServiceName", "SubscriptionId", "SubscriptionName", "TenantName"], "x-cs-enum-type": "ServiceNowPolicyDescriptionAttribute"}}}, "type": "object"}]}, "ServiceNowRequestComponent": {"properties": {"sys_id": {"type": "string", "description": "Sys Id of the ServiceNow Component "}, "title": {"type": "string", "description": "Title of the ServiceNow Component "}}, "type": "object"}, "ServiceNowRequestManagementActionMapping": {"properties": {"action": {"type": "string", "description": "Corestack action for Request Management", "example": "approve", "enum": ["approve", "create", "cancel", "completemodify", "re_order", "terminate"], "x-cs-enum-type": "ServiceNowRequestManagementAction"}, "source_is_servicenow": {"type": "boolean", "description": "True if Request Management source is ServiceNow"}, "target_is_servicenow": {"type": "boolean", "description": "True if Request Management target is ServiceNow"}, "service_now_action_attr": {"type": "array", "description": "List of ServiceNow attributes for Request Management Action", "items": {"type": "string"}}}, "type": "object"}, "ServiceNowRequestManagementAttributeMapping": {"properties": {"service_now_attribute": {"type": "string", "description": "ServiceNow attribute for Request management"}, "corestack_attribute": {"type": "array", "description": "List of Corestack attributes for Request Management", "items": {"type": "string"}}}, "type": "object"}, "ServiceNowRequestManagementCatalogComponent": {"properties": {"title": {"type": "string", "description": "Title for Request Management Catalog Item"}, "sys_id": {"type": "string", "description": "SysID for Request Management Catalog Item"}, "name": {"type": "string", "description": "Name for Request Management Catalog Item"}, "level1": {"type": "string", "description": "Level 1 for Request Management Catalog Item"}, "level2": {"type": "string", "description": "Level 2 for Request Management Catalog Item"}, "classification_name": {"type": "string", "description": "Classification Name for Request Management Catalog Item"}, "label": {"type": "string", "description": "Label for Request Management Catalog Item"}, "item_id": {"type": "string", "description": "Id for Request Management Catalog Item"}}, "type": "object"}, "ServiceNowRequestManagementCatalogDetails": {"properties": {"service_now_catalog": {"description": "ServiceNow catalog  for Request management catalog", "$ref": "#/definitions/ServiceNowRequestManagementCatalogComponent"}, "service_now_category": {"description": "ServiceNow category for Request management catalog", "$ref": "#/definitions/ServiceNowRequestManagementCatalogComponent"}, "service_now_subcategory": {"description": "ServiceNow subcategory for Request management catalog", "$ref": "#/definitions/ServiceNowRequestManagementCatalogComponent"}, "service_now_item": {"description": "ServiceNow Item attribute for Request management catalog", "$ref": "#/definitions/ServiceNowRequestManagementCatalogComponent"}, "corestack_catalog": {"description": "Corestack catalog  for Request management catalog", "$ref": "#/definitions/ServiceNowRequestManagementCatalogComponent"}, "corestack_category": {"description": "Corestack category for Request management catalog", "$ref": "#/definitions/ServiceNowRequestManagementCatalogComponent"}, "corestack_resource": {"description": "Corestack resource for Request management catalog", "$ref": "#/definitions/ServiceNowRequestManagementCatalogComponent"}, "corestack_item": {"description": "Corestack Item attribute for Request management catalog", "$ref": "#/definitions/ServiceNowRequestManagementCatalogComponent"}}, "type": "object"}, "ServiceNowRequestManagementStatusMapping": {"properties": {"service_now_status": {"type": "string", "description": "Service Now status for Request Management", "example": "not_requested", "enum": ["not_requested", "requested", "approved", "rejected"], "x-cs-enum-type": "ServiceNowRequestManagementStatus"}, "corestack_status": {"type": "string", "description": "Corestack status for Request Management "}}, "type": "object"}, "ServiceNowSecurityAlertMapping": {"allOf": [{"$ref": "#/definitions/ServiceNowMappingBase"}, {"properties": {"description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes for ServiceNow Security Alerts Description", "example": "AccountId", "enum": ["AccountId", "AffectedResource", "AlertDescription", "CloudAccountName", "Count", "FindingsType", "Intent", "Location", "ResourceGroup", "ResourceId", "ResourceName", "ResourceType", "ServiceAccountId", "ServiceName", "Severity", "Status", "SubscriptionName", "TenantName"], "x-cs-enum-type": "ServiceNowSecurityAlertDescriptionAttribute"}}}, "type": "object"}]}, "ServiceNowServiceCatalog": {"properties": {"catalog": {"$ref": "#/definitions/ServiceNowRequestComponent"}, "categories": {"type": "array", "description": "List of Service Catalog Categories", "items": {"$ref": "#/definitions/ServiceNowServiceCatalogCategory"}}}, "type": "object"}, "ServiceNowServiceCatalogCategory": {"properties": {"category": {"$ref": "#/definitions/ServiceNowRequestComponent"}, "sub_categories": {"type": "array", "description": "List of Service Catalog SubCategories", "items": {"$ref": "#/definitions/ServiceNowServiceCatalogSubCategory"}}}, "type": "object"}, "ServiceNowServiceCatalogSubCategory": {"properties": {"sub_category": {"$ref": "#/definitions/ServiceNowRequestComponent"}, "items": {"type": "array", "description": "List of Service Catalog Items", "items": {"$ref": "#/definitions/ServiceNowRequestComponent"}}}, "type": "object"}, "ServiceNowTableRow": {"properties": {"id": {"type": "string", "description": "Id of the element"}, "name": {"type": "string", "description": "Name of the element"}}, "type": "object"}, "ServiceNowTableRowsListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "ServiceNowTableRowsListResponse": {"properties": {"results": {"type": "array", "description": "Table rows.", "items": {"$ref": "#/definitions/ServiceNowTableRow"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "ServiceResourceBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/ServiceResourceDetails"}}}, "type": "object"}, "ServiceResourceDetails": {"properties": {"check_resource_element": {"type": "string", "description": "Unique ID of the resource element"}, "operation_id": {"type": "string", "description": "Operation ID for resource discovery"}, "resource_filter": {"type": "string", "description": "Resource filter criteria used"}, "service_account_id": {"type": "string", "description": "Service account ID", "x-cs-type": "ObjectId"}, "category": {"type": "string", "description": "Resource category"}, "component": {"type": "string", "description": "Resource component"}, "created_at": {"type": "string", "format": "date-time", "description": "Creation timestamp"}, "location": {"type": "string", "description": "Resource region/location/zone"}, "resource": {"type": "string", "description": "Resources of the cloud provider"}, "resource_type": {"type": "string", "description": "Type of the resource"}, "summary_details": {"type": "object", "description": "Detailed resource information from cloud provider"}, "tags": {"type": "array", "description": "Resource tags as key-value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "updated_at": {"type": "string", "format": "date-time", "description": "Last update timestamp"}}, "type": "object"}, "ServiceResourceFilter": {"properties": {"service_account_ids": {"type": "array", "description": "Filter by service account IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "location": {"type": "string", "description": "Filter by region/location/zone"}, "tags": {"type": "array", "description": "Resource tags as key-value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "operation_id": {"type": "string", "description": "Filter by operation ID"}, "resource_filter": {"type": "string", "description": "Filter by resource filter, also known as resource group in Azure"}, "category": {"type": "string", "description": "Filter by resource category"}, "component": {"type": "string", "description": "Filter by resource component"}, "tenant_ids": {"type": "array", "description": "Filter by tenant IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "resource": {"type": "string", "description": "Filter by resource"}, "check_resource_element": {"type": "string", "description": "Filter by unique ID of the resource"}, "check_resource_parent_id": {"type": "string", "description": "Filter by parent unique ID of the resource"}}, "type": "object"}, "ServiceResourceInventoryDetails": {"required": ["corestack_resource_id", "service_account_id"], "properties": {"corestack_resource_id": {"type": "string", "description": "ID of the resource", "x-cs-type": "ObjectId"}, "service_account_id": {"type": "string", "description": "ID of the service account", "x-cs-type": "ObjectId"}, "check_resource_element": {"type": "string", "description": "Unique id of the resource"}, "component": {"type": "string", "description": "Component of the resource"}, "location": {"type": "string", "description": "Location of the resource"}, "resource_group": {"type": "string", "description": "Resource group name specific to Azure resource"}, "summary_details_name": {"type": "string", "description": "Resource name specific to Azure"}}, "type": "object"}, "ServiceResourceInventoryLookup": {"required": ["corestack_resource_id", "service_account_id"], "properties": {"corestack_resource_id": {"type": "string", "description": "ID of the resource", "x-cs-type": "ObjectId"}, "service_account_id": {"type": "string", "description": "ID of the service account", "x-cs-type": "ObjectId"}}, "type": "object"}, "ServiceResourceInventoryLookupRequest": {"properties": {"corestack_resource_ids": {"type": "array", "description": "Id of the resource", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "ServiceResourceListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ServiceResourceFilter"}}, "type": "object"}, "ServiceResourceListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "ServiceTypeQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["service_types"], "properties": {"service_types": {"type": "array", "description": "Service types to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ServiceTypeQueryOperator"}, "SetDefaultRequest": {"required": ["monitoring_template_uri"], "properties": {"monitoring_template_uri": {"type": "string", "description": "Specify the monitoring_template_uri of the template to mark it as default"}}, "type": "object"}, "ShareTarget": {"required": ["__type", "service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "Target service account ID", "x-cs-type": "ObjectId"}, "percentage": {"type": "number", "description": "Percentage of unshared benefit to allocate"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "ShareTargetForSavingsPlan", "subtype_name": "ShareTargetForSavingsPlan"}, {"subtype_model": "ShareTargetForReservation", "subtype_name": "ShareTargetForReservation"}]}, "ShareTargetForReservation": {"allOf": [{"$ref": "#/definitions/ShareTarget"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ShareTargetForReservation"}, "ShareTargetForSavingsPlan": {"allOf": [{"$ref": "#/definitions/ShareTarget"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ShareTargetForSavingsPlan"}, "SignedUrlDetails": {"properties": {"file_name": {"type": "string", "description": "Name of the file to generate re signed url"}, "file_size": {"type": "integer", "description": "Size of the file to be uploaded"}, "upload_id": {"type": "string", "description": "Upload ID for the multipart upload"}, "upload_part_size": {"type": "integer", "description": "Upload part size in bytes"}, "pre_signed_urls": {"type": "array", "items": {"$ref": "#/definitions/PresignedUrlDetails"}}}, "type": "object"}, "SkuUnitPriceRequest": {"required": ["service", "sku_name"], "properties": {"cloud_provider": {"type": "string", "description": "Cloud provider. aws | azure", "default": "aws"}, "service": {"type": "string", "description": "Service name. ec2 | rds | eks | elasticache | redshift"}, "sku_name": {"type": "string", "description": "Instance or node type e.g. m5.xlarge, db.m6i.32xlarge"}, "region": {"type": "string", "description": "AWS region code e.g. us-east-1", "default": "us-east-1"}, "pricing_type": {"type": "string", "description": "ON_DEMAND | RESERVED", "default": "ON_DEMAND"}, "commitment_term": {"type": "string", "description": "1yr | 3yr \u2014 RESERVED only"}, "payment_option": {"type": "string", "description": "NO_UPFRONT | PARTIAL_UPFRONT | ALL_UPFRONT \u2014 RESERVED only"}, "attributes": {"type": "object", "description": "Service-specific filter fields: os, db_engine, deployment, cache_engine"}}, "type": "object"}, "SsoRedirectResponse": {"properties": {"sso_redirect_url": {"type": "string", "description": "SSO Redirected URL"}}, "type": "object"}, "SsoRedirectUrlRequest": {"properties": {"email_id": {"type": "string", "description": "The unique email ID of the user."}, "redirect_url": {"type": "string", "description": "The URL to which the user will be redirected after authentication."}, "source": {"type": "string", "description": "The source system, application, or workflow initiating the SSO request."}}, "type": "object"}, "StackMarketPlaceAccountDetailsForStackDeployment": {"properties": {"service_account_id": {"type": "string", "description": "Service account ID", "x-cs-type": "ObjectId"}, "location": {"description": "Optional location context for the stack deployment", "$ref": "#/definitions/LocationDetailsBase"}, "resource_group": {"description": "Optional resource group context for the stack deployment", "$ref": "#/definitions/ResourceGroupDetailsBase"}, "compartment": {"description": "Optional compartment context for the stack deployment", "$ref": "#/definitions/CompartmentDetailsBase"}}, "type": "object"}, "StackMarketPlaceDeploymentAdditionalSettings": {"properties": {"notification_templates_success": {"description": "Notification message", "$ref": "#/definitions/StacksMarketplaceStackNotificationTemplate"}, "notification_templates_failure": {"description": "Notification message", "$ref": "#/definitions/StacksMarketplaceStackNotificationTemplate"}}, "type": "object"}, "StackMarketplaceDefinitionBase": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceComponentBase"}, {"properties": {"name": {"type": "string", "description": "Name of the component definition"}, "description": {"type": "string", "description": "Description of the component definition"}}, "type": "object"}]}, "StackMarketplaceStackDeploymentExecute": {"properties": {"action_type": {"type": "string", "description": "Deployment action of the resource", "example": "Run", "enum": ["Run", "Destroy", "Rerun"], "x-cs-enum-type": "StacksMarketplaceStackDeploymentAction"}, "stack_version_id": {"type": "string", "description": "Stack version ID"}, "input_parameters": {"type": "string", "description": "JSON encoded string of input parameters"}, "run_name": {"type": "string", "description": "Run name"}, "estimated_cost": {"description": "Estimated cost of the stack before deployment.", "$ref": "#/definitions/CostWithCurrency"}}, "type": "object"}, "StackMarketplaceStackDeploymentListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/StacksMarketplaceStackDeploymentListSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/StacksMarketplaceStackDeploymentFilter"}}, "type": "object"}, "StacksMarketplaceAdditionalCostComponent": {"properties": {"component_type": {"type": "string", "description": "Custom cost component."}, "cost": {"description": "Cost of the additional cost component", "$ref": "#/definitions/CostWithCurrency"}}, "type": "object"}, "StacksMarketplaceBase": {"properties": {"sysId": {"type": "string", "description": "ID of the Stack Marketplace component"}, "createdOn": {"type": "string", "format": "date-time", "description": "Created datetime for the component"}, "updatedOn": {"type": "string", "format": "date-time", "description": "Updated datetime for the component"}, "created_by": {"type": "string", "description": "Created by user ID"}, "updated_by": {"type": "string", "description": "Updated by user ID"}}, "type": "object"}, "StacksMarketplaceComponentBase": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceBase"}, {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "StacksMarketplaceComponentDefinition": {"properties": {"sku": {"type": "string", "description": "External SKU for the component"}, "name": {"type": "string", "description": "Component name"}, "description": {"type": "string", "description": "Component description"}}, "type": "object"}, "StacksMarketplaceCostEstimation": {"properties": {"job_status": {"type": "string", "description": "Status of Background Job", "example": "Ready", "enum": ["Ready", "Pending", "Waiting", "Failed", "Completed", "Cancelled"], "x-cs-enum-type": "BackgroundJobStatus"}, "breakdown": {"type": "array", "description": "Cost breakdown of all resources to be provisioned by the template.", "items": {"$ref": "#/definitions/StacksMarketplaceResourceCost"}}}, "type": "object"}, "StacksMarketplaceDeploymentDefinition": {"allOf": [{"$ref": "#/definitions/StackMarketplaceDefinitionBase"}, {"properties": {"stack_id": {"type": "string", "description": "Stack ID"}, "order_id": {"type": "string", "description": "Order ID"}, "details": {"type": "array", "description": "Deployment details", "items": {"$ref": "#/definitions/StackMarketPlaceAccountDetailsForStackDeployment"}}, "additional_settings": {"description": "Additional settings", "$ref": "#/definitions/StackMarketPlaceDeploymentAdditionalSettings"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}]}, "StacksMarketplaceDeploymentQueryAccount": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["service_account_ids"], "properties": {"service_account_ids": {"type": "array", "description": "Service Account IDs", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceDeploymentQueryAccount"}, "StacksMarketplaceDeploymentQueryName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"deployment_name": {"type": "string", "description": "Deployment name"}}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceDeploymentQueryName"}, "StacksMarketplaceDeploymentQueryRegion": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["regions"], "properties": {"regions": {"type": "array", "description": "Regions", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceDeploymentQueryRegion"}, "StacksMarketplaceDeploymentQueryStack": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["stacks_ids"], "properties": {"stacks_ids": {"type": "array", "description": "Stacks Ids", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceDeploymentQueryStack"}, "StacksMarketplaceEstimateCostRequest": {"allOf": [{"$ref": "#/definitions/StackMarketPlaceAccountDetailsForStackDeployment"}, {"properties": {"input_parameters": {"type": "string", "description": "JSON string of input parameters"}, "currency": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}]}, "StacksMarketplaceEstimateCostResponse": {"properties": {"background_job_id": {"type": "string", "description": "ID of the background job which performs cost estimation of resource"}}, "type": "object"}, "StacksMarketplacePlanComponent": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceComponentDefinition"}, {"properties": {}, "type": "object"}]}, "StacksMarketplaceProductComponent": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceComponentDefinition"}, {"properties": {}, "type": "object"}]}, "StacksMarketplaceProductDefinition": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceComponentBase"}, {"properties": {"product": {"description": "Product definition", "$ref": "#/definitions/StacksMarketplaceProductComponent"}, "plans": {"type": "array", "description": "Product plans", "items": {"$ref": "#/definitions/StacksMarketplacePlanComponent"}}, "is_marketplace": {"type": "boolean", "description": "Whether the Product is Marketplace or Standalone"}}, "type": "object"}]}, "StacksMarketplaceProductDefinitionBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/StacksMarketplaceProductDefinition"}}}, "type": "object"}, "StacksMarketplaceProductFilter": {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "text_filter": {"type": "string", "description": "Text filter used to search product names and SKUs"}, "query": {"description": "Query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "StacksMarketplaceProductListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/StacksMarketplaceProductListSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/StacksMarketplaceProductFilter"}}, "type": "object"}, "StacksMarketplaceProductListSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "Sku", "CreatedOn", "UpdatedOn"], "x-cs-enum-type": "StacksMarketplaceProductListSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "StacksMarketplaceResourceComponentCost": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceResourceCostBase"}, {"properties": {"name": {"type": "string", "description": "Name of the cost components"}, "unit": {"type": "string", "description": "Units used for calculation of cost"}, "quantity": {"type": "integer", "description": "Quantity of the resource component"}, "usage_based": {"type": "boolean", "description": "Whether the component is usage based or not."}, "price_not_found": {"type": "boolean", "description": "Whether the component price is not found or not."}}, "type": "object"}]}, "StacksMarketplaceResourceCost": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceResourceCostBase"}, {"properties": {"name": {"type": "string", "description": "Name of the resource"}, "resource_type": {"type": "string", "description": "Resource type used by the template engine"}, "count": {"type": "integer", "description": "Number of resources which are having similar specification"}, "components": {"type": "array", "description": "Costs of the components that make up the resource.", "items": {"$ref": "#/definitions/StacksMarketplaceResourceComponentCost"}}, "is_billable": {"type": "boolean", "description": "Whether the resource is billable or not."}, "is_cost_estimation_supported": {"type": "boolean", "description": "Whether the resource is supported for cost estimation or not."}, "is_supported_cloud_resource": {"type": "boolean", "description": "Whether the resource is part of Corestack supported Hyperscaler or not."}}, "type": "object"}]}, "StacksMarketplaceResourceCostBase": {"properties": {"cost": {"description": "Cost of the stack version resource component.", "$ref": "#/definitions/CostWithCurrency"}}, "type": "object"}, "StacksMarketplaceStackConfiguration": {"properties": {"product_id": {"type": "string", "description": "Product ID"}, "plan_skus": {"type": "array", "description": "Plan SKUs", "items": {"type": "string"}}, "deployment_details": {"description": "Deployment details", "$ref": "#/definitions/StacksMarketplaceStackDeploymentConfiguration"}, "input_parameters": {"type": "array", "description": "Input parameters", "items": {"$ref": "#/definitions/StacksMarketplaceStackInputParameter"}}, "output_parameters": {"type": "array", "description": "Output parameters", "items": {"$ref": "#/definitions/StacksMarketplaceStackParameter"}}, "notification_templates_success": {"description": "Notification message", "$ref": "#/definitions/StacksMarketplaceStackNotificationTemplate"}, "notification_templates_failure": {"description": "Notification message", "$ref": "#/definitions/StacksMarketplaceStackNotificationTemplate"}, "guess_for_cost_range": {"description": "Customer guessed cost range value of the stack", "$ref": "#/definitions/CustomerGuessForCostRange"}}, "type": "object"}, "StacksMarketplaceStackDefinition": {"allOf": [{"$ref": "#/definitions/StackMarketplaceDefinitionBase"}, {"properties": {"owner": {"type": "string", "description": "Owner of the Stack"}, "master_account_id": {"type": "string", "description": "Master account ID", "x-cs-type": "ObjectId"}, "is_archived": {"type": "boolean", "description": "Whether the Stack is archived"}, "headVersion": {"$ref": "#/definitions/RecordIdentity"}, "releaseVersion": {"$ref": "#/definitions/RecordIdentity"}, "allow_auto_approval": {"type": "boolean", "description": "Whether to allow auto approval of the stack"}}, "type": "object"}]}, "StacksMarketplaceStackDefinitionBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/StacksMarketplaceStackDefinition"}}}, "type": "object"}, "StacksMarketplaceStackDefinitionListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionListSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/StacksMarketplaceStackFilter"}}, "type": "object"}, "StacksMarketplaceStackDefinitionListSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedOn", "UpdatedOn", "Owner", "Version"], "x-cs-enum-type": "StacksMarketplaceStackDefinitionListSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "StacksMarketplaceStackDefinitionVersion": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceBase"}, {"properties": {"version": {"type": "integer", "description": "Version number"}, "definition": {"$ref": "#/definitions/RecordIdentity"}, "details": {"$ref": "#/definitions/StacksMarketplaceStackConfiguration"}, "predecessor": {"$ref": "#/definitions/RecordIdentity"}, "list_version": {"type": "string", "description": "List version"}, "change_summary": {"type": "string", "description": "Change summary"}}, "type": "object"}]}, "StacksMarketplaceStackDefinitionVersionBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/StacksMarketplaceStackDefinitionVersion"}}}, "type": "object"}, "StacksMarketplaceStackDefinitionVersionSetStateRequest": {"properties": {"list_version": {"type": "string", "description": "List version"}, "change_summary": {"type": "string", "description": "Change summary"}}, "type": "object"}, "StacksMarketplaceStackDeploymentBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/StacksMarketplaceDeploymentDefinition"}}}, "type": "object"}, "StacksMarketplaceStackDeploymentConfiguration": {"properties": {"deployment_type": {"type": "string", "description": "Deployment type of the resource", "example": "Template", "enum": ["Template", "Blueprint"], "x-cs-enum-type": "StacksMarketplaceStackDeploymentType"}, "deployment_model_id": {"type": "string", "description": "Deployment model ID"}}, "type": "object"}, "StacksMarketplaceStackDeploymentFilter": {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "query": {"description": "Query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "StacksMarketplaceStackDeploymentHistory": {"properties": {"deployment_id": {"type": "string", "description": "Deployment ID"}, "stack_version_id": {"type": "string", "description": "Stack version ID"}, "stack_deployment_action": {"type": "string", "description": "Deployment action of the resource", "example": "Run", "enum": ["Run", "Destroy", "Rerun"], "x-cs-enum-type": "StacksMarketplaceStackDeploymentAction"}, "job_id": {"type": "string", "description": "Job ID"}, "initiated_at": {"type": "string", "format": "date-time", "description": "Initiated at"}, "completed_at": {"type": "string", "format": "date-time", "description": "Completed at"}, "status": {"type": "string", "description": "Deployment execution status", "example": "Pending", "enum": ["Pending", "Running", "Completed", "Failed"], "x-cs-enum-type": "StacksMarketplaceStackDeploymentExecutionStatus"}, "initiated_by": {"type": "string", "description": "Initiated by"}, "distributor_id": {"type": "string", "description": "Distributor ID"}, "input_parameters": {"type": "string", "description": "JSON encoded string of input parameters"}, "run_name": {"type": "string", "description": "Run name"}, "status_message": {"type": "string", "description": "Status message"}, "estimated_cost": {"description": "Estimated cost of the stack before deployment.", "$ref": "#/definitions/CostWithCurrency"}}, "type": "object"}, "StacksMarketplaceStackDeploymentHistoryBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/StacksMarketplaceStackDeploymentHistory"}}}, "type": "object"}, "StacksMarketplaceStackDeploymentListSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedOn", "UpdatedOn", "Status", "StartTime", "EndTime"], "x-cs-enum-type": "StacksMarketplaceStackDeploymentListSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "StacksMarketplaceStackDeploymentQueryExecutionStatus": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["status"], "properties": {"status": {"type": "array", "description": "Status", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceStackDeploymentQueryExecutionStatus"}, "StacksMarketplaceStackFilter": {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "query": {"description": "Query operator", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "StacksMarketplaceStackInputParameter": {"allOf": [{"$ref": "#/definitions/StacksMarketplaceStackParameter"}, {"properties": {"default_value": {"type": "string", "description": "Default value for the parameter, encoded as a JSON string"}}, "type": "object"}]}, "StacksMarketplaceStackNotificationTemplate": {"properties": {"message": {"type": "string", "description": "Notification message"}, "email_ids": {"type": "array", "description": "Email IDs", "items": {"type": "string"}}}, "type": "object"}, "StacksMarketplaceStackParameter": {"properties": {"template_parameter": {"type": "string", "description": "Template parameter name"}, "display_name": {"type": "string", "description": "Stack parameter display name"}, "description": {"type": "string", "description": "Stack parameter description"}, "hide_parameter": {"type": "boolean", "description": "Whether to hide parameter from deployment UI"}}, "type": "object"}, "StacksMarketplaceStackPublishingState": {"properties": {"updated_on": {"type": "string", "format": "date-time", "description": "Updated datetime for publishing change"}, "updated_by": {"type": "string", "description": "Updated by user ID"}, "note": {"type": "string", "description": "Note for the publishing status change"}, "tenant_ids": {"type": "array", "description": "Target Tenant IDs", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "vendor_name": {"type": "string", "description": "Name of the vendor"}, "description": {"type": "string", "description": "Description of the vendor"}, "status": {"type": "string", "description": "Status of the stack version", "example": "InReview", "enum": ["InReview", "Approved", "Rejected", "Revoked"], "x-cs-enum-type": "StacksMarketplaceStackPublishingStatus"}, "auto_publish_settings": {"type": "string", "description": "Auto-Publish settings", "example": "NoAutoPublish", "enum": ["NoAutoPublish", "AutoPublishToDirectChildren", "AutoPublishToAll"], "x-cs-enum-type": "StackMarketplaceAutoPublishSettings"}}, "type": "object"}, "StacksMarketplaceStackQueryArchived": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceStackQueryArchived"}, "StacksMarketplaceStackQueryAutoApproved": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceStackQueryAutoApproved"}, "StacksMarketplaceStackQueryName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"properties": {"stack_name": {"type": "string", "description": "Stack name"}}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceStackQueryName"}, "StacksMarketplaceStackQueryOwner": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["stack_owners"], "properties": {"stack_owners": {"type": "array", "description": "Stack owners", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceStackQueryOwner"}, "StacksMarketplaceStackQueryProduct": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["product_ids"], "properties": {"product_ids": {"type": "array", "description": "Stack name", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "StacksMarketplaceStackQueryProduct"}, "StepWiseNotifications": {"properties": {"step_name": {"type": "string", "description": "Name of the step for which notification has to be sent."}, "notification_sent": {"type": "boolean", "description": "Boolean which represents the notification has been sent."}}, "type": "object"}, "StorageAccountDetailsForAzureCspMaster": {"properties": {"subscription_id": {"type": "string", "description": "Storage account subscription Id."}, "name": {"type": "string", "description": "Storage Account name"}, "report_path": {"type": "string", "description": "Cost Report Path."}}, "type": "object"}, "StorageConfigurationBaseForKubernetes": {"required": ["type"], "properties": {}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "StorageConfigurationForKubernetesPlatformManaged", "subtype_name": "StorageConfigurationForKubernetesPlatformManaged"}, {"subtype_model": "StorageConfigurationForAwsKubernetesUserManagedOnboarded", "subtype_name": "StorageConfigurationForAwsKubernetesUserManagedOnboarded"}, {"subtype_model": "StorageConfigurationForAwsKubernetesUserManagedIndividual", "subtype_name": "StorageConfigurationForAwsKubernetesUserManagedIndividual"}, {"subtype_model": "StorageConfigurationForAzureKubernetesUserManagedOnboarded", "subtype_name": "StorageConfigurationForAzureKubernetesUserManagedOnboarded"}, {"subtype_model": "StorageConfigurationForAzureKubernetesUserManagedIndividual", "subtype_name": "StorageConfigurationForAzureKubernetesUserManagedIndividual"}, {"subtype_model": "StorageConfigurationForGcpKubernetesUserManagedOnboarded", "subtype_name": "StorageConfigurationForGcpKubernetesUserManagedOnboarded"}, {"subtype_model": "StorageConfigurationForGcpKubernetesUserManagedIndividual", "subtype_name": "StorageConfigurationForGcpKubernetesUserManagedIndividual"}]}, "StorageConfigurationBaseForSaas": {"required": ["type"], "properties": {}, "discriminator": "type", "type": "object", "x-cs-subtypes": [{"subtype_model": "StorageConfigurationForSaasUserManaged", "subtype_name": "StorageConfigurationForSaasUserManaged"}, {"subtype_model": "StorageConfigurationForSaasOnboarded", "subtype_name": "StorageConfigurationForSaasOnboarded"}, {"subtype_model": "StorageConfigurationForSaasUserManagedIndividual", "subtype_name": "StorageConfigurationForSaasUserManagedIndividual"}, {"subtype_model": "StorageConfigurationForSaasUserManagedOnboarded", "subtype_name": "StorageConfigurationForSaasUserManagedOnboarded"}]}, "StorageConfigurationForAwsKubernetesUserManaged": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForKubernetesUserManaged"}, {"properties": {"bucket_name": {"type": "string", "description": "Storage Bucket Name"}, "file_path": {"type": "string", "description": "File Path in the Bucket"}}, "type": "object"}]}, "StorageConfigurationForAwsKubernetesUserManagedIndividual": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForAwsKubernetesUserManaged"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForAwsKubernetesUserManagedIndividual"}, "StorageConfigurationForAwsKubernetesUserManagedOnboarded": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForAwsKubernetesUserManaged"}, {"properties": {"account_id": {"type": "string", "description": "Reference to the Service Account under which the S3 is present.", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForAwsKubernetesUserManagedOnboarded"}, "StorageConfigurationForAzureKubernetesUserManaged": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForKubernetesUserManaged"}, {"properties": {"container_name": {"type": "string", "description": "Azure Blob Container Name"}, "file_path": {"type": "string", "description": "File Path in the Container"}}, "type": "object"}]}, "StorageConfigurationForAzureKubernetesUserManagedIndividual": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForAzureKubernetesUserManaged"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForAzureKubernetesUserManagedIndividual"}, "StorageConfigurationForAzureKubernetesUserManagedOnboarded": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForAzureKubernetesUserManaged"}, {"properties": {"account_id": {"type": "string", "description": "Reference to the linked Azure cloud account.", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForAzureKubernetesUserManagedOnboarded"}, "StorageConfigurationForGcpKubernetesUserManaged": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForKubernetesUserManaged"}, {"properties": {"bucket_name": {"type": "string", "description": "GCP Bucket Name"}, "file_path": {"type": "string", "description": "File path prefix in the bucket"}}, "type": "object"}]}, "StorageConfigurationForGcpKubernetesUserManagedIndividual": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForGcpKubernetesUserManaged"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForGcpKubernetesUserManagedIndividual"}, "StorageConfigurationForGcpKubernetesUserManagedOnboarded": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForGcpKubernetesUserManaged"}, {"properties": {"account_id": {"type": "string", "description": "Reference to the Service Account under which the GCS bucket is present.", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForGcpKubernetesUserManagedOnboarded"}, "StorageConfigurationForKubernetesPlatformManaged": {"allOf": [{"$ref": "#/definitions/StorageConfigurationBaseForKubernetes"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForKubernetesPlatformManaged"}, "StorageConfigurationForKubernetesUserManaged": {"allOf": [{"$ref": "#/definitions/StorageConfigurationBaseForKubernetes"}, {"properties": {}, "type": "object"}]}, "StorageConfigurationForSaasOnboarded": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForSaasUserManaged"}, {"properties": {"account_id": {"type": "string", "description": "Reference to the Service Account under which the storage is present.", "x-cs-type": "ObjectId"}}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForSaasOnboarded"}, "StorageConfigurationForSaasUserManaged": {"allOf": [{"$ref": "#/definitions/StorageConfigurationBaseForSaas"}, {"properties": {"bucket_name": {"type": "string", "description": "AWS S3 Storage Bucket Name"}, "file_path": {"type": "string", "description": "File Path in the Bucket"}}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForSaasUserManaged"}, "StorageConfigurationForSaasUserManagedIndividual": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForSaasUserManaged"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForSaasUserManagedIndividual"}, "StorageConfigurationForSaasUserManagedOnboarded": {"allOf": [{"$ref": "#/definitions/StorageConfigurationForSaasOnboarded"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "StorageConfigurationForSaasUserManagedOnboarded"}, "SummaryCountResponse": {"required": ["violations"], "properties": {"violations": {"description": "Contains the summary of violations shared under Utilization/Standards for AWS/Azure", "$ref": "#/definitions/ViolationCategoryModel"}}, "type": "object"}, "SummaryModel": {"required": ["category", "count"], "properties": {"count": {"type": "string", "description": "Violations count for each violation category, i.e. Utilization/Standards"}, "category": {"type": "string", "description": "Category of violations i.e Utilization/Standards"}}, "type": "object"}, "SwaggerResource": {"properties": {"service_name": {"type": "string", "description": "select the cloud account type", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "resource_category": {"type": "string", "description": "Resource Category"}, "resource_type": {"type": "string", "description": "Resource Type"}, "resource": {"type": "string", "description": "Resource"}, "operations": {"type": "array", "description": "Resource Operations", "items": {"$ref": "#/definitions/SwaggerResourceOperation"}}}, "type": "object"}, "SwaggerResourceOperation": {"properties": {"id": {"type": "string", "description": "Id of the Operation"}, "name": {"type": "string", "description": "Name of the Operation"}, "operation_id": {"type": "string", "description": "Operation Id of the resource"}, "activity_type": {"type": "string", "description": "Activity Type"}, "is_default": {"type": "boolean", "description": "Default Activity Flag"}}, "type": "object"}, "SwaggerResourceSchemaResponse": {"properties": {"results": {"type": "array", "description": "Resource List", "items": {"$ref": "#/definitions/SwaggerResource"}}}, "type": "object"}, "TabWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/WidgetConfiguration"}, {"properties": {"numCols": {"type": "integer"}, "numRows": {"type": "integer"}, "tabs": {"type": "array", "items": {"$ref": "#/definitions/WidgetTab"}}}, "type": "object"}], "x-cs-type-name": "TabWidgetConfiguration"}, "TagBaselineAvailableTag": {"properties": {"key": {"type": "string", "description": "Tag key"}, "values": {"type": "array", "description": "Values for the tag key", "items": {"type": "string"}}}, "type": "object"}, "TagBaselineAvailableTagBatchRequest": {"allOf": [{"$ref": "#/definitions/BatchRequest"}, {"properties": {"filters": {"description": "Account filters for the tags", "$ref": "#/definitions/AccountFilters"}}, "type": "object"}]}, "TagBaselineAvailableTagBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/TagBaselineAvailableTag"}}}, "type": "object"}, "TagBaselineAvailableTagFilters": {"properties": {"tag_key_query": {"type": "string", "description": "Text filter the tag keys"}, "filters": {"description": "Account filters for the tags", "$ref": "#/definitions/AccountFilters"}}, "type": "object"}, "TagBaselineAvailableTagListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/TagBaselineAvailableTagSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/TagBaselineAvailableTagFilters"}}, "type": "object"}, "TagBaselineAvailableTagSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Key", "enum": ["Key"], "x-cs-enum-type": "TagBaselineAvailableTagSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "TagBaselineConfiguration": {"required": ["tags"], "properties": {"tags": {"type": "object", "description": "Tag rules in this baseline", "additionalProperties": {"$ref": "#/definitions/TagBaselineRule"}}}, "type": "object"}, "TagBaselineCustomTags": {"allOf": [{"$ref": "#/definitions/TagBaselineAvailableTag"}, {"properties": {"regex_pattern": {"type": "string", "description": "Regular expression pattern to validate tag values, ensuring they follow a predefined format."}}, "type": "object"}]}, "TagBaselineDefinition": {"allOf": [{"$ref": "#/definitions/BaseDefinition"}, {"required": ["account_id", "is_active", "scope", "title"], "properties": {"account_id": {"type": "string", "description": "Account owning the tag baseline"}, "title": {"type": "string", "description": "Name of the baseline"}, "description": {"type": "string", "description": "Description of the baseline"}, "scope": {"description": "At what scope level the baseline should work", "$ref": "#/definitions/TagBaselineScope"}, "is_active": {"type": "boolean", "description": "States if the baseline definition is active or not"}}, "type": "object"}]}, "TagBaselineDefinitionVersion": {"allOf": [{"$ref": "#/definitions/BaseDefinitionVersion"}, {"properties": {"details": {"description": "Details of the version", "$ref": "#/definitions/TagBaselineConfiguration"}}, "type": "object"}]}, "TagBaselineEnhanceRequest": {"required": ["tags_to_enhance"], "properties": {"tags_to_enhance": {"type": "array", "description": "Tags to be enhanced", "items": {"$ref": "#/definitions/TagBaselineCustomTags"}}}, "type": "object"}, "TagBaselineGenerateRequest": {"required": ["user_prompt_text"], "properties": {"user_prompt_text": {"type": "string", "description": "User prompt to generate tags"}, "scope": {"description": "At what scope level the baseline should work", "$ref": "#/definitions/TagBaselineScope"}}, "type": "object"}, "TagBaselineReference": {"properties": {"baseline_id": {"type": "string"}, "baseline_version_id": {"type": "string"}}, "type": "object"}, "TagBaselineRule": {"required": ["__type"], "properties": {"category": {"type": "array", "description": "Categories for this tag", "items": {"type": "string"}}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "TagBaselineRuleAllowedValues", "subtype_name": "TagBaselineRuleAllowedValues"}, {"subtype_model": "TagBaselineRuleRegex", "subtype_name": "TagBaselineRuleRegex"}, {"subtype_model": "TagBaselineRuleCondition", "subtype_name": "TagBaselineRuleCondition"}]}, "TagBaselineRuleAllowedValues": {"allOf": [{"$ref": "#/definitions/TagBaselineRule"}, {"required": ["allowed_values"], "properties": {"allowed_values": {"type": "array", "description": "Allowed values for this tag", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "TagBaselineRuleAllowedValues"}, "TagBaselineRuleCondition": {"allOf": [{"$ref": "#/definitions/TagBaselineRule"}, {"properties": {"starts_with": {"type": "string", "description": "Allowed values should start with this text"}, "contains": {"type": "string", "description": "Allowed values should contain this text"}, "ends_with": {"type": "string", "description": "Allowed values should end with this text"}}, "type": "object"}], "x-cs-type-name": "TagBaselineRuleCondition"}, "TagBaselineRuleRegex": {"allOf": [{"$ref": "#/definitions/TagBaselineRule"}, {"required": ["regex_pattern"], "properties": {"regex_pattern": {"type": "string", "description": "Regular expression for allowed values for this tag"}}, "type": "object"}], "x-cs-type-name": "TagBaselineRuleRegex"}, "TagBaselineScope": {"required": ["__type"], "properties": {"inherit": {"type": "boolean", "description": "Allow inheriting rules from parent scope"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "TagBaselineScopeGlobal", "subtype_name": "TagBaselineScopeGlobal"}, {"subtype_model": "TagBaselineScopeTenant", "subtype_name": "TagBaselineScopeTenant"}, {"subtype_model": "TagBaselineScopeCloudAccount", "subtype_name": "TagBaselineScopeCloudAccount"}]}, "TagBaselineScopeCloudAccount": {"allOf": [{"$ref": "#/definitions/TagBaselineScope"}, {"properties": {"cloud_account_ids": {"type": "array", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "TagBaselineScopeCloudAccount"}, "TagBaselineScopeGlobal": {"allOf": [{"$ref": "#/definitions/TagBaselineScope"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "TagBaselineScopeGlobal"}, "TagBaselineScopeTenant": {"allOf": [{"$ref": "#/definitions/TagBaselineScope"}, {"properties": {"tenant_ids": {"type": "array", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "TagBaselineScopeTenant"}, "TagDiscoveryResourceMapping": {"required": ["arn", "inventory_id"], "properties": {"arn": {"type": "string", "description": "ResourceArn"}, "inventory_id": {"type": "string", "description": "Service Resource Inventory Unique Id", "x-cs-type": "ObjectId"}}, "type": "object"}, "TagKeyRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key"], "properties": {"tag_key": {"description": "Include response that has the given tag key", "$ref": "#/definitions/Regex"}, "tag_kind": {"type": "string", "description": "Tag kind if applicable"}}, "type": "object"}], "x-cs-type-name": "TagKeyRegexQueryOperator"}, "TagKeyStringValueRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key", "tag_value_regex"], "properties": {"tag_key": {"type": "string", "description": "Namespace label key to identify which label to select"}, "tag_value_regex": {"description": "Include responses where the label value has the given string", "$ref": "#/definitions/Regex"}, "tag_kind": {"type": "string", "description": "Tag kind if applicable"}}, "type": "object"}], "x-cs-type-name": "TagKeyStringValueRegexQueryOperator"}, "TagKeyValueRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_value"], "properties": {"tag_key": {"description": "Tag key pattern to identify and include corresponding response", "$ref": "#/definitions/Regex"}, "tag_value": {"description": "Tag value pattern to identify and include corresponding response", "$ref": "#/definitions/Regex"}, "tag_kind": {"type": "string", "description": "Tag kind if applicable"}}, "type": "object"}], "x-cs-type-name": "TagKeyValueRegexQueryOperator"}, "TagKindStringKeyRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key_regex", "tag_kind"], "properties": {"tag_kind": {"type": "string", "description": "Namespace label key to identify which label to select"}, "tag_key_regex": {"description": "Include responses where the label key has the given string", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "TagKindStringKeyRegexQueryOperator"}, "TagLevelTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["granularity"], "properties": {"granularity": {"type": "string", "description": "Granularity to aggregate data", "example": "day", "enum": ["day", "week", "month", "quarter", "year"], "x-cs-enum-type": "TrendGranularity"}}, "type": "object"}], "x-cs-type-name": "TagLevelTrendWidgetConfiguration"}, "TagPostureBase": {"required": ["__type"], "properties": {"account_id": {"type": "string", "description": "Id of the CoreStack Account under which this tenant resides"}, "tenant_id": {"type": "string", "description": "Id of the CoreStack Tenant for the posture"}, "cloud": {"type": "string", "description": "Cloud Provider being summarized", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "cloud_account_id": {"type": "string", "description": "Cloud Account id for the posture"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "TagPostureCloudAccountSummary", "subtype_name": "TagPostureCloudAccountSummary"}, {"subtype_model": "TagPostureResourceBase", "subtype_name": "TagPostureResourceBase"}, {"subtype_model": "TagPostureResourceSummary", "subtype_name": "TagPostureResourceSummary"}, {"subtype_model": "TagPostureResource", "subtype_name": "TagPostureResource"}]}, "TagPostureCloudAccountSummary": {"allOf": [{"$ref": "#/definitions/TagPostureBase"}, {"properties": {"created_at": {"type": "string", "format": "date-time", "description": "Time coverage was generated"}, "cloud_account_name": {"type": "string", "description": "Name of cloud account"}, "resource_coverage": {"description": "Resource coverage of the posture", "$ref": "#/definitions/TagPostureResourceCoverage"}, "tag_coverage": {"type": "array", "description": "Tag level coverage for the posture", "items": {"$ref": "#/definitions/TagPostureTagCoverage"}}, "baselines": {"type": "array", "description": "List of baselines that are included in this snapshot for this account", "items": {"$ref": "#/definitions/TagBaselineReference"}}, "remediation_allowed": {"type": "boolean", "description": "Whether tag remediation is allowed for this account"}}, "type": "object"}], "x-cs-type-name": "TagPostureCloudAccountSummary"}, "TagPostureCloudAccountSummaryBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/TagPostureCloudAccountSummary"}}}, "type": "object"}, "TagPostureContext": {"properties": {"filter": {"$ref": "#/definitions/AccountFilters"}, "baseline_id": {"type": "string", "description": "Only return postures for the selected baseline"}, "resource_categories": {"type": "array", "description": "Resource categories to filter (all if missing)", "items": {"type": "string"}}, "resource_components": {"type": "array", "description": "Resource components to filter (all if missing)", "items": {"type": "string"}}, "resource_types": {"type": "array", "description": "Resources types to filter (all if missing)", "items": {"type": "string"}}, "resources": {"type": "array", "description": "Resources to filter (all if missing)", "items": {"type": "string"}}, "supports_remediation_only": {"type": "boolean", "description": "Whether to only return resources that support remediation"}, "text_query": {"type": "string", "description": "Text query for tag postures"}, "workload_id": {"type": "string", "description": "Workload Id"}, "is_billable": {"type": "array", "description": "Whether to only return billable/non billable resources)", "items": {"type": "boolean"}}, "tag_key": {"type": "string", "description": "Tag key to filter resources by, used to evaluate governance coverage for a specific tag like 'owner' or 'environment'."}}, "type": "object"}, "TagPostureResource": {"allOf": [{"$ref": "#/definitions/TagPostureResourceBase"}, {"properties": {"resource_tags": {"type": "array", "description": "List of tags for the resource", "items": {"$ref": "#/definitions/TagPostureTagDetails"}}}, "type": "object"}], "x-cs-type-name": "TagPostureResource"}, "TagPostureResourceBase": {"allOf": [{"$ref": "#/definitions/TagPostureBase"}, {"properties": {"resource_id": {"type": "string", "description": "Identifier of the resource"}, "cloud_resource_id": {"type": "string", "description": "Cloud resource id"}, "resource_name": {"type": "string", "description": "Name of the resource"}, "resource_category": {"type": "string", "description": "Category of the resource"}, "resource_component": {"type": "string", "description": "Component of the resource"}, "resource_type": {"type": "string", "description": "Type of the resource"}, "resource_region": {"type": "string", "description": "Location of the resource"}, "resource_filter": {"type": "string", "description": "Resource_group/Zone/Region for the resource"}}, "type": "object"}], "x-cs-type-name": "TagPostureResourceBase"}, "TagPostureResourceBatchRequest": {"properties": {"baseline_id": {"type": "string", "description": "Baseline to fetch summary for (all if missing)"}, "resource_ids": {"type": "array", "description": "List of resource ids to fetch Tag Posture Details", "items": {"type": "string"}}}, "type": "object"}, "TagPostureResourceBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/TagPostureResource"}}}, "type": "object"}, "TagPostureResourceCoverage": {"properties": {"resource_count": {"type": "integer", "description": "Total number of resources"}, "valid_resource_count": {"type": "integer", "description": "Number of resources with 100% coverage"}, "tag_counts": {"description": "Count of tags for all resources", "$ref": "#/definitions/TagPostureSummaryCount"}, "missing_tag_keys": {"type": "array", "description": "List of missing tag keys", "items": {"type": "string"}}, "invalid_tag_values": {"type": "object", "description": "Map of invalid tag values", "additionalProperties": {"type": "string"}}}, "type": "object"}, "TagPostureResourceSummary": {"allOf": [{"$ref": "#/definitions/TagPostureResourceBase"}, {"properties": {"supports_remediation": {"type": "boolean", "description": "Whether or not the resource supports remediation"}, "resource_coverage": {"description": "Resource coverage of the posture", "$ref": "#/definitions/TagPostureResourceCoverage"}, "is_billable": {"type": "array", "description": "Whether to only return billable/non billable resources)", "items": {"type": "boolean"}}}, "type": "object"}], "x-cs-type-name": "TagPostureResourceSummary"}, "TagPostureResourceSummaryBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/TagPostureResourceSummary"}}}, "type": "object"}, "TagPostureSnapshot": {"properties": {"snapshot_id": {"type": "string"}, "account_id": {"type": "string", "description": "Id of the account associated with the snapshot"}, "created_at": {"type": "string", "format": "date-time", "description": "When the snapshot was created"}, "updated_at": {"type": "string", "format": "date-time", "description": "When the snapshot was updated"}, "created_by": {"type": "string", "description": "User ID of user who created the snapshot"}, "status": {"type": "string", "description": "Status of the snapshot", "example": "Running", "enum": ["Running", "Failed", "Success"], "x-cs-enum-type": "TagPostureSnapshotStatus"}, "reason": {"type": "string", "description": "Reason for triggering the snapshot", "example": "Manual", "enum": ["Manual", "Automatic"], "x-cs-enum-type": "TagPostureSnapshotReason"}, "progress": {"description": "Progress of the generation", "$ref": "#/definitions/TagPostureSnapshotProgress"}}, "type": "object"}, "TagPostureSnapshotBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/TagPostureSnapshot"}}}, "type": "object"}, "TagPostureSnapshotCreateRequest": {"properties": {"cloud_account_ids": {"type": "array", "description": "List of cloud account ids to include in the snapshot", "items": {"type": "string"}}}, "type": "object"}, "TagPostureSnapshotFilters": {"properties": {"status": {"type": "array", "description": "List of status to filter. (All if missing)", "items": {"type": "string", "description": "Status of the snapshot", "example": "Running", "enum": ["Running", "Failed", "Success"], "x-cs-enum-type": "TagPostureSnapshotStatus"}}}, "type": "object"}, "TagPostureSnapshotListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/TagPostureSnapshotSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/TagPostureSnapshotFilters"}}, "type": "object"}, "TagPostureSnapshotProgress": {"properties": {"total_cloud_accounts": {"type": "integer", "description": "Total number of cloud accounts in the snapshot"}, "processed_cloud_accounts": {"type": "integer", "description": "Number of cloud accounts that have been processed already"}}, "type": "object"}, "TagPostureSnapshotSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CreatedAt", "enum": ["CreatedAt", "Status", "Reason"], "x-cs-enum-type": "TagPostureSnapshotSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "TagPostureSummaryCount": {"properties": {"valid_count": {"type": "integer", "description": "Number of valid"}, "invalid_count": {"type": "integer", "description": "Number of invalid"}, "missing_keys_count": {"type": "integer", "description": "Number of missing"}, "auto_suggested_count": {"type": "integer", "description": "Number of suggestions"}}, "type": "object"}, "TagPostureSummaryListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/TagPostureSummarySortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/TagPostureContext"}}, "type": "object"}, "TagPostureSummarySortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Cloud", "enum": ["Cloud", "CloudAccountName", "CloudResourceId", "InvalidTags", "MissingTags", "ResourceCategory", "ResourceComponent", "ResourceCoverage", "ResourceName", "ResourceRegion", "ResourceType", "ResourceFilter", "TagCoverage"], "x-cs-enum-type": "TagPostureSummarySortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "TagPostureTagCoverage": {"properties": {"tag": {"type": "string", "description": "Tag key"}, "resource_counts": {"description": "Counts of resources for this tag", "$ref": "#/definitions/TagPostureSummaryCount"}}, "type": "object"}, "TagPostureTagDetails": {"properties": {"tag": {"type": "string", "description": "Tag key"}, "value": {"type": "string", "description": "Value of tag"}, "is_valid": {"type": "boolean", "description": "Whether the tag is valid"}, "auto_suggest": {"type": "array", "description": "Possible values for the key", "items": {"type": "string"}}}, "type": "object"}, "TagPostureWorkloadCloudSummary": {"properties": {"workload_id": {"type": "string", "description": "Workload id"}, "workload_cloud_summary": {"type": "array", "description": "Workload Cloud Tag Posture Summary", "items": {"$ref": "#/definitions/TagPostureCloudAccountSummary"}}}, "type": "object"}, "TagPostureWorkloadCloudSummaryResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/TagPostureWorkloadCloudSummary"}}}, "type": "object"}, "TagRemediationRequest": {"allOf": [{"$ref": "#/definitions/TagsRemediation"}, {"required": ["service_account_id"], "properties": {"service_account_id": {"type": "string", "description": "service_account_id", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "TagRemediationStatus": {"required": ["created_at", "status"], "properties": {"status": {"type": "string", "description": "Status of Tag Remediation"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}, "created_at": {"type": "string", "format": "date-time", "description": "Created datetime for the Tags"}}, "type": "object"}, "TaggedUntaggedResourcesByProductCategory": {"properties": {"untagged_resources": {"type": "number", "description": "Cost for all untagged resources in category"}, "tagged_resources": {"type": "number", "description": "Cost for all tagged resources in category"}, "product_category": {"type": "string", "description": "product category type"}}, "type": "object"}, "TaggedUntaggedResourcesByProductCategoryRequest": {"allOf": [{"$ref": "#/definitions/CommonCostRequest"}, {"properties": {}, "type": "object"}]}, "TagsRemediation": {"required": ["resource", "resource_category", "resource_filter", "resource_id", "resource_type"], "properties": {"resource_category": {"type": "string", "description": "resource_category (it can be fetched from the tag posture resource based on input filters api"}, "resource_type": {"type": "string", "description": "resource_type (it can be fetched from the tag posture resource based on input filters api)"}, "resource": {"type": "string", "description": "resource (it can be fetched from the tag posture resource based on input filters api)"}, "resource_filter": {"type": "string", "description": "resource_filter will be region, resource group or zone name. It can be fetched from the list resource visibility count api"}, "resource_id": {"type": "string", "description": "resource_id (it can be fetched from the tag posture resource based on input filters api)"}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "TclCorestackAttributeMapping": {"properties": {"tcl_attribute": {"type": "string", "description": "TCL attribute of the resource"}, "corestack_attribute": {"type": "string", "description": "Corestack attribute of the resource"}}, "type": "object"}, "TclItsmCorestackResourceMapping": {"required": ["cloud_service"], "properties": {"cloud_service": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "resource_category": {"type": "string", "description": "Corestack resource category"}, "resource_type": {"type": "string", "description": "Corestack resource type"}, "attribute_mapping": {"type": "array", "description": "Mapping of TCL and corestack attributes of resources", "items": {"$ref": "#/definitions/TclCorestackAttributeMapping"}}}, "type": "object"}, "TclItsmUserActionmapping": {"properties": {"corestack_action": {"type": "string", "description": "Corestack action for user management"}, "tcl_itsm_action": {"type": "string", "description": "TCL ITSM action for user management"}, "source": {"type": "string", "description": "Source for TCL ITSM user action", "example": "Corestack", "enum": ["Corestack", "TCL_ITSM"], "x-cs-enum-type": "TclItsmUserActionEntity"}, "target": {"type": "string", "description": "Target for TCL ITSM user action", "example": "Corestack", "enum": ["Corestack", "TCL_ITSM"], "x-cs-enum-type": "TclItsmUserActionEntity"}}, "type": "object"}, "TclItsmUserAttributeEncryption": {"properties": {"action": {"type": "string", "description": "Allowed values for TCL ITSM User Actions", "example": "create_user", "enum": ["create_user", "update_user", "create_or_update_user", "create_tenant", "delete_user"], "x-cs-enum-type": "TclItsmUserAction"}, "selected_attributes": {"type": "array", "description": "Selected attributes for encryption", "items": {"type": "string"}}}, "type": "object"}, "TemplateCreateResponse": {"required": ["template_id"], "properties": {"template_id": {"type": "string", "description": "Unique Id of the template"}}, "type": "object"}, "TemplateDataModelList": {"required": ["classification", "description", "dsl", "scope", "services", "template_id", "template_name", "type"], "properties": {"template_id": {"type": "string", "description": "Unique Id of the template"}, "services": {"type": "array", "description": "Service(s) associated with the template, for example, AWS, AzureRM, Openstack., etc", "items": {"type": "string"}}, "template_name": {"type": "string", "description": "Name of the template"}, "description": {"type": "string", "description": "Description about template"}, "type": {"type": "array", "description": "Type of the template like, Cloud, Monitoring, Orchestration., etc", "items": {"type": "string"}}, "dsl": {"type": "string", "description": "dsl of the template"}, "classification": {"type": "array", "description": "Classification of the Template", "items": {"type": "string"}}, "scope": {"type": "string", "description": "scope of template (Account,Tenant,Private)"}}, "type": "object"}, "TemplateExecuteRequest": {"required": ["args", "cloud_accounts"], "properties": {"args": {"type": "object", "description": "Arguments to the template"}, "cloud_accounts": {"type": "array", "description": "Cloud account details to execute the template", "items": {"$ref": "#/definitions/CloudAccount"}}, "incident_reference": {"description": "Incident reference.", "$ref": "#/definitions/TemplateIncidentReference"}}, "type": "object"}, "TemplateExecuteResponse": {"required": ["data"], "properties": {"data": {"type": "object", "description": "Job identifier of the executed template"}}, "type": "object"}, "TemplateGetParameterSchemaResponse": {"properties": {"input_parameters": {"type": "array", "description": "List of input parameters.", "items": {"$ref": "#/definitions/NamedParameter"}}, "output_parameters": {"type": "array", "description": "List of output parameters.", "items": {"$ref": "#/definitions/NamedParameter"}}}, "type": "object"}, "TemplateGetParamsRequest": {"required": ["cloud_accounts"], "properties": {"cloud_accounts": {"type": "array", "description": "cloud account details to execute the template", "items": {"$ref": "#/definitions/CloudAccount"}}}, "type": "object"}, "TemplateGetParamsResponse": {"required": ["args", "cloud_accounts"], "properties": {"args": {"type": "object", "description": "Arguments to the template"}, "cloud_accounts": {"type": "array", "description": "Cloud account details to execute the template", "items": {"$ref": "#/definitions/CloudAccountDetailsResponse"}}}, "type": "object"}, "TemplateIncidentReference": {"properties": {"integrated_tool_account_id": {"type": "string", "description": "Integrated tool account id", "x-cs-type": "ObjectId"}, "incident_id": {"type": "string", "description": "Incident Id"}}, "type": "object"}, "TemplateJobListResponse": {"required": ["jobs"], "properties": {"jobs": {"$ref": "#/definitions/TemplateJobsList"}}, "type": "object"}, "TemplateJobResource": {"properties": {"resource_id": {"type": "string", "description": "Unique Resource ID."}, "resource_name": {"type": "string", "description": "Name of the resource."}, "resource_type": {"type": "string", "description": "Type of the resource created."}, "status": {"type": "string", "description": "Provides status of the resource.", "example": "CANCELED", "enum": ["CANCELED", "COMPLETED", "CREATE_FAILED", "CREATE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "DELETE_IN_PROGRESS", "FAILED", "IN_PROGRESS", "SNAPSHOT_COMPLETED", "SNAPSHOT_FAILED", "SNAPSHOT_IN_PROGRESS", "UPDATED", "UPDATE_FAILED", "UPDATE_IN_PROGRESS"], "x-cs-enum-type": "TemplateJobStatus"}, "status_reason": {"type": "string", "description": "Provides reason for the failure of the job"}, "start_date": {"type": "string", "format": "date-time", "description": "Template job start time."}, "end_date": {"type": "string", "format": "date-time", "description": "Template job end time."}}, "type": "object"}, "TemplateJobUpdateResponse": {"properties": {"id": {"type": "string", "description": "Unique ID of the Template Job"}, "name": {"type": "string", "description": "Name of the Template Job"}, "status": {"type": "string", "description": "Overall status of the template execution", "example": "CANCELED", "enum": ["CANCELED", "COMPLETED", "CREATE_FAILED", "CREATE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "DELETE_IN_PROGRESS", "FAILED", "IN_PROGRESS", "SNAPSHOT_COMPLETED", "SNAPSHOT_FAILED", "SNAPSHOT_IN_PROGRESS", "UPDATED", "UPDATE_FAILED", "UPDATE_IN_PROGRESS"], "x-cs-enum-type": "TemplateJobStatus"}, "status_reason": {"type": "string", "description": "Error message if failed"}, "created_at": {"type": "string", "format": "date-time", "description": "Template Job start time in UTC"}, "completed_at": {"type": "string", "format": "date-time", "description": "Template Job completion time in UTC"}, "execution_type": {"type": "string", "description": "Template Job execution type", "example": "on_demand", "enum": ["on_demand", "scheduled", "event_driven", "system"], "x-cs-enum-type": "TemplateExecutionType"}, "terraform_state": {"type": "string", "description": "Terraform Template state"}, "args": {"type": "object", "description": "Template Job execution template inputs arguments", "additionalProperties": {"type": "string"}}, "output": {"type": "string", "description": "Template Job outputs"}, "attachment_id": {"type": "string", "description": "Terraform job log ID"}, "resources": {"type": "array", "items": {"$ref": "#/definitions/TemplateJobResource"}}}, "type": "object"}, "TemplateJobsList": {"properties": {"id": {"type": "string", "description": "Unique ID of the template job."}, "name": {"type": "string", "description": "Name of the template job."}, "status": {"type": "string", "description": "Overall status of the template execution", "example": "CANCELED", "enum": ["CANCELED", "COMPLETED", "CREATE_FAILED", "CREATE_IN_PROGRESS", "DELETED", "DELETE_FAILED", "DELETE_IN_PROGRESS", "FAILED", "IN_PROGRESS", "SNAPSHOT_COMPLETED", "SNAPSHOT_FAILED", "SNAPSHOT_IN_PROGRESS", "UPDATED", "UPDATE_FAILED", "UPDATE_IN_PROGRESS"], "x-cs-enum-type": "TemplateJobStatus"}, "type": {"type": "string", "description": "Type of the executed template [heat/mistral]"}, "status_reason": {"type": "string", "description": "Error message if failed"}, "user_name": {"type": "string", "description": "User who initiated the template execution"}, "job_actions": {"type": "array", "description": "list of actions supported for this job based on its type.", "items": {"type": "string"}}, "incident_reference": {"description": "Incident reference details.", "$ref": "#/definitions/TemplateIncidentReference"}}, "type": "object"}, "TemplateListResponse": {"required": ["templates", "total_pages", "total_templates"], "properties": {"total_templates": {"type": "string", "description": "Total number of templates available"}, "total_pages": {"type": "string", "description": "Total number of pages"}, "templates": {"description": "Template Metadata Info.", "$ref": "#/definitions/TemplateDataModelList"}}, "type": "object"}, "TemplateParameterValidationRequest": {"required": ["input_parameters"], "properties": {"input_parameters": {"type": "string", "description": "Template execution parameters, encoded as a JSON string"}}, "type": "object"}, "TemplateValidateRequest": {"required": ["cloud_accounts"], "properties": {"cloud_accounts": {"type": "array", "description": "cloud account details to execute the template", "items": {"$ref": "#/definitions/CloudAccount"}}}, "type": "object"}, "TemplateValidateResponse": {"required": ["validation_status"], "properties": {"validation_status": {"type": "string", "description": "Job identifier of the executed template"}}, "type": "object"}, "TemplateViewResponse": {"required": ["classification", "content", "content_files", "content_type", "content_url", "created_at", "created_by", "description", "dsl", "resource_type", "resources", "scope", "services", "template_id", "template_name", "type", "updated_at", "updated_by"], "properties": {"template_id": {"type": "string", "description": "Unique Id of the template"}, "services": {"type": "array", "description": "Service(s) associated with the template, for example, AWS, AzureRM, Openstack., etc", "items": {"type": "string"}}, "template_name": {"type": "string", "description": "Name of the template"}, "content": {"type": "string", "description": "Raw content of the template which is usually in YAML or JSON format"}, "content_type": {"type": "string", "description": "Template content source (git, file)"}, "content_url": {"type": "string", "description": "Git project URL when the content type is git required only in case of content type git"}, "content_files": {"type": "string", "description": "Details about content like its data,filename"}, "description": {"type": "string", "description": "Usage of template"}, "resources": {"type": "string"}, "resource_type": {"type": "string"}, "status": {"type": "string", "description": "Status of the template[active/inactive]. Only active templates can be executed"}, "type": {"type": "array", "description": "Type of the template like Cloud, Monitoring, Orchestration., etc", "items": {"type": "string"}}, "dsl": {"type": "string", "description": "DSL of the template"}, "classification": {"type": "array", "description": "Classification of the template", "items": {"type": "string"}}, "scope": {"type": "string", "description": "Scope of the template [Account,Tenant,Private]"}, "created_by": {"type": "string", "description": "Name of the user who created the template."}, "created_at": {"type": "string", "description": "Template creation time"}, "updated_by": {"type": "string", "description": "Name of the user who updated the templated. "}, "updated_at": {"type": "string", "description": "Template updated time"}}, "type": "object"}, "TenantComplianceSummaryWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "TenantComplianceSummaryWidgetConfiguration"}, "TenantComplianceTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "TenantComplianceTrendWidgetConfiguration"}, "TenantCreateResponse": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Id of the newly created tenant. This will be used for performing tenant level operations such as createPolicy, createScript, onboardCloudAccount and so on."}}, "type": "object"}, "TenantDetails": {"required": ["account_id", "created_at", "description", "is_default", "name", "status", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Id of the tenant. This will be used for performing tenant level operations such as createPolicy, createScript, onboardCloudAccount and so on."}, "name": {"type": "string", "description": "Unique name of the tenant provided as input while creating."}, "description": {"type": "string", "description": "Description of the tenant."}, "account_id": {"type": "string", "description": "Id of the CoreStack account under which this tenant resides."}, "is_default": {"type": "boolean", "description": "Is the master tenant"}, "fiscal_year_configuration": {"description": "Fiscal Year settings", "$ref": "#/definitions/FiscalYearConfiguration"}, "cost_anomaly_settings": {"$ref": "#/definitions/CostAnomalyConfiguration"}, "cost_processing_settings": {"$ref": "#/definitions/CostProcessingSettings"}, "azure_hybrid_benefits_enabled": {"type": "boolean", "description": "azure hybrid benefits enabled under finOps"}, "disk_utilization_settings": {"description": "enables disk utilization configuration for specified service accounts", "$ref": "#/definitions/DiskUtilizationSetting"}, "dimension_settings": {"type": "array", "items": {"$ref": "#/definitions/DimensionTenantSettings"}}, "status": {"type": "string", "description": "Indicates the status of the Tenant", "example": "active", "enum": ["active", "suspended"], "x-cs-enum-type": "TenantStatus"}, "created_at": {"type": "string", "description": "Created DateTime in UTC of the tenant."}, "activity_queue_notifications": {"$ref": "#/definitions/ActivityQueueNotificationDetails"}}, "type": "object"}, "TenantNameRegexQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tenant_name"], "properties": {"tenant_name": {"description": "Tenant name regex pattern", "$ref": "#/definitions/Regex"}}, "type": "object"}], "x-cs-type-name": "TenantNameRegexQueryOperator"}, "TenantQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "Tenants to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "TenantQueryOperator"}, "TenantTagKeyQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_keys"], "properties": {"tag_keys": {"type": "array", "description": "Tag keys to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "TenantTagKeyQueryOperator"}, "TenantTagKeyValueQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["tag_key", "tag_values"], "properties": {"tag_key": {"type": "string", "description": "Tag key for the given tenant"}, "tag_values": {"type": "array", "description": "Tag values for the given key", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "TenantTagKeyValueQueryOperator"}, "TenantUpdateResponse": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Id of the updated tenant. This Id will be used for performing tenant level operations such as createPolicy, createScript, onboardCloudAccount and so on."}}, "type": "object"}, "TextWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/WidgetConfiguration"}, {"properties": {"text": {"type": "string"}, "color": {"type": "string"}, "alignment": {"type": "string", "example": "Left", "enum": ["Left", "Center", "Right"], "x-cs-enum-type": "HorizontalAlignment"}, "preventWrapping": {"type": "boolean"}}, "type": "object"}], "x-cs-type-name": "TextWidgetConfiguration"}, "ThirdPartySubscription": {"properties": {"provider": {"type": "string", "description": "Provider of subscription"}, "type": {"type": "string", "description": "Type of subscription", "example": "marketplace", "enum": ["marketplace"], "x-cs-enum-type": "ThirdPartySubscriptionType"}, "subscription_name": {"type": "string", "description": "Subscription Name"}, "subscription_id": {"type": "string", "description": "Subscription ID"}, "plan_id": {"type": "string", "description": "Plan ID"}, "offer_id": {"type": "string", "description": "Offer ID"}, "purchaser_email": {"type": "string", "description": "Purchaser Email Id"}, "activation_details": {"description": "Activation Details", "$ref": "#/definitions/ActivationDetails"}}, "type": "object"}, "ThreatExplorerWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ThreatExplorerWidgetConfiguration"}, "ThreatIntentQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["intents"], "properties": {"intents": {"type": "array", "description": "Intents of the threat to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ThreatIntentQueryOperator"}, "ThreatResponse": {"allOf": [{"$ref": "#/definitions/ThreatVulnerabilityBaseResponse"}, {"properties": {"intent": {"type": "array", "description": "List of threat intents, representing the potential goals or purposes behind the threat, such as \"Persistence\", \"CredentialAccess\", or \"DefenseEvasion\". These help categorize and understand the threat behavior.", "items": {"type": "string"}}, "threat_id": {"type": "string", "description": "Unique identifier of the threat.", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "ThreatVulnerabilitiesFiltersRequestSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "resource", "enum": ["resource", "severity", "service_name", "status", "findings_id", "resource_id", "resource_name"], "x-cs-enum-type": "ThreatVulnerabilitiesFiltersRequestSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "ThreatVulnerabilityBaseResponse": {"properties": {"service_account_id": {"type": "string", "description": "ID of the service account to which the threat/vulnerability belongs to.", "x-cs-type": "ObjectId"}, "cloud_provider": {"type": "string", "description": "Cloud Provider of the service account", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "tenant_id": {"type": "string", "description": "Tenant ID where the service account belongs to", "x-cs-type": "ObjectId"}, "resource_id": {"type": "string", "description": "ID of the resource where the threat/vulnerability is observed"}, "resource_name": {"type": "string", "description": "Name of the resource where the threat/vulnerability is observed"}, "resource_category": {"type": "string", "description": "Category of the resource to which the threat/vulnerability belongs to."}, "resource_type": {"type": "string", "description": "Type of the resource to which the threat/vulnerability belongs to."}, "resource": {"type": "string", "description": "Resource to which the threat/vulnerability belongs to."}, "region": {"type": "string", "description": "Region the impacted resource is located in."}, "location": {"type": "string", "description": "Location the impacted resource is located in."}, "resource_group": {"type": "string", "description": "Resource Group of the resource to which the threat/vulnerability belongs to."}, "severity": {"type": "string", "description": "Severity of the threat/vulnerability", "example": "Critical", "enum": ["Critical", "High", "Info", "Low", "Medium", "None", "Unknown"], "x-cs-enum-type": "Severity"}, "status": {"type": "string", "description": "Status of the threats/vulnerabilities", "example": "active", "enum": ["active", "closed", "inactive", "resolved", "skipped", "suppressed"], "x-cs-enum-type": "ThreatVulnerabilityStatus"}, "source": {"type": "string", "description": "Source of the threat/vulnerability"}, "issue_type": {"type": "string", "description": "Issue Type of the threat/vulnerability"}, "provider_issue_id": {"type": "string", "description": "Unique id for threat/vulnerability as provided by the cloud provider"}, "title": {"type": "string", "description": "Title of the threat/vulnerability"}, "created_at": {"type": "string", "format": "date-time", "description": "Date and time when the threat/vulnerability was created in corestack"}, "updated_at": {"type": "string", "format": "date-time", "description": "Date and time when the threat/vulnerability was updated in corestack"}, "description": {"type": "string", "description": "Description of the threat/vulnerability"}, "detected_at": {"type": "string", "format": "date-time", "description": "Date and time when the threat/vulnerability was detected"}, "recommendation": {"type": "string", "description": "Recommendation for the threat/vulnerability"}, "remediation": {"type": "string", "description": "Recommended remediation for the threat/vulnerability"}, "source_data": {"type": "object", "description": "Source data of the threat/vulnerability captured from the cloud."}}, "type": "object"}, "ThreatVulnerabilityFilters": {"allOf": [{"$ref": "#/definitions/SecurityInfraDashboardBaseFilters"}, {"properties": {"search": {"type": "string", "description": "Search text to filter the threats/vulnerabilities based on Resource Name, Resource ID, Findings ID"}}, "type": "object"}]}, "ThreatVulnerabilityIssueTypeQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["issue_types"], "properties": {"issue_types": {"type": "array", "description": "Issue types to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "ThreatVulnerabilityIssueTypeQueryOperator"}, "ThreatVulnerabilityRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/ThreatVulnerabilitiesFiltersRequestSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/ThreatVulnerabilityFilters"}}, "type": "object"}, "ThreatVulnerabilitySeverityQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["severities"], "properties": {"severities": {"type": "array", "description": "Severities to include", "items": {"type": "string", "description": "Severity values", "example": "Critical", "enum": ["Critical", "High", "Info", "Low", "Medium", "None", "Unknown"], "x-cs-enum-type": "Severity"}}}, "type": "object"}], "x-cs-type-name": "ThreatVulnerabilitySeverityQueryOperator"}, "ThreatVulnerabilityStatusQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["statuses"], "properties": {"statuses": {"type": "array", "description": "Statuses of the vulnerability to include", "items": {"type": "string", "description": "Status of the threats/vulnerabilities", "example": "active", "enum": ["active", "closed", "inactive", "resolved", "skipped", "suppressed"], "x-cs-enum-type": "ThreatVulnerabilityStatus"}}}, "type": "object"}], "x-cs-type-name": "ThreatVulnerabilityStatusQueryOperator"}, "ThreatsByCloudAccountWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ThreatsByCloudAccountWidgetConfiguration"}, "ThreatsByRegionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ThreatsByRegionWidgetConfiguration"}, "ThreatsConcentrationByProviderWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ThreatsConcentrationByProviderWidgetConfiguration"}, "ThreatsTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "ThreatsTrendWidgetConfiguration"}, "ThresholdActionConfigurationModel": {"properties": {"action_configuration": {"type": "array", "description": "action configuration", "items": {"type": "string"}}, "action_uri": {"type": "array", "description": "action uri", "items": {"type": "string"}}}, "type": "object"}, "ThresholdAlertDetailsModel": {"required": ["threshold_name", "threshold_uri"], "properties": {"threshold_name": {"type": "string", "description": "threshold name"}, "threshold_uri": {"type": "string", "description": "threshold uri"}}, "type": "object"}, "ThresholdAlertListModel": {"required": ["alert_notification_details", "budget_uri", "configuration_type", "created_at", "created_by", "id", "name", "tenant_id", "threshold_amount", "threshold_percentage", "threshold_uri", "updated_at", "updated_by"], "properties": {"id": {"type": "string", "description": "threshold id"}, "tenant_id": {"type": "string", "description": "tenant id"}, "created_by": {"type": "string", "description": "Name of the user who created the threshold alert."}, "created_at": {"type": "string", "description": "Created time to create threshold alert"}, "updated_by": {"type": "string", "description": "Name of the user who updated the the threshold alert."}, "updated_at": {"type": "string", "description": "Updated time to create threshold alert"}, "threshold_uri": {"type": "string", "description": "threshold uri"}, "threshold_percentage": {"type": "number", "description": "threshold percentage"}, "threshold_amount": {"type": "number", "description": "threshold amount"}, "configuration_type": {"type": "string", "description": "Configuration type"}, "alert_action_details": {"type": "array", "description": "alert action details", "items": {"type": "string"}}, "budget_uri": {"type": "string", "description": "threshold uri"}, "name": {"type": "string", "description": "Threshold Action name"}, "alert_notification_details": {"type": "array", "description": "Alert Notification Details", "items": {"$ref": "#/definitions/AlertNotificationDetailsModel"}}}, "type": "object"}, "ThresholdAlertListResponse": {"required": ["threshold_details"], "properties": {"threshold_details": {"type": "array", "description": "Threshold Details", "items": {"$ref": "#/definitions/ThresholdAlertListModel"}}}, "type": "object"}, "ThresholdAlertUpdateRequest": {"required": ["budget_uri", "threshold_details"], "properties": {"budget_uri": {"type": "string", "description": "budget uri"}, "threshold_details": {"type": "array", "description": "Threshold Details", "items": {"$ref": "#/definitions/ThresholdDetailsModel"}}}, "type": "object"}, "ThresholdAlertUpdateResponse": {"required": ["threshold_details"], "properties": {"threshold_details": {"type": "array", "items": {"$ref": "#/definitions/ThresholdAlertDetailsModel"}}}, "type": "object"}, "ThresholdAlertViewListRequest": {"required": ["budget_uri"], "properties": {"budget_uri": {"type": "string", "description": "budget uri"}, "project_id": {"type": "string", "description": "tenant ID"}, "dimension_id": {"type": "array", "description": "dimension ID", "items": {"type": "string"}}}, "type": "object"}, "ThresholdDetailsModel": {"required": ["alert_action_details", "alert_notification_details", "configuration_type", "created_at", "created_by", "id", "tenant_id", "threshold_name", "threshold_percentage", "updated_at", "updated_by"], "properties": {"threshold_percentage": {"type": "number", "description": "threshold percentage"}, "threshold_name": {"type": "string", "description": "threshold name"}, "alert_notification_details": {"description": "alert notification details", "$ref": "#/definitions/ThresholdNotificationConfigurationModel"}, "configuration_type": {"type": "string", "description": "Configuration type"}, "alert_action_details": {"description": "alert action details", "$ref": "#/definitions/ThresholdActionConfigurationModel"}, "tenant_id": {"type": "string", "description": "tenant id"}, "created_by": {"type": "string", "description": "Name of the user who created the threshold alert."}, "created_at": {"type": "string", "description": "Created time to create threshold alert"}, "updated_by": {"type": "string", "description": "Name of the user who updated the the threshold alert."}, "updated_at": {"type": "string", "description": "Updated time to create threshold alert"}, "id": {"type": "string", "description": "Threshold alert id which can be retrieved from View Budget Threshold Alerts API"}}, "type": "object"}, "ThresholdNotificationConfigurationModel": {"properties": {"notification_configuration": {"type": "array", "description": "notification configuration", "items": {"$ref": "#/definitions/NotificationConfigurationModel"}}, "notification_uri": {"type": "array", "description": "notification uri", "items": {"type": "string"}}}, "type": "object"}, "Tier": {"required": ["__type"], "properties": {"min": {"type": "number", "description": "Minimum value of the tier"}, "max": {"type": "number", "description": "Maximum value of the tier"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "BillingRuleTier", "subtype_name": "BillingRuleTier"}, {"subtype_model": "CreateLineItemTier", "subtype_name": "CreateLineItemTier"}]}, "TimeDetails": {"required": ["hour", "minute", "seconds"], "properties": {"seconds": {"type": "string", "description": "The Template/Script/Policy is scheduled at which second. Allowed values: 00-60"}, "minute": {"type": "string", "description": "The Template/Script/Policy is scheduled at which minute. Allowed values: 00-60"}, "hour": {"type": "string", "description": "The Template/Script/Policy is scheduled at which hour. Allowed values: 01-23"}}, "type": "object"}, "TimeDuration": {"properties": {"amount": {"type": "integer"}, "unit": {"type": "string", "example": "NANOS", "enum": ["NANOS", "MICROS", "MILLIS", "SECONDS", "MINUTES", "HOURS", "HALF_DAYS", "DAYS", "WEEKS", "MONTHS", "YEARS", "DECADES", "CENTURIES", "MILLENNIA", "ERAS", "FOREVER"], "x-cs-enum-type": "ChronoUnit"}}, "type": "object"}, "TimeSeriesPoint": {"properties": {"timestamp": {"type": "string", "format": "date-time", "description": "Timestamp in ISO format"}, "average": {"type": "number", "description": "Average value"}, "total": {"type": "number", "description": "Total value"}, "minimum": {"type": "number", "description": "Minimum value"}, "maximum": {"type": "number", "description": "Maximum value"}, "count": {"type": "integer", "description": "Count"}}, "type": "object"}, "TimezoneModel": {"required": ["id", "raw_offset"], "properties": {"id": {"type": "string", "description": "Id of the Timezone such as Asia/Kolkata, Asia/Dubai and so on."}, "raw_offset": {"type": "string", "description": "Raw offset of the timezone. It means the amount of time in milliseconds to add to UTC to get standard time in the required time zone."}}, "type": "object"}, "TokenTenantModel": {"properties": {"id": {"type": "string", "description": "Id of the tenant. This will be used for performing tenant level operations such as createPolicy, createScript, onboardCloudAccount and so on."}, "name": {"type": "string", "description": "Unique name of the tenant provided as input when creating."}, "master_tenant": {"type": "boolean", "description": "If user created under particular tenant it will be set to True or else False"}, "roles": {"type": "object", "description": "Roles"}}, "type": "object"}, "TopBudgetByTenant": {"properties": {"tenant_id": {"type": "string"}, "budget_details": {"type": "array", "items": {"$ref": "#/definitions/Budget"}}}, "type": "object"}, "TopBudgetByTenantRequest": {"allOf": [{"$ref": "#/definitions/CommonCostRequest"}, {"properties": {}, "type": "object"}]}, "TopBudgetByTenantWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "TopBudgetByTenantWidgetConfiguration"}, "TopConsumptionUsage": {"properties": {"category": {"type": "string", "description": "Category of the top consumption usage"}, "component": {"type": "string", "description": "Component associated with the top consumption usage"}, "resource": {"type": "string", "description": "Resource associated with the top consumption usage"}, "count": {"type": "integer", "description": "Count of the top consumption usage"}}, "type": "object"}, "TopCostOptimizationWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"required": ["optimizationSelection"], "properties": {"optimizationSelection": {"type": "string", "description": "Type of Optimization", "example": "Region", "enum": ["Region", "ProductCategory"], "x-cs-enum-type": "OptimizationSelection"}}, "type": "object"}], "x-cs-type-name": "TopCostOptimizationWidgetConfiguration"}, "TopPodWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "TopPodWidgetConfiguration"}, "TopRecommendations": {"required": ["message", "status", "top_recommendations"], "properties": {"status": {"type": "string", "description": "Response status on resource wise top recommendations"}, "message": {"type": "string", "description": "top recommendations list"}, "top_recommendations": {"type": "object", "description": "Top Recommendation"}}, "type": "object"}, "TopResourcesWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {"forPlatform": {"type": "boolean"}}, "type": "object"}], "x-cs-type-name": "TopResourcesWidgetConfiguration"}, "UiFeatureFlagsWithDefaults": {"allOf": [{"$ref": "#/definitions/FeatureFlagsWithDefaults"}, {"properties": {"ui_2601_f_infra_dashboard_vulnerbility_explorer": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_infra_dashboard_threats_explorer": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_infra_dashboard_misconfigurations_explorer": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_infra_dashboard_open_issues_trend": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_infra_dashboard_by_severity_by_account": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_infra_dashboard_by_resource_category": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_infra_dashboard_by_inventory_overview": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_infra_dashboard_resource_issues_flow": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_infra_dashboard_by_region": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2601_f_widget_filter_lazy_select": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2602_f_lazy_dropdown_select": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2602_f_dimension_creation_wizard": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2602_f_infra_dashboard_enable_workload_filter": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2602_f_widget_lazy_sa": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2602_f_t2_data_time_range_presets": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2603_f_ai_observability_119985": {"type": "boolean", "description": "Flag's default value", "default": true}, "ui_2603_f_remediation_explorer": {"type": "boolean", "description": "Flag's default value", "default": true}}, "type": "object"}]}, "UniqueIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["ids"], "properties": {"ids": {"type": "array", "description": "List of unique ID(s) to include.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "UniqueIdQueryOperator"}, "UnitRateCrawlerConfiguration": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "UnitRateCrawlerConfigurationForAzureEA", "subtype_name": "UnitRateCrawlerConfigurationForAzureEA"}]}, "UnitRateCrawlerConfigurationForAzureEA": {"allOf": [{"$ref": "#/definitions/UnitRateCrawlerConfiguration"}, {"properties": {"parent_account_id": {"type": "string"}, "enrollment_id": {"type": "string"}, "subscription_id": {"type": "string"}, "account_id": {"type": "string"}, "currency_code": {"type": "string", "description": "currency of the cost. Example 'currency':'USD'", "example": "AED", "enum": ["AED", "ALL", "ARS", "AUD", "BAM", "BDT", "BGN", "BHD", "BRL", "CAD", "CHF", "CLP", "CNY", "COP", "CRC", "CZK", "DKK", "EGP", "EUR", "GBP", "HKD", "HRK", "HUF", "IDR", "ILS", "INR", "ISK", "JPY", "KES", "KRW", "KWD", "KZT", "MOP", "MVR", "MXN", "MYR", "NOK", "NZD", "OMR", "PEN", "PHP", "PKR", "PLN", "QAR", "RON", "RSD", "RUB", "SAR", "SEK", "SGD", "THB", "TRY", "TWD", "USD", "VND", "ZAR"], "x-cs-enum-type": "Currency"}}, "type": "object"}], "x-cs-type-name": "UnitRateCrawlerConfigurationForAzureEA"}, "UpdateBlueprintResponse": {"required": ["blueprint_id"], "properties": {"blueprint_id": {"type": "string", "description": "Blueprint ID"}}, "type": "object"}, "UpdateMarkupRequest": {"allOf": [{"$ref": "#/definitions/MarkupDetails"}, {"properties": {}, "type": "object"}]}, "UpdateMarkupResponse": {"properties": {"name": {"type": "string", "description": "Updated Rule name"}}, "type": "object"}, "UpdatePolicyRequest": {"required": ["category", "classification", "content", "name", "scope", "severity", "sub_classification"], "properties": {"name": {"type": "string", "description": "policy name which is unique and does not allow space or special character"}, "display_name": {"type": "string", "description": "Display name of policy which allow space this is to mostly show on the ui"}, "description": {"type": "string", "description": "A brief explanation of the policy."}, "type": {"type": "array", "description": "Indicates the type of policy", "items": {"type": "string"}}, "category": {"type": "string", "description": "The category will be either service or resource"}, "content": {"type": "string", "description": "The policy content"}, "is_system_policy": {"type": "boolean", "description": "Flag to identify system policies"}, "metadata": {"description": "Metadata about policy", "$ref": "#/definitions/PolicyMetadata"}, "engine_type": {"type": "string", "description": "Engine type of the policy", "example": "corestack_policy", "enum": ["corestack_policy", "aws_organization_policy", "azure_policy", "aws_config", "gcp_organization_policy", "gcp_policy", "kubernetes_policy", "oracle_cloud_guard"], "x-cs-enum-type": "PolicyEngineType"}, "cloud": {"type": "array", "description": "Displays the cloud associated with the policy", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "classification": {"type": "string", "description": "Policies are classified based on the basis of the activity they perform, for example provisioning, Account Management, Utilization, etc. This value is displayed in this field"}, "sub_classification": {"type": "string", "description": "Sub classification for policy"}, "scope": {"type": "string", "description": "The scope of the policy:\nAccount scope - All users under that account will have access to view and execute Only Account admins can update/delete the policies,\nTenant Scope - Users with access to the specific tenant will have access to policies who can describe or execute policies. Tenant admins can only update/delete.\nPrivate Scope - User who created will only have access", "example": "private", "enum": ["private", "account", "tenant"], "x-cs-enum-type": "AccountScope"}, "content_type": {"type": "string", "description": "Policy content source", "example": "git", "enum": ["git", "file"], "x-cs-enum-type": "ContentType"}, "content_password_or_key": {"type": "string", "description": "Password or private key to access of Git repo if repo is authenticated required if the content type is git"}, "content_username": {"type": "string", "description": "Username of Git repo if repo is authenticated required if the content type is git"}, "content_url": {"type": "string", "description": "Git project URL when the content type is git required if the content type is git"}, "content_path": {"type": "string", "description": "Root path of the policy in git repo required if the content type is git"}, "severity": {"type": "string", "description": "Severity of policy", "example": "high", "enum": ["high", "low", "medium"], "x-cs-enum-type": "PolicySeverity"}}, "type": "object"}, "UpdateRoleAssignment": {"properties": {"tenant_id": {"type": "string", "description": "ID of the tenant within the CoreStack account"}, "role_names": {"type": "array", "description": "Name of the Roles to be assigned to the user under a tenant", "items": {"type": "string"}}}, "type": "object"}, "UpdateScheduleRequest": {"required": ["attributes", "name", "recurrence", "resource", "schedule"], "properties": {"name": {"type": "string", "description": "Schedule Name to be create"}, "description": {"type": "string", "description": "Description of the schedule"}, "recurrence": {"type": "string", "description": "Recurrence of the schedule", "example": "Once", "enum": ["Once", "Minutes", "Hours", "Daily", "Weekly", "Monthly", "Annually"], "x-cs-enum-type": "ScheduleRecurrence"}, "schedule": {"description": "Schedule date and time details", "$ref": "#/definitions/DateAndTimeDetails"}, "resource": {"type": "array", "description": "Template/Script/Policy Id.can be retrieved using the List Policy Schedules", "items": {"type": "string"}}, "attributes": {"description": "Attribute Details", "$ref": "#/definitions/AttributeDetails"}, "args": {"type": "object", "description": "Input Parameters for the Template/Script/Policy"}}, "type": "object"}, "UpdateScheduleRequestScript": {"required": ["attributes", "name", "recurrence", "resource", "schedule"], "properties": {"name": {"type": "string", "description": "Schedule Name to be create"}, "description": {"type": "string", "description": "Description of the schedule"}, "recurrence": {"type": "string", "description": "Recurrence of the schedule", "example": "Once", "enum": ["Once", "Minutes", "Hours", "Daily", "Weekly", "Monthly", "Annually"], "x-cs-enum-type": "ScheduleRecurrence"}, "schedule": {"description": "Schedule date and time details", "$ref": "#/definitions/DateAndTimeDetails"}, "resource": {"type": "array", "description": "Template/Script/Policy Id.can be retrieved using the List Policy Schedules", "items": {"type": "string"}}, "attributes": {"description": "Attribute Details", "$ref": "#/definitions/AttributeDetails"}, "args": {"description": "Input Parameters for the Template/Script/Policy", "$ref": "#/definitions/ArgsDetails"}}, "type": "object"}, "UpdateScheduleResponse": {"required": ["id"], "properties": {"id": {"type": "string", "description": "Schedule ID"}}, "type": "object"}, "UpdateTenantRequest": {"properties": {"name": {"type": "string", "description": "New name for the tenant. Tenant Name must be unique within the account. Must be 3-100 characters. Special characters ' \" # ? / \\ are not allowed."}, "description": {"type": "string", "description": "Description of the the tenant."}, "metadata": {"type": "object", "description": "metadata is freeform JSON. It allows to store custom keys and values. It will be useful for storing information about an external applications that will refer to CoreStack tenant."}, "account_id": {"type": "string", "description": "Id of the CoreStack account under which the tenant to be updated."}, "fiscal_year_configuration": {"description": "Fiscal Year settings", "$ref": "#/definitions/FiscalYearConfiguration"}, "cost_anomaly_settings": {"$ref": "#/definitions/CostAnomalyConfiguration"}, "cost_processing_settings": {"$ref": "#/definitions/CostProcessingSettings"}, "azure_hybrid_benefits_enabled": {"type": "boolean", "description": "azure hybrid benefits enabled under finOps"}, "disk_utilization_settings": {"description": "enables disk utilization configuration for specified service accounts", "$ref": "#/definitions/DiskUtilizationSetting"}, "dimension_settings": {"type": "array", "description": "Dimension Settings for this Tenant", "items": {"$ref": "#/definitions/DimensionTenantSettings"}}, "status": {"type": "string", "description": "Indicates the status of the Tenant", "example": "active", "enum": ["active", "suspended"], "x-cs-enum-type": "TenantStatus"}}, "type": "object"}, "UsageDetails": {"required": ["avg_percentage", "reserved_hours", "unused_hours", "used_hours"], "properties": {"reserved_hours": {"type": "integer", "description": "How many hours are reserved"}, "avg_percentage": {"type": "integer", "description": "Average Percentage used"}, "used_hours": {"type": "integer", "description": "How many hours are used"}, "unused_hours": {"type": "integer", "description": "How many hours are unused"}}, "type": "object"}, "User": {"properties": {"sysId": {"type": "string"}, "createdOn": {"type": "string", "format": "date-time"}, "updatedOn": {"type": "string", "format": "date-time"}, "firstName": {"type": "string"}, "lastName": {"type": "string"}, "emailAddress": {"type": "string"}, "phoneNumber": {"type": "string"}, "roles": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}, "groups": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}, "origin": {"type": "string"}}, "type": "object"}, "UserCreateRequest": {"required": ["account_id", "email", "role_assignment", "timezone_id", "username"], "properties": {"username": {"type": "string", "description": "The unique username for the user to be created. This value is expected to be unique across all accounts. Hence it is recommended that you use the email address as the value here. Validations:- Min length - 5, Alphanumeric"}, "email": {"type": "string", "description": "Email ID of the user. This wil be unique across all the CoreStack accounts"}, "timezone_id": {"type": "string", "description": "ID of the timezone to be set for th user. For a valid list of timezone values to use, please refer https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"}, "account_id": {"type": "string", "description": "ID of the Account in CoreStack. It will be available in the authToken API response"}, "first_name": {"type": "string", "description": "First Name of the user. It can be only alphanumeric"}, "last_name": {"type": "string", "description": "Last Name of the user. It can be only alphanumeric"}, "role_assignment": {"type": "array", "description": "List of roles assignments for the user. The same user can be assigned different roles in different tenants", "items": {"$ref": "#/definitions/AddRoleAssignment"}}, "is_accesskey_required": {"type": "boolean", "description": "Is Access Key to be generated for this user", "default": false}}, "type": "object"}, "UserCreateResponse": {"required": ["user_id"], "properties": {"user_id": {"type": "string", "description": "ID of the newly created User"}}, "type": "object"}, "UserDelegation": {"allOf": [{"$ref": "#/definitions/UserDelegationRequest"}, {"properties": {"source_master_account_id": {"type": "string", "description": "User delegation source account master id"}, "created_at": {"type": "string", "format": "date-time", "description": "Date and Time of Creation"}, "created_by": {"type": "string", "description": "User that created delegation"}, "updated_at": {"type": "string", "format": "date-time", "description": "Date and Time of Last Update"}, "updated_by": {"type": "string", "description": "User that last updated delegation"}}, "type": "object"}]}, "UserDelegationBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/UserDelegation"}}}, "type": "object"}, "UserDelegationListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/UserDelegationSortCriteria"}}}, "type": "object"}, "UserDelegationRequest": {"properties": {"source_user_groups": {"type": "array", "items": {"type": "string", "description": "User delegation source user groups"}}, "source_roles": {"type": "array", "items": {"type": "string", "description": "User delegation source roles"}}, "source_users": {"type": "array", "items": {"type": "string", "description": "User delegation source users"}}, "target_master_account_id": {"type": "string", "description": "User delegation target account master id"}, "target_roles": {"type": "array", "items": {"type": "string", "description": "User delegation target roles"}}, "target_user_groups": {"type": "array", "items": {"type": "string", "description": "User delegation target user groups"}}}, "type": "object"}, "UserDelegationResponse": {"properties": {"id": {"type": "string", "description": "User delegation id"}}, "type": "object"}, "UserDelegationRole": {"properties": {"id": {"type": "string", "description": "Role id"}, "name": {"type": "string", "description": "Role name"}}, "type": "object"}, "UserDelegationSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CreatedAt", "enum": ["CreatedAt"], "x-cs-enum-type": "UserDelegationSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "UserDelegationSummary": {"properties": {"master_account_id": {"type": "string", "description": "User delegation master account id"}, "master_account_name": {"type": "string", "description": "User delegation master account name"}, "hierarchy_level": {"type": "string", "description": "User delegation hierarchy level"}, "tenants": {"type": "array", "description": "Tenants in the delegation", "items": {"$ref": "#/definitions/UserDelegationTenant"}}, "user_groups": {"type": "array", "description": "UserGroups in the delegation", "items": {"$ref": "#/definitions/UserDelegationUserGroup"}}}, "type": "object"}, "UserDelegationTenant": {"properties": {"tenant_id": {"type": "string", "description": "Tenant id"}, "tenant_name": {"type": "string", "description": "Tenant name"}, "roles": {"type": "array", "description": "Delegation roles", "items": {"$ref": "#/definitions/UserDelegationRole"}}}, "type": "object"}, "UserDelegationUserGroup": {"properties": {"id": {"type": "string", "description": "User group id"}, "name": {"type": "string", "description": "User group name"}}, "type": "object"}, "UserDescribeResponse": {"required": ["email", "first_name", "last_name", "role_assignment", "status", "timezone_id", "user_id", "username"], "properties": {"user_id": {"type": "string", "description": "ID of the User. This is an auto generated and unique in the CoreStack system"}, "username": {"type": "string", "description": "Username is unique in the CoreStack system. User can use this to login to CoreStack portal in addition to email"}, "status": {"type": "string", "description": "Current Status of the user - active or inactive. Inactive user cannot login or use AccessKeys."}, "email": {"type": "string", "description": "Email of the User. This is unique in the CoreStack system."}, "first_name": {"type": "string", "description": "First Name of the user. It can be only alphanumeric."}, "last_name": {"type": "string", "description": "Last Name of the user. It can be only alphanumeric."}, "role_assignment": {"type": "array", "description": "List of roles assignments for the user. The same user can be assigned different roles in different tenants", "items": {"$ref": "#/definitions/RoleAssignment"}}, "timezone_id": {"type": "string", "description": "ID of the Timezone such as Asia/Kolkata, Asia/Dubai and so on"}, "created_by": {"type": "string", "description": "Name of the user/admin who created this user"}, "created_at": {"type": "string", "description": "DateTime when the user was created"}, "updated_by": {"type": "string", "description": "Name of the user/admin last updated this user"}, "updated_at": {"type": "string", "description": "DateTime when the user was last updated"}, "sso_userid": {"type": "string", "description": "User's Single Sign-on Id, if CoreStack is deployed using SingleSignOn (SSO) model"}, "account_id": {"type": "string", "description": "ID of the Account in CoreStack. It will be available in the authToken API response"}, "is_accesskey_available": {"type": "boolean", "description": "Is Access Key available for this user."}, "source_user_id": {"type": "string", "description": "source user id"}}, "type": "object"}, "UserDetails": {"required": ["email", "role_assignment", "status", "timezone_id", "user_id", "username"], "properties": {"user_id": {"type": "string", "description": "ID of the User. This is an auto generated and unique in the CoreStack system"}, "username": {"type": "string", "description": "Username is unique in the CoreStack system. User can use this to login to CoreStack portal in addition to email"}, "status": {"type": "string", "description": "Current Status of the user - active or inactive. Inactive user cannot login or use AccessKeys"}, "email": {"type": "string", "description": "Email of the User. This is unique in the CoreStack system"}, "role_assignment": {"type": "array", "description": "List of roles assignments or the user. The same user can be assigned different roles in different tenants", "items": {"$ref": "#/definitions/RoleAssignment"}}, "timezone_id": {"type": "string", "description": "Id of the Timezone such as Asia/Kolkata, Asia/Dubai and so on"}, "source_user_id": {"type": "string", "description": "source user id"}}, "type": "object"}, "UserGroupBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/UserGroupDetails"}}}, "type": "object"}, "UserGroupDetails": {"properties": {"created_by": {"type": "string", "description": "Name of the user who created this user group"}, "created_at": {"type": "string", "format": "date-time", "description": "When the user group was created"}, "updated_by": {"type": "string", "description": "Name of the user last updated this user group"}, "updated_at": {"type": "string", "format": "date-time", "description": "When the user group was last updated"}, "group_name": {"type": "string", "description": "Name of the user group"}, "tenant_ids": {"type": "array", "description": "ID of tenants within the CoreStack account", "items": {"type": "string"}}, "roles": {"type": "array", "description": "List of role IDs assigned to UserGroup", "items": {"type": "string"}}, "users": {"type": "array", "description": "List of users IDs assigned to UserGroup", "items": {"type": "string"}}}, "type": "object"}, "UserGroupFilters": {"properties": {"tenant_ids": {"type": "array", "items": {"type": "string", "description": "Filter By tenants"}}}, "type": "object"}, "UserGroupListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/UserGroupSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/UserGroupFilters"}}, "type": "object"}, "UserGroupListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "UserGroupRequest": {"required": ["group_name", "roles", "tenant_ids", "users"], "properties": {"group_name": {"type": "string", "description": "The unique group name for the user group to be created."}, "tenant_ids": {"type": "array", "description": "ID of tenants to assign to UserGroup", "items": {"type": "string"}}, "roles": {"type": "array", "description": "List of role IDs to assign to UserGroup", "items": {"type": "string"}}, "users": {"type": "array", "description": "List of users IDs to assign to UserGroup", "items": {"type": "string"}}}, "type": "object"}, "UserGroupSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "CreatedAt"], "x-cs-enum-type": "UserGroupSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "UserInviteRequest": {"required": ["email", "master_account_id", "tenants"], "properties": {"email": {"type": "string", "description": "Email ID of the user. This wil be unique across all the CoreStack accounts"}, "tenants": {"type": "array", "description": "List of roles assignments for the user. The same user can be assigned different roles in different tenants", "items": {"$ref": "#/definitions/UserInviteTenantRoles"}}, "master_account_id": {"type": "string", "description": "ID of the Account Master in CoreStack"}, "user_groups": {"type": "array", "items": {"type": "string", "description": "Ids of the Usergroups"}}}, "type": "object"}, "UserInviteResponse": {"properties": {"user_id": {"type": "string", "description": "ID of the newly invited User"}}, "type": "object"}, "UserInviteTenantRoles": {"required": ["role_ids", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "ID of the tenant within the CoreStack account"}, "role_ids": {"type": "array", "description": "Ids of the Roles to be assigned to the user under a tenant", "items": {"type": "string"}}}, "type": "object"}, "UserModel": {"required": ["active_tenant_id", "email", "id", "master_account_id", "master_account_name", "mcp_server_enabled", "mfa_enabled", "name", "timezone"], "properties": {"name": {"type": "string", "description": "Name of the user."}, "id": {"type": "string", "description": "Id of the user. This will be used for performing user level operations such as getUser, changePassword and so on."}, "email": {"type": "string", "description": "Email Id of the user. This wil be unique."}, "active_tenant_id": {"type": "string", "description": "Active tenant id."}, "timezone": {"description": "Contains information about the timezone set for the user.", "$ref": "#/definitions/TimezoneModel"}, "preferred_language": {"type": "string", "description": "Preferred language of the user.", "example": "en", "enum": ["en", "ja"], "x-cs-enum-type": "PreferredLanguage"}, "mcp_server_enabled": {"type": "boolean", "description": "Checks if the account is mcp server enabled or not"}, "mfa_enabled": {"type": "string", "description": "Checks if the account is mfa enabled or not"}, "master_account_id": {"type": "string", "description": "Master Account ID of the user."}, "master_account_name": {"type": "string", "description": "Master Account Name of the user."}, "products": {"type": "array", "description": "Products enabled in the master account", "items": {"type": "string"}}, "crm_id": {"type": "string", "description": "Customer Relationship Management ID"}, "master_account_ids": {"type": "array", "description": "list of master account ids", "items": {"type": "string"}}}, "type": "object"}, "UserPreference": {"properties": {"path": {"type": "string", "description": "Path is combination of id/key/value of user preference"}, "name": {"type": "string", "description": "Name of the user preference"}, "value": {"type": "string", "description": "Value of the user preference which is a JSON string"}, "created_at": {"type": "string", "format": "date-time", "description": "When the user preference was created"}, "updated_at": {"type": "string", "format": "date-time", "description": "When the user preference was updated"}}, "type": "object"}, "UserPreferenceDeleteRequest": {"properties": {"path": {"type": "string", "description": "Path of the user preference"}, "name": {"type": "string", "description": "Name of the user preference"}}, "type": "object"}, "UserPreferenceGetRequest": {"properties": {"path": {"type": "string", "description": "Path of the user preference"}, "name": {"type": "string", "description": "Name of the user preference"}}, "type": "object"}, "UserPreferenceListRequest": {"properties": {"path": {"type": "string", "description": "Path of the user preference"}}, "type": "object"}, "UserPreferenceListResponse": {"properties": {"names": {"type": "object", "description": "Map from name to last update timestamp", "additionalProperties": {"type": "string", "format": "date-time"}}}, "type": "object"}, "UserProfileActiveTenantRequest": {"properties": {"tenant_id": {"type": "string", "description": "Tenant ID to set as active"}}, "type": "object"}, "UserProfileActiveTenantResponse": {"properties": {"id": {"type": "string", "description": "ID for user that was updated"}, "tenant_id": {"type": "string", "description": "ID for the new active tenant"}}, "type": "object"}, "UserQueryRequest": {"required": ["query"], "properties": {"chat_id": {"type": "string", "description": "ID of the chat", "x-cs-type": "ObjectId"}, "agent_id": {"type": "string", "description": "ID of the agent", "x-cs-type": "ObjectId"}, "tenant_id": {"type": "string", "description": "ID of the tenant", "x-cs-type": "ObjectId"}, "query": {"type": "string", "description": "User query"}}, "type": "object"}, "UserQueryResponse": {"properties": {"conversation_details": {"description": "Conversation details", "$ref": "#/definitions/ConversationDetails"}, "suggested_prompts": {"type": "array", "description": "List of suggested prompt based on the query", "items": {"type": "string"}}}, "type": "object"}, "UserResponseList": {"required": ["total_count", "users"], "properties": {"total_count": {"type": "integer", "description": "Number of users in CoreStack account."}, "users": {"type": "array", "description": "List all users within a CoreStack account.", "items": {"$ref": "#/definitions/UserDetails"}}}, "type": "object"}, "UserSummary": {"properties": {"name": {"type": "string", "description": "Name of the User"}, "email": {"type": "string", "description": "User email"}, "status": {"type": "string", "description": "Status of the user", "example": "active", "enum": ["active", "suspended", "deleted", "pending_activation", "verified", "rejected"], "x-cs-enum-type": "UserStatus"}}, "type": "object"}, "UserSummaryBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/UserSummary"}}}, "type": "object"}, "UserTenantDetails": {"required": ["email", "roles", "status", "user_id", "username"], "properties": {"user_id": {"type": "string", "description": "ID of the User. This is an auto generated and unique in the CoreStack system"}, "username": {"type": "string", "description": "Username is unique in the CoreStack system. User can use this to login to CoreStack portal in addition to email"}, "status": {"type": "string", "description": "Current Status of the user - active or inactive. Inactive user cannot login or use AccessKeys"}, "email": {"type": "string", "description": "Email of the User. This is unique in the CoreStack system"}, "roles": {"type": "array", "description": "List of role assignments for the user. The same user can be assigned with different roles in a tenant", "items": {"type": "string"}}}, "type": "object"}, "UserTenantResponseList": {"required": ["total_count", "users"], "properties": {"total_count": {"type": "integer", "description": "Number of users in CoreStack account."}, "users": {"type": "array", "description": "List all users within a CoreStack account.", "items": {"$ref": "#/definitions/UserTenantDetails"}}}, "type": "object"}, "UserUpdateRequest": {"required": ["email", "timezone_id"], "properties": {"email": {"type": "string", "description": "Email ID of the user. This wil be unique across all the CoreStack accounts"}, "first_name": {"type": "string", "description": "First Name of the user. It can be only alphanumeric"}, "last_name": {"type": "string", "description": "Last Name of the user. It can be only alphanumeric"}, "timezone_id": {"type": "string", "description": "ID of the timezone to be set for th user. For a valid list of timezone values to use, please refer https://en.wikipedia.org/wiki/List_of_tz_database_time_zones"}, "role_assignment": {"type": "array", "description": "List of roles assignments for the user. The same user can be assigned different roles in different tenants", "items": {"$ref": "#/definitions/UpdateRoleAssignment"}}, "mobile": {"type": "string", "description": "Mobile number of the user."}, "preferred_language": {"type": "string", "description": "Preferred language of the user.", "example": "en", "enum": ["en", "ja"], "x-cs-enum-type": "PreferredLanguage"}}, "type": "object"}, "UserUpdateResponse": {"required": ["user_id"], "properties": {"user_id": {"type": "string", "description": "ID of the updated User"}}, "type": "object"}, "UserVerificationRequest": {"required": ["email"], "properties": {"email": {"type": "string", "description": "User email"}}, "type": "object"}, "UserVerificationResponse": {"properties": {"user_id": {"type": "string", "description": "User id"}, "token": {"type": "string"}, "reset_key": {"type": "string"}, "status": {"type": "string"}}, "type": "object"}, "UtilizationAggregateResponse": {"properties": {"results": {"type": "array", "description": "Resource Aggregate.", "items": {"$ref": "#/definitions/ResourceLevelUtilizationAggregate"}}}, "type": "object"}, "UtilizationAggregationRequest": {"allOf": [{"$ref": "#/definitions/UtilizationStatisticsRequest"}, {"required": ["end_date", "start_date"], "properties": {"filters": {"description": "Query expression to filter line items.", "$ref": "#/definitions/QueryOperator"}, "additional_filters": {"description": "Additional Query expression to filter line items. Filtering the Disk Usage Stats metrics can be applied here.", "$ref": "#/definitions/QueryOperator"}, "start_date": {"type": "string", "format": "date-time", "description": "specify the start date."}, "end_date": {"type": "string", "format": "date-time", "description": "specify the end date."}}, "type": "object"}]}, "UtilizationDetails": {"required": ["date", "percentage"], "properties": {"date": {"type": "string", "description": "Day wise utilization"}, "percentage": {"type": "integer", "description": "Utilization by percentage for that date"}}, "type": "object"}, "UtilizationMetricIdentity": {"properties": {"service_account_id": {"type": "string", "description": "service account id", "x-cs-type": "ObjectId"}, "resource_region": {"type": "string", "description": "resource region"}, "resource_id": {"type": "string", "description": "resource id"}, "metric_name": {"type": "string", "description": "metric name"}}, "type": "object"}, "UtilizationMetricSeries": {"properties": {"maximum": {"type": "array", "description": "List of maximum utilization metrics.", "items": {"type": "number"}}, "minimum": {"type": "array", "description": "List of minimum utilization metrics.", "items": {"type": "number"}}, "average": {"type": "array", "description": "List of average utilization metrics.", "items": {"type": "number"}}, "sum": {"type": "array", "description": "List of total (sum) utilization values.", "items": {"type": "number"}}, "count": {"type": "array", "description": "The count (number) of data points used for the statistical calculation.", "items": {"type": "integer"}}}, "type": "object"}, "UtilizationMetricsAggregateResult": {"properties": {"identity": {"description": "Identity of the result group.", "$ref": "#/definitions/UtilizationMetricIdentity"}, "metric_series": {"description": "Statistical summary of utilization metric data.", "$ref": "#/definitions/UtilizationMetricSeries"}, "timestamps": {"type": "array", "description": "timestamps", "items": {"type": "string", "format": "date-time"}}}, "type": "object"}, "UtilizationMetricsAggregateTrendRequest": {"required": ["end_date", "granularity", "start_date"], "properties": {"start_date": {"type": "string", "format": "date-time", "description": "specify the start date."}, "end_date": {"type": "string", "format": "date-time", "description": "specify the end date."}, "granularity": {"type": "integer", "description": "specify the granularity in seconds. Allowed values are 60, 300, 3600."}, "filters": {"description": "Query expression to filter.", "$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "UtilizationMetricsForRecommendation": {"required": ["end_date", "metric_name", "start_date"], "properties": {"start_date": {"type": "integer", "description": "specify the start date in epoch time stamp."}, "end_date": {"type": "integer", "description": "specify the end date in epoch time stamp."}, "granularity": {"type": "integer", "description": "Granularity at which the utilization metric is being persisted."}, "metric_name": {"type": "string", "description": "Metric name"}, "values": {"type": "array", "description": "values for the metrics", "items": {"type": "number"}}}, "type": "object"}, "UtilizationResourceAggregationRequest": {"properties": {"service_account_id": {"type": "string", "description": "Service account id", "x-cs-type": "ObjectId"}, "check_resource_element": {"type": "string", "description": "Unique id of the resource"}, "aggregation": {"type": "string", "description": "Aggregation of the resource"}, "metric_name": {"type": "array", "description": "metric name", "items": {"type": "string"}}, "from_date": {"type": "string", "format": "date-time", "description": "specify the start date."}, "to_date": {"type": "string", "format": "date-time", "description": "specify the end date."}}, "type": "object"}, "UtilizationResourceAggregationResponse": {"properties": {"hourly_aggregations": {"type": "array", "description": "List of supported hourly aggregation types (e.g., avg, min, max) for utilization metrics", "items": {"type": "string"}}, "daily_aggregations": {"type": "array", "description": "List of supported daily aggregation types (e.g., avg, min, max) for utilization metrics", "items": {"type": "string"}}, "time_aggregation": {"type": "array", "description": "Time-based aggregation levels available for utilization data (hourly, daily)", "items": {"type": "string"}}, "metrics": {"type": "array", "description": "List of utilization metrics and their supported aggregation configurations", "items": {"$ref": "#/definitions/ResourceUtilizationMetric"}}}, "type": "object"}, "UtilizationStatisticsRequest": {"required": ["tenant_ids"], "properties": {"tenant_ids": {"type": "array", "description": "List of tenant ids for which data needs to be passed.", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "UtilizationStatisticsResponse": {"properties": {"configured": {"type": "boolean", "description": "Indicates whether the tenant level configuration is done or not."}, "total_resources": {"type": "integer", "description": "Total number of resources for which the dashboard needs to present the data."}, "overall_statistics": {"type": "array", "description": "A statistical Data for the Kpi metrics at the selected tenant level.", "items": {"$ref": "#/definitions/IndividualKpiBase"}}, "patch_readiness_status": {"description": "Details Describing the Patch readiness Kpi metrics.", "$ref": "#/definitions/PatchReadinessStatistics"}}, "type": "object"}, "UtilizationTypeQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["utilization_types"], "properties": {"utilization_types": {"type": "array", "description": "Utilization types to include", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "UtilizationTypeQueryOperator"}, "ValidateGroupingRulesRequest": {"properties": {"rules": {"type": "array", "description": "List of Dimension Grouping Rules to validate", "items": {"$ref": "#/definitions/DimensionGroupingRule"}}}, "type": "object"}, "ValidationResult": {"properties": {"field": {"type": "string"}, "reason": {"type": "string"}}, "type": "object"}, "ValidationResults": {"properties": {"entries": {"type": "array", "items": {"$ref": "#/definitions/ValidationResult"}}}, "type": "object"}, "VerifyUserResponse": {"required": ["account_master_name", "tenant_names", "timezone", "user_email", "user_id", "user_name"], "properties": {"user_id": {"type": "string", "description": "user id"}, "user_name": {"type": "string", "description": "user name"}, "user_email": {"type": "string", "description": "user email"}, "tenant_names": {"type": "array", "description": "user tenant names", "items": {"type": "string"}}, "account_master_name": {"type": "string", "description": "user name"}, "timezone": {"type": "string", "description": "Contains information about the timezone set for the user."}}, "type": "object"}, "ViewAppliedRequest": {"required": ["cloud_account_id", "monitoring_template_uri"], "properties": {"monitoring_template_uri": {"type": "string", "description": "Specify the monitoring_template_uri of the applied template to view what is applied. Template URI can be obtained from List operation alert configuration templates"}, "cloud_account_id": {"type": "string", "description": "Cloud account id is unique can be obtained from the list cloud account api."}, "resource_type": {"type": "string", "description": "Resource Type can be obtained from List Operation visibility details"}, "resource": {"type": "string", "description": "Resource can be obtained from get operations resource details"}, "metric_name": {"type": "string", "description": "Metric name can be obtained from List Operation visibility details"}, "criticality": {"type": "string", "description": "Specify the criticality", "example": "High", "enum": ["High", "Low", "Medium"], "x-cs-enum-type": "TemplateAlertCriticality"}, "metric_type": {"type": "string", "description": "Specify the metric_type", "example": "Availability", "enum": ["Availability", "Capacity", "Failure", "Performance", "Security", "Success", "Utilization"], "x-cs-enum-type": "TemplateAlertMetricType"}, "status": {"type": "string", "description": "The data to be filtered based on the specified status", "example": "completed", "enum": ["completed", "delete_failed", "delete_in_progress", "deleted", "enabled", "failed", "skipped"], "x-cs-enum-type": "AppliedAlertStatus"}}, "type": "object"}, "ViewAppliedResponse": {"required": ["applied_records", "page_count", "total_count"], "properties": {"total_count": {"type": "integer", "description": "total records count"}, "page_count": {"type": "integer", "description": "Count of number of pages"}, "applied_records": {"description": "view applied response data", "$ref": "#/definitions/ViewAppliedResponseItem"}}, "type": "object"}, "ViewAppliedResponseItem": {"properties": {"resource": {"type": "string", "description": "Resource details retrieved successfully"}, "metric_name": {"type": "string", "description": "Metric name retrieved successfully"}, "criticality": {"type": "string", "description": "Criticality retrieved successfully"}, "metric_type": {"type": "string", "description": "metric_type retrieved successfully"}, "resource_filter": {"type": "string", "description": "Resource filter retrieved successfully"}, "status": {"type": "string", "description": "Status retrieved successfully"}, "metric_configurations": {"description": "Metric Configurations retrieved successfully", "$ref": "#/definitions/MetricConfigItems"}, "last_applied_date": {"type": "string", "description": "Last applied date retrieved successfully"}, "resource_type": {"type": "string", "description": "Resource type retrieved successfully"}, "status_message": {"type": "string", "description": "Status message retrieved successfully"}}, "type": "object"}, "ViewBlueprintDetails": {"required": ["created_at", "created_by", "description", "id", "name", "resources", "scope", "status", "updated_at", "updated_by"], "properties": {"id": {"type": "string", "description": "Blueprint ID"}, "name": {"type": "string", "description": "Blueprint Name"}, "description": {"type": "string", "description": "Blueprints Description"}, "resources": {"type": "array", "description": "Resource Details", "items": {"$ref": "#/definitions/ResourcesDetails"}}, "scope": {"type": "string", "description": "Scope of the blueprint"}, "status": {"type": "string", "description": "Status of the blueprint"}, "created_by": {"type": "string", "description": "Who has created the blueprint"}, "created_at": {"type": "string", "description": "When was the blueprint created"}, "updated_by": {"type": "string", "description": "Who has updated the blueprint"}, "updated_at": {"type": "string", "description": "When was the blueprint updated"}}, "type": "object"}, "ViewConfigurationRequest": {"required": ["template_uri"], "properties": {"template_uri": {"type": "string", "description": "Template URI"}}, "type": "object"}, "ViewConfigurationResponse": {"required": ["data", "message"], "properties": {"message": {"type": "string", "description": "Message of View Configuration"}, "data": {"type": "object", "description": "View Configuration Listing"}}, "type": "object"}, "ViewScheduleResponse": {"required": ["args", "created_at", "created_by", "description", "execution_logs", "name", "next_run", "recurrence", "resource", "schedule", "type", "updated_at", "updated_by"], "properties": {"name": {"type": "string", "description": "Schedule Name"}, "type": {"type": "string", "description": "Schedule type", "example": "template", "enum": ["template", "script", "policy"], "x-cs-enum-type": "ScheduleType"}, "description": {"type": "string", "description": "Description of the schedule"}, "recurrence": {"type": "string", "description": "Re-occurence of the schedule"}, "next_run": {"type": "string", "description": "When will the schedule run for the next time"}, "schedule": {"type": "object", "description": "Schedule date and time details"}, "args": {"type": "object", "description": "Input Parameters for that Template/Policy/Script that is scheduled"}, "resource": {"type": "array", "description": "Template/Policy/Script Details that is scheduled", "items": {"$ref": "#/definitions/ResourceViewDetails"}}, "execution_logs": {"type": "array", "description": "Execution Log Details", "items": {"$ref": "#/definitions/ExecutionLogDetails"}}, "created_at": {"type": "string", "description": "When the schedule is created"}, "created_by": {"type": "string", "description": "Who has created the schedule"}, "updated_by": {"type": "string", "description": "Who has updated the schedule"}, "updated_at": {"type": "string", "description": "When the schedule is updated"}}, "type": "object"}, "ViewState": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "DashboardViewState", "subtype_name": "DashboardViewState"}]}, "ViewViolationModel": {"required": ["category", "cloud_account_id", "cloud_account_name", "count", "name", "severity", "tenant_id", "tenant_name", "violation_category"], "properties": {"count": {"type": "integer", "description": "Count of a particular violation in a particular cloud account"}, "category": {"type": "string", "description": "Category under which a particular violation falls in a particular cloud account"}, "tenant_name": {"type": "string", "description": "Tenant under which the cloud account resides"}, "name": {"type": "string", "description": "Name of the violation"}, "cloud_account_id": {"type": "string", "description": "ID of the cloud account"}, "violation_category": {"type": "string", "description": "Category of a violation i.e. standards/utilization"}, "cloud_account_name": {"type": "string", "description": "Cloud account name"}, "tenant_id": {"type": "string", "description": "ID of the tenant"}, "severity": {"type": "string", "description": "Severity of the violation"}}, "type": "object"}, "ViewViolationResponse": {"required": ["details", "page_count", "total_count"], "properties": {"total_count": {"type": "integer", "description": "Total violations count"}, "page_count": {"type": "string", "description": "Count of number of pages"}, "details": {"type": "array", "description": "Details of violation", "items": {"$ref": "#/definitions/ViewViolationModel"}}}, "type": "object"}, "ViolationBase": {"properties": {"scanner_rule_id": {"type": "string", "description": "Rule ID."}, "resource_identifier": {"type": "string", "description": "Identifier Name for the resource for which the scanning is being done."}, "file_name": {"type": "string", "description": "Name of the File against which the violation has been generated."}}, "type": "object"}, "ViolationCategoryModel": {"required": ["standards", "utilization"], "properties": {"utilization": {"description": "Contains the category and the number of violations under Utilization", "$ref": "#/definitions/SummaryModel"}, "standards": {"description": "Contains the category and the number of violations under Standards", "$ref": "#/definitions/SummaryModel"}}, "type": "object"}, "VirtualMachineAgent": {"properties": {"name": {"type": "string", "description": "Type of the agents used.", "example": "CloudWatch", "enum": ["CloudWatch", "Qualys", "Microsoft_Defender", "CrowdStrike", "Cribl", "Splunk"], "x-cs-enum-type": "VirtualMachineAgentsType"}, "is_installed": {"type": "boolean", "description": "Installation status of the VM Agent"}}, "type": "object"}, "VirtualMachineAgentSummary": {"properties": {"sys_id": {"type": "string", "description": "Resource Id", "x-cs-type": "ObjectId"}, "service_account_id": {"type": "string", "description": "Corestack service account id", "x-cs-type": "ObjectId"}, "service_resource_inventory_id": {"type": "string", "x-cs-type": "ObjectId"}, "instance_id": {"type": "string", "description": "Virtual machine id"}, "resource_name": {"type": "string", "description": "Virtual machine name"}, "vm_agents_status": {"type": "array", "description": "List of VM agent statuses", "items": {"$ref": "#/definitions/VirtualMachineAgent"}}, "instance_type": {"type": "string", "description": "Virtual machine type"}, "instance_state": {"type": "string", "description": "Virtual machine state"}, "region": {"type": "string", "description": "Virtual machine region"}, "launch_time": {"type": "string", "format": "date-time", "description": "Virtual machine launch time"}, "os_type": {"type": "string", "description": "Virtual Machine OS Type"}, "tags": {"type": "string", "description": "Virtual machine tags"}, "host_name": {"type": "string", "description": "Private dns name"}, "ssm_ping_successful": {"type": "boolean", "description": "ssm ping status"}}, "type": "object"}, "VirtualMachineAgentsBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/VirtualMachineAgentSummary"}}}, "type": "object"}, "VirtualMachineAgentsFilter": {"required": ["cloud"], "properties": {"cloud": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "tenant_ids": {"type": "array", "description": "Specify the tenant ID. This is a unique ID and can be retrieved using the List Tenants API.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "agents": {"type": "array", "items": {"type": "string", "description": "Type of the agents used.", "example": "CloudWatch", "enum": ["CloudWatch", "Qualys", "Microsoft_Defender", "CrowdStrike", "Cribl", "Splunk"], "x-cs-enum-type": "VirtualMachineAgentsType"}}, "service_account_ids": {"type": "array", "description": "Specify the Service Account IDs.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "text_query": {"type": "string", "description": "Text query to filter agents."}}, "type": "object"}, "VirtualMachineAgentsListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/VirtualMachineAgentsSummarySortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/VirtualMachineAgentsFilter"}}, "type": "object"}, "VirtualMachineAgentsSummarySortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "resource_name", "enum": ["resource_name"], "x-cs-enum-type": "VirtualMachineAgentsSummarySortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "VisibilityFilterResponse": {"required": ["cloud_accounts", "guardrails", "tenants"], "properties": {"cloud_accounts": {"type": "array", "description": "Service accounts to filter violations based on service accounts", "items": {"$ref": "#/definitions/ServiceAccountsModel"}}, "guardrails": {"type": "array", "description": "Guardrail to filter violations based on guardrail", "items": {"$ref": "#/definitions/GuardrailModel"}}, "tenants": {"type": "array", "description": "Tenants to filter violations based on tenant", "items": {"$ref": "#/definitions/ProjectsModel"}}}, "type": "object"}, "VmAgentsQueryCrowdStrikeStatus": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["crowdstrike_status"], "properties": {"crowdstrike_status": {"type": "array", "description": "Crowdstrike Installation Status", "items": {"type": "string", "description": "Installation Status is required", "example": "Installed", "enum": ["Installed", "Not Installed"], "x-cs-enum-type": "InstallationStatus"}}}, "type": "object"}], "x-cs-type-name": "VmAgentsQueryCrowdStrikeStatus"}, "VmAgentsQueryInstantState": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["instant_state"], "properties": {"instant_state": {"type": "array", "description": "State of Instances", "items": {"type": "string", "description": "State of the Instances", "example": "running", "enum": ["running", "stopped", "others"], "x-cs-enum-type": "InstanceState"}}}, "type": "object"}], "x-cs-type-name": "VmAgentsQueryInstantState"}, "VmAgentsQueryOsTypes": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["os_type"], "properties": {"os_type": {"type": "array", "description": "Types of OS", "items": {"type": "string", "description": "OS Type of Instances", "example": "Windows", "enum": ["Windows", "Linux"], "x-cs-enum-type": "OsTypes"}}}, "type": "object"}], "x-cs-type-name": "VmAgentsQueryOsTypes"}, "VmAgentsQueryQualysStatus": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["qualys_status"], "properties": {"qualys_status": {"type": "array", "description": "Qualys Installation Status", "items": {"type": "string", "description": "Installation Status is required", "example": "Installed", "enum": ["Installed", "Not Installed"], "x-cs-enum-type": "InstallationStatus"}}}, "type": "object"}], "x-cs-type-name": "VmAgentsQueryQualysStatus"}, "VmAgentsQuerySplunkStatus": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["splunk_status"], "properties": {"splunk_status": {"type": "array", "description": "Splunk Installation Status", "items": {"type": "string", "description": "Installation Status is required", "example": "Installed", "enum": ["Installed", "Not Installed"], "x-cs-enum-type": "InstallationStatus"}}}, "type": "object"}], "x-cs-type-name": "VmAgentsQuerySplunkStatus"}, "VulnerabilitiesBySeverityByAccountWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilitiesBySeverityByAccountWidgetConfiguration"}, "VulnerabilitiesOverBuildWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilitiesOverBuildWidgetConfiguration"}, "VulnerabilityByAgeWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilityByAgeWidgetConfiguration"}, "VulnerabilityByCloudAccountWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilityByCloudAccountWidgetConfiguration"}, "VulnerabilityByProductWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilityByProductWidgetConfiguration"}, "VulnerabilityByRegionWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilityByRegionWidgetConfiguration"}, "VulnerabilityBySeverityAndKevWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilityBySeverityAndKevWidgetConfiguration"}, "VulnerabilityExplorerWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilityExplorerWidgetConfiguration"}, "VulnerabilityNvdDescription": {"properties": {"lang": {"type": "string", "description": "Language of the description"}, "value": {"type": "string", "description": "Value of the description"}}, "type": "object"}, "VulnerabilityReferenceIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["vulnerability_reference_ids"], "properties": {"vulnerability_reference_ids": {"type": "array", "description": "Vulnerability IDs to include", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}], "x-cs-type-name": "VulnerabilityReferenceIdQueryOperator"}, "VulnerabilityResponse": {"allOf": [{"$ref": "#/definitions/ThreatVulnerabilityBaseResponse"}, {"properties": {"vulnerability_id": {"type": "string", "description": "Unique identifier of the vulnerability.", "x-cs-type": "ObjectId"}, "vulnerability_reference_id": {"type": "string", "description": "Reference identifier to master vulnerability source.", "x-cs-type": "ObjectId"}}, "type": "object"}]}, "VulnerabilityTrendWidgetConfiguration": {"allOf": [{"$ref": "#/definitions/BaseChartWidgetConfigurationModel"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "VulnerabilityTrendWidgetConfiguration"}, "WellArchitectedAssessmentRunCreateMilestoneRequest": {"properties": {"name": {"type": "string", "description": "Name of the milestone to create."}}, "type": "object"}, "WellArchitectedFramework": {"properties": {"created_on": {"type": "string", "format": "date-time", "description": "Framework created on"}, "created_by": {"type": "string", "description": "Username who created the framework. null for Marketplace frameworks."}, "updated_on": {"type": "string", "format": "date-time", "description": "Framework updated on"}, "updated_by": {"type": "string", "description": "Username who updated the framework. null for Marketplace frameworks."}, "framework_id": {"type": "string", "description": "ID of Framework"}, "hyperscaler_framework_id": {"type": "string", "description": "ID of framework"}, "framework_type": {"type": "string", "description": "Type of the Framework", "example": "Custom", "enum": ["Custom", "Marketplace"], "x-cs-enum-type": "WellArchitectedFrameworkType"}, "account_id": {"type": "string", "description": "Master account id associated with the framework. null for Marketplace frameworks"}, "tenant_id": {"type": "string", "description": "Tenant associated with the framework. null for Marketplace frameworks"}, "name": {"type": "string", "description": "Name of the Framework"}, "description": {"type": "string", "description": "Description for Framework"}, "version": {"type": "string", "description": "Version of the Framework"}, "valid_service_types": {"type": "array", "description": "Valid Service Types", "items": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}}, "logo": {"type": "string", "description": "Logo of Framework"}, "status": {"type": "string", "description": "Framework status", "example": "Draft", "enum": ["Draft", "Active", "Inactive"], "x-cs-enum-type": "WellArchitectedFrameworkStatus"}, "pillars": {"type": "array", "description": "The Pillars in the Framework", "items": {"$ref": "#/definitions/WellArchitectedFrameworkPillar"}}, "sync_with_hyperscaler": {"$ref": "#/definitions/WellArchitectedFrameworkCustomLens"}, "handle_none_of_the_above": {"type": "string", "description": "Defines the framework's handling of the None of the above option, with permissible values: No or SeparateBP", "example": "No", "enum": ["No", "SeparateBP"], "x-cs-enum-type": "WellArchitectedFrameworkHandleNoneOfTheAbove"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentAwsSyncFields": {"properties": {"cloud_account_id": {"type": "string", "description": "ID of cloud account"}, "region": {"type": "string", "description": "Name of region"}, "partner_id": {"type": "string", "description": "AWS Partner Network(APN) reference ID"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentConfiguration": {"properties": {"workload_id": {"type": "string", "description": "ID of the Workload Definition to use for this assessment"}, "framework_ids": {"type": "array", "items": {"type": "string", "description": "IDs of the Frameworks to use for this assessment"}}, "sync_with_hyperscaler": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentSync"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentContext": {"properties": {"framework_id": {"type": "string", "description": "ID of the Framework. This can be retrieved using the Well Architected Framework List API."}, "pillar_id": {"type": "string", "description": "ID of the Pillar associated with the Framework"}, "question_id": {"type": "string", "description": "ID of the Question associated with the Pillar"}, "best_practice_id": {"type": "string", "description": "ID of the Bestpractice associated with the Question"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentDefinition": {"allOf": [{"$ref": "#/definitions/BaseDefinition"}, {"required": ["is_active", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant owning the assessment"}, "owner": {"type": "string", "description": "Owner of the assessment"}, "approver": {"type": "string", "description": "Approver of the assessment"}, "name": {"type": "string", "description": "Name of the assessment"}, "description": {"type": "string", "description": "Description of the assessment"}, "is_active": {"type": "boolean", "description": "States if the assessment is active or not"}, "notification_configuration": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentNotification"}}, "type": "object"}]}, "WellArchitectedFrameworkAssessmentDefinitionVersion": {"allOf": [{"$ref": "#/definitions/BaseDefinitionVersion"}, {"properties": {"details": {"description": "Details of the version", "$ref": "#/definitions/WellArchitectedFrameworkAssessmentConfiguration"}, "version_state": {"type": "string", "description": "State of the version", "example": "Draft", "enum": ["Draft", "Approved", "Rejected"], "x-cs-enum-type": "VersionState"}}, "type": "object"}]}, "WellArchitectedFrameworkAssessmentNotification": {"properties": {"email_recipients": {"type": "array", "items": {"type": "string", "description": "Mail IDs of the users for email notification"}}, "webhooks": {"type": "array", "description": "webhooks to trigger notifications", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentNotificationWebHook"}}}, "type": "object"}, "WellArchitectedFrameworkAssessmentNotificationWebHook": {"required": ["__type"], "properties": {"webhook_id": {"type": "string", "description": "Webhook ID to trigger notification"}}, "discriminator": "__type", "type": "object", "x-cs-type-name": "WellArchitectedFrameworkAssessmentNotificationWebHook", "x-cs-subtypes": [{"subtype_model": "WellArchitectedFrameworkAssessmentNotificationWebHookForMicrosoftTeams", "subtype_name": "WellArchitectedFrameworkAssessmentNotificationWebHookForMicrosoftTeams"}, {"subtype_model": "WellArchitectedFrameworkAssessmentNotificationWebHookForStandardType", "subtype_name": "WellArchitectedFrameworkAssessmentNotificationWebHookForStandardType"}]}, "WellArchitectedFrameworkAssessmentNotificationWebHookForMicrosoftTeams": {"allOf": [{"$ref": "#/definitions/WellArchitectedFrameworkAssessmentNotificationWebHook"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "WellArchitectedFrameworkAssessmentNotificationWebHookForMicrosoftTeams"}, "WellArchitectedFrameworkAssessmentNotificationWebHookForStandardType": {"allOf": [{"$ref": "#/definitions/WellArchitectedFrameworkAssessmentNotificationWebHook"}, {"properties": {}, "type": "object"}], "x-cs-type-name": "WellArchitectedFrameworkAssessmentNotificationWebHookForStandardType"}, "WellArchitectedFrameworkAssessmentRun": {"properties": {"sysId": {"type": "string", "description": "ID of the Assessment run"}, "createdOn": {"type": "string", "format": "date-time", "description": "Assessment run created on"}, "updatedOn": {"type": "string", "format": "date-time", "description": "Assessment run updated on"}, "status": {"type": "string", "description": "Status of the assessment run", "example": "InProgress", "enum": ["InProgress", "Abandoned", "Completed"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunStatus"}, "assessment_definition": {"description": "The Assessment this run is for", "$ref": "#/definitions/RecordIdentity"}, "assessment_version": {"description": "The version of the Assessment used for this run", "$ref": "#/definitions/RecordIdentity"}, "workload_version": {"description": "The version of the Workload used for this run", "$ref": "#/definitions/RecordIdentity"}, "hyperscaler_workload_id": {"type": "string", "description": "ARN of workload created when synced to AWS"}, "sync_failure_reason": {"type": "string", "description": "Sync failure reason"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunAnswer": {"properties": {"best_practice_id": {"type": "string", "description": "Identity of the Best Practice"}, "status": {"type": "string", "description": "Status of the question or best practice", "example": "Open", "enum": ["Open", "NotApplicable", "Unanswered", "Verified", "VerifiedWithException"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunAnswerStatus"}, "createdBy": {"type": "string", "description": "User ID of user who provided this answer"}, "createdOn": {"type": "string", "format": "date-time", "description": "When the answer was provided"}, "owner": {"type": "string", "description": "User ID of the owner of this answer"}, "assigned_to": {"type": "array", "description": "List of user IDs assigned to this answer", "items": {"type": "string"}}, "attachment_ids": {"type": "array", "description": "List of Attachment IDs assigned to this answer", "items": {"type": "string"}}, "comment_id": {"type": "string", "description": "Unique ID for this comment"}, "comment": {"type": "string", "description": "Comment added to this answer"}, "recommendation": {"type": "string", "description": "Markdown text of the recommendation if edited by the user"}, "sync_failure_reason": {"type": "string", "description": "Sync failure reason"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunAnswerRequest": {"properties": {"framework_id": {"type": "string", "description": "Identity of the Framework"}, "pillar_id": {"type": "string", "description": "Identity of the Pillar"}, "question_id": {"type": "string", "description": "Identity of the Question"}, "answer": {"description": "Answer to add to question", "$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunAnswer"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunCreateRequest": {"properties": {"assessment_version": {"description": "The version of the Assessment used for this run", "$ref": "#/definitions/RecordIdentity"}, "workload_version": {"description": "The version of the Workload used for this run", "$ref": "#/definitions/RecordIdentity"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunHistory": {"properties": {"sysId": {"type": "string", "description": "ID of the Assessment run history"}, "createdOn": {"type": "string", "format": "date-time", "description": "Assessment run created on"}, "updatedOn": {"type": "string", "format": "date-time", "description": "Assessment run updated on"}, "assessment_run": {"description": "The Assessment Run this history is for", "$ref": "#/definitions/RecordIdentity"}, "predecessor": {"description": "Previous history entry", "$ref": "#/definitions/RecordIdentity"}, "triggered_contexts": {"type": "array", "description": "Contexts that triggered the scan", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentContext"}}, "background_job": {"description": "Background job associated with a relevant scan. If null, background job has completed.", "$ref": "#/definitions/RecordIdentity"}, "milestone": {"type": "string", "description": "Name of the milestone (only present if this history entry represents a milestone)"}, "policy_scans": {"type": "array", "description": "Scans associated with this history step", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunPolicyScan"}}, "hyperscaler_milestone_number": {"type": "integer", "description": "Milestone number "}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunHistoryRequest": {"properties": {"assessment_run_ids": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunPolicyScan": {"properties": {"context": {"description": "Context for the policy execution.", "$ref": "#/definitions/WellArchitectedFrameworkAssessmentContext"}, "cloud_account_id": {"type": "string", "description": "ID of the cloud account for this policy Job execution"}, "policy_uri": {"type": "string", "description": "External Identity of the Policy"}, "policy_job_id": {"type": "string", "description": "Identity of the Policy Job"}, "status": {"type": "string", "description": "Status of the policy scan", "example": "Queued", "enum": ["Queued", "InProgress", "Success", "Failed"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunPolicyScanStatus"}, "failure": {"type": "string", "description": "Reason for failure of the policy scan"}, "started": {"type": "string", "format": "date-time"}, "completed": {"type": "string", "format": "date-time"}, "evaluated_resource_count": {"type": "integer"}, "violated_resource_count": {"type": "integer"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunQuestion": {"properties": {"sysId": {"type": "string", "description": "ID of the Assessment run question"}, "createdOn": {"type": "string", "format": "date-time", "description": "Assessment run question created on"}, "updatedOn": {"type": "string", "format": "date-time", "description": "Assessment run question created on"}, "assessment_run_history": {"description": "The entry in the Assessment Run History this question is for", "$ref": "#/definitions/RecordIdentity"}, "framework_id": {"type": "string", "description": "Identity of the Framework"}, "pillar_id": {"type": "string", "description": "Identity of the Pillar"}, "question_id": {"type": "string", "description": "Identity of the Question"}, "answers": {"type": "array", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentRunAnswer"}}, "sync_failure_reason": {"type": "string", "description": "Sync failure reason"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunQuestionRequest": {"properties": {"assessment_run_history_ids": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunRequest": {"properties": {"assessment_definition_ids": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunSetStateRequest": {"properties": {"status": {"type": "string", "description": "Status of the assessment run", "example": "InProgress", "enum": ["InProgress", "Abandoned", "Completed"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunStatus"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunTTLRefreshRequest": {"properties": {"service_account_id": {"type": "string", "description": "Service account ID to perform TTL refresh", "x-cs-type": "ObjectId"}, "policy_uris": {"type": "array", "items": {"type": "string", "description": "Policy uri to perform TTL refresh"}}}, "type": "object"}, "WellArchitectedFrameworkAssessmentRunViolationRequest": {"properties": {"policy_job_id": {"type": "string", "description": "Identity of the Policy Job"}}, "type": "object"}, "WellArchitectedFrameworkAssessmentSync": {"properties": {"AWS": {"$ref": "#/definitions/WellArchitectedFrameworkAssessmentAwsSyncFields"}}, "type": "object"}, "WellArchitectedFrameworkAwsCustomLens": {"properties": {"schema_version": {"type": "string", "description": "Schema version of AWS custom lens"}, "name": {"type": "string", "description": "Name of AWS custom lens"}, "description": {"type": "string", "description": "Description of AWS custom lens"}, "pillars": {"type": "array", "description": "Pillars associated with AWS custom lens", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAwsCustomLensPillar"}}}, "type": "object"}, "WellArchitectedFrameworkAwsCustomLensChoice": {"properties": {"sys_id": {"type": "string", "description": "Id of choice of AWS custom lens"}, "title": {"type": "string", "description": "Title of choice of AWS custom lens"}, "helpful_resource": {"description": "Helpful resources associated with AWS custom lens", "$ref": "#/definitions/WellArchitectedFrameworkAwsCustomLensRecommendation"}, "improvement_plan": {"description": "Improvement plans associated with AWS custom lens", "$ref": "#/definitions/WellArchitectedFrameworkAwsCustomLensRecommendation"}}, "type": "object"}, "WellArchitectedFrameworkAwsCustomLensPillar": {"properties": {"sys_id": {"type": "string", "description": "Id of pillar associated with AWS custom lens"}, "name": {"type": "string", "description": "Name of pillar associated with AWS custom lens"}, "questions": {"type": "array", "description": "Questions associated with AWS custom lens", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAwsCustomLensQuestion"}}}, "type": "object"}, "WellArchitectedFrameworkAwsCustomLensQuestion": {"properties": {"sys_id": {"type": "string", "description": "Id of question associated with AWS custom lens"}, "title": {"type": "string", "description": "Title of question associated with AWS custom lens"}, "description": {"type": "string", "description": "Description of question associated with AWS custom lens"}, "choices": {"type": "array", "description": "Choices associated with AWS custom lens", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAwsCustomLensChoice"}}, "risk_rules": {"type": "array", "description": "Risk rule associated with AWS custom lens", "items": {"$ref": "#/definitions/WellArchitectedFrameworkAwsCustomLensRiskRule"}}}, "type": "object"}, "WellArchitectedFrameworkAwsCustomLensRecommendation": {"properties": {"displaytext": {"type": "string", "description": "Well Architected recommendation/description"}, "url": {"type": "string", "description": "Well Architected recommendation/description url"}}, "type": "object"}, "WellArchitectedFrameworkAwsCustomLensRiskRule": {"properties": {"condition": {"type": "string", "description": "Risk rule condition for CustomLens Question"}, "risk": {"type": "string", "description": "Risk for CustomLens Question", "example": "NO_RISK", "enum": ["NO_RISK", "MEDIUM_RISK", "HIGH_RISK"], "x-cs-enum-type": "WellArchitectedFrameworkAwsCustomLensQuestionRisk"}}, "type": "object"}, "WellArchitectedFrameworkBestPractice": {"properties": {"framework_id": {"type": "string", "description": "ID of the framework associated with the best practice"}, "pillar_id": {"type": "string", "description": "ID of the pillar associated with the best practice"}, "question_id": {"type": "string", "description": "ID for the question associated with the best practice"}, "best_practice_id": {"type": "string", "description": "ID for the best practice"}, "hyperscaler_best_practice_id": {"type": "string", "description": "ID of best practice"}, "best_practice": {"type": "string", "description": "Best practice at question level"}, "description": {"type": "string", "description": "Statement of the best practice"}, "recommendation": {"type": "string", "description": "Statement of the best practice"}, "nature": {"type": "string", "description": "Nature of the best practice", "example": "Automated", "enum": ["Automated", "Manual"], "x-cs-enum-type": "WellArchitectedFrameworkBestPracticeNature"}, "risk": {"type": "string", "description": "Risk of the best practice", "example": "Low", "enum": ["Low", "Medium", "High", "None"], "x-cs-enum-type": "WellArchitectedFrameworkRisk"}, "policy_uris": {"type": "array", "description": "URIs of the Policies associated with this best practice", "items": {"type": "string"}}, "is_automatable": {"type": "boolean", "description": "Flag to indicate whether the best practice is automatable"}, "is_none_of_the_above": {"type": "boolean", "description": "Flag to indicate whether the best practice is None of the above"}}, "type": "object"}, "WellArchitectedFrameworkBestPracticeRequest": {"properties": {"best_practices": {"type": "array", "description": "Best Practices to process", "items": {"$ref": "#/definitions/WellArchitectedFrameworkBestPractice"}}}, "type": "object"}, "WellArchitectedFrameworkCustomLens": {"required": ["__type"], "properties": {}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "WellArchitectedFrameworkCustomLensForAws", "subtype_name": "WellArchitectedFrameworkCustomLensForAws"}]}, "WellArchitectedFrameworkCustomLensForAws": {"allOf": [{"$ref": "#/definitions/WellArchitectedFrameworkCustomLens"}, {"properties": {"sync_enabled": {"type": "boolean", "description": "States if sync is enabled or not"}, "cloud_account_id": {"type": "string", "description": "Cloud account id", "x-cs-type": "ObjectId"}, "region": {"type": "string", "description": "Name of region"}, "from_aws": {"type": "boolean", "description": "States if sync is from aws"}, "to_aws": {"type": "boolean", "description": "States if sync is to aws"}, "sync_failure_reason": {"type": "string", "description": "Sync failure reason"}, "lens_name": {"type": "string", "description": "Synced Custom lens name"}, "last_sync": {"type": "string", "format": "date-time", "description": "Last sync time"}}, "type": "object"}], "x-cs-type-name": "WellArchitectedFrameworkCustomLensForAws"}, "WellArchitectedFrameworkPillar": {"properties": {"framework_id": {"type": "string", "description": "Framework id for the Pillar"}, "pillar_id": {"type": "string", "description": "Unique Id of the Pillar"}, "hyperscaler_pillar_id": {"type": "string", "description": "Unique Id of pillar"}, "pillar": {"type": "string", "description": "Name of Pillar for the Framework"}, "description": {"type": "string", "description": "Description of the Pillar"}, "icon": {"type": "string", "description": "Icon for the pillar"}, "questions": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}, "type": "object"}, "WellArchitectedFrameworkPillarRequest": {"properties": {"pillars": {"type": "array", "description": "Pillars to process", "items": {"$ref": "#/definitions/WellArchitectedFrameworkPillar"}}}, "type": "object"}, "WellArchitectedFrameworkQuestion": {"properties": {"created_on": {"type": "string", "format": "date-time", "description": "Well Architected Question created on"}, "updated_on": {"type": "string", "format": "date-time", "description": "Well Architected Question updated on"}, "framework_id": {"type": "string", "description": "ID of the framework associated with the question"}, "pillar_id": {"type": "string", "description": "ID of the pillar associated with the question"}, "question_id": {"type": "string", "description": "ID for the particular question"}, "hyperscaler_question_id": {"type": "string", "description": "Id of question"}, "question": {"type": "string", "description": "Question"}, "description": {"type": "string", "description": "Description for the question"}, "best_practices": {"type": "array", "items": {"$ref": "#/definitions/RecordIdentity"}}}, "type": "object"}, "WellArchitectedFrameworkQuestionRequest": {"properties": {"questions": {"type": "array", "description": "Questions to process", "items": {"$ref": "#/definitions/WellArchitectedFrameworkQuestion"}}}, "type": "object"}, "WellArchitectedFrameworkReport": {"properties": {"sys_id": {"type": "string", "description": "Unique ID for the report"}, "user_id": {"type": "string", "description": "ID of the user who requested the report"}, "report_configuration": {"description": "Report configuration to generate report", "$ref": "#/definitions/ReportConfigurationForAssessmentRun"}, "schedule_id": {"type": "string", "description": "Schedule ID of which the report to be generated", "x-cs-type": "ObjectId"}, "email_recipients": {"type": "array", "items": {"type": "string", "description": "List of Email IDs for which the scheduled report will be sent."}}, "background_job": {"description": "Identity of the background job used to generate the report. null if the job has completed", "$ref": "#/definitions/RecordIdentity"}, "attachment_id": {"type": "string", "description": "ID of the attachment where the report contents are stored. This will be null until the report has been successfully generated"}, "failure_message": {"type": "string", "description": "Reason for report generation failure"}, "status": {"type": "string", "description": "Status of the report generation", "example": "InProgress", "enum": ["InProgress", "Completed", "Failed"], "x-cs-enum-type": "AssessmentRunReportStatus"}, "triggered_at": {"type": "string", "format": "date-time", "description": "TimeStamp when assessment run report generation was triggered"}, "completed_at": {"type": "string", "format": "date-time", "description": "TimeStamp when assessment run report generation was completed"}}, "type": "object"}, "WellArchitectedFrameworkReportCreateRequest": {"properties": {"report_configuration": {"description": "Report configuration to generate report", "$ref": "#/definitions/ReportConfigurationForAssessmentRun"}}, "type": "object"}, "WellArchitectedFrameworkReportListFilter": {"required": ["tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant ID", "x-cs-type": "ObjectId"}, "time_delta_in_days": {"type": "integer", "description": "Time delta to filter reports created in the last N days"}, "filters": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "WellArchitectedFrameworkReportListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/WellArchitectedFrameworkReportListFilter"}}, "type": "object"}, "WellArchitectedFrameworkReportListResponse": {"properties": {"results": {"type": "array", "description": "List of result identifiers", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "next_list_context": {"description": "List context", "$ref": "#/definitions/ListContext"}}, "type": "object"}, "WellArchitectedFrameworkReportScheduleRequest": {"required": ["assessment_id", "framework_id", "report_type", "schedule_id", "user_id"], "properties": {"assessment_id": {"description": "The Assessment this report is for", "$ref": "#/definitions/RecordIdentity"}, "framework_id": {"type": "string", "description": "Identity of the Framework"}, "report_type": {"type": "string", "description": "Report type for assessment run", "example": "AssessmentRunDetail", "enum": ["AssessmentRunDetail", "AssessmentRunSummary", "AssessmentRunViolation"], "x-cs-enum-type": "WellArchitectedFrameworkAssessmentRunReportType"}, "user_id": {"type": "string", "description": "User ID of user who scheduled the report"}, "schedule_id": {"type": "string", "description": "Schedule ID of which the report to be generated", "x-cs-type": "ObjectId"}, "email_recipients": {"type": "array", "items": {"type": "string", "description": "List of Email IDs for which the scheduled report will be sent."}}, "filters": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "WidgetComposition": {"properties": {"config": {"$ref": "#/definitions/WidgetConfiguration"}, "outline": {"$ref": "#/definitions/WidgetOutline"}}, "type": "object"}, "WidgetConfiguration": {"required": ["__type", "id"], "properties": {"id": {"type": "string"}, "size": {"type": "integer"}, "name": {"type": "string"}, "description": {"type": "string"}, "refreshRateInSeconds": {"type": "integer"}, "manualFontScaling": {"type": "boolean"}, "fontMultiplier": {"type": "number"}, "toolbarBehavior": {"type": "string", "description": "Behavior of the widget toolbar", "example": "AlwaysShow", "enum": ["AlwaysShow", "AutoHide", "Collapsible", "Hide"], "x-cs-enum-type": "WidgetToolbarBehavior"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "GroupingWidgetConfiguration", "subtype_name": "GroupingWidgetConfiguration"}, {"subtype_model": "TabWidgetConfiguration", "subtype_name": "TabWidgetConfiguration"}, {"subtype_model": "ImageWidgetConfiguration", "subtype_name": "ImageWidgetConfiguration"}, {"subtype_model": "TextWidgetConfiguration", "subtype_name": "TextWidgetConfiguration"}, {"subtype_model": "BaseDataWidgetConfigurationModel", "subtype_name": "BaseDataWidgetConfigurationModel"}, {"subtype_model": "BaseProducerDataWidgetConfigurationModel", "subtype_name": "BaseProducerDataWidgetConfigurationModel"}, {"subtype_model": "BaseChartWidgetConfigurationModel", "subtype_name": "BaseChartWidgetConfigurationModel"}, {"subtype_model": "BaseGroupByDataWidgetConfigurationModel", "subtype_name": "BaseGroupByDataWidgetConfigurationModel"}, {"subtype_model": "BaseCostTrendWidgetConfigurationModel", "subtype_name": "BaseCostTrendWidgetConfigurationModel"}, {"subtype_model": "FilterWidgetConfiguration", "subtype_name": "FilterWidgetConfiguration"}, {"subtype_model": "FilterContextWidgetConfigurationModel", "subtype_name": "FilterContextWidgetConfigurationModel"}, {"subtype_model": "CloudForecasterForSixMonthsWidgetConfiguration", "subtype_name": "CloudForecasterForSixMonthsWidgetConfiguration"}, {"subtype_model": "CostSpendByCloudWidgetConfiguration", "subtype_name": "CostSpendByCloudWidgetConfiguration"}, {"subtype_model": "CostSpendByCloudAccountWidgetConfiguration", "subtype_name": "CostSpendByCloudAccountWidgetConfiguration"}, {"subtype_model": "CostSpendByCloudResourceWidgetConfiguration", "subtype_name": "CostSpendByCloudResourceWidgetConfiguration"}, {"subtype_model": "CostSpendByCloudTenantWidgetConfiguration", "subtype_name": "CostSpendByCloudTenantWidgetConfiguration"}, {"subtype_model": "CostSpendByRegionWidgetConfiguration", "subtype_name": "CostSpendByRegionWidgetConfiguration"}, {"subtype_model": "CostTrendByCloudWidgetConfiguration", "subtype_name": "CostTrendByCloudWidgetConfiguration"}, {"subtype_model": "CostTrendByDimensionGroupWidgetConfiguration", "subtype_name": "CostTrendByDimensionGroupWidgetConfiguration"}, {"subtype_model": "CostTrendWidgetConfiguration", "subtype_name": "CostTrendWidgetConfiguration"}, {"subtype_model": "CostTrendForecastWidgetConfiguration", "subtype_name": "CostTrendForecastWidgetConfiguration"}, {"subtype_model": "DimensionBudgetWidgetConfiguration", "subtype_name": "DimensionBudgetWidgetConfiguration"}, {"subtype_model": "BudgetCostTrendWidgetConfiguration", "subtype_name": "BudgetCostTrendWidgetConfiguration"}, {"subtype_model": "KubernetesCostTrendWidgetConfiguration", "subtype_name": "KubernetesCostTrendWidgetConfiguration"}, {"subtype_model": "KubernetesCostTrendForecastWidgetConfiguration", "subtype_name": "KubernetesCostTrendForecastWidgetConfiguration"}, {"subtype_model": "ChargeDescriptionWidgetConfiguration", "subtype_name": "ChargeDescriptionWidgetConfiguration"}, {"subtype_model": "AiAgentChartConfiguration", "subtype_name": "AiAgentChartConfiguration"}, {"subtype_model": "AiAgentDataTableConfiguration", "subtype_name": "AiAgentDataTableConfiguration"}, {"subtype_model": "AiAgenticInsightsConfiguration", "subtype_name": "AiAgenticInsightsConfiguration"}, {"subtype_model": "CostForAzureMaccCommitmentConfiguration", "subtype_name": "CostForAzureMaccCommitmentConfiguration"}, {"subtype_model": "CostAzureMaccCommitmentBurndownConfiguration", "subtype_name": "CostAzureMaccCommitmentBurndownConfiguration"}, {"subtype_model": "CostAwsEdpConfiguration", "subtype_name": "CostAwsEdpConfiguration"}, {"subtype_model": "CostVariationWidgetConfiguration", "subtype_name": "CostVariationWidgetConfiguration"}, {"subtype_model": "CostAnomalyByCloudWidgetConfiguration", "subtype_name": "CostAnomalyByCloudWidgetConfiguration"}, {"subtype_model": "CostSummaryWidgetConfigurationModel", "subtype_name": "CostSummaryWidgetConfigurationModel"}, {"subtype_model": "KubernetesCostSummaryWidgetConfigurationModel", "subtype_name": "KubernetesCostSummaryWidgetConfigurationModel"}, {"subtype_model": "ResourceByProductCategoryWidgetConfiguration", "subtype_name": "ResourceByProductCategoryWidgetConfiguration"}, {"subtype_model": "TopBudgetByTenantWidgetConfiguration", "subtype_name": "TopBudgetByTenantWidgetConfiguration"}, {"subtype_model": "TopResourcesWidgetConfiguration", "subtype_name": "TopResourcesWidgetConfiguration"}, {"subtype_model": "TopPodWidgetConfiguration", "subtype_name": "TopPodWidgetConfiguration"}, {"subtype_model": "BudgetDriftWidgetConfiguration", "subtype_name": "BudgetDriftWidgetConfiguration"}, {"subtype_model": "TopCostOptimizationWidgetConfiguration", "subtype_name": "TopCostOptimizationWidgetConfiguration"}, {"subtype_model": "CostOptimizationByOptimizationTypeWidgetConfiguration", "subtype_name": "CostOptimizationByOptimizationTypeWidgetConfiguration"}, {"subtype_model": "CostOptimizationTrendWidgetConfiguration", "subtype_name": "CostOptimizationTrendWidgetConfiguration"}, {"subtype_model": "BaseDimensionWidgetConfiguration", "subtype_name": "BaseDimensionWidgetConfiguration"}, {"subtype_model": "CostSpendByDimensionWidgetConfiguration", "subtype_name": "CostSpendByDimensionWidgetConfiguration"}, {"subtype_model": "KubernetesCostSpendByDimensionWidgetConfiguration", "subtype_name": "KubernetesCostSpendByDimensionWidgetConfiguration"}, {"subtype_model": "CostVariationByDimensionWidgetConfiguration", "subtype_name": "CostVariationByDimensionWidgetConfiguration"}, {"subtype_model": "CostSpendByHierarchyWidgetConfiguration", "subtype_name": "CostSpendByHierarchyWidgetConfiguration"}, {"subtype_model": "CostSpendByTagLevelWidgetConfiguration", "subtype_name": "CostSpendByTagLevelWidgetConfiguration"}, {"subtype_model": "CostAnomalyImpactByBillingWidgetConfiguration", "subtype_name": "CostAnomalyImpactByBillingWidgetConfiguration"}, {"subtype_model": "CostAnomalyImpactByCloudAccountWidgetConfiguration", "subtype_name": "CostAnomalyImpactByCloudAccountWidgetConfiguration"}, {"subtype_model": "CostAnomalyImpactByEventWidgetConfiguration", "subtype_name": "CostAnomalyImpactByEventWidgetConfiguration"}, {"subtype_model": "CostAnomalyImpactTrendWidgetConfiguration", "subtype_name": "CostAnomalyImpactTrendWidgetConfiguration"}, {"subtype_model": "CostAnomalySpendTrendWidgetConfiguration", "subtype_name": "CostAnomalySpendTrendWidgetConfiguration"}, {"subtype_model": "CostAnomalySpendTrendByResourceIdWidgetConfiguration", "subtype_name": "CostAnomalySpendTrendByResourceIdWidgetConfiguration"}, {"subtype_model": "CostImpactByDimensionGroupWidgetConfiguration", "subtype_name": "CostImpactByDimensionGroupWidgetConfiguration"}, {"subtype_model": "CostImpactByCategoryWidgetConfiguration", "subtype_name": "CostImpactByCategoryWidgetConfiguration"}, {"subtype_model": "CostTrendByResourceCategoryWidgetConfiguration", "subtype_name": "CostTrendByResourceCategoryWidgetConfiguration"}, {"subtype_model": "VulnerabilityByCloudAccountWidgetConfiguration", "subtype_name": "VulnerabilityByCloudAccountWidgetConfiguration"}, {"subtype_model": "VulnerabilityByRegionWidgetConfiguration", "subtype_name": "VulnerabilityByRegionWidgetConfiguration"}, {"subtype_model": "VulnerabilityTrendWidgetConfiguration", "subtype_name": "VulnerabilityTrendWidgetConfiguration"}, {"subtype_model": "TagLevelTrendWidgetConfiguration", "subtype_name": "TagLevelTrendWidgetConfiguration"}, {"subtype_model": "ThreatsTrendWidgetConfiguration", "subtype_name": "ThreatsTrendWidgetConfiguration"}, {"subtype_model": "ThreatsConcentrationByProviderWidgetConfiguration", "subtype_name": "ThreatsConcentrationByProviderWidgetConfiguration"}, {"subtype_model": "ThreatsByCloudAccountWidgetConfiguration", "subtype_name": "ThreatsByCloudAccountWidgetConfiguration"}, {"subtype_model": "ThreatsByRegionWidgetConfiguration", "subtype_name": "ThreatsByRegionWidgetConfiguration"}, {"subtype_model": "MisconfigurationViolationsTrendWidgetConfiguration", "subtype_name": "MisconfigurationViolationsTrendWidgetConfiguration"}, {"subtype_model": "MisconfigurationViolationsByCloudAccountWidgetConfiguration", "subtype_name": "MisconfigurationViolationsByCloudAccountWidgetConfiguration"}, {"subtype_model": "MisconfigurationViolationsByRegionWidgetConfiguration", "subtype_name": "MisconfigurationViolationsByRegionWidgetConfiguration"}, {"subtype_model": "MisconfigurationViolationsByCloudProviderWidgetConfiguration", "subtype_name": "MisconfigurationViolationsByCloudProviderWidgetConfiguration"}, {"subtype_model": "ControlViolationsWithHighRiskLevelWidgetConfiguration", "subtype_name": "ControlViolationsWithHighRiskLevelWidgetConfiguration"}, {"subtype_model": "ControlViolationsWithStandardCoverageWidgetConfiguration", "subtype_name": "ControlViolationsWithStandardCoverageWidgetConfiguration"}, {"subtype_model": "ControlHealthWidgetConfiguration", "subtype_name": "ControlHealthWidgetConfiguration"}, {"subtype_model": "AccessViolationsTrendWidgetConfiguration", "subtype_name": "AccessViolationsTrendWidgetConfiguration"}, {"subtype_model": "AccessViolationsByCloudAccountWidgetConfiguration", "subtype_name": "AccessViolationsByCloudAccountWidgetConfiguration"}, {"subtype_model": "CloudAccountComplianceSummaryWidgetConfiguration", "subtype_name": "CloudAccountComplianceSummaryWidgetConfiguration"}, {"subtype_model": "TenantComplianceSummaryWidgetConfiguration", "subtype_name": "TenantComplianceSummaryWidgetConfiguration"}, {"subtype_model": "TenantComplianceTrendWidgetConfiguration", "subtype_name": "TenantComplianceTrendWidgetConfiguration"}, {"subtype_model": "AppInsightsActionableRecommendationsWidgetConfiguration", "subtype_name": "AppInsightsActionableRecommendationsWidgetConfiguration"}, {"subtype_model": "VulnerabilityByAgeWidgetConfiguration", "subtype_name": "VulnerabilityByAgeWidgetConfiguration"}, {"subtype_model": "VulnerabilityByProductWidgetConfiguration", "subtype_name": "VulnerabilityByProductWidgetConfiguration"}, {"subtype_model": "VulnerabilityBySeverityAndKevWidgetConfiguration", "subtype_name": "VulnerabilityBySeverityAndKevWidgetConfiguration"}, {"subtype_model": "OpenVulnerabilitiesBySeverityWidgetConfiguration", "subtype_name": "OpenVulnerabilitiesBySeverityWidgetConfiguration"}, {"subtype_model": "VulnerabilitiesOverBuildWidgetConfiguration", "subtype_name": "VulnerabilitiesOverBuildWidgetConfiguration"}, {"subtype_model": "VulnerabilityExplorerWidgetConfiguration", "subtype_name": "VulnerabilityExplorerWidgetConfiguration"}, {"subtype_model": "ThreatExplorerWidgetConfiguration", "subtype_name": "ThreatExplorerWidgetConfiguration"}, {"subtype_model": "AppSecOpsVulnerabilityByRegionWidgetConfiguration", "subtype_name": "AppSecOpsVulnerabilityByRegionWidgetConfiguration"}, {"subtype_model": "MisconfigurationExplorerWidgetConfiguration", "subtype_name": "MisconfigurationExplorerWidgetConfiguration"}, {"subtype_model": "VulnerabilitiesBySeverityByAccountWidgetConfiguration", "subtype_name": "VulnerabilitiesBySeverityByAccountWidgetConfiguration"}, {"subtype_model": "InfrastructureResourcesInventoryOverviewWidgetConfiguration", "subtype_name": "InfrastructureResourcesInventoryOverviewWidgetConfiguration"}, {"subtype_model": "OpenInfrastructureVulnerabilitiesByTrendWidgetConfiguration", "subtype_name": "OpenInfrastructureVulnerabilitiesByTrendWidgetConfiguration"}, {"subtype_model": "InfrastructureResourcesByResourceCategoryWidgetConfiguration", "subtype_name": "InfrastructureResourcesByResourceCategoryWidgetConfiguration"}, {"subtype_model": "InfrastructureResourcesIssuesFlowWidgetConfiguration", "subtype_name": "InfrastructureResourcesIssuesFlowWidgetConfiguration"}]}, "WidgetNavigationDescriptor": {"properties": {"context": {"type": "string", "description": "Context of the navigation if the Widget supports more than one (e.g. columns)"}, "portal_path": {"type": "array", "description": "Path of the portal to navigate to", "items": {"type": "string"}}}, "type": "object"}, "WidgetOutline": {"properties": {"left": {"type": "integer"}, "top": {"type": "integer"}, "width": {"type": "integer"}, "height": {"type": "integer"}}, "type": "object"}, "WidgetTab": {"properties": {"label": {"type": "string"}, "widget": {"$ref": "#/definitions/WidgetComposition"}}, "type": "object"}, "WidgetViewState": {"required": ["__type"], "properties": {"id": {"type": "string"}}, "discriminator": "__type", "type": "object", "x-cs-subtypes": [{"subtype_model": "FilterWidgetViewState", "subtype_name": "FilterWidgetViewState"}, {"subtype_model": "ChartWidgetViewState", "subtype_name": "ChartWidgetViewState"}]}, "WorkFlowActionDetails": {"properties": {"action_source": {"type": "string", "description": "Source of the Action to be taken.", "example": "ITSM", "enum": ["ITSM"], "x-cs-enum-type": "WorkFlowSource"}, "action_type": {"type": "string", "description": "Type of the Action based on source selected.", "example": "Task", "enum": ["Task"], "x-cs-enum-type": "WorkFlowActionsType"}, "approval_required": {"type": "boolean", "description": "Key represents whether the approval is required or not.", "default": true}, "applicable_service_account": {"type": "string", "description": "Identifier of the tool account."}}, "type": "object"}, "WorkFlowBatchResponse": {"properties": {"results": {"type": "object", "description": "Map from identifier to response model", "additionalProperties": {"$ref": "#/definitions/WorkFlowDefinitionsBase"}}}, "type": "object"}, "WorkFlowDefinitionDetails": {"allOf": [{"$ref": "#/definitions/MinimizedWorkFlowForBaseVersion"}, {"properties": {"filters": {"description": "Query based on Resource Group, Region, resource_id, resource_name and resource", "$ref": "#/definitions/QueryOperator"}, "actions": {"type": "array", "items": {"$ref": "#/definitions/WorkFlowActionDetails"}}, "rules": {"type": "array", "items": {"$ref": "#/definitions/WorkFlowPersistedRule"}}, "notifications": {"type": "array", "items": {"$ref": "#/definitions/WorkFlowNotifications"}}}, "type": "object"}]}, "WorkFlowDefinitionFilter": {"properties": {"name": {"type": "string", "description": "Regular expression to match against the name"}, "module": {"type": "string", "description": "Module for which the workflow which has to be generated.", "example": "FINOPS", "enum": ["FINOPS"], "x-cs-enum-type": "WorkFlowModules"}, "category": {"type": "string", "description": "SubCategory for which the workflow which has to be generated.", "example": "recommendation", "enum": ["recommendation", "cost_anomaly"], "x-cs-enum-type": "WorkFlowCategory"}, "tenant_ids": {"type": "array", "description": "Only include accounts from these Tenants.", "items": {"type": "string", "x-cs-type": "ObjectId"}}, "owner": {"type": "string", "description": "User id for which the workflows needs to be listed."}, "search": {"type": "string", "description": "Search term to be matched against the workflow name and description."}}, "type": "object"}, "WorkFlowDefinitionsBase": {"properties": {"name": {"type": "string", "description": "Name for the workflow."}, "module": {"type": "string", "description": "Module for which the workflow which has to be generated.", "example": "FINOPS", "enum": ["FINOPS"], "x-cs-enum-type": "WorkFlowModules"}, "is_active": {"type": "boolean", "description": "Boolean represents whether the workflow is active or not", "default": true}, "tenant_id": {"type": "string", "description": "Sys Id of the master account where the workflow belongs to", "x-cs-type": "ObjectId"}, "category": {"type": "string", "description": "SubCategory for which the workflow which has to be generated.", "example": "recommendation", "enum": ["recommendation", "cost_anomaly"], "x-cs-enum-type": "WorkFlowCategory"}, "workflow_id": {"type": "string", "description": "Unique Sys Id for a workflow"}, "created_on": {"type": "string", "format": "date-time", "description": "Created time for the workflow."}, "updated_on": {"type": "string", "format": "date-time", "description": "Last Updated time for the workflow."}, "created_by": {"type": "string", "description": "User who created the workflow"}, "updated_by": {"type": "string", "description": "User who last updated the workflow"}}, "type": "object"}, "WorkFlowEventHistory": {"properties": {"event_name": {"type": "string", "description": "Step wise status of the workflow.", "example": "Data Generated", "enum": ["Data Generated", "Waiting For Approval", "Approval Process Completed", "Approval Process Failed", "Rejection Process Completed", "Rejection Process Failed", "WorkFlow Completed", "Resource Realized"], "x-cs-enum-type": "WorkFlowLifeCycleStatus"}, "performed_at": {"type": "string", "format": "date-time", "description": "The time at which the event has occur"}, "event_status": {"type": "string", "description": "The status of the event which has been performed while doing automation workflow."}, "failure_reason": {"type": "string", "description": "Failure Reason if any available for the step."}}, "type": "object"}, "WorkFlowIdQueryOperator": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["workflow_ids"], "properties": {"workflow_ids": {"type": "array", "description": "Id of the workflow", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "WorkFlowIdQueryOperator"}, "WorkFlowImpacts": {"required": ["workflow_id"], "properties": {"workflow_id": {"type": "string", "description": "Work Flow Id"}, "workflow_status": {"type": "string", "description": "over all status of the workflow.", "example": "Approved", "enum": ["Approved", "Auto Approved", "Pending Approval", "Rejected"], "x-cs-enum-type": "WorkFlowImpactStatus"}, "rejection_reason": {"type": "string", "description": "Reason for the rejection for the recommendation."}, "rejection_duration_days": {"type": "integer", "description": "Number of days the customer rejects the recommendation"}, "history_events": {"type": "array", "items": {"$ref": "#/definitions/WorkFlowEventHistory"}}}, "type": "object"}, "WorkFlowNotifications": {"properties": {"notification_type": {"type": "string", "description": "Type of the notifications.", "example": "email", "enum": ["email"], "x-cs-enum-type": "WorkFlowNotificationsType"}, "values": {"type": "array", "description": "Value for the notifications.", "items": {"type": "string"}}}, "type": "object"}, "WorkFlowPersistedRule": {"properties": {"rule_id": {"type": "string", "description": "master rule sys id"}, "default_inputs": {"type": "array", "description": "input parameters the user wants to override", "items": {"type": "string"}}}, "type": "object"}, "WorkFlowReconcillationScopes": {"properties": {"generated_at": {"type": "string", "format": "date-time", "description": "Date Filter for the impacted resources."}, "status": {"type": "string", "description": "Status of the policy resource recommendation", "example": "error", "enum": ["error", "in_progress", "open", "resolved", "skipped", "system_skipped"], "x-cs-enum-type": "PolicyResourceRecommendationStatus"}, "sys_ids": {"type": "array", "description": "Only include these sys Ids.", "items": {"type": "string"}}, "service_account_id": {"type": "string", "description": "Service account id", "x-cs-type": "ObjectId"}, "workflow_ids": {"type": "array", "description": "Workflow ids for which the rules are required", "items": {"type": "string"}}}, "type": "object"}, "WorkFlowRuleBase": {"properties": {"name": {"type": "string", "description": "name of the rule which are scanned against the workflow impacted resources."}, "description": {"type": "string", "description": "description of the rule which are scanned against the workflow impacted resources."}, "inputs": {"type": "array", "description": "The input with which the rules are getting scanned.", "items": {"type": "string"}}, "rule_category": {"type": "string", "description": "SubCategory for which the workflow which has to be generated.", "example": "recommendation", "enum": ["recommendation", "cost_anomaly"], "x-cs-enum-type": "WorkFlowCategory"}, "reference_id": {"type": "string", "description": "reference id for the rule which will be used in engine"}, "sys_id": {"type": "string", "description": "Identity of the rule which are scanned against the workflow impacted resources."}}, "type": "object"}, "WorkFlowRuleDetailBase": {"allOf": [{"$ref": "#/definitions/WorkFlowRuleBase"}, {"properties": {"is_rule_override": {"type": "boolean", "description": "Boolean to check whether the input has been override in the workflow"}, "values": {"type": "array", "description": "inputs with which the rules are getting scanned.", "items": {"type": "string"}}}, "type": "object"}]}, "WorkFlowRuleList": {"properties": {"rules": {"type": "array", "description": "The list of workflow rules.", "items": {"$ref": "#/definitions/WorkFlowRuleDetailBase"}}}, "type": "object"}, "WorkFlowRuleListRequest": {"properties": {"category": {"type": "string", "description": "SubCategory for which the workflow which has to be generated.", "example": "recommendation", "enum": ["recommendation", "cost_anomaly"], "x-cs-enum-type": "WorkFlowCategory"}, "tenant_id": {"type": "string", "description": "Sys Id of the tenant account where the workflow belongs to"}, "workflow_sys_id": {"type": "string", "description": "workflow sys id for which the rules are required"}}, "type": "object"}, "WorkFlowsListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/WorkFlowsSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/WorkFlowDefinitionFilter"}}, "type": "object"}, "WorkFlowsSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "createdOn"], "x-cs-enum-type": "WorkFlowsSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "WorkSpaceReportModel": {"required": ["data"], "properties": {"data": {"type": "object", "description": "Returned Workspace"}}, "type": "object"}, "WorkloadConfiguration": {"properties": {"tiers": {"type": "array", "description": "Tiers composing the workload", "items": {"$ref": "#/definitions/WorkloadTierConfiguration"}}, "tags": {"type": "array", "description": "List of tag key/value pairs", "items": {"$ref": "#/definitions/KeyValuePair"}}}, "type": "object"}, "WorkloadDefinition": {"allOf": [{"$ref": "#/definitions/BaseDefinition"}, {"required": ["is_active", "tenant_id"], "properties": {"tenant_id": {"type": "string", "description": "Tenant owning the workload"}, "owner": {"type": "string", "description": "Owner of the workload"}, "name": {"type": "string", "description": "Name of the workload"}, "description": {"type": "string", "description": "Description of the workload"}, "workload_type": {"type": "string", "description": "Type of the workload"}, "is_active": {"type": "boolean", "description": "States if the workload is active or not"}, "attachments": {"type": "array", "description": "List of attachment IDs associated with this workload", "items": {"type": "string"}}}, "type": "object"}]}, "WorkloadDefinitionListRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/WorkloadDefinitionListSortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/WorkloadFilter"}}, "type": "object"}, "WorkloadDefinitionListSortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "Name", "enum": ["Name", "WorkloadType", "CreatedOn", "UpdatedOn"], "x-cs-enum-type": "WorkloadDefinitionListSortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "WorkloadDefinitionVersion": {"allOf": [{"$ref": "#/definitions/BaseDefinitionVersion"}, {"properties": {"details": {"description": "Details of the version", "$ref": "#/definitions/WorkloadConfiguration"}}, "type": "object"}]}, "WorkloadFilter": {"properties": {"tenant_id": {"type": "string", "description": "Tenant id"}, "query": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "WorkloadQueryCloud": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["clouds"], "properties": {"clouds": {"type": "array", "description": "Cloud providers", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "WorkloadQueryCloud"}, "WorkloadQueryCloudAccount": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["cloud_account_ids"], "properties": {"cloud_account_ids": {"type": "array", "description": "ID of cloud accounts", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "WorkloadQueryCloudAccount"}, "WorkloadQueryRequest": {"properties": {"list_context": {"description": "Optional list context", "$ref": "#/definitions/ListContext"}, "sort": {"type": "array", "description": "Sort criteria", "items": {"$ref": "#/definitions/WorkloadQuerySortCriteria"}}, "filters": {"description": "Filters for the request", "$ref": "#/definitions/WorkloadTierConfiguration"}}, "type": "object"}, "WorkloadQuerySortCriteria": {"required": ["column"], "properties": {"column": {"type": "string", "example": "CloudAccountName", "enum": ["CloudAccountName", "Cloud", "ResourceID", "ResourceCategory", "ResourceType", "Resource", "ResourceRegion"], "x-cs-enum-type": "WorkloadQuerySortColumn"}, "ascending": {"type": "boolean"}}, "type": "object"}, "WorkloadQueryWorkloadId": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["workload_ids"], "properties": {"workload_ids": {"type": "array", "description": "ID of the Workload", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "WorkloadQueryWorkloadId"}, "WorkloadQueryWorkloadName": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["name"], "properties": {"name": {"type": "string", "description": "Regular expression to match against Workload name."}}, "type": "object"}], "x-cs-type-name": "WorkloadQueryWorkloadName"}, "WorkloadQueryWorkloadOwner": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["workload_owners"], "properties": {"workload_owners": {"type": "array", "description": "Owners of Workload", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "WorkloadQueryWorkloadOwner"}, "WorkloadQueryWorkloadType": {"allOf": [{"$ref": "#/definitions/QueryOperator"}, {"required": ["workload_types"], "properties": {"workload_types": {"type": "array", "description": "Type of the Workload", "items": {"type": "string"}}}, "type": "object"}], "x-cs-type-name": "WorkloadQueryWorkloadType"}, "WorkloadResource": {"properties": {"service_resource_id": {"type": "string", "description": "Unique identifier of the resource", "x-cs-type": "ObjectId"}, "service_account_id": {"type": "string", "description": "ID of account that resource belongs to"}, "resource_filter": {"type": "string", "description": "Resource Filter"}, "category": {"type": "string", "description": "Category of resource"}, "resource_type": {"type": "string", "description": "Resource Type of resource"}, "resource": {"type": "string", "description": "Resource (service_resource)"}, "operation_id": {"type": "string", "description": "OperationId associated with resource"}, "location": {"type": "string", "description": "Location of resource"}, "check_resource_element": {"type": "string", "description": "Resource identifier"}, "resource_name": {"type": "string", "description": "Resource name. For any resource type that does not support a name field, resource_name will be null."}, "tags": {"type": "object", "description": "Tags associated with resource", "additionalProperties": {"type": "string"}}, "status": {"type": "string", "description": "Status of the resource"}, "created_at": {"type": "string", "format": "date-time", "description": "When resource was created"}, "updated_at": {"type": "string", "format": "date-time", "description": "When resource was last updated"}}, "type": "object"}, "WorkloadServiceResource": {"properties": {"cloud": {"type": "string", "description": "Cloud Provider", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "category": {"type": "string", "description": "Resource Category"}, "resource_type": {"type": "string", "description": "Resource Type"}, "resource": {"type": "string", "description": "Resource Name"}, "supports_tags": {"type": "boolean", "description": "Whether resource has tag support"}}, "type": "object"}, "WorkloadServiceResourceRegion": {"properties": {"region": {"type": "string", "description": "Resource Region"}}, "type": "object"}, "WorkloadServiceResourceRegionRequest": {"properties": {"cloud_account_ids": {"type": "array", "description": "Which cloud account ids to fetch regions for", "items": {"type": "string"}}}, "type": "object"}, "WorkloadServiceResourceRequest": {"properties": {"service_account_ids": {"type": "array", "description": "Which cloud account ids to fetch resources for", "items": {"type": "string", "x-cs-type": "ObjectId"}}}, "type": "object"}, "WorkloadTierConfiguration": {"properties": {"name": {"type": "string", "description": "Name of the workload tier"}, "description": {"type": "string", "description": "Description of the tier"}, "owner": {"type": "string", "description": "Owner of the tier"}, "cloud_account_id": {"type": "array", "items": {"type": "string", "description": "Cloud Accounts from which to select resources"}}, "resource_filter": {"$ref": "#/definitions/QueryOperator"}}, "type": "object"}, "WorkspaceDataForServiceAccount": {"properties": {"service_account_id": {"type": "string", "description": "Id of the service account of the workspace", "x-cs-type": "ObjectId"}, "workspace_details": {"type": "array", "description": "list of all workspaces details associated with the service account", "items": {"$ref": "#/definitions/WorkspaceDetails"}}}, "type": "object"}, "WorkspaceDetails": {"properties": {"resource_id": {"type": "string", "description": "resource id of the workspace"}, "workspace_id": {"type": "string", "description": "id of the workspace"}}, "type": "object"}, "ZabbixComponentBase": {"properties": {"item_id": {"type": "string", "description": "ID of the Zabbix component"}, "name": {"type": "string", "description": "Name of the component"}}, "type": "object"}, "ZabbixConfiguration": {"allOf": [{"$ref": "#/definitions/ZabbixConfigurationBase"}, {"properties": {"resource_type": {"type": "string", "description": "Corestack resource type"}, "item": {"$ref": "#/definitions/ZabbixElement"}, "trigger": {"$ref": "#/definitions/ZabbixTriggerComponent"}, "cloud_management_action": {"type": "string", "description": "Cloud management action for Zabbix"}, "execution_type": {"type": "string", "description": "Execution types in Zabbix Configuration", "example": "manual", "enum": ["manual", "immediate", "delay"], "x-cs-enum-type": "ZabbixExecutionType"}}, "type": "object"}]}, "ZabbixConfigurationBase": {"required": ["cloud_service"], "properties": {"cloud_service": {"type": "string", "description": "Cloud Provider to select", "example": "AWS", "enum": ["AWS", "Azure", "AzureStack", "Azure_CSP", "Azure_CSP-Direct", "Azure_EA", "Azure_MCA", "Cloudstack", "GCP", "MS_VMM", "OCI", "Openstack", "PrivateCloud", "Rackspace", "VMware", "VMware_VCD", "vCenter"], "x-cs-enum-type": "CloudServiceName"}, "template": {"$ref": "#/definitions/ZabbixTemplate"}, "webhook_url": {"type": "string", "description": "Webhook URL for Zabbix Configuration"}}, "type": "object"}, "ZabbixElement": {"allOf": [{"$ref": "#/definitions/ZabbixElementBase"}, {"properties": {"key": {"type": "string", "description": "Key with respect to Zabbix configuration"}, "interval": {"type": "string", "description": "Interval for the trigger"}, "item_type": {"type": "string", "description": "Zabbix classification for the item"}, "hosts": {"type": "array", "description": "List of hosts", "items": {"type": "string"}}, "enabled": {"type": "boolean", "description": "Enabled or not"}}, "type": "object"}]}, "ZabbixElementBase": {"allOf": [{"$ref": "#/definitions/ZabbixComponentBase"}, {"properties": {"number_of_triggers": {"type": "integer", "description": "Number of triggers of the component"}}, "type": "object"}]}, "ZabbixHostConfiguration": {"allOf": [{"$ref": "#/definitions/ZabbixConfigurationBase"}, {"properties": {"host_group_id": {"type": "string", "description": "ID of the host group"}, "name": {"type": "string", "description": "Name of the host group"}, "hosts": {"type": "array", "description": "List of hosts", "items": {"type": "string"}}, "items": {"type": "array", "items": {"$ref": "#/definitions/ZabbixElement"}}}, "type": "object"}]}, "ZabbixTemplate": {"allOf": [{"$ref": "#/definitions/ZabbixElementBase"}, {"properties": {"number_of_items": {"type": "integer", "description": "Number of components"}, "linked_templates": {"type": "array", "description": "List of linked templates", "items": {"type": "string"}}, "linked_hosts": {"type": "array", "description": "List of linked hosts", "items": {"type": "string"}}}, "type": "object"}]}, "ZabbixTriggerComponent": {"allOf": [{"$ref": "#/definitions/ZabbixComponentBase"}, {"properties": {"enabled": {"type": "boolean", "description": "Enabled or not"}, "severity": {"type": "string", "description": "Severity of Zabbix Trigger Component", "example": "Not_Classified", "enum": ["Not_Classified", "Information", "Warning", "Average", "High", "Disaster"], "x-cs-enum-type": "ZabbixTriggerSeverity"}, "expression": {"type": "string", "description": "Expression of the trigger component"}}, "type": "object"}]}, "ZohoServiceDeskAlertMapping": {"properties": {"selected_description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes to be added into  Zoho ServiceDesk Alerts Description", "example": "location", "enum": ["location", "metric_name", "metric_value", "name", "operator", "project_name", "resource_group", "resource_name", "resource_type", "service_account_name", "service_name", "threshold", "time_aggregation"], "x-cs-enum-type": "ZohoServiceDeskAlertDescriptionAttribute"}}, "selected_incident_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes to be added into Zoho ServiceDesk Alerts Incident Name", "example": "cloud_account_name", "enum": ["cloud_account_name", "resource_id"], "x-cs-enum-type": "ZohoServiceDeskAlertIncidentAttribute"}}}, "type": "object"}, "ZohoServiceDeskBudgetAlertMapping": {"properties": {"selected_description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes to be added into  Zoho ServiceDesk Budget Alerts Description", "example": "actual_amount", "enum": ["actual_amount", "budget_amount", "budget_frequency", "budget_name", "budget_type", "configuration_type", "created_at", "currency", "project_name", "service_accounts", "threshold_percentage", "updated_at"], "x-cs-enum-type": "ZohoServiceDeskBudgetAlertDescriptionAttribute"}}, "selected_incident_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes to be added into Zoho ServiceDesk Budget Alerts Incident", "example": "cloud_account_name", "enum": ["cloud_account_name", "budget_name"], "x-cs-enum-type": "ZohoServiceDeskBudgetAlertIncidentAttribute"}}}, "type": "object"}, "ZohoServiceDeskIncidentManagementConfiguration": {"properties": {"module": {"type": "string", "description": "Module for Incident management", "example": "problem_module", "enum": ["problem_module", "request_module"], "x-cs-enum-type": "ZohoServiceDeskModule"}, "requester": {"$ref": "#/definitions/ZohoServiceDeskIncidentManagementConfigurationRequester"}, "assignee": {"type": "string", "description": "Assignee of the Incident"}, "site": {"description": "Sites for Incident management", "$ref": "#/definitions/ZohoServiceDeskSite"}}, "type": "object"}, "ZohoServiceDeskIncidentManagementConfigurationRequester": {"properties": {"user_id": {"type": "string", "description": "Id of the requester"}, "user_name": {"type": "string", "description": "Name for requester"}}, "type": "object"}, "ZohoServiceDeskPolicyMapping": {"properties": {"selected_description_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes to be added into Zoho ServiceDesk Policy Description", "example": "policy_id", "enum": ["policy_id", "display_name", "status", "services", "policy_type", "engine_type", "resources", "resource_id", "resource_name", "region", "service_accounts", "content_type", "classification", "sub_classification", "severity"], "x-cs-enum-type": "ZohoServiceDeskPolicyDescriptionAttribute"}}, "selected_incident_attributes": {"type": "array", "items": {"type": "string", "description": "Allowed attributes to be added into Zoho ServiceDesk Policy Incident Name", "example": "policy_name", "enum": ["policy_name", "cloud_account_name", "resource_name"], "x-cs-enum-type": "ZohoServiceDeskPolicyIncidentAttribute"}}}, "type": "object"}, "ZohoServiceDeskSite": {"properties": {"key": {"type": "string", "description": "Key for ZOHO ServiceDesk Site"}, "name": {"type": "string", "description": "Name for ZOHO ServiceDesk Site"}}, "type": "object"}, "ZohoServiceDeskUser": {"properties": {"user_id": {"type": "string", "description": "Id of the user"}, "user_name": {"type": "string", "description": "Name for user"}}, "type": "object"}, "ZoneModel": {"required": ["count", "zone"], "properties": {"zone": {"type": "string", "description": "zone name"}, "count": {"type": "integer", "description": "total count details"}}, "type": "object"}}, "responses": {"ParseError": {"description": "When a mask can't be parsed"}, "MaskError": {"description": "When any error occurs on mask"}}}