ApiResponseOfSentinelIngestDeploymentCardDto

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/contraforce/json-schema/contraforce-api-response-of-sentinel-ingest-deployment-card-dto-schema.json",
  "title": "ApiResponseOfSentinelIngestDeploymentCardDto",
  "description": "Standard v2 API response envelope for single-item responses.",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/contraforce-service-accounts-api-openapi.yml#/components/schemas/ApiResponseOfSentinelIngestDeploymentCardDto",
  "type": "object",
  "properties": {
    "data": {
      "description": "The deployment card the portal shows after provisioning Sentinel Content Hub ingest: the shared client id\nand secret for the organization, plus each onboarded workspace and the endpoint its playbook posts to.",
      "$ref": "#/$defs/SentinelIngestDeploymentCardDto"
    },
    "meta": {
      "$ref": "#/$defs/ResponseMeta"
    }
  },
  "$defs": {
    "ResponseMeta": {
      "type": "object",
      "properties": {
        "requestId": {
          "type": [
            "null",
            "string"
          ]
        },
        "timestamp": {
          "type": [
            "null",
            "string"
          ]
        }
      }
    },
    "SentinelIngestDeploymentCardDto": {
      "type": "object",
      "properties": {
        "clientId": {
          "type": "string",
          "description": "The client id every playbook authenticates with (the managed service account id, shared org-wide).",
          "format": "uuid"
        },
        "clientSecret": {
          "type": [
            "null",
            "string"
          ],
          "description": "The client secret, shared across all of the organization's workspaces. Returned on every provision so it\ncan be reused when adding a workspace later; the same secret authenticates every playbook. Null only if\nthe credential could not be resolved."
        },
        "credentialAlreadyIssued": {
          "type": "boolean",
          "description": "True when the credential already existed before this call (this provisioning reused it rather than\ncreating it). Informational; the secret is returned either way."
        },
        "workspaces": {
          "type": [
            "null",
            "array"
          ],
          "items": {
            "description": "One onboarded workspace and the region-qualified ingest endpoint its playbook posts incidents to.",
            "$ref": "#/$defs/SentinelIngestWorkspaceDto"
          },
          "description": "The workspaces onboarded by this call, each with the endpoint its Sentinel playbook posts to."
        }
      },
      "description": "The deployment card the portal shows after provisioning Sentinel Content Hub ingest: the shared client id\nand secret for the organization, plus each onboarded workspace and the endpoint its playbook posts to."
    },
    "SentinelIngestWorkspaceDto": {
      "type": "object",
      "properties": {
        "workspaceId": {
          "type": "string",
          "format": "uuid"
        },
        "workspaceName": {
          "type": [
            "null",
            "string"
          ]
        },
        "ingestUrl": {
          "type": [
            "null",
            "string"
          ]
        }
      },
      "description": "One onboarded workspace and the region-qualified ingest endpoint its playbook posts incidents to."
    }
  }
}