{ "openapi": "3.0.3", "info": { "title": "AuthSpoke API", "version": "1.0.0", "description": "The AuthSpoke Enterprise AI Control Plane API — a fully headless REST API (JWT for humans, client-credentials tokens for machines). Generated from the authgateway controller surface so every endpoint is documented." }, "servers": [ { "url": "https://api.authspoke.com", "description": "Headless host for agents, MCP servers, SDKs, CI, and server-to-server automation. Send a bearer token; tenant context is resolved from the token/session." }, { "url": "https://your-company.authspoke.com", "description": "Tenant console host. Human/admin clients can call the same API through their tenant domain." } ], "tags": [ { "name": "Authentication", "x-group": "Get Started", "description": "Sign in, reset passwords, and use bearer-token authentication for every headless client." }, { "name": "System", "x-group": "Get Started", "description": "Liveness and operational probes used by monitoring and deployment automation." }, { "name": "Registration", "x-group": "Get Started", "description": "Self-service tenant provisioning and email verification." }, { "name": "Tenant Domain", "x-group": "Platform", "description": "Read and manage the tenant domain alias used by browser and API clients." }, { "name": "Platform", "x-group": "Platform", "description": "Tenant capability and feature-flag discovery." }, { "name": "Provider Support", "x-group": "Provider", "description": "AuthSpoke provider-admin operations for tenants, entitlements, kill switches, config, and support actions." }, { "name": "Connector Catalog", "x-group": "Enterprise Connectors", "description": "Browse connector definitions, manifests, statuses, categories, and draft connection tests." }, { "name": "Connector Instances", "x-group": "Enterprise Connectors", "description": "Create, update, test, and inspect connector instances." }, { "name": "Integrations Workspace", "x-group": "Enterprise Connectors", "description": "The metadata-driven connector workspace: configuration, provisioning, diagnostics, activity, operations, synchronization, and reliability." }, { "name": "Legacy Catalog", "x-group": "Enterprise Connectors", "description": "Legacy catalog and catalog-instance APIs retained for compatibility." }, { "name": "AI Overview", "x-group": "Enterprise AI", "description": "Mission-control posture rollups for the AI estate." }, { "name": "AI Agents", "x-group": "Enterprise AI", "description": "Register and manage AI agents as governed identities with computed risk and trust." }, { "name": "AI Registry", "x-group": "Enterprise AI", "description": "Governed AI Asset registry APIs for imported and manually registered AI assets." }, { "name": "AI Governance", "x-group": "Enterprise AI", "description": "Policy, evaluation, finding, review, exemption, and remediation-task APIs for governed AI assets." }, { "name": "MCP Registry", "x-group": "Enterprise AI", "description": "Register and govern MCP servers and the tools exposed through them." }, { "name": "AI Models", "x-group": "Enterprise AI", "description": "Inventory AI models and model risk posture." }, { "name": "AI Tools", "x-group": "Enterprise AI", "description": "Catalog tools an agent can invoke, including risk and status metadata." }, { "name": "AI Identities", "x-group": "Enterprise AI", "description": "Manage workload and service identities used by AI systems." }, { "name": "AI Policies", "x-group": "Enterprise AI", "description": "Legacy policy authoring and explainable policy evaluation endpoints." }, { "name": "AI Sessions", "x-group": "Enterprise AI", "description": "Track, suspend, terminate, and delete live AI sessions." }, { "name": "AI Compliance", "x-group": "Enterprise AI", "description": "Map controls and evidence to AI compliance frameworks and posture." }, { "name": "AI Activity", "x-group": "Enterprise AI", "description": "Tenant-wide and per-subject AI event streams." }, { "name": "Runtime SSO", "x-group": "Identity Runtime", "description": "Runtime application and callback endpoints used by SSO flows." }, { "name": "Access" }, { "name": "Agent" }, { "name": "Applications" }, { "name": "SAML Applications" }, { "name": "API Keys" }, { "name": "Tenant" }, { "name": "Reports" }, { "name": "Assertion" }, { "name": "Metadata" }, { "name": "Public Key" }, { "name": "Slo" }, { "name": "User Attributes" }, { "name": "AI Access Governance" } ], "paths": { "/{nonce}/{app_instance_id}": { "get": { "tags": [ "Runtime SSO" ], "operationId": "getNonceAppInstanceId", "summary": "Get nonce app instance id", "description": "Get nonce app instance id. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "nonce", "in": "path", "required": true, "description": "nonce identifier.", "schema": { "type": "string" } }, { "name": "app_instance_id", "in": "path", "required": true, "description": "app_instance_id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssets", "summary": "List v1 ai assets", "description": "List v1 ai assets for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Registry" ], "operationId": "postApiV1AiAssets", "summary": "Create or run v1 ai assets", "description": "Create or run v1 ai assets for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/{id}": { "delete": { "tags": [ "AI Registry" ], "operationId": "deleteApiV1AiAssetsId", "summary": "Delete ai assets id", "description": "Delete ai assets id for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsId", "summary": "Get ai assets id", "description": "Get ai assets id for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "AI Registry" ], "operationId": "putApiV1AiAssetsId", "summary": "Replace ai assets id", "description": "Replace ai assets id for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/{id}/activity": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsIdActivity", "summary": "List activity", "description": "List activity for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets/{id}/activity/{eventId}": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsIdActivityEventId", "summary": "Get activity event", "description": "Get activity event for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "required": true, "description": "eventId identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets/{id}/governance-findings": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsIdGovernanceFindings", "summary": "Get id governance findings", "description": "Get id governance findings for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets/{id}/governance-state": { "patch": { "tags": [ "AI Registry" ], "operationId": "patchApiV1AiAssetsIdGovernanceState", "summary": "Update id governance state", "description": "Update id governance state for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/{id}/governance-state/history": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsIdGovernanceStateHistory", "summary": "List history", "description": "List history for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets/{id}/lifecycle": { "patch": { "tags": [ "AI Registry" ], "operationId": "patchApiV1AiAssetsIdLifecycle", "summary": "Update id lifecycle", "description": "Update id lifecycle for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/{id}/lifecycle/history": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsIdLifecycleHistory", "summary": "List history", "description": "List history for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets/{id}/metadata": { "patch": { "tags": [ "AI Registry" ], "operationId": "patchApiV1AiAssetsIdMetadata", "summary": "Update id metadata", "description": "Update id metadata for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/{id}/metadata/schema": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsIdMetadataSchema", "summary": "Get metadata schema", "description": "Get metadata schema for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets/{id}/ownership": { "patch": { "tags": [ "AI Registry" ], "operationId": "patchApiV1AiAssetsIdOwnership", "summary": "Update id ownership", "description": "Update id ownership for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/{id}/relationships": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsIdRelationships", "summary": "Get id relationships", "description": "Get id relationships for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Registry" ], "operationId": "postApiV1AiAssetsIdRelationships", "summary": "Create or run id relationships", "description": "Create or run id relationships for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/{id}/relationships/{relationshipId}": { "delete": { "tags": [ "AI Registry" ], "operationId": "deleteApiV1AiAssetsIdRelationshipsRelationshipId", "summary": "Delete relationships relationship id", "description": "Delete relationships relationship id for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "relationshipId", "in": "path", "required": true, "description": "relationshipId identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets/cleanup/preview": { "post": { "tags": [ "AI Registry" ], "operationId": "postApiV1AiAssetsCleanupPreview", "summary": "Get preview", "description": "Get preview for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/cleanup/run": { "post": { "tags": [ "AI Registry" ], "operationId": "postApiV1AiAssetsCleanupRun", "summary": "Create or run cleanup run", "description": "Create or run cleanup run for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai-assets/filters": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsFilters", "summary": "List ai assets filters", "description": "List ai assets filters for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-assets/summary": { "get": { "tags": [ "AI Registry" ], "operationId": "getApiV1AiAssetsSummary", "summary": "Get summary", "description": "Get summary for governed AI assets, ownership, lifecycle, metadata, relationships, activity, and governance findings. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "search", "in": "query", "description": "Search by asset name/provider metadata where supported.", "schema": { "type": "string" } }, { "name": "assetType", "in": "query", "description": "Filter by governed asset type.", "schema": { "type": "string" } }, { "name": "provider", "in": "query", "description": "Filter by source provider.", "schema": { "type": "string" } }, { "name": "environment", "in": "query", "description": "Filter by environment.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/dashboard/summary": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceDashboardSummary", "summary": "Get summary", "description": "Get summary for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/domain/enums": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceDomainEnums", "summary": "List domain enums", "description": "List domain enums for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/evaluations/run": { "post": { "tags": [ "AI Governance" ], "operationId": "postApiV1AiGovernanceEvaluationsRun", "summary": "Create or run evaluations run", "description": "Create or run evaluations run for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "reason": "Reviewed by governance workflow", "status": "ACTIVE" } } } } } }, "/api/v1/ai-governance/evaluations/runs": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceEvaluationsRuns", "summary": "List evaluations runs", "description": "List evaluations runs for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/evaluations/runs/{id}": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceEvaluationsRunsId", "summary": "Get runs id", "description": "Get runs id for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/exemptions": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceExemptions", "summary": "List ai governance exemptions", "description": "List ai governance exemptions for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/exemptions/{id}": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceExemptionsId", "summary": "Get exemptions id", "description": "Get exemptions id for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/exemptions/{id}/revoke": { "patch": { "tags": [ "AI Governance" ], "operationId": "patchApiV1AiGovernanceExemptionsIdRevoke", "summary": "Update id revoke", "description": "Update id revoke for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "reason": "Reviewed by governance workflow", "status": "ACTIVE" } } } } } }, "/api/v1/ai-governance/findings": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceFindings", "summary": "List ai governance findings", "description": "List ai governance findings for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/findings/{id}": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceFindingsId", "summary": "Get findings id", "description": "Get findings id for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/findings/{id}/review-actions": { "post": { "tags": [ "AI Governance" ], "operationId": "postApiV1AiGovernanceFindingsIdReviewActions", "summary": "Create or run id review actions", "description": "Create or run id review actions for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "reason": "Reviewed by governance workflow", "status": "ACTIVE" } } } } } }, "/api/v1/ai-governance/findings/{id}/reviews": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceFindingsIdReviews", "summary": "Get id reviews", "description": "Get id reviews for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/policies": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernancePolicies", "summary": "List ai governance policies", "description": "List ai governance policies for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Governance" ], "operationId": "postApiV1AiGovernancePolicies", "summary": "Create or run ai governance policies", "description": "Create or run ai governance policies for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "reason": "Reviewed by governance workflow", "status": "ACTIVE" } } } } } }, "/api/v1/ai-governance/policies/{id}": { "delete": { "tags": [ "AI Governance" ], "operationId": "deleteApiV1AiGovernancePoliciesId", "summary": "Delete policies id", "description": "Delete policies id for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernancePoliciesId", "summary": "Get policies id", "description": "Get policies id for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "patch": { "tags": [ "AI Governance" ], "operationId": "patchApiV1AiGovernancePoliciesId", "summary": "Update policies id", "description": "Update policies id for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "reason": "Reviewed by governance workflow", "status": "ACTIVE" } } } } } }, "/api/v1/ai-governance/policies/{id}/duplicate": { "post": { "tags": [ "AI Governance" ], "operationId": "postApiV1AiGovernancePoliciesIdDuplicate", "summary": "Create or run id duplicate", "description": "Create or run id duplicate for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "reason": "Reviewed by governance workflow", "status": "ACTIVE" } } } } } }, "/api/v1/ai-governance/policies/{id}/status": { "patch": { "tags": [ "AI Governance" ], "operationId": "patchApiV1AiGovernancePoliciesIdStatus", "summary": "Update id status", "description": "Update id status for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "reason": "Reviewed by governance workflow", "status": "ACTIVE" } } } } } }, "/api/v1/ai-governance/reviews": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceReviews", "summary": "List ai governance reviews", "description": "List ai governance reviews for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/tasks": { "get": { "tags": [ "AI Governance" ], "operationId": "getApiV1AiGovernanceTasks", "summary": "List ai governance tasks", "description": "List ai governance tasks for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } }, { "name": "status", "in": "query", "description": "Filter by workflow status where supported.", "schema": { "type": "string" } }, { "name": "severity", "in": "query", "description": "Filter by finding or policy severity where supported.", "schema": { "type": "string" } }, { "name": "policyId", "in": "query", "description": "Filter findings or evaluations by policy id where supported.", "schema": { "type": "string" } }, { "name": "assetId", "in": "query", "description": "Filter findings by AI asset id where supported.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai-governance/tasks/{id}": { "patch": { "tags": [ "AI Governance" ], "operationId": "patchApiV1AiGovernanceTasksId", "summary": "Update tasks id", "description": "Update tasks id for AI Governance policy, evaluation, finding, review, exemption, or remediation workflows. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "reason": "Reviewed by governance workflow", "status": "ACTIVE" } } } } } }, "/api/v1/ai/activity": { "get": { "tags": [ "AI Activity" ], "operationId": "getApiV1AiActivity", "summary": "List activity", "description": "List activity in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai/activity/{subjectId}": { "get": { "tags": [ "AI Activity" ], "operationId": "getApiV1AiActivitySubjectId", "summary": "List activity", "description": "List activity in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "subjectId", "in": "path", "required": true, "description": "subjectId identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai/agents": { "get": { "tags": [ "AI Agents" ], "operationId": "getApiV1AiAgents", "summary": "List ai agents", "description": "List ai agents in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Agents" ], "operationId": "postApiV1AiAgents", "summary": "Create or run ai agents", "description": "Create or run ai agents in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/agents/{id}": { "delete": { "tags": [ "AI Agents" ], "operationId": "deleteApiV1AiAgentsId", "summary": "Delete agents id", "description": "Delete agents id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Agents" ], "operationId": "getApiV1AiAgentsId", "summary": "Get agents id", "description": "Get agents id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "AI Agents" ], "operationId": "putApiV1AiAgentsId", "summary": "Replace agents id", "description": "Replace agents id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/compliance": { "get": { "tags": [ "AI Compliance" ], "operationId": "getApiV1AiCompliance", "summary": "List ai compliance", "description": "List ai compliance in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Compliance" ], "operationId": "postApiV1AiCompliance", "summary": "Create or run ai compliance", "description": "Create or run ai compliance in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/compliance/{id}": { "delete": { "tags": [ "AI Compliance" ], "operationId": "deleteApiV1AiComplianceId", "summary": "Delete compliance id", "description": "Delete compliance id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Compliance" ], "operationId": "getApiV1AiComplianceId", "summary": "Get compliance id", "description": "Get compliance id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "AI Compliance" ], "operationId": "putApiV1AiComplianceId", "summary": "Replace compliance id", "description": "Replace compliance id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/compliance/posture": { "get": { "tags": [ "AI Compliance" ], "operationId": "getApiV1AiCompliancePosture", "summary": "List compliance posture", "description": "List compliance posture in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai/identities": { "get": { "tags": [ "AI Identities" ], "operationId": "getApiV1AiIdentities", "summary": "List ai identities", "description": "List ai identities in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Identities" ], "operationId": "postApiV1AiIdentities", "summary": "Create or run ai identities", "description": "Create or run ai identities in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/identities/{id}": { "delete": { "tags": [ "AI Identities" ], "operationId": "deleteApiV1AiIdentitiesId", "summary": "Delete identities id", "description": "Delete identities id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Identities" ], "operationId": "getApiV1AiIdentitiesId", "summary": "Get identities id", "description": "Get identities id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "AI Identities" ], "operationId": "putApiV1AiIdentitiesId", "summary": "Replace identities id", "description": "Replace identities id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/mcp-servers": { "get": { "tags": [ "MCP Registry" ], "operationId": "getApiV1AiMcpServers", "summary": "List ai mcp servers", "description": "List ai mcp servers in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "MCP Registry" ], "operationId": "postApiV1AiMcpServers", "summary": "Create or run ai mcp servers", "description": "Create or run ai mcp servers in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/mcp-servers/{id}": { "delete": { "tags": [ "MCP Registry" ], "operationId": "deleteApiV1AiMcpServersId", "summary": "Delete mcp servers id", "description": "Delete mcp servers id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "MCP Registry" ], "operationId": "getApiV1AiMcpServersId", "summary": "Get mcp servers id", "description": "Get mcp servers id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "MCP Registry" ], "operationId": "putApiV1AiMcpServersId", "summary": "Replace mcp servers id", "description": "Replace mcp servers id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/models": { "get": { "tags": [ "AI Models" ], "operationId": "getApiV1AiModels", "summary": "List ai models", "description": "List ai models in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Models" ], "operationId": "postApiV1AiModels", "summary": "Create or run ai models", "description": "Create or run ai models in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/models/{id}": { "delete": { "tags": [ "AI Models" ], "operationId": "deleteApiV1AiModelsId", "summary": "Delete models id", "description": "Delete models id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Models" ], "operationId": "getApiV1AiModelsId", "summary": "Get models id", "description": "Get models id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "AI Models" ], "operationId": "putApiV1AiModelsId", "summary": "Replace models id", "description": "Replace models id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/overview": { "get": { "tags": [ "AI Overview" ], "operationId": "getApiV1AiOverview", "summary": "List ai overview", "description": "List ai overview in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai/policies": { "get": { "tags": [ "AI Policies" ], "operationId": "getApiV1AiPolicies", "summary": "List ai policies", "description": "List ai policies in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Policies" ], "operationId": "postApiV1AiPolicies", "summary": "Create or run ai policies", "description": "Create or run ai policies in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/policies/{id}": { "delete": { "tags": [ "AI Policies" ], "operationId": "deleteApiV1AiPoliciesId", "summary": "Delete policies id", "description": "Delete policies id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Policies" ], "operationId": "getApiV1AiPoliciesId", "summary": "Get policies id", "description": "Get policies id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "AI Policies" ], "operationId": "putApiV1AiPoliciesId", "summary": "Replace policies id", "description": "Replace policies id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/policies/evaluate": { "post": { "tags": [ "AI Policies" ], "operationId": "postApiV1AiPoliciesEvaluate", "summary": "Create or run policies evaluate", "description": "Create or run policies evaluate in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/sessions": { "get": { "tags": [ "AI Sessions" ], "operationId": "getApiV1AiSessions", "summary": "List ai sessions", "description": "List ai sessions in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Sessions" ], "operationId": "postApiV1AiSessions", "summary": "Create or run ai sessions", "description": "Create or run ai sessions in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/sessions/{id}": { "delete": { "tags": [ "AI Sessions" ], "operationId": "deleteApiV1AiSessionsId", "summary": "Delete sessions id", "description": "Delete sessions id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Sessions" ], "operationId": "getApiV1AiSessionsId", "summary": "Get sessions id", "description": "Get sessions id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/ai/sessions/{id}/suspend": { "post": { "tags": [ "AI Sessions" ], "operationId": "postApiV1AiSessionsIdSuspend", "summary": "Create or run id suspend", "description": "Create or run id suspend in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/sessions/{id}/terminate": { "post": { "tags": [ "AI Sessions" ], "operationId": "postApiV1AiSessionsIdTerminate", "summary": "Create or run id terminate", "description": "Create or run id terminate in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/tools": { "get": { "tags": [ "AI Tools" ], "operationId": "getApiV1AiTools", "summary": "List ai tools", "description": "List ai tools in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "AI Tools" ], "operationId": "postApiV1AiTools", "summary": "Create or run ai tools", "description": "Create or run ai tools in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/ai/tools/{id}": { "delete": { "tags": [ "AI Tools" ], "operationId": "deleteApiV1AiToolsId", "summary": "Delete tools id", "description": "Delete tools id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "AI Tools" ], "operationId": "getApiV1AiToolsId", "summary": "Get tools id", "description": "Get tools id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "AI Tools" ], "operationId": "putApiV1AiToolsId", "summary": "Replace tools id", "description": "Replace tools id in the Enterprise AI Control Plane. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/auth/ping": { "get": { "tags": [ "Authentication" ], "operationId": "getApiV1AuthPing", "summary": "List auth ping", "description": "List auth ping. This endpoint is public unless deployment policy requires otherwise.", "security": [], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/auth/reset-password": { "post": { "tags": [ "Authentication" ], "operationId": "postApiV1AuthResetPassword", "summary": "Change your password", "description": "Authenticated self-service password change. Requires a bearer token; the target user is the token's principal (never a body username). The current password must verify.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Password changed" }, "400": { "description": "Current password incorrect / weak new password" }, "401": { "description": "Unauthenticated" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "currentPassword", "newPassword" ], "properties": { "currentPassword": { "type": "string" }, "newPassword": { "type": "string", "minLength": 8 } } } } } } } }, "/api/v1/auth/signin": { "post": { "tags": [ "Authentication" ], "operationId": "postApiV1AuthSignin", "summary": "Create or run auth signin", "description": "Create or run auth signin. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "username": "admin@example.com", "password": "********" } } } } } }, "/api/v1/catalog": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1Catalog", "summary": "List v1 catalog", "description": "List v1 catalog for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/catalog/categories": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogCategories", "summary": "List catalog categories", "description": "List catalog categories for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/catalog/instances": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogInstances", "summary": "List catalog instances", "description": "List catalog instances for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "Legacy Catalog" ], "operationId": "postApiV1CatalogInstances", "summary": "Create or run catalog instances", "description": "Create or run catalog instances for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/catalog/instances/{id}": { "delete": { "tags": [ "Legacy Catalog" ], "operationId": "deleteApiV1CatalogInstancesId", "summary": "Delete instances id", "description": "Delete instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogInstancesId", "summary": "Get instances id", "description": "Get instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "Legacy Catalog" ], "operationId": "putApiV1CatalogInstancesId", "summary": "Replace instances id", "description": "Replace instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/catalog/instances/{id}/assets": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogInstancesIdAssets", "summary": "Get id assets", "description": "Get id assets for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/catalog/instances/{id}/audit": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogInstancesIdAudit", "summary": "Get id audit", "description": "Get id audit for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/catalog/instances/{id}/capabilities": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogInstancesIdCapabilities", "summary": "Get id capabilities", "description": "Get id capabilities for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/catalog/instances/{id}/discover": { "post": { "tags": [ "Legacy Catalog" ], "operationId": "postApiV1CatalogInstancesIdDiscover", "summary": "Create or run id discover", "description": "Create or run id discover for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/catalog/instances/{id}/health": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogInstancesIdHealth", "summary": "Get health", "description": "Get health for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/catalog/instances/{id}/import": { "post": { "tags": [ "Legacy Catalog" ], "operationId": "postApiV1CatalogInstancesIdImport", "summary": "Create or run id import", "description": "Create or run id import for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/catalog/instances/{id}/test-connection": { "post": { "tags": [ "Legacy Catalog" ], "operationId": "postApiV1CatalogInstancesIdTestConnection", "summary": "Test connection", "description": "Test connection for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/catalog/instances/pipeline": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogInstancesPipeline", "summary": "List instances pipeline", "description": "List instances pipeline for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/catalog/instances/test": { "post": { "tags": [ "Legacy Catalog" ], "operationId": "postApiV1CatalogInstancesTest", "summary": "Test connection", "description": "Test connection for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/catalog/registry": { "get": { "tags": [ "Legacy Catalog" ], "operationId": "getApiV1CatalogRegistry", "summary": "List catalog registry", "description": "List catalog registry for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/connector-instances": { "get": { "tags": [ "Connector Instances" ], "operationId": "getApiV1ConnectorInstances", "summary": "List v1 connector instances", "description": "List v1 connector instances for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "Connector Instances" ], "operationId": "postApiV1ConnectorInstances", "summary": "Create or run v1 connector instances", "description": "Create or run v1 connector instances for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/connector-instances/{id}": { "delete": { "tags": [ "Connector Instances" ], "operationId": "deleteApiV1ConnectorInstancesId", "summary": "Delete connector instances id", "description": "Delete connector instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "get": { "tags": [ "Connector Instances" ], "operationId": "getApiV1ConnectorInstancesId", "summary": "Get connector instances id", "description": "Get connector instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "patch": { "tags": [ "Connector Instances" ], "operationId": "patchApiV1ConnectorInstancesId", "summary": "Update connector instances id", "description": "Update connector instances id for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/connectors": { "get": { "tags": [ "Connector Catalog" ], "operationId": "getApiV1Connectors", "summary": "List v1 connectors", "description": "List v1 connectors for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/connectors/{providerKey}": { "get": { "tags": [ "Connector Catalog" ], "operationId": "getApiV1ConnectorsProviderKey", "summary": "Get connectors provider key", "description": "Get connectors provider key for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "providerKey", "in": "path", "required": true, "description": "providerKey identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/connectors/{providerKey}/manifest": { "get": { "tags": [ "Connector Catalog" ], "operationId": "getApiV1ConnectorsProviderKeyManifest", "summary": "Get provider key manifest", "description": "Get provider key manifest for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "providerKey", "in": "path", "required": true, "description": "providerKey identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/connectors/{providerKey}/test": { "post": { "tags": [ "Connector Catalog" ], "operationId": "postApiV1ConnectorsProviderKeyTest", "summary": "Test connection", "description": "Test connection for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "providerKey", "in": "path", "required": true, "description": "providerKey identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/connectors/categories": { "get": { "tags": [ "Connector Catalog" ], "operationId": "getApiV1ConnectorsCategories", "summary": "List connectors categories", "description": "List connectors categories for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/connectors/enabled": { "get": { "tags": [ "Connector Catalog" ], "operationId": "getApiV1ConnectorsEnabled", "summary": "List connectors enabled", "description": "List connectors enabled for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/connectors/statuses": { "get": { "tags": [ "Connector Catalog" ], "operationId": "getApiV1ConnectorsStatuses", "summary": "List connectors statuses", "description": "List connectors statuses for the Enterprise Connector Framework. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/email/send-otp": { "post": { "tags": [ "Authentication" ], "operationId": "postApiV1EmailSendOtp", "summary": "Create or run email send otp", "description": "Create or run email send otp. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "username": "admin@example.com", "password": "********" } } } } } }, "/api/v1/email/verify-otp": { "post": { "tags": [ "Authentication" ], "operationId": "postApiV1EmailVerifyOtp", "summary": "Create or run email verify otp", "description": "Create or run email verify otp. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "username": "admin@example.com", "password": "********" } } } } } }, "/api/v1/integrations": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1Integrations", "summary": "List v1 integrations", "description": "List v1 integrations in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}": { "delete": { "tags": [ "Integrations Workspace" ], "operationId": "deleteApiV1IntegrationsId", "summary": "Delete integrations id", "description": "Delete integrations id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "patch": { "tags": [ "Integrations Workspace" ], "operationId": "patchApiV1IntegrationsId", "summary": "Update integrations id", "description": "Update integrations id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/activity": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdActivity", "summary": "List activity", "description": "List activity in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/activity/{eventId}": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdActivityEventId", "summary": "Get activity event", "description": "Get activity event in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "eventId", "in": "path", "required": true, "description": "eventId identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/activity/summary": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdActivitySummary", "summary": "Get summary", "description": "Get summary in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/configuration": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdConfiguration", "summary": "Get id configuration", "description": "Get id configuration in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "Integrations Workspace" ], "operationId": "putApiV1IntegrationsIdConfiguration", "summary": "Replace id configuration", "description": "Replace id configuration in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/configuration/validate": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdConfigurationValidate", "summary": "Create or run configuration validate", "description": "Create or run configuration validate in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/diagnostics/history": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdDiagnosticsHistory", "summary": "List history", "description": "List history in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/diagnostics/latest": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdDiagnosticsLatest", "summary": "Get diagnostics latest", "description": "Get diagnostics latest in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/diagnostics/run": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdDiagnosticsRun", "summary": "Create or run diagnostics run", "description": "Create or run diagnostics run in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/diagnostics/runs/{runId}": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdDiagnosticsRunsRunId", "summary": "Get runs run id", "description": "Get runs run id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "runId", "in": "path", "required": true, "description": "runId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/health/trend": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdHealthTrend", "summary": "Get health", "description": "Get health in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/import": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdImport", "summary": "Create or run id import", "description": "Create or run id import in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/imports": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdImports", "summary": "Create or run id imports", "description": "Create or run id imports in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/imports/{importId}": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdImportsImportId", "summary": "Get imports import id", "description": "Get imports import id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "description": "importId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/imports/{importId}/confirm": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdImportsImportIdConfirm", "summary": "Confirm operation", "description": "Confirm operation in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "description": "importId identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/imports/{importId}/preview": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdImportsImportIdPreview", "summary": "Get preview", "description": "Get preview in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "importId", "in": "path", "required": true, "description": "importId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/imports/history": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdImportsHistory", "summary": "List history", "description": "List history in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/operations": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdOperations", "summary": "Get id operations", "description": "Get id operations in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdOperations", "summary": "Create or run id operations", "description": "Create or run id operations in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/operations/{operationId}": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdOperationsOperationId", "summary": "Get operations operation id", "description": "Get operations operation id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "operationId", "in": "path", "required": true, "description": "operationId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/operations/{operationId}/cancel": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdOperationsOperationIdCancel", "summary": "Create or run operation id cancel", "description": "Create or run operation id cancel in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "operationId", "in": "path", "required": true, "description": "operationId identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/operations/{operationId}/retry": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdOperationsOperationIdRetry", "summary": "Create or run operation id retry", "description": "Create or run operation id retry in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "operationId", "in": "path", "required": true, "description": "operationId identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/overview": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdOverview", "summary": "Get id overview", "description": "Get id overview in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/refresh": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdRefresh", "summary": "Create or run id refresh", "description": "Create or run id refresh in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/reliability/summary": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdReliabilitySummary", "summary": "Get summary", "description": "Get summary in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/schedule": { "put": { "tags": [ "Integrations Workspace" ], "operationId": "putApiV1IntegrationsIdSchedule", "summary": "Replace id schedule", "description": "Replace id schedule in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/synchronizations": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdSynchronizations", "summary": "Create or run id synchronizations", "description": "Create or run id synchronizations in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/synchronizations/{syncId}": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdSynchronizationsSyncId", "summary": "Get synchronizations sync id", "description": "Get synchronizations sync id in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "syncId", "in": "path", "required": true, "description": "syncId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/synchronizations/{syncId}/confirm": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdSynchronizationsSyncIdConfirm", "summary": "Confirm operation", "description": "Confirm operation in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "syncId", "in": "path", "required": true, "description": "syncId identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/synchronizations/{syncId}/preview": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdSynchronizationsSyncIdPreview", "summary": "Get preview", "description": "Get preview in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } }, { "name": "syncId", "in": "path", "required": true, "description": "syncId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/synchronizations/history": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdSynchronizationsHistory", "summary": "List history", "description": "List history in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/synchronizations/latest": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdSynchronizationsLatest", "summary": "Get synchronizations latest", "description": "Get synchronizations latest in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/{id}/test": { "post": { "tags": [ "Integrations Workspace" ], "operationId": "postApiV1IntegrationsIdTest", "summary": "Test connection", "description": "Test connection in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "configuration": { "mode": "metadata-driven" } } } } } } }, "/api/v1/integrations/{id}/workspace": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsIdWorkspace", "summary": "Get id workspace", "description": "Get id workspace in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/filters": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsFilters", "summary": "List integrations filters", "description": "List integrations filters in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/integrations/summary": { "get": { "tags": [ "Integrations Workspace" ], "operationId": "getApiV1IntegrationsSummary", "summary": "Get summary", "description": "Get summary in the connector workspace. These APIs are headless and can be used by the UI, agents, MCP servers, or server-to-server automation. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/monitor/ping": { "get": { "tags": [ "System" ], "operationId": "getApiV1MonitorPing", "summary": "List monitor ping", "description": "List monitor ping. This endpoint is public unless deployment policy requires otherwise.", "security": [], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/platform/capabilities": { "get": { "tags": [ "Platform" ], "operationId": "getApiV1PlatformCapabilities", "summary": "List platform capabilities", "description": "List platform capabilities. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/register": { "post": { "tags": [ "Registration" ], "operationId": "postApiV1Register", "summary": "Create or run v1 register", "description": "Create or run v1 register. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/support/config": { "get": { "tags": [ "Provider Support" ], "operationId": "getApiV1SupportConfig", "summary": "List support config", "description": "List support config. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "Provider Support" ], "operationId": "postApiV1SupportConfig", "summary": "Create or run support config", "description": "Create or run support config. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/support/config/{key}": { "delete": { "tags": [ "Provider Support" ], "operationId": "deleteApiV1SupportConfigKey", "summary": "Delete config key", "description": "Delete config key. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "description": "key identifier.", "schema": { "type": "string" } } ], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "Provider Support" ], "operationId": "postApiV1SupportConfigKey", "summary": "Create or run config key", "description": "Create or run config key. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "description": "key identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/support/kill-switches": { "get": { "tags": [ "Provider Support" ], "operationId": "getApiV1SupportKillSwitches", "summary": "List support kill switches", "description": "List support kill switches. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/support/kill-switches/{key}": { "post": { "tags": [ "Provider Support" ], "operationId": "postApiV1SupportKillSwitchesKey", "summary": "Create or run kill switches key", "description": "Create or run kill switches key. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "description": "key identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/support/me": { "get": { "tags": [ "Provider Support" ], "operationId": "getApiV1SupportMe", "summary": "List support me", "description": "List support me. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/support/orgs": { "get": { "tags": [ "Provider Support" ], "operationId": "getApiV1SupportOrgs", "summary": "List support orgs", "description": "List support orgs. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/support/orgs/{tenantId}": { "get": { "tags": [ "Provider Support" ], "operationId": "getApiV1SupportOrgsTenantId", "summary": "Get orgs tenant id", "description": "Get orgs tenant id. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "description": "tenantId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/support/orgs/{tenantId}/users": { "get": { "tags": [ "Provider Support" ], "operationId": "getApiV1SupportOrgsTenantIdUsers", "summary": "Get tenant id users", "description": "Get tenant id users. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "description": "tenantId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/support/sql": { "post": { "tags": [ "Provider Support" ], "operationId": "postApiV1SupportSql", "summary": "Create or run support sql", "description": "Create or run support sql. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/support/tenants": { "get": { "tags": [ "Provider Support" ], "operationId": "getApiV1SupportTenants", "summary": "List support tenants", "description": "List support tenants. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/support/tenants/{tenantId}/entitlements": { "get": { "tags": [ "Provider Support" ], "operationId": "getApiV1SupportTenantsTenantIdEntitlements", "summary": "Get tenant id entitlements", "description": "Get tenant id entitlements. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "description": "tenantId identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/support/tenants/{tenantId}/entitlements/{kind}/{key}": { "post": { "tags": [ "Provider Support" ], "operationId": "postApiV1SupportTenantsTenantIdEntitlementsKindKey", "summary": "Create or run kind key", "description": "Create or run kind key. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "tenantId", "in": "path", "required": true, "description": "tenantId identifier.", "schema": { "type": "string" } }, { "name": "kind", "in": "path", "required": true, "description": "kind identifier.", "schema": { "type": "string" } }, { "name": "key", "in": "path", "required": true, "description": "key identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/support/users/{userId}/reset-password": { "post": { "tags": [ "Provider Support" ], "operationId": "postApiV1SupportUsersUserIdResetPassword", "summary": "Create or run user id reset password", "description": "Create or run user id reset password. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "userId identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/support/users/{userId}/status": { "post": { "tags": [ "Provider Support" ], "operationId": "postApiV1SupportUsersUserIdStatus", "summary": "Create or run user id status", "description": "Create or run user id status. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "userId", "in": "path", "required": true, "description": "userId identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/api/v1/tenant/domain": { "get": { "tags": [ "Tenant Domain" ], "operationId": "getApiV1TenantDomain", "summary": "List tenant domain", "description": "List tenant domain. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/tenant/domain/alias": { "delete": { "tags": [ "Tenant Domain" ], "operationId": "deleteApiV1TenantDomainAlias", "summary": "Delete domain alias", "description": "Delete domain alias. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "204": { "description": "Deleted or completed with no response body." }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "put": { "tags": [ "Tenant Domain" ], "operationId": "putApiV1TenantDomainAlias", "summary": "Replace domain alias", "description": "Replace domain alias. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/app/{app_id}/{app_instance_id}": { "get": { "tags": [ "Runtime SSO" ], "operationId": "getAppAppIdAppInstanceId", "summary": "Get app id app instance id", "description": "Get app id app instance id. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "app_id", "in": "path", "required": true, "description": "app_id identifier.", "schema": { "type": "string" } }, { "name": "app_instance_id", "in": "path", "required": true, "description": "app_instance_id identifier.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } }, "post": { "tags": [ "Runtime SSO" ], "operationId": "postAppAppIdAppInstanceId", "summary": "Create or run app id app instance id", "description": "Create or run app id app instance id. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "app_id", "in": "path", "required": true, "description": "app_id identifier.", "schema": { "type": "string" } }, { "name": "app_instance_id", "in": "path", "required": true, "description": "app_instance_id identifier.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } }, "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string", "description": "Display name or operation name where applicable." }, "status": { "type": "string", "description": "Status or lifecycle value where applicable." }, "reason": { "type": "string", "description": "Audit reason for governed changes." }, "metadata": { "type": "object", "description": "Provider or business metadata." }, "configuration": { "type": "object", "description": "Connector, policy, or resource configuration." } } }, "example": { "name": "example", "metadata": {} } } } } } }, "/callback": { "get": { "tags": [ "Runtime SSO" ], "operationId": "getCallback", "summary": "List callback", "description": "List callback. The tenant is resolved server-side from the bearer token/session; callers do not pass a tenant subdomain in the API path.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "page", "in": "query", "description": "Zero-based page index where supported.", "schema": { "type": "integer", "default": 0 } }, { "name": "size", "in": "query", "description": "Page size where supported.", "schema": { "type": "integer", "default": 25 } } ], "responses": { "200": { "description": "Successful response.", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true }, "example": { "id": "uuid", "status": "OK" } } } }, "400": { "description": "Invalid request." }, "401": { "description": "Missing or invalid authentication." }, "403": { "description": "Forbidden by permission, SKU, or provider-admin policy." }, "404": { "description": "Resource not found or not in the caller's tenant." } } } }, "/api/v1/access/validate": { "post": { "operationId": "validateAccess", "summary": "Validate Access", "tags": [ "Access" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/agents/health": { "get": { "operationId": "health", "summary": "Health", "tags": [ "Agent" ], "security": [], "x-generated": true, "responses": { "200": { "description": "Success" } } } }, "/api/v1/apps/{id}": { "get": { "operationId": "getApp", "summary": "Get App", "tags": [ "Applications" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } }, "put": { "operationId": "updateApp", "summary": "Update App", "tags": [ "Applications" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/saml-apps/create": { "post": { "operationId": "createSAMLApp", "summary": "Create SAMLApp", "tags": [ "SAML Applications" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } }, "get": { "operationId": "redirectToSamlAppForm", "summary": "Redirect To Saml App Form", "tags": [ "SAML Applications" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/saml-apps/{appInstanceId}": { "put": { "operationId": "updateSAMLApp", "summary": "Update SAMLApp", "tags": [ "SAML Applications" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "appInstanceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } }, "get": { "operationId": "getSamlAppInstanceDetails", "summary": "Get Saml App Instance Details", "tags": [ "SAML Applications" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "appInstanceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/saml-apps/health": { "get": { "operationId": "healthCheck", "summary": "Health Check", "tags": [ "SAML Applications" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/user/app/{id}": { "delete": { "operationId": "deleteApp", "summary": "Delete App", "tags": [ "Applications" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/api-keys/{id}": { "delete": { "operationId": "revoke", "summary": "Revoke", "tags": [ "API Keys" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/auth/token": { "post": { "operationId": "token", "summary": "Token", "tags": [ "Authentication" ], "security": [], "x-generated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/tenant/current": { "get": { "operationId": "current", "summary": "Current", "tags": [ "Tenant" ], "security": [], "x-generated": true, "responses": { "200": { "description": "Success" } } } }, "/redis/health": { "get": { "operationId": "checkRedisHealth", "summary": "Check Redis Health", "tags": [ "System" ], "security": [], "x-generated": true, "responses": { "200": { "description": "Success" } } } }, "/api/v1/reports/app-usage": { "get": { "operationId": "getAppUsageReport", "summary": "Get App Usage Report", "tags": [ "Reports" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "userId", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "period", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/response": { "post": { "operationId": "sendSAMLResponse", "summary": "Send SAMLResponse", "tags": [ "Assertion" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "username", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "password", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/{appInstanceId}": { "get": { "operationId": "getSAMLMetadata", "summary": "Get SAMLMetadata", "tags": [ "Metadata" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "appInstanceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/public-keys/upload": { "post": { "operationId": "uploadPublicKey", "summary": "Upload Public Key", "tags": [ "Public Key" ], "security": [], "x-generated": true, "parameters": [ { "name": "tenantId", "in": "query", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" } } } }, "/slo": { "get": { "operationId": "sloGet", "summary": "Slo Get", "tags": [ "Slo" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } }, "post": { "operationId": "sloPost", "summary": "Slo Post", "tags": [ "Slo" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "SAMLRequest", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/user/{userId}": { "get": { "operationId": "getUserAttributes", "summary": "Get User Attributes", "tags": [ "User Attributes" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "userId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-targets/{connectorInstanceId}/resources": { "get": { "operationId": "resources", "summary": "Resources", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "connectorInstanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "String", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-targets/{connectorInstanceId}/resources/sync": { "post": { "operationId": "syncResources", "summary": "Sync Resources", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "connectorInstanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "String", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-targets/{connectorInstanceId}/drift-scan": { "post": { "operationId": "driftScan", "summary": "Drift Scan", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "connectorInstanceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-targets/{connectorInstanceId}/resources/{resourceId}/access-profiles": { "get": { "operationId": "accessProfiles", "summary": "Access Profiles", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "connectorInstanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-targets/{connectorInstanceId}/access-profiles": { "get": { "operationId": "connectorAccessProfiles", "summary": "Connector Access Profiles", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "connectorInstanceId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "resourceType", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-connectors": { "get": { "operationId": "accessConnectors", "summary": "Access Connectors", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-connectors/{catalogItemId}/request-schema": { "get": { "operationId": "requestSchema", "summary": "Request Schema", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "catalogItemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/access-requests": { "post": { "operationId": "createRequest", "summary": "Create Request", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-requests": { "get": { "operationId": "listRequests", "summary": "List Requests", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "String", "in": "query", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-requests/{id}/evaluate": { "post": { "operationId": "evaluateRequest", "summary": "Evaluate Request", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-requests/{id}": { "get": { "operationId": "getRequest", "summary": "Get Request", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-requests/{id}/approve": { "post": { "operationId": "approve", "summary": "Approve", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-requests/{id}/reject": { "post": { "operationId": "reject", "summary": "Reject", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-requests/{id}/cancel": { "post": { "operationId": "cancel", "summary": "Cancel", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-requests/{id}/provision": { "post": { "operationId": "provision", "summary": "Provision", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/access-assignments": { "get": { "operationId": "assignments", "summary": "Assignments", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/access-summary": { "get": { "operationId": "summary", "summary": "Summary", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/access-identities": { "get": { "operationId": "accessIdentities", "summary": "Access Identities", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/available-access-targets": { "get": { "operationId": "availableTargets", "summary": "Available Targets", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-targets": { "get": { "operationId": "targetApplications", "summary": "Target Applications", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-assignments/{id}/verify": { "post": { "operationId": "verify", "summary": "Verify", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-assignments/{id}/modify": { "post": { "operationId": "modify", "summary": "Modify", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-assignments/{id}/repair": { "post": { "operationId": "repair", "summary": "Repair", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-drift": { "get": { "operationId": "accessDrift", "summary": "Access Drift", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-expiring": { "get": { "operationId": "accessExpiring", "summary": "Access Expiring", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-unused": { "get": { "operationId": "accessUnused", "summary": "Access Unused", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-lifecycle/dashboard": { "get": { "operationId": "lifecycleDashboard", "summary": "Lifecycle Dashboard", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-certifications": { "post": { "operationId": "createCertification", "summary": "Create Certification", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } }, "get": { "operationId": "listCertifications", "summary": "List Certifications", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-certifications/{id}": { "get": { "operationId": "certification", "summary": "Certification", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-certifications/{id}/items/{itemId}/review": { "post": { "operationId": "reviewCertificationItem", "summary": "Review Certification Item", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "itemId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-assignments/{id}/revoke": { "post": { "operationId": "revoke", "summary": "Revoke", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/access-usage": { "get": { "operationId": "assetUsage", "summary": "Asset Usage", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "query", "required": false, "schema": { "type": "string" } }, { "name": "size", "in": "query", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/access-usage/export": { "get": { "operationId": "exportAssetUsage", "summary": "Export Asset Usage", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/access-usage/summary": { "get": { "operationId": "assetUsageSummary", "summary": "Asset Usage Summary", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/ai-assets/{assetId}/runtime-test": { "post": { "operationId": "runtimeTest", "summary": "Runtime Test", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/access-assignments/{id}/usage": { "get": { "operationId": "usage", "summary": "Usage", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } }, "/api/v1/agent-tools/github/execute": { "post": { "operationId": "execute", "summary": "Execute", "tags": [ "AI Access Governance" ], "security": [], "x-generated": true, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" } } } }, "/api/v1/ai-assets/{assetId}/agent-tool-token": { "post": { "operationId": "issueToken", "summary": "Issue Token", "tags": [ "AI Access Governance" ], "security": [ { "bearerAuth": [] } ], "x-generated": true, "parameters": [ { "name": "assetId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Success" }, "401": { "description": "Unauthenticated" }, "403": { "description": "Forbidden" } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "schemas": { "GenericObject": { "type": "object", "additionalProperties": true } } } }