openapi: 3.1.0 info: version: 16.10.0 title: Amplify Platform API v1.0.0 aca provider API description: 'The Amplify Platform API provides the interface to perform the following: - Manage account settings and credentials - Manage organization settings, users, service accounts, and teams - Retrieve organization usage data - Register and manage applications - Retrieve application metrics and analytics - Retrieve user, organization, and application activity See the Amplify Guide for documentation and examples on how to authorize API calls to platform services. For general documentation refer to the Amplify Platform documentation. © Axway 2026. All rights reserved.' contact: email: support@axway.com termsOfService: https://www.axway.com/en/axway-platform-terms-of-use servers: - url: https://platform.axway.com/api/v1 tags: - name: provider paths: /provider: parameters: [] post: summary: Axway Create Provider Marketplace description: "Creates a provider marketplace.\n\n___Auth Requirement___\n - _All of_\n - `administrator` access to the organization.\n - The organization entitlements allow `Hub.Marketplaces`.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_create x-publishes: - marketplace.create responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: 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 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 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. 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. 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_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. 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 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_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_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 certificate_expires: type: string format: date-time description: Expiry date of certificate provided for marketplace domain. 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 consumer: type: boolean description: Whether to allow authenticated consumer org user access to the marketplace. default: false consumer_approve: type: boolean description: Whether to Require newly registered consumer organizations in the marketplace to require approval from an organization administrator. default: false 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' 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' guid: type: string description: Identifier of the provider marketplace instance. 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' help_menu_icon: type: string description: Icon displayed in the navigation bar to show the help menu. 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 - right bottom - center top - center center - center bottom image_size: type: string description: Background image size for the content. enum: - auto - cover - contain - 100% 100% url: type: string description: Background image URL for the content. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' content: type: array description: Content items. items: type: object unevaluatedProperties: false discriminator: propertyName: type mapping: button: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/1' image: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/2' search: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/3' text: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/4' oneOf: - type: object title: Button required: - url unevaluatedProperties: false discriminator: propertyName: url_type mapping: url: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/1' oneOf: - title: URL properties: url: type: string description: URL or relative path for the link. anyOf: - type: string title: URL pattern: (^((https?:\/\/[A-Za-z0-9.-]+|(?:www\.|[-;:&=+$,\w]+@)[A-Za-z0-9.-]+)((?:\/[+~%/.\w\-_]*)?\??(?:[-+=&;%@.\w_]*)#?(?:[\w?/:@\-._~!$&'()*+,;=]*))?)$|^(?:\/[+~%/.\w\-_]*)(?:\?[-+=&;%@.\w_]*)?(?:#[.!/\\\w]*)?$) - type: string title: Signin enum: - signin url_type: type: string enum: - url - title: Document properties: url: type: string description: Document resource guid url_type: type: string enum: - document properties: background: type: string format: color description: Button background color. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Button text color. format: type: string description: Button background fill or outline. enum: - solid - outline target: type: - 'null' - string default: null enum: - null - _blank text: type: object description: Button text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' type: type: string enum: - button url_type: type: string description: Link type for the button URL. enum: - url - document - type: object title: Document required: - id unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' id: type: string description: Published document resource identifier. type: type: string enum: - document - type: object title: Image required: - url unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' text: type: object description: Image alt text. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' type: type: string enum: - image url: type: string description: Image source URL. - type: object title: Search unevaluatedProperties: false properties: scope: type: string enum: - products - documents - resources - all text: type: object description: Placeholder text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' - type: object title: Text unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Text color. padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' text: type: object description: Text content, using markdown formatting. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' type: type: string enum: - text properties: align: type: string description: Content alignment. default: left enum: - left - center - right margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string enum: - button - document - image - search - text type: type: string enum: - content - type: object additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - nav - type: object additionalProperties: false discriminator: propertyName: filter mapping: top: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' published: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' tags: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/1' oneOf: - type: object properties: filter: type: string enum: - top - published - type: object properties: filter: type: string enum: - tags tags: type: array description: The tags determining which products to show when `filter` is set to `"tags".` minItems: 1 items: type: string properties: count: type: number maximum: 12 filter: type: string description: Displayed products setting for the provider marketplace featured products section. enum: - tags - top - published sort: type: string description: Sorting setting for the provider marketplace featured products section. enum: - alpha - recent - highest_rating - most_reviews title: type: object description: Title for the products. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' type: type: string enum: - products - type: object required: - border additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - separator properties: margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string visibility: type: number description: 'Item visibility. Always shown: 0, Signed in: 1, Signed out: 2' enum: - 0 - 1 - 2 width: type: number description: 'Item width. Full width: 0, Full width aligned to grid: 5, Column width: 1 - 4.' enum: - 0 - 1 - 2 - 3 - 4 - 5 idp: type: boolean description: Whether to allow consumer organizations in the marketplace to establish custom Identity Providers. default: false idp_hint: type: - string - 'null' description: Identity Provider `guid` to use for sign in attempts originating from the marketplace. Cannot be set at the same time as `consumer`. lang: type: object description: Internationalization settings for the provider marketplace. default: default: en-US supported: - en-US products: all properties: default: type: string description: Default language to use for users of the marketplace. default: en-US enum: - en-US - fr-FR - de-DE - pt-BR products: type: string description: Behavior for display of products in the marketplace based on translation state. default: all enum: - all - translated supported: type: array description: Languages supported by the marketplace. default: - en-US items: type: string enum: - en-US - fr-FR - de-DE - pt-BR name: type: object description: Name of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' name_gender: description: Gender of the `name` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' nav_items: type: object description: Links added in the common navigation menu. default: {} properties: en-US: type: array description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' fr-FR: type: array description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' de-DE: type: array description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' pt-BR: type: array description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' oauth: type: object description: OAuth 2.0 client settings for the provider marketplace's consumer users. default: enabled: false properties: github: type: object description: Settings for the provider marketplace's GitHub OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitHub" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered application within GitHub. secret_updated: type: string format: date-time description: Date client_secret last updated. gitlab: type: object description: Settings for the provider marketplace's GitLab OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitLab" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Application ID of the registered application within GitLab. secret_updated: type: string format: date-time description: Date client_secret last updated. google: type: object description: Settings for the provider marketplace's Google OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with Google" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered OAuth 2.0 Credentials within Google. secret_updated: type: string format: date-time description: Date client_secret last updated. onboarding: type: object description: Onboarding data capture settings for the provider marketplace. default: enabled: false items: [] properties: enabled: type: boolean description: Whether onboarding data capture feature is enabled for the provider marketplace. items: type: array description: Onboarding fields to capture for consumer orgs of the provider marketplace. minItems: 1 maxItems: 50 items: type: object discriminator: propertyName: type mapping: header: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/0' text: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/1' number: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' date: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' checkbox: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' toggle: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/3' select: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' multiselect: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' oneOf: - type: object required: - id - type - text properties: id: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/id' text: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/text' type: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/type' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: maxlen: type: number description: Maximum value length for the element. placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: 'off': type: object description: Label for disabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' 'on': type: object description: Label for enabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: options: type: array minItems: 2 maxItems: 1000 items: type: object required: - text - value properties: text: type: object description: Label for value. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' value: type: string placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' org_guid: type: string format: uuid description: '`guid` of the organization the provider marketplace belongs to.' provider_idp: type: object default: enabled: false properties: enabled: type: boolean default: false allow_external: type: boolean default: false enforce_association: type: boolean default: false public: type: boolean description: Whether the provider marketplace allows access to unauthenticated users or users authenticated to orgs other than the provider org. default: false reviews: type: object description: Ratings & Reviews settings for the provider marketplace. default: enabled: false properties: enabled: type: boolean description: Whether Ratings & Reviews are enabled for the provider marketplace. char_limit: type: number description: Character limit for written feedback for products or services in the provider marketplace. enum: - 280 - 1000 - 4000 flagged_handling: type: string description: How reported review content is handled within the provider marketplace enum: - hide - show instructions: type: object description: Review guidelines and policies within the provider marketplace. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' moderation_process: type: string description: Which type of moderation process is to be used for reviews in the provider marketplace enum: - manual - automatic permissions: type: string description: Who is allowed to provide feedback for products or services in the provider marketplace. enum: - subscribers - all public_responses: type: boolean description: Whether to enable public responses to reviews in the provider marketplace. response_time: type: number description: Expected response time for feedback in the provider marketplace, in `response_time_unit`. minimum: 1 response_time_unit: type: string description: Unit of time that `response_time` correlates to. search_engines: type: object default: indexing_enabled: true additionalProperties: false properties: google_site_verification_id: type: string description: Site Verification ID for Google Search Console integration. minLength: 1 indexing_enabled: type: boolean description: Whether indexing by search engines is enabled for the marketplace. default: true signup: type: boolean description: Whether to allow self-service sign up for consumer organizations in the marketplace. default: false sitename: type: object description: Page title of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' sitename_gender: description: Gender of the `sitename` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' subdomain: type: string description: Subdomain on which the provider marketplace can be accessed. pattern: ^[a-z0-9\-]{4,63}$ terms: type: boolean description: Whether the provider marketplace access should be gated on acceptance of Terms & Conditions. default: false terms_updated: type: string format: date-time description: Date Terms & Conditions last updated. terms_url: type: string format: url description: URL of the provider marketplace Terms & Conditions. url: type: string description: Fully qualified domain name on which the provider marketplace can be accessed. pattern: ^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$ versions: type: object description: Product version settings for the provider marketplace. default: custom: false display: all properties: custom: type: boolean description: Whether custom product versions are displayed in the provider marketplace. default: false display: type: string description: What product version types will be displayed in the provider marketplace. default: all enum: - all - latest examples: ProviderCreate200Example: summary: Default provider_create 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: MAX_FILE_SIZE: value: success: false description: The file exceeds the maximum upload size of %d bytes. code: 400 PROVIDER_LIMIT: value: success: false description: Marketplace limit reached. code: 400 PROVIDER_NAME_UNIQUE: value: success: false description: The provided Marketplace name is already in use in the organization. code: 400 PROVIDER_SUBDOMAIN_UNIQUE: value: success: false description: The provided Marketplace subdomain is already in use. code: 400 PROVIDER_SUBDOMAIN_URL: value: success: false description: Marketplace Settings requires a valid subdomain or URL. code: 400 PROVIDER_URL_CNAME: value: success: false description: Marketplace URL does not have expected CNAME registered. code: 400 PROVIDER_URL_UNIQUE: value: success: false description: The provided Marketplace URL is already in use. code: 400 PROVIDER_CERT_DOMAIN: value: success: false description: The provided certificate does not match the Marketplace URL's domain. code: 400 PROVIDER_CERT_PRIVATE_KEY: value: success: false description: The provided certificate contains an invalid private key. code: 400 PROVIDER_CERT_EXPIRED: value: success: false description: The provided certificate is expired. code: 400 FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' IDP_REQUIRED: value: $ref: '#/components/examples/IDP_REQUIRED/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value requestBody: content: multipart/form-data: schema: properties: ai: $ref: '#/components/schemas/Provider/properties/ai' appearance: $ref: '#/components/schemas/Provider/properties/appearance' billing: $ref: '#/components/schemas/Provider/properties/billing' certificate: type: string description: Certificate matching provider marketplace URL; accepts full CA chain files in PEM format. format: binary consumer: $ref: '#/components/schemas/Provider/properties/consumer' consumer_approve: $ref: '#/components/schemas/Provider/properties/consumer_approve' description: $ref: '#/components/schemas/Provider/properties/description' favicon: type: string description: Provider marketplace favicon file; accepts PNG or ICO only. format: binary footer: $ref: '#/components/schemas/Provider/properties/footer' help_menu: $ref: '#/components/schemas/Provider/properties/help_menu' help_menu_icon: $ref: '#/components/schemas/Provider/properties/help_menu_icon' homepage: $ref: '#/components/schemas/Provider/properties/homepage' idp: $ref: '#/components/schemas/Provider/properties/idp' idp_hint: $ref: '#/components/schemas/Provider/properties/idp_hint' lang: $ref: '#/components/schemas/Provider/properties/lang' logo: type: string description: Provider marketplace logo file; accepts PNG, JPEG, or GIF only. format: binary name: $ref: '#/components/schemas/Provider/properties/name' nav_items: $ref: '#/components/schemas/Provider/properties/nav_items' oauth: $ref: '#/components/schemas/Provider/properties/oauth' onboarding: $ref: '#/components/schemas/Provider/properties/onboarding' org_guid: $ref: '#/components/schemas/Provider/properties/org_guid' public: $ref: '#/components/schemas/Provider/properties/public' reviews: $ref: '#/components/schemas/Provider/properties/reviews' search_engines: $ref: '#/components/schemas/Provider/properties/search_engines' signup: $ref: '#/components/schemas/Provider/properties/signup' sitename: $ref: '#/components/schemas/Provider/properties/sitename' subdomain: $ref: '#/components/schemas/Provider/properties/subdomain' terms: $ref: '#/components/schemas/Provider/properties/terms' terms_file: type: string description: Provider marketplace Terms & Conditions file; accepts PDF only. format: binary terms_updated: type: boolean description: Whether Terms & Conditions has been updated terms_url: $ref: '#/components/schemas/Provider/properties/terms_url' url: $ref: '#/components/schemas/Provider/properties/url' versions: $ref: '#/components/schemas/Provider/properties/versions' required: - name - org_guid x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: Axway Get Provider Marketplaces description: "Returns the provider marketplaces for an organization\n\n___Auth Requirement___\n - Access to the organization, allowing consumer role.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_find responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: title: ProviderList type: array description: A list of Provider objects. items: type: object properties: _id: type: string description: Document ID of the provider. readOnly: true deprecated: true 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 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. 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. 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. 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 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 certificate: type: string description: Encrypted certificate writeOnly: true certificate_expires: type: string format: date-time description: Expiry date of certificate provided for marketplace domain. 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 consumer: type: boolean description: Whether to allow authenticated consumer org user access to the marketplace. default: false consumer_approve: type: boolean description: Whether to Require newly registered consumer organizations in the marketplace to require approval from an organization administrator. default: false 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' 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' guid: type: string description: Identifier of the provider marketplace instance. 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' help_menu_icon: type: string description: Icon displayed in the navigation bar to show the help menu. 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 - right bottom - center top - center center - center bottom image_size: type: string description: Background image size for the content. enum: - auto - cover - contain - 100% 100% url: type: string description: Background image URL for the content. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' content: type: array description: Content items. items: type: object unevaluatedProperties: false discriminator: propertyName: type mapping: button: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/1' image: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/2' search: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/3' text: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/4' oneOf: - type: object title: Button required: - url unevaluatedProperties: false discriminator: propertyName: url_type mapping: url: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/1' oneOf: - title: URL properties: url: type: string description: URL or relative path for the link. anyOf: - type: string title: URL pattern: (^((https?:\/\/[A-Za-z0-9.-]+|(?:www\.|[-;:&=+$,\w]+@)[A-Za-z0-9.-]+)((?:\/[+~%/.\w\-_]*)?\??(?:[-+=&;%@.\w_]*)#?(?:[\w?/:@\-._~!$&'()*+,;=]*))?)$|^(?:\/[+~%/.\w\-_]*)(?:\?[-+=&;%@.\w_]*)?(?:#[.!/\\\w]*)?$) - type: string title: Signin enum: - signin url_type: type: string enum: - url - title: Document properties: url: type: string description: Document resource guid url_type: type: string enum: - document properties: background: type: string format: color description: Button background color. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Button text color. format: type: string description: Button background fill or outline. enum: - solid - outline target: type: - 'null' - string default: null enum: - null - _blank text: type: object description: Button text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' type: type: string enum: - button url_type: type: string description: Link type for the button URL. enum: - url - document - type: object title: Document required: - id unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' id: type: string description: Published document resource identifier. type: type: string enum: - document - type: object title: Image required: - url unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' text: type: object description: Image alt text. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' type: type: string enum: - image url: type: string description: Image source URL. - type: object title: Search unevaluatedProperties: false properties: scope: type: string enum: - products - documents - resources - all text: type: object description: Placeholder text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' - type: object title: Text unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Text color. padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' text: type: object description: Text content, using markdown formatting. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' type: type: string enum: - text properties: align: type: string description: Content alignment. default: left enum: - left - center - right margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string enum: - button - document - image - search - text type: type: string enum: - content - type: object additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - nav - type: object additionalProperties: false discriminator: propertyName: filter mapping: top: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' published: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' tags: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/1' oneOf: - type: object properties: filter: type: string enum: - top - published - type: object properties: filter: type: string enum: - tags tags: type: array description: The tags determining which products to show when `filter` is set to `"tags".` minItems: 1 items: type: string properties: count: type: number maximum: 12 filter: type: string description: Displayed products setting for the provider marketplace featured products section. enum: - tags - top - published sort: type: string description: Sorting setting for the provider marketplace featured products section. enum: - alpha - recent - highest_rating - most_reviews title: type: object description: Title for the products. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' type: type: string enum: - products - type: object required: - border additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - separator properties: margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string visibility: type: number description: 'Item visibility. Always shown: 0, Signed in: 1, Signed out: 2' enum: - 0 - 1 - 2 width: type: number description: 'Item width. Full width: 0, Full width aligned to grid: 5, Column width: 1 - 4.' enum: - 0 - 1 - 2 - 3 - 4 - 5 idp: type: boolean description: Whether to allow consumer organizations in the marketplace to establish custom Identity Providers. default: false idp_hint: type: - string - 'null' description: Identity Provider `guid` to use for sign in attempts originating from the marketplace. Cannot be set at the same time as `consumer`. lang: type: object description: Internationalization settings for the provider marketplace. default: default: en-US supported: - en-US products: all properties: default: type: string description: Default language to use for users of the marketplace. default: en-US enum: - en-US - fr-FR - de-DE - pt-BR products: type: string description: Behavior for display of products in the marketplace based on translation state. default: all enum: - all - translated supported: type: array description: Languages supported by the marketplace. default: - en-US items: type: string enum: - en-US - fr-FR - de-DE - pt-BR name: type: object description: Name of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' name_gender: description: Gender of the `name` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' nav_items: type: object description: Links added in the common navigation menu. default: {} properties: en-US: type: array description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' fr-FR: type: array description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' de-DE: type: array description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' pt-BR: type: array description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' oauth: type: object description: OAuth 2.0 client settings for the provider marketplace's consumer users. default: enabled: false properties: github: type: object description: Settings for the provider marketplace's GitHub OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitHub" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered application within GitHub. client_secret: type: string description: Client secret for the registered application within GitHub. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. gitlab: type: object description: Settings for the provider marketplace's GitLab OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitLab" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Application ID of the registered application within GitLab. client_secret: type: string description: Application Secret for the registered application within GitLab. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. google: type: object description: Settings for the provider marketplace's Google OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with Google" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered OAuth 2.0 Credentials within Google. client_secret: type: string description: Client secret for the registered OAuth 2.0 Credentials within Google. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. onboarding: type: object description: Onboarding data capture settings for the provider marketplace. default: enabled: false items: [] properties: enabled: type: boolean description: Whether onboarding data capture feature is enabled for the provider marketplace. items: type: array description: Onboarding fields to capture for consumer orgs of the provider marketplace. minItems: 1 maxItems: 50 items: type: object discriminator: propertyName: type mapping: header: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/0' text: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/1' number: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' date: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' checkbox: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' toggle: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/3' select: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' multiselect: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' oneOf: - type: object required: - id - type - text properties: id: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/id' text: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/text' type: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/type' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: maxlen: type: number description: Maximum value length for the element. placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: 'off': type: object description: Label for disabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' 'on': type: object description: Label for enabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: options: type: array minItems: 2 maxItems: 1000 items: type: object required: - text - value properties: text: type: object description: Label for value. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' value: type: string placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' org_guid: type: string format: uuid description: '`guid` of the organization the provider marketplace belongs to.' provider_idp: type: object default: enabled: false properties: enabled: type: boolean default: false allow_external: type: boolean default: false enforce_association: type: boolean default: false public: type: boolean description: Whether the provider marketplace allows access to unauthenticated users or users authenticated to orgs other than the provider org. default: false reviews: type: object description: Ratings & Reviews settings for the provider marketplace. default: enabled: false properties: enabled: type: boolean description: Whether Ratings & Reviews are enabled for the provider marketplace. char_limit: type: number description: Character limit for written feedback for products or services in the provider marketplace. enum: - 280 - 1000 - 4000 flagged_handling: type: string description: How reported review content is handled within the provider marketplace enum: - hide - show instructions: type: object description: Review guidelines and policies within the provider marketplace. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' moderation_process: type: string description: Which type of moderation process is to be used for reviews in the provider marketplace enum: - manual - automatic permissions: type: string description: Who is allowed to provide feedback for products or services in the provider marketplace. enum: - subscribers - all public_responses: type: boolean description: Whether to enable public responses to reviews in the provider marketplace. response_time: type: number description: Expected response time for feedback in the provider marketplace, in `response_time_unit`. minimum: 1 response_time_unit: type: string description: Unit of time that `response_time` correlates to. search_engines: type: object default: indexing_enabled: true additionalProperties: false properties: google_site_verification_id: type: string description: Site Verification ID for Google Search Console integration. minLength: 1 indexing_enabled: type: boolean description: Whether indexing by search engines is enabled for the marketplace. default: true signup: type: boolean description: Whether to allow self-service sign up for consumer organizations in the marketplace. default: false sitename: type: object description: Page title of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' sitename_gender: description: Gender of the `sitename` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' subdomain: type: string description: Subdomain on which the provider marketplace can be accessed. pattern: ^[a-z0-9\-]{4,63}$ terms: type: boolean description: Whether the provider marketplace access should be gated on acceptance of Terms & Conditions. default: false terms_updated: type: string format: date-time description: Date Terms & Conditions last updated. terms_url: type: string format: url description: URL of the provider marketplace Terms & Conditions. url: type: string description: Fully qualified domain name on which the provider marketplace can be accessed. pattern: ^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$ versions: type: object description: Product version settings for the provider marketplace. default: custom: false display: all properties: custom: type: boolean description: Whether custom product versions are displayed in the provider marketplace. default: false display: type: string description: What product version types will be displayed in the provider marketplace. default: all enum: - all - latest product_count: type: integer description: Number of published products in the marketplace subscription_count: type: integer description: Number of subscriptions for the marketplace examples: ProviderFind200Example: summary: Default provider_find 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' IDP_REQUIRED: value: $ref: '#/components/examples/IDP_REQUIRED/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: query name: org_guid required: false schema: type: string description: guid of the organization example: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/onboarding: parameters: [] get: summary: Axway Get Provider Marketplace Onboarding Settings description: 'Returns provider marketplace onboarding settings. _Allows consumer organization access_ ' tags: - provider operationId: provider_findOnboarding responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: $ref: '#/components/schemas/Provider/properties/onboarding' examples: ProviderFindonboarding200Example: summary: Default provider_findOnboarding 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: type: string description: guid of the provider marketplace example: 507f1f77bcf86cd799439011 x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/oauth/{service}/confirm: parameters: [] post: summary: Axway OAuth 2.0 Auth Signup Confirmation description: Confirm user signup via an OAuth 2.0 auth flow externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_oauthConfirm x-publishes: - marketplace.consumer.signup - platform.org.create - platform.user.social.enable responses: '200': $ref: '#/components/responses/SuccessResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: type: string description: guid of the provider marketplace example: 507f1f77bcf86cd799439011 - in: path name: service required: true schema: type: string description: service to initiate OAuth 2.0 auth flow using enum: - github - gitlab - google example: github requestBody: content: '*/*': schema: properties: firstname: type: string description: First name of org administrator. from: type: string description: Optional flag saying where the request is coming from. id: type: string description: GUID of the activation. lastname: type: string description: Last name of org administrator. org_name: type: string description: Name of the organization. required: - firstname - id - lastname - org_name x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/oauth/{service}/callback: parameters: [] get: summary: Axway Concludes OAuth 2.0 Auth description: Concludes an OAuth 2.0 auth flow externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_oauthCallback x-publishes: - platform.user.social.enable responses: '200': $ref: '#/components/responses/SuccessResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: type: string description: guid of the provider marketplace example: 507f1f77bcf86cd799439011 - in: path name: service required: true schema: type: string description: service to which the OAuth 2.0 auth flow is associated enum: - github - gitlab - google example: github - in: query name: code required: false schema: type: string description: Temporary code for authenticating requests against the provider example: example_value - in: query name: state required: true schema: type: string description: State value corresponding to initial authorization request example: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/oauth/{service}/authorize: parameters: [] get: summary: Axway Initiates OAuth 2.0 Auth description: Initiates an OAuth 2.0 auth flow externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_oauthAuthorize responses: '200': $ref: '#/components/responses/SuccessResponse' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: type: string description: guid of the provider marketplace example: 507f1f77bcf86cd799439011 - in: path name: service required: true schema: type: string description: service to which the OAuth 2.0 auth flow is associated enum: - github - gitlab - google example: github - in: query name: grant required: false schema: type: string description: Optional grant value for use with Platform IdP example: example_value x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/idp/saml: parameters: [] post: externalDocs: description: Managing Identity Providers url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/configuring_and_managing_identity_providers/index.html tags: - provider summary: Axway Create Consumer SAML V2.0 IdP description: "Configure a custom SAML v2.0 Identity Provider for a marketplace's consumer organizations\n\n___Auth Requirement___\n - _All of_\n - `administrator` access to the provider's organization.\n - The organization entitlements allow `idp`.\n" operationId: provider_idpCreateSAML x-publishes: - marketplace.idp.create responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: type: object required: - guid - name - protocol unevaluatedProperties: false allOf: - $ref: '#/components/schemas/DefaultFields' properties: _id: type: string description: Document ID of the Identity Provider. deprecated: true description: type: string description: Description of the Identity Provider. guid: type: string format: uuid description: '`guid` of the Identity Provider.' name: type: string description: Name of Identity Provider protocol: type: string description: Protocol the Identity Provider uses. enum: - oidc - saml provider_guid: type: string examples: ProviderIdpcreatesaml200Example: summary: Default provider_idpCreateSAML 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: IDP_MIXED_MAPPERS: value: success: false description: Cannot configure mappers with the same value in both Friendly and Attribute Names. code: 400 FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} requestBody: content: '*/*': schema: properties: allowedClockSkew: type: integer description: Clock skew in seconds that is tolerated when validating identity provider tokens default: 0 attributeConsumingServiceIndex: type: integer description: Index of the Attribute Consuming Service profile to request during authentication default: 0 attributeConsumingServiceName: type: string description: Name of the Attribute Consuming Service profile to advertise in the SP metadata backchannelSupported: type: boolean description: Whether the IdP supports backchannel logout default: false description: $ref: '#/components/schemas/IdentityProvider/properties/description' encryptionAlgorithm: type: string description: Encryption algorithm which is used by the SAML Identity Provider for encryption of SAML documents, assertions or IDs. The corresponding decryption key for decrypt SAML document parts will be chosen based on this configured algorithm and is provided by Axway for the encryption (ENC) usage. If algorithm is not configured, then any supported algorithm is allowed and decryption key will be chosen based on the algorithm configured in SAML document itself. enum: - RSA-OAEP entityId: type: string description: The Entity ID that will be used to uniquely identify this SAML Service Provider forceAuthn: type: boolean description: Whether the IdP must authenticate the presenter directly rather than rely on a previous security context default: false idpEntityId: type: string description: The Entity ID used to validate the Issuer for received SAML assertions. If empty, no Issuer validation is performed loginHint: type: boolean description: Whether to pass login_hint to the IdP default: true metadataDescriptorUrl: type: string description: External URL where the Identity Provider publishes the SAML Descriptor metadata information to source the X509 certificates used to validate signatures name: $ref: '#/components/schemas/IdentityProvider/properties/name' nameIDPolicyFormat: type: string description: Specifies the URI reference corresponding to a name identifier format enum: - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent - urn:oasis:names:tc:SAML:2.0:nameid-format:transient - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress - urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos - urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName - urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified postBindingAuthnRequest: type: boolean description: Indicates whether the AuthnRequest must be sent using HTTP-POST binding default: true postBindingLogout: type: boolean description: Indicates whether to respond to requests using HTTP-POST binding default: false postBindingResponse: type: boolean description: Indicates whether to respond to requests using HTTP-POST binding default: true xmlSigKeyInfoKeyNameTransformer: type: string description: Signing key to use in KeyName element enum: - NONE - KEY_ID - CERT_SUBJECT signSpMetadata: type: boolean description: Enable/disable signature of the provider SAML metadata signatureAlgorithm: type: string description: The signature algorithm to use to sign documents enum: - RSA_SHA256 - RSA_SHA256_MGF1 - RSA_SHA512 - RSA_SHA512_MGF1 signingCertificate: type: string description: The certificate in PEM format that must be used to check for signatures. Multiple certificates can be entered, separated by comma singleLogoutServiceUrl: type: string description: The URL that must be used to send logout requests singleSignOnServiceUrl: type: string description: The URL that must be used to send authentication requests useMetadataDescriptorUrl: type: boolean description: Whether to use a configured Metadata Descriptor URL to source the X509 certificates used to validate signatures validateSignature: type: boolean description: Enable/disable signature validation of IdP signatures default: false wantAssertionsEncrypted: type: boolean description: Whether to expect an encrypted assertion default: false wantAssertionsSigned: type: boolean description: Whether to expect a signed assertion default: false wantAuthnRequestsSigned: type: boolean description: Indicates whether the IdP expects a signed AuthnRequest default: true mapperAttrEmail: type: string description: Attribute name of the attribute to map to a user's email mapperFriendlyEmail: type: string description: Friendly name of the attribute to map to a user's email. One of friendly or attribute name is required mapperAttrFirstname: type: string description: Attribute name of the attribute to map to a user's first name. One of friendly or attribute name is required mapperFriendlyFirstname: type: string description: Friendly name of the attribute to map to a user's first name. One of friendly or attribute name is required mapperAttrLastname: type: string description: Attribute name of the attribute to map to a user's last name. One of friendly or attribute name is required mapperFriendlyLastname: type: string description: Friendly name of the attribute to map to a user's last name. One of friendly or attribute name is required mapperAttrPhone: type: string description: Attribute name of the attribute to map to a user's phone number. One of friendly or attribute name can be supplied mapperFriendlyPhone: type: string description: Friendly name of the attribute to map to a user's phone number. One of friendly or attribute name can be supplied mapperAttrCountry: type: string description: Attribute name of the attribute to map to a user's country. One of friendly or attribute name can be supplied mapperFriendlyCountry: type: string description: Friendly name of the attribute to map to a user's country. One of friendly or attribute name can be supplied caseInsensitiveMappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/case_insensitive_mapped_roles' defaultRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/default_roles' enforceMappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/enforce_mapped_roles' mappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/mapped_roles' mapperAttrConsumerId: type: string description: Attribute name of the attribute to map to the consumer organization ID(s). One of friendly or attribute name can be supplied mapperFriendlyConsumerId: type: string description: Friendly name of the attribute to map to the consumer organization ID(s). One of friendly or attribute name can be supplied consumerDefaultTeam: type: boolean description: Whether to add new users to the default team of the consumer organization consumerDefaultTeamRoles: type: array description: The roles to assign to new users in the default team of the consumer organization items: type: string consumerDefaultTeamPrivate: type: boolean description: Whether to make the default team of the consumer organization private when a new organization is created required: - name - nameIDPolicyFormat - singleSignOnServiceUrl - defaultRoles x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/idp/oidc: parameters: [] post: externalDocs: description: Managing Identity Providers url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/configuring_and_managing_identity_providers/index.html tags: - provider summary: Axway Create Consumer OIDC IdP description: "Configure a custom OIDC Identity Provider for a marketplace's consumer organizations\n\n___Auth Requirement___\n - _All of_\n - `administrator` access to the provider's organization.\n - The organization entitlements allow `idp`.\n" operationId: provider_idpCreateOIDC x-publishes: - marketplace.idp.create responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: type: object required: - guid - name - protocol unevaluatedProperties: false allOf: - $ref: '#/components/schemas/DefaultFields' properties: _id: type: string description: Document ID of the Identity Provider. deprecated: true description: type: string description: Description of the Identity Provider. guid: type: string format: uuid description: '`guid` of the Identity Provider.' name: type: string description: Name of Identity Provider protocol: type: string description: Protocol the Identity Provider uses. enum: - oidc - saml provider_guid: type: string examples: ProviderIdpcreateoidc200Example: summary: Default provider_idpCreateOIDC 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} requestBody: content: '*/*': schema: properties: allowedClockSkew: type: integer description: Clock skew in seconds that is tolerated when validating identity provider tokens default: 0 authorizationUrl: type: string description: Authorization URL backchannelSupported: type: boolean description: Whether the IdP supports backchannel logout default: false clientAssertionAudience: type: string description: The audience to use for the client assertion. The default value is the Identity Provider's token endpoint URL clientAssertionSigningAlg: type: string description: 'Signature algorithm to create JWT assertion as client authentication. In the case of JWT signed with private key or JWT signed with client secret, it is required. If no algorithm is specified, the following algorithm is adapted: `RS256` is adapted in the case of JWT signed with private key, `HS256` is adapted in the case of JWT signed with client secret' enum: - algorithmNotSpecified - ES256 - ES384 - ES512 - HS256 - HS384 - HS512 - PS256 - PS384 - PS512 - RS256 - RS384 - RS512 default: algorithmNotSpecified clientAuthMethod: type: string description: The client authentication method. In case of JWT signed with private key, Axway's private key is used enum: - client_secret_post - client_secret_basic - client_secret_jwt - private_key_jwt clientId: type: string description: The client identifier registered within the IdP clientSecret: type: string description: The client secret registered within the IdP defaultScope: type: string description: The scopes to be sent when asking for authorization. It can be a space-separated list of scopes description: $ref: '#/components/schemas/IdentityProvider/properties/description' issuer: type: string description: The issuer identifier for the issuer of the response. If not provided, no validation will be performed. jwksUrl: type: string description: URL where identity provider keys in JWK format are stored jwtX509HeadersEnabled: type: boolean description: If enabled, the `x5t` (X.509 Certificate SHA-1 Thumbprint) header will be added to the JWT to reference the certificate used to sign it. Otherwise, the `kid` (Key ID) header will be used instead loginHint: type: boolean description: Whether to pass login_hint to the IdP default: true logoutUrl: type: string description: End session endpoint to use to logout user from the external IdP name: $ref: '#/components/schemas/IdentityProvider/properties/name' pkceEnabled: type: boolean description: Use PKCE (Proof of Key-code exchange) for Identity Provider Brokering pkceMethod: type: string description: PKCE Method to use enum: - plain - S256 publicKeySignatureVerifier: type: string description: The public key in PEM format that must be used to verify IdP signatures publicKeySignatureVerifierKeyId: type: string description: Explicit ID of the supplied validating public key sendClientIdOnLogout: type: boolean description: If the `client_id` parameter should be sent in logout requests sendIdTokenOnLogout: type: boolean description: If the `id_token_hint` parameter should be sent in logout requests tokenUrl: type: string description: Token URL useJwksUrl: type: boolean description: If enabled, then identity provider public keys will be downloaded from given JWKS URL validateSignature: type: boolean description: Enable/disable signature validation of IdP signatures default: false mapperAttrEmail: type: string description: Name of claim to search for in token for the user's email address mapperAttrFirstname: type: string description: Name of claim to search for in token for the user's first name mapperAttrLastname: type: string description: Name of claim to search for in token for the user's last name mapperAttrPhone: type: string description: Name of claim to search for in token for the user's phone number mapperAttrCountry: type: string description: Name of claim to search for in token for the user's country caseInsensitiveMappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/case_insensitive_mapped_roles' defaultRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/default_roles' enforceMappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/enforce_mapped_roles' mappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/mapped_roles' mapperAttrConsumerId: type: string description: Name of claim to search for in token for the consumer organization ID(s) consumerDefaultTeam: type: boolean description: Whether to add new users to the default team of the consumer organization consumerDefaultTeamRoles: type: array description: The roles to assign to new users in the default team of the consumer organization items: type: string consumerDefaultTeamPrivate: type: boolean description: Whether to make the default team of the consumer organization private when a new organization is created required: - authorizationUrl - clientAuthMethod - clientId - defaultScope - name - tokenUrl - mapperAttrEmail - mapperAttrFirstname - mapperAttrLastname - defaultRoles - mapperAttrConsumerId x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/idp: parameters: [] delete: summary: Axway Remove Consumer IdP description: "Removes a custom Identity Provider for a marketplace's consumer organizations\n\n___Auth Requirement___\n - _All of_\n - `administrator` access to the provider's organization.\n - The organization entitlements allow `idp`.\n" externalDocs: description: Managing Identity Providers url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/configuring_and_managing_identity_providers/index.html tags: - provider operationId: provider_idpRemove x-publishes: - marketplace.idp.remove responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' PROVIDER_REMOVE_ENABLED_IDP: value: success: false description: Identity Provider cannot be removed as Identity Provider Managed Consumers is enabled for the Marketplace. code: 400 FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} - in: query name: cleanup required: false schema: type: boolean description: Whether to cascade delete consumer organizations and users created by this Identity Provider. default: false example: true x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Axway Update Consumer IdP description: "Update a custom Identity Provider for a marketplace's consumer organizations\n\n___Auth Requirement___\n - _All of_\n - `administrator` access to the provider's organization.\n - The organization entitlements allow `idp`.\n" externalDocs: description: Managing Identity Providers url: https://docs.axway.com/bundle/platform-management/page/docs/management_guide/configuring_and_managing_identity_providers/index.html tags: - provider operationId: provider_idpUpdate x-publishes: - marketplace.idp.update responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: type: object required: - guid - name - protocol unevaluatedProperties: false allOf: - $ref: '#/components/schemas/DefaultFields' properties: _id: type: string description: Document ID of the Identity Provider. deprecated: true description: type: string description: Description of the Identity Provider. guid: type: string format: uuid description: '`guid` of the Identity Provider.' name: type: string description: Name of Identity Provider protocol: type: string description: Protocol the Identity Provider uses. enum: - oidc - saml provider_guid: type: string examples: ProviderIdpupdate200Example: summary: Default provider_idpUpdate 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: IDP_MIXED_MAPPERS: value: success: false description: Cannot configure mappers with the same value in both Friendly and Attribute Names. code: 400 FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} requestBody: content: '*/*': schema: properties: allowedClockSkew: type: integer description: Clock skew in seconds that is tolerated when validating identity provider tokens default: 0 attributeConsumingServiceIndex: type: integer description: Index of the Attribute Consuming Service profile to request during authentication default: 0 attributeConsumingServiceName: type: string description: Name of the Attribute Consuming Service profile to advertise in the SP metadata authorizationUrl: type: string description: Authorization URL backchannelSupported: type: boolean description: Whether the IdP supports backchannel logout caseInsensitiveMappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/case_insensitive_mapped_roles' clientAssertionAudience: type: string description: The audience to use for the client assertion. The default value is the Identity Provider's token endpoint URL clientAssertionSigningAlg: type: string description: 'Signature algorithm to create JWT assertion as client authentication. In the case of JWT signed with private key or JWT signed with client secret, it is required. If no algorithm is specified, the following algorithm is adapted: `RS256` is adapted in the case of JWT signed with private key, `HS256` is adapted in the case of JWT signed with client secret' enum: - algorithmNotSpecified - ES256 - ES384 - ES512 - HS256 - HS384 - HS512 - PS256 - PS384 - PS512 - RS256 - RS384 - RS512 default: algorithmNotSpecified clientAuthMethod: type: string description: The client authentication method. In case of JWT signed with private key, Axway's private key is used enum: - client_secret_post - client_secret_basic - client_secret_jwt - private_key_jwt clientId: type: string description: The client identifier registered within the IdP clientSecret: type: string description: The client secret registered within the IdP defaultRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/default_roles' defaultScope: type: string description: The scopes to be sent when asking for authorization. It can be a space-separated list of scopes description: type: string description: Description of Identity Provider encryptionAlgorithm: type: string description: Encryption algorithm which is used by the SAML Identity Provider for encryption of SAML documents, assertions or IDs. The corresponding decryption key for decrypt SAML document parts will be chosen based on this configured algorithm and is provided by Axway for the encryption (ENC) usage. If algorithm is not configured, then any supported algorithm is allowed and decryption key will be chosen based on the algorithm configured in SAML document itself. enum: - RSA-OAEP enforceMappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/enforce_mapped_roles' entityId: type: string description: The Entity ID that will be used to uniquely identify this SAML Service Provider forceAuthn: type: boolean description: Whether the IdP must authenticate the presenter directly rather than rely on a previous security context idpEntityId: type: string description: The Entity ID used to validate the Issuer for received SAML assertions. If empty, no Issuer validation is performed issuer: type: string description: The issuer identifier for the issuer of the response. If not provided, no validation will be performed. jwksUrl: type: string description: URL where identity provider keys in JWK format are stored jwtX509HeadersEnabled: type: boolean description: If enabled, the `x5t` (X.509 Certificate SHA-1 Thumbprint) header will be added to the JWT to reference the certificate used to sign it. Otherwise, the `kid` (Key ID) header will be used instead loginHint: type: boolean description: Whether to pass login_hint to the IdP default: true logoutUrl: type: string description: End session endpoint to use to logout user from the external IdP mappedRoles: $ref: '#/components/schemas/IdentityProvider/properties/orgs/items/properties/mapped_roles' mapperAttrCountry: type: string description: Attribute to map to a user's country mapperAttrEmail: type: string description: Attribute to map to a user's email mapperAttrFirstname: type: string description: Attribute to map to a user's first name mapperAttrLastname: type: string description: Attribute to map to a user's last name mapperAttrPhone: type: string description: Attribute to map to a user's phone number mapperFriendlyCountry: type: string description: Friendly name of the attribute to map to a user's country mapperFriendlyEmail: type: string description: Friendly name of the attribute to map to a user's email mapperFriendlyFirstname: type: string description: Friendly name of the attribute to map to a user's first name mapperFriendlyLastname: type: string description: Friendly name of the attribute to map to a user's last name mapperFriendlyPhone: type: string description: Friendly name of the attribute to map to a user's phone number metadataDescriptorUrl: type: string description: External URL where the Identity Provider publishes the SAML Descriptor metadata information to source the X509 certificates used to validate signatures name: type: string description: Name of Identity Provider nameIDPolicyFormat: type: string description: Specifies the URI reference corresponding to a name identifier format enum: - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent - urn:oasis:names:tc:SAML:2.0:nameid-format:transient - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress - urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos - urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName - urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified pkceEnabled: type: boolean description: Use PKCE (Proof of Key-code exchange) for Identity Provider Brokering pkceMethod: type: string description: PKCE Method to use enum: - plain - S256 postBindingAuthnRequest: type: boolean description: Indicates whether the AuthnRequest must be sent using HTTP-POST binding postBindingLogout: type: boolean description: Indicates whether to respond to requests using HTTP-POST binding postBindingResponse: type: boolean description: Indicates whether to respond to requests using HTTP-POST binding providerId: type: string description: The protocol of the IdP enum: - oidc - saml publicKeySignatureVerifier: type: string description: The public key in PEM format that must be used to verify IdP signatures publicKeySignatureVerifierKeyId: type: string description: Explicit ID of the supplied validating public key sendClientIdOnLogout: type: boolean description: If the `client_id` parameter should be sent in logout requests sendIdTokenOnLogout: type: boolean description: If the `id_token_hint` parameter should be sent in logout requests signatureAlgorithm: type: string description: The signature algorithm to use to sign documents enum: - RSA_SHA256 - RSA_SHA256_MGF1 - RSA_SHA512 - RSA_SHA512_MGF1 signingCertificate: type: string description: The certificate in PEM format that must be used to check for signatures. Multiple certificates can be entered, separated by comma signSpMetadata: type: boolean description: Enable/disable signature of the provider SAML metadata singleLogoutServiceUrl: type: string description: The Url that must be used to send logout requests singleSignOnServiceUrl: type: string description: The Url that must be used to send authentication requests tokenUrl: type: string description: Token URL useJwksUrl: type: boolean description: If enabled, then identity provider public keys will be downloaded from given JWKS URL useMetadataDescriptorUrl: type: boolean description: Whether to use a configured Metadata Descriptor URL to source the X509 certificates used to validate signatures validateSignature: type: boolean description: Enable/disable signature validation of IdP signatures wantAssertionsEncrypted: type: boolean description: Whether to expect an encrypted assertion wantAssertionsSigned: type: boolean description: Whether to expect a signed assertion wantAuthnRequestsSigned: type: boolean description: Indicates whether the IdP expects a signed AuthnRequest xmlSigKeyInfoKeyNameTransformer: type: string description: Signing key to use in KeyName element enum: - NONE - KEY_ID - CERT_SUBJECT consumerDefaultTeam: type: boolean description: Whether to add new users to the default team of the consumer organization consumerDefaultTeamPrivate: type: boolean description: Whether to make the default team of the consumer organization private when a new organization is created consumerDefaultTeamRoles: type: array description: The roles to assign to new users in the default team of the consumer organization items: type: string mapperAttrConsumerId: type: string description: Attribute to map to the consumer organization ID(s) mapperFriendlyConsumerId: type: string description: Friendly name of the attribute to map to the consumer organization ID(s) required: - providerId x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/consumer/{org_id}: parameters: [] put: summary: Axway Update Consumer Organization description: "Update a consumer organization.\n\n___Auth Requirement___\n - `administrator` access to the provider's organization.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_consumerUpdate x-publishes: - platform.org.update - event: platform.org.active text: Sent if the org is activated or approved. - event: platform.org.inactive text: Sent if the org is deactivated or denied. - event: marketplace.consumer.active text: Sent if the org is activated or approved. - event: marketplace.consumer.inactive text: Sent if the org is deactivated or denied. - event: marketplace.consumer.approve text: Sent if the org is approved. - event: marketplace.consumer.deny text: Sent if the org is denied. responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - in: path name: org_id required: true schema: type: string description: '`guid` or `org_id` of the organization to update' example: 507f1f77bcf86cd799439011 - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} requestBody: content: '*/*': schema: properties: active: $ref: '#/components/schemas/Consumer/properties/active' consumer_id: $ref: '#/components/schemas/Org/properties/consumer_id' name: $ref: '#/components/schemas/Consumer/properties/name' onboarding: $ref: '#/components/schemas/Consumer/properties/onboarding' pending: $ref: '#/components/schemas/Consumer/properties/pending' x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/consumer/{consumer_id}: parameters: [] get: summary: Axway Find Consumer Organization description: "Find a consumer organization for a given provider marketplace.\n\n___Auth Requirement___\n - `administrator`, `auditor`, `developer`, or `api_central_admin` access to the provider's organization.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_consumerFindOne responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: $ref: '#/components/schemas/Consumer' examples: ProviderConsumerfindone200Example: summary: Default provider_consumerFindOne 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: consumer_id required: true schema: type: string description: '`guid` or `org_id` of the consumer org' example: 507f1f77bcf86cd799439011 - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} - in: query name: admin required: false schema: type: boolean description: Opt-in to include the consumer org's initial administrator user, if defined. Requires `administrator` access to the marketplace. default: false example: true - in: query name: onboarding required: false schema: type: boolean description: Opt-in to include the consumer org's onboarding data, if defined. Requires `administrator` access to the marketplace. default: false example: true - in: query name: teams required: false schema: type: boolean description: Opt-in to include array of consumer org team guid and name values. default: false example: true x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Axway Delete a Consumer Organization description: "Deletes a consumer organization and its related data from the platform. This is a destructive and irreversible delete.\n\n___Auth Requirement___\n - `administrator` access to the provider's organization.\n" tags: - provider operationId: provider_consumerRemove x-publishes: - platform.org.delete - marketplace.consumer.remove responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - in: path name: consumer_id required: true schema: type: string description: '`guid` or `org_id` of the consumer org' example: 507f1f77bcf86cd799439011 - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/consumer: parameters: [] post: summary: Axway Create Consumer Organization description: "Creates a consumer organization.\n\n___Auth Requirement___\n - `administrator` access to the provider's organization.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_consumerCreate x-publishes: - platform.org.create - event: platform.activation.send text: Sent if the admin user is not already activated. responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: type: object required: - active - guid - name - org_id - region - subscriptions - users unevaluatedProperties: false allOf: - $ref: '#/components/schemas/DefaultFields' properties: _id: type: string description: The id of the organization. readOnly: true deprecated: true account_id: type: integer description: Account ID of the organization. minimum: 10000 maximum: 999999 active: type: boolean description: Active state of the organization. Organizations become inactive after passing their end date. default: true analytics: type: object description: Analytics details for the organization additionalProperties: false properties: token: type: string description: Token used to identify the organization. api_central: type: object description: Engage provision status readOnly: true branding: type: object description: Organization branding. additionalProperties: false properties: logo: type: string description: Logo image of the company. consumer_id: type: string description: Mapped ID of the consumer org from the configured Identity Provider. created_by: type: object description: Details of the user that created the organization. unevaluatedProperties: false properties: client_id: type: string description: The client_id of the client that created the organization. readOnly: true email: type: string format: email description: Email address of the user that created the organization. readOnly: true name: type: string description: The name of the user or client that created the organization. readOnly: true entitlements: type: object readOnly: true allOf: - $ref: '#/components/schemas/Entitlements' guid: type: string format: uuid description: GUID identifier for the organization help_menu: type: object description: Contents of the help menu displayed in the navigation bar. default: enabled: false additionalProperties: false properties: enabled: type: boolean description: Whether the custom help menu is enabled. default: false defaults: type: boolean description: Whether to include the default items. icon: type: string description: Icon displayed in the navigation bar to show the help menu. items: type: array description: Custom help menu shown in the navigation bar. items: type: object required: - text - type - url unevaluatedProperties: false discriminator: propertyName: type mapping: url: '#/components/schemas/Org/properties/help_menu/properties/items/items/oneOf/0' document: '#/components/schemas/Org/properties/help_menu/properties/items/items/oneOf/1' oneOf: - type: object properties: type: type: string enum: - url url: type: string format: url description: URL for the link. - type: object properties: type: type: string enum: - document url: type: string description: Document resource guid properties: icon: type: string description: Icon displayed in the menu for the item. new_tab: type: boolean description: Whether the link opens in a new tab. provider_guid: type: string description: The GUID of the provider a document url is for 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. last_login: type: string format: date-time description: When the most recent session was created in the organization. readOnly: true logged_in_count: type: number description: How many session are been created in the organization. readOnly: true name: type: string description: Name of the organization. minLength: 2 maxLength: 64 x-no-tags: true onboarding_required: type: array readOnly: true items: type: string pattern: '[\w-]{21}' org_id: type: integer description: Identifier for the organization origin: type: - string - 'null' description: Source from which the organization creation originated. enum: - '360' - sfdc - signup pending: type: boolean description: Whether the organization is pending approval for a provider organization administator. provider_guid: type: string format: uuid description: GUID identifier of the owning provider if the organization is a consumer of a marketplace. region: type: string description: The data residency region of the organization. default: US enum: - US - EU - AP security: type: object description: Security settings for the organization. additionalProperties: false properties: access_controls: type: object description: Developer visibility controls. additionalProperties: false properties: enviroments: type: number description: Developer access to environments. 0 - Developers cannot view environments, 1 - Developer may view all environemnts. enum: - 0 - 1 service_accounts: type: number description: Developer access to service accounts. 0 - Developers cannot view service accounts, 1 - Developers may view service accounts in their teams, 2 - Developer may view all service accounts. enum: - 0 - 1 - 2 usage: type: number description: Developer access to usage. 0 - Developers cannot view usage, 1 - Developer may view all usage. enum: - 0 - 1 users: type: number description: Developer access to users.0 - Developers cannot view users, 1 - Developers may view administrators and users in their teams, 2 - Developer may view all users. enum: - 0 - 1 - 2 allow_tooling: type: boolean description: Grant access using tooling credentials disable_analytics: type: boolean description: Opt out from third-party support services. password_policy: $ref: '#/components/schemas/PasswordPolicy' redact_personal: type: boolean description: Personal information like email addresses will be masked in UI. default: false subscriptions: type: array default: [] items: $ref: '#/components/schemas/Subscription' support_access_code: type: integer description: Support Access Code for the org. minimum: 10000 maximum: 999999 users: type: array description: List of users that are members of the organization. default: [] items: type: object required: - guid - roles additionalProperties: false properties: guid: type: string format: uuid description: GUID of the user. idp: type: string description: GUID of the Identity Provider the user is required to authenticate with to access the organization. primary: type: boolean description: Whether the user is the primary contact for the organization. roles: type: array description: Roles within the organization. items: type: string enum: - administrator - developer - auditor - consumer - usage_reporter - api_central_admin examples: ProviderConsumercreate200Example: summary: Default provider_consumerCreate 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: EXISTING_ORG_NAME: value: success: false description: Organization names must be unique. Please enter a different organization name. code: 400 FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' INVALID_EMAIL_DOMAIN: value: success: false description: Sign-up is not allowed for this email domain. code: 400 internalCode: 14 NEW_USER_SIGNUP: value: success: false description: You must be a new user to sign up. code: 400 PROVIDER_CONSUMER_DISABLED: value: success: false description: Consumer organization access is disabled. code: 400 internalCode: 431 NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} requestBody: content: '*/*': schema: properties: admin: type: string description: Email address of the person who will be the initial org administrator. consumer_id: $ref: '#/components/schemas/Org/properties/consumer_id' name: $ref: '#/components/schemas/Org/properties/name' onboarding: $ref: '#/components/schemas/Org/properties/onboarding' required: - name x-microcks-operation: delay: 0 dispatcher: FALLBACK get: summary: Axway Find Consumer Organizations description: "Find consumer organizations for a given provider marketplace.\n\n___Auth Requirement___\n - `administrator`, `auditor`, `developer`, or `api_central_admin` access to the provider's organization.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_consumerFind responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: title: ConsumerList type: array description: A list of Consumer objects. items: type: object properties: active: $ref: '#/components/schemas/Org/properties/active' consumer_id: $ref: '#/components/schemas/Org/properties/consumer_id' guid: $ref: '#/components/schemas/Org/properties/guid' name: $ref: '#/components/schemas/Org/properties/name' org_id: $ref: '#/components/schemas/Org/properties/org_id' pending: $ref: '#/components/schemas/Org/properties/pending' users: type: integer description: Count of users in the consumer org. teams: oneOf: - type: integer description: Count of teams in the consumer org. - type: object description: Metadata of the teams in the consumer org. properties: guid: $ref: '#/components/schemas/Team/properties/guid' name: $ref: '#/components/schemas/Team/properties/name' users: type: integer description: Count of users in the team. users_created: type: integer description: Count of users in the team created after provided date. users_last_login: type: integer description: Count of users in the team who last signed in after provided date. users_created: type: integer description: Count of users in the consumer org created after provided date. users_last_login: type: integer description: Count of users in the consumer org who last signed in after provided date. - properties: metadata: type: object description: Result metadata. properties: count: type: number description: Number of organizations included in the response. matched: type: number description: Total number of organizations matching the query. query: type: object description: The organization query. examples: ProviderConsumerfind200Example: summary: Default provider_consumerFind 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} - in: query name: created_from required: false schema: type: number description: Timestamp to return count of users created after. example: 1.0 - in: query name: created_to required: false schema: type: number description: Timestamp to return count of users created before. example: 1.0 - in: query name: last_login_from required: false schema: type: number description: Timestamp to return count of users that have signed in after. example: 1.0 - in: query name: last_login_to required: false schema: type: number description: Timestamp to return count of users that have signed in before. example: 1.0 - in: query name: name required: false schema: type: string description: Find consumer organizations matching full or partial name (minimum of 3 characters). example: Example Name - in: query name: teams required: false schema: type: boolean description: Opt-in to include array of consumer org team guid and name values. default: false example: true x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}/activity: parameters: [] get: summary: Axway Get Marketplace Activity description: "Returns all of the activity events for the marketplace and any associated consumer organizations\n\n___Auth Requirement___\n - `administrator` access to the provider's organization.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_activity responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: metadata: type: object description: Result metadata. properties: contexts: type: string description: Type of events included in the response. query: type: object description: Activity query. Included when debug is true. - properties: metadata: $ref: '#/components/schemas/ResponseMetadata' examples: ProviderActivity200Example: summary: Default provider_activity 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: type: string description: guid of the provider marketplace example: 507f1f77bcf86cd799439011 - in: query name: consumer_id required: false schema: type: number description: org_id of consumer organization to fetch activity for. example: 1.0 - in: query name: contexts required: false schema: type: array description: Type of events to return. items: type: string example: - example_value - in: query name: data required: false schema: type: boolean description: Return event and data properties for events example: true - in: query name: enrich required: false schema: type: boolean description: Whether to replace identifiers with user names in event messages. example: true - in: query name: exclude_contexts required: false schema: type: array description: Type of events to exclude. items: type: string example: - example_value - in: query name: from required: false schema: type: number description: Starting timestamp to get data for. example: 1.0 - in: query name: redact required: false schema: type: boolean description: Whether to apply redaction of email addresses per the org's setting, example: true - in: query name: sort required: false schema: type: number description: 'Sort direction: `1` - ascending, `-1` - descending.' enum: - -1 - 1 default: -1 example: -1 - in: query name: term required: false schema: type: string description: Prefix or exact search term example: example_value - in: query name: to required: false schema: type: number description: Ending timestamp to get data for. example: 1.0 - in: query name: limit required: false schema: type: number minimum: 0 maximum: 100 description: Number of results per page. Zero will return an empty result, but the matched count in meta will be returned. default: 25 example: 1.0 - in: query name: page required: false schema: type: number description: Page of results. default: 1 example: 1.0 - in: query name: skip required: false schema: type: number description: Number of items to skip in results, used for pagination. default: 0 example: 1.0 x-microcks-operation: delay: 0 dispatcher: FALLBACK /provider/{provider_id}: parameters: [] get: summary: Axway Get Provider Marketplace description: "Returns a provider marketplace\n\n___Auth Requirement___\n - _One of_\n - Auth token.\n - Access to the provider's organization.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_findOne responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: type: object properties: _id: type: string description: Document ID of the provider. readOnly: true deprecated: true 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 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. 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. 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. 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 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 certificate: type: string description: Encrypted certificate writeOnly: true certificate_expires: type: string format: date-time description: Expiry date of certificate provided for marketplace domain. 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 consumer: type: boolean description: Whether to allow authenticated consumer org user access to the marketplace. default: false consumer_approve: type: boolean description: Whether to Require newly registered consumer organizations in the marketplace to require approval from an organization administrator. default: false 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' 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' guid: type: string description: Identifier of the provider marketplace instance. 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' help_menu_icon: type: string description: Icon displayed in the navigation bar to show the help menu. 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 - right bottom - center top - center center - center bottom image_size: type: string description: Background image size for the content. enum: - auto - cover - contain - 100% 100% url: type: string description: Background image URL for the content. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' content: type: array description: Content items. items: type: object unevaluatedProperties: false discriminator: propertyName: type mapping: button: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/1' image: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/2' search: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/3' text: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/4' oneOf: - type: object title: Button required: - url unevaluatedProperties: false discriminator: propertyName: url_type mapping: url: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/1' oneOf: - title: URL properties: url: type: string description: URL or relative path for the link. anyOf: - type: string title: URL pattern: (^((https?:\/\/[A-Za-z0-9.-]+|(?:www\.|[-;:&=+$,\w]+@)[A-Za-z0-9.-]+)((?:\/[+~%/.\w\-_]*)?\??(?:[-+=&;%@.\w_]*)#?(?:[\w?/:@\-._~!$&'()*+,;=]*))?)$|^(?:\/[+~%/.\w\-_]*)(?:\?[-+=&;%@.\w_]*)?(?:#[.!/\\\w]*)?$) - type: string title: Signin enum: - signin url_type: type: string enum: - url - title: Document properties: url: type: string description: Document resource guid url_type: type: string enum: - document properties: background: type: string format: color description: Button background color. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Button text color. format: type: string description: Button background fill or outline. enum: - solid - outline target: type: - 'null' - string default: null enum: - null - _blank text: type: object description: Button text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' type: type: string enum: - button url_type: type: string description: Link type for the button URL. enum: - url - document - type: object title: Document required: - id unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' id: type: string description: Published document resource identifier. type: type: string enum: - document - type: object title: Image required: - url unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' text: type: object description: Image alt text. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' type: type: string enum: - image url: type: string description: Image source URL. - type: object title: Search unevaluatedProperties: false properties: scope: type: string enum: - products - documents - resources - all text: type: object description: Placeholder text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' - type: object title: Text unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Text color. padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' text: type: object description: Text content, using markdown formatting. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' type: type: string enum: - text properties: align: type: string description: Content alignment. default: left enum: - left - center - right margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string enum: - button - document - image - search - text type: type: string enum: - content - type: object additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - nav - type: object additionalProperties: false discriminator: propertyName: filter mapping: top: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' published: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' tags: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/1' oneOf: - type: object properties: filter: type: string enum: - top - published - type: object properties: filter: type: string enum: - tags tags: type: array description: The tags determining which products to show when `filter` is set to `"tags".` minItems: 1 items: type: string properties: count: type: number maximum: 12 filter: type: string description: Displayed products setting for the provider marketplace featured products section. enum: - tags - top - published sort: type: string description: Sorting setting for the provider marketplace featured products section. enum: - alpha - recent - highest_rating - most_reviews title: type: object description: Title for the products. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' type: type: string enum: - products - type: object required: - border additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - separator properties: margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string visibility: type: number description: 'Item visibility. Always shown: 0, Signed in: 1, Signed out: 2' enum: - 0 - 1 - 2 width: type: number description: 'Item width. Full width: 0, Full width aligned to grid: 5, Column width: 1 - 4.' enum: - 0 - 1 - 2 - 3 - 4 - 5 idp: type: boolean description: Whether to allow consumer organizations in the marketplace to establish custom Identity Providers. default: false idp_hint: type: - string - 'null' description: Identity Provider `guid` to use for sign in attempts originating from the marketplace. Cannot be set at the same time as `consumer`. lang: type: object description: Internationalization settings for the provider marketplace. default: default: en-US supported: - en-US products: all properties: default: type: string description: Default language to use for users of the marketplace. default: en-US enum: - en-US - fr-FR - de-DE - pt-BR products: type: string description: Behavior for display of products in the marketplace based on translation state. default: all enum: - all - translated supported: type: array description: Languages supported by the marketplace. default: - en-US items: type: string enum: - en-US - fr-FR - de-DE - pt-BR name: type: object description: Name of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' name_gender: description: Gender of the `name` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' nav_items: type: object description: Links added in the common navigation menu. default: {} properties: en-US: type: array description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' fr-FR: type: array description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' de-DE: type: array description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' pt-BR: type: array description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' oauth: type: object description: OAuth 2.0 client settings for the provider marketplace's consumer users. default: enabled: false properties: github: type: object description: Settings for the provider marketplace's GitHub OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitHub" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered application within GitHub. client_secret: type: string description: Client secret for the registered application within GitHub. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. gitlab: type: object description: Settings for the provider marketplace's GitLab OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitLab" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Application ID of the registered application within GitLab. client_secret: type: string description: Application Secret for the registered application within GitLab. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. google: type: object description: Settings for the provider marketplace's Google OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with Google" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered OAuth 2.0 Credentials within Google. client_secret: type: string description: Client secret for the registered OAuth 2.0 Credentials within Google. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. onboarding: type: object description: Onboarding data capture settings for the provider marketplace. default: enabled: false items: [] properties: enabled: type: boolean description: Whether onboarding data capture feature is enabled for the provider marketplace. items: type: array description: Onboarding fields to capture for consumer orgs of the provider marketplace. minItems: 1 maxItems: 50 items: type: object discriminator: propertyName: type mapping: header: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/0' text: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/1' number: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' date: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' checkbox: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' toggle: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/3' select: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' multiselect: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' oneOf: - type: object required: - id - type - text properties: id: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/id' text: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/text' type: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/type' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: maxlen: type: number description: Maximum value length for the element. placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: 'off': type: object description: Label for disabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' 'on': type: object description: Label for enabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: options: type: array minItems: 2 maxItems: 1000 items: type: object required: - text - value properties: text: type: object description: Label for value. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' value: type: string placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' org_guid: type: string format: uuid description: '`guid` of the organization the provider marketplace belongs to.' provider_idp: type: object default: enabled: false properties: enabled: type: boolean default: false allow_external: type: boolean default: false enforce_association: type: boolean default: false public: type: boolean description: Whether the provider marketplace allows access to unauthenticated users or users authenticated to orgs other than the provider org. default: false reviews: type: object description: Ratings & Reviews settings for the provider marketplace. default: enabled: false properties: enabled: type: boolean description: Whether Ratings & Reviews are enabled for the provider marketplace. char_limit: type: number description: Character limit for written feedback for products or services in the provider marketplace. enum: - 280 - 1000 - 4000 flagged_handling: type: string description: How reported review content is handled within the provider marketplace enum: - hide - show instructions: type: object description: Review guidelines and policies within the provider marketplace. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' moderation_process: type: string description: Which type of moderation process is to be used for reviews in the provider marketplace enum: - manual - automatic permissions: type: string description: Who is allowed to provide feedback for products or services in the provider marketplace. enum: - subscribers - all public_responses: type: boolean description: Whether to enable public responses to reviews in the provider marketplace. response_time: type: number description: Expected response time for feedback in the provider marketplace, in `response_time_unit`. minimum: 1 response_time_unit: type: string description: Unit of time that `response_time` correlates to. search_engines: type: object default: indexing_enabled: true additionalProperties: false properties: google_site_verification_id: type: string description: Site Verification ID for Google Search Console integration. minLength: 1 indexing_enabled: type: boolean description: Whether indexing by search engines is enabled for the marketplace. default: true signup: type: boolean description: Whether to allow self-service sign up for consumer organizations in the marketplace. default: false sitename: type: object description: Page title of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' sitename_gender: description: Gender of the `sitename` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' subdomain: type: string description: Subdomain on which the provider marketplace can be accessed. pattern: ^[a-z0-9\-]{4,63}$ terms: type: boolean description: Whether the provider marketplace access should be gated on acceptance of Terms & Conditions. default: false terms_updated: type: string format: date-time description: Date Terms & Conditions last updated. terms_url: type: string format: url description: URL of the provider marketplace Terms & Conditions. url: type: string description: Fully qualified domain name on which the provider marketplace can be accessed. pattern: ^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$ versions: type: object description: Product version settings for the provider marketplace. default: custom: false display: all properties: custom: type: boolean description: Whether custom product versions are displayed in the provider marketplace. default: false display: type: string description: What product version types will be displayed in the provider marketplace. default: all enum: - all - latest base_url: type: string description: URL on which the provider marketplace can be accessed. format: url can_edit: type: boolean description: 'Indicates whether the user making the call can edit the provider marketplace. ' org_id: type: number description: The org_id of the organization the provider marketplace belongs to. org_name: type: number description: The name of the organization the provider marketplace belongs to. examples: ProviderFindone200Example: summary: Default provider_findOne 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - AuthToken: [] - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - name: exclude_fields in: query description: A list of fields to exclude from the response. schema: type: array items: type: string default: can_edit,org_id,org_name example: - example_value - $ref: '#/components/parameters/add_fields' example: example_value - in: path name: provider_id required: true schema: type: string description: guid of the provider marketplace example: 507f1f77bcf86cd799439011 - in: header name: x-auth-token required: false schema: type: string description: Token to authorize the request. example: eyJhbGciOiJIUzI1NiJ9.example x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: Axway Delete Provider Marketplace description: "Deletes a provider marketplace and all associated consumer org and user data\n\n___Auth Requirement___\n - `administrator` access to the provider's organization.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_remove x-publishes: - marketplace.remove - platform.org.delete - platform.user.remove responses: '204': description: No Content '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: PROVIDER_PRODUCT_REMOVE: value: success: false description: Marketplace cannot be removed as it has published products. code: 400 FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' '405': description: Method Not Allowed content: application/json: schema: $ref: '#/components/schemas/Error' examples: NOT_ENABLED: value: success: false description: The requested action is not enabled. code: 405 security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - in: path name: provider_id required: true schema: type: string description: guid of the provider marketplace example: 507f1f77bcf86cd799439011 x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: Axway Update Provider Marketplace description: "Updates a provider marketplace.\n\n___Auth Requirement___\n - `administrator` access to the provider's organization.\n" externalDocs: description: Managing Marketplaces url: https://docs.axway.com/bundle/amplify-central/page/docs/manage_marketplace/customize_marketplace/index.html tags: - provider operationId: provider_update x-publishes: - marketplace.ai.disable - marketplace.ai.enable - marketplace.ai.update - marketplace.appearance.update - marketplace.billing.disable - marketplace.billing.enable - marketplace.billing.update - marketplace.lang.update - marketplace.settings.update - event: marketplace.publisheddocumentresource.add text: When published document resources are selected for use in Marketplace settings - event: marketplace.publisheddocumentresource.remove text: When published document resources are removed from use in Marketplace settings responses: '200': description: Response content: application/json: schema: allOf: - $ref: '#/components/schemas/Response' - properties: result: 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 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 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. 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. 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_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. 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 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_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_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 certificate_expires: type: string format: date-time description: Expiry date of certificate provided for marketplace domain. 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 consumer: type: boolean description: Whether to allow authenticated consumer org user access to the marketplace. default: false consumer_approve: type: boolean description: Whether to Require newly registered consumer organizations in the marketplace to require approval from an organization administrator. default: false 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' 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' guid: type: string description: Identifier of the provider marketplace instance. 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' help_menu_icon: type: string description: Icon displayed in the navigation bar to show the help menu. 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 - right bottom - center top - center center - center bottom image_size: type: string description: Background image size for the content. enum: - auto - cover - contain - 100% 100% url: type: string description: Background image URL for the content. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' content: type: array description: Content items. items: type: object unevaluatedProperties: false discriminator: propertyName: type mapping: button: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/1' image: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/2' search: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/3' text: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/4' oneOf: - type: object title: Button required: - url unevaluatedProperties: false discriminator: propertyName: url_type mapping: url: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/1' oneOf: - title: URL properties: url: type: string description: URL or relative path for the link. anyOf: - type: string title: URL pattern: (^((https?:\/\/[A-Za-z0-9.-]+|(?:www\.|[-;:&=+$,\w]+@)[A-Za-z0-9.-]+)((?:\/[+~%/.\w\-_]*)?\??(?:[-+=&;%@.\w_]*)#?(?:[\w?/:@\-._~!$&'()*+,;=]*))?)$|^(?:\/[+~%/.\w\-_]*)(?:\?[-+=&;%@.\w_]*)?(?:#[.!/\\\w]*)?$) - type: string title: Signin enum: - signin url_type: type: string enum: - url - title: Document properties: url: type: string description: Document resource guid url_type: type: string enum: - document properties: background: type: string format: color description: Button background color. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Button text color. format: type: string description: Button background fill or outline. enum: - solid - outline target: type: - 'null' - string default: null enum: - null - _blank text: type: object description: Button text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' type: type: string enum: - button url_type: type: string description: Link type for the button URL. enum: - url - document - type: object title: Document required: - id unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' id: type: string description: Published document resource identifier. type: type: string enum: - document - type: object title: Image required: - url unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' text: type: object description: Image alt text. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' type: type: string enum: - image url: type: string description: Image source URL. - type: object title: Search unevaluatedProperties: false properties: scope: type: string enum: - products - documents - resources - all text: type: object description: Placeholder text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' - type: object title: Text unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Text color. padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' text: type: object description: Text content, using markdown formatting. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' type: type: string enum: - text properties: align: type: string description: Content alignment. default: left enum: - left - center - right margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string enum: - button - document - image - search - text type: type: string enum: - content - type: object additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - nav - type: object additionalProperties: false discriminator: propertyName: filter mapping: top: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' published: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' tags: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/1' oneOf: - type: object properties: filter: type: string enum: - top - published - type: object properties: filter: type: string enum: - tags tags: type: array description: The tags determining which products to show when `filter` is set to `"tags".` minItems: 1 items: type: string properties: count: type: number maximum: 12 filter: type: string description: Displayed products setting for the provider marketplace featured products section. enum: - tags - top - published sort: type: string description: Sorting setting for the provider marketplace featured products section. enum: - alpha - recent - highest_rating - most_reviews title: type: object description: Title for the products. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' type: type: string enum: - products - type: object required: - border additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - separator properties: margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string visibility: type: number description: 'Item visibility. Always shown: 0, Signed in: 1, Signed out: 2' enum: - 0 - 1 - 2 width: type: number description: 'Item width. Full width: 0, Full width aligned to grid: 5, Column width: 1 - 4.' enum: - 0 - 1 - 2 - 3 - 4 - 5 idp: type: boolean description: Whether to allow consumer organizations in the marketplace to establish custom Identity Providers. default: false idp_hint: type: - string - 'null' description: Identity Provider `guid` to use for sign in attempts originating from the marketplace. Cannot be set at the same time as `consumer`. lang: type: object description: Internationalization settings for the provider marketplace. default: default: en-US supported: - en-US products: all properties: default: type: string description: Default language to use for users of the marketplace. default: en-US enum: - en-US - fr-FR - de-DE - pt-BR products: type: string description: Behavior for display of products in the marketplace based on translation state. default: all enum: - all - translated supported: type: array description: Languages supported by the marketplace. default: - en-US items: type: string enum: - en-US - fr-FR - de-DE - pt-BR name: type: object description: Name of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' name_gender: description: Gender of the `name` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' nav_items: type: object description: Links added in the common navigation menu. default: {} properties: en-US: type: array description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' fr-FR: type: array description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' de-DE: type: array description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' pt-BR: type: array description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' oauth: type: object description: OAuth 2.0 client settings for the provider marketplace's consumer users. default: enabled: false properties: github: type: object description: Settings for the provider marketplace's GitHub OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitHub" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered application within GitHub. secret_updated: type: string format: date-time description: Date client_secret last updated. gitlab: type: object description: Settings for the provider marketplace's GitLab OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitLab" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Application ID of the registered application within GitLab. secret_updated: type: string format: date-time description: Date client_secret last updated. google: type: object description: Settings for the provider marketplace's Google OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with Google" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered OAuth 2.0 Credentials within Google. secret_updated: type: string format: date-time description: Date client_secret last updated. onboarding: type: object description: Onboarding data capture settings for the provider marketplace. default: enabled: false items: [] properties: enabled: type: boolean description: Whether onboarding data capture feature is enabled for the provider marketplace. items: type: array description: Onboarding fields to capture for consumer orgs of the provider marketplace. minItems: 1 maxItems: 50 items: type: object discriminator: propertyName: type mapping: header: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/0' text: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/1' number: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' date: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' checkbox: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' toggle: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/3' select: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' multiselect: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' oneOf: - type: object required: - id - type - text properties: id: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/id' text: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/text' type: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/type' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: maxlen: type: number description: Maximum value length for the element. placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: 'off': type: object description: Label for disabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' 'on': type: object description: Label for enabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: options: type: array minItems: 2 maxItems: 1000 items: type: object required: - text - value properties: text: type: object description: Label for value. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' value: type: string placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' org_guid: type: string format: uuid description: '`guid` of the organization the provider marketplace belongs to.' provider_idp: type: object default: enabled: false properties: enabled: type: boolean default: false allow_external: type: boolean default: false enforce_association: type: boolean default: false public: type: boolean description: Whether the provider marketplace allows access to unauthenticated users or users authenticated to orgs other than the provider org. default: false reviews: type: object description: Ratings & Reviews settings for the provider marketplace. default: enabled: false properties: enabled: type: boolean description: Whether Ratings & Reviews are enabled for the provider marketplace. char_limit: type: number description: Character limit for written feedback for products or services in the provider marketplace. enum: - 280 - 1000 - 4000 flagged_handling: type: string description: How reported review content is handled within the provider marketplace enum: - hide - show instructions: type: object description: Review guidelines and policies within the provider marketplace. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' moderation_process: type: string description: Which type of moderation process is to be used for reviews in the provider marketplace enum: - manual - automatic permissions: type: string description: Who is allowed to provide feedback for products or services in the provider marketplace. enum: - subscribers - all public_responses: type: boolean description: Whether to enable public responses to reviews in the provider marketplace. response_time: type: number description: Expected response time for feedback in the provider marketplace, in `response_time_unit`. minimum: 1 response_time_unit: type: string description: Unit of time that `response_time` correlates to. search_engines: type: object default: indexing_enabled: true additionalProperties: false properties: google_site_verification_id: type: string description: Site Verification ID for Google Search Console integration. minLength: 1 indexing_enabled: type: boolean description: Whether indexing by search engines is enabled for the marketplace. default: true signup: type: boolean description: Whether to allow self-service sign up for consumer organizations in the marketplace. default: false sitename: type: object description: Page title of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' sitename_gender: description: Gender of the `sitename` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' subdomain: type: string description: Subdomain on which the provider marketplace can be accessed. pattern: ^[a-z0-9\-]{4,63}$ terms: type: boolean description: Whether the provider marketplace access should be gated on acceptance of Terms & Conditions. default: false terms_updated: type: string format: date-time description: Date Terms & Conditions last updated. terms_url: type: string format: url description: URL of the provider marketplace Terms & Conditions. url: type: string description: Fully qualified domain name on which the provider marketplace can be accessed. pattern: ^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$ versions: type: object description: Product version settings for the provider marketplace. default: custom: false display: all properties: custom: type: boolean description: Whether custom product versions are displayed in the provider marketplace. default: false display: type: string description: What product version types will be displayed in the provider marketplace. default: all enum: - all - latest examples: ProviderUpdate200Example: summary: Default provider_update 200 response x-microcks-default: true value: example_value '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/Error' examples: MAX_FILE_SIZE: value: success: false description: The file exceeds the maximum upload size of %d bytes. code: 400 PROVIDER_NAME_UNIQUE: value: success: false description: The provided Marketplace name is already in use in the organization. code: 400 PROVIDER_SUBDOMAIN_UNIQUE: value: success: false description: The provided Marketplace subdomain is already in use. code: 400 PROVIDER_SUBDOMAIN_URL: value: success: false description: Marketplace Settings requires a valid subdomain or URL. code: 400 PROVIDER_URL_CNAME: value: success: false description: Marketplace URL does not have expected CNAME registered. code: 400 PROVIDER_CERT_DOMAIN: value: success: false description: The provided certificate does not match the Marketplace URL's domain. code: 400 PROVIDER_CERT_PRIVATE_KEY: value: success: false description: The provided certificate contains an invalid private key. code: 400 PROVIDER_CERT_EXPIRED: value: success: false description: The provided certificate is expired. code: 400 LINK_NOT_FOUND: value: success: false description: '"%s" contained an invalid value: Resource not found.' code: 400 internalCode: 747 FORBIDDEN: value: $ref: '#/components/examples/FORBIDDEN/value' NOT_FOUND: value: $ref: '#/components/examples/NOT_FOUND/value' USER_NOT_ADMIN: value: $ref: '#/components/examples/USER_NOT_ADMIN/value' LOGIN_REQUIRED: value: $ref: '#/components/examples/LOGIN_REQUIRED/value' PARAM_INVALID: value: $ref: '#/components/examples/PARAM_INVALID/value' PARAM_REQUIRED: value: $ref: '#/components/examples/PARAM_REQUIRED/value' security: - BearerClient: [] - SessionCookie: [] - BearerUser: [] parameters: - $ref: '#/components/parameters/fields' example: example_value - $ref: '#/components/parameters/exclude_fields' example: example_value - in: path name: provider_id required: true schema: $ref: '#/components/schemas/Provider/properties/guid' example: {} requestBody: content: multipart/form-data: schema: properties: admin_teams: $ref: '#/components/schemas/Provider/properties/admin_teams' ai: $ref: '#/components/schemas/Provider/properties/ai' appearance: $ref: '#/components/schemas/Provider/properties/appearance' billing: $ref: '#/components/schemas/Provider/properties/billing' certificate: type: string description: Certificate matching provider marketplace URL; accepts full CA chain files in PEM format. format: binary consume_teams: $ref: '#/components/schemas/Provider/properties/consume_teams' consumer: $ref: '#/components/schemas/Provider/properties/consumer' consumer_approve: $ref: '#/components/schemas/Provider/properties/consumer_approve' description: $ref: '#/components/schemas/Provider/properties/description' favicon: type: string description: Provider marketplace favicon file; accepts PNG or ICO only. format: binary footer: $ref: '#/components/schemas/Provider/properties/footer' help_menu: $ref: '#/components/schemas/Provider/properties/help_menu' help_menu_icon: $ref: '#/components/schemas/Provider/properties/help_menu_icon' homepage: $ref: '#/components/schemas/Provider/properties/homepage' idp: $ref: '#/components/schemas/Provider/properties/idp' idp_hint: $ref: '#/components/schemas/Provider/properties/idp_hint' lang: $ref: '#/components/schemas/Provider/properties/lang' logo: type: string description: Provider marketplace logo file; accepts PNG, JPEG, or GIF only. format: binary name: $ref: '#/components/schemas/Provider/properties/name' name_gender: $ref: '#/components/schemas/Provider/properties/name_gender' nav_items: $ref: '#/components/schemas/Provider/properties/nav_items' oauth: $ref: '#/components/schemas/Provider/properties/oauth' onboarding: $ref: '#/components/schemas/Provider/properties/onboarding' org_guid: $ref: '#/components/schemas/Provider/properties/org_guid' public: $ref: '#/components/schemas/Provider/properties/public' publish_teams: $ref: '#/components/schemas/Provider/properties/publish_teams' reviews: $ref: '#/components/schemas/Provider/properties/reviews' search_engines: $ref: '#/components/schemas/Provider/properties/search_engines' signup: $ref: '#/components/schemas/Provider/properties/signup' sitename: $ref: '#/components/schemas/Provider/properties/sitename' sitename_gender: $ref: '#/components/schemas/Provider/properties/sitename_gender' subdomain: $ref: '#/components/schemas/Provider/properties/subdomain' terms: $ref: '#/components/schemas/Provider/properties/terms' terms_file: type: string description: Provider marketplace Terms & Conditions file; accepts PDF only. format: binary terms_updated: type: boolean description: Whether Terms & Conditions has been updated terms_url: $ref: '#/components/schemas/Provider/properties/terms_url' url: $ref: '#/components/schemas/Provider/properties/url' versions: $ref: '#/components/schemas/Provider/properties/versions' required: - org_guid x-microcks-operation: delay: 0 dispatcher: FALLBACK components: schemas: Provider: x-defs: onboarding.items.hint: type: string description: Contextual information for the element. onboarding.items.text: type: string description: Label for the element. onboarding.items.on: type: string description: Label for enabled toggle state. onboarding.items.placeholder: type: string description: Placeholder or example value for the element. sitename: type: string description: Page title of the provider marketplace instance. maxLength: 350 x-no-tags: true 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$ nav_items: type: array description: Links added in the common navigation menu. maxItems: 9 items: $ref: '#/components/schemas/Provider/x-defs/menu_item' description: type: string description: Description of the provider marketplace instance. default: '' maxLength: 200 homepage_content_search_text: type: string description: Placeholder text onboarding.items.options.text: type: string description: Label for value. homepage_categories_title: type: string description: Title for the categories. 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 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. onboarding.items.off: type: string description: Label for disabled toggle state. 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' name: type: string description: Name of the provider marketplace instance. minLength: 2 maxLength: 350 x-no-tags: true 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 homepage_content_button_text: type: string description: Button text reviews.instructions: type: string description: Review guidelines and policies within the provider marketplace. x-no-tags: true 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)$ homepage_content_text: type: string description: Text content, using markdown formatting. 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 homepage_content_image_alt: type: string description: Image alt text. 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 homepage_products_title: type: string description: Title for the products. properties: sitename_gender: description: Gender of the `sitename` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' example: Example Name org_guid: type: string format: uuid description: '`guid` of the organization the provider marketplace belongs to.' example: example_value oauth: type: object description: OAuth 2.0 client settings for the provider marketplace's consumer users. default: enabled: false properties: github: type: object description: Settings for the provider marketplace's GitHub OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitHub" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered application within GitHub. client_secret: type: string description: Client secret for the registered application within GitHub. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. gitlab: type: object description: Settings for the provider marketplace's GitLab OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with GitLab" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Application ID of the registered application within GitLab. client_secret: type: string description: Application Secret for the registered application within GitLab. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. google: type: object description: Settings for the provider marketplace's Google OAuth 2.0 client. properties: enabled: type: boolean description: Whether "Sign in with Google" is enabled for the provider marketplace's consumer users. default: false client_id: type: string description: Client ID of the registered OAuth 2.0 Credentials within Google. client_secret: type: string description: Client secret for the registered OAuth 2.0 Credentials within Google. writeOnly: true secret_updated: type: string format: date-time description: Date client_secret last updated. example: github: enabled: true client_id: 507f1f77bcf86cd799439011 client_secret: '********' secret_updated: '********' gitlab: enabled: true client_id: 507f1f77bcf86cd799439011 client_secret: '********' secret_updated: '********' google: enabled: true client_id: 507f1f77bcf86cd799439011 client_secret: '********' secret_updated: '********' terms_url: type: string format: url description: URL of the provider marketplace Terms & Conditions. example: https://example.com reviews: type: object description: Ratings & Reviews settings for the provider marketplace. default: enabled: false properties: enabled: type: boolean description: Whether Ratings & Reviews are enabled for the provider marketplace. char_limit: type: number description: Character limit for written feedback for products or services in the provider marketplace. enum: - 280 - 1000 - 4000 flagged_handling: type: string description: How reported review content is handled within the provider marketplace enum: - hide - show instructions: type: object description: Review guidelines and policies within the provider marketplace. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/reviews.instructions' moderation_process: type: string description: Which type of moderation process is to be used for reviews in the provider marketplace enum: - manual - automatic permissions: type: string description: Who is allowed to provide feedback for products or services in the provider marketplace. enum: - subscribers - all public_responses: type: boolean description: Whether to enable public responses to reviews in the provider marketplace. response_time: type: number description: Expected response time for feedback in the provider marketplace, in `response_time_unit`. minimum: 1 response_time_unit: type: string description: Unit of time that `response_time` correlates to. example: enabled: true char_limit: 280 flagged_handling: hide instructions: en-US: example_value fr-FR: example_value de-DE: example_value pt-BR: example_value moderation_process: manual permissions: subscribers public_responses: true response_time: 1.0 response_time_unit: example_value help_menu_icon: type: string description: Icon displayed in the navigation bar to show the help menu. example: example_value public: type: boolean description: Whether the provider marketplace allows access to unauthenticated users or users authenticated to orgs other than the provider org. default: false example: true 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 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 sitename: type: object description: Page title of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/sitename' example: en-US: example_value fr-FR: example_value de-DE: example_value pt-BR: example_value 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 signup: type: boolean description: Whether to allow self-service sign up for consumer organizations in the marketplace. default: false example: true 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 name: type: object description: Name of the provider marketplace instance. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/name' example: en-US: example_value fr-FR: example_value de-DE: example_value pt-BR: example_value lang: type: object description: Internationalization settings for the provider marketplace. default: default: en-US supported: - en-US products: all properties: default: type: string description: Default language to use for users of the marketplace. default: en-US enum: - en-US - fr-FR - de-DE - pt-BR products: type: string description: Behavior for display of products in the marketplace based on translation state. default: all enum: - all - translated supported: type: array description: Languages supported by the marketplace. default: - en-US items: type: string enum: - en-US - fr-FR - de-DE - pt-BR example: default: en-US products: all supported: - en-US search_engines: type: object default: indexing_enabled: true additionalProperties: false properties: google_site_verification_id: type: string description: Site Verification ID for Google Search Console integration. minLength: 1 indexing_enabled: type: boolean description: Whether indexing by search engines is enabled for the marketplace. default: true example: google_site_verification_id: 507f1f77bcf86cd799439011 indexing_enabled: true guid: type: string description: Identifier of the provider marketplace instance. example: example_value idp: type: boolean description: Whether to allow consumer organizations in the marketplace to establish custom Identity Providers. default: false example: true 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 consumer: type: boolean description: Whether to allow authenticated consumer org user access to the marketplace. default: false example: true idp_hint: type: - string - 'null' description: Identity Provider `guid` to use for sign in attempts originating from the marketplace. Cannot be set at the same time as `consumer`. example: 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 url: type: string description: Fully qualified domain name on which the provider marketplace can be accessed. pattern: ^([a-z0-9]+(-[a-z0-9]+)*\.)+[a-z]{2,}$ example: https://example.com nav_items: type: object description: Links added in the common navigation menu. default: {} properties: en-US: type: array description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' fr-FR: type: array description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' de-DE: type: array description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' pt-BR: type: array description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/nav_items' 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 terms: type: boolean description: Whether the provider marketplace access should be gated on acceptance of Terms & Conditions. default: false example: true name_gender: description: Gender of the `name` of the provider marketplace instance. allOf: - $ref: '#/components/schemas/Provider/x-defs/genderedLangSchema' example: Example Name versions: type: object description: Product version settings for the provider marketplace. default: custom: false display: all properties: custom: type: boolean description: Whether custom product versions are displayed in the provider marketplace. default: false display: type: string description: What product version types will be displayed in the provider marketplace. default: all enum: - all - latest example: custom: true display: all subdomain: type: string description: Subdomain on which the provider marketplace can be accessed. pattern: ^[a-z0-9\-]{4,63}$ example: example.com onboarding: type: object description: Onboarding data capture settings for the provider marketplace. default: enabled: false items: [] properties: enabled: type: boolean description: Whether onboarding data capture feature is enabled for the provider marketplace. items: type: array description: Onboarding fields to capture for consumer orgs of the provider marketplace. minItems: 1 maxItems: 50 items: type: object discriminator: propertyName: type mapping: header: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/0' text: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/1' number: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' date: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' checkbox: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/2' toggle: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/3' select: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' multiselect: '#/components/schemas/Provider/properties/onboarding/properties/items/items/oneOf/4' oneOf: - type: object required: - id - type - text properties: id: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/id' text: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/text' type: $ref: '#/components/schemas/Provider/x-defs/onboarding_props/properties/type' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: maxlen: type: number description: Maximum value length for the element. placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: 'off': type: object description: Label for disabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.off' 'on': type: object description: Label for enabled toggle state. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.on' - allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding_props' properties: options: type: array minItems: 2 maxItems: 1000 items: type: object required: - text - value properties: text: type: object description: Label for value. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/onboarding.items.options.text' value: type: string placeholder: $ref: '#/components/schemas/Provider/x-defs/placeholder' example: enabled: true items: - {} 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 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 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 - right bottom - center top - center center - center bottom image_size: type: string description: Background image size for the content. enum: - auto - cover - contain - 100% 100% url: type: string description: Background image URL for the content. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' content: type: array description: Content items. items: type: object unevaluatedProperties: false discriminator: propertyName: type mapping: button: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/1' image: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/2' search: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/3' text: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/4' oneOf: - type: object title: Button required: - url unevaluatedProperties: false discriminator: propertyName: url_type mapping: url: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/0' document: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1/properties/content/items/oneOf/0/oneOf/1' oneOf: - title: URL properties: url: type: string description: URL or relative path for the link. anyOf: - type: string title: URL pattern: (^((https?:\/\/[A-Za-z0-9.-]+|(?:www\.|[-;:&=+$,\w]+@)[A-Za-z0-9.-]+)((?:\/[+~%/.\w\-_]*)?\??(?:[-+=&;%@.\w_]*)#?(?:[\w?/:@\-._~!$&'()*+,;=]*))?)$|^(?:\/[+~%/.\w\-_]*)(?:\?[-+=&;%@.\w_]*)?(?:#[.!/\\\w]*)?$) - type: string title: Signin enum: - signin url_type: type: string enum: - url - title: Document properties: url: type: string description: Document resource guid url_type: type: string enum: - document properties: background: type: string format: color description: Button background color. border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Button text color. format: type: string description: Button background fill or outline. enum: - solid - outline target: type: - 'null' - string default: null enum: - null - _blank text: type: object description: Button text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_button_text' type: type: string enum: - button url_type: type: string description: Link type for the button URL. enum: - url - document - type: object title: Document required: - id unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' id: type: string description: Published document resource identifier. type: type: string enum: - document - type: object title: Image required: - url unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' text: type: object description: Image alt text. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_image_alt' type: type: string enum: - image url: type: string description: Image source URL. - type: object title: Search unevaluatedProperties: false properties: scope: type: string enum: - products - documents - resources - all text: type: object description: Placeholder text default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_search_text' - type: object title: Text unevaluatedProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' color: type: string format: color description: Text color. padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' text: type: object description: Text content, using markdown formatting. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_content_text' type: type: string enum: - text properties: align: type: string description: Content alignment. default: left enum: - left - center - right margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string enum: - button - document - image - search - text type: type: string enum: - content - type: object additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - nav - type: object additionalProperties: false discriminator: propertyName: filter mapping: top: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' published: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/0' tags: '#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3/oneOf/1' oneOf: - type: object properties: filter: type: string enum: - top - published - type: object properties: filter: type: string enum: - tags tags: type: array description: The tags determining which products to show when `filter` is set to `"tags".` minItems: 1 items: type: string properties: count: type: number maximum: 12 filter: type: string description: Displayed products setting for the provider marketplace featured products section. enum: - tags - top - published sort: type: string description: Sorting setting for the provider marketplace featured products section. enum: - alpha - recent - highest_rating - most_reviews title: type: object description: Title for the products. default: {} properties: en-US: type: string description: English language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' fr-FR: type: string description: French language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' de-DE: type: string description: German language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' pt-BR: type: string description: Portuguese language value. allOf: - $ref: '#/components/schemas/Provider/x-defs/homepage_products_title' type: type: string enum: - products - type: object required: - border additionalProperties: false properties: border: $ref: '#/components/schemas/Provider/x-defs/homepage_border' type: type: string enum: - separator properties: margin: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' padding: $ref: '#/components/schemas/Provider/x-defs/homepage_spacing' type: type: string visibility: type: number description: 'Item visibility. Always shown: 0, Signed in: 1, Signed out: 2' enum: - 0 - 1 - 2 width: type: number description: 'Item width. Full width: 0, Full width aligned to grid: 5, Column width: 1 - 4.' enum: - 0 - 1 - 2 - 3 - 4 - 5 example: enabled: true default_page: example_value items: - margin: {} padding: {} type: example_value visibility: 0 width: 0 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 Response: type: object properties: success: type: boolean description: Whether the request was successful. example: true IdentityProvider: properties: orgs: items: properties: case_insensitive_mapped_roles: type: boolean description: Whether to match returned mapped attribute values to expected attribute values without letter case sensitivity. enforce_mapped_roles: type: boolean description: Whether to restrict organization role management solely to mapped IdP attributes. Any organization role(s) that a user has that does not match to an associated mapper (or the Default Organization Roles) will be removed on subsequent sign in. default_roles: type: array description: Array of role identifiers that are assigned to newly provisioned users in the Organization. items: type: string enum: - administrator - developer - auditor - consumer - usage_reporter - api_central_admin mapped_roles: type: array description: Array of role identifiers to assign users in the Organization based on attributes defined by the Identity Provider. default: [] items: type: object required: - value - roles additionalProperties: false properties: friendly: type: string description: Friendly name of the attribute provided by the SAML Identity Provider. name: type: string description: Name of the attribute provided by the Identity Provider. roles: type: array description: Array of role identifiers to be assigned to matching users in the Organization. items: type: string enum: - administrator - developer - auditor - consumer - usage_reporter - api_central_admin value: type: string description: Value of the named attribute to determine whether to apply the role. name: type: string description: Name of Identity Provider example: Example Name description: type: string description: Description of the Identity Provider. example: An example description Success: type: object allOf: - $ref: '#/components/schemas/Response' - type: object properties: result: description: The response data Consumer: type: object properties: active: $ref: '#/components/schemas/Org/properties/active' consumer_id: $ref: '#/components/schemas/Org/properties/consumer_id' guid: $ref: '#/components/schemas/Org/properties/guid' name: $ref: '#/components/schemas/Org/properties/name' onboarding: $ref: '#/components/schemas/Org/properties/onboarding' org_id: $ref: '#/components/schemas/Org/properties/org_id' pending: $ref: '#/components/schemas/Org/properties/pending' teams: oneOf: - type: integer description: Count of teams in the consumer org. - type: object description: Metadata of the teams in the consumer org. properties: guid: $ref: '#/components/schemas/Team/properties/guid' name: $ref: '#/components/schemas/Team/properties/name' example: example_value users: type: integer description: Count of users in the consumer org. example: 1 PasswordPolicy: type: object description: Password policy properties: length: type: integer minimum: 9 maximum: 127 default: 8 example: 1 max_length: type: integer minimum: 9 maximum: 127 default: 128 example: 1 lower: type: integer minimum: 1 example: 1 upper: type: integer minimum: 1 example: 1 special: type: integer minimum: 1 example: 1 digit: type: integer minimum: 1 example: 1 lockout: type: integer minimum: 1 maximum: 4 default: 5 example: 1 renewal: type: integer minimum: 1 example: 1 history: type: integer minimum: 1 maximum: 10 example: 1 Team: properties: name: type: string description: Name of the team. minLength: 2 maxLength: 100 x-no-tags: true example: Example Name guid: type: string format: uuid description: '`guid` of the team.' example: example_value Org: properties: org_id: type: integer description: Identifier for the organization example: 1 name: type: string description: Name of the organization. minLength: 2 maxLength: 64 x-no-tags: true example: Example Name active: type: boolean description: Active state of the organization. Organizations become inactive after passing their end date. default: true example: true pending: type: boolean description: Whether the organization is pending approval for a provider organization administator. example: true guid: type: string format: uuid description: GUID identifier for the organization example: example_value onboarding: type: object description: Onboarding data for consumer org. maxProperties: 50 writeOnly: true patternProperties: '[\w-]{21}': type: - string - number - boolean - array description: Onboarding data field value. items: type: string description: Onboarding data field multi-select option value. example: {} consumer_id: type: string description: Mapped ID of the consumer org from the configured Identity Provider. example: 507f1f77bcf86cd799439011 Entitlements: type: object description: Subscription entitlements properties: id: type: string title: ID description: An identifier for the plan example: 507f1f77bcf86cd799439011 name: type: string title: Name description: A name for the plan example: Example Name ACT.Instances: type: integer title: Instances description: Total allowed Instances. example: 1 AgentSDK.Transactions: type: integer title: Third-party Gateway Traceability Agent Transactions description: Third-party Gateway Traceability Agent Transactions per month. These are transactions instrumented using Agent SDK for vendors other than AWS, Azure, and Istio. example: 1 provision_envs: type: array title: Provisioned Environments x-immutable: true x-deprecated: true items: type: string enum: - sandbox - production description: Environments to provision in Integration Builder. example: - sandbox transactions: type: integer title: Integration Builder Transactions x-deprecated: true description: Integration Builder Transactions per month. example: 1 AI.Transactions: type: integer title: AI Transactions description: AI Transactions per month. example: 1 AISuite.Cores: type: integer title: AI Suite Cores description: Total allowed AI Suite Cores. example: 1 AISuite.InputEvents: type: integer title: AI Suite Incoming Records description: AI Suite Incoming Records per month. example: 1 AISuite.Instances: type: integer title: AI Suite Rule Engine Instances description: Total allowed AI Suite Rule Engine Instances. example: 1 AISuite.Users: type: integer title: AI Suite Named Users description: Total allowed AI Suite Named Users. example: 1 AMPG.Transactions: type: integer title: Amplify Gateway Transactions description: Amplify Gateway Transactions per month. example: 1 AMPG.Volume: type: number title: Amplify Gateway Volume description: Amplify Gateway transferred volume per month in GB. example: 1.0 AMPI.Transactions: type: integer title: Integration Transactions description: Integration Transactions per month. example: 1 AMPI.Volume: type: number title: Data Volume description: ' transferred volume per month in GB.' example: 1.0 AOB.Transactions: type: integer title: Open Banking API Transactions description: Open Banking API Transactions per month. example: 1 API.Transactions: type: integer title: API Transactions description: API Transactions per month. example: 1 APIB.Transactions: type: integer title: API Builder Transactions x-deprecated: true description: API Builder Transactions per month. example: 1 APIM.DRCores: type: integer title: DR Cores description: Total allowed DR Cores. example: 1 APIM.NonProdCores: type: integer title: Non-production Cores description: Total allowed Non-production Cores. example: 1 APIM.ProdCores: type: integer title: Production Cores description: Total allowed Production Cores. example: 1 APIM.Transactions: type: integer title: API Gateway Transactions description: API Gateway Transactions per month. example: 1 APIM.Volume: type: number title: API Gateway Outbound Volume description: API Gateway transferred volume per month in GB. example: 1.0 APIMG.Transactions: type: integer title: Amplify Istio Traceability Agent Transactions description: Amplify Istio Traceability Agent Transactions per month. example: 1 APIP.DRCores: type: integer title: DR Cores description: Total allowed DR Cores. example: 1 APIP.NonProdCores: type: integer title: Non-production Cores description: Total allowed Non-production Cores. example: 1 APIP.ProdCores: type: integer title: Production Cores description: Total allowed Production Cores. example: 1 Automator.CockpitEssential: type: integer title: Automator Cockpit Essential description: Automator Cockpit Essential. example: 1 Automator.CockpitPlus: type: integer title: Automator Cockpit Plus description: Automator Cockpit Plus. example: 1 Automator.Points: type: integer title: Automator Points description: Automator Points. example: 1 AWS.Transactions: type: integer title: AWS API Gateway Traceability Agent Transactions description: AWS API Gateway Traceability Agent Transactions per month. example: 1 Azure.Transactions: type: integer title: Azure API Gateway Traceability Agent Transactions description: Azure API Gateway Traceability Agent Transactions per month. example: 1 B2Bi.Cores: type: integer title: Cores description: Total allowed DR cores. example: 1 B2Bi.Messages: type: integer title: B2Bi Messages description: B2Bi Messages per month. example: 1 B2Bi.Partners: type: integer title: B2Bi Partners description: B2Bi Partners per month. example: 1 B2Bi.Volume: type: number title: B2Bi Volume description: B2Bi transferred volume per month in GB. example: 1.0 B2Bi.WTPartners: type: integer title: Webtrader Partners description: Total allowed Webtrader Partners. example: 1 BN.Volume: type: integer title: Axway Business Network Volume description: Axway Business Network Volume per month in KiloCharacters. example: 1 CFT.Cores: type: integer title: Cores description: Total allowed Cores. example: 1 CFT.MSUs: type: integer title: MSUs description: Total allowed MSUs. example: 1 CFT.Sessions: type: integer title: Sessions description: Total allowed Sessions. example: 1 CFT.Transfers: type: integer title: CFT File Transfers description: CFT File Transfers per month. example: 1 CSOS.CentralSigning: type: boolean title: CSOS Signing Instance description: Allow access to CSOS Signing Instance feature. example: true CSOS.Monitoring: type: boolean title: CSOS Monitoring description: Allow access to CSOS Monitoring feature. example: true CSOS.Orders: type: integer title: CSOS Orders description: CSOS Orders per month. example: 1 CSOS.Partners: type: integer title: CSOS Partners description: Total allowed CSOS Partners. example: 1 CSOS.Transformation: type: boolean title: CSOS Transformation description: Allow access to CSOS Transformation feature. example: true CSOS.Validation: type: boolean title: CSOS Validation Instance description: Allow access to CSOS Validation Instance feature. example: true DI.Dashboards: type: integer title: Axway Decision Insights Dashboards description: Total allowed Axway Decision Insights Dashboards. example: 1 DI.Users: type: integer title: Axway Decision Insights Named Users description: Total allowed Axway Decision Insights Named Users. example: 1 DS.Cores: type: integer title: Datastore Cores description: Total allowed Datastore Cores. example: 1 DS.Users: type: integer title: Datastore Client Users description: Total allowed Datastore Client Users. example: 1 DV.EnterpriseInstances: type: integer title: Desktop Validator Enterprise Instances description: Total allowed Desktop Validator Enterprise Instances. example: 1 DV.StandardInstances: type: integer title: Desktop Validator Standard Instances description: Total allowed Desktop Validator Standard Instances. example: 1 EBICSC.Channels: type: integer title: EBICS Client Channels description: Total allowed EBICS Client Channels. example: 1 EBICSCORP.Banks: type: integer title: Bank Connections Allowed description: Total allowed EBICS Corporate bank connections. example: 1 EBICSCORP.Treasurers: type: integer title: Treasurer Connections Allowed description: Total allowed EBICS Corporate treasurer connections. example: 1 EBICSG.Customers: type: integer title: EBICS Client Customers description: Total allowed EBICS Client Customers. example: 1 EBICSG.FileTransfers: type: integer title: EBICS Gateway File Transfers description: EBICS Gateway File Transfers per month. example: 1 EBICSG.Messages: type: integer title: EBICS Gateway Instant Payment Messages description: EBICS Gateway Instant Payment Messages per month. example: 1 EBICSG.Subscriptions: type: integer title: EBICS Gateway Subscriptions description: Total allowed EBICS Gateway Subscriptions. example: 1 EI.Archives: type: integer title: eInvoicing Archiving Transactions description: eInvoicing Archiving Transactions per month. example: 1 EI.Invoices: type: integer title: eInvoicing Transactions description: eInvoicing Transactions per month. example: 1 EI.OCRTransactions: type: integer title: OCR eInvoicing Transactions description: OCR eInvoicing Transactions per month. example: 1 EI.PeppolTransactions: type: integer title: PEPPOL Invoicing Transactions description: PEPPOL Invoicing Transactions per month. example: 1 EI.Transformations: type: integer title: eInvoicing Transformation Transactions description: eInvoicing Transformation Transactions per month. example: 1 EN.Environments: type: integer title: Connected Environments description: Total allowed Connected Environments. example: 1 EN.EnvironmentsNonProd: type: integer title: Connected Environments (Non-production) description: Total allowed Connected Environments (Non-production). example: 1 EN.Services: type: integer title: API Services description: Total allowed API Services. example: 1 ESUB.ClientLicense: type: integer title: eSubmissions Client Licenses description: Total allowed eSubmissions Client Licenses. example: 1 ESUB.CommunityLicense: type: integer title: eSubmissions Community Licenses description: Total allowed eSubmissions Community Licenses. example: 1 ESUB.Messages: type: integer title: eSubmissions Messages description: eSubmissions Messages per month. example: 1 ESUB.Partners: type: integer title: eSubmissions (Non-Regulatory) Trading Partners description: eSubmissions (Non-Regulatory) Trading Partners per month. example: 1 ESUB.Regulatory: type: integer title: eSubmissions Regulatory Trading Partners description: eSubmissions Regulatory Trading Partners per month. example: 1 ESUB.T1: type: integer title: eSubmissions Client Tier 1 description: Total allowed eSubmissions Client Tier 1. example: 1 ESUB.T2: type: integer title: eSubmissions Client Tier 2 description: Total allowed eSubmissions Client Tier 2. example: 1 ESUB.T3: type: integer title: eSubmissions Client Tier 3 description: Total allowed eSubmissions Client Tier 3. example: 1 ESUB.Volume: type: number title: eSubmissions Volume description: eSubmissions transferred volume per month in GB. example: 1.0 FAH.ApplicationConnectors: type: integer title: Financial Accounting Hub ApplicationConnectors description: Total allowed Financial Accounting Hub ApplicationConnectors. example: 1 FAH.Records: type: integer title: Financial Accounting Hub Records description: Financial Accounting Hub Records per month. example: 1 FAH.Users: type: integer title: Financial Accounting Hub Named Users description: Total allowed Financial Accounting Hub Named Users. example: 1 flows: type: integer title: Flow Manager Unit Flows description: Flow Manager Unit Flows per month. example: 1 FU.MultiPatternTransactions: type: integer title: Multi-Pattern Transactions description: Multi-Pattern Transactions per month. example: 1 HBS.Messages: type: integer title: Shared Usage Metric description: Hybrid B2B Solution messages per month. example: 1 Hub.Assets: type: integer title: Asset Catalog Assets description: Total allowed Asset Catalog Assets. example: 1 Hub.Marketplaces: type: integer title: Marketplaces description: Total allowed Marketplaces. example: 1 Hub.Subscriptions: type: integer title: Marketplace Subscriptions description: Total allowed Marketplace Subscriptions. example: 1 Hub.Transactions: type: integer title: Analytics Transactions description: Analytics Transactions per month. example: 1 INTP.Designers: type: integer title: Interplay Designers description: Total allowed Interplay Designers. example: 1 INTP.Instances: type: integer title: Interplay Instances description: Total allowed Interplay Instances. example: 1 PEPPOL.Transactions: type: integer title: PEPPOL Service Transactions description: PEPPOL Service Transactions per month. example: 1 SC.Instances: type: integer title: Secure Client Instances description: Secure Client Instances. example: 1 SC.Licenses: type: array title: Secure Client License Activation ID items: type: string description: License Activation ID for Secure Client instances. example: - example_value SFC.Banks: type: integer title: Secure Financial Client Banks description: Total allowed Secure Financial Client Banks. example: 1 SFC.Partners: type: integer title: Secure Financial Client Connection Partners description: Total allowed Secure Financial Client Connection Partners. example: 1 SFC.Treasurers: type: integer title: Secure Financial Client Treasurers description: Total allowed Secure Financial Client Treasurers. example: 1 ST.ActiveUsers: type: integer title: Connections description: Total allowed Connections. example: 1 ST.Connections: type: integer title: Connections description: Total allowed Connections. example: 1 ST.Cores: type: integer title: Cores description: Total allowed Cores. example: 1 ST.Instances: type: integer title: Production Instances description: Total allowed Production Instances. example: 1 ST.Sessions: type: integer title: Sessions description: Total allowed Sessions. example: 1 ST.Transfers: type: integer title: File Transfers description: File Transfers per month. example: 1 ST.TransfersIn: type: integer title: Transfers In description: Transfers In per month. example: 1 ST.TransfersOut: type: integer title: Transfers Out description: Transfers Out per month. example: 1 ST.Volume: type: number title: Incoming Data Volume description: Transferred data volume per month in GB. example: 1.0 STL.Applications: type: integer title: Monitored Applications description: Total allowed Monitored Applications. example: 1 STL.CPUs: type: integer title: CPUs description: Total allowed CPUs. example: 1 STL.Users: type: integer title: Users description: Total allowed Users. example: 1 Streams.Events: type: integer title: Streams Events description: Streams Events per month. example: 1 Streams.Volume: type: number title: Streams Volume description: Streams transferred volume per month in GB. example: 1.0 SV.Users: type: integer title: Server Validator Users description: Total allowed Server Validator Users. example: 1 TNT.Compliance: type: array title: Compliance Module items: type: string enum: - EU - SA - UAE example: - EU TNT.Lines: type: integer title: Manufactoring/Distributor Lines description: Total allowed Manufactoring/Distributor Lines. example: 1 TNT.Packs: type: integer title: Unit Packs description: Total allowed Unit Packs. example: 1 TNT.Routing: type: boolean title: DSCSA Routing Service example: true TNT.SerialNumbers: type: integer title: Track & Trace Serial Numbers description: Track & Trace Serial Numbers. example: 1 Traceable.Discovery: type: integer title: Traceable API Discovery description: Total allowed Traceable API Discovery. example: 1 Traceable.SecurityTesting: type: boolean title: Traceable API Security Testing description: Allow access to Traceable API Security Testing feature. example: true TSIM.Cores: type: integer title: Cores description: Total allowed DR cores. example: 1 TSIM.Messages: type: integer title: TSIM Messages description: TSIM Messages per month. example: 1 TSIM.Partners: type: integer title: TSIM Partner Relations description: TSIM allowed partners per month. example: 1 TSIM.Users: type: integer title: ENGDAT Users description: Total allowed ENGDAT Users. example: 1 TSIM.Volume: type: number title: TSIM Volume description: TSIM transferred volume per month in GB. example: 1.0 VA.Policies: type: integer title: Policies description: Total allowed Policies. example: 1 VA.Repeaters: type: integer title: Repeater Instances description: Total allowed Repeater Instances. example: 1 VA.Responsers: type: integer title: Responser Instances description: Total allowed Responser Instances. example: 1 VRS.Transactions: type: integer title: Axway VRS Solution Transactions description: Axway VRS Solution Transactions per month. example: 1 WebEDI.Users: type: integer title: WebEDI Portal Users description: Total allowed WebEDI Portal Users. example: 1 WebEDI.Volume: type: number title: WebEDI Portal Volume description: WebEDI Portal transferred volume per month in GB. example: 1.0 APIConnect.Transactions: type: integer title: IBM APIConnect Traceability Agent Transactions description: IBM APIConnect Traceability Agent Transactions per month. example: 1 Apigee.Transactions: type: integer title: Apigee Traceability Agent Transactions description: Apigee Traceability Agent Transactions per month. example: 1 APIMAgent.Transactions: type: integer title: Axway Gateway Traceability Agent Transactions description: Axway Gateway Traceability Agent Transactions per month. example: 1 Kafka.Transactions: type: integer title: Kafka Traceability Agent Transactions description: Kafka Traceability Agent Transactions per month. example: 1 SAPAPIPortal.Transactions: type: integer title: SAP API Portal Traceability Agent Transactions description: SAP API Portal Traceability Agent Transactions per month. example: 1 Sensedia.Transactions: type: integer title: Sensedia Agent Transactions description: Sensedia Agent Transactions per month. example: 1 Tokens: type: integer title: Tokens description: Amplify API Management Platform offering tokens per month. example: 1 Volume: type: integer title: Volume description: Amplify API Management Platform offering transaction volume per month. example: 1 WebMethods.Transactions: type: integer title: Software AG webMethods Agent Transactions description: Software AG webMethods Agent Transactions per month. example: 1 WSO2.Transactions: type: integer title: WSO2 Traceability Agent Transactions description: WSO2 Traceability Agent Transactions per month. example: 1 AIIntegration: type: boolean title: AI Integration description: Allow access to AI Integration feature. example: true APICompliance: type: boolean title: API Compliance description: Allow access to API Compliance feature. example: true APIMocking: type: boolean title: API Mocking description: Allow access to API Mocking feature. example: true catalog: type: boolean title: Unified Catalog Access description: Allow access to Unified Catalog. example: true daysDataRetained: type: integer title: Data Retention description: How long analytics events are kept in days. example: 1 FIPS: type: boolean title: FIPS example: true idp: type: boolean title: External Identity Provider description: Allow configuration of an external identity provider for authentication. example: true partners: type: array title: Partners x-immutable: - AEM - AMP - APIM - APIMG - AWS - Azure - Bundle - EN - Hub - Streams - ai - ars - fc - ib items: type: string enum: - aca - analytics - api_central description: Partners the organization has access to. example: - aca public_provider: type: boolean title: Public Marketplace description: Allow public Marketplace features including vanity URL, unauthorized access, consumer org support, homepage content, and paid plans. example: true retention: type: integer title: Analytics Event Retention description: Length of time analytics events are kept in days. example: 1 retentionTransactions: type: integer title: Transaction Event Retention description: Length of time transaction events are kept in days. example: 1 DefaultFields: type: object unevaluatedProperties: false properties: created: type: string format: date-time description: Date created. readOnly: true example: '2026-04-21T00:00:00Z' created_by: type: object description: Creator user or client. readOnly: true properties: guid: type: string description: '`guid` of the creator.' type: type: string description: Type of the creator. enum: - user - client example: guid: example_value type: user updated: type: string format: date-time description: Date last updated. readOnly: true example: '2026-04-21T00:00:00Z' Error: type: object allOf: - $ref: '#/components/schemas/Response' - type: object properties: code: type: number description: HTTP status code. description: type: string description: A message describing the error. internalCode: type: number description: Internal code. ResponseMetadata: type: object properties: count: type: number description: Number of results included in the response. example: 1.0 limit: type: number description: Number of results per page. example: 1.0 matched: type: number description: Total number of matched results. example: 1.0 page: type: number description: Page of results. example: 1.0 pages: type: number description: Total number of pages of results. example: 1.0 skip: type: number description: Number of results skipped in pagination. example: 1.0 Subscription: type: object description: Organization entitlements required: - id - product - plan - entitlements additionalProperties: false properties: end_date: type: string format: date-time description: When the subscription is active to. example: '2026-04-21T00:00:00Z' entitlements: type: array items: type: object required: - key - value properties: key: type: string description: Entitlement key. value: oneOf: - type: boolean description: Boolean entitlement, granting access to a feature of capability. - type: integer description: Integer entitlement value, granting quota of allow transactions or requests per month. maximum: 9999999999999 - type: number description: Numeric entitlement value, granting allow volumes of network throughput or storage. maximum: 9999999999999 - type: array description: Set entitlement, listing provisioned service or environment availability. items: type: string description: Service or environment key. example: - key: example_value value: example_value governance: type: string description: Governance model for the subscription. enum: - SaaS - Customer Managed - Axway Managed example: SaaS id: type: string description: Identifier for the subscription. example: 507f1f77bcf86cd799439011 opportunity_id: type: number description: Opportunity ID associated with the subscription. minimum: 10000 maximum: 999999 example: 1.0 plan: type: string description: Which plan the subscription is for. example: example_value product: type: string description: Name to identify the product, e.g. APIM, B2Bi. example: example_value product_name: type: string description: Official product name. readOnly: true example: Example Name source: type: string description: Source of this subscription. enum: - API - UI - Platform - Billing example: API start_date: type: string format: date-time description: When the subscription is active from. example: '2026-04-21T00:00:00Z' tier: type: string description: Whether the subscription is a trial or paid for. enum: - paid - trial - free example: paid examples: FORBIDDEN: value: success: false description: You do not have access privileges to view this content. code: 403 USER_NOT_ADMIN: value: success: false description: You are not authorized to perform this action. Please contact your organization administrator. code: 403 PARAM_INVALID: value: success: false description: '"%s" contained an invalid value.' code: 400 internalCode: 74 NOT_FOUND: value: success: false description: Resource Not Found code: 404 LOGIN_REQUIRED: value: success: false description: Sign-in Required code: 401 IDP_REQUIRED: value: success: false description: You must sign in using the Identity Provider configured by your organization's administrators to access this organization. code: 401 internalCode: 235 PARAM_REQUIRED: value: success: false description: '"%s" is a required parameter.' code: 400 internalCode: 77 parameters: add_fields: name: add_fields in: query description: A list of fields to add to the default field set in the response. schema: type: array items: type: string fields: name: fields in: query description: A list of fields to include in the response. schema: type: array items: type: string exclude_fields: name: exclude_fields in: query description: A list of fields to exclude from the response. schema: type: array items: type: string responses: SuccessResponse: description: Success content: application/json: schema: $ref: '#/components/schemas/Success' securitySchemes: AuthToken: description: Auth token for internal services type: apiKey in: header name: x-auth-token BearerClient: description: Service account access token type: http scheme: bearer bearerFormat: jwt BearerService: description: Service account access token for an internal client type: http scheme: bearer bearerFormat: jwt BearerUser: description: AxwayID user session access token type: http scheme: bearer bearerFormat: jwt MFA: description: Multi-factor authentication code type: apiKey in: header name: x-auth-code OAuth2: type: oauth2 flows: clientCredentials: tokenUrl: https://login.axway.com/auth/realms/Broker/protocol/openid-connect/token scopes: {} authorizationCode: authorizationUrl: https://login.axway.com/auth/realms/Broker/openid-connect/auth tokenUrl: https://login.axway.com/auth/realms/Broker/openid-connect/token scopes: {} implicit: authorizationUrl: https://login.axway.com/auth/realms/Broker/openid-connect/auth scopes: {} Password: description: User password type: apiKey in: header name: x-auth-password SessionCookie: description: Platform session cookie type: apiKey in: cookie name: connect.sid