Ampersand · Schema

ProviderMetadataInfo

ProviderMetadataInfo schema from Ampersand API

Developer ToolsIntegrationsPlatformSaaSOAuthData SyncWebhooks

Properties

Name Type Description
value string The value of the metadata field
source string The source of the metadata field
displayName string The human-readable name for the field
View JSON Schema on GitHub

JSON Schema

ampersand-api-provider-metadata-info-schema.json Raw ↑
{
  "$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-metadata-info-schema.json",
  "title": "ProviderMetadataInfo",
  "description": "ProviderMetadataInfo schema from Ampersand API",
  "type": "object",
  "properties": {
    "value": {
      "type": "string",
      "description": "The value of the metadata field",
      "example": "1234567890"
    },
    "source": {
      "type": "string",
      "description": "The source of the metadata field",
      "enum": [
        "input",
        "token",
        "provider"
      ],
      "example": "input"
    },
    "displayName": {
      "type": "string",
      "description": "The human-readable name for the field",
      "example": "Account ID"
    }
  },
  "required": [
    "value",
    "source"
  ]
}