ProviderApp

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-schema/ampersand-api-provider-app-schema.json",
  "title": "ProviderApp",
  "description": "ProviderApp schema from Ampersand API",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "The provider app ID.",
      "example": "provider-app-123"
    },
    "projectId": {
      "type": "string",
      "description": "The Ampersand project ID.",
      "example": "project-456"
    },
    "externalRef": {
      "type": "string",
      "description": "The ID used by the provider to identify the app (optional).",
      "example": "external-id-123"
    },
    "provider": {
      "type": "string",
      "description": "The SaaS provider that this app connects to.",
      "example": "salesforce"
    },
    "clientId": {
      "type": "string",
      "description": "The OAuth client ID for this app.",
      "example": "client-id-123"
    },
    "scopes": {
      "type": "array",
      "description": "The OAuth scopes for this app.",
      "items": {
        "type": "string",
        "example": [
          "oauth",
          "offline",
          "crm.read"
        ]
      }
    },
    "metadata": {
      "$ref": "#/components/schemas/ProviderAppMetadata"
    },
    "createTime": {
      "type": "string",
      "description": "The time the provider app was created.",
      "format": "date-time"
    },
    "updateTime": {
      "type": "string",
      "description": "The time the provider app was updated.",
      "format": "date-time"
    }
  },
  "required": [
    "clientId",
    "createTime",
    "id",
    "projectId",
    "provider"
  ]
}