openapi: 3.2.0 info: title: Airia Web System Agent Settings API version: 1.0.0 servers: - url: https://api.airia.ai tags: - name: SystemAgentSettings paths: /v1/SystemAgentSettings: get: tags: - SystemAgentSettings operationId: SystemAgentSettings_GetSystemAgents parameters: - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/SystemAgentMetadataDto' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings get system agents x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}: get: tags: - SystemAgentSettings operationId: SystemAgentSettings_GetSystemAgent parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: version in: query schema: type: - string - 'null' x-position: 2 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/SystemAgentDetailDto' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings get system agent x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/enable: put: tags: - SystemAgentSettings operationId: SystemAgentSettings_EnableSystemAgent parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings enable system agent x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/disable: put: tags: - SystemAgentSettings operationId: SystemAgentSettings_DisableSystemAgent parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings disable system agent x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/overrides: put: tags: - SystemAgentSettings operationId: SystemAgentSettings_UpdateOverrides parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: version in: query schema: type: - string - 'null' x-position: 3 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/UpdateSystemAgentOverridesRequest' required: true x-position: 2 responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings update overrides x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/pin: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_PinVersion parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/PinVersionRequest' x-position: 2 responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings pin version x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/unpin: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_UnpinVersion parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings unpin version x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/upgrade: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_UpgradeVersion parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings upgrade version x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/override-snapshots: get: tags: - SystemAgentSettings operationId: SystemAgentSettings_GetOverrideSnapshots parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings get override snapshots x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/restore-overrides: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_RestoreOverrides parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: version in: query schema: type: string x-position: 2 - name: x-correlation-id in: header schema: type: string responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings restore overrides x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/provision: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_ProvisionSystemAgent parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/ProvisionSystemAgentRequest' required: true x-position: 2 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/ProvisionSystemAgentResult' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 409: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 422: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings provision system agent x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/unprovision: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_UnprovisionSystemAgent parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 409: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings unprovision system agent x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/upgrade-provisioned: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_UpgradeProvisionedAgent parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/UpgradeProvisionedAgentRequest' required: true x-position: 2 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/ProvisionSystemAgentResult' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings upgrade provisioned agent x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/upgrade-preview: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_PreviewUpgrade parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/UpgradeProvisionedAgentRequest' required: true x-position: 2 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/SystemAgentUpgradePreviewDto' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings preview upgrade x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/migrate-deployment: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_MigrateExistingDeployment parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/MigrateDeploymentRequest' required: true x-position: 2 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/ProvisionSystemAgentResult' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 409: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings migrate existing deployment x-summary-source: derived /v1/SystemAgentSettings/occupied-projects: get: tags: - SystemAgentSettings operationId: SystemAgentSettings_GetOccupiedProjectIds parameters: - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: type: string format: guid 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings get occupied project ids x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/delegates: get: tags: - SystemAgentSettings operationId: SystemAgentSettings_GetDelegates parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/SystemAgentDelegateDto' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings get delegates x-summary-source: derived put: tags: - SystemAgentSettings operationId: SystemAgentSettings_ReconcileDelegates parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/ReconcileDelegatesRequest' required: true x-position: 2 responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings reconcile delegates x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/delegates/{exportAgentId}/enable: put: tags: - SystemAgentSettings operationId: SystemAgentSettings_EnableDelegate parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: exportAgentId in: path required: true schema: type: string format: guid x-position: 2 - name: x-correlation-id in: header schema: type: string responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings enable delegate x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/delegates/{exportAgentId}/disable: put: tags: - SystemAgentSettings operationId: SystemAgentSettings_DisableDelegate parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: exportAgentId in: path required: true schema: type: string format: guid x-position: 2 - name: x-correlation-id in: header schema: type: string responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings disable delegate x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/provisioned-pipeline: get: tags: - SystemAgentSettings operationId: SystemAgentSettings_GetProvisionedPipeline parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedPipelineDto' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings get provisioned pipeline x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/provisioned-pipeline/privacy: put: tags: - SystemAgentSettings operationId: SystemAgentSettings_UpdateProvisionedPipelinePrivacy parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/UpdateProvisionedPipelinePrivacyRequest' required: true x-position: 2 responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings update provisioned pipeline privacy x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/provisioned-pipeline/tools: put: tags: - SystemAgentSettings operationId: SystemAgentSettings_UpdateProvisionedToolConfiguration parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/UpdateProvisionedToolConfigurationRequest' required: true x-position: 2 responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings update provisioned tool configuration x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/provisioned-pipeline/prompt-segment: post: tags: - SystemAgentSettings operationId: SystemAgentSettings_CreateProvisionedPromptSegment parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/CreateProvisionedPromptSegmentRequest' required: true x-position: 2 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/StepPromptSegment' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings create provisioned prompt segment x-summary-source: derived /v1/SystemAgentSettings/{systemAgentId}/mcp-bindings: put: tags: - SystemAgentSettings operationId: SystemAgentSettings_UpdateMcpBindings parameters: - name: systemAgentId in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/UpdateMcpBindingsRequest' required: true x-position: 2 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/UpdateMcpBindingsResult' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 422: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: System agent settings update mcp bindings x-summary-source: derived components: schemas: UserGroup: type: object additionalProperties: false properties: userGroupId: type: string format: guid userId: type: string format: guid groupId: type: string format: guid tenantId: type: string format: guid user: $ref: '#/components/schemas/User' group: $ref: '#/components/schemas/Group' AiAssetSourceType: type: string description: '' x-enumNames: - Airia - Aws - Azure - Global - N8n - LangGraph - CopilotStudio - GitHub - Governance - GoogleWorkspace - MicrosoftGraph - EndpointAgent - Browser - CrowdStrike - Okta - CrowdStrikeEndpoint - MicrosoftDefenderCloudApps - MicrosoftDefenderXdr - SentinelOne - Netskope - Zscaler - Gateway - AzureDevOps - Gcp - Databricks - Snowflake - Glean - Atlan - ServiceNow - SalesforceAgentforce - CrewAi - AzurePowerApps - GeminiEnterprise - GoogleAgentPlatform - Purview - AzureFunctionApps - GitLab enum: - Airia - Aws - Azure - Global - N8n - LangGraph - CopilotStudio - GitHub - Governance - GoogleWorkspace - MicrosoftGraph - EndpointAgent - Browser - CrowdStrike - Okta - CrowdStrikeEndpoint - MicrosoftDefenderCloudApps - MicrosoftDefenderXdr - SentinelOne - Netskope - Zscaler - Gateway - AzureDevOps - Gcp - Databricks - Snowflake - Glean - Atlan - ServiceNow - SalesforceAgentforce - CrewAi - AzurePowerApps - GeminiEnterprise - GoogleAgentPlatform - Purview - AzureFunctionApps - GitLab SpmSecurityScoreStatus: type: string description: '' x-enumNames: - NotAnalyzed - Analyzed - Error - NotApplicable enum: - NotAnalyzed - Analyzed - Error - NotApplicable EvaluationType: type: string description: '' x-enumNames: - Standard - RedTeaming - Bias - StandardBiasDrift - Consistency enum: - Standard - RedTeaming - Bias - StandardBiasDrift - Consistency ConnectionCloudflare: type: object additionalProperties: false properties: accountId: type: - string - 'null' apiToken: type: - string - 'null' maxRecordsPerRequest: type: - integer - 'null' format: int32 MitigationStepStatus: type: string description: '' x-enumNames: - New - InProgress - Completed - Failed enum: - New - InProgress - Completed - Failed RiskMetadata: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid classificationAssignmentId: type: string format: guid classificationAssignment: oneOf: - $ref: '#/components/schemas/ClassificationAssignment' description: type: - string - 'null' inherentRiskScore: type: - integer - 'null' format: int32 residualRiskScore: type: - integer - 'null' format: int32 confidence: type: - string - 'null' maxLength: 50 rationale: type: - string - 'null' maxLength: 2000 euAiAct: oneOf: - $ref: '#/components/schemas/EuAiActCategory' nistAiRmf: oneOf: - $ref: '#/components/schemas/NistAiRmfTier' iso42001: oneOf: - $ref: '#/components/schemas/Iso42001Level' status: $ref: '#/components/schemas/RiskRegistryStatus' riskDomainId: type: - string - 'null' format: guid riskDomain: oneOf: - $ref: '#/components/schemas/RiskDomain' riskSubDomainId: type: - string - 'null' format: guid riskSubDomain: oneOf: - $ref: '#/components/schemas/RiskSubDomain' type: oneOf: - $ref: '#/components/schemas/RiskRegistryType' tenantId: type: string format: guid riskProfileId: type: - string - 'null' format: guid riskProfile: oneOf: - $ref: '#/components/schemas/RiskProfile' user: oneOf: - $ref: '#/components/schemas/User' mitigationSteps: type: array items: $ref: '#/components/schemas/MitigationStep' acceptanceDecision: oneOf: - $ref: '#/components/schemas/AcceptanceDecision' avoidanceDecision: oneOf: - $ref: '#/components/schemas/RiskAvoidanceDecision' transferDecision: oneOf: - $ref: '#/components/schemas/RiskTransferDecision' riskControls: type: array items: $ref: '#/components/schemas/RiskControl' artifacts: type: array items: $ref: '#/components/schemas/RiskArtifact' catalogVersion: type: - string - 'null' maxLength: 50 AiAssetSourceSyncParameters: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object x-abstract: true additionalProperties: false properties: name: type: string maxLength: 250 lastUpdated: type: - string - 'null' format: date-time id: type: string format: guid region: type: string maxLength: 250 aiAssetAggregateSourceId: type: string format: guid parameterType: $ref: '#/components/schemas/AiAssetSourceSyncParameterType' aiAssetAggregateSource: $ref: '#/components/schemas/AiAssetAggregateSource' tenantId: type: string format: guid credentialId: type: string format: guid credential: oneOf: - $ref: '#/components/schemas/Credentials' AiAssetUsageStatus: type: string description: '' x-enumNames: - Undefined - Confirmed - Updating enum: - Undefined - Confirmed - Updating MitigationArtifactEvidenceState: type: string description: '' x-enumNames: - Qualifying - Candidate - Missing - InProgress enum: - Qualifying - Candidate - Missing - InProgress DataSourceFileMetadata: type: object additionalProperties: false properties: id: type: string name: type: string mimeType: type: - string - 'null' lastUpdated: type: - string - 'null' format: date-time size: type: integer format: int64 downloadUrl: type: string ConnectionCopilotStudio: type: object additionalProperties: false properties: tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' certificateData: type: - string - 'null' certificatePassword: type: - string - 'null' useCertificateAuth: type: boolean environmentUrl: type: - string - 'null' webhookThreatDetectionEnabled: type: boolean allowedWebhookAppIds: type: array items: type: string collectConversationTranscripts: type: boolean transcriptCollectionStartedAt: type: - string - 'null' format: date-time AssessmentTemplate: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - name - description - category - scope - frameworkId properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 name: type: string maxLength: 256 minLength: 1 description: type: string maxLength: 2000 minLength: 1 category: $ref: '#/components/schemas/AssessmentTemplateCategory' scope: $ref: '#/components/schemas/AssessmentTemplateScope' subCategories: type: array items: $ref: '#/components/schemas/AssessmentTemplateSubCategory' frameworkId: type: string format: guid minLength: 1 framework: $ref: '#/components/schemas/GovernanceFramework' isSystemManaged: type: boolean sourceTemplateId: type: - string - 'null' format: guid isActive: type: boolean systemKey: type: - string - 'null' maxLength: 128 assessments: type: array items: $ref: '#/components/schemas/Assessment' versions: type: array items: $ref: '#/components/schemas/AssessmentTemplateVersion' AgentEvaluationEvaluator: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - descriptorJson properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 agentEvaluationId: type: string format: guid agentEvaluation: $ref: '#/components/schemas/AgentEvaluation' evalSuiteEvaluatorId: type: - string - 'null' format: guid evalSuiteEvaluator: oneOf: - $ref: '#/components/schemas/EvalSuiteEvaluator' descriptorJson: type: string minLength: 1 initParamsJson: type: - string - 'null' SpmComponentType: type: string description: '' x-enumNames: - Undefined - AiModel - SpmAgent - Tool - McpServer - Knowledge enum: - Undefined - AiModel - SpmAgent - Tool - McpServer - Knowledge ReconcileDelegatesRequest: type: object additionalProperties: false properties: enabledDelegateIds: type: array items: type: string format: guid CredentialType: type: string description: '' x-enumNames: - None - Ai21 - Alibaba - AlphaVantage - Anthropic - Asana - Atlassian - AtlassianApiKey - AtlassianOauth - Azure - AzureAIStudio - AzureBlob - AzureML - BasicAuth - Bedrock - BoxOauth - BraveSearchApiKey - Cohere - Compass - CustomCredential - CustomAPIKey - CustomOpenAI - DataBricksToken - DropboxOauth - ElevenLabs - Exa - Firecrawl - GenericOpenAI - GithubPersonalAccessToken - Google - GoogleOauth - GoogleServiceAccount - HeaderAuth - Hubspot - HuggingFace - ICDOauth - IPAPI - JinaAI - LinkPreview - McpAccessToken - McpHeaders - MicrosoftOauth - MicrosoftBingSearch - Mistral - MongoDb - MongoDbCloudId - MongoDbConnectionString - MsServer - MySql - NASA - NewsAPI - NotionIntegrationSecret - Nutritionix - Ollama - OpenAI - OpenVINO - Perplexity - PgSql - Pinecone - PyTorch - QueryParamAuth - Reddit - Replicate - S3 - SalesforceOauth - ScaleFlex - SendGrid - Serper - ServiceNow - SlackBotAccessToken - SlackOauth - SlackUserAccessToken - SnowflakeEncryptedKey - SnowflakePrivateKey - Spotify - Stability - Strava - SupabasePersonalAccessToken - TogetherAI - WatsonAix - Weaviate - WeatherStack - WolframAlpha - XKey - XAI - XOauth - Youtube - FredApiKey - GovRegulationsApiKey - SecHeader - PineconeApiKey - LaunchDarklyApiKey - PerplexityApiKey - StripeApiKey - AirtableApiKey - SmartSheetApiKey - GrafanaApiKey - GenericOAuth - AiriaXApiKey - AzureAi - BedrockArn - ScaleflexMcpHeaders - WhatsAppCloudApi - NotionOauth - SapHana - BitlyApiKey - CalendlyAccessToken - ClickUpApiKey - DiscordBotToken - FreshdeskApiKey - IntercomAccessToken - LinearApiKey - MailchimpApiKey - MondayComApiKey - PipedriveApiKey - ShopifyAccessToken - SurveyMonkeyAccessToken - TelegramBotToken - TodoistApiKey - TrelloApiKey - TwilioApiKey - TypeformAccessToken - ZendeskApiKey - ZoomOauth - QuickBooksOauth - AwsAccessKey - JiraOauth - XeroOauth - ActiveCampaignApiKey - GitlabAccessToken - ClockifyApiKey - PagerDutyApiKey - NetlifyAccessToken - HelpScoutApiKey - HarvestAccessToken - DiscourseApiKey - ConvertKitApiKey - BaserowApiKey - NocoDBApiKey - PayPalOAuth - KeapAccessToken - MauticApiKey - AffinityApiKey - HighLevelApiKey - InvoiceNinjaApiKey - MagentoAccessToken - CustomerIoApiKey - AgileCrmApiKey - PostHogApiKey - OrbitApiKey - SentryIoApiKey - WooCommerceApiKey - SpotifyOauth - UptimeRobotApiKey - MediumAccessToken - LinkedInOauth - StravaOauth - SupabaseApiKey - MetabaseApiKey - PaddleApiKey - JenkinsApiKey - SalesmateApiKey - ChargebeeApiKey - HomeAssistantAccessToken - CircleCiApiKey - RedditApiOauth - OktaApiKey - WhatsAppAccessToken - FreshserviceApiKey - FreshworksCrmApiKey - BrevoApiKey - MailerLiteApiKey - CloudflareApiKey - StrapiApiKey - GetResponseApiKey - TwistAccessToken - WekanApiKey - ZulipApiKey - NextCloudApiKey - CodaApiKey - DriftAccessToken - QuickBaseApiKey - TheHiveApiKey - KoBoToolboxApiKey - GrafanaApiApiKey - ActionNetworkApiKey - AdaloApiKey - AirtopApiKey - ApiTemplateIoApiKey - AutopilotApiKey - AwsLambdaApiKey - BannerbearApiKey - BeeminderApiKey - BitwardenApiKey - BrandfetchApiKey - BubbleApiKey - ClearbitApiKey - CockpitApiKey - CoinGeckoApiKey - MicrosoftGraphAccessToken - GcpServiceAccount - GoogleCloudOAuth - MsServerEntraId - DemioApiKey - DhlApiKey - DisqusApiKey - DropcontactApiKey - EgoiApiKey - EmeliaApiKey - ErpNextApiKey - FlowApiKey - GhostApiKey - GongApiKey - GotifyApiKey - GoToWebinarOAuth2 - GristApiKey - HackerNewsApiKey - HaloPsaApiKey - HumanticAiApiKey - HunterApiKey - IterableApiKey - JinaAiApiKey - LemlistApiKey - LingvaNexApiKey - LoneScaleApiKey - MailcheckApiKey - MailgunApiKey - MailjetApiKey - MandrillApiKey - MarketstackApiKey - MatrixApiKey - MattermostApiKey - MessageBirdApiKey - MindeeApiKey - MispApiKey - MistralAiApiKey - MoceanApiKey - MonicaCrmApiKey - Msg91ApiKey - NasaApiKey - NpmApiKey - OdooApiKey - OneSimpleApiApiKey - OnfleetApiKey - OpenThesaurusApiKey - OpenWeatherMapApiKey - OuraApiKey - PeekalinkApiKey - PhantombusterApiKey - PhilipsHueApiKey - PlivoApiKey - ProfitWellApiKey - PushbulletApiKey - PushcutApiKey - PushoverApiKey - QuickChartApiKey - RaindropApiKey - RocketChatApiKey - RundeckApiKey - SeaTableApiKey - SecurityScorecardApiKey - SegmentApiKey - SendyApiKey - Signl4ApiKey - Sms77ApiKey - SplunkApiKey - StackbyApiKey - StoryblokApiKey - SyncroMspApiKey - TaigaApiKey - TapfiliateApiKey - TravisCiApiKey - TwakeApiKey - UnleashedSoftwareApiKey - UpleadApiKey - UProcApiKey - UrlScanIoApiKey - VeroApiKey - VonageApiKey - WebflowApiKey - WiseApiKey - TwitterOAuth2 - YourlsApiKey - ZammadApiKey - ZohoCrmOAuth2 - DocuSignOAuth2 - AzureDevOpsPersonalAccessToken - WorkdayOAuth2 - DatadogApiKey - AmazonSESApiKey - BitbucketOAuth2 - SAPApiKey - Dynamics365OAuth2 - SnowflakeApiKey - TwitchOAuth2 - FigmaPersonalAccessToken - AwsCloudWatchApiKey - AzureBlobStorageApiKey - OneLoginOAuth2 - SmtpRelay - WordpressApiKey - ContentfulApiKey - CopperApiKey - DeepLApiKey - CortexApiKey - AzureFoundryEntraId - Causeway - Amazon - Clerk - Brightspace - GenericAnthropic - Cohesity - AnthropicInferenceHooks - AnthropicAnalytics - GoogleVertexAi enum: - None - AI21 - Alibaba - AlphaVantage - Anthropic - Asana - Atlassian - AtlassianApiKey - AtlassianOauth - Azure - AzureAIStudio - AzureBlob - AzureML - BasicAuth - Bedrock - BoxOauth - BraveSearchApiKey - Cohere - Compass - CustomCredential - CustomAPIKey - Custom OpenAI - DataBricksToken - DropboxOauth - ElevenLabs - Exa - Firecrawl - GenericOpenAI - GithubPersonalAccessToken - Google - GoogleOauth - GoogleServiceAccount - HeaderAuth - Hubspot - Hugging Face - ICDOauth - IPAPI - JinaAI - LinkPreview - McpAccessToken - McpHeaders - MicrosoftOauth - MicrosoftBingSearch - Mistral - MongoDb - MongoDbCloudId - MongoDbConnectionString - MsServer - MySql - NASA - NewsAPI - NotionIntegrationSecret - Nutritionix - Ollama - OpenAI - OpenVINO - Perplexity - PgSql - Pinecone - PyTorch - QueryParamAuth - Reddit - Replicate - S3 - SalesforceOauth - ScaleFlex - SendGrid - Serper - ServiceNow - SlackBotAccessToken - SlackOauth - SlackUserAccessToken - SnowflakeEncryptedKey - SnowflakePrivateKey - Spotify - Stability - Strava - SupabasePersonalAccessToken - Together AI - WatsonAix - Weaviate - WeatherStack - WolframAlpha - X - XAI - XOauth - Youtube - FredApiKey - GovRegulationsApiKey - SecHeader - PineconeApiKey - LaunchDarklyApiKey - PerplexityApiKey - StripeApiKey - AirtableApiKey - SmartSheetApiKey - GrafanaApiKey - GenericOAuth - AiriaXApiKey - AzureAi - BedrockArn - ScaleflexMcpHeaders - WhatsAppCloudApi - NotionOauth - SapHana - BitlyApiKey - CalendlyAccessToken - ClickUpApiKey - DiscordBotToken - FreshdeskApiKey - IntercomAccessToken - LinearApiKey - MailchimpApiKey - MondayComApiKey - PipedriveApiKey - ShopifyAccessToken - SurveyMonkeyAccessToken - TelegramBotToken - TodoistApiKey - TrelloApiKey - TwilioApiKey - TypeformAccessToken - ZendeskApiKey - ZoomOauth - QuickBooksOauth - AwsAccessKey - JiraOauth - XeroOauth - ActiveCampaignApiKey - GitlabAccessToken - ClockifyApiKey - PagerDutyApiKey - NetlifyAccessToken - HelpScoutApiKey - HarvestAccessToken - DiscourseApiKey - ConvertKitApiKey - BaserowApiKey - NocoDBApiKey - PayPalOAuth - KeapAccessToken - MauticApiKey - AffinityApiKey - HighLevelApiKey - InvoiceNinjaApiKey - MagentoAccessToken - CustomerIoApiKey - AgileCrmApiKey - PostHogApiKey - OrbitApiKey - SentryIoApiKey - WooCommerceApiKey - SpotifyOauth - UptimeRobotApiKey - MediumAccessToken - LinkedInOauth - StravaOauth - SupabaseApiKey - MetabaseApiKey - PaddleApiKey - JenkinsApiKey - SalesmateApiKey - ChargebeeApiKey - HomeAssistantAccessToken - CircleCiApiKey - RedditApiOauth - OktaApiKey - WhatsAppAccessToken - FreshserviceApiKey - FreshworksCrmApiKey - BrevoApiKey - MailerLiteApiKey - CloudflareApiKey - StrapiApiKey - GetResponseApiKey - TwistAccessToken - WekanApiKey - ZulipApiKey - NextCloudApiKey - CodaApiKey - DriftAccessToken - QuickBaseApiKey - TheHiveApiKey - KoBoToolboxApiKey - GrafanaApiApiKey - ActionNetworkApiKey - AdaloApiKey - AirtopApiKey - ApiTemplateIoApiKey - AutopilotApiKey - AwsLambdaApiKey - BannerbearApiKey - BeeminderApiKey - BitwardenApiKey - BrandfetchApiKey - BubbleApiKey - ClearbitApiKey - CockpitApiKey - CoinGeckoApiKey - MicrosoftGraphAccessToken - GcpServiceAccount - GoogleCloudOAuth - MsServerEntraId - DemioApiKey - DhlApiKey - DisqusApiKey - DropcontactApiKey - EgoiApiKey - EmeliaApiKey - ErpNextApiKey - FlowApiKey - GhostApiKey - GongApiKey - GotifyApiKey - GoToWebinarOAuth2 - GristApiKey - HackerNewsApiKey - HaloPsaApiKey - HumanticAiApiKey - HunterApiKey - IterableApiKey - JinaAiApiKey - LemlistApiKey - LingvaNexApiKey - LoneScaleApiKey - MailcheckApiKey - MailgunApiKey - MailjetApiKey - MandrillApiKey - MarketstackApiKey - MatrixApiKey - MattermostApiKey - MessageBirdApiKey - MindeeApiKey - MispApiKey - MistralAiApiKey - MoceanApiKey - MonicaCrmApiKey - Msg91ApiKey - NasaApiKey - NpmApiKey - OdooApiKey - OneSimpleApiApiKey - OnfleetApiKey - OpenThesaurusApiKey - OpenWeatherMapApiKey - OuraApiKey - PeekalinkApiKey - PhantombusterApiKey - PhilipsHueApiKey - PlivoApiKey - ProfitWellApiKey - PushbulletApiKey - PushcutApiKey - PushoverApiKey - QuickChartApiKey - RaindropApiKey - RocketChatApiKey - RundeckApiKey - SeaTableApiKey - SecurityScorecardApiKey - SegmentApiKey - SendyApiKey - Signl4ApiKey - Sms77ApiKey - SplunkApiKey - StackbyApiKey - StoryblokApiKey - SyncroMspApiKey - TaigaApiKey - TapfiliateApiKey - TravisCiApiKey - TwakeApiKey - UnleashedSoftwareApiKey - UpleadApiKey - UProcApiKey - UrlScanIoApiKey - VeroApiKey - VonageApiKey - WebflowApiKey - WiseApiKey - TwitterOAuth2 - YourlsApiKey - ZammadApiKey - ZohoCrmOAuth2 - DocuSignOAuth2 - AzureDevOpsPersonalAccessToken - WorkdayOAuth2 - DatadogApiKey - AmazonSESApiKey - BitbucketOAuth2 - SAPApiKey - Dynamics365OAuth2 - SnowflakeApiKey - TwitchOAuth2 - FigmaPersonalAccessToken - AwsCloudWatchApiKey - AzureBlobStorageApiKey - OneLoginOAuth2 - SmtpRelay - WordpressApiKey - ContentfulApiKey - CopperApiKey - DeepLApiKey - CortexApiKey - AzureFoundryEntraId - Causeway - Amazon - Clerk - Brightspace - GenericAnthropic - Cohesity - AnthropicInferenceHooks - AnthropicAnalytics - GoogleVertexAi SpmAppIntegrationAnalysisRun: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - providerType - status - analyzedIdentifier properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 connectionId: type: - string - 'null' format: guid providerType: $ref: '#/components/schemas/IntegrationProviderType' status: $ref: '#/components/schemas/IntegrationAnalysisRunStatus' analyzedIdentifier: type: string maxLength: 255 minLength: 1 totalUsers: type: integer format: int32 totalIntegrations: type: integer format: int32 errors: type: - string - 'null' startedAt: type: - string - 'null' format: date-time endedAt: type: - string - 'null' format: date-time ConnectionSnowflake: type: object additionalProperties: false properties: accountUrl: type: string programmaticAccessToken: type: string role: type: - string - 'null' ChunkingStrategy: type: string description: '' x-enumNames: - Automatic - Recursive - Html - Markdown - Code - Token - Character enum: - automatic - recursive - html - markdown - code - token - character ScheduleType: type: string description: '' x-enumNames: - Hourly - Daily - Weekly - Minute - OneTime - Monthly - Quarterly enum: - Hourly - Daily - Weekly - Minute - OneTime - Monthly - Quarterly AiAssetAggregateSource: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid source: $ref: '#/components/schemas/AiAssetSourceType' timeReference: type: - string - 'null' format: date-time syncParameters: type: - array - 'null' items: $ref: '#/components/schemas/AiAssetSourceSyncParameters' SpmProviderKind: type: string description: '' x-enumNames: - AgentRefresh - ShadowAI - CodeScanner - Analytics - EndpointInventory - ProcessExecutionDetection enum: - AgentRefresh - ShadowAI - CodeScanner - Analytics - EndpointInventory - ProcessExecutionDetection MitigationCapability: type: string description: '' x-enumNames: - Invocable - TrafficInterposed - ConfigControlledLlmRouting - ConfigControlledMcpRouting - ConfigControlledMcpSanction - ConfigControlledGateway - Observed - Declared enum: - Invocable - TrafficInterposed - ConfigControlledLlmRouting - ConfigControlledMcpRouting - ConfigControlledMcpSanction - ConfigControlledGateway - Observed - Declared MitigationArtifactType: type: string description: '' x-enumNames: - Guardrail - Evaluation - RedTeamingCampaign - Assessment - GatewayLimit - Disclosure - EndpointRouting - GatewayBudget - GatewayAgentConstraint - ExternalAgentRouting enum: - Guardrail - Evaluation - RedTeamingCampaign - Assessment - GatewayLimit - Disclosure - EndpointRouting - GatewayBudget - GatewayAgentConstraint - ExternalAgentRouting RuleActionEntity: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object x-abstract: true additionalProperties: false properties: ruleId: type: - string - 'null' format: guid rule: oneOf: - $ref: '#/components/schemas/GatewayRuleEntity' resilienceTargetId: type: - string - 'null' format: guid resilienceTarget: oneOf: - $ref: '#/components/schemas/GatewayResilienceTargetEntity' order: type: integer format: int32 AgentEvaluationDataset: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - input properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 agentEvaluationId: type: string format: guid agentEvaluation: $ref: '#/components/schemas/AgentEvaluation' input: type: string minLength: 1 expectedOutput: type: - string - 'null' context: type: - string - 'null' configuration: oneOf: - $ref: '#/components/schemas/AgentEvaluationDatasetConfiguration' baselineDatasetId: type: - string - 'null' format: guid sourceLibraryId: type: - string - 'null' format: guid sourceTestCaseId: type: - string - 'null' format: guid sourceLibraryVersion: type: - string - 'null' maxLength: 32 GatewayApiKeyType: type: string description: '' x-enumNames: - Unknown - Standard - ExternalAgent - User enum: - Unknown - Standard - ExternalAgent - User AiAssetSourceSyncParameterType: type: string description: '' x-enumNames: - AzureOpenAI - AwsBedrock - GoogleVertex enum: - AzureOpenAI - AwsBedrock - GoogleVertex RuleGroupConditionEntity: allOf: - $ref: '#/components/schemas/RuleConditionEntity' - type: object additionalProperties: false properties: logicalOperator: type: string children: type: array items: $ref: '#/components/schemas/RuleConditionEntity' ParameterDataType: type: string description: '' x-enumNames: - String - Integer - Decimal - Boolean - DateTime - Array - Object enum: - String - Integer - Decimal - Boolean - DateTime - Array - Object AiAssetMetadataDefinitionOption: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid aiAssetMetadataDefinitionId: type: string format: guid aiAssetMetadataDefinition: $ref: '#/components/schemas/AiAssetMetadataDefinition' value: type: string maxLength: 500 minLength: 0 SpmComponent: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - spmAgentId - name - externalId - securePostureProvider - componentType - componentJson properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 spmAgentId: type: string format: guid minLength: 1 name: type: string minLength: 1 externalId: type: string minLength: 1 aiModelName: type: - string - 'null' aiProviderName: type: - string - 'null' aiSecurable: type: - boolean - 'null' securedStatus: $ref: '#/components/schemas/SecurePostureStatus' securedNote: type: - string - 'null' securedAt: type: - string - 'null' format: date-time secureApiKeyId: type: - string - 'null' format: guid securePostureProvider: $ref: '#/components/schemas/SecurePostureProvider' componentType: $ref: '#/components/schemas/SpmComponentType' externalType: type: - string - 'null' externalTypeVersion: type: - number - 'null' format: float category: type: - string - 'null' maxLength: 100 externalOwner: type: - string - 'null' maxLength: 255 externalCreatedAt: type: - string - 'null' format: date-time externalModifiedAt: type: - string - 'null' format: date-time language: type: - string - 'null' maxLength: 100 externalCreatedBy: type: - string - 'null' maxLength: 255 externalModifiedBy: type: - string - 'null' maxLength: 255 reusePolicy: type: - string - 'null' maxLength: 50 credentialsCount: type: - integer - 'null' format: int32 parametersCount: type: - integer - 'null' format: int32 componentJson: type: string minLength: 1 endUserAuthenticationSetting: type: - string - 'null' maxLength: 100 knowledgeSourceType: type: - string - 'null' maxLength: 100 knowledgeSourceLocation: type: - string - 'null' maxLength: 2048 spmAgent: $ref: '#/components/schemas/SpmAgent' gatewayApiKey: oneOf: - $ref: '#/components/schemas/GatewayApiKeyEntity' EvalSuiteEvaluator: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - evaluatorKey - displayName - descriptorJson properties: id: type: string format: guid tenantId: type: - string - 'null' format: guid evalSuiteId: type: string format: guid evalSuite: $ref: '#/components/schemas/EvalSuite' evaluatorKey: type: string maxLength: 128 minLength: 1 displayName: type: string maxLength: 128 minLength: 1 isEnabled: type: boolean isHidden: type: boolean descriptorJson: type: string minLength: 1 AssessmentTemplateCategory: type: string description: '' x-enumNames: - Exploratory - Attestation enum: - Exploratory - Attestation ModelIdentifierType: type: string description: '' x-enumNames: - None - Library - Project enum: - None - Library - Project SystemAgentOverrides: type: object additionalProperties: false properties: steps: type: object additionalProperties: $ref: '#/components/schemas/StepOverride' memories: type: object additionalProperties: type: string format: guid subAgents: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SubAgentOverrides' Pipeline: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: activeVersionId: type: - string - 'null' format: guid name: type: - string - 'null' maxLength: 256 minLength: 0 executionName: type: - string - 'null' maxLength: 256 minLength: 0 description: type: - string - 'null' maxLength: 2000 minLength: 0 markdownDescription: type: - string - 'null' maxLength: 4000 minLength: 0 videoLink: type: - string - 'null' maxLength: 256 minLength: 0 agentIconId: type: - string - 'null' format: guid agentUnicodeIcon: type: - string - 'null' maxLength: 256 minLength: 0 executionStats: oneOf: - $ref: '#/components/schemas/ExecutionStats' industry: type: - string - 'null' maxLength: 256 minLength: 0 subIndustries: type: - array - 'null' items: type: string agentDetails: type: - object - 'null' additionalProperties: type: array items: $ref: '#/components/schemas/AgentDetailItem' agentDetailsTags: type: - array - 'null' items: type: string tags: type: array items: type: string activeVersion: oneOf: - $ref: '#/components/schemas/PipelineVersion' backupPipelineId: type: - string - 'null' format: guid libraryAgentId: type: - string - 'null' format: guid libraryImportedHash: type: - string - 'null' maxLength: 256 minLength: 0 libraryImportedVersion: type: - string - 'null' maxLength: 256 minLength: 0 isDeleted: type: - boolean - 'null' agentTrigger: oneOf: - $ref: '#/components/schemas/AgentTrigger' apiKeyId: type: - string - 'null' format: guid isSeeded: type: boolean behaviours: type: - array - 'null' items: $ref: '#/components/schemas/AgentBehaviours' departmentId: type: - string - 'null' format: guid department: oneOf: - $ref: '#/components/schemas/Department' ownerId: type: - string - 'null' format: guid isEndUserPrivate: type: boolean systemAgent: type: boolean systemAgentId: type: - string - 'null' format: guid hideExecutionInternals: type: boolean saveToolResponsesToHistory: type: boolean deployment: oneOf: - $ref: '#/components/schemas/Deployment' EvaluatorSource: type: string description: '' x-enumNames: - Airia - AzureFoundry enum: - Airia - AzureFoundry UseCaseGovernanceFrameworkSnapshot: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - useCaseId - governanceFrameworkId properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 useCaseId: type: string format: guid minLength: 1 useCaseVersionId: type: - string - 'null' format: guid governanceFrameworkId: type: string format: guid minLength: 1 useCase: $ref: '#/components/schemas/UseCase' governanceFramework: $ref: '#/components/schemas/GovernanceFramework' definitionVersionId: type: - string - 'null' format: guid definitionVersion: oneOf: - $ref: '#/components/schemas/GovernanceFrameworkDefinitionVersion' MitigationStepCompletionSource: type: string description: '' x-enumNames: - Manual - Verified enum: - Manual - Verified QuickActionType: type: string description: '' x-enumNames: - Page - Selection - PageSource enum: - Page - Selection - PageSource AIModel: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false required: - priceType properties: category: oneOf: - $ref: '#/components/schemas/ModelCategory' outputModalities: type: - array - 'null' items: type: string modelParameters: type: array items: $ref: '#/components/schemas/ModelParameter' displayName: type: string modelName: type: - string - 'null' promptId: type: - string - 'null' format: guid systemPrompt: oneOf: - $ref: '#/components/schemas/Prompt' url: type: - string - 'null' type: $ref: '#/components/schemas/InputType' provider: $ref: '#/components/schemas/ProviderType' credentialsId: type: - string - 'null' format: guid oAuthProviderConfigId: type: - string - 'null' format: guid credentials: oneOf: - $ref: '#/components/schemas/Credentials' gatewayConfigurationId: type: - string - 'null' format: guid deploymentType: $ref: '#/components/schemas/DeploymentType' sourceType: $ref: '#/components/schemas/SourceType' connectionString: type: - string - 'null' containerName: type: - string - 'null' deployedKey: type: - string - 'null' deployedUrl: type: - string - 'null' state: oneOf: - $ref: '#/components/schemas/ModelState' uploadedContainerId: type: - string - 'null' format: guid libraryModelId: type: - string - 'null' format: guid inputTokenPrice: type: - number - 'null' format: decimal outputTokenPrice: type: - number - 'null' format: decimal tokenUnits: type: - integer - 'null' format: int32 hasToolSupport: type: boolean hasStreamSupport: type: boolean allowAiriaCredentials: type: boolean allowBYOKCredentials: type: boolean author: type: - string - 'null' priceType: $ref: '#/components/schemas/PriceType' routeThroughACC: type: boolean accGroup: type: - string - 'null' hasResponseSchemaSupport: type: boolean reasoning: type: boolean reasoningEffortLevels: type: - array - 'null' items: type: string requiresAdaptiveThinking: type: boolean supportsSearch: type: boolean supportsPromptCaching: type: boolean maxOutputTokens: type: - integer - 'null' format: int32 ConnectionAzureFoundry: type: object additionalProperties: false properties: projectEndpoint: type: string tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' evaluationsEnabled: type: boolean ConnectionSentinelOne: type: object additionalProperties: false properties: consoleUrl: type: - string - 'null' apiToken: type: - string - 'null' Classification: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid classificationName: type: string maxLength: 500 minLength: 0 required: type: boolean isActive: type: boolean type: $ref: '#/components/schemas/ClassificationType' classificationLabels: type: array items: $ref: '#/components/schemas/ClassificationLabel' classificationAssignments: type: array items: $ref: '#/components/schemas/ClassificationAssignment' tenantId: type: - string - 'null' format: guid RiskRegistryStatus: type: string description: '' x-enumNames: - PendingReview - Mitigate - Accept - Transfer - Avoid enum: - PendingReview - Mitigate - Accept - Transfer - Avoid RetryConfiguration: type: object additionalProperties: false properties: enabled: type: boolean maxRetries: type: integer format: int32 maximum: 100 minimum: 0 delay: type: integer format: int32 maximum: 300000 minimum: 1 maxDelay: type: integer format: int32 maximum: 600000 minimum: 1 backoffMultiplier: type: number format: double maximum: 10 minimum: 1 useJitter: type: boolean Group: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid identityServerGroupId: type: - string - 'null' name: type: string parentId: type: - string - 'null' format: guid parent: $ref: '#/components/schemas/Group' groupType: $ref: '#/components/schemas/GroupType' isIdpProvisioned: type: boolean createTenantEnabled: type: boolean totalUsers: type: integer format: int32 rolesList: type: array items: $ref: '#/components/schemas/Role' groupLeaderId: type: - string - 'null' format: guid projectIds: type: array items: type: string format: guid ToolPatchEntry: type: object additionalProperties: false properties: stepTitle: type: - string - 'null' toolInstanceId: type: - string - 'null' toolAggregateId: type: - string - 'null' configuration: oneOf: - $ref: '#/components/schemas/JsonNode' EuAiActCategory: type: string description: '' x-enumNames: - Prohibited - HighRisk - LimitedRisk - MinimalRisk - NotApplicable enum: - Prohibited - HighRisk - LimitedRisk - MinimalRisk - NotApplicable ConnectionLangGraph: type: object additionalProperties: false properties: apiKey: type: string url: type: string N8nOriginalNodeCredentials: type: object additionalProperties: false properties: nodeId: type: string credentials: type: - object - 'null' additionalProperties: {} BedrockGatewayConfiguration: type: object additionalProperties: false properties: modelId: type: string gatewayUrl: type: string gatewayApiKeyId: type: string providerType: type: string bedrockAgentId: type: - string - 'null' createdAt: type: string format: date-time BaseAuditEntity: type: object x-abstract: true additionalProperties: false properties: createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time userId: type: - string - 'null' format: guid AssessmentTemplateScope: type: string description: '' x-enumNames: - Organization - UseCase - Asset enum: - Organization - UseCase - Asset User: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid identityServerUserId: type: - string - 'null' identityServerIssuer: type: - string - 'null' email: type: string firstName: type: string lastName: type: string profileImageId: type: - string - 'null' format: guid enterprise: type: - string - 'null' phoneNumber: type: - string - 'null' isDisabled: type: boolean isDeleted: type: - boolean - 'null' groups: type: array items: $ref: '#/components/schemas/Group' roles: type: array items: $ref: '#/components/schemas/Role' lastTenantId: type: - string - 'null' format: guid userGroups: type: array items: $ref: '#/components/schemas/UserGroup' lastLogin: type: - string - 'null' format: date-time userDetails: type: - string - 'null' isIdpProvisioned: type: boolean isServiceAccount: type: boolean provisioningSource: oneOf: - $ref: '#/components/schemas/UserProvisioningSource' projects: type: array items: $ref: '#/components/schemas/Project' userSettings: type: - string - 'null' lastInviteSentDate: type: - string - 'null' format: date-time invitationExpirationDate: type: - string - 'null' format: date-time MitigationStepDefinition: type: object additionalProperties: false required: - name - whyValidMitigation - minimumRequirement properties: id: type: string format: guid name: type: string maxLength: 200 minLength: 1 whyValidMitigation: type: string minLength: 1 minimumRequirement: type: string minLength: 1 verifierKey: oneOf: - $ref: '#/components/schemas/MitigationVerifierKey' requiredCapabilities: type: array items: $ref: '#/components/schemas/MitigationCapability' controlFunction: oneOf: - $ref: '#/components/schemas/MitigationControlFunction' verifierTtlSeconds: type: - integer - 'null' format: int32 DataSourceFile: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: dataSourceId: type: string format: guid filePath: type: - string - 'null' inputToken: type: - string - 'null' processingStatus: $ref: '#/components/schemas/FileProcessingStatus' processingStartedAt: type: - string - 'null' format: date-time fileMetadataJson: type: - string - 'null' fileMetadata: oneOf: - $ref: '#/components/schemas/DataSourceFileMetadata' processingLogsJson: type: - string - 'null' processingLogs: oneOf: - $ref: '#/components/schemas/FileProcessingLogDetails' SubAgentOverrides: type: object additionalProperties: false properties: steps: type: object additionalProperties: $ref: '#/components/schemas/StepOverride' CampaignTargetKind: type: string description: '' x-enumNames: - PublishedPipelineVersion - ChangeScenario - ExternalHttp - SpmAgent - GatewayRoute enum: - PublishedPipelineVersion - ChangeScenario - ExternalHttp - SpmAgent - GatewayRoute GovernanceFrameworkDefinition: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - key - name - type properties: id: type: string format: guid key: type: string maxLength: 128 minLength: 1 name: type: string maxLength: 256 minLength: 1 type: type: string maxLength: 32 minLength: 1 jurisdiction: type: - string - 'null' maxLength: 128 currentVersionId: type: - string - 'null' format: guid currentVersion: oneOf: - $ref: '#/components/schemas/GovernanceFrameworkDefinitionVersion' isHidden: type: boolean versions: type: array items: $ref: '#/components/schemas/GovernanceFrameworkDefinitionVersion' AgentEvaluationDatasetConfiguration: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object x-abstract: true additionalProperties: false required: - tenantId - datasetId properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 datasetId: type: string format: guid minLength: 1 dataset: $ref: '#/components/schemas/AgentEvaluationDataset' AiAssetMetadataType: type: string description: '' x-enumNames: - DirectValue - SingleOption - MultipleOption enum: - DirectValue - SingleOption - MultipleOption MitigationStep: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - title - description properties: id: type: string format: guid riskMetadataId: type: string format: guid title: type: string maxLength: 200 minLength: 1 description: type: string maxLength: 2000 minLength: 1 callToAction: type: - string - 'null' maxLength: 200 controlId: type: - string - 'null' maxLength: 50 status: $ref: '#/components/schemas/MitigationStepStatus' mitigationStepDefinitionId: type: - string - 'null' format: guid definition: oneOf: - $ref: '#/components/schemas/MitigationStepDefinition' completionSource: oneOf: - $ref: '#/components/schemas/MitigationStepCompletionSource' completedByUserId: type: - string - 'null' format: guid completedByUser: oneOf: - $ref: '#/components/schemas/User' verificationEvidence: oneOf: - $ref: '#/components/schemas/MitigationVerificationEvidence' targetAssetAggregateId: type: - string - 'null' format: guid origin: oneOf: - $ref: '#/components/schemas/MitigationStepOrigin' tenantId: type: string format: guid GovernanceFramework: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - name - tenantId properties: id: type: string format: guid name: type: string maxLength: 256 minLength: 1 key: type: - string - 'null' maxLength: 128 isEnabled: type: boolean isHidden: type: boolean definitionId: type: - string - 'null' format: guid definition: oneOf: - $ref: '#/components/schemas/GovernanceFrameworkDefinition' tenantId: type: string format: guid minLength: 1 assessmentTemplates: type: array items: $ref: '#/components/schemas/AssessmentTemplate' ApiKeyScope: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - name properties: id: type: string format: guid name: $ref: '#/components/schemas/ApiKeyScopeName' UpdateMcpBindingsResult: type: object additionalProperties: false properties: pipelinesUpdated: type: integer format: int32 placeholdersApplied: type: integer format: int32 skippedPlaceholders: type: array items: type: string McpPlaceholderPreviewEntry: type: object additionalProperties: false properties: placeholderId: type: string format: guid name: type: string description: type: - string - 'null' isBound: type: boolean boundDeploymentId: type: - string - 'null' format: guid isNewInTargetVersion: type: boolean gatewayLibraryId: type: - string - 'null' format: guid authenticationType: type: - string - 'null' ExecutionStats: type: object additionalProperties: false properties: successCount: type: integer format: int32 failureCount: type: integer format: int32 AiAssetMetadataAssignment: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid aiAssetAggregateId: type: string format: guid aiAssetAggregate: $ref: '#/components/schemas/AiAssetAggregate' aiAssetMetadataDefinitionId: type: string format: guid aiAssetMetadataDefinition: $ref: '#/components/schemas/AiAssetMetadataDefinition' aiAssetMetadataDefinitionOptionId: type: - string - 'null' format: guid aiAssetMetadataDefinitionOption: oneOf: - $ref: '#/components/schemas/AiAssetMetadataDefinitionOption' assetType: $ref: '#/components/schemas/AiAssetType' value: type: - string - 'null' maxLength: 4000 minLength: 0 version: type: - string - 'null' maxLength: 100 minLength: 0 tenantId: type: string format: guid GatewayRuleEntity: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: gatewayConfigurationId: type: string format: guid gatewayConfiguration: oneOf: - $ref: '#/components/schemas/GatewayConfigurationEntity' name: type: string priority: type: integer format: int32 conditionId: type: string format: guid condition: oneOf: - $ref: '#/components/schemas/RuleConditionEntity' allConditions: type: array items: $ref: '#/components/schemas/RuleConditionEntity' actions: type: array items: $ref: '#/components/schemas/RuleActionEntity' behavior: type: string syncParameterId: type: - string - 'null' format: guid origin: type: - string - 'null' sourceRef: type: - string - 'null' displayName: type: - string - 'null' FileProcessingStatus: type: string description: '' x-enumNames: - Pending - Processing - Processed - Failed enum: - Pending - Processing - Processed - Failed DatasourceState: type: string description: '' x-enumNames: - Unknown - Pending - Validating - Ingesting - Storing - Indexing - Finished - Failed - Validated - Ingested - Stored - Indexed enum: - Unknown - Pending - Validating - Ingesting - Storing - Indexing - Finished - Failed - Validated - Ingested - Stored - Indexed ClassificationLabel: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid labelName: type: string maxLength: 500 minLength: 0 classificationId: type: string format: guid classification: $ref: '#/components/schemas/Classification' isDefaultValue: type: boolean tenantId: type: - string - 'null' format: guid priority: type: integer format: int32 QuickAction: type: object additionalProperties: false properties: id: type: string displayName: type: string quickActionType: $ref: '#/components/schemas/QuickActionType' initialMessage: type: - string - 'null' assignedAgent: oneOf: - $ref: '#/components/schemas/AssignedAgent' targetDomains: type: - array - 'null' items: type: string SecurePostureStatus: type: string description: '' x-enumNames: - NotSecured - Secured - PartiallySecured - NotSecurableSecurePostureProvider - NotSecurableAiProvider - NotSecurableAiModel - NoAiService enum: - NotSecured - Secured - PartiallySecured - NotSecurableSecurePostureProvider - NotSecurableAiProvider - NotSecurableAiModel - NoAiService EvalSuite: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - source - externalSuiteId - name properties: id: type: string format: guid tenantId: type: - string - 'null' format: guid source: $ref: '#/components/schemas/EvaluatorSource' spmConnectionId: type: - string - 'null' format: guid spmConnection: oneOf: - $ref: '#/components/schemas/SpmConnection' externalSuiteId: type: string maxLength: 64 minLength: 1 name: type: string maxLength: 128 minLength: 1 description: type: - string - 'null' maxLength: 512 isEnabled: type: boolean isHidden: type: boolean refreshedAt: type: string format: date-time evaluators: type: array items: $ref: '#/components/schemas/EvalSuiteEvaluator' AiAssetType: type: string description: '' x-enumNames: - InternalModel - InternalDataSource - InternalTools - InternalAgent - InternalProject - InternalMcpServer - ExternalModel - UseCase - ExternalAgent - GovernanceAgent - ExternalApplication - InternalApplication - EndpointApp - EndpointMcpServer - ExternalDataSource enum: - InternalModel - InternalDataSource - InternalTools - InternalAgent - InternalProject - InternalMcpServer - ExternalModel - UseCase - ExternalAgent - GovernanceAgent - ExternalApplication - InternalApplication - EndpointApp - EndpointMcpServer - ExternalDataSource StepPromptSegment: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: stepId: type: string format: guid promptId: type: string format: guid selectedPromptVersionId: type: string format: guid order: type: integer format: int32 isVersionPinned: type: boolean prompt: $ref: '#/components/schemas/Prompt' selectedPromptVersion: $ref: '#/components/schemas/PromptVersion' isAgentSpecific: type: boolean StepType: type: string description: '' x-enumNames: - AIOperation - DataSearch - ExecutePipelineStep - InputStep - MachineLearningOperationStep - MemoryLoadStep - MemoryStoreStep - OutputStep - PythonStep - Exception - RouterStep - AnnotationStep - ApprovalStep - WebhookApprovalStep - ToolActionStep - AgentCardStep - ConditionalBranchStep - LoopContainerStep - LoopStartStep - LoopEndStep - JsonFormatterStep - SdkStep - CustomFormHumanApprovalStep - ImageGenerationStep - DocumentSplitterStep enum: - AIOperation - dataSearch - executePipelineStep - inputStep - machineLearningOperationStep - memoryLoadStep - memoryStoreStep - outputStep - pythonStep - exception - routerStep - annotationStep - approvalStep - webhookApprovalStep - toolActionStep - agentCardStep - conditionalBranchStep - loopContainerStep - loopStartStep - loopEndStep - jsonFormatterStep - sdkStep - customFormHumanApprovalStep - imageGenerationStep - documentSplitterStep ScenarioOverrides: type: object discriminator: propertyName: kind mapping: Internal: '#/components/schemas/InternalScenarioOverrides' External: '#/components/schemas/ExternalScenarioOverrides' x-abstract: true additionalProperties: false required: - kind properties: modelOverride: oneOf: - $ref: '#/components/schemas/ModelOverride' toolOverrides: oneOf: - $ref: '#/components/schemas/ToolPatch' kind: type: string SpmAgentType: type: string description: '' x-enumNames: - Agent - Flow - Workflow x-enum-descriptions: - A conversational AI agent that maintains context across turns. Supports multi-turn Red Teaming campaigns (e.g. AWS Bedrock Agent, Copilot Studio Bot). - A deterministic automation flow. Stateless — each invocation is independent with no conversation history (e.g. AWS Bedrock Flow, Copilot Studio Power Automate flow). - A workflow automation. Stateless with no conversation context support (e.g. N8n workflow). enum: - Agent - Flow - Workflow UpdateProvisionedPipelinePrivacyRequest: type: object additionalProperties: false properties: isEndUserPrivate: type: boolean SubdomainApplicability: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid riskProfileId: type: string format: guid riskSubDomainId: type: string format: guid applicable: type: boolean confidence: type: - string - 'null' maxLength: 50 rationale: type: - string - 'null' maxLength: 2000 inherentImpact: type: - integer - 'null' format: int32 inherentLikelihood: type: - integer - 'null' format: int32 inherentScore: type: - integer - 'null' format: int32 residualImpact: type: - integer - 'null' format: int32 residualLikelihood: type: - integer - 'null' format: int32 residualScore: type: - integer - 'null' format: int32 inherentExposure: type: - integer - 'null' format: int32 inherentAutonomy: type: - integer - 'null' format: int32 inherentOpFrequency: type: - integer - 'null' format: int32 inherentInputSurface: type: - integer - 'null' format: int32 residualExposure: type: - integer - 'null' format: int32 residualAutonomy: type: - integer - 'null' format: int32 residualOpFrequency: type: - integer - 'null' format: int32 residualInputSurface: type: - integer - 'null' format: int32 inherentUnknownFieldsJson: type: - string - 'null' residualUnknownFieldsJson: type: - string - 'null' SystemAgentVersionEntryDto: type: object additionalProperties: false properties: version: type: string releasedAt: type: string format: date-time deprecatedAt: type: - string - 'null' format: date-time retiredAt: type: - string - 'null' format: date-time isDeprecated: type: boolean isRetired: type: boolean isCurrent: type: boolean summary: type: - string - 'null' changes: type: - array - 'null' items: type: string AdministrativeScope: type: string description: '' x-enumNames: - Tenant - Project - Personal enum: - Tenant - Project - User AssessmentTemplateVersionStatus: type: string description: '' x-enumNames: - Processing - Completed - Failed enum: - Processing - Completed - Failed SystemAgentSubAgentDto: type: object additionalProperties: false properties: agentId: type: string format: guid name: type: string group: type: - string - 'null' steps: type: array items: $ref: '#/components/schemas/SystemAgentStepDto' GatewayResilienceTargetEntity: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false properties: resilienceRuleId: type: string format: guid name: type: string order: type: integer format: int32 weight: type: integer format: int32 timeoutInSeconds: type: - integer - 'null' format: int32 httpStatusCodes: type: - array - 'null' items: type: integer format: int32 failureThreshold: type: - integer - 'null' format: int32 failureRateThreshold: type: - number - 'null' format: decimal timespanWindowInSeconds: type: - integer - 'null' format: int32 cooldownSeconds: type: - integer - 'null' format: int32 actions: type: array items: $ref: '#/components/schemas/RuleActionEntity' ModelParameter: type: object additionalProperties: false properties: id: type: string format: guid name: type: string maxLength: 100 minLength: 0 value: {} location: $ref: '#/components/schemas/ParameterLocation' dataType: $ref: '#/components/schemas/ParameterDataType' modelId: type: string format: guid UseCaseEvaluationSelection: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - useCaseId - agentEvaluationId - source - selectedAt properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 useCaseId: type: string format: guid minLength: 1 agentEvaluationId: type: string format: guid minLength: 1 source: $ref: '#/components/schemas/UseCaseEvaluationSelectionSource' selectedAt: type: string format: date-time selectedByUserId: type: - string - 'null' format: guid useCase: $ref: '#/components/schemas/UseCase' agentEvaluation: $ref: '#/components/schemas/AgentEvaluation' SystemAgentDetailDto: type: object additionalProperties: false properties: systemAgentId: type: string format: guid name: type: string description: type: string isEnabled: type: boolean isEnabledByDefault: type: boolean hideExecutionInternals: type: boolean steps: type: array items: $ref: '#/components/schemas/SystemAgentStepDto' memoryDefinitions: type: array items: $ref: '#/components/schemas/SystemAgentMemoryDefinitionDto' overrides: oneOf: - $ref: '#/components/schemas/SystemAgentOverrides' subAgents: type: - array - 'null' items: $ref: '#/components/schemas/SystemAgentSubAgentDto' exportDefinition: {} versionStatus: oneOf: - $ref: '#/components/schemas/SystemAgentVersionStatusDto' provisionedPipelineId: type: - string - 'null' format: guid provisionedFromVersion: type: - string - 'null' provisionedProjectId: type: - string - 'null' format: guid provisionedProjectName: type: - string - 'null' allowProvision: type: boolean requireProvision: type: boolean suggestedProjectName: type: - string - 'null' exclusiveProject: type: boolean autoCreateProject: type: boolean hideProject: type: boolean activeVersion: type: - string - 'null' viewingVersion: type: - string - 'null' isPreviewMode: type: boolean pendingRequiredOverrides: type: integer format: int32 ResourcePreviewEntry: type: object additionalProperties: false properties: resourceType: type: string definitionId: type: string format: guid displayName: type: string action: type: string matchedExistingEntityId: type: - string - 'null' format: guid matchedExistingEntityName: type: - string - 'null' SystemAgentStepMcpPlaceholderDto: type: object additionalProperties: false required: - name properties: id: type: string format: guid name: type: string description: type: - string - 'null' gatewayLibraryId: type: - string - 'null' format: guid authenticationType: type: - string - 'null' AiAssetMetadataValueType: type: string description: '' x-enumNames: - Text - Number - Boolean - DateTime - User enum: - Text - Number - Boolean - DateTime - User SystemAgentStepDto: type: object additionalProperties: false properties: id: type: string format: guid stepTitle: type: string stepType: type: string defaultModelId: type: - string - 'null' format: guid defaultModelName: type: - string - 'null' defaultModelProvider: type: - string - 'null' tools: type: - array - 'null' items: $ref: '#/components/schemas/SystemAgentStepToolDto' supportsModelOverride: type: boolean supportsCredentialOverride: type: boolean supportsDataSourceOverride: type: boolean supportsPromptOverride: type: boolean defaultPromptText: type: - string - 'null' defaultDataSourceId: type: - string - 'null' format: guid defaultDataSourceName: type: - string - 'null' requiresDataSourceOverride: type: boolean mcpPlaceholders: type: - array - 'null' items: $ref: '#/components/schemas/SystemAgentStepMcpPlaceholderDto' GatewayConfigurationEntity: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false properties: name: type: string maxLength: 128 description: type: string maxLength: 512 enabled: type: boolean complexityRoutingEnabled: type: - boolean - 'null' taskTypeRoutingEnabled: type: - boolean - 'null' conversationFloorRoutingEnabled: type: - boolean - 'null' maxActiveApiKeys: type: - integer - 'null' format: int32 providerConfigurations: type: array items: $ref: '#/components/schemas/GatewayProviderConfigurationEntity' apiKeys: type: array items: $ref: '#/components/schemas/GatewayApiKeyEntity' rules: type: array items: $ref: '#/components/schemas/GatewayRuleEntity' resilienceRules: type: array items: $ref: '#/components/schemas/GatewayResilienceRuleEntity' rulesIncludeSyncOwned: type: boolean ConnectionGlean: type: object additionalProperties: false properties: instance: type: string apiToken: type: string N8nCredentialsForAiriaGateway: type: object additionalProperties: false properties: n8nCredentialId: type: string n8nCredentialName: type: string n8nCredentialType: type: string n8nNodeType: type: string airiaGatewayUrl: type: string airiaGatewayConfigurationId: type: string format: guid airiaApiKeyId: type: string format: guid AssessmentTemplateVersion: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - templateId - name - description properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 templateId: type: string format: guid minLength: 1 name: type: string maxLength: 256 minLength: 1 description: type: string maxLength: 2000 minLength: 1 versionNumber: type: integer format: int32 isDraft: type: boolean templateStructure: type: - string - 'null' questionCount: type: integer format: int32 status: $ref: '#/components/schemas/AssessmentTemplateVersionStatus' failureReason: type: - string - 'null' maxLength: 2000 template: $ref: '#/components/schemas/AssessmentTemplate' ModelCategory: type: string description: '' x-enumNames: - Multimodal - ComputerVision - NLP - ReinforcementLearning - Embedding - ImageGeneration - MachineLearning - Voice - Reranker - VideoGeneration enum: - Multimodal - ComputerVision - NLP - ReinforcementLearning - Embedding - ImageGeneration - MachineLearning - Voice - Reranker - VideoGeneration DeploymentAssignments: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: deploymentId: type: string format: guid id: type: string format: guid entityId: type: string format: guid entityType: type: string PaginatedPipelineDto: allOf: - $ref: '#/components/schemas/Pipeline' - type: object additionalProperties: false properties: versions: type: array items: $ref: '#/components/schemas/PipelineVersion' deploymentId: type: - string - 'null' format: guid deploymentName: type: - string - 'null' deploymentDescription: type: - string - 'null' slackBotDeploymentId: type: - string - 'null' format: guid teamDeploymentId: type: - string - 'null' format: guid whatsAppBotDeploymentId: type: - string - 'null' format: guid allDeployments: type: array items: $ref: '#/components/schemas/DeploymentInfo' userKeys: type: object additionalProperties: type: string groupKeys: type: object additionalProperties: type: string agentIcon: type: - string - 'null' external: type: boolean ownerDisplayName: type: - string - 'null' SupportedInputMode: type: string description: '' x-enumNames: - FileUpload - Whiteboard - Code - Math enum: - FileUpload - Whiteboard - Code - Math MitigationControlFunction: type: string description: '' x-enumNames: - Prevent - Detect - Respond enum: - Prevent - Detect - Respond PipelineStepPosition: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: x: type: number format: float y: type: number format: float pipelineStepId: type: string format: guid MitigationVerificationTrigger: type: string description: '' x-enumNames: - Event - Creation - Manual - Scheduled - ResidualRecompute - WorkStarted enum: - Event - Creation - Manual - Scheduled - ResidualRecompute - WorkStarted JsonNode: type: object x-abstract: true additionalProperties: false properties: underlyingElement: {} options: oneOf: - $ref: '#/components/schemas/JsonNodeOptions' parent: oneOf: - $ref: '#/components/schemas/JsonNode' root: $ref: '#/components/schemas/JsonNode' UpdateProvisionedToolConfigurationRequest: type: object additionalProperties: false required: - stepId - toolIds properties: stepId: type: string format: guid toolIds: type: array items: type: string format: guid toolParams: type: - object - 'null' additionalProperties: type: string mcpServerDeploymentIds: type: - array - 'null' items: type: string format: guid mcpServerDeploymentParams: type: - object - 'null' additionalProperties: type: string UpgradeProvisionedAgentRequest: type: object additionalProperties: false properties: targetVersion: type: - string - 'null' mcpServerMappings: type: - object - 'null' additionalProperties: type: - string - 'null' format: guid GatewayProviders: type: string description: '' x-enumNames: - Unknown - OpenAI - Anthropic - Gemini - Ollama - AzureFoundry - AwsBedrock - TogetherAI - Replicate - GoogleVertex enum: - Unknown - OpenAI - Anthropic - Gemini - Ollama - AzureFoundry - AwsBedrock - TogetherAI - Replicate - GoogleVertex RiskRegistryType: type: string description: '' x-enumNames: - UseCase enum: - UseCase AiAssetUsage: type: object x-abstract: true additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid assetId: type: string format: guid asset: oneOf: - $ref: '#/components/schemas/AiAssetAggregate' assetType: $ref: '#/components/schemas/AiAssetType' parentType: $ref: '#/components/schemas/AiAssetType' parentId: type: - string - 'null' format: guid parentInternalId: type: - string - 'null' format: guid sourceType: $ref: '#/components/schemas/AiAssetSourceType' timeReference: type: - string - 'null' format: date-time status: $ref: '#/components/schemas/AiAssetUsageStatus' assetName: type: string SystemAgentDelegateSource: type: string description: '' x-enumNames: - Managed - Custom enum: - Managed - Custom GovernanceFrameworkReleaseState: type: string description: '' x-enumNames: - Draft - Preview - Ready - Retired enum: - Draft - Preview - Ready - Retired AzureFoundryAuthMethod: type: string description: '' x-enumNames: - ApiKey - EntraId - GcpServiceAccount enum: - ApiKey - EntraId - GcpServiceAccount RiskDomain: type: object additionalProperties: false required: - name properties: id: type: string format: guid name: type: string maxLength: 200 minLength: 1 color: type: - string - 'null' maxLength: 20 displayOrder: type: integer format: int32 subDomains: type: array items: $ref: '#/components/schemas/RiskSubDomain' UseCaseStatus: type: string description: '' x-enumNames: - Approved - Rejected enum: - Approved - Rejected SystemAgentMetadataDto: type: object additionalProperties: false properties: systemAgentId: type: string format: guid name: type: string description: type: string isEnabled: type: boolean isEnabledByDefault: type: boolean hideExecutionInternals: type: boolean hasOverrides: type: boolean currentVersion: type: - string - 'null' pinnedVersion: type: - string - 'null' hasUpdateAvailable: type: boolean isProvisioned: type: boolean allowProvision: type: boolean BrowserExtensionConfig: type: object additionalProperties: false properties: type: type: string quickActions: type: array items: $ref: '#/components/schemas/QuickAction' UseCaseRegisterTemplateSnapshot: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - useCaseId - assessmentTemplateId properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 useCaseId: type: string format: guid minLength: 1 assessmentTemplateId: type: string format: guid minLength: 1 useCase: $ref: '#/components/schemas/UseCase' assessmentTemplate: $ref: '#/components/schemas/AssessmentTemplate' RiskControl: type: object additionalProperties: false required: - controlId - name properties: id: type: string format: guid controlGroupId: type: string format: guid controlId: type: string maxLength: 50 minLength: 1 name: type: string maxLength: 500 minLength: 1 controlGroup: oneOf: - $ref: '#/components/schemas/RiskControlGroup' JsonNodeOptions: type: object additionalProperties: false properties: propertyNameCaseInsensitive: type: boolean UseCaseReviewPolicy: type: object additionalProperties: false properties: disclaimerText: type: - string - 'null' reviewCadence: type: - string - 'null' nextReviewDate: type: - string - 'null' format: date-time ConnectionZscaler: type: object additionalProperties: false properties: vanityDomain: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' PinVersionRequest: type: object additionalProperties: false properties: version: type: - string - 'null' Prompt: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false properties: activeVersionId: type: - string - 'null' format: guid name: type: - string - 'null' maxLength: 256 minLength: 0 versions: type: array items: $ref: '#/components/schemas/PromptVersion' activeVersion: oneOf: - $ref: '#/components/schemas/PromptVersion' isAgentSpecific: type: boolean isDeleted: type: - boolean - 'null' ProviderType: type: string description: '' x-enumNames: - OpenAI - Ollama - Azure - HuggingFace - Anthropic - AzureAIStudio - OpenVINO - PyTorch - Replicate - Stability - Mistral - Perplexity - WatsonAix - Ai21 - Cohere - Google - TogetherAI - XAI - Bedrock - Compass - AzureML - Unknown - Alibaba - GenericOpenAI - GenericAnthropic - GoogleVertex enum: - OpenAI - Ollama - Azure - Hugging Face - Anthropic - AzureAIStudio - OpenVINO - PyTorch - Replicate - Stability - Mistral - Perplexity - WatsonAix - AI21 - Cohere - Google - Together AI - xAI - Amazon Bedrock - Compass - AzureML - Unknown - Alibaba - GenericOpenAI - GenericAnthropic - Google Vertex AI UseCaseEvaluationSelectionSource: type: string description: '' x-enumNames: - Manual - CreatedFromUseCase - Automation - LegacyAuto enum: - Manual - CreatedFromUseCase - Automation - LegacyAuto MigrateDeploymentRequest: type: object additionalProperties: false properties: deploymentId: type: string format: guid projectId: type: - string - 'null' format: guid enabledDelegateIds: type: - array - 'null' items: type: string format: guid previousDeploymentId: type: - string - 'null' format: guid GatewayApiKeyEntity: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false properties: apiKey: type: string maxLength: 128 apiKeyFingerprint: type: string maxLength: 64 enabled: type: boolean gatewayConfigurationId: type: string format: guid gatewayConfiguration: $ref: '#/components/schemas/GatewayConfigurationEntity' resourceId: type: - string - 'null' format: guid type: $ref: '#/components/schemas/GatewayApiKeyType' agentName: type: - string - 'null' maxLength: 128 origin: oneOf: - $ref: '#/components/schemas/GatewayApiKeyOrigin' expiresAt: type: - string - 'null' format: date-time UseCaseCore: type: object additionalProperties: false properties: summary: type: - string - 'null' tags: type: array items: type: string AgentTriggerAllowedType: type: string description: '' x-enumNames: - Unrestricted - Domains - Emails enum: - Unrestricted - Domains - Emails AgentEvaluation: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - evaluationName - evaluationType properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 evaluationName: type: string maxLength: 128 minLength: 1 description: type: - string - 'null' maxLength: 512 pipelineVersionIds: type: array items: type: string format: guid agentEvaluationTargets: type: array items: $ref: '#/components/schemas/AgentEvaluationTarget' datasetIds: type: array items: type: string format: guid spmAgentIds: type: array items: type: string format: guid agentEvaluationToSpmAgents: type: array items: $ref: '#/components/schemas/AgentEvaluationSpmAgent' agentEvaluationToEvaluators: type: array items: $ref: '#/components/schemas/AgentEvaluationEvaluator' dataset: type: array items: $ref: '#/components/schemas/AgentEvaluationDataset' modelId: type: - string - 'null' format: guid evaluatorSource: oneOf: - $ref: '#/components/schemas/EvaluatorSource' spmConnectionId: type: - string - 'null' format: guid spmConnection: oneOf: - $ref: '#/components/schemas/SpmConnection' modelIdentifierType: $ref: '#/components/schemas/ModelIdentifierType' evaluationType: $ref: '#/components/schemas/EvaluationType' runsPerTestCase: type: - integer - 'null' format: int32 baselineEvaluationId: type: - string - 'null' format: guid variants: type: - array - 'null' items: $ref: '#/components/schemas/AgentEvaluationVariant' comparisonSetId: type: - string - 'null' format: guid baselineMode: $ref: '#/components/schemas/WhatIfBaselineMode' accuracyThreshold: type: - integer - 'null' format: int32 biasThreshold: type: - number - 'null' format: double driftThreshold: type: - integer - 'null' format: int32 scheduleId: type: - string - 'null' format: guid schedule: oneOf: - $ref: '#/components/schemas/AgentEvaluationSchedule' originSource: type: - string - 'null' maxLength: 256 originId: type: - string - 'null' format: guid originContext: type: - object - 'null' additionalProperties: type: string ConversationType: type: string description: '' x-enumNames: - StandardChat - ImageOnly - FileOnly enum: - StandardChat - ImageOnly - FileOnly UseCase: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - name - stage properties: id: type: string format: guid tenantId: type: - string - 'null' format: guid name: type: string maxLength: 200 minLength: 0 stage: $ref: '#/components/schemas/UseCaseStage' description: type: - string - 'null' ownerId: type: - string - 'null' format: guid reviewerId: type: - string - 'null' format: guid impacted: type: - string - 'null' maxLength: 500 minLength: 0 reviewedAt: type: - string - 'null' format: date-time contextChangedAt: type: - string - 'null' format: date-time registerTemplatesPinnedAt: type: - string - 'null' format: date-time riskDomainId: type: - string - 'null' format: guid riskSubDomainId: type: - string - 'null' format: guid autonomy: oneOf: - $ref: '#/components/schemas/UseCaseAutonomy' status: oneOf: - $ref: '#/components/schemas/UseCaseStatus' acceptsAssetUpdates: type: boolean hasAutoGeneratedName: type: boolean core: oneOf: - $ref: '#/components/schemas/UseCaseCore' intendedUse: oneOf: - $ref: '#/components/schemas/UseCaseIntendedUse' reviewPolicy: oneOf: - $ref: '#/components/schemas/UseCaseReviewPolicy' registerFactAnswers: type: object additionalProperties: type: string receiptJson: type: - string - 'null' nutritionLabelJson: type: - string - 'null' activeVersionId: type: - string - 'null' format: guid approvedVersionId: type: - string - 'null' format: guid rowVersion: type: integer activeVersion: oneOf: - $ref: '#/components/schemas/UseCaseVersion' approvedVersion: oneOf: - $ref: '#/components/schemas/UseCaseVersion' reviewer: oneOf: - $ref: '#/components/schemas/User' riskDomain: oneOf: - $ref: '#/components/schemas/RiskDomain' riskSubDomain: oneOf: - $ref: '#/components/schemas/RiskSubDomain' assignedAssets: type: array items: $ref: '#/components/schemas/AiAssetAggregate' assetAssignments: type: array items: $ref: '#/components/schemas/UseCaseAssetAssignment' artifacts: type: array items: $ref: '#/components/schemas/GovernanceArtifact' frameworkSnapshots: type: array items: $ref: '#/components/schemas/UseCaseGovernanceFrameworkSnapshot' registerTemplateSnapshots: type: array items: $ref: '#/components/schemas/UseCaseRegisterTemplateSnapshot' evaluationSelections: type: array items: $ref: '#/components/schemas/UseCaseEvaluationSelection' ModelOverride: type: object additionalProperties: false properties: modelId: type: string identifierType: $ref: '#/components/schemas/ModelIdentifierType' ConnectionDatabricks: type: object additionalProperties: false properties: workspaceUrl: type: string accessToken: type: string FileProcessingLogDetails: type: object additionalProperties: false properties: timestamp: type: string format: date-time message: type: string ConnectionMicrosoftGraph: type: object additionalProperties: false properties: tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' maxUsers: type: - integer - 'null' format: int32 RiskSubDomainControl: type: object additionalProperties: false properties: id: type: string format: guid riskSubDomainId: type: string format: guid riskControlId: type: string format: guid displayOrder: type: integer format: int32 riskSubDomain: oneOf: - $ref: '#/components/schemas/RiskSubDomain' riskControl: oneOf: - $ref: '#/components/schemas/RiskControl' NistAiRmfTier: type: string description: '' x-enumNames: - Tier1 - Tier2 - Tier3 - Tier4 - Tier5 - NotApplicable enum: - Tier1 - Tier2 - Tier3 - Tier4 - Tier5 - NotApplicable CreateProvisionedPromptSegmentRequest: type: object additionalProperties: false required: - stepId - name - promptMessage properties: stepId: type: string format: guid minLength: 1 name: type: string maxLength: 256 minLength: 0 promptMessage: type: string minLength: 1 order: type: integer format: int32 Deployment: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: pipelineId: type: string format: guid name: type: string maxLength: 256 minLength: 0 description: type: string deploymentUserPrompts: type: array items: $ref: '#/components/schemas/DeploymentUserPrompt' deploymentPrompt: oneOf: - $ref: '#/components/schemas/DeploymentPrompt' projectId: type: string format: guid isRecommended: type: boolean deploymentType: $ref: '#/components/schemas/AgentDeploymentType' conversationType: $ref: '#/components/schemas/ConversationType' externalOAuthCredentialId: type: - string - 'null' format: guid about: oneOf: - $ref: '#/components/schemas/AboutDeploymentMetadata' isDeployedViaAssistants: type: boolean assignments: type: - array - 'null' items: $ref: '#/components/schemas/DeploymentAssignments' targetAgents: type: array items: $ref: '#/components/schemas/DeploymentTargetAgent' supportedInputModes: type: array items: $ref: '#/components/schemas/SupportedInputMode' browserExtensionConfig: oneOf: - $ref: '#/components/schemas/BrowserExtensionConfig' teamsManifestCustomization: oneOf: - $ref: '#/components/schemas/TeamsManifestCustomizationConfig' displayConsumptionInfo: type: boolean greetingMessage: type: - string - 'null' AgentEvaluationSpmAgent: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 agentEvaluationId: type: string format: guid agentEvaluation: $ref: '#/components/schemas/AgentEvaluation' spmAgentId: type: string format: guid spmAgent: $ref: '#/components/schemas/SpmAgent' BaseEntity: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object x-abstract: true additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid projectId: type: string format: guid Assessment: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - aiAssetAggregateId - name - templateId - templateVersionId - version - status - approverId properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 aiAssetAggregateId: type: string format: guid minLength: 1 name: type: string maxLength: 256 minLength: 1 templateId: type: string format: guid minLength: 1 templateVersionId: type: string format: guid minLength: 1 version: type: string maxLength: 50 minLength: 1 status: $ref: '#/components/schemas/AssessmentStatus' lastCompletedAt: type: - string - 'null' format: date-time approverId: type: string format: guid minLength: 1 responses: type: - string - 'null' fileId: type: - string - 'null' maxLength: 100 template: oneOf: - $ref: '#/components/schemas/AssessmentTemplate' templateVersion: oneOf: - $ref: '#/components/schemas/AssessmentTemplateVersion' aiAssetAggregate: oneOf: - $ref: '#/components/schemas/AiAssetAggregate' originSource: type: - string - 'null' maxLength: 256 originId: type: - string - 'null' format: guid originContext: type: - object - 'null' additionalProperties: type: string SystemAgentStepToolDto: type: object additionalProperties: false properties: id: type: string format: guid name: type: string supportsCredentialOverride: type: boolean credentialType: type: - string - 'null' requiresCredentialOverride: type: boolean DataSource: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false required: - name properties: executionName: type: - string - 'null' maxLength: 256 minLength: 0 state: $ref: '#/components/schemas/DatasourceState' chunkingConfigId: type: - string - 'null' format: guid chunkingConfig: $ref: '#/components/schemas/ChunkingConfig' dataSourceType: type: string databaseType: type: string pineconeApiKey: type: - string - 'null' pineconeIndexName: type: - string - 'null' embeddingProvider: $ref: '#/components/schemas/EmbeddingProviderType' isUserSpecific: type: boolean isImageProcessingEnabled: type: boolean customImageProcessingPrompt: type: string files: type: - array - 'null' items: $ref: '#/components/schemas/DataSourceFile' fileCount: type: - integer - 'null' format: int32 dataSourceGroupId: type: - string - 'null' format: guid dataSourceGroup: oneOf: - $ref: '#/components/schemas/DataSourceGroup' configurationJson: type: string credentialsId: type: - string - 'null' format: guid tableDocumentProcessingMode: oneOf: - $ref: '#/components/schemas/TableDocumentProcessingMode' sourceType: $ref: '#/components/schemas/SourceType' lastIngested: type: - string - 'null' format: date-time agentTrigger: oneOf: - $ref: '#/components/schemas/AgentTrigger' isDeleted: type: - boolean - 'null' name: type: string minLength: 1 AgentEvaluationVariant: type: object additionalProperties: false properties: variantId: type: string format: guid label: type: string isBaseline: type: boolean overrides: oneOf: - $ref: '#/components/schemas/ExternalScenarioOverrides' SpmConnection: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - name - securePostureProvider - connectionJson properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 name: type: string minLength: 1 securePostureProvider: $ref: '#/components/schemas/SecurePostureProvider' connectionJson: type: string minLength: 1 connection: oneOf: - $ref: '#/components/schemas/ConnectionConfiguration' isDeleted: type: - boolean - 'null' spmAgents: type: array items: $ref: '#/components/schemas/SpmAgent' analysisRuns: type: array items: $ref: '#/components/schemas/SpmAppIntegrationAnalysisRun' Iso42001Level: type: string description: '' x-enumNames: - Level1 - Level2 - Level3 - Level4 - Level5 - NotApplicable enum: - Level1 - Level2 - Level3 - Level4 - Level5 - NotApplicable DeploymentInfo: type: object additionalProperties: false properties: id: type: string format: guid deploymentType: $ref: '#/components/schemas/AgentDeploymentType' pipelineId: type: string format: guid AssessmentStatus: type: string description: '' x-enumNames: - Draft - Pending - Approved - Rejected - AutoComplete - ReadyForReview - AutoCompleteFailed enum: - Draft - Pending - Approved - Rejected - AutoComplete - ReadyForReview - AutoCompleteFailed SourceType: type: string description: '' x-enumNames: - UserProvided - Library enum: - userProvided - library AssessmentTemplateSubCategory: type: string description: '' x-enumNames: - Impact - Risk - Vendor - Register enum: - Impact - Risk - Vendor - Register ConnectionMicrosoftDefenderXdr: type: object additionalProperties: false properties: tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' maxUsers: type: - integer - 'null' format: int32 RiskProfile: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid useCaseRiskClassificationId: type: string format: guid riskClassification: oneOf: - $ref: '#/components/schemas/UseCaseRiskClassification' governanceScoreInherent: type: - integer - 'null' format: int32 governanceScoreResidual: type: - integer - 'null' format: int32 governanceLevel: type: - string - 'null' maxLength: 50 inherentStaleAt: type: - string - 'null' format: date-time residualStaleAt: type: - string - 'null' format: date-time regulatoryRisks: type: array items: $ref: '#/components/schemas/RegulatoryRisk' subdomainApplicabilities: type: array items: $ref: '#/components/schemas/SubdomainApplicability' PipelineStepDependency: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: pipelineStepId: type: string format: guid parentId: type: string format: guid parentHandleId: type: string format: guid handleId: type: string format: guid ProvisionSystemAgentRequest: type: object additionalProperties: false properties: projectId: type: - string - 'null' format: guid enabledDelegateIds: type: - array - 'null' items: type: string format: guid mcpServerMappings: type: - object - 'null' additionalProperties: type: string format: guid toolCredentialMappings: type: - object - 'null' additionalProperties: type: string format: guid SystemAgentUpgradePreviewDto: type: object additionalProperties: false properties: currentVersion: type: string targetVersion: type: string agent: oneOf: - $ref: '#/components/schemas/AgentUpgradePreviewEntry' subAgents: type: array items: $ref: '#/components/schemas/AgentUpgradePreviewEntry' removedSubAgents: type: array items: $ref: '#/components/schemas/AgentUpgradePreviewEntry' resources: type: array items: $ref: '#/components/schemas/ResourcePreviewEntry' manifestChanges: type: array items: type: string overridesCompatible: type: boolean incompatibleOverrideKeys: type: array items: type: string allMcpPlaceholders: type: array items: $ref: '#/components/schemas/McpPlaceholderPreviewEntry' newMcpPlaceholders: type: array items: $ref: '#/components/schemas/McpPlaceholderPreviewEntry' GovernanceFrameworkDefinitionVersion: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - definitionId - version - releaseState properties: id: type: string format: guid definitionId: type: string format: guid minLength: 1 definition: $ref: '#/components/schemas/GovernanceFrameworkDefinition' version: type: integer format: int32 releaseState: $ref: '#/components/schemas/GovernanceFrameworkReleaseState' effectiveFrom: type: - string - 'null' format: date reviewedAt: type: - string - 'null' format: date-time officialSources: type: string supportsClassification: type: boolean supportsControls: type: boolean supportsAssessments: type: boolean supportsCopilotGuidance: type: boolean assessmentSchema: type: - string - 'null' applicabilityDefinition: type: - string - 'null' scorePolicyKey: type: - string - 'null' maxLength: 128 promptFragmentKey: type: - string - 'null' maxLength: 128 AgentEvaluationTarget: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - targetKind properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 agentEvaluationId: type: string format: guid agentEvaluation: $ref: '#/components/schemas/AgentEvaluation' targetKind: $ref: '#/components/schemas/CampaignTargetKind' pipelineVersionId: type: - string - 'null' format: guid pipelineVersion: oneOf: - $ref: '#/components/schemas/PipelineVersion' targetEntityPayload: type: - string - 'null' CredentialEntry: type: object additionalProperties: false properties: key: $ref: '#/components/schemas/CredentialKeyField' value: type: string CredentialOrigin: type: string description: '' x-enumNames: - Platform - Chat enum: - Platform - Chat ConnectionN8n: type: object additionalProperties: false properties: apiKey: type: string url: type: string n8nCredentialsForAiriaGateway: type: array items: $ref: '#/components/schemas/N8nCredentialsForAiriaGateway' originalNodeCredentials: type: array items: $ref: '#/components/schemas/N8nOriginalNodeCredentials' SpmAgent: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId - spmConnectionId - name - externalId - securePostureProvider properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 spmConnectionId: type: string format: guid minLength: 1 name: type: string minLength: 1 externalId: type: string minLength: 1 description: type: - string - 'null' versionId: type: - string - 'null' isActive: type: - boolean - 'null' nodesCount: type: - integer - 'null' format: int32 aiModelNames: type: - string - 'null' aiProviderNames: type: - string - 'null' aiNodesCount: type: - integer - 'null' format: int32 aiSecurableNodesCount: type: - integer - 'null' format: int32 securedNodesCount: type: - integer - 'null' format: int32 credentialsCount: type: - integer - 'null' format: int32 externalCreatedAt: type: - string - 'null' format: date-time externalCreatedBy: type: - string - 'null' maxLength: 255 externalOwner: type: - string - 'null' maxLength: 255 sourceEnvironment: type: - string - 'null' maxLength: 255 sourceEnvironmentId: type: string maxLength: 255 lastSeenSyncOrgTaskId: type: string format: guid externalModifiedBy: type: - string - 'null' maxLength: 255 externalPublishedAt: type: - string - 'null' format: date-time language: type: - string - 'null' maxLength: 100 authenticationMode: type: - string - 'null' maxLength: 100 authenticationTrigger: type: - string - 'null' maxLength: 100 accessControlPolicy: type: - string - 'null' maxLength: 100 externalStatus: type: - string - 'null' maxLength: 100 owningBusinessUnit: type: - string - 'null' maxLength: 255 externalPublishedBy: type: - string - 'null' maxLength: 255 externalUpdatedAt: type: - string - 'null' format: date-time securedStatus: $ref: '#/components/schemas/SecurePostureStatus' securedNote: type: - string - 'null' securedAt: type: - string - 'null' format: date-time secureApiKeyId: type: - string - 'null' format: guid agentJson: type: string securePostureProvider: $ref: '#/components/schemas/SecurePostureProvider' agentType: oneOf: - $ref: '#/components/schemas/SpmAgentType' spmConnection: $ref: '#/components/schemas/SpmConnection' spmComponents: type: array items: $ref: '#/components/schemas/SpmComponent' hasAnySecuring: type: boolean isSecurable: type: boolean refreshedAt: type: - string - 'null' format: date-time securityScoreStatus: $ref: '#/components/schemas/SpmSecurityScoreStatus' securityScore: type: - number - 'null' format: double securityAnalyzedAt: type: - string - 'null' format: date-time securityAnalysisDetails: type: - string - 'null' workflowDisplayJson: type: - string - 'null' workflowDisplayComputedAt: type: - string - 'null' format: date-time discoveryPublishedAt: type: - string - 'null' format: date-time isAutonomous: type: - boolean - 'null' platformUrl: type: - string - 'null' maxLength: 2048 orgWideAccessible: type: - boolean - 'null' publiclyAccessible: type: - boolean - 'null' sharedWithUserCount: type: - integer - 'null' format: int32 sharedWithUsers: type: - string - 'null' maxLength: 2000 projectId: type: - string - 'null' maxLength: 255 projectName: type: - string - 'null' maxLength: 255 instructions: type: - string - 'null' schemaName: type: - string - 'null' maxLength: 255 autonomousTriggersCount: type: - integer - 'null' format: int32 webBrowsingCapability: type: - boolean - 'null' requireUsersToSignIn: type: - boolean - 'null' generativeAiEnabled: type: - boolean - 'null' agentToAgentEnabled: type: - boolean - 'null' guardrailPolicyName: type: - string - 'null' maxLength: 255 guardrailPolicyJson: type: - string - 'null' guardrailsCollectedAt: type: - string - 'null' format: date-time resourceCategory: type: string resourceType: type: string platformResourceId: type: string agentAuthenticationSetting: type: - string - 'null' ConnectionGeminiEnterprise: type: object additionalProperties: false properties: projectId: type: string location: type: string serviceAccountJson: type: string GroupType: type: string description: '' x-enumNames: - Feature - Tenant - Keycloak - EndpointDiscovered enum: - Feature - Tenant - Keycloak - EndpointDiscovered Project: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - name properties: id: type: string format: guid name: type: string minLength: 1 tenantId: type: string format: guid description: type: - string - 'null' projectIconId: type: - string - 'null' format: guid requireClassification: type: boolean pipelines: type: array items: $ref: '#/components/schemas/Pipeline' models: type: array items: $ref: '#/components/schemas/AIModel' dataSources: type: array items: $ref: '#/components/schemas/DataSource' prompts: type: array items: $ref: '#/components/schemas/Prompt' userPrompts: type: array items: $ref: '#/components/schemas/UserPrompt' apiKeys: type: array items: $ref: '#/components/schemas/ApiKey' credentials: type: array items: $ref: '#/components/schemas/Credentials' memories: type: array items: $ref: '#/components/schemas/Memory' classifications: type: array items: $ref: '#/components/schemas/Classification' classificationProjects: type: array items: $ref: '#/components/schemas/ClassificationProject' projectType: $ref: '#/components/schemas/ProjectType' sourceType: $ref: '#/components/schemas/SourceType' isDeleted: type: - boolean - 'null' ApiKeyScopeName: type: string description: '' x-enumNames: - Conversations - Project - Findings - EndpointAgentPolicy - BrowserExtensionProvisioning - LiteLlmGuardrail enum: - Conversations - Project - Findings - EndpointAgentPolicy - BrowserExtensionProvisioning - LiteLlmGuardrail ConnectionAzurePowerApps: type: object additionalProperties: false properties: tenantId: type: string clientId: type: string clientSecret: type: string ConnectionMicrosoftDefenderCloudApps: type: object additionalProperties: false properties: tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' portalUrl: type: - string - 'null' maxUsers: type: - integer - 'null' format: int32 RiskArtifact: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - riskMetadataId - artifactType - fileId - fileName properties: id: type: string format: guid tenantId: type: string format: guid riskMetadataId: type: string format: guid minLength: 1 artifactType: type: string maxLength: 200 minLength: 1 fileId: type: string maxLength: 100 minLength: 1 fileName: type: string maxLength: 500 minLength: 1 riskMetadata: $ref: '#/components/schemas/RiskMetadata' PromptVersion: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false properties: promptId: type: string format: guid versionNumber: type: integer format: int32 isLatest: type: boolean versionChangeDescription: type: string maxLength: 256 minLength: 0 promptMessage: type: string AgentDetailItem: type: object additionalProperties: false properties: type: type: string name: type: string value: {} options: type: - array - 'null' items: type: string SystemAgentMemoryDefinitionDto: type: object additionalProperties: false properties: id: type: string format: guid name: type: string isUserSpecific: type: boolean isConversationScoped: type: boolean supportsOverride: type: boolean requiresOverride: type: boolean ScenarioOverrideKind: type: string description: '' x-enumNames: - Internal - External enum: - Internal - External UseCaseRiskClassification: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - euAiAct - nistAiRmfTier - iso42001Level properties: id: type: string format: guid tenantId: type: string format: guid useCaseId: type: string format: guid useCaseVersionId: type: - string - 'null' format: guid isActive: type: boolean euAiAct: $ref: '#/components/schemas/EuAiActCategory' nistAiRmfTier: $ref: '#/components/schemas/NistAiRmfTier' iso42001Level: $ref: '#/components/schemas/Iso42001Level' mitRiskControlIds: type: array items: type: string coSaiControlIds: type: array items: type: string governanceScore: type: - integer - 'null' format: int32 governanceLevel: type: - string - 'null' maxLength: 50 summary: type: - string - 'null' maxLength: 5000 riskAssessmentJson: type: - string - 'null' euAiActConfidence: type: - string - 'null' maxLength: 50 nistAiRmfConfidence: type: - string - 'null' maxLength: 50 iso42001Confidence: type: - string - 'null' maxLength: 50 sourceRiskAnalysisRunId: type: - string - 'null' format: guid useCase: oneOf: - $ref: '#/components/schemas/UseCase' PipelineAlignment: type: string description: '' x-enumNames: - Horizontal - Vertical enum: - Horizontal - Vertical UseCaseAutonomy: type: string description: '' x-enumNames: - HumanInTheLoop - HumanOnTheLoop - HumanInTheCommand - SupervisedAutonomy - FullAutonomy enum: - HumanInTheLoop - HumanOnTheLoop - HumanInTheCommand - SupervisedAutonomy - FullAutonomy Memory: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false required: - name properties: lookupId: type: - string - 'null' format: guid isUserSpecific: type: boolean name: type: string minLength: 1 isDeleted: type: - boolean - 'null' isConversationScoped: type: boolean memoryDataEntries: type: array items: $ref: '#/components/schemas/MemoryData' UseCaseIntendedUse: type: object additionalProperties: false properties: businessPurpose: type: - string - 'null' userPopulation: type: - string - 'null' deploymentContext: type: array items: type: string dataCategories: type: array items: type: string rightsAffecting: type: array items: type: string affectedPopulation: type: array items: type: string deploymentRegion: type: array items: type: string intendedOutcome: type: - string - 'null' operatingCadence: type: - string - 'null' intendedFor: type: array items: type: string notIntendedFor: type: array items: type: string CustomCredentials: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false required: - name properties: credentialType: $ref: '#/components/schemas/CredentialType' name: type: string maxLength: 255 minLength: 1 credentialData: type: string ProvisionSystemAgentResult: type: object additionalProperties: false properties: pipelineId: type: string format: guid provisionedFromVersion: type: string AgentUpgradePreviewEntry: type: object additionalProperties: false properties: exportAgentId: type: string format: guid name: type: string action: type: string existingPipelineId: type: - string - 'null' format: guid ConnectionPurview: type: object additionalProperties: false properties: tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' accountName: type: - string - 'null' AiAssetMetadataDefinition: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid metadataName: type: string maxLength: 500 minLength: 0 metadataType: $ref: '#/components/schemas/AiAssetMetadataType' valueType: $ref: '#/components/schemas/AiAssetMetadataValueType' isPredefined: type: boolean isRequired: type: boolean isSystemGenerated: type: boolean defaultValue: type: - string - 'null' maxLength: 4000 minLength: 0 assetType: $ref: '#/components/schemas/AiAssetType' tenantId: type: - string - 'null' format: guid options: type: array items: $ref: '#/components/schemas/AiAssetMetadataDefinitionOption' assignments: type: array items: $ref: '#/components/schemas/AiAssetMetadataAssignment' ApiKey: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false required: - name - key properties: name: type: string minLength: 1 userIdentifier: type: - string - 'null' key: type: string minLength: 1 agentId: type: - string - 'null' format: guid scopes: type: array items: $ref: '#/components/schemas/ApiKeyScope' boundUserId: type: - string - 'null' format: guid boundKeycloakSubject: type: - string - 'null' isShadowUser: type: boolean enforcementMode: $ref: '#/components/schemas/EnforcementMode' expiresAt: type: - string - 'null' format: date-time lastUsedAt: type: - string - 'null' format: date-time ConfiguredModelEntry: type: object additionalProperties: false properties: modelName: type: string aiModelId: type: - string - 'null' format: guid routeThroughAcc: type: boolean accGroup: type: - string - 'null' format: guid url: type: - string - 'null' credentialId: type: - string - 'null' format: guid AiAssetDisplayStatus: type: string description: '' x-enumNames: - Unrevised - Undefined - Updated enum: - Unrevised - Undefined - Updated AboutDeploymentMetadata: type: object additionalProperties: false properties: version: type: integer format: int32 videoUrl: type: string SecurePostureProvider: type: string description: '' x-enumNames: - Undefined - N8n - Airia - AwsBedrock - AzureFoundry - LangGraph - CopilotStudio - MicrosoftGraph - GoogleWorkspace - GitHubRepository - Cloudflare - GoogleAgentPlatform - Glean - Atlan - Okta - Databricks - Purview - ServiceNow - GeminiEnterprise - SalesforceAgentforce - AzurePowerApps - CrewAi - CrowdStrike - MicrosoftDefenderCloudApps - MicrosoftDefenderXdr - SentinelOne - OpenAi - Netskope - Zscaler - Snowflake - AzureFunctionApps - AzureDevOpsRepository - GitLabRepository enum: - Undefined - N8n - Airia - AwsBedrock - AzureFoundry - LangGraph - CopilotStudio - MicrosoftGraph - GoogleWorkspace - GitHubRepository - Cloudflare - GoogleAgentPlatform - Glean - Atlan - Okta - Databricks - Purview - ServiceNow - GeminiEnterprise - SalesforceAgentforce - AzurePowerApps - CrewAi - CrowdStrike - MicrosoftDefenderCloudApps - MicrosoftDefenderXdr - SentinelOne - OpenAi - Netskope - Zscaler - Snowflake - AzureFunctionApps - AzureDevOpsRepository - GitLabRepository GatewayProviderConfigurationEntity: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false properties: gatewayConfigurationId: type: string format: guid provider: $ref: '#/components/schemas/GatewayProviders' enabled: type: boolean url: type: - string - 'null' useAiriaApiKey: type: boolean credentialId: type: - string - 'null' format: guid gatewayConfiguration: $ref: '#/components/schemas/GatewayConfigurationEntity' credential: oneOf: - $ref: '#/components/schemas/Credentials' allowedModelNames: type: - array - 'null' items: type: string configuredModels: type: - array - 'null' items: $ref: '#/components/schemas/ConfiguredModelEntry' syncParameterId: type: - string - 'null' format: guid authMethod: $ref: '#/components/schemas/AzureFoundryAuthMethod' enableUserImpersonation: type: boolean MemoryData: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: memoryObjectId: type: string format: guid memory: $ref: '#/components/schemas/Memory' data: type: string isMigrated: type: - boolean - 'null' migratedAt: type: - string - 'null' format: date-time ClassificationType: type: string description: '' x-enumNames: - Default - Custom - RiskLevel enum: - Default - Custom - RiskLevel ClassificationProject: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: classificationId: type: string format: guid projectId: type: string format: guid classificationLabelId: type: - string - 'null' format: guid classificationLabel: $ref: '#/components/schemas/ClassificationLabel' classification: $ref: '#/components/schemas/Classification' project: $ref: '#/components/schemas/Project' tenantId: type: string format: guid AgentDeploymentType: type: string description: '' x-enumNames: - Chat - AddinChat - AddinPlaybookCompare - AddinPlaybookRules - ChromeExtensionSummarize - ChromeExtensionKeyPoints - ChromeExtensionTranslate - BrowserExtension - SlackBot - TeamsBot - AddinOutlookEmailAssistant - NativeSpotlightSearch - WhatsAppBot - AddinOutlookCustomReadView - AddinPowerPointChat - AddinExcelChat - SalesforceChat - OmniAgent - HubSpotChat - SubAgent enum: - Chat - AddinChat - AddinPlaybookCompare - AddinPlaybookRules - ChromeExtensionSummarize - ChromeExtensionKeyPoints - ChromeExtensionTranslate - BrowserExtension - SlackBot - TeamsBot - AddinOutlookEmailAssistant - NativeSpotlightSearch - WhatsAppBot - AddinOutlookCustomReadView - AddinPowerPointChat - AddinExcelChat - SalesforceChat - OmniAgent - HubSpotChat - SubAgent MitigationVerificationEvidence: type: object additionalProperties: false properties: verifierKey: $ref: '#/components/schemas/MitigationVerifierKey' evidenceEntityIds: type: array items: type: string format: guid artifacts: type: array items: $ref: '#/components/schemas/MitigationArtifactEvidence' verifiedAt: type: string format: date-time trigger: $ref: '#/components/schemas/MitigationVerificationTrigger' evidenceMissingAt: type: - string - 'null' format: date-time SystemAgentVersionStatusDto: type: object additionalProperties: false properties: currentVersion: type: string currentVersionReleasedAt: type: - string - 'null' format: date-time pinnedVersion: type: - string - 'null' hasUpdateAvailable: type: boolean overridesCompatible: type: boolean incompatibleStepKeys: type: - array - 'null' items: type: string availableVersions: type: array items: $ref: '#/components/schemas/SystemAgentVersionEntryDto' pinnedVersionDeprecated: type: boolean pinnedVersionRetired: type: boolean RiskSubDomainMitigation: type: object additionalProperties: false properties: id: type: string format: guid riskSubDomainId: type: string format: guid mitigationStepDefinitionId: type: string format: guid displayOrder: type: integer format: int32 riskSubDomain: oneOf: - $ref: '#/components/schemas/RiskSubDomain' definition: oneOf: - $ref: '#/components/schemas/MitigationStepDefinition' ToolPatch: type: object additionalProperties: false properties: add: type: - array - 'null' items: $ref: '#/components/schemas/ToolPatchEntry' remove: type: - array - 'null' items: $ref: '#/components/schemas/ToolPatchEntry' modify: type: - array - 'null' items: $ref: '#/components/schemas/ToolPatchEntry' StepOverride: type: object additionalProperties: false properties: modelId: type: - string - 'null' format: guid modelCredentialId: type: - string - 'null' format: guid toolCredentials: type: - object - 'null' additionalProperties: type: string format: guid dataSourceId: type: - string - 'null' format: guid promptText: type: - string - 'null' mcpServerMappings: type: - object - 'null' additionalProperties: type: string format: guid MitigationStepOrigin: type: string description: '' x-enumNames: - Generated - Manual enum: - Generated - Manual DeploymentPrompt: type: string description: '' x-enumNames: - Artifact - Citation enum: - Artifact - Citation ChunkingConfig: type: object x-abstract: true additionalProperties: false properties: id: type: string format: guid chunkSize: type: integer format: int32 chunkOverlap: type: integer format: int32 strategyType: $ref: '#/components/schemas/ChunkingStrategy' AssignedAgent: type: object additionalProperties: false properties: deploymentId: type: string format: guid agentName: type: string agentUrl: type: string isConfigurable: type: boolean RiskTransferDecision: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - justification - transferredOwner properties: id: type: string format: guid riskMetadataId: type: string format: guid justification: type: string maxLength: 2000 minLength: 1 transferredOwner: type: string maxLength: 500 minLength: 1 evidenceLink: type: - string - 'null' maxLength: 200 user: oneOf: - $ref: '#/components/schemas/User' tenantId: type: string format: guid AiAssetInternalStatus: type: string description: '' x-enumNames: - Undefined - Synchronizing - MissingFromSource enum: - Undefined - Synchronizing - MissingFromSource UseCaseAssetAssignment: type: object additionalProperties: false properties: useCaseId: type: string format: guid aiAssetAggregateId: type: string format: guid aiAssetVersionId: type: - string - 'null' format: guid ConnectionOkta: type: object additionalProperties: false properties: orgUrl: type: - string - 'null' apiToken: type: - string - 'null' maxUsers: type: - integer - 'null' format: int32 autoManageDiscoveredAiApps: type: - boolean - 'null' IntegrationProviderType: type: string description: '' x-enumNames: - Google - Microsoft - Okta - CrowdStrike - MicrosoftDefenderCloudApps - MicrosoftDefenderXdr - SentinelOne - Netskope - Zscaler enum: - Google - Microsoft - Okta - CrowdStrike - MicrosoftDefenderCloudApps - MicrosoftDefenderXdr - SentinelOne - Netskope - Zscaler EmbeddingProviderType: type: string description: '' x-enumNames: - Unknown - OpenAi - AzureVision - Clip - Cohere - Ollama enum: - Unknown - OpenAI - AzureVision - Clip - Cohere - Ollama AgentBehaviours: type: string description: '' x-enumNames: - IterateCsv - IterateFiles - Voice - IterateDatasourceFiles - IterateDatasourceFileContent enum: - IterateCsv - IterateFiles - Voice - IterateDatasourceFiles - IterateDatasourceFileContent CredentialKeyField: type: string description: '' x-enumNames: - OpenAIAPIKey - AzureAPIKey - OllamaAPIKey - HuggingFaceAPIKey - AnthropicAPIKey - AzureAIStudioApiKey - ReplicateAPIKey - StabilityAPIKey - MistralAPIKey - PerplexityAPIKey - WatsonAPIKey - Ai21APIKey - CohereAPIKey - GoogleAPIKey - TogetherAIAPIKey - PineconeAPIKey - WeaviateAPIKey - CustomOpenAIAPIKey - XAIAPIKey - XAPIKey - FirecrawlAPIKey - YoutubeAPIKey - MicrosoftBingSearchAPIKey - BedrockAPIKey - AWSSecretKey - AwsAccessKey - AWSRegion - CustomApiKey - ConvertKitApiSecret - AccessToken - RefreshToken - Scope - Domain - Username - Password - Header - HeaderValue - Key - QueryParam - CompassAPIKey - SnowflakePrivateKey - SnowflakePasswordPhrase - AzureMLAPIKey - OpenVinoAPIKey - PyTorchAPIKey - AzureClientId - AzureClientSecret - AzureTenantId - AlibabaApiKey - GenericOpenAIAPIKey - ClientId - ClientSecret - ConnectionString - WolframAlphaAppId - ServiceAccountCredentials - ApplicationName - ImpersonateUser - AzureAiAPIKey - BedrockAccountNumber - BedrockExternalId - BedrockIamRole - BedrockUseIRSA - FilerobotToken - XFilerobotKey - WhatsAppAccessToken - WhatsAppPhoneNumberId - WhatsAppAppSecret - Host - Port - Database - Schema - Ssl - Encrypt - ValidateCert - HanaConnectionType - HanaInstanceNumber - ConfluenceUrl - JiraUrl - ContentfulSpaceId - ContentfulPreviewApiKey - AccessKeyId - SecretAccessKey - SessionToken - Expiration - SlackSigningSecret - CohesityApiKey - CohesityEndpoint - AnthropicInferenceHooksSigningSecret - AnthropicAdminKey - AnthropicAnalyticsKey - GcpProjectId - GcpLocation enum: - openaiApiKey - azureApiKey - ollamaApiKey - huggingFaceApiKey - anthropicApiKey - azureAIStudioApiKey - replicateApiKey - stabilityApiKey - mistralApiKey - perplexityApiKey - watsonApiKey - ai21ApiKey - cohereApiKey - googleApiKey - togetherAiApiKey - pineconeApiKey - weaviateApiKey - customOpenAiApiKey - xAiApiKey - xApiKey - firecrawlApiKey - youtubeApiKey - microsoftBingSearchAPIKey - bedrockApiKey - awsSecretKey - awsAccessKey - awsRegion - CustomAPIKey - convertkitApiSecret - AccessToken - RefreshToken - Scope - Domain - Username - Password - Header - HeaderValue - Key - QueryParam - compassApiKey - snowflakePrivateKey - snowflakePasswordPhrase - azureMLApiKey - OpenVinoAPIKey - PyTorchAPIKey - azureClientId - azureClientSecret - azureTenantId - AlibabaApiKey - genericOpenAiApiKey - ClientId - ClientSecret - ConnectionString - WolframAlphaAppId - serviceAccountCredentials - applicationName - impersonateUser - azureAiApiKey - bedrockAccountNumber - bedrockExternalId - bedrockIamRole - bedrockUseIRSA - filerobotToken - xFilerobotKey - whatsAppAccessToken - whatsAppPhoneNumberId - whatsAppAppSecret - host - port - database - schema - Ssl - Encrypt - ValidateCert - hanaConnectionType - hanaInstanceNumber - confluenceUrl - jiraUrl - contentfulSpaceId - contentfulPreviewApiKey - AccessKeyId - SecretAccessKey - SessionToken - Expiration - SlackSigningSecret - cohesityApiKey - cohesityEndpoint - anthropicInferenceHooksSigningSecret - anthropicAdminKey - anthropicAnalyticsKey - gcpProjectId - gcpLocation UpdateSystemAgentOverridesRequest: type: object additionalProperties: false properties: overrides: oneOf: - $ref: '#/components/schemas/SystemAgentOverrides' ConnectionConfiguration: type: object additionalProperties: false properties: connectionN8n: oneOf: - $ref: '#/components/schemas/ConnectionN8n' connectionAzureFoundry: oneOf: - $ref: '#/components/schemas/ConnectionAzureFoundry' connectionAwsBedrock: oneOf: - $ref: '#/components/schemas/ConnectionAwsBedrock' connectionLangGraph: oneOf: - $ref: '#/components/schemas/ConnectionLangGraph' connectionCopilotStudio: oneOf: - $ref: '#/components/schemas/ConnectionCopilotStudio' connectionMicrosoftGraph: oneOf: - $ref: '#/components/schemas/ConnectionMicrosoftGraph' connectionGoogleWorkspace: oneOf: - $ref: '#/components/schemas/ConnectionGoogleWorkspace' connectionCloudflare: oneOf: - $ref: '#/components/schemas/ConnectionCloudflare' connectionGoogleAgentPlatform: oneOf: - $ref: '#/components/schemas/ConnectionGoogleAgentPlatform' connectionGlean: oneOf: - $ref: '#/components/schemas/ConnectionGlean' connectionAtlan: oneOf: - $ref: '#/components/schemas/ConnectionAtlan' connectionOkta: oneOf: - $ref: '#/components/schemas/ConnectionOkta' connectionDatabricks: oneOf: - $ref: '#/components/schemas/ConnectionDatabricks' connectionPurview: oneOf: - $ref: '#/components/schemas/ConnectionPurview' connectionServiceNow: oneOf: - $ref: '#/components/schemas/ConnectionServiceNow' connectionGeminiEnterprise: oneOf: - $ref: '#/components/schemas/ConnectionGeminiEnterprise' connectionSalesforceAgentforce: oneOf: - $ref: '#/components/schemas/ConnectionSalesforceAgentforce' connectionAzurePowerApps: oneOf: - $ref: '#/components/schemas/ConnectionAzurePowerApps' connectionCrewAi: oneOf: - $ref: '#/components/schemas/ConnectionCrewAi' connectionCrowdStrike: oneOf: - $ref: '#/components/schemas/ConnectionCrowdStrike' connectionMicrosoftDefenderCloudApps: oneOf: - $ref: '#/components/schemas/ConnectionMicrosoftDefenderCloudApps' connectionMicrosoftDefenderXdr: oneOf: - $ref: '#/components/schemas/ConnectionMicrosoftDefenderXdr' connectionSentinelOne: oneOf: - $ref: '#/components/schemas/ConnectionSentinelOne' connectionOpenAi: oneOf: - $ref: '#/components/schemas/ConnectionOpenAi' connectionNetskope: oneOf: - $ref: '#/components/schemas/ConnectionNetskope' connectionZscaler: oneOf: - $ref: '#/components/schemas/ConnectionZscaler' connectionSnowflake: oneOf: - $ref: '#/components/schemas/ConnectionSnowflake' connectionAzureFunctionApps: oneOf: - $ref: '#/components/schemas/ConnectionAzureFunctionApps' ConnectionAtlan: type: object additionalProperties: false properties: baseUrl: type: string apiToken: type: string ConnectionSalesforceAgentforce: type: object additionalProperties: false properties: instanceUrl: type: string clientId: type: string clientSecret: type: string ClassificationAssignment: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid assetId: type: string format: guid classificationId: type: string format: guid assignedClassificationLabelId: type: - string - 'null' format: guid assignedClassificationLabel: oneOf: - $ref: '#/components/schemas/ClassificationLabel' inferredClassificationLabelId: type: - string - 'null' format: guid classification: $ref: '#/components/schemas/Classification' riskMetadata: oneOf: - $ref: '#/components/schemas/RiskMetadata' RegulatoryRisk: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid riskProfileId: type: string format: guid frameworkKey: type: string maxLength: 128 classificationValue: type: string maxLength: 128 rationale: type: - string - 'null' maxLength: 2000 confidence: type: - string - 'null' maxLength: 50 assessedAt: type: - string - 'null' format: date-time definitionVersionId: type: - string - 'null' format: guid applicability: type: - string - 'null' maxLength: 32 normalizedScore: type: - integer - 'null' details: type: - string - 'null' UseCaseVersion: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - name properties: id: type: string format: guid tenantId: type: string format: guid useCaseId: type: string format: guid revisionNumber: type: integer format: int32 versionLabel: type: - string - 'null' maxLength: 64 minLength: 0 isActive: type: boolean isArchived: type: boolean name: type: string maxLength: 200 minLength: 0 description: type: - string - 'null' stage: $ref: '#/components/schemas/UseCaseStage' status: oneOf: - $ref: '#/components/schemas/UseCaseStatus' autonomy: oneOf: - $ref: '#/components/schemas/UseCaseAutonomy' impacted: type: - string - 'null' maxLength: 500 minLength: 0 ownerId: type: - string - 'null' format: guid reviewerId: type: - string - 'null' format: guid riskDomainId: type: - string - 'null' format: guid riskSubDomainId: type: - string - 'null' format: guid reviewedAt: type: - string - 'null' format: date-time contextChangedAt: type: - string - 'null' format: date-time acceptsAssetUpdates: type: boolean core: oneOf: - $ref: '#/components/schemas/UseCaseCore' intendedUse: oneOf: - $ref: '#/components/schemas/UseCaseIntendedUse' reviewPolicy: oneOf: - $ref: '#/components/schemas/UseCaseReviewPolicy' nutritionLabelJson: type: - string - 'null' receiptJson: type: - string - 'null' rowVersion: type: integer useCase: oneOf: - $ref: '#/components/schemas/UseCase' TableDocumentProcessingMode: type: string description: '' x-enumNames: - Unspecified - Semantic - Sql - Both - Embedding - Graph - Labels - HybridEntityRag enum: - Unspecified - Semantic - Sql - Both - Embedding - Graph - Labels - HybridEntityRag ProjectType: type: string description: '' x-enumNames: - Standard - Frontline - Legal - FieldService - BrainFreeze enum: - Standard - Frontline - Legal - FieldService - BrainFreeze PipelineVersion: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: pipelineId: type: string format: guid majorVersion: type: integer format: int32 minorVersion: type: integer format: int32 versionNumber: type: string isDraftVersion: type: boolean isLatest: type: boolean steps: type: - array - 'null' items: $ref: '#/components/schemas/PipelineStep' alignment: $ref: '#/components/schemas/PipelineAlignment' description: type: - string - 'null' maxLength: 1024 versionName: type: - string - 'null' maxLength: 256 isDeprecated: type: boolean boxedAgentDefinition: type: - string - 'null' overrides: type: - string - 'null' TeamsManifestCustomizationConfig: type: object additionalProperties: false properties: botName: type: - string - 'null' colorIconBlobId: type: - string - 'null' format: guid outlineIconBlobId: type: - string - 'null' format: guid RiskSubDomain: type: object additionalProperties: false required: - name properties: id: type: string format: guid riskDomainId: type: string format: guid name: type: string maxLength: 500 minLength: 1 code: type: - string - 'null' maxLength: 10 description: type: - string - 'null' maxLength: 2000 displayOrder: type: integer format: int32 riskDomain: oneOf: - $ref: '#/components/schemas/RiskDomain' mitigations: type: array items: $ref: '#/components/schemas/RiskSubDomainMitigation' controls: type: array items: $ref: '#/components/schemas/RiskSubDomainControl' PipelineStepHandle: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: pipelineStepId: type: string format: guid uuid: type: string format: guid type: type: string maxLength: 6 label: type: - string - 'null' maxLength: 100 tooltip: type: - string - 'null' x: type: - number - 'null' format: float y: type: - number - 'null' format: float SystemAgentDelegateDto: type: object additionalProperties: false properties: exportAgentId: type: string format: guid pipelineId: type: - string - 'null' format: guid exportParentAgentId: type: string format: guid name: type: string description: type: - string - 'null' isEnabled: type: boolean deploymentId: type: - string - 'null' format: guid source: $ref: '#/components/schemas/SystemAgentDelegateSource' BaseProjectEntity: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object x-abstract: true additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid projectId: type: string format: guid project: oneOf: - $ref: '#/components/schemas/Project' UpdateMcpBindingsRequest: type: object additionalProperties: false required: - mcpServerMappings properties: mcpServerMappings: type: object additionalProperties: type: - string - 'null' format: guid subAgentId: type: - string - 'null' format: guid ConnectionAzureFunctionApps: type: object additionalProperties: false properties: tenantId: type: string clientId: type: string clientSecret: type: string PipelineStep: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object x-abstract: true additionalProperties: false properties: position: oneOf: - $ref: '#/components/schemas/PipelineStepPosition' handles: type: - array - 'null' items: $ref: '#/components/schemas/PipelineStepHandle' dependenciesObject: type: - array - 'null' items: $ref: '#/components/schemas/PipelineStepDependency' stepType: $ref: '#/components/schemas/StepType' pipelineVersionId: type: string format: guid stepTitle: type: string maxLength: 100 minLength: 0 parentId: type: - string - 'null' format: guid width: type: - integer - 'null' format: int32 height: type: - integer - 'null' format: int32 retryConfiguration: oneOf: - $ref: '#/components/schemas/RetryConfiguration' GatewayApiKeyOrigin: type: string description: '' x-enumNames: - SelfServe - EndpointAgent - SecurePosture enum: - SelfServe - EndpointAgent - SecurePosture WhatIfBaselineMode: type: string description: '' x-enumNames: - FreshInJob - ReuseExisting enum: - FreshInJob - ReuseExisting ConnectionAwsBedrock: type: object additionalProperties: false properties: region: type: string accessKey: type: string secretKey: type: string sessionToken: type: - string - 'null' gatewayConfigurations: type: array items: $ref: '#/components/schemas/BedrockGatewayConfiguration' ModelState: type: string description: '' x-enumNames: - Unknown - Pending - Retrieving - Storing - Finished - Failed enum: - unknown - pending - retrieving - storing - finished - failed RiskControlGroup: type: object additionalProperties: false required: - name properties: id: type: string format: guid name: type: string maxLength: 200 minLength: 1 key: type: - string - 'null' maxLength: 128 controls: type: array items: $ref: '#/components/schemas/RiskControl' MitigationVerifierKey: type: string description: '' x-enumNames: - Guardrail - Evaluation - RedTeaming - Gateway - Assessment - Disclosure - EndpointRouting - GatewayBudget - GatewayAgentConstraint enum: - Guardrail - Evaluation - RedTeaming - Gateway - Assessment - Disclosure - EndpointRouting - GatewayBudget - GatewayAgentConstraint ConnectionOpenAi: type: object additionalProperties: false properties: workspaceLabel: type: - string - 'null' enabledCapabilities: type: array items: $ref: '#/components/schemas/SpmProviderKind' ConnectionCrowdStrike: type: object additionalProperties: false properties: clientId: type: - string - 'null' clientSecret: type: - string - 'null' region: type: - string - 'null' maxUsers: type: - integer - 'null' format: int32 enabledCapabilities: type: array items: $ref: '#/components/schemas/SpmProviderKind' IntegrationAnalysisRunStatus: type: string description: '' x-enumNames: - Pending - Completed - Failed enum: - Pending - Completed - Failed UseCaseStage: type: string description: '' x-enumNames: - Discover - Register - Triage - Assess - BuildAndConnect - Mitigate - Approve - Monitor - Quarantine - Change - Archive enum: - Discover - Register - Triage - Assess - BuildAndConnect - Mitigate - Approve - Monitor - Quarantine - Change - Archive ProblemDetails: type: object additionalProperties: {} properties: type: type: - string - 'null' title: type: - string - 'null' status: type: - integer - 'null' format: int32 detail: type: - string - 'null' instance: type: - string - 'null' GatewayResilienceRuleEntity: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false properties: gatewayConfigurationId: type: string format: guid name: type: string order: type: integer format: int32 mode: type: string weight: type: integer format: int32 timeoutInSeconds: type: integer format: int32 httpStatusCodes: type: array items: type: integer format: int32 enableAffinity: type: boolean affinityTtlSeconds: type: integer format: int32 gatewayRuleId: type: - string - 'null' format: guid failureThreshold: type: integer format: int32 failureRateThreshold: type: number format: decimal timespanWindowInSeconds: type: integer format: int32 cooldownSeconds: type: integer format: int32 targets: type: array items: $ref: '#/components/schemas/GatewayResilienceTargetEntity' AiAssetAggregate: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object x-abstract: true additionalProperties: false properties: id: type: string format: guid tenantId: type: string format: guid sourceId: type: string format: guid source: oneOf: - $ref: '#/components/schemas/AiAssetAggregateSource' sourceType: $ref: '#/components/schemas/AiAssetSourceType' sourceInstanceId: type: - string - 'null' format: guid sourceEnvironmentId: type: string maxLength: 255 minLength: 0 assetType: $ref: '#/components/schemas/AiAssetType' internalStatus: $ref: '#/components/schemas/AiAssetInternalStatus' displayStatus: $ref: '#/components/schemas/AiAssetDisplayStatus' timeReference: type: - string - 'null' format: date-time usage: type: array items: $ref: '#/components/schemas/AiAssetUsage' childUsages: type: array items: $ref: '#/components/schemas/AiAssetUsage' name: type: string maxLength: 4000 minLength: 0 classifications: type: - array - 'null' items: $ref: '#/components/schemas/ClassificationAssignment' metadataAssignments: type: - array - 'null' items: $ref: '#/components/schemas/AiAssetMetadataAssignment' assessments: type: - array - 'null' items: $ref: '#/components/schemas/Assessment' useCases: type: array items: $ref: '#/components/schemas/UseCase' EmailAction: type: string description: '' x-enumNames: - Reply - ReplyAll - Forward - None enum: - Reply - ReplyAll - Forward - None ConnectionCrewAi: type: object additionalProperties: false properties: baseUrl: type: string apiToken: type: string organizationId: type: - string - 'null' MitigationArtifactEvidence: type: object additionalProperties: false properties: artifactType: $ref: '#/components/schemas/MitigationArtifactType' entityId: type: string format: guid displayName: type: string state: $ref: '#/components/schemas/MitigationArtifactEvidenceState' status: type: - string - 'null' appliesNow: type: boolean dataLossPreventionCategories: type: array items: type: string agentPipelineIds: type: array items: type: string format: guid gatewayConfigurationIds: type: array items: type: string format: guid routedOfReachable: type: - string - 'null' artifactTimestamp: type: - string - 'null' format: date-time GovernanceArtifact: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false required: - useCaseId - artifactType - fileId - fileName - uploadedByUserId - uploadedAt properties: useCaseId: type: string format: guid minLength: 1 useCaseVersionId: type: - string - 'null' format: guid artifactType: type: string maxLength: 200 minLength: 1 fileId: type: string maxLength: 100 minLength: 1 fileName: type: string maxLength: 500 minLength: 1 slotKey: type: - string - 'null' maxLength: 200 uploadedByUserId: type: string format: guid minLength: 1 uploadedAt: type: string format: date-time useCase: $ref: '#/components/schemas/UseCase' AgentEvaluationSchedule: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - tenantId properties: id: type: string format: guid tenantId: type: string format: guid minLength: 1 second: type: integer format: int32 maximum: 59 minimum: 0 minute: type: integer format: int32 maximum: 59 minimum: 0 hour: type: integer format: int32 maximum: 23 minimum: 0 day: type: integer format: int32 maximum: 31 minimum: 1 month: type: integer format: int32 maximum: 12 minimum: 1 scheduleType: $ref: '#/components/schemas/ScheduleType' daysOfWeek: type: - string - 'null' maxLength: 100 minLength: 0 year: type: - integer - 'null' format: int32 maximum: 2099 minimum: 1970 startDate: type: - string - 'null' format: date-time endDate: type: - string - 'null' format: date-time isCancelled: type: boolean ParameterLocation: type: string description: '' x-enumNames: - QueryString - Header - Body enum: - QueryString - Header - Body RiskAvoidanceDecision: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - justification properties: id: type: string format: guid riskMetadataId: type: string format: guid justification: type: string maxLength: 2000 minLength: 1 user: oneOf: - $ref: '#/components/schemas/User' tenantId: type: string format: guid ConnectionServiceNow: type: object additionalProperties: false properties: instanceUrl: type: string username: type: string password: type: string ConnectionGoogleAgentPlatform: type: object additionalProperties: false properties: projectId: type: string location: type: string serviceAccountJson: type: string Department: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid label: type: string maxLength: 256 minLength: 0 order: type: integer format: int32 createdBy: oneOf: - $ref: '#/components/schemas/User' tenantId: type: string format: guid InputType: type: string description: '' x-enumNames: - Text - Image - Audio - Video enum: - text - image - audio - video UserPrompt: allOf: - $ref: '#/components/schemas/BaseProjectEntity' - type: object additionalProperties: false properties: name: type: string maxLength: 256 message: type: string maxLength: 4096 description: type: string maxLength: 4096 deploymentUserPrompts: type: array items: $ref: '#/components/schemas/DeploymentUserPrompt' DeploymentUserPrompt: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: deploymentId: type: string format: guid userPromptId: type: string format: guid Role: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false properties: id: type: string format: guid name: type: string displayName: type: string identityServerRoleId: type: - string - 'null' format: guid description: type: - string - 'null' projectId: type: - string - 'null' format: guid privilegeOrder: type: integer format: int32 DeploymentTargetAgent: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: deploymentId: type: string format: guid targetPipelineId: type: string format: guid ResidualRisk: type: string description: '' x-enumNames: - Low - Medium - High - Critical enum: - Low - Medium - High - Critical AgentTrigger: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: emailId: type: string maxLength: 256 minLength: 0 allowedType: $ref: '#/components/schemas/AgentTriggerAllowedType' allowedValues: type: string maxLength: 4000 minLength: 0 pipelineId: type: string format: guid dataSourceId: type: - string - 'null' format: guid storeConnectorId: type: - string - 'null' format: guid emailAction: $ref: '#/components/schemas/EmailAction' forwardTo: type: - string - 'null' maxLength: 4000 minLength: 0 useEmailUserMapping: type: - boolean - 'null' requireUserMapping: type: - boolean - 'null' autoProvisionUsers: type: - boolean - 'null' ExternalScenarioOverrides: allOf: - $ref: '#/components/schemas/ScenarioOverrides' - type: object additionalProperties: false properties: overrideKind: $ref: '#/components/schemas/ScenarioOverrideKind' systemPromptOverride: type: - string - 'null' additionalInstructions: type: - string - 'null' configOverrides: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/JsonNode' DeploymentType: type: string description: '' x-enumNames: - Marketplace - External - Internal enum: - marketplace - external - internal UserProvisioningSource: type: string description: '' x-enumNames: - EndpointDiscovered enum: - EndpointDiscovered PriceType: type: string description: '' x-enumNames: - Unknown - AITextOutputModelPrice - AIImageOutputModelPrice enum: - Unknown - AITextOutputModelPrice - AIImageOutputModelPrice ConnectionGoogleWorkspace: type: object additionalProperties: false properties: domain: type: - string - 'null' serviceAccountKey: type: - string - 'null' adminEmail: type: - string - 'null' DataSourceGroup: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false required: - name properties: name: type: string maxLength: 256 minLength: 0 description: type: string dataSources: type: array items: $ref: '#/components/schemas/DataSource' RuleConditionEntity: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object x-abstract: true additionalProperties: false properties: gatewayRuleId: type: string format: guid ruleId: type: - string - 'null' format: guid rule: oneOf: - $ref: '#/components/schemas/GatewayRuleEntity' parentGroupId: type: - string - 'null' format: guid parentGroup: oneOf: - $ref: '#/components/schemas/RuleGroupConditionEntity' order: type: integer format: int32 not: type: - boolean - 'null' EnforcementMode: type: string description: '' x-enumNames: - Legacy - Audit - Enforce enum: - Legacy - Audit - Enforce AcceptanceDecision: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - decision properties: id: type: string format: guid riskMetadataId: type: string format: guid decision: type: string maxLength: 2000 minLength: 1 residualRisk: oneOf: - $ref: '#/components/schemas/ResidualRisk' user: oneOf: - $ref: '#/components/schemas/User' tenantId: type: string format: guid ConnectionNetskope: type: object additionalProperties: false properties: tenantUrl: type: - string - 'null' apiToken: type: - string - 'null' BaseOptionalProjectEntity: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object x-abstract: true additionalProperties: false properties: projectId: type: - string - 'null' format: guid Credentials: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false properties: name: type: - string - 'null' displayIdentifierName: type: - string - 'null' type: $ref: '#/components/schemas/CredentialType' sourceType: $ref: '#/components/schemas/SourceType' administrativeScope: $ref: '#/components/schemas/AdministrativeScope' expired: type: - boolean - 'null' ExpiresOn: type: - string - 'null' format: date-time Origin: $ref: '#/components/schemas/CredentialOrigin' enabledForPythonBlocks: type: boolean credentialData: type: string credentialDataList: type: - array - 'null' items: $ref: '#/components/schemas/CredentialEntry' customCredentialsId: type: - string - 'null' format: guid customCredentials: oneOf: - $ref: '#/components/schemas/CustomCredentials' sourceId: type: - string - 'null' format: guid ucsProvider: type: - string - 'null' ucsAuthenticationType: type: - string - 'null' binderId: type: - string - 'null' format: guid credentialId: type: - string - 'null' format: guid securitySchemes: ApiKey: type: apiKey description: API Key Authentication name: X-API-Key in: header Cookies: type: apiKey description: Cookie based Authentication name: Cookie in: header x-generator: NSwag v14.7.1.0 (NJsonSchema v11.6.1.0 (Newtonsoft.Json v13.0.0.0))