{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Provider",
"title": "Provider",
"type": "object",
"required": [
"consumer",
"consumer_approve",
"guid",
"name",
"org_guid",
"public",
"signup",
"terms"
],
"x-defs": {
"menu_item": {
"type": "object",
"required": [
"type",
"text",
"url"
],
"unevaluatedProperties": false,
"discriminator": {
"propertyName": "type",
"mapping": {
"url": "#/components/schemas/Provider/x-defs/menu_item/oneOf/0",
"document": "#/components/schemas/Provider/x-defs/menu_item/oneOf/1"
}
},
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"url"
]
},
"url": {
"type": "string",
"description": "URL or relative path for the link.",
"pattern": "(^((https?:\\/\\/[A-Za-z0-9.-]+|(?:www\\.|[-;:&=+$,\\w]+@)[A-Za-z0-9.-]+)((?:\\/[+~%/.\\w\\-_]*)?\\??(?:[-+=&;%@.\\w_]*)#?(?:[\\w?/:@\\-._~!$&'()*+,;=]*))?)$|^(?:\\/[+~%/.\\w\\-_]*)(?:\\?[-+=&;%@.\\w_]*)?(?:#[.!/\\\\\\w]*)?$)"
}
}
},
{
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"document"
]
},
"url": {
"type": "string",
"description": "Document resource guid"
}
}
}
],
"properties": {
"new_tab": {
"type": "boolean",
"description": "Whether the link opens in a new tab."
},
"text": {
"type": "string",
"description": "Label for the link.",
"x-no-tags": true
},
"type": {
"type": "string",
"description": "Type of the link.",
"enum": [
"document",
"url"
]
},
"url": {
"type": "string",
"description": "URL, relative path, or document resource guid for the link."
},
"visibility": {
"type": "integer",
"description": "Which users the link is visible to. Always shown: 0, Signed in: 1, Signed out: 2, Hidden: 3",
"enum": [
0,
1,
2,
3
]
}
}
},
"onboarding.items.hint": {
"type": "string",
"description": "Contextual information for the element."
},
"onboarding.items.text": {
"type": "string",
"description": "Label for the element."
},
"onboarding_props": {
"type": "object",
"required": [
"id",
"type",
"text"
],
"properties": {
"hint": {
"type": "object",
"description": "Contextual information for the element.",
"default": {},
"properties": {
"en-US": {
"type": "string",
"description": "English language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.hint"
}
]
},
"fr-FR": {
"type": "string",
"description": "French language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.hint"
}
]
},
"de-DE": {
"type": "string",
"description": "German language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.hint"
}
]
},
"pt-BR": {
"type": "string",
"description": "Portuguese language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.hint"
}
]
}
}
},
"id": {
"type": "string",
"description": "Identifier for the element.",
"pattern": "[\\w-]{21}"
},
"required": {
"type": "boolean",
"description": "Whether entry is required for the element."
},
"text": {
"type": "object",
"description": "Label for the element.",
"default": {},
"properties": {
"en-US": {
"type": "string",
"description": "English language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.text"
}
]
},
"fr-FR": {
"type": "string",
"description": "French language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.text"
}
]
},
"de-DE": {
"type": "string",
"description": "German language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.text"
}
]
},
"pt-BR": {
"type": "string",
"description": "Portuguese language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.text"
}
]
}
}
},
"type": {
"type": "string",
"description": "Type of element.",
"enum": [
"header",
"text",
"number",
"date",
"checkbox",
"toggle",
"select",
"multiselect"
]
},
"visibility": {
"type": "number",
"description": "Whether the field is only available to provider administrators",
"enum": [
0,
1
]
}
}
},
"onboarding.items.placeholder": {
"type": "string",
"description": "Placeholder or example value for the element."
},
"placeholder": {
"type": "object",
"description": "Placeholder or example value for the element.",
"default": {},
"properties": {
"en-US": {
"type": "string",
"description": "English language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.placeholder"
}
]
},
"fr-FR": {
"type": "string",
"description": "French language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.placeholder"
}
]
},
"de-DE": {
"type": "string",
"description": "German language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.placeholder"
}
]
},
"pt-BR": {
"type": "string",
"description": "Portuguese language value.",
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/onboarding.items.placeholder"
}
]
}
}
},
"homepage_border": {
"type": "object",
"description": "Item border properties.",
"properties": {
"color": {
"type": "string",
"format": "color",
"description": "Border color"
},
"radius": {
"type": "string",
"description": "Border radius",
"default": "square",
"enum": [
"square",
"rounded",
"pill"
]
},
"style": {
"type": "string",
"description": "Border style",
"default": "solid",
"enum": [
"solid",
"dashed",
"dotted"
]
},
"width": {
"type": "object",
"additionalProperties": false,
"properties": {
"bottom": {
"type": "string",
"pattern": "^[0-9]+\\.?([0-9]+)?px$"
},
"left": {
"type": "string",
"pattern": "^[0-9]+\\.?([0-9]+)?px$"
},
"right": {
"type": "string",
"pattern": "^[0-9]+\\.?([0-9]+)?px$"
},
"top": {
"type": "string",
"pattern": "^[0-9]+\\.?([0-9]+)?px$"
}
}
}
}
},
"homepage_spacing": {
"type": "object",
"additionalProperties": false,
"properties": {
"bottom": {
"type": "string",
"pattern": "^[0-9]+\\.?([0-9]+)?(px|%|em|rem)$"
},
"left": {
"type": "string",
"pattern": "^[0-9]+\\.?([0-9]+)?(px|%|em|rem)$"
},
"right": {
"type": "string",
"pattern": "^[0-9]+\\.?([0-9]+)?(px|%|em|rem)$"
},
"top": {
"type": "string",
"pattern": "^[0-9]+\\.?([0-9]+)?(px|%|em|rem)$"
}
}
},
"genderedLangSchema": {
"type": "object",
"properties": {
"en-US": {
"type": "null",
"description": "English language value.",
"enum": [
null
]
},
"fr-FR": {
"type": "string",
"description": "French language value.",
"enum": [
"m",
"f"
]
},
"de-DE": {
"type": "string",
"description": "German language value.",
"enum": [
"m",
"f",
"n"
]
},
"pt-BR": {
"type": "string",
"description": "Portuguese language value.",
"enum": [
"m",
"f"
]
}
}
},
"description": {
"type": "string",
"description": "Description of the provider marketplace instance.",
"default": "",
"maxLength": 200
},
"footer.items": {
"type": "array",
"description": "Elements shown in the footer block.",
"maxItems": 10,
"items": {
"type": "object",
"unevaluatedProperties": false,
"discriminator": {
"propertyName": "type",
"mapping": {
"nav_menu": "#/components/schemas/Provider/x-defs/footer.items/items/oneOf/0",
"logo": "#/components/schemas/Provider/x-defs/footer.items/items/oneOf/1",
"text": "#/components/schemas/Provider/x-defs/footer.items/items/oneOf/2",
"separator": "#/components/schemas/Provider/x-defs/footer.items/items/oneOf/3"
}
},
"oneOf": [
{
"title": "Menu",
"description": "Navigation menu.",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"title": "Navigation Menu Items",
"description": "Links added in the footer navigation menu.",
"maxItems": 9,
"items": {
"$ref": "#/components/schemas/Provider/x-defs/menu_item"
}
},
"type": {
"enum": [
"nav_menu"
]
}
}
},
{
"title": "Logo",
"description": "Company logo.",
"required": [
"image"
],
"properties": {
"image": {
"type": "string",
"description": "Company logo."
},
"tagline": {
"type": "string",
"format": "html",
"description": "Company tagline."
},
"type": {
"enum": [
"logo"
]
}
}
},
{
"title": "Text",
"description": "Text block.",
"required": [
"content"
],
"properties": {
"content": {
"type": "string",
"format": "html",
"description": "Text block to show in the footer."
},
"type": {
"enum": [
"text"
]
}
}
},
{
"title": "Separator",
"description": "Separator.",
"properties": {
"type": {
"enum": [
"separator"
]
}
}
}
],
"properties": {
"position": {
"type": "string",
"description": "Alignment of the content within the footer block.",
"enum": [
"left",
"center",
"right"
]
},
"type": {
"type": "string",
"description": "Content type"
}
}
}
},
"help_menu": {
"type": "array",
"description": "Content shown in the navigation bar help menu.",
"items": {
"type": "object",
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/components/schemas/Provider/x-defs/menu_item"
}
],
"properties": {
"icon": {
"type": "string",
"description": "Icon displayed in the menu for the item."
}
}
}
},
"homepage_categories_title": {
"type": "string",
"description": "Title for the categories."
},
"homepage_content_button_text": {
"type": "string",
"description": "Button text"
},
"homepage_content_image_alt": {
"type": "string",
"description": "Image alt text."
},
"homepage_content_search_text": {
"type": "string",
"description": "Placeholder text"
},
"homepage_content_text": {
"type": "string",
"description": "Text content, using markdown formatting."
},
"homepage_products_title": {
"type": "string",
"description": "Title for the products."
},
"name": {
"type": "string",
"description": "Name of the provider marketplace instance.",
"minLength": 2,
"maxLength": 350,
"x-no-tags": true
},
"nav_items": {
"type": "array",
"description": "Links added in the common navigation menu.",
"maxItems": 9,
"items": {
"$ref": "#/components/schemas/Provider/x-defs/menu_item"
}
},
"onboarding.items.off": {
"type": "string",
"description": "Label for disabled toggle state."
},
"onboarding.items.on": {
"type": "string",
"description": "Label for enabled toggle state."
},
"onboarding.items.options.text": {
"type": "string",
"description": "Label for value."
},
"reviews.instructions": {
"type": "string",
"description": "Review guidelines and policies within the provider marketplace.",
"x-no-tags": true
},
"sitename": {
"type": "string",
"description": "Page title of the provider marketplace instance.",
"maxLength": 350,
"x-no-tags": true
}
},
"unevaluatedProperties": false,
"allOf": [
{
"$ref": "#/components/schemas/DefaultFields"
}
],
"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.myfato
# --- truncated at 32 KB (102 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/axway/refs/heads/main/json-schema/axway-provider-schema.json