Amplify Platform Provider Structure

{
  "$schema": "https://json-structure.org/draft/2020-12/schema",
  "name": "Provider",
  "description": "Provider schema from Axway Amplify Platform API",
  "type": "object",
  "properties": {
    "_id": {
      "type": "string",
      "description": "Document ID of the provider.",
      "readOnly": true,
      "deprecated": true,
      "example": "507f1f77bcf86cd799439011"
    },
    "admin_teams": {
      "description": "Administration access.",
      "default": false,
      "oneOf": [
        {
          "type": "boolean",
          "description": "Flag indicating if `marketplace_admin` role members in all teams can administer the provider marketplace."
        },
        {
          "type": "array",
          "description": "`guid` of a selected team whose `marketplace_admin` role members can administer the provider marketplace.",
          "items": {
            "type": "string",
            "format": "uuid"
          }
        }
      ],
      "example": "example_value"
    },
    "consume_teams": {
      "type": "object",
      "description": "Preference for which org members can consume the provider marketplace.",
      "default": {
        "type": "teams",
        "value": true
      },
      "unevaluatedProperties": false,
      "discriminator": {
        "propertyName": "type",
        "mapping": {
          "teams": "#/components/schemas/Provider/properties/consume_teams/oneOf/0",
          "included": "#/components/schemas/Provider/properties/consume_teams/oneOf/1",
          "excluded": "#/components/schemas/Provider/properties/consume_teams/oneOf/1",
          "tags": "#/components/schemas/Provider/properties/consume_teams/oneOf/2"
        }
      },
      "oneOf": [
        {
          "type": "object",
          "title": "All Teams",
          "properties": {
            "type": {
              "enum": [
                "teams"
              ]
            },
            "value": {
              "type": "boolean",
              "description": "Indicates if `consumer` role members in all teams can consume the provider marketplace."
            }
          }
        },
        {
          "type": "object",
          "title": "Specific Teams",
          "properties": {
            "type": {
              "enum": [
                "included",
                "excluded"
              ]
            },
            "value": {
              "type": "array",
              "description": "`guid` of a selected teams whose `consumer` role members can consume the provider marketplace.",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            }
          }
        },
        {
          "type": "object",
          "title": "Tagged Teams",
          "properties": {
            "type": {
              "enum": [
                "tags"
              ]
            },
            "value": {
              "type": "array",
              "description": "`consumer` role members in teams with any value in its `tags` can consume the provider marketplace.",
              "items": {
                "type": "string"
              }
            }
          }
        }
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Setting for how to apply consumption preference value."
        }
      },
      "example": {
        "type": "example_value"
      }
    },
    "publish_teams": {
      "type": "object",
      "description": "Preference for which org members can publish products to the provider marketplace.",
      "default": {
        "type": "teams",
        "value": true
      },
      "unevaluatedProperties": false,
      "discriminator": {
        "propertyName": "type",
        "mapping": {
          "teams": "#/components/schemas/Provider/properties/publish_teams/oneOf/0",
          "included": "#/components/schemas/Provider/properties/publish_teams/oneOf/1",
          "excluded": "#/components/schemas/Provider/properties/publish_teams/oneOf/1",
          "tags": "#/components/schemas/Provider/properties/publish_teams/oneOf/2"
        }
      },
      "oneOf": [
        {
          "type": "object",
          "title": "All Teams",
          "properties": {
            "type": {
              "enum": [
                "teams"
              ]
            },
            "value": {
              "type": "boolean",
              "description": "Indicates if `catalog_manager` role members in all teams can publish to the provider marketplace."
            }
          }
        },
        {
          "type": "object",
          "title": "Specific Teams",
          "properties": {
            "type": {
              "enum": [
                "included",
                "excluded"
              ]
            },
            "value": {
              "type": "array",
              "description": "`guid` of a selected teams whose `catalog_manager` role members can publish to the provider marketplace.",
              "items": {
                "type": "string",
                "format": "uuid"
              }
            }
          }
        },
        {
          "type": "object",
          "title": "Tagged Teams",
          "properties": {
            "type": {
              "enum": [
                "tags"
              ]
            },
            "value": {
              "type": "array",
              "description": "`catalog_manager` role members in teams with any value in its `tags` can publish to the provider marketplace.",
              "items": {
                "type": "string"
              }
            }
          }
        }
      ],
      "properties": {
        "type": {
          "type": "string",
          "description": "Setting for how to apply publication preference value."
        }
      },
      "example": {
        "type": "example_value"
      }
    },
    "ai": {
      "type": "object",
      "default": {
        "enabled": false
      },
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether AI integration is enabled for the provider marketplace.",
          "default": false
        },
        "embedded": {
          "type": "boolean",
          "description": "Whether AI integration uses built-in LLM (or customer hosted).",
          "default": false
        },
        "key": {
          "type": "string",
          "description": "API key of customer hosted LLM.",
          "writeOnly": true
        },
        "key_set": {
          "type": "string",
          "format": "date-time",
          "description": "Date and time when API key was last set.",
          "readOnly": true
        },
        "stream": {
          "type": "boolean",
          "description": "Whether LLM supports SSE events stream.",
          "default": true
        },
        "url": {
          "type": "string",
          "format": "secure-url",
          "description": "URL of customer hosted LLM."
        }
      },
      "example": {
        "enabled": true,
        "embedded": true,
        "key": "example_value",
        "key_set": "2026-04-21T00:00:00Z",
        "stream": true,
        "url": "https://example.com"
      }
    },
    "appearance": {
      "type": "object",
      "description": "Appearance settings for the provider marketplace.",
      "additionalProperties": false,
      "properties": {
        "favicon": {
          "type": "string",
          "description": "URL of the provider marketplace favicon."
        },
        "logo": {
          "type": "string",
          "description": "URL of the provider marketplace logo."
        },
        "theme_bg": {
          "type": "string",
          "format": "color",
          "description": "Color for page background."
        },
        "theme_black": {
          "type": "string",
          "format": "color",
          "description": "Color for default elements."
        },
        "theme_link": {
          "type": "string",
          "format": "color",
          "description": "Color for text links."
        },
        "theme_primary": {
          "type": "string",
          "format": "color",
          "description": "Color for action controls."
        },
        "theme_primary_alt": {
          "type": "string",
          "format": "color",
          "description": "Supplementary content color for primary action controls."
        },
        "theme_secondary": {
          "type": "string",
          "format": "color",
          "description": "Color for secondary elements."
        },
        "theme_secondary_alt": {
          "type": "string",
          "format": "color",
          "description": "Supplementary content color for secondary action controls."
        },
        "theme_tertiary": {
          "type": "string",
          "format": "color",
          "description": "Color for tertiary elements."
        },
        "theme_tertiary_alt": {
          "type": "string",
          "format": "color",
          "description": "Supplementary content color for tertiary action controls."
        },
        "theme_danger": {
          "type": "string",
          "format": "color",
          "description": "Color for danger elements."
        },
        "theme_danger_alt": {
          "type": "string",
          "format": "color",
          "description": "Supplementary content color for danger state elements."
        },
        "theme_info": {
          "type": "string",
          "format": "color",
          "description": "Color for info elements."
        },
        "theme_info_alt": {
          "type": "string",
          "format": "color",
          "description": "Supplementary content color for info state elements."
        },
        "theme_success": {
          "type": "string",
          "format": "color",
          "description": "Color for success elements."
        },
        "theme_success_alt": {
          "type": "string",
          "format": "color",
          "description": "Supplementary content color for success state elements."
        },
        "theme_warning": {
          "type": "string",
          "format": "color",
          "description": "Color for warning elements."
        },
        "theme_warning_alt": {
          "type": "string",
          "format": "color",
          "description": "Supplementary content color for warning state elements."
        },
        "theme_button": {
          "type": "string",
          "format": "color",
          "description": "Element color for heading buttons."
        },
        "theme_button_text": {
          "type": "string",
          "format": "color",
          "description": "Element color for heading button text."
        },
        "theme_container": {
          "type": "string",
          "format": "color",
          "description": "Element color for container titles."
        },
        "theme_container_bg": {
          "type": "string",
          "format": "color",
          "description": "Element color for container backgrounds."
        },
        "theme_container_brd": {
          "type": "string",
          "format": "color",
          "description": "Element color for container borders and separators."
        },
        "theme_container_text": {
          "type": "string",
          "format": "color",
          "description": "Element color for container text."
        },
        "theme_heading": {
          "type": "string",
          "format": "color",
          "description": "Element color for heading titles."
        },
        "theme_heading_bg": {
          "type": "string",
          "format": "color",
          "description": "Element color for heading back."
        },
        "theme_icon": {
          "type": "string",
          "format": "color",
          "description": "Element color for icons."
        },
        "theme_top_nav": {
          "type": "string",
          "format": "color",
          "description": "Color for top navigation menu text."
        },
        "theme_top_nav_bg_direction": {
          "type": "string",
          "description": "Direction for the top navigation menu background gradient.",
          "enum": [
            "to right",
            "to bottom",
            "to right top",
            "to right bottom"
          ]
        },
        "theme_top_nav_bg_end": {
          "type": "string",
          "format": "color",
          "description": "Ending color for top navigation menu background."
        },
        "theme_top_nav_bg_fill": {
          "type": "string",
          "description": "Fill format for the top navigation menu background.",
          "enum": [
            "solid",
            "gradient"
          ]
        },
        "theme_top_nav_bg_start": {
          "type": "string",
          "format": "color",
          "description": "Starting color for top navigation menu background."
        },
        "theme_top_nav_icon": {
          "type": "string",
          "format": "color",
          "description": "Color for top navigation menu icons."
        },
        "theme_top_nav_menu_bg": {
          "type": "string",
          "format": "color",
          "description": "Color for top navigation menu background."
        },
        "theme_left_nav": {
          "type": "string",
          "format": "color",
          "description": "Color for left navigation menu text."
        },
        "theme_left_nav_active": {
          "type": "string",
          "format": "color",
          "description": "Color for left navigation menu active item text."
        },
        "theme_left_nav_active_bg": {
          "type": "string",
          "format": "color",
          "description": "Color for left navigation menu active item background."
        },
        "theme_left_nav_bg": {
          "type": "string",
          "format": "color",
          "description": "Color for left navigation menu background."
        },
        "font_family": {
          "type": "string",
          "description": "Font family."
        },
        "letter_spacing": {
          "type": "string",
          "description": "Letter spacing.",
          "enum": [
            "-1px",
            "normal",
            "1px"
          ]
        },
        "button_format": {
          "type": "string",
          "description": "Button background fill or outline.",
          "enum": [
            "solid",
            "outline"
          ]
        },
        "button_radius": {
          "type": "string",
          "description": "Button radius.",
          "enum": [
            "square",
            "rounded",
            "pill"
          ]
        }
      },
      "example": {
        "favicon": "example_value",
        "logo": "example_value",
        "theme_bg": "example_value",
        "theme_black": "example_value",
        "theme_link": "example_value",
        "theme_primary": "example_value",
        "theme_primary_alt": "example_value",
        "theme_secondary": "example_value",
        "theme_secondary_alt": "example_value",
        "theme_tertiary": "example_value"
      }
    },
    "billing": {
      "type": "object",
      "description": "Billing integration settings for the provider marketplace.",
      "default": {
        "enabled": false
      },
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether billing integration is enabled for the provider marketplace.",
          "default": false
        },
        "key": {
          "type": "string",
          "description": "Billing integration vendor API key; required for vendor other than `custom`.",
          "writeOnly": true
        },
        "key_set": {
          "type": "string",
          "format": "date-time",
          "description": "Date billing integration vendor key was set.",
          "readOnly": true
        },
        "portal_url": {
          "type": "string",
          "format": "secure-url",
          "description": "URL of vendor hosted customer portal; optional for vendor `stripe`."
        },
        "signature": {
          "type": "string",
          "description": "Billing integration vendor webhook signature or secret key; required for vendor other than `custom`.",
          "writeOnly": true
        },
        "signature_set": {
          "type": "string",
          "format": "date-time",
          "description": "Date billing integration vendor webhook signature was set.",
          "readOnly": true
        },
        "url": {
          "type": "string",
          "format": "url",
          "description": "Billing integration vendor region or environment URL; required for vendor `myFatoorah`.",
          "enum": [
            "https://api.myfatoorah.com",
            "https://api-sa.myfatoorah.com",
            "https://api-qa.myfatoorah.com",
            "https://apitest.myfatoorah.com"
          ]
        },
        "vendor": {
          "type": "string",
          "description": "Billing integration vendor for the provider marketplace.",
          "enum": [
            "stripe",
            "myFatoorah",
            "custom"
          ]
        }
      },
      "example": {
        "enabled": true,
        "key": "example_value",
        "key_set": "2026-04-21T00:00:00Z",
        "portal_url": "https://example.com",
        "signature": "example_value",
        "signature_set": "2026-04-21T00:00:00Z",
        "url": "https://api.myfatoorah.com",
        "vendor": "stripe"
      }
    },
    "certificate": {
      "type": "string",
      "description": "Encrypted certificate",
      "writeOnly": true,
      "example": "example_value"
    },
    "certificate_expires": {
      "type": "datetime",
      "description": "Expiry date of certificate provided for marketplace domain.",
      "example": "2026-04-21T00:00:00Z"
    },
    "console": {
      "type": "object",
      "description": "Console page settings for the provider marketplace.",
      "default": {
        "getting_started": {
          "enabled": false
        }
      },
      "additionalProperties": false,
      "properties": {
        "getting_started": {
          "type": "object",
          "description": "Getting Started section settings for the provider marketplace console page.",
          "default": {
            "enabled": false
          },
          "required": [
            "enabled"
          ],
          "additionalProperties": false,
          "properties": {
            "enabled": {
              "type": "boolean",
              "description": "Whether Getting Started section is enabled for the provider marketplace console page.",
              "default": false
            },
            "type": {
              "type": "string",
              "description": "Type of document to display on Getting Started section on the provider marketplace console page.",
              "enum": [
                "document"
              ]
            },
            "url": {
              "type": "string",
              "description": "Document resource guid",
              "x-no-tags": true
            }
          }
        }
      },
      "example": {
        "getting_started": {
          "enabled": true,
          "type": "document",
          "url": "https://example.com"
        }
      }
    },
    "consumer": {
      "type": "boolean",
      "description": "Whether to allow authenticated consumer org user access to the marketplace.",
      "default": false,
      "example": true
    },
    "consumer_approve": {
      "type": "boolean",
      "description": "Whether to Require newly registered consumer organizations in the marketplace to require approval from an organization administrator.",
      "default": false,
      "example": true
    },
    "description": {
      "type": "object",
      "description": "Description of the provider marketplace instance.",
      "default": {},
      "properties": {
        "en-US": {
          "type": "string",
          "description": "English language value.",
          "allOf": [
            {
              "$ref": "#/components/schemas/Provider/x-defs/description"
            }
          ]
        },
        "fr-FR": {
          "type": "string",
          "description": "French language value.",
          "allOf": [
            {
              "$ref": "#/components/schemas/Provider/x-defs/description"
            }
          ]
        },
        "de-DE": {
          "type": "string",
          "description": "German language value.",
          "allOf": [
            {
              "$ref": "#/components/schemas/Provider/x-defs/description"
            }
          ]
        },
        "pt-BR": {
          "type": "string",
          "description": "Portuguese language value.",
          "allOf": [
            {
              "$ref": "#/components/schemas/Provider/x-defs/description"
            }
          ]
        }
      },
      "example": {
        "en-US": "example_value",
        "fr-FR": "example_value",
        "de-DE": "example_value",
        "pt-BR": "example_value"
      }
    },
    "footer": {
      "type": "object",
      "description": "Appearance and content settings for the provider marketplace common footer element.",
      "default": {
        "items": {
          "en-US": null,
          "fr-FR": null,
          "de-DE": null,
          "pt-BR": null
        }
      },
      "properties": {
        "background": {
          "type": [
            "string",
            "null"
          ],
          "description": "Fill format for the footer background.",
          "enum": [
            "solid",
            "gradient",
            null
          ]
        },
        "background_direction": {
          "type": "string",
          "description": "Direction for the footer background gradient.",
          "enum": [
            "to right",
            "to bottom",
            "to right top",
            "to right bottom"
          ]
        },
        "background_end": {
          "type": "string",
          "description": "Ending color for footer background."
        },
        "background_start": {
          "type": "string",
          "description": "Starting color for footer background."
        },
        "brd": {
          "type": "string",
          "description": "Color for footer borders and dividers."
        },
        "color": {
          "type": "string",
          "description": "Color for footer text."
        },
        "link": {
          "type": "string",
          "description": "Color for footer links."
        },
        "items": {
          "type": "object",
          "description": "Elements shown in the footer block.",
          "default": {},
          "properties": {
            "en-US": {
              "type": "array",
              "description": "English language value.",
              "allOf": [
                {
                  "$ref": "#/components/schemas/Provider/x-defs/footer.items"
                }
              ]
            },
            "fr-FR": {
              "type": "array",
              "description": "French language value.",
              "allOf": [
                {
                  "$ref": "#/components/schemas/Provider/x-defs/footer.items"
                }
              ]
            },
            "de-DE": {
              "type": "array",
              "description": "German language value.",
              "allOf": [
                {
                  "$ref": "#/components/schemas/Provider/x-defs/footer.items"
                }
              ]
            },
            "pt-BR": {
              "type": "array",
              "description": "Portuguese language value.",
              "allOf": [
                {
                  "$ref": "#/components/schemas/Provider/x-defs/footer.items"
                }
              ]
            }
          }
        }
      },
      "example": {
        "background": "solid",
        "background_direction": "to right",
        "background_end": "example_value",
        "background_start": "example_value",
        "brd": "example_value",
        "color": "example_value",
        "link": "example_value",
        "items": {
          "en-US": [
            "example_value"
          ],
          "fr-FR": [
            "example_value"
          ],
          "de-DE": [
            "example_value"
          ],
          "pt-BR": [
            "example_value"
          ]
        }
      }
    },
    "guid": {
      "type": "string",
      "description": "Identifier of the provider marketplace instance.",
      "example": "example_value"
    },
    "help_menu": {
      "type": "object",
      "description": "Content shown in the navigation bar help menu.",
      "default": {},
      "properties": {
        "en-US": {
          "type": "array",
          "description": "English language value.",
          "allOf": [
            {
              "$ref": "#/components/schemas/Provider/x-defs/help_menu"
            }
          ]
        },
        "fr-FR": {
          "type": "array",
          "description": "French language value.",
          "allOf": [
            {
              "$ref": "#/components/schemas/Provider/x-defs/help_menu"
            }
          ]
        },
        "de-DE": {
          "type": "array",
          "description": "German language value.",
          "allOf": [
            {
              "$ref": "#/components/schemas/Provider/x-defs/help_menu"
            }
          ]
        },
        "pt-BR": {
          "type": "array",
          "description": "Portuguese language value.",
          "allOf": [
            {
              "$ref": "#/components/schemas/Provider/x-defs/help_menu"
            }
          ]
        }
      },
      "example": {
        "en-US": [
          "example_value"
        ],
        "fr-FR": [
          "example_value"
        ],
        "de-DE": [
          "example_value"
        ],
        "pt-BR": [
          "example_value"
        ]
      }
    },
    "help_menu_icon": {
      "type": "string",
      "description": "Icon displayed in the navigation bar to show the help menu.",
      "example": "example_value"
    },
    "homepage": {
      "type": "object",
      "description": "Homepage settings for the provider marketplace.",
      "default": {
        "enabled": false,
        "items": []
      },
      "required": [
        "enabled"
      ],
      "additionalProperties": false,
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Whether homepage is enabled for the provider marketplace.",
          "default": false
        },
        "default_page": {
          "type": [
            "object",
            "null"
          ],
          "description": "Which path to display when homepage is not shown; `null` displays \"Browse Products\".",
          "default": null,
          "discriminator": {
            "propertyName": "type",
            "mapping": {
              "document": "#/components/schemas/Provider/properties/homepage/properties/default_page/oneOf/0",
              "url": "#/components/schemas/Provider/properties/homepage/properties/default_page/oneOf/1"
            }
          },
          "oneOf": [
            {
              "properties": {
                "url": {
                  "type": "string",
                  "description": "Document resource guid"
                }
              }
            },
            {
              "properties": {
                "url": {
                  "type": "string",
                  "enum": [
                    "/categories",
                    "/activity"
                  ]
                }
              }
            }
          ],
          "properties": {
            "type": {
              "type": "string",
              "enum": [
                "document",
                "url"
              ]
            }
          }
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "unevaluatedProperties": false,
            "discriminator": {
              "propertyName": "type",
              "mapping": {
                "categories": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/0",
                "content": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1",
                "nav": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/2",
                "products": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3",
                "separator": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/4"
              }
            },
            "oneOf": [
              {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "sort": {
                    "type": "string",
                    "description": "Sorting setting for the provider marketplace featured content section.",
                    "enum": [
                      "alpha",
                      "recent"
                    ]
                  },
                  "title": {
                    "type": "object",
                    "description": "Title for the categories.",
                    "default": {},
                    "properties": {
                      "en-US": {
                        "type": "string",
                        "description": "English language value.",
                        "allOf": [
                          {
                            "$ref": "#/components/schemas/Provider/x-defs/homepage_categories_title"
                          }
                        ]
                      },
                      "fr-FR": {
                        "type": "string",
                        "description": "French language value.",
                        "allOf": [
                          {
                            "$ref": "#/components/schemas/Provider/x-defs/homepage_categories_title"
                          }
                        ]
                      },
                      "de-DE": {
                        "type": "string",
                        "description": "German language value.",
                        "allOf": [
                          {
                            "$ref": "#/components/schemas/Provider/x-defs/homepage_categories_title"
                          }
                        ]
                      },
                      "pt-BR": {
                        "type": "string",
                        "description": "Portuguese language value.",
                        "allOf": [
                          {
                            "$ref": "#/components/schemas/Provider/x-defs/homepage_categories_title"
                          }
                        ]
                      }
                    }
                  },
                  "type": {
                    "type": "string",
                    "enum": [
                      "categories"
                    ]
                  }
                }
              },
              {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                  "background": {
                    "type": "object",
                    "unevaluatedProperties": false,
                    "properties": {
                      "color_end": {
                        "type": "string",
                        "format": "color",
                        "description": "Starting color for the background."
                      },
                      "color_start": {
                        "type": "string",
                        "format": "color",
                        "description": "Ending color for the background."
                      },
                      "direction": {
                        "type": "string",
                        "description": "Direction for the background color gradient.",
                        "enum": [
                          "to right",
                          "to bottom",
                          "to right top",
                          "to right bottom"
                        ]
                      },
                      "image_position": {
                        "type": "string",
                        "description": "Background image position for the content.",
                        "enum": [
                          "left top",
                          "left center",
                          "left bottom",
                          "right top",
                          "right center"

# --- truncated at 32 KB (86 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/axway/refs/heads/main/json-structure/amplify-platform-provider-structure.json