Ampersand · JSON Structure

Ampersand Api Provider App Structure

ProviderApp schema from Ampersand API

Type: object Properties: 9 Required: 5
Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

ProviderApp is a JSON Structure definition published by Ampersand, describing 9 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id projectId externalRef provider clientId scopes metadata createTime updateTime

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ampersand/refs/heads/main/json-structure/ampersand-api-provider-app-structure.json",
  "name": "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": "datetime",
      "description": "The time the provider app was created."
    },
    "updateTime": {
      "type": "datetime",
      "description": "The time the provider app was updated."
    }
  },
  "required": [
    "clientId",
    "createTime",
    "id",
    "projectId",
    "provider"
  ]
}