openapi: 3.2.0 info: title: Airia Web Pipelines Config API version: 1.0.0 servers: - url: https://api.airia.ai tags: - name: PipelinesConfig paths: /v1/PipelinesConfig: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelines2 parameters: - name: PageNumber in: query schema: type: integer format: int32 x-position: 1 - name: PageSize in: query schema: type: integer format: int32 x-position: 2 - name: SortBy in: query schema: type: - string - 'null' x-position: 3 - name: SortDirection in: query schema: type: string x-position: 4 - name: filter in: query schema: type: - string - 'null' x-position: 5 - name: projectId in: query schema: type: - string - 'null' x-position: 6 - name: modelCredentialSourceType in: query schema: oneOf: - oneOf: - $ref: '#/components/schemas/SourceType' x-position: 7 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/Pipeline' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipelines2 x-summary-source: derived post: tags: - PipelinesConfig operationId: PipelinesConfig_PostPipeline2 parameters: - name: x-correlation-id in: header schema: type: string requestBody: x-name: pipelineRequest content: application/json: schema: $ref: '#/components/schemas/CreatePipelineRequest' required: true x-position: 1 responses: 201: description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedPipelineDto' 500: description: '' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config post pipeline2 x-summary-source: derived /v1/PipelinesConfig/batch-names: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelineNamesByIds2 parameters: - name: ids in: query style: form explode: true schema: type: - array - 'null' items: 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/EntityNamesResult' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipeline names by ids2 x-summary-source: derived /v1/PipelinesConfig/withSchedule: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelinesWithSchedule2 parameters: - name: PageNumber in: query schema: type: integer format: int32 x-position: 1 - name: PageSize in: query schema: type: integer format: int32 x-position: 2 - name: SortBy in: query schema: type: - string - 'null' x-position: 3 - name: SortDirection in: query schema: type: string x-position: 4 - name: filter in: query schema: type: - string - 'null' x-position: 5 - name: projectId in: query schema: type: - string - 'null' x-position: 6 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/PagedResultOfPaginatedPipelineWithScheduleDto' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipelines with schedule2 x-summary-source: derived /v1/PipelinesConfig/summary: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetAgentSummary2 parameters: - name: PageNumber in: query schema: type: integer format: int32 x-position: 1 - name: PageSize in: query schema: type: integer format: int32 x-position: 2 - name: SortBy in: query schema: type: - string - 'null' x-position: 3 - name: SortDirection in: query schema: type: string x-position: 4 - name: filter in: query schema: type: - string - 'null' x-position: 5 - name: agentFilter in: query schema: $ref: '#/components/schemas/AgentSummaryFilter' x-position: 6 - name: agentAccessibleAsFilter in: query schema: oneOf: - $ref: '#/components/schemas/AgentAccessibleAsFilter' x-position: 7 - name: projectId x-originalName: projectIds in: query style: form explode: true schema: type: - array - 'null' items: type: string format: guid x-position: 8 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/PagedResultOfPaginatedPipelineDtoWithClassifications' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get agent summary2 x-summary-source: derived /v1/PipelinesConfig/{id}: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipeline2 parameters: - name: id 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' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipeline2 x-summary-source: derived put: tags: - PipelinesConfig operationId: PipelinesConfig_PutPipeline2 parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: X-API-Key x-originalName: apiKey in: header schema: type: - string - 'null' x-position: 3 - name: x-correlation-id in: header schema: type: string requestBody: x-name: pipeline content: application/json: schema: $ref: '#/components/schemas/UpdatePipelineRequest' required: true x-position: 2 responses: 204: description: '' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 422: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config put pipeline2 x-summary-source: derived delete: tags: - PipelinesConfig operationId: PipelinesConfig_DeletePipeline2 parameters: - name: id 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' 422: description: '' content: application/json: schema: $ref: '#/components/schemas/AgentDeletionBlockedDetails' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config delete pipeline2 x-summary-source: derived /v1/PipelinesConfig/{id}/editor-shell: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelineEditorShell2 parameters: - name: id 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/PipelineEditorShellDto' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipeline editor shell2 x-summary-source: derived /v1/PipelinesConfig/{id}/editor-icon: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelineEditorIcon2 parameters: - name: id 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' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipeline editor icon2 x-summary-source: derived /v1/PipelinesConfig/{id}/editor-versions: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelineEditorVersions2 parameters: - name: id 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/PipelineEditorVersionsDto' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipeline editor versions2 x-summary-source: derived /v1/PipelinesConfig/{pipelineVersionId}/report: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetReportByPipelineVersionId2 parameters: - name: pipelineVersionId 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/PipelineIntegrations' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get report by pipeline version id2 x-summary-source: derived /v1/PipelinesConfig/{id}/integrations: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelineIntegrations2 parameters: - name: id 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/PipelineIntegrations' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipeline integrations2 x-summary-source: derived /v1/PipelinesConfig/{pipelineVersionId}/has-image-support: get: tags: - PipelinesConfig operationId: PipelinesConfig_HasImageSupport2 parameters: - name: pipelineVersionId 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: boolean 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config has image support2 x-summary-source: derived /v1/PipelinesConfig/from-version: post: tags: - PipelinesConfig operationId: PipelinesConfig_PostPipelineFromVersion2 parameters: - name: x-correlation-id in: header schema: type: string requestBody: x-name: pipelineRequest content: application/json: schema: $ref: '#/components/schemas/CreatePipelineRequest' required: true x-position: 1 responses: 201: description: '' content: application/json: schema: $ref: '#/components/schemas/PipelineCloneCreatedDto' 500: description: '' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config post pipeline from version2 x-summary-source: derived /v1/PipelinesConfig/bulk-delete: post: tags: - PipelinesConfig operationId: PipelinesConfig_BulkDeletePipelines2 parameters: - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/BulkDeletePipelinesRequest' required: true x-position: 1 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/BulkDeletePipelinesResult' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config bulk delete pipelines2 x-summary-source: derived /v1/PipelinesConfig/{id}/duplicate: post: tags: - PipelinesConfig operationId: PipelinesConfig_DuplicatePipeline2 parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: x-correlation-id in: header schema: type: string responses: 201: description: '' content: application/json: schema: $ref: '#/components/schemas/PaginatedPipelineDto' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config duplicate pipeline2 x-summary-source: derived /v1/PipelinesConfig/{id}/versions/{versionId}/publish: post: tags: - PipelinesConfig operationId: PipelinesConfig_PublishVersion2 parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: versionId in: path required: true schema: type: string format: guid x-position: 2 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/PipelineVersion' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 409: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config publish version2 x-summary-source: derived /v1/PipelinesConfig/{id}/tags: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetVersionTags2 parameters: - name: id 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/PipelineVersionTagDto' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get version tags2 x-summary-source: derived post: tags: - PipelinesConfig operationId: PipelinesConfig_CreateVersionTag2 parameters: - name: id 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/CreatePipelineVersionTagRequest' required: true x-position: 2 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/PipelineVersionTagDto' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 409: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config create version tag2 x-summary-source: derived /v1/PipelinesConfig/{id}/tags/{tag}: put: tags: - PipelinesConfig operationId: PipelinesConfig_MoveVersionTag2 parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: tag in: path required: true schema: type: string x-position: 2 - name: x-correlation-id in: header schema: type: string requestBody: x-name: request content: application/json: schema: $ref: '#/components/schemas/MovePipelineVersionTagRequest' required: true x-position: 3 responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/PipelineVersionTagDto' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 409: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config move version tag2 x-summary-source: derived delete: tags: - PipelinesConfig operationId: PipelinesConfig_DeleteVersionTag2 parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: tag in: path required: true schema: type: string x-position: 2 - name: x-correlation-id in: header schema: type: string responses: 204: description: '' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config delete version tag2 x-summary-source: derived /v1/PipelinesConfig/validate: post: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelineValidationResultByVersion2 parameters: - name: x-correlation-id in: header schema: type: string requestBody: x-name: pipelineRequest content: application/json: schema: $ref: '#/components/schemas/CreatePipelineRequest' required: true x-position: 1 responses: 201: description: '' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipeline validation result by version2 x-summary-source: derived /v1/PipelinesConfig/export/{id}: get: tags: - PipelinesConfig operationId: PipelinesConfig_ExportPipeline2 parameters: - name: id in: path required: true schema: type: string format: guid x-position: 1 - name: Tagline in: query schema: type: - string - 'null' x-position: 2 - name: Description in: query schema: type: - string - 'null' x-position: 3 - name: Industry in: query schema: type: - string - 'null' x-position: 4 - name: Tasks in: query schema: type: - string - 'null' x-position: 5 - name: CredentialExportOption in: query schema: $ref: '#/components/schemas/CredentialExportOption' x-position: 6 - name: DataSourceExportOption in: query schema: $ref: '#/components/schemas/DataSourceExportOption' x-position: 7 - name: Country in: query schema: type: - string - 'null' x-position: 8 - name: SquashPromptSegments in: query schema: type: boolean x-position: 9 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/ExportPipelineDefinition' 404: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 422: description: '' content: application/json: schema: $ref: '#/components/schemas/PipelineExportError' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config export pipeline2 x-summary-source: derived /v1/PipelinesConfig/pipeline-limit: get: tags: - PipelinesConfig operationId: PipelinesConfig_CheckPipelineLimit2 parameters: - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/PipelineLimitResponse' 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config check pipeline limit2 x-summary-source: derived /v1/PipelinesConfig/generateForwardingEmail: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetForwardEmailIdForEMailConnector2 parameters: - name: projectId in: query schema: type: string format: guid x-position: 1 - name: pipelineId in: query schema: type: - string - 'null' format: guid x-position: 2 - name: x-correlation-id in: header schema: type: string responses: default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 200: description: '' content: application/json: schema: type: string 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get forward email id for EMail connector2 x-summary-source: derived /v1/PipelinesConfig/tags: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetPipelineTags2 parameters: - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: type: array items: type: string 500: description: '' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' default: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' summary: Pipelines config get pipeline tags2 x-summary-source: derived /v2/PipelinesConfig/summary: get: tags: - PipelinesConfig operationId: PipelinesConfig_GetAgentSummary22 parameters: - name: IncludeTotalCount in: query schema: type: boolean x-position: 1 - name: PageNumber in: query schema: type: integer format: int32 x-position: 2 - name: PageSize in: query schema: type: integer format: int32 x-position: 3 - name: SortBy in: query schema: type: - string - 'null' x-position: 4 - name: SortDirection in: query schema: type: string x-position: 5 - name: filter in: query schema: type: - string - 'null' x-position: 6 - name: agentFilter in: query schema: $ref: '#/components/schemas/AgentSummaryFilter' x-position: 7 - name: agentAccessibleAsFilter in: query style: form explode: true schema: type: - array - 'null' items: $ref: '#/components/schemas/AgentAccessibleAsFilter' x-position: 8 - name: projectId x-originalName: projectIds in: query style: form explode: true schema: type: - array - 'null' items: type: string format: guid x-position: 9 - name: x-correlation-id in: header schema: type: string responses: 200: description: '' content: application/json: schema: $ref: '#/components/schemas/PagedResultV2OfAgentSummaryDtoV2' 400: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 401: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 403: description: '' content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' 500: description: '' summary: Pipelines config get agent summary22 x-summary-source: derived components: schemas: 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 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 MitigationArtifactEvidenceState: type: string description: '' x-enumNames: - Qualifying - Candidate - Missing - InProgress enum: - Qualifying - Candidate - Missing - InProgress 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 SpmComponentType: type: string description: '' x-enumNames: - Undefined - AiModel - SpmAgent - Tool - McpServer - Knowledge enum: - Undefined - AiModel - SpmAgent - Tool - McpServer - Knowledge ScheduleModel: type: object additionalProperties: false properties: 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 executionHour: type: - integer - 'null' 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: - array - 'null' items: $ref: '#/components/schemas/DayOfWeek' monthlyWeekOccurrence: oneOf: - $ref: '#/components/schemas/MonthlyWeekOccurrence' timeZoneId: 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 AgentDetailItemDefinition: type: object additionalProperties: false properties: itemType: type: string name: type: string value: type: string options: type: - array - 'null' items: type: string PromptDefinition: type: object additionalProperties: false properties: name: type: string versionChangeDescription: type: string promptMessage: type: - string - 'null' isAgentSpecific: type: - boolean - 'null' isGlobal: type: - boolean - 'null' id: type: string format: guid 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' MitigationCapability: type: string description: '' x-enumNames: - Invocable - TrafficInterposed - ConfigControlledLlmRouting - ConfigControlledMcpRouting - ConfigControlledMcpSanction - ConfigControlledGateway - Observed - Declared enum: - Invocable - TrafficInterposed - ConfigControlledLlmRouting - ConfigControlledMcpRouting - ConfigControlledMcpSanction - ConfigControlledGateway - Observed - Declared DeploymentDefinition: type: object additionalProperties: false properties: name: type: string deploymentIcon: type: - string - 'null' deploymentDescription: type: string userPrompts: type: - array - 'null' items: $ref: '#/components/schemas/UserPromptDefinition' deploymentPrompt: type: - string - 'null' isRecommended: type: boolean deploymentType: type: string conversationType: type: string aboutJson: type: - string - 'null' supportedInputModes: type: - array - 'null' items: type: string browserExtensionConfig: oneOf: - $ref: '#/components/schemas/BrowserExtensionConfigDefinition' displayConsumptionInfo: type: boolean 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 AssignedAgentDefinition: type: object additionalProperties: false properties: deploymentId: type: string format: guid agentName: type: string agentUrl: type: string isConfigurable: type: boolean EvaluatorSource: type: string description: '' x-enumNames: - Airia - AzureFoundry enum: - Airia - AzureFoundry QuickActionType: type: string description: '' x-enumNames: - Page - Selection - PageSource enum: - Page - Selection - PageSource ConnectionSentinelOne: type: object additionalProperties: false properties: consoleUrl: type: - string - 'null' apiToken: type: - string - 'null' UpdatePipelineRequest: type: object additionalProperties: false properties: id: type: string format: guid backupPipelineId: type: - string - 'null' format: guid name: type: - string - 'null' executionName: type: - string - 'null' description: type: - string - 'null' markdownDescription: type: - string - 'null' agentIconId: type: - string - 'null' format: guid agentUnicodeIcon: type: - string - 'null' projectId: type: string format: guid activeVersionId: type: - string - 'null' format: guid agentDetails: type: - object - 'null' additionalProperties: type: array items: $ref: '#/components/schemas/AgentDetailItem' industry: type: - string - 'null' subIndustries: type: - array - 'null' items: type: string videoLink: type: - string - 'null' behaviours: type: - array - 'null' items: $ref: '#/components/schemas/AgentBehaviours' departmentId: type: - string - 'null' format: guid ownerId: type: - string - 'null' format: guid tags: type: array items: type: string isEndUserPrivate: type: - boolean - 'null' saveToolResponsesToHistory: type: - boolean - 'null' MonthlyWeekOccurrence: type: string description: '' x-enumNames: - First - Second - Third - Fourth - Last enum: - First - Second - Third - Fourth - Last 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' 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' ExecutionStats: type: object additionalProperties: false properties: successCount: type: integer format: int32 failureCount: type: integer format: int32 AgentCardDefinition: type: object additionalProperties: false properties: agentCardId: type: string format: guid name: type: string description: type: string supportedInterfaces: type: array items: $ref: '#/components/schemas/AgentInterface2' provider: oneOf: - $ref: '#/components/schemas/AgentProvider2' version: type: string documentationUrl: type: - string - 'null' iconUrl: type: - string - 'null' capabilities: $ref: '#/components/schemas/AgentCapabilities2' securitySchemes: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/SecurityScheme2' securityRequirements: type: - array - 'null' items: $ref: '#/components/schemas/SecurityRequirement2' signatures: type: - array - 'null' items: $ref: '#/components/schemas/AgentCardSignature2' defaultInputModes: type: array items: type: string defaultOutputModes: type: array items: type: string skills: type: array items: $ref: '#/components/schemas/AgentSkill2' AgentDeletionBlockedDetails: type: object additionalProperties: false properties: message: type: string pipelineId: type: string format: guid pipelineName: type: string activeCampaigns: type: array items: $ref: '#/components/schemas/ActiveCampaignInfo' hasActiveExecutions: type: boolean 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 LoopStepBatchConfigurationDefinition: type: object additionalProperties: false properties: batchSize: type: integer format: int32 batchDelaySeconds: type: integer format: int32 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' ConnectionGlean: type: object additionalProperties: false properties: instance: type: string apiToken: type: string PipelineCloneCreatedDto: type: object additionalProperties: false required: - id - projectId - activeVersionId - activeVersion properties: id: type: string format: guid projectId: type: string format: guid activeVersionId: type: string format: guid activeVersion: $ref: '#/components/schemas/PipelineVersionEditorDto' 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' 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 MitigationControlFunction: type: string description: '' x-enumNames: - Prevent - Detect - Respond enum: - Prevent - Detect - Respond SupportedInputMode: type: string description: '' x-enumNames: - FileUpload - Whiteboard - Code - Math enum: - FileUpload - Whiteboard - Code - Math 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' MovePipelineVersionTagRequest: type: object additionalProperties: false required: - pipelineVersionId properties: pipelineVersionId: type: string format: guid AgentAccessibleAsFilter: type: string description: '' x-enumFlags: true x-enumNames: - None - Embedded - Word - Scheduled - Email - AiriaAgents - Webhooks - Chrome - ToolInterface enum: - None - Embedded - Word - Scheduled - Email - AiriaAgents - Webhooks - Chrome - ToolInterface AzureFoundryAuthMethod: type: string description: '' x-enumNames: - ApiKey - EntraId - GcpServiceAccount enum: - ApiKey - EntraId - GcpServiceAccount AgentSummaryVersionDtoV2: type: object additionalProperties: false properties: id: type: string format: guid createdAt: type: - string - 'null' format: date-time versionNumber: type: string isDraftVersion: type: boolean isLatest: type: boolean BrowserExtensionConfig: type: object additionalProperties: false properties: type: type: string quickActions: type: array items: $ref: '#/components/schemas/QuickAction' JsonNodeOptions: type: object additionalProperties: false properties: propertyNameCaseInsensitive: type: boolean 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 PipelineExportError: type: object additionalProperties: false properties: errorMessage: type: - string - 'null' errorDetails: type: - array - 'null' items: type: string errorCode: type: - string - 'null' 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 AgentTriggerAllowedType: type: string description: '' x-enumNames: - Unrestricted - Domains - Emails enum: - Unrestricted - Domains - Emails 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' FileProcessingLogDetails: type: object additionalProperties: false properties: timestamp: type: string format: date-time message: type: string NistAiRmfTier: type: string description: '' x-enumNames: - Tier1 - Tier2 - Tier3 - Tier4 - Tier5 - NotApplicable enum: - Tier1 - Tier2 - Tier3 - Tier4 - Tier5 - NotApplicable 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 AgentEvaluationVariant: type: object additionalProperties: false properties: variantId: type: string format: guid label: type: string isBaseline: type: boolean overrides: oneOf: - $ref: '#/components/schemas/ExternalScenarioOverrides' SourceType: type: string description: '' x-enumNames: - UserProvided - Library enum: - userProvided - library 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' WebhookConfiguration: type: object additionalProperties: false properties: impersonateUser: type: boolean successfulResponseCode: type: integer format: int32 failedResponseCode: type: integer format: int32 useExternalUserMapping: type: - boolean - 'null' requireUserMapping: type: - boolean - 'null' autoProvisionUsers: type: - boolean - 'null' provisionedUserRole: type: - string - 'null' sendTypingIndicator: type: - boolean - 'null' teamsAppId: type: - string - 'null' oneDriveDriveId: type: - string - 'null' oneDriveFolderId: type: - string - 'null' oneDriveCredentialId: type: - string - 'null' format: guid oneDriveProviderConfigurationId: type: - string - 'null' format: guid oneDriveAllowedExtensions: type: - array - 'null' items: type: string oneDriveIncludeSubfolders: type: - boolean - 'null' oneDriveGraphSubscriptionId: type: - string - 'null' oneDriveClientState: type: - string - 'null' oneDriveSubscriptionExpiration: type: - string - 'null' format: date-time oneDriveDeltaLink: type: - string - 'null' sharePointSiteId: type: - string - 'null' sharePointDriveId: type: - string - 'null' sharePointFolderId: type: - string - 'null' sharePointListId: type: - string - 'null' sharePointCredentialId: type: - string - 'null' format: guid sharePointProviderConfigurationId: type: - string - 'null' format: guid sharePointAllowedExtensions: type: - array - 'null' items: type: string sharePointIncludeSubfolders: type: - boolean - 'null' sharePointGraphSubscriptionId: type: - string - 'null' sharePointClientState: type: - string - 'null' sharePointSubscriptionExpiration: type: - string - 'null' format: date-time sharePointDeltaLink: type: - string - 'null' fetchChannelContext: type: - boolean - 'null' channelContextMessageCount: type: - integer - 'null' format: int32 asanaHookSecret: type: - string - 'null' 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' AgentDetailItem: type: object additionalProperties: false properties: type: type: string name: type: string value: {} options: type: - array - 'null' items: type: string WebhookAuthorizationBase: type: object discriminator: propertyName: $type mapping: WebhookHmacAuthorization: '#/components/schemas/WebhookHmacAuthorization' x-abstract: true additionalProperties: false required: - $type properties: $type: type: string 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 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 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' AgentToolAnnotationsDefinition: type: object additionalProperties: false properties: destructiveHint: type: - boolean - 'null' idempotentHint: type: - boolean - 'null' openWorldHint: type: - boolean - 'null' readOnlyHint: type: - boolean - 'null' title: type: - string - 'null' 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' ProjectType: type: string description: '' x-enumNames: - Standard - Frontline - Legal - FieldService - BrainFreeze enum: - Standard - Frontline - Legal - FieldService - BrainFreeze 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 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 WhatIfBaselineMode: type: string description: '' x-enumNames: - FreshInJob - ReuseExisting enum: - FreshInJob - ReuseExisting ModelState: type: string description: '' x-enumNames: - Unknown - Pending - Retrieving - Storing - Finished - Failed enum: - unknown - pending - retrieving - storing - finished - failed 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 EmailAction: type: string description: '' x-enumNames: - Reply - ReplyAll - Forward - None enum: - Reply - ReplyAll - Forward - None 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' DateTimeTimezoneSettingsDefinition: type: object additionalProperties: false properties: mode: type: - string - 'null' value: type: - string - 'null' ParameterLocation: type: string description: '' x-enumNames: - QueryString - Header - Body enum: - QueryString - Header - Body ConnectionServiceNow: type: object additionalProperties: false properties: instanceUrl: type: string username: type: string password: type: string WebhookType: type: string description: '' x-enumNames: - Manual - GitHub - SlackEventSubscriptions - TeamsBotFramework - WhatsAppCloudApi - DropBox - OneDrive - SharePoint - Asana enum: - Manual - GitHub - SlackEventSubscriptions - TeamsBotFramework - WhatsAppCloudApi - DropBox - OneDrive - SharePoint - Asana 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' CustomCredentialsDefinition: type: object additionalProperties: false properties: id: type: string format: guid name: type: string credentialType: type: string credentialData: 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' 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 RetryConfigurationDefinition: type: object additionalProperties: false properties: enabled: type: boolean maxRetries: type: integer format: int32 delay: type: integer format: int32 maxDelay: type: integer format: int32 backoffMultiplier: type: number format: double useJitter: type: boolean SdkStepCredentialReference: type: object additionalProperties: false properties: propertyName: type: string originalCredentialId: type: string format: guid credentialsDefinition: $ref: '#/components/schemas/CredentialsDefinition' required: type: boolean supportedTypes: type: array items: type: string SpmProviderKind: type: string description: '' x-enumNames: - AgentRefresh - ShadowAI - CodeScanner - Analytics - EndpointInventory - ProcessExecutionDetection enum: - AgentRefresh - ShadowAI - CodeScanner - Analytics - EndpointInventory - ProcessExecutionDetection 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 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 QuickActionDefinition: type: object additionalProperties: false properties: id: type: string displayName: type: string quickActionType: type: string assignedAgent: oneOf: - $ref: '#/components/schemas/AssignedAgentDefinition' RuleGroupConditionEntity: allOf: - $ref: '#/components/schemas/RuleConditionEntity' - type: object additionalProperties: false properties: logicalOperator: type: string children: type: array items: $ref: '#/components/schemas/RuleConditionEntity' AgentSummaryDeploymentDtoV2: type: object additionalProperties: false properties: id: type: string format: guid deploymentType: $ref: '#/components/schemas/AgentDeploymentType' ParameterDataType: type: string description: '' x-enumNames: - String - Integer - Decimal - Boolean - DateTime - Array - Object enum: - String - Integer - Decimal - Boolean - DateTime - Array - Object MitigationStepCompletionSource: type: string description: '' x-enumNames: - Manual - Verified enum: - Manual - Verified 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 CredentialsDefinition: type: object additionalProperties: false properties: name: type: string credentialType: type: string sourceType: type: string credentialDataList: type: array items: $ref: '#/components/schemas/CredentialsDataListDefinition' displayIdentifierName: type: - string - 'null' administrativeScope: type: - string - 'null' origin: type: - string - 'null' customCredentials: oneOf: - $ref: '#/components/schemas/CustomCredentialsDefinition' id: type: string format: guid ConnectionAzureFoundry: type: object additionalProperties: false properties: projectEndpoint: type: string tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' evaluationsEnabled: type: boolean 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 AgentSkill2: type: object additionalProperties: false properties: id: type: string name: type: string description: type: string tags: type: array items: type: string examples: type: - array - 'null' items: type: string inputModes: type: - array - 'null' items: type: string outputModes: type: - array - 'null' items: type: string securityRequirements: type: - array - 'null' items: $ref: '#/components/schemas/SecurityRequirement2' EuAiActCategory: type: string description: '' x-enumNames: - Prohibited - HighRisk - LimitedRisk - MinimalRisk - NotApplicable enum: - Prohibited - HighRisk - LimitedRisk - MinimalRisk - NotApplicable McpHydrationFailurePolicyDefinition: type: string description: '' x-enumNames: - Unspecified - ContinueWithoutUnavailableTools - FailExecution enum: - Unspecified - ContinueWithoutUnavailableTools - FailExecution ConnectionLangGraph: type: object additionalProperties: false properties: apiKey: type: string url: type: string 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 PipelineEditorVersionDto: type: object additionalProperties: false required: - id - pipelineId - versionNumber - majorVersion - minorVersion - isDraftVersion - isLatest - isDeprecated - alignment properties: id: type: string format: guid pipelineId: type: string format: guid versionNumber: type: string majorVersion: type: integer format: int32 minorVersion: type: integer format: int32 isDraftVersion: type: boolean isLatest: type: boolean isDeprecated: type: boolean createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time userId: type: - string - 'null' format: guid versionName: type: - string - 'null' tags: type: array items: type: string description: type: - string - 'null' alignment: $ref: '#/components/schemas/PipelineAlignment' 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 HandleDefinition: type: object additionalProperties: false properties: uuid: type: string format: guid type: type: string maxLength: 6 label: type: - string - 'null' maxLength: 100 tooltip: type: - string - 'null' x: type: number format: float y: type: number format: float 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 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 AgentExtension2: type: object additionalProperties: false properties: uri: type: string description: type: - string - 'null' required: type: - boolean - 'null' params: type: - object - 'null' additionalProperties: {} 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 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 AssessmentTemplateVersionStatus: type: string description: '' x-enumNames: - Processing - Completed - Failed enum: - Processing - Completed - Failed 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' ConditionalBranchConfigurationDefinition: type: object additionalProperties: false properties: id: type: string format: guid label: type: - string - 'null' 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' PipelineEditorVersionsDto: type: object additionalProperties: false required: - pipelineId - projectId - versions properties: pipelineId: type: string format: guid projectId: type: string format: guid name: type: - string - 'null' activeVersionId: type: - string - 'null' format: guid versions: type: array items: $ref: '#/components/schemas/PipelineEditorVersionDto' 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 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 EntityNamesResult: type: object additionalProperties: false properties: names: type: object additionalProperties: type: string ChunkingConfigDefinition: type: object additionalProperties: false properties: id: type: string format: guid chunkSize: type: integer format: int32 chunkOverlap: type: integer format: int32 strategyType: type: string 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' 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' 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 ModelDefinition: type: object additionalProperties: false properties: id: type: string format: guid displayName: type: string modelName: type: - string - 'null' promptId: type: - string - 'null' format: guid systemPromptDefinition: oneOf: - $ref: '#/components/schemas/PromptDefinition' url: type: - string - 'null' inputType: type: - string - 'null' provider: type: - string - 'null' credentialsDefinition: oneOf: - $ref: '#/components/schemas/CredentialsDefinition' deploymentType: type: - string - 'null' sourceType: type: string connectionString: type: - string - 'null' containerName: type: - string - 'null' deployedKey: type: - string - 'null' deployedUrl: type: - string - 'null' state: type: - string - 'null' uploadedContainerId: type: - string - 'null' format: guid libraryModelId: type: - string - 'null' format: guid inputTokenPrice: type: - string - 'null' outputTokenPrice: type: - string - 'null' tokenUnits: type: - integer - 'null' format: int32 hasToolSupport: type: - boolean - 'null' allowAiriaCredentials: type: - boolean - 'null' allowBYOKCredentials: type: - boolean - 'null' author: type: - string - 'null' priceType: type: - string - 'null' category: type: - string - 'null' maxOutputTokens: type: - integer - 'null' format: int32 UseCaseCore: type: object additionalProperties: false properties: summary: type: - string - 'null' tags: type: array items: type: string ConnectionDatabricks: type: object additionalProperties: false properties: workspaceUrl: type: string accessToken: type: string McpServerPlaceholderDefinition: 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 selectedTools: type: - array - 'null' items: type: string authenticationType: type: - string - 'null' ExportPipelineDefinition: type: object additionalProperties: false properties: available: type: boolean metadata: $ref: '#/components/schemas/PipelineDefinitionMetadata' agent: $ref: '#/components/schemas/PipelineDefinition' dataSources: type: - array - 'null' items: $ref: '#/components/schemas/DataSourcesDefinition' prompts: type: - array - 'null' items: $ref: '#/components/schemas/PromptDefinition' tools: type: - array - 'null' items: $ref: '#/components/schemas/ToolsExportDefinition' models: type: - array - 'null' items: $ref: '#/components/schemas/ModelDefinition' memories: type: - array - 'null' items: $ref: '#/components/schemas/MemoryDefinition' pythonCodeBlocks: type: - array - 'null' items: $ref: '#/components/schemas/PythonCodeBlockDefinition' routers: type: - array - 'null' items: $ref: '#/components/schemas/RouterDefinition' approvalRequests: type: - array - 'null' items: $ref: '#/components/schemas/ApprovalRequestDefinition' webhookApprovalRequests: type: - array - 'null' items: $ref: '#/components/schemas/WebhookApprovalRequestDefinition' customFormApprovalRequests: type: - array - 'null' items: $ref: '#/components/schemas/CustomFormApprovalRequestDefinition' agentCards: type: - array - 'null' items: $ref: '#/components/schemas/AgentCardDefinition' subAgents: type: - array - 'null' items: $ref: '#/components/schemas/PipelineDefinition' subAgentInterfaces: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/InterfacesDefinition' deployment: oneOf: - $ref: '#/components/schemas/DeploymentDefinition' interfaces: oneOf: - $ref: '#/components/schemas/InterfacesDefinition' eventTriggers: type: - array - 'null' items: $ref: '#/components/schemas/AgentEventTriggerDefinition' sdkSteps: type: - array - 'null' items: $ref: '#/components/schemas/SdkStepDefinition' mcpServerPlaceholders: type: - array - 'null' items: $ref: '#/components/schemas/McpServerPlaceholderDefinition' 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 ConnectionGeminiEnterprise: type: object additionalProperties: false properties: projectId: type: string location: type: string serviceAccountJson: type: string 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 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' 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' ScenarioOverrideKind: type: string description: '' x-enumNames: - Internal - External enum: - Internal - External 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 ConnectionPurview: type: object additionalProperties: false properties: tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' accountName: type: - string - 'null' AiAssetDisplayStatus: type: string description: '' x-enumNames: - Unrevised - Undefined - Updated enum: - Unrevised - Undefined - Updated 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 PipelineStepDefinition: type: object additionalProperties: false required: - stepTitle properties: id: type: string format: guid stepType: type: string position: $ref: '#/components/schemas/PositionDefinition' handles: type: array items: $ref: '#/components/schemas/HandleDefinition' dependenciesObject: type: array items: $ref: '#/components/schemas/PipelineStepDependencyDefinition' temperature: type: - number - 'null' format: float reasoningEffort: type: - string - 'null' includeDateTimeContext: type: - boolean - 'null' dateTimeTimezoneSettings: oneOf: - $ref: '#/components/schemas/DateTimeTimezoneSettingsDefinition' includeUserDetailsContext: type: - boolean - 'null' promptId: type: - string - 'null' format: guid promptSegments: type: - array - 'null' items: $ref: '#/components/schemas/PromptSegmentDefinition' modelId: type: - string - 'null' format: guid toolIds: type: - array - 'null' items: type: string format: guid agentDelegateIds: type: - array - 'null' items: type: string format: guid toolParamsJson: type: - string - 'null' dataSourceId: type: - string - 'null' format: guid topK: type: - integer - 'null' format: int32 relevanceThreshold: type: - number - 'null' format: float neighboringChunksCount: type: - integer - 'null' format: int32 hybridSearchAlpha: type: - number - 'null' format: float databaseType: type: - string - 'null' enableSqlQueries: type: - boolean - 'null' fuzzySearch: type: - boolean - 'null' sqlResultLimit: type: - integer - 'null' format: int32 hybridSearchFusionType: type: - string - 'null' userInputOnVectorSearch: type: - boolean - 'null' performReranking: type: - boolean - 'null' memoryId: type: - string - 'null' format: guid pythonCodeBlockId: type: - string - 'null' format: guid useUserIdTokenForwarding: type: - boolean - 'null' includedStepResultTitles: type: - array - 'null' items: type: string approvalRequestId: type: - string - 'null' format: guid webhookApprovalRequestId: type: - string - 'null' format: guid customFormApprovalRequestId: type: - string - 'null' format: guid agentCardId: type: - string - 'null' format: guid backgroundColor: type: - string - 'null' content: type: - string - 'null' stepTitle: type: string parentId: type: - string - 'null' format: guid width: type: - integer - 'null' format: int32 height: type: - integer - 'null' format: int32 loopStepConfiguration: oneOf: - $ref: '#/components/schemas/LoopStepConfigurationDefinition' jsonFormatterStepConfiguration: oneOf: - $ref: '#/components/schemas/JsonFormatterStepConfigurationDefinition' inputVariablesJson: type: - string - 'null' inputTemplate: type: - string - 'null' includeChatHistory: type: - boolean - 'null' isMultiRoute: type: - boolean - 'null' routerConfigJson: type: - string - 'null' conditionalBranchCode: type: - string - 'null' conditionalBranchConfigJson: type: - string - 'null' routerConfig: type: - object - 'null' additionalProperties: $ref: '#/components/schemas/ConditionalBranchConfigurationDefinition' selectedPromptVersion: type: - string - 'null' format: guid stepParams: type: - object - 'null' additionalProperties: type: string useUserInput: type: - boolean - 'null' aiOperationStepIncludeChatHistory: type: - boolean - 'null' aiOperationStepIncludeAttachments: type: - boolean - 'null' aiOperationStepUseDataSource: type: - boolean - 'null' selectedDataSources: type: - array - 'null' items: type: string format: guid memoryStoreStepAppendText: type: - boolean - 'null' aiOperationStepChatHistoryMessagesLimit: type: - integer - 'null' format: int32 aiOperationStepOutputSchemaJson: type: - string - 'null' executePipelineId: type: - string - 'null' format: guid selectedPipelineVersion: type: - string - 'null' format: guid embeddedAgentVariablesJson: type: - string - 'null' preferredPdfParserId: type: - string - 'null' format: guid customPdfParserPrompt: type: - string - 'null' retryConfiguration: oneOf: - $ref: '#/components/schemas/RetryConfigurationDefinition' mcpServerDeploymentIds: type: - array - 'null' items: type: string format: guid mcpHydrationFailurePolicy: oneOf: - $ref: '#/components/schemas/McpHydrationFailurePolicyDefinition' mcpServerDeploymentParamsJson: type: - string - 'null' documentSplitterPrompt: type: - string - 'null' documentSplitterWindowSize: type: - integer - 'null' format: int32 documentSplitterMaxWindowSize: type: - integer - 'null' format: int32 documentSplitterOutputSchemaJson: type: - string - 'null' DeploymentPrompt: type: string description: '' x-enumNames: - Artifact - Citation enum: - Artifact - Citation AssignedAgent: type: object additionalProperties: false properties: deploymentId: type: string format: guid agentName: type: string agentUrl: type: string isConfigurable: type: boolean EmbeddingProviderType: type: string description: '' x-enumNames: - Unknown - OpenAi - AzureVision - Clip - Cohere - Ollama enum: - Unknown - OpenAI - AzureVision - Clip - Cohere - Ollama UseCaseAssetAssignment: type: object additionalProperties: false properties: useCaseId: type: string format: guid aiAssetAggregateId: type: string format: guid aiAssetVersionId: type: - string - 'null' format: guid 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' 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' BulkDeletePipelineFailureReason: type: string description: '' x-enumNames: - Blocked - NotFound - Error enum: - Blocked - NotFound - Error PipelineEditorShellDto: type: object additionalProperties: false required: - id - projectId - hasDeployments - hasDrafts properties: id: type: string format: guid projectId: type: string format: guid name: type: - string - 'null' backupPipelineId: type: - string - 'null' format: guid agentIcon: type: - string - 'null' activeVersionId: type: - string - 'null' format: guid activeVersion: oneOf: - $ref: '#/components/schemas/PipelineEditorVersionDto' hasDeployments: type: boolean hasDrafts: type: boolean AgentEventTriggerDefinition: type: object additionalProperties: false properties: eventTypeName: type: - string - 'null' filters: type: - object - 'null' additionalProperties: type: array items: type: string triggerMode: type: - string - 'null' WebhookActionType: type: string description: '' x-enumNames: - None - Agent - SlackBot - TeamsBot - WhatsAppBot - MicrosoftGraphFileTrigger enum: - None - Agent - SlackBot - TeamsBot - WhatsAppBot - MicrosoftGraphFileTrigger GatewayApiKeyOrigin: type: string description: '' x-enumNames: - SelfServe - EndpointAgent - SecurePosture enum: - SelfServe - EndpointAgent - SecurePosture CustomFormApprovalRequestDefinition: type: object additionalProperties: false properties: id: type: string format: guid emailNotification: type: boolean title: type: - string - 'null' description: type: - string - 'null' actions: type: - array - 'null' items: $ref: '#/components/schemas/CustomFormActionDefinition' structuredOutputSchema: {} useCustomFields: type: boolean 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' 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 AgentTriggersDefinition: type: object additionalProperties: false properties: allowedType: type: - string - 'null' emailAction: type: - string - 'null' 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' 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' ConnectionGoogleAgentPlatform: type: object additionalProperties: false properties: projectId: type: string location: type: string serviceAccountJson: type: string PipelineIntegrations: type: object additionalProperties: false properties: pipelineId: type: string format: guid integrationsMap: type: object additionalProperties: $ref: '#/components/schemas/ToolIntegration' mcpDeployments: type: array items: $ref: '#/components/schemas/McpDeploymentIntegration' 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 DeploymentTargetAgent: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object additionalProperties: false properties: deploymentId: type: string format: guid targetPipelineId: type: string format: guid CreatePipelineRequest: type: object additionalProperties: false properties: name: type: - string - 'null' executionName: type: - string - 'null' description: type: - string - 'null' markdownDescription: type: - string - 'null' videoLink: type: - string - 'null' projectId: type: string format: guid agentIconId: type: - string - 'null' format: guid agentIconUri: type: - string - 'null' agentIconBase64: type: - string - 'null' agentUnicodeIcon: type: - string - 'null' alignment: oneOf: - $ref: '#/components/schemas/PipelineAlignment' steps: type: - array - 'null' items: $ref: '#/components/schemas/PipelineStep' sourceVersionId: type: - string - 'null' format: guid tenantId: type: string format: guid libraryAgentId: type: - string - 'null' format: guid agentDetails: type: - object - 'null' additionalProperties: type: array items: $ref: '#/components/schemas/AgentDetailItem' industry: type: - string - 'null' subIndustries: type: - array - 'null' items: type: string libraryImportedHash: type: - string - 'null' libraryImportedVersion: type: - string - 'null' isSeeded: type: boolean behaviours: type: - array - 'null' items: $ref: '#/components/schemas/AgentBehaviours' departmentId: type: - string - 'null' format: guid tags: type: array items: type: string isEndUserPrivate: type: boolean saveToolResponsesToHistory: type: boolean 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' BaseOptionalProjectEntity: allOf: - $ref: '#/components/schemas/BaseEntity' - type: object x-abstract: true additionalProperties: false properties: projectId: type: - string - 'null' format: guid ConnectionCloudflare: type: object additionalProperties: false properties: accountId: type: - string - 'null' apiToken: type: - string - 'null' maxRecordsPerRequest: type: - integer - 'null' format: int32 PagedResultOfPaginatedPipelineWithScheduleDto: type: object additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PaginatedPipelineWithScheduleDto' totalCount: type: integer format: int32 MemoryDefinition: type: object additionalProperties: false properties: id: type: string format: guid name: type: string isUserSpecific: type: boolean isConversationScoped: type: - boolean - 'null' defaultValue: type: - string - 'null' 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 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' 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' AgentProvider2: type: object additionalProperties: false properties: organization: type: string url: type: string LoopStepConfigurationDefinition: type: object additionalProperties: false properties: stopOnError: type: boolean retryOnError: type: boolean retryOnErrorCount: type: integer format: int32 maxIterations: type: integer format: int32 executionMode: type: string parallelConfiguration: oneOf: - $ref: '#/components/schemas/LoopStepParallelConfigurationDefinition' batchConfiguration: oneOf: - $ref: '#/components/schemas/LoopStepBatchConfigurationDefinition' inputExpression: type: - string - 'null' ToolProvider: type: string description: '' x-enumNames: - Custom - JinaAI - WolframAlpha - AlphaVantage - Postgres - MySQL - Atlassian - ArXivOrg - SendGrid - Google - MathJS - IPAPI - WeatherStack - Snowflake - OpenAI - Nutritionix - Asana - Firecrawl - Exa - NASA - MSSQLServer - Serper - X - Microsoft - MicrosoftBingSearch - Airia - Salesforce - Hubspot - ICD - Reddit - Strava - Spotify - NewsAPI - LinkPreview - Youtube - ServiceNow - DataBricks - MongoDb - Zapier - GitHub - HubSpot - Notion - ElevenLabs - Terraform - Anthropic - Supabase - BraveSearch - Slack - FRED - RegulationsGov - SEC - Pinecone - LaunchDarkly - Perplexity - Stripe - Airtable - SAP - Agent enum: - Custom - Jina AI - Wolfram Alpha - AlphaVantage - Postgres - MySQL - Atlassian - ArXiv.org - SendGrid - Google - Math JS - IP API - WeatherStack - Snowflake - OpenAI - Nutritionix - Asana - Firecrawl - Exa - NASA - MSSQLServer - Serper - X - Microsoft - MicrosoftBingSearch - Airia - Salesforce - Hubspot - ICD - Reddit - Strava - Spotify - NewsAPI - LinkPreview - Youtube - ServiceNow - DataBricks - MongoDb - Zapier - GitHub - HubSpot - Notion - ElevenLabs - Terraform - Anthropic - Supabase - BraveSearch - Slack - FRED - RegulationsGov - SEC - Pinecone - LaunchDarkly - Perplexity - Stripe - Airtable - SAP - Agent 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 AgentCapabilities2: type: object additionalProperties: false properties: streaming: type: - boolean - 'null' pushNotifications: type: - boolean - 'null' extendedAgentCard: type: - boolean - 'null' extensions: type: - array - 'null' items: $ref: '#/components/schemas/AgentExtension2' AiAssetSourceSyncParameterType: type: string description: '' x-enumNames: - AzureOpenAI - AwsBedrock - GoogleVertex enum: - AzureOpenAI - AwsBedrock - GoogleVertex 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' WebhookEntity: allOf: - $ref: '#/components/schemas/BaseOptionalProjectEntity' - type: object additionalProperties: false required: - friendlyName - actionType - authorizationType properties: friendlyName: type: string maxLength: 128 minLength: 1 description: type: - string - 'null' maxLength: 512 actionType: $ref: '#/components/schemas/WebhookActionType' authorizationType: $ref: '#/components/schemas/WebhookAuthorizationType' actionId: type: - string - 'null' format: guid authorization: oneOf: - $ref: '#/components/schemas/WebhookAuthorizationBase' configuration: $ref: '#/components/schemas/WebhookConfiguration' type: $ref: '#/components/schemas/WebhookType' enabled: type: boolean 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' 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 VectorStoreDefinition: type: object additionalProperties: false properties: hostingType: type: - string - 'null' modality: type: - string - 'null' provider: type: - string - 'null' storeTypeId: type: - string - 'null' credentialId: type: - string - 'null' configurationJson: type: - string - 'null' sparseVectorEnabled: type: boolean embeddingProvider: type: - string - 'null' embeddingConfigurationJson: type: - string - 'null' 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 PythonCodeBlockDefinition: type: object additionalProperties: false properties: id: type: string format: guid code: type: string credentialIds: type: - object - 'null' additionalProperties: type: string oAuthProviderConfigIds: type: - object - 'null' additionalProperties: type: string isStructuredOutputEnabled: type: - boolean - 'null' includeParsedFiles: type: - boolean - 'null' credentialsDefinitions: type: - array - 'null' items: $ref: '#/components/schemas/CredentialsDefinition' FileProcessingStatus: type: string description: '' x-enumNames: - Pending - Processing - Processed - Failed enum: - Pending - Processing - Processed - Failed UserPromptDefinition: type: object additionalProperties: false properties: name: type: string message: type: string promptDescription: type: string 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 CredentialsDataListDefinition: type: object additionalProperties: false properties: key: type: string value: type: string JsonFormatterStepConfigurationDefinition: type: object additionalProperties: false properties: template: type: string fallbackToRawResultOnUnresolvedPath: type: boolean 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 DataSourcesDefinition: type: object additionalProperties: false properties: id: type: string format: guid name: type: - string - 'null' executionName: type: - string - 'null' chunkingConfig: oneOf: - $ref: '#/components/schemas/ChunkingConfigDefinition' dataSourceType: type: string databaseType: type: - string - 'null' embeddingProvider: type: - string - 'null' isUserSpecific: type: boolean files: type: - array - 'null' items: $ref: '#/components/schemas/DataSourceFileDefinition' fileCount: type: - integer - 'null' format: int32 configurationJson: type: - string - 'null' credentials: oneOf: - $ref: '#/components/schemas/CredentialsDefinition' isImageProcessingEnabled: type: boolean description: type: - string - 'null' vectorStore: oneOf: - $ref: '#/components/schemas/VectorStoreDefinition' scanDocumentForImages: type: boolean imageProcessingPrompt: type: - string - 'null' storeType: type: - string - 'null' tableDocumentProcessingMode: type: - string - 'null' parserConfigurationJson: type: - string - 'null' PipelineVersionEditorDto: type: object additionalProperties: false required: - id - pipelineId - majorVersion - minorVersion - versionNumber - isDraftVersion - isLatest - isDeprecated - alignment - steps properties: id: type: string format: guid pipelineId: type: string format: guid majorVersion: type: integer format: int32 minorVersion: type: integer format: int32 versionNumber: type: string isDraftVersion: type: boolean isLatest: type: boolean isDeprecated: type: boolean alignment: $ref: '#/components/schemas/PipelineAlignment' description: type: - string - 'null' versionName: type: - string - 'null' createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time userId: type: - string - 'null' format: guid steps: type: array items: type: array items: $ref: '#/components/schemas/KeyValuePairOfStringAndJsonNode' 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 PositionDefinition: type: object additionalProperties: false properties: x: type: string y: type: string 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 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 PagedResultV2OfAgentSummaryDtoV2: type: object additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/AgentSummaryDtoV2' totalCount: type: - integer - 'null' format: int32 hasMore: type: - boolean - 'null' PipelineStepDependencyDefinition: type: object additionalProperties: false properties: parentId: type: string format: guid parentHandleId: type: string format: guid handleId: type: string format: guid 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' RiskRegistryType: type: string description: '' x-enumNames: - UseCase enum: - UseCase GovernanceFrameworkReleaseState: type: string description: '' x-enumNames: - Draft - Preview - Ready - Retired enum: - Draft - Preview - Ready - Retired CreatePipelineVersionTagRequest: type: object additionalProperties: false required: - tag - pipelineVersionId properties: tag: type: string pipelineVersionId: type: string format: guid LoopStepParallelConfigurationDefinition: type: object additionalProperties: false properties: maxDegreeOfParallelism: type: integer format: int32 UseCaseReviewPolicy: type: object additionalProperties: false properties: disclaimerText: type: - string - 'null' reviewCadence: type: - string - 'null' nextReviewDate: type: - string - 'null' format: date-time ConversationType: type: string description: '' x-enumNames: - StandardChat - ImageOnly - FileOnly enum: - StandardChat - ImageOnly - FileOnly 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' 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' PipelineVersionTagDto: type: object additionalProperties: false required: - pipelineId - tag - pipelineVersionId properties: pipelineId: type: string format: guid tag: type: string pipelineVersionId: type: string format: guid updatedAt: type: - string - 'null' format: date-time RouterConfigurationDefinition: type: object additionalProperties: false properties: id: type: string format: guid prompt: type: string isDefault: type: - boolean - 'null' InterfacesDefinition: type: object additionalProperties: false properties: emailInbox: oneOf: - $ref: '#/components/schemas/AgentTriggersDefinition' toolInterface: oneOf: - $ref: '#/components/schemas/AgentToolInterfaceDefinition' AssessmentStatus: type: string description: '' x-enumNames: - Draft - Pending - Approved - Rejected - AutoComplete - ReadyForReview - AutoCompleteFailed enum: - Draft - Pending - Approved - Rejected - AutoComplete - ReadyForReview - AutoCompleteFailed ConnectionMicrosoftDefenderXdr: type: object additionalProperties: false properties: tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' maxUsers: type: - integer - 'null' format: int32 AssessmentTemplateSubCategory: type: string description: '' x-enumNames: - Impact - Risk - Vendor - Register enum: - Impact - Risk - Vendor - Register 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' AgentSummaryFilter: type: string description: '' x-enumNames: - AllAgents - ExternalAgent enum: - AllAgents - ExternalAgent ToolHeadersDefinition: type: object additionalProperties: false properties: key: type: string value: type: string sensitive: type: boolean AgentToolInterfaceDefinition: type: object additionalProperties: false properties: name: type: string title: type: - string - 'null' description: type: string inputSchema: type: string outputSchema: type: - string - 'null' enabled: type: boolean annotations: oneOf: - $ref: '#/components/schemas/AgentToolAnnotationsDefinition' 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' ApiKeyScopeName: type: string description: '' x-enumNames: - Conversations - Project - Findings - EndpointAgentPolicy - BrowserExtensionProvisioning - LiteLlmGuardrail enum: - Conversations - Project - Findings - EndpointAgentPolicy - BrowserExtensionProvisioning - LiteLlmGuardrail 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 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 McpDeploymentIntegration: type: object additionalProperties: false properties: id: type: string format: guid name: type: string gatewayLibraryId: type: string format: guid credentialId: type: - string - 'null' format: guid iconUrl: type: - string - 'null' authenticationType: type: - string - 'null' oauthProviderConfigId: type: - string - 'null' PipelineScheduleModel: allOf: - $ref: '#/components/schemas/ScheduleModel' - type: object additionalProperties: false required: - pipelineId - versionNumber properties: pipelineId: type: string format: guid minLength: 1 versionNumber: type: string minLength: 1 userInput: type: - string - 'null' pipelineVersionId: type: string format: guid 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 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' MitigationStepOrigin: type: string description: '' x-enumNames: - Generated - Manual enum: - Generated - Manual AiAssetInternalStatus: type: string description: '' x-enumNames: - Undefined - Synchronizing - MissingFromSource enum: - Undefined - Synchronizing - MissingFromSource 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 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 ConnectionAtlan: type: object additionalProperties: false properties: baseUrl: type: string apiToken: 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' 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' 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' ConnectionOpenAi: type: object additionalProperties: false properties: workspaceLabel: type: - string - 'null' enabledCapabilities: type: array items: $ref: '#/components/schemas/SpmProviderKind' 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 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' ConnectionCrewAi: type: object additionalProperties: false properties: baseUrl: type: string apiToken: type: string organizationId: type: - string - 'null' WebhookAuthorizationType: type: string description: '' x-enumNames: - None - Hmac enum: - None - Hmac 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 InputType: type: string description: '' x-enumNames: - Text - Image - Audio - Video enum: - text - image - audio - video 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 DeploymentType: type: string description: '' x-enumNames: - Marketplace - External - Internal enum: - marketplace - external - internal 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' DataSourceFileDefinition: type: object additionalProperties: false properties: dataSourceId: type: string format: guid filePath: type: - string - 'null' inputToken: type: - string - 'null' EnforcementMode: type: string description: '' x-enumNames: - Legacy - Audit - Enforce enum: - Legacy - Audit - Enforce 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' 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 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' SpmSecurityScoreStatus: type: string description: '' x-enumNames: - NotAnalyzed - Analyzed - Error - NotApplicable enum: - NotAnalyzed - Analyzed - Error - NotApplicable ToolsExportDefinition: type: object additionalProperties: false properties: toolType: type: string name: type: string standardizedName: type: string toolDescription: type: string purpose: type: string apiEndpoint: type: string credentialsDefinition: oneOf: - $ref: '#/components/schemas/CredentialsDefinition' headersDefinition: type: - array - 'null' items: $ref: '#/components/schemas/ToolHeadersDefinition' body: type: - string - 'null' parametersDefinition: type: - array - 'null' items: $ref: '#/components/schemas/ToolParametersDefinition' methodType: type: string routeThroughACC: type: - boolean - 'null' accGroup: type: - string - 'null' iconUrl: type: - string - 'null' useUserCredentials: type: boolean useUserCredentialsType: type: - string - 'null' provider: type: - string - 'null' bodyType: type: - string - 'null' numberOfPages: type: - string - 'null' shouldRetrieveFullPageContent: type: - string - 'null' schemaDefinition: type: - string - 'null' requestTimeout: type: - integer - 'null' format: int32 annotations: type: - object - 'null' additionalProperties: {} shouldReroute: type: - boolean - 'null' credentialsSourceType: type: - string - 'null' useJwtForwarding: type: - boolean - 'null' id: type: string format: guid agentId: type: - string - 'null' format: guid EvaluationType: type: string description: '' x-enumNames: - Standard - RedTeaming - Bias - StandardBiasDrift - Consistency enum: - Standard - RedTeaming - Bias - StandardBiasDrift - Consistency AgentInterface2: type: object additionalProperties: false properties: url: type: string protocolBinding: type: string protocolVersion: type: string tenant: type: - string - 'null' BrowserExtensionConfigDefinition: type: object additionalProperties: false properties: browserType: type: string quickActions: type: array items: $ref: '#/components/schemas/QuickActionDefinition' PaginatedPipelineDtoWithClassifications: allOf: - $ref: '#/components/schemas/PaginatedPipelineDto' - type: object additionalProperties: false properties: classifications: type: - array - 'null' items: $ref: '#/components/schemas/ClassificationAssignment' lastExecutionDate: type: - string - 'null' format: date-time hasScheduleInterface: type: boolean hasDeploymentSchedules: type: boolean webhooks: type: array items: $ref: '#/components/schemas/WebhookEntity' 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' 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 BulkDeletePipelinesRequest: type: object additionalProperties: false required: - pipelineIds properties: pipelineIds: type: array maxItems: 100 minItems: 1 items: type: string format: guid AgentSummaryDtoV2: type: object additionalProperties: false properties: id: type: string format: guid projectId: type: string format: guid activeVersionId: type: - string - 'null' format: guid name: type: - string - 'null' description: type: - string - 'null' createdAt: type: - string - 'null' format: date-time updatedAt: type: - string - 'null' format: date-time agentIcon: type: - string - 'null' executionStats: oneOf: - $ref: '#/components/schemas/ExecutionStats' apiKeyId: type: - string - 'null' format: guid behaviours: type: - array - 'null' items: $ref: '#/components/schemas/AgentBehaviours' departmentId: type: - string - 'null' format: guid versions: type: array items: $ref: '#/components/schemas/AgentSummaryVersionDtoV2' activeVersion: oneOf: - $ref: '#/components/schemas/AgentSummaryVersionDtoV2' deploymentId: type: - string - 'null' format: guid 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/AgentSummaryDeploymentDtoV2' external: type: boolean hasEmailTrigger: type: boolean hasWebhooks: type: boolean classifications: type: array items: $ref: '#/components/schemas/AgentSummaryClassificationDtoV2' lastExecutionDate: type: - string - 'null' format: date-time hasScheduleInterface: type: boolean hasDeploymentSchedules: type: boolean PromptSegmentDefinition: type: object additionalProperties: false properties: promptId: type: string format: guid order: type: integer format: int32 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 ModelIdentifierType: type: string description: '' x-enumNames: - None - Library - Project enum: - None - Library - Project DayOfWeek: type: string description: '' x-enumNames: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday enum: - Sunday - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday ToolParametersDefinition: type: object additionalProperties: false properties: name: type: string parameterType: type: string parameterDescription: type: string default: type: string validOptions: type: - array - 'null' items: type: string arrayItemType: type: - string - 'null' parameters: type: - array - 'null' items: $ref: '#/components/schemas/ToolParametersDefinition' requirement: type: string AssessmentTemplateScope: type: string description: '' x-enumNames: - Organization - UseCase - Asset enum: - Organization - UseCase - Asset 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' ApiKeyScope: allOf: - $ref: '#/components/schemas/BaseAuditEntity' - type: object additionalProperties: false required: - name properties: id: type: string format: guid name: $ref: '#/components/schemas/ApiKeyScopeName' 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' ToolIntegration: type: object additionalProperties: false properties: toolId: type: string format: guid name: type: - string - 'null' provider: $ref: '#/components/schemas/ToolProvider' credentialSettings: oneOf: - $ref: '#/components/schemas/IntegrationCredentialSettings' isAvailable: type: boolean credentialState: type: - string - 'null' message: type: - string - 'null' credentialReasonCode: type: - string - 'null' isM2MAuthentication: type: boolean credentialDisplayIdentifierName: type: - string - 'null' endpoint: type: - string - 'null' userAuthEnabled: type: boolean userCredentialConnectorId: type: - string - 'null' format: guid parentAgentToolId: type: - string - 'null' format: guid parentAgentName: type: - string - 'null' iconUrl: type: - string - 'null' toolType: type: - string - 'null' PagedResultOfPaginatedPipelineDtoWithClassifications: type: object additionalProperties: false properties: items: type: array items: $ref: '#/components/schemas/PaginatedPipelineDtoWithClassifications' totalCount: type: integer format: int32 SecurePostureStatus: type: string description: '' x-enumNames: - NotSecured - Secured - PartiallySecured - NotSecurableSecurePostureProvider - NotSecurableAiProvider - NotSecurableAiModel - NoAiService enum: - NotSecured - Secured - PartiallySecured - NotSecurableSecurePostureProvider - NotSecurableAiProvider - NotSecurableAiModel - NoAiService 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 IntegrationCredentialSettings: type: object additionalProperties: false properties: availableCredentialTypes: type: array items: type: string defaultValue: type: - string - 'null' platformSupportedOAuthTypes: type: array items: type: string AdministrativeScope: type: string description: '' x-enumNames: - Tenant - Project - Personal enum: - Tenant - Project - User CredentialExportOption: type: string description: '' x-enumNames: - Placeholder - Encrypted enum: - Placeholder - Encrypted AiAssetMetadataValueType: type: string description: '' x-enumNames: - Text - Number - Boolean - DateTime - User enum: - Text - Number - Boolean - DateTime - User PaginatedPipelineWithScheduleDto: allOf: - $ref: '#/components/schemas/PaginatedPipelineDto' - type: object additionalProperties: false properties: schedule: oneOf: - $ref: '#/components/schemas/PipelineScheduleModel' SecurityRequirement2: type: object additionalProperties: false properties: schemes: type: object additionalProperties: type: array items: type: string MitigationVerificationTrigger: type: string description: '' x-enumNames: - Event - Creation - Manual - Scheduled - ResidualRecompute - WorkStarted enum: - Event - Creation - Manual - Scheduled - ResidualRecompute - WorkStarted 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 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 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 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' ConnectionZscaler: type: object additionalProperties: false properties: vanityDomain: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' KeyValuePairOfStringAndJsonNode: type: object additionalProperties: false properties: key: type: - string - 'null' value: oneOf: - $ref: '#/components/schemas/JsonNode' ModelOverride: type: object additionalProperties: false properties: modelId: type: string identifierType: $ref: '#/components/schemas/ModelIdentifierType' ConnectionMicrosoftGraph: type: object additionalProperties: false properties: tenantId: type: - string - 'null' clientId: type: - string - 'null' clientSecret: type: - string - 'null' maxUsers: type: - integer - 'null' format: int32 BulkDeletePipelineFailure: type: object additionalProperties: false properties: pipelineId: type: string format: guid message: type: string reason: $ref: '#/components/schemas/BulkDeletePipelineFailureReason' blockedDetails: oneOf: - $ref: '#/components/schemas/AgentDeletionBlockedDetails' 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 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 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 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 GroupType: type: string description: '' x-enumNames: - Feature - Tenant - Keycloak - EndpointDiscovered enum: - Feature - Tenant - Keycloak - EndpointDiscovered PipelineDefinition: type: object additionalProperties: false properties: id: type: string format: guid name: type: string executionName: type: - string - 'null' agentIcon: type: - string - 'null' agentDescription: type: string markdownDescription: type: - string - 'null' tagline: type: - string - 'null' videoLink: type: - string - 'null' industry: type: - string - 'null' subIndustries: type: - array - 'null' items: type: string tags: type: - array - 'null' items: type: string agentDetails: type: - object - 'null' additionalProperties: type: array items: $ref: '#/components/schemas/AgentDetailItemDefinition' steps: type: array items: $ref: '#/components/schemas/PipelineStepDefinition' behaviours: type: - array - 'null' items: type: string agentUnicodeIcon: type: - string - 'null' agentIconBase64: type: - string - 'null' alignment: type: string saveToolResponsesToHistory: type: - boolean - 'null' 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 ApprovalRequestDefinition: type: object additionalProperties: false properties: id: type: string format: guid message: type: - string - 'null' emailNotification: type: boolean approvalDescription: type: - string - 'null' denialDescription: type: - string - 'null' approvedHandleId: type: string format: guid deniedHandleId: type: string format: guid UseCaseAutonomy: type: string description: '' x-enumNames: - HumanInTheLoop - HumanOnTheLoop - HumanInTheCommand - SupervisedAutonomy - FullAutonomy enum: - HumanInTheLoop - HumanOnTheLoop - HumanInTheCommand - SupervisedAutonomy - FullAutonomy AgentSummaryClassificationDtoV2: type: object additionalProperties: false properties: id: type: string format: guid classificationId: type: string format: guid assignedClassificationLabelId: type: - string - 'null' format: guid inferredClassificationLabelId: type: - string - 'null' format: guid 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 SecurityScheme2: type: object discriminator: propertyName: type mapping: apiKey: '#/components/schemas/ApiKeySecurityScheme2' http: '#/components/schemas/HttpSecurityScheme2' oauth2: '#/components/schemas/OAuth2SecurityScheme2' openIdConnect: '#/components/schemas/OpenIdConnectSecurityScheme2' mutualTLS: '#/components/schemas/MutualTlsSecurityScheme2' x-abstract: true additionalProperties: false required: - type properties: description: type: - string - 'null' type: type: string 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' SdkStepDefinition: type: object additionalProperties: false properties: id: type: string format: guid name: type: string sdkStepType: type: string category: type: string group: type: string version: type: string stepParameters: type: string credentialReferences: type: array items: $ref: '#/components/schemas/SdkStepCredentialReference' supportedCredentialTypes: type: array items: type: string AboutDeploymentMetadata: type: object additionalProperties: false properties: version: type: integer format: int32 videoUrl: type: string BulkDeletePipelinesResult: type: object additionalProperties: false properties: deletedIds: type: array items: type: string format: guid failures: type: array items: $ref: '#/components/schemas/BulkDeletePipelineFailure' 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 AgentBehaviours: type: string description: '' x-enumNames: - IterateCsv - IterateFiles - Voice - IterateDatasourceFiles - IterateDatasourceFileContent enum: - IterateCsv - IterateFiles - Voice - IterateDatasourceFiles - IterateDatasourceFileContent ConnectionSalesforceAgentforce: type: object additionalProperties: false properties: instanceUrl: type: string clientId: type: string clientSecret: type: string 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 DataSourceExportOption: type: string description: '' x-enumNames: - Placeholder - ExportDefinition - FullExport enum: - Placeholder - ExportDefinition - FullExport CustomFormActionDefinition: type: object additionalProperties: false properties: id: type: string format: guid label: type: string handleId: type: string format: guid style: type: string confirmationText: type: - string - 'null' requiresComment: type: boolean ConnectionAzureFunctionApps: type: object additionalProperties: false properties: tenantId: type: string clientId: type: string clientSecret: type: string PipelineLimitResponse: type: object additionalProperties: false properties: limitReached: type: boolean limit: type: integer format: int32 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' AgentCardSignature2: type: object additionalProperties: false properties: protected: type: string signature: type: string header: type: - object - 'null' additionalProperties: {} IntegrationAnalysisRunStatus: type: string description: '' x-enumNames: - Pending - Completed - Failed enum: - Pending - Completed - Failed WebhookApprovalRequestDefinition: type: object additionalProperties: false properties: id: type: string format: guid webhookUrl: type: string timeoutSeconds: type: integer format: int32 maxRetryAttempts: type: integer format: int32 message: type: - string - 'null' approvedHandleId: type: string format: guid deniedHandleId: type: string format: guid RouterDefinition: type: object additionalProperties: false properties: id: type: string format: guid modelId: type: - string - 'null' format: guid routerConfigJson: type: - string - 'null' routerConfig: type: object additionalProperties: $ref: '#/components/schemas/RouterConfigurationDefinition' isMultiRoute: type: - boolean - 'null' includeChatHistory: type: boolean 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 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 ActiveCampaignInfo: type: object additionalProperties: false properties: campaignId: type: string format: guid campaignName: type: string campaignType: type: string activeExecutionsCount: type: integer format: int32 isRunning: type: boolean hasActiveSchedule: type: boolean scheduleType: type: - string - 'null' UserProvisioningSource: type: string description: '' x-enumNames: - EndpointDiscovered enum: - EndpointDiscovered PipelineDefinitionMetadata: type: object additionalProperties: false required: - state properties: id: type: string format: guid exportVersion: type: - string - 'null' tagline: type: string agentDescription: type: string industry: type: string tasks: type: string credentialExportOption: type: string dataSourceExportOption: type: string versionInformation: type: string state: type: string contributorId: type: - string - 'null' contributorGivenName: type: - string - 'null' contributorSurname: type: - string - 'null' videoLink: type: - string - 'null' readiness: type: - string - 'null' department: type: - string - 'null' agentLastUpdated: type: - string - 'null' format: date-time country: type: - string - 'null' 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' 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' 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))