{ "openapi": "3.1.0", "info": { "version": "16.10.0", "title": "Amplify Platform API v1.0.0", "description": "The Amplify Platform API provides the interface to perform the following:\n- Manage account settings and credentials\n- Manage organization settings, users, service accounts, and teams\n- Retrieve organization usage data\n- Register and manage applications\n- Retrieve application metrics and analytics\n- Retrieve user, organization, and application activity\n\nSee the Amplify Guide for documentation and examples on how to authorize API calls to platform services.\n\nFor general documentation refer to the Amplify Platform documentation.\n\n© 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" } ], "components": { "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" } } }, "exclude_fields": { "name": "exclude_fields", "in": "query", "description": "A list of fields to exclude from 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" } } } }, "responses": { "AnalyticsResponse": { "description": "Analytics Query Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "success": { "type": "boolean", "description": "Whether the request was successful.", "default": true }, "result": { "oneOf": [ { "type": "array", "title": "Mutli query response", "items": { "properties": { "data": { "type": "object", "description": "The analytics data." }, "last_fetched": { "type": "string", "description": "When the data returned was last fetched." } } } }, { "title": "Single query response", "properties": { "data": { "type": "object", "description": "The analytics data." }, "last_fetched": { "type": "string", "description": "When the data returned was last fetched." } } } ] } } } ] } } } }, "BaseResponse": { "description": "Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response" } } } }, "ErrorResponse": { "description": "Error Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "SuccessResponse": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Success" } } } } }, "schemas": { "Activation": { "type": "object", "properties": { "created": { "$ref": "#/components/schemas/DefaultFields/properties/created" }, "expire": { "type": "string", "description": "Timestamp of when the record expired.", "example": "example_value" }, "guid": { "type": "string", "description": "Identifier for the activation record.", "example": "example_value" }, "type": { "type": "string", "description": "Type of record.", "example": "example_value" }, "updated": { "$ref": "#/components/schemas/DefaultFields/properties/created" }, "user_guid": { "type": "string", "description": "GUID of the user the activation record is for.", "example": "example_value" } } }, "Application": { "type": "object", "required": [ "guid", "name", "org_guid", "platform", "type" ], "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "if": { "type": "object", "title": "Document Resource", "properties": { "type": { "type": "string", "enum": [ "documentresource" ] } } }, "then": { "type": "object", "title": "Document Resource", "properties": { "default_lang": { "type": [ "string", "null" ], "enum": [ "en-US", "fr-FR", "de-DE", "pt-BR" ] }, "description": { "type": "object", "description": "Description of the application.", "properties": { "en-US": { "type": [ "string", "null" ], "description": "English language value.", "x-no-tags": true }, "fr-FR": { "type": [ "string", "null" ], "description": "French language value.", "x-no-tags": true }, "de-DE": { "type": [ "string", "null" ], "description": "German language value.", "x-no-tags": true }, "pt-BR": { "type": [ "string", "null" ], "description": "Portuguese language value.", "x-no-tags": true } } }, "name": { "type": "object", "description": "Name of the application.", "properties": { "en-US": { "type": [ "string", "null" ], "description": "English language value.", "x-no-tags": true }, "fr-FR": { "type": [ "string", "null" ], "description": "French language value.", "x-no-tags": true }, "de-DE": { "type": [ "string", "null" ], "description": "German language value.", "x-no-tags": true }, "pt-BR": { "type": [ "string", "null" ], "description": "Portuguese language value.", "x-no-tags": true } } }, "url": { "type": "object", "description": "URL for the application.", "properties": { "en-US": { "type": [ "string", "null" ], "description": "English language value.", "x-no-tags": true }, "fr-FR": { "type": [ "string", "null" ], "description": "French language value.", "x-no-tags": true }, "de-DE": { "type": [ "string", "null" ], "description": "German language value.", "x-no-tags": true }, "pt-BR": { "type": [ "string", "null" ], "description": "Portuguese language value.", "x-no-tags": true } } } } }, "else": { "type": "object", "title": "Other Type", "properties": { "description": { "type": "string", "description": "Description of the application.", "x-no-tags": true }, "name": { "type": "string", "description": "Name of the application.", "x-no-tags": true }, "url": { "type": "string", "description": "URL for the application.", "x-no-tags": true } } }, "properties": { "_id": { "type": "string", "description": "ID of the application.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "apis": { "type": "array", "items": { "type": "string" }, "example": [ "example_value" ] }, "automatic": { "type": "boolean", "example": true }, "env": { "type": "string", "example": "example_value" }, "guid": { "type": "string", "description": "Application guid.", "example": "example_value" }, "org_guid": { "type": "string", "description": "The `guid` of the org the application belongs to.", "example": "example_value" }, "platform": { "type": "string", "description": "Name of the platform the application being developed for.", "example": "example_value" }, "provider_guid": { "type": "string", "example": "example_value" }, "providers": { "type": "array", "description": "The provider marketplaces the application is published to. Set for \"product\" and \"documentresource\" applications.", "items": { "type": "object", "required": [ "guid" ], "properties": { "guid": { "type": "string", "description": "The `guid` of the provider marketplace." }, "published_id": { "type": "string", "description": "The published id of the application in the provider marketplace." } } }, "example": [ { "guid": "example_value", "published_id": "507f1f77bcf86cd799439011" } ] }, "source": { "type": "string", "x-no-tags": true, "example": "example_value" }, "subtype": { "type": "string", "x-no-tags": true, "example": "example_value" }, "type": { "type": "string", "description": "Type of the application", "x-no-tags": true, "example": "example_value" } } }, "Client": { "type": "object", "required": [ "guid", "name", "org_guid", "roles", "tags" ], "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "if": { "type": "object", "title": "Certificate Auth", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "certificate" ] } } }, "then": { "type": "object", "additionalProperties": false, "properties": { "key_id": { "type": "string", "description": "Identifier of the public key used for the client.", "readOnly": true } } }, "else": { "type": "object", "title": "Secret Auth", "additionalProperties": false }, "properties": { "_id": { "type": "string", "description": "Document ID of the client.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "client_id": { "type": "string", "description": "Identifier of the client to use for authentication.", "example": "507f1f77bcf86cd799439011" }, "guid": { "type": "string", "format": "uuid", "description": "`guid` of the client.", "example": "example_value" }, "name": { "type": "string", "description": "Name of the client.", "x-no-tags": true, "example": "Example Name" }, "org_guid": { "type": "string", "format": "uuid", "description": "`guid` of the organization the client belongs to.", "example": "example_value" }, "roles": { "type": "array", "description": "Array of org-level role identifiers that are assigned to the client.", "default": [], "items": { "type": "string", "enum": [ "administrator", "developer", "auditor", "consumer", "usage_reporter", "api_central_admin" ] }, "example": [ "administrator" ] }, "tags": { "type": "array", "description": "Tags assigned to the client.", "default": [], "minItems": 0, "uniqueItems": true, "maxItems": 30, "items": { "type": "string", "maxLength": 40 }, "example": [ "example_value" ] }, "type": { "type": "string", "description": "Authentication method for the client.", "default": "secret", "enum": [ "secret", "certificate" ], "example": "secret" } } }, "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 } } }, "CustomQuery": { "type": "object", "required": [ "name", "span", "unit" ], "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "properties": { "_id": { "type": "string", "description": "Identifier of the query.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "cross_org": { "type": "boolean", "description": "Whether the query is run against all organizations instead of just the organization it belongs to.", "example": true }, "endpoint": { "type": "string", "format": "url", "description": "The analytics endpoint called for the query.", "example": "example_value" }, "field": { "type": "string", "description": "Lexus query invoke field.", "example": "example_value" }, "filters": { "type": "string", "format": "json", "description": "Lexus filters JSON.", "example": "example_value" }, "granularity": { "type": "string", "description": "Unit of time for grouping results; with \"grquantity\", determines interval of results.", "enum": [ "month", "day", "hour", "minute" ], "example": "month" }, "groupings": { "type": "array", "description": "Field to group results by.", "items": { "type": "object", "required": [ "field", "type" ], "additionalProperties": false, "properties": { "field": { "type": "string" }, "interval": { "type": "integer", "description": "Interval used when grouping by a numeric field.", "minimum": 1 }, "limit": { "type": "integer", "description": "Maximum number of items to return for a grouping", "minimum": 1 }, "type": { "type": "string", "enum": [ "string", "number", "duration" ] } } }, "example": [ { "field": "example_value", "interval": 1, "limit": 1, "type": "string" } ] }, "grquantity": { "type": "integer", "description": "Number of units of time for grouping results; with \"granularity\", determines interval of results.", "minimum": 1, "maximum": 200, "example": 1 }, "guid": { "type": "string", "format": "uuid", "description": "Identifier for the query.", "example": "example_value" }, "include": { "type": "array", "description": "_Find method only._ Which fields to include in each document.", "items": { "type": "string", "description": "Field name." }, "example": [ "example_value" ] }, "limit": { "type": "integer", "description": "_Find method only._ How many results to include per grouping", "minimum": 1, "example": 1 }, "method": { "type": "string", "description": "Lexus query invoke method.", "example": "example_value" }, "name": { "type": "string", "description": "A name to give the query.", "example": "Example Name" }, "offset": { "type": "integer", "description": "_Find method only._ How many documents to skip.", "minimum": 0, "example": 1 }, "org_guid": { "type": "integer", "description": "The guid of the organization the query is saved for.", "example": 1 }, "rateGranularity": { "type": "string", "description": "_Rate method only._ The granularity at which the rate is displayed.", "enum": [ "second", "minute", "hour", "day" ], "example": "second" }, "sortField": { "type": "string", "description": "_Find method only._ Field by which to sort events.", "maxProperties": 1, "example": "example_value" }, "sortOrder": { "type": "integer", "description": "_Find method only._ Order in which to sort events. 1 (ascending) or -1 (descending).", "enum": [ 1, -1 ], "maxProperties": 1, "example": 1 }, "span": { "type": "integer", "description": "Number of units of time for queried date range; with \"unit\", determines queried date range.", "minimum": 1, "maximum": 200, "example": 1 }, "type": { "type": "string", "description": "Type of chart to use to display results.", "enum": [ "list", "stream", "line", "bar" ], "example": "list" }, "unit": { "type": "string", "description": "Unit of time for date range of query; with \"span\", determines queried date range.", "enum": [ "quarter", "month", "week", "day", "hour", "minute" ], "example": "quarter" }, "valueFormat": { "type": "string", "description": "How to format values for the query", "enum": [ "duration", "percent" ], "example": "duration" }, "yAxis": { "type": "string", "description": "How to display series in the y-Axis of the chart.", "enum": [ "overlap", "stacked", "ratio" ], "example": "overlap" } } }, "DataExport": { "type": "object", "required": [ "guid", "items", "status", "user_guid" ], "additionalProperties": false, "properties": { "_id": { "type": "string", "description": "Document ID of the export.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "completed": { "type": "string", "format": "date-time", "description": "Date the export was completed", "example": "2026-04-21T00:00:00Z" }, "created": { "$ref": "#/components/schemas/DefaultFields/properties/created" }, "filename": { "type": "string", "format": "url", "description": "Location the export is saved to.", "example": "Example Name" }, "guid": { "type": "string", "format": "uuid", "description": "`guid` of the export.", "example": "example_value" }, "items": { "type": "array", "description": "Items included in the export.", "items": { "type": "string", "enum": [ "user_metadata", "user_activity", "user_devices", "orgs", "org_metadata", "org_activity", "subscriptions", "envs", "teams", "apps", "providers", "idps", "domains" ] }, "example": [ "user_metadata" ] }, "org_guid": { "type": "string", "description": "`guid` of the org for org specific exports.", "example": "example_value" }, "status": { "type": "string", "description": "Status of the export.", "default": "pending", "enum": [ "pending", "complete", "failed" ], "example": "pending" }, "updated": { "$ref": "#/components/schemas/DefaultFields/properties/updated" }, "user_guid": { "type": "string", "description": "`guid` of the user that initiated the export.", "example": "example_value" } } }, "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" } } }, "Domain": { "type": "object", "required": [ "orgs", "tld" ], "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "properties": { "_id": { "type": "string", "description": "Document ID of the Domain.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "orgs": { "type": "array", "description": "Organizations associated to this Domain, their association state, and any associated Identity Providers.", "default": [], "items": { "type": "object", "required": [ "guid", "status" ], "additionalProperties": false, "properties": { "enabled": { "type": "string", "format": "date-time", "description": "Date the Identity Provider was enabled for users on the Domain." }, "associated": { "type": "string", "format": "date-time", "description": "Date the Domain was confirmed as associated to the Identity Provider." }, "guid": { "type": "string", "format": "uuid", "description": "`guid` of the Organization the Domain is associated to." }, "idp": { "type": "string", "format": "uuid", "description": "Identifier of the Identity Provider associated to the Domain for the Organization." }, "status": { "type": "number", "description": "Indicator of the Organizations confirmed association to the Domain.", "enum": [ 0, 1, 2, 3 ] }, "verified": { "type": "string", "format": "date-time", "description": "Date the Domain was verified as owned by the Organization." } } }, "example": [ { "enabled": "2026-04-21T00:00:00Z", "associated": "2026-04-21T00:00:00Z", "guid": "example_value", "idp": "example_value", "status": 0, "verified": "2026-04-21T00:00:00Z" } ] }, "provider_guid": { "type": "string", "format": "uuid", "description": "GUID identifier of the owning Provider if the Domain is configured in context of consumers of a marketplace.", "example": "example_value" }, "tld": { "type": "string", "format": "domain", "description": "Domain name.", "example": "example_value" } } }, "Entitlement": { "type": "object", "required": [ "type", "title", "description" ], "properties": { "description": { "type": "string", "description": "Description of entitlement.", "example": "An example description" }, "title": { "type": "string", "description": "Entitlement or metric name", "example": "example_value" }, "type": { "type": "string", "description": "Type of entitlement", "enum": [ "array", "boolean", "integer", "number", "string" ], "example": "array" } } }, "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 } } }, "Environment": { "type": "object", "required": [ "guid", "isProduction", "name", "org_guid", "type" ], "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "properties": { "_id": { "type": "string", "description": "Document ID of the environment.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "governance": { "type": "string", "description": "Governance of the environment.", "enum": [ "Customer Managed", "Axway Managed" ], "example": "Customer Managed" }, "guid": { "type": "string", "description": "GUID of the environment.", "example": "example_value" }, "isProduction": { "type": "boolean", "description": "Whether the environment is a production environment.", "default": false, "example": true }, "name": { "type": "string", "description": "Name of the environment", "x-no-tags": true, "example": "Example Name" }, "org_guid": { "type": "string", "description": "`guid` of the organization the environment is associated to.", "example": "example_value" }, "source": { "type": "string", "example": "example_value" }, "type": { "type": "string", "description": "Type of environment", "default": "usage", "enum": [ "usage", "integration" ], "example": "usage" }, "url": { "type": "string", "format": "secure-url", "description": "URL of the integration environment.", "example": "https://example.com" } } }, "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." } } } ] }, "Event": { "type": "object", "required": [ "event" ], "properties": { "data": { "type": "object", "description": "All custom data must go here.", "example": {} }, "event": { "type": "string", "description": "The name of the event.", "example": "example_value" }, "id": { "type": "string", "description": "Unique event identifier.", "example": "507f1f77bcf86cd799439011" }, "timestamp": { "type": "number", "description": "A UTC timestamp in miliseconds.", "example": 1.0 }, "version": { "type": "string", "description": "Specification version in use.", "enum": [ "4" ], "example": "4" } } }, "IdentityProvider": { "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, "example": "507f1f77bcf86cd799439011" }, "description": { "type": "string", "description": "Description of the Identity Provider.", "example": "An example description" }, "guid": { "type": "string", "format": "uuid", "description": "`guid` of the Identity Provider.", "example": "example_value" }, "name": { "type": "string", "description": "Name of Identity Provider", "example": "Example Name" }, "orgs": { "type": "array", "description": "Organizations associated to this Identity Provider and their user associations.", "default": [], "items": { "type": "object", "required": [ "guid", "default_roles", "default_teams", "mapped_roles", "mapped_teams" ], "additionalProperties": false, "properties": { "case_insensitive_mapped_roles": { "type": "boolean", "description": "Whether to match returned mapped attribute values to expected attribute values without letter case sensitivity." }, "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" ] } }, "default_teams": { "type": "array", "description": "Array of teams to assign newly provisioned users in the Organization.", "default": [], "items": { "type": "object", "required": [ "guid", "roles" ], "additionalProperties": false, "properties": { "guid": { "type": "string", "format": "uuid", "description": "`guid` of the team within the Organization the assign newly provisioned users." }, "roles": { "type": "array", "description": "Array of role identifiers that are assigned to newly provisioned users in the team.", "items": { "type": "string", "enum": [ "consumer", "subscription_admin", "developer", "catalog_manager", "subscription_approver", "api_access", "insights", "administrator", "marketplace_admin" ] } } } } }, "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." }, "enforce_mapped_teams": { "type": "boolean", "description": "Whether to restrict team membership and role management solely to mapped IdP attributes. Any team memberships or roles that a user has that does not match to an associated mapper will be removed on subsequent sign in." }, "guid": { "type": "string", "format": "uuid", "description": "`guid` of the Organization the Identity Provider is associated to." }, "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." } } } }, "mapped_teams": { "type": "array", "description": "Array of teams to assign users in the Organization based on attributes defined by the Identity Provider.", "default": [], "items": { "type": "object", "required": [ "team_guid", "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 team.", "items": { "type": "string", "enum": [ "consumer", "subscription_admin", "developer", "catalog_manager", "subscription_approver", "api_access", "insights", "administrator", "marketplace_admin" ] } }, "team_guid": { "type": "string", "format": "uuid", "description": "`guid` of the team within the Organization the assign matching users." }, "value": { "type": "string", "description": "Value of the named attribute to determine whether to apply the team association." } } } }, "provision_adhoc": { "type": "boolean", "description": "Whether to automatically register users who authenticate using the Identity Provider that are not on an associated claimed email domain as members of the organization.", "default": false }, "restrict_domain_users": { "type": "boolean", "description": "Whether to automatically restrict users provisioned via domain association to authenticate using the Identity Provider.", "default": false } } }, "example": [ { "case_insensitive_mapped_roles": true, "default_roles": [ "administrator" ], "default_teams": [ { "guid": "example_value", "roles": [ "consumer" ] } ], "enforce_mapped_roles": true, "enforce_mapped_teams": true, "guid": "example_value", "mapped_roles": [ { "friendly": "example_value", "name": "Example Name", "roles": [ "administrator" ], "value": "example_value" } ], "mapped_teams": [ { "friendly": "example_value", "name": "Example Name", "roles": [ "consumer" ], "team_guid": "example_value", "value": "example_value" } ], "provision_adhoc": true, "restrict_domain_users": true } ] }, "protocol": { "type": "string", "description": "Protocol the Identity Provider uses.", "enum": [ "oidc", "saml" ], "example": "oidc" }, "provider_guid": { "type": "string", "example": "example_value" } } }, "Org": { "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, "example": "507f1f77bcf86cd799439011" }, "account_id": { "type": "integer", "description": "Account ID of the organization.", "minimum": 10000, "maximum": 999999, "example": 1 }, "active": { "type": "boolean", "description": "Active state of the organization. Organizations become inactive after passing their end date.", "default": true, "example": true }, "analytics": { "type": "object", "description": "Analytics details for the organization", "additionalProperties": false, "properties": { "token": { "type": "string", "description": "Token used to identify the organization." } }, "example": { "token": "eyJhbGciOiJIUzI1NiJ9.example" } }, "api_central": { "type": "object", "description": "Engage provision status", "readOnly": true, "example": {} }, "branding": { "type": "object", "description": "Organization branding.", "additionalProperties": false, "properties": { "logo": { "type": "string", "description": "Logo image of the company." } }, "example": { "logo": "example_value" } }, "consumer_id": { "type": "string", "description": "Mapped ID of the consumer org from the configured Identity Provider.", "example": "507f1f77bcf86cd799439011" }, "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 } }, "example": { "client_id": "507f1f77bcf86cd799439011", "email": "user@example.com", "name": "Example Name" } }, "entitlements": { "type": "object", "readOnly": true, "allOf": [ { "$ref": "#/components/schemas/Entitlements" } ], "example": {} }, "guid": { "type": "string", "format": "uuid", "description": "GUID identifier for the organization", "example": "example_value" }, "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." } } } } }, "example": { "enabled": true, "defaults": true, "icon": "example_value", "items": [ { "icon": "example_value", "new_tab": true, "provider_guid": "example_value", "text": "example_value", "type": "document", "url": "https://example.com" } ] } }, "last_login": { "type": "string", "format": "date-time", "description": "When the most recent session was created in the organization.", "readOnly": true, "example": "2026-04-21T00:00:00Z" }, "logged_in_count": { "type": "number", "description": "How many session are been created in the organization.", "readOnly": true, "example": 1.0 }, "name": { "type": "string", "description": "Name of the organization.", "minLength": 2, "maxLength": 64, "x-no-tags": true, "example": "Example Name" }, "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": {} }, "onboarding_required": { "type": "array", "readOnly": true, "items": { "type": "string", "pattern": "[\\w-]{21}" }, "example": [ "example_value" ] }, "org_id": { "type": "integer", "description": "Identifier for the organization", "example": 1 }, "origin": { "type": [ "string", "null" ], "description": "Source from which the organization creation originated.", "enum": [ "360", "sfdc", "signup" ], "example": "360" }, "pending": { "type": "boolean", "description": "Whether the organization is pending approval for a provider organization administator.", "example": true }, "provider_guid": { "type": "string", "format": "uuid", "description": "GUID identifier of the owning provider if the organization is a consumer of a marketplace.", "example": "example_value" }, "region": { "type": "string", "description": "The data residency region of the organization.", "default": "US", "enum": [ "US", "EU", "AP" ], "example": "US" }, "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 } }, "example": { "access_controls": { "enviroments": 0, "service_accounts": 0, "usage": 0, "users": 0 }, "allow_tooling": true, "disable_analytics": true, "password_policy": { "length": 1, "max_length": 1, "lower": 1, "upper": 1, "special": 1, "digit": 1, "lockout": 1, "renewal": 1, "history": 1 }, "redact_personal": true } }, "subscriptions": { "type": "array", "default": [], "items": { "$ref": "#/components/schemas/Subscription" }, "example": [ { "end_date": "2026-04-21T00:00:00Z", "entitlements": [ { "key": "example_value", "value": "example_value" } ], "governance": "SaaS", "id": "507f1f77bcf86cd799439011", "opportunity_id": 1.0, "plan": "example_value", "product": "example_value", "product_name": "Example Name", "source": "API", "start_date": "2026-04-21T00:00:00Z" } ] }, "support_access_code": { "type": "integer", "description": "Support Access Code for the org.", "minimum": 10000, "maximum": 999999, "example": 1 }, "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" ] } } } }, "example": [ { "guid": "example_value", "idp": "example_value", "primary": true, "roles": [ "administrator" ] } ] } } }, "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 } } }, "Provider": { "type": "object", "required": [ "consumer", "consumer_approve", "guid", "name", "org_guid", "public", "signup", "terms" ], "x-defs": { "menu_item": { "type": "object", "required": [ "type", "text", "url" ], "unevaluatedProperties": false, "discriminator": { "propertyName": "type", "mapping": { "url": "#/components/schemas/Provider/x-defs/menu_item/oneOf/0", "document": "#/components/schemas/Provider/x-defs/menu_item/oneOf/1" } }, "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "url" ] }, "url": { "type": "string", "description": "URL or relative path for the link.", "pattern": "(^((https?:\\/\\/[A-Za-z0-9.-]+|(?:www\\.|[-;:&=+$,\\w]+@)[A-Za-z0-9.-]+)((?:\\/[+~%/.\\w\\-_]*)?\\??(?:[-+=&;%@.\\w_]*)#?(?:[\\w?/:@\\-._~!$&'()*+,;=]*))?)$|^(?:\\/[+~%/.\\w\\-_]*)(?:\\?[-+=&;%@.\\w_]*)?(?:#[.!/\\\\\\w]*)?$)" } } }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "document" ] }, "url": { "type": "string", "description": "Document resource guid" } } } ], "properties": { "new_tab": { "type": "boolean", "description": "Whether the link opens in a new tab." }, "text": { "type": "string", "description": "Label for the link.", "x-no-tags": true }, "type": { "type": "string", "description": "Type of the link.", "enum": [ "document", "url" ] }, "url": { "type": "string", "description": "URL, relative path, or document resource guid for the link." }, "visibility": { "type": "integer", "description": "Which users the link is visible to. Always shown: 0, Signed in: 1, Signed out: 2, Hidden: 3", "enum": [ 0, 1, 2, 3 ] } } }, "onboarding.items.hint": { "type": "string", "description": "Contextual information for the element." }, "onboarding.items.text": { "type": "string", "description": "Label for the element." }, "onboarding_props": { "type": "object", "required": [ "id", "type", "text" ], "properties": { "hint": { "type": "object", "description": "Contextual information for the element.", "default": {}, "properties": { "en-US": { "type": "string", "description": "English language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.hint" } ] }, "fr-FR": { "type": "string", "description": "French language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.hint" } ] }, "de-DE": { "type": "string", "description": "German language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.hint" } ] }, "pt-BR": { "type": "string", "description": "Portuguese language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.hint" } ] } } }, "id": { "type": "string", "description": "Identifier for the element.", "pattern": "[\\w-]{21}" }, "required": { "type": "boolean", "description": "Whether entry is required for the element." }, "text": { "type": "object", "description": "Label for the element.", "default": {}, "properties": { "en-US": { "type": "string", "description": "English language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.text" } ] }, "fr-FR": { "type": "string", "description": "French language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.text" } ] }, "de-DE": { "type": "string", "description": "German language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.text" } ] }, "pt-BR": { "type": "string", "description": "Portuguese language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.text" } ] } } }, "type": { "type": "string", "description": "Type of element.", "enum": [ "header", "text", "number", "date", "checkbox", "toggle", "select", "multiselect" ] }, "visibility": { "type": "number", "description": "Whether the field is only available to provider administrators", "enum": [ 0, 1 ] } } }, "onboarding.items.placeholder": { "type": "string", "description": "Placeholder or example value for the element." }, "placeholder": { "type": "object", "description": "Placeholder or example value for the element.", "default": {}, "properties": { "en-US": { "type": "string", "description": "English language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.placeholder" } ] }, "fr-FR": { "type": "string", "description": "French language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.placeholder" } ] }, "de-DE": { "type": "string", "description": "German language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.placeholder" } ] }, "pt-BR": { "type": "string", "description": "Portuguese language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/onboarding.items.placeholder" } ] } } }, "homepage_border": { "type": "object", "description": "Item border properties.", "properties": { "color": { "type": "string", "format": "color", "description": "Border color" }, "radius": { "type": "string", "description": "Border radius", "default": "square", "enum": [ "square", "rounded", "pill" ] }, "style": { "type": "string", "description": "Border style", "default": "solid", "enum": [ "solid", "dashed", "dotted" ] }, "width": { "type": "object", "additionalProperties": false, "properties": { "bottom": { "type": "string", "pattern": "^[0-9]+\\.?([0-9]+)?px$" }, "left": { "type": "string", "pattern": "^[0-9]+\\.?([0-9]+)?px$" }, "right": { "type": "string", "pattern": "^[0-9]+\\.?([0-9]+)?px$" }, "top": { "type": "string", "pattern": "^[0-9]+\\.?([0-9]+)?px$" } } } } }, "homepage_spacing": { "type": "object", "additionalProperties": false, "properties": { "bottom": { "type": "string", "pattern": "^[0-9]+\\.?([0-9]+)?(px|%|em|rem)$" }, "left": { "type": "string", "pattern": "^[0-9]+\\.?([0-9]+)?(px|%|em|rem)$" }, "right": { "type": "string", "pattern": "^[0-9]+\\.?([0-9]+)?(px|%|em|rem)$" }, "top": { "type": "string", "pattern": "^[0-9]+\\.?([0-9]+)?(px|%|em|rem)$" } } }, "genderedLangSchema": { "type": "object", "properties": { "en-US": { "type": "null", "description": "English language value.", "enum": [ null ] }, "fr-FR": { "type": "string", "description": "French language value.", "enum": [ "m", "f" ] }, "de-DE": { "type": "string", "description": "German language value.", "enum": [ "m", "f", "n" ] }, "pt-BR": { "type": "string", "description": "Portuguese language value.", "enum": [ "m", "f" ] } } }, "description": { "type": "string", "description": "Description of the provider marketplace instance.", "default": "", "maxLength": 200 }, "footer.items": { "type": "array", "description": "Elements shown in the footer block.", "maxItems": 10, "items": { "type": "object", "unevaluatedProperties": false, "discriminator": { "propertyName": "type", "mapping": { "nav_menu": "#/components/schemas/Provider/x-defs/footer.items/items/oneOf/0", "logo": "#/components/schemas/Provider/x-defs/footer.items/items/oneOf/1", "text": "#/components/schemas/Provider/x-defs/footer.items/items/oneOf/2", "separator": "#/components/schemas/Provider/x-defs/footer.items/items/oneOf/3" } }, "oneOf": [ { "title": "Menu", "description": "Navigation menu.", "required": [ "items" ], "properties": { "items": { "type": "array", "title": "Navigation Menu Items", "description": "Links added in the footer navigation menu.", "maxItems": 9, "items": { "$ref": "#/components/schemas/Provider/x-defs/menu_item" } }, "type": { "enum": [ "nav_menu" ] } } }, { "title": "Logo", "description": "Company logo.", "required": [ "image" ], "properties": { "image": { "type": "string", "description": "Company logo." }, "tagline": { "type": "string", "format": "html", "description": "Company tagline." }, "type": { "enum": [ "logo" ] } } }, { "title": "Text", "description": "Text block.", "required": [ "content" ], "properties": { "content": { "type": "string", "format": "html", "description": "Text block to show in the footer." }, "type": { "enum": [ "text" ] } } }, { "title": "Separator", "description": "Separator.", "properties": { "type": { "enum": [ "separator" ] } } } ], "properties": { "position": { "type": "string", "description": "Alignment of the content within the footer block.", "enum": [ "left", "center", "right" ] }, "type": { "type": "string", "description": "Content type" } } } }, "help_menu": { "type": "array", "description": "Content shown in the navigation bar help menu.", "items": { "type": "object", "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/menu_item" } ], "properties": { "icon": { "type": "string", "description": "Icon displayed in the menu for the item." } } } }, "homepage_categories_title": { "type": "string", "description": "Title for the categories." }, "homepage_content_button_text": { "type": "string", "description": "Button text" }, "homepage_content_image_alt": { "type": "string", "description": "Image alt text." }, "homepage_content_search_text": { "type": "string", "description": "Placeholder text" }, "homepage_content_text": { "type": "string", "description": "Text content, using markdown formatting." }, "homepage_products_title": { "type": "string", "description": "Title for the products." }, "name": { "type": "string", "description": "Name of the provider marketplace instance.", "minLength": 2, "maxLength": 350, "x-no-tags": true }, "nav_items": { "type": "array", "description": "Links added in the common navigation menu.", "maxItems": 9, "items": { "$ref": "#/components/schemas/Provider/x-defs/menu_item" } }, "onboarding.items.off": { "type": "string", "description": "Label for disabled toggle state." }, "onboarding.items.on": { "type": "string", "description": "Label for enabled toggle state." }, "onboarding.items.options.text": { "type": "string", "description": "Label for value." }, "reviews.instructions": { "type": "string", "description": "Review guidelines and policies within the provider marketplace.", "x-no-tags": true }, "sitename": { "type": "string", "description": "Page title of the provider marketplace instance.", "maxLength": 350, "x-no-tags": true } }, "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "properties": { "_id": { "type": "string", "description": "Document ID of the provider.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "admin_teams": { "description": "Administration access.", "default": false, "oneOf": [ { "type": "boolean", "description": "Flag indicating if `marketplace_admin` role members in all teams can administer the provider marketplace." }, { "type": "array", "description": "`guid` of a selected team whose `marketplace_admin` role members can administer the provider marketplace.", "items": { "type": "string", "format": "uuid" } } ], "example": "example_value" }, "consume_teams": { "type": "object", "description": "Preference for which org members can consume the provider marketplace.", "default": { "type": "teams", "value": true }, "unevaluatedProperties": false, "discriminator": { "propertyName": "type", "mapping": { "teams": "#/components/schemas/Provider/properties/consume_teams/oneOf/0", "included": "#/components/schemas/Provider/properties/consume_teams/oneOf/1", "excluded": "#/components/schemas/Provider/properties/consume_teams/oneOf/1", "tags": "#/components/schemas/Provider/properties/consume_teams/oneOf/2" } }, "oneOf": [ { "type": "object", "title": "All Teams", "properties": { "type": { "enum": [ "teams" ] }, "value": { "type": "boolean", "description": "Indicates if `consumer` role members in all teams can consume the provider marketplace." } } }, { "type": "object", "title": "Specific Teams", "properties": { "type": { "enum": [ "included", "excluded" ] }, "value": { "type": "array", "description": "`guid` of a selected teams whose `consumer` role members can consume the provider marketplace.", "items": { "type": "string", "format": "uuid" } } } }, { "type": "object", "title": "Tagged Teams", "properties": { "type": { "enum": [ "tags" ] }, "value": { "type": "array", "description": "`consumer` role members in teams with any value in its `tags` can consume the provider marketplace.", "items": { "type": "string" } } } } ], "properties": { "type": { "type": "string", "description": "Setting for how to apply consumption preference value." } }, "example": { "type": "example_value" } }, "publish_teams": { "type": "object", "description": "Preference for which org members can publish products to the provider marketplace.", "default": { "type": "teams", "value": true }, "unevaluatedProperties": false, "discriminator": { "propertyName": "type", "mapping": { "teams": "#/components/schemas/Provider/properties/publish_teams/oneOf/0", "included": "#/components/schemas/Provider/properties/publish_teams/oneOf/1", "excluded": "#/components/schemas/Provider/properties/publish_teams/oneOf/1", "tags": "#/components/schemas/Provider/properties/publish_teams/oneOf/2" } }, "oneOf": [ { "type": "object", "title": "All Teams", "properties": { "type": { "enum": [ "teams" ] }, "value": { "type": "boolean", "description": "Indicates if `catalog_manager` role members in all teams can publish to the provider marketplace." } } }, { "type": "object", "title": "Specific Teams", "properties": { "type": { "enum": [ "included", "excluded" ] }, "value": { "type": "array", "description": "`guid` of a selected teams whose `catalog_manager` role members can publish to the provider marketplace.", "items": { "type": "string", "format": "uuid" } } } }, { "type": "object", "title": "Tagged Teams", "properties": { "type": { "enum": [ "tags" ] }, "value": { "type": "array", "description": "`catalog_manager` role members in teams with any value in its `tags` can publish to the provider marketplace.", "items": { "type": "string" } } } } ], "properties": { "type": { "type": "string", "description": "Setting for how to apply publication preference value." } }, "example": { "type": "example_value" } }, "ai": { "type": "object", "default": { "enabled": false }, "properties": { "enabled": { "type": "boolean", "description": "Whether AI integration is enabled for the provider marketplace.", "default": false }, "embedded": { "type": "boolean", "description": "Whether AI integration uses built-in LLM (or customer hosted).", "default": false }, "key": { "type": "string", "description": "API key of customer hosted LLM.", "writeOnly": true }, "key_set": { "type": "string", "format": "date-time", "description": "Date and time when API key was last set.", "readOnly": true }, "stream": { "type": "boolean", "description": "Whether LLM supports SSE events stream.", "default": true }, "url": { "type": "string", "format": "secure-url", "description": "URL of customer hosted LLM." } }, "example": { "enabled": true, "embedded": true, "key": "example_value", "key_set": "2026-04-21T00:00:00Z", "stream": true, "url": "https://example.com" } }, "appearance": { "type": "object", "description": "Appearance settings for the provider marketplace.", "additionalProperties": false, "properties": { "favicon": { "type": "string", "description": "URL of the provider marketplace favicon." }, "logo": { "type": "string", "description": "URL of the provider marketplace logo." }, "theme_bg": { "type": "string", "format": "color", "description": "Color for page background." }, "theme_black": { "type": "string", "format": "color", "description": "Color for default elements." }, "theme_link": { "type": "string", "format": "color", "description": "Color for text links." }, "theme_primary": { "type": "string", "format": "color", "description": "Color for action controls." }, "theme_primary_alt": { "type": "string", "format": "color", "description": "Supplementary content color for primary action controls." }, "theme_secondary": { "type": "string", "format": "color", "description": "Color for secondary elements." }, "theme_secondary_alt": { "type": "string", "format": "color", "description": "Supplementary content color for secondary action controls." }, "theme_tertiary": { "type": "string", "format": "color", "description": "Color for tertiary elements." }, "theme_tertiary_alt": { "type": "string", "format": "color", "description": "Supplementary content color for tertiary action controls." }, "theme_danger": { "type": "string", "format": "color", "description": "Color for danger elements." }, "theme_danger_alt": { "type": "string", "format": "color", "description": "Supplementary content color for danger state elements." }, "theme_info": { "type": "string", "format": "color", "description": "Color for info elements." }, "theme_info_alt": { "type": "string", "format": "color", "description": "Supplementary content color for info state elements." }, "theme_success": { "type": "string", "format": "color", "description": "Color for success elements." }, "theme_success_alt": { "type": "string", "format": "color", "description": "Supplementary content color for success state elements." }, "theme_warning": { "type": "string", "format": "color", "description": "Color for warning elements." }, "theme_warning_alt": { "type": "string", "format": "color", "description": "Supplementary content color for warning state elements." }, "theme_button": { "type": "string", "format": "color", "description": "Element color for heading buttons." }, "theme_button_text": { "type": "string", "format": "color", "description": "Element color for heading button text." }, "theme_container": { "type": "string", "format": "color", "description": "Element color for container titles." }, "theme_container_bg": { "type": "string", "format": "color", "description": "Element color for container backgrounds." }, "theme_container_brd": { "type": "string", "format": "color", "description": "Element color for container borders and separators." }, "theme_container_text": { "type": "string", "format": "color", "description": "Element color for container text." }, "theme_heading": { "type": "string", "format": "color", "description": "Element color for heading titles." }, "theme_heading_bg": { "type": "string", "format": "color", "description": "Element color for heading back." }, "theme_icon": { "type": "string", "format": "color", "description": "Element color for icons." }, "theme_top_nav": { "type": "string", "format": "color", "description": "Color for top navigation menu text." }, "theme_top_nav_bg_direction": { "type": "string", "description": "Direction for the top navigation menu background gradient.", "enum": [ "to right", "to bottom", "to right top", "to right bottom" ] }, "theme_top_nav_bg_end": { "type": "string", "format": "color", "description": "Ending color for top navigation menu background." }, "theme_top_nav_bg_fill": { "type": "string", "description": "Fill format for the top navigation menu background.", "enum": [ "solid", "gradient" ] }, "theme_top_nav_bg_start": { "type": "string", "format": "color", "description": "Starting color for top navigation menu background." }, "theme_top_nav_icon": { "type": "string", "format": "color", "description": "Color for top navigation menu icons." }, "theme_top_nav_menu_bg": { "type": "string", "format": "color", "description": "Color for top navigation menu background." }, "theme_left_nav": { "type": "string", "format": "color", "description": "Color for left navigation menu text." }, "theme_left_nav_active": { "type": "string", "format": "color", "description": "Color for left navigation menu active item text." }, "theme_left_nav_active_bg": { "type": "string", "format": "color", "description": "Color for left navigation menu active item background." }, "theme_left_nav_bg": { "type": "string", "format": "color", "description": "Color for left navigation menu background." }, "font_family": { "type": "string", "description": "Font family." }, "letter_spacing": { "type": "string", "description": "Letter spacing.", "enum": [ "-1px", "normal", "1px" ] }, "button_format": { "type": "string", "description": "Button background fill or outline.", "enum": [ "solid", "outline" ] }, "button_radius": { "type": "string", "description": "Button radius.", "enum": [ "square", "rounded", "pill" ] } }, "example": { "favicon": "example_value", "logo": "example_value", "theme_bg": "example_value", "theme_black": "example_value", "theme_link": "example_value", "theme_primary": "example_value", "theme_primary_alt": "example_value", "theme_secondary": "example_value", "theme_secondary_alt": "example_value", "theme_tertiary": "example_value" } }, "billing": { "type": "object", "description": "Billing integration settings for the provider marketplace.", "default": { "enabled": false }, "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "description": "Whether billing integration is enabled for the provider marketplace.", "default": false }, "key": { "type": "string", "description": "Billing integration vendor API key; required for vendor other than `custom`.", "writeOnly": true }, "key_set": { "type": "string", "format": "date-time", "description": "Date billing integration vendor key was set.", "readOnly": true }, "portal_url": { "type": "string", "format": "secure-url", "description": "URL of vendor hosted customer portal; optional for vendor `stripe`." }, "signature": { "type": "string", "description": "Billing integration vendor webhook signature or secret key; required for vendor other than `custom`.", "writeOnly": true }, "signature_set": { "type": "string", "format": "date-time", "description": "Date billing integration vendor webhook signature was set.", "readOnly": true }, "url": { "type": "string", "format": "url", "description": "Billing integration vendor region or environment URL; required for vendor `myFatoorah`.", "enum": [ "https://api.myfatoorah.com", "https://api-sa.myfatoorah.com", "https://api-qa.myfatoorah.com", "https://apitest.myfatoorah.com" ] }, "vendor": { "type": "string", "description": "Billing integration vendor for the provider marketplace.", "enum": [ "stripe", "myFatoorah", "custom" ] } }, "example": { "enabled": true, "key": "example_value", "key_set": "2026-04-21T00:00:00Z", "portal_url": "https://example.com", "signature": "example_value", "signature_set": "2026-04-21T00:00:00Z", "url": "https://api.myfatoorah.com", "vendor": "stripe" } }, "certificate": { "type": "string", "description": "Encrypted certificate", "writeOnly": true, "example": "example_value" }, "certificate_expires": { "type": "string", "format": "date-time", "description": "Expiry date of certificate provided for marketplace domain.", "example": "2026-04-21T00:00:00Z" }, "console": { "type": "object", "description": "Console page settings for the provider marketplace.", "default": { "getting_started": { "enabled": false } }, "additionalProperties": false, "properties": { "getting_started": { "type": "object", "description": "Getting Started section settings for the provider marketplace console page.", "default": { "enabled": false }, "required": [ "enabled" ], "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "description": "Whether Getting Started section is enabled for the provider marketplace console page.", "default": false }, "type": { "type": "string", "description": "Type of document to display on Getting Started section on the provider marketplace console page.", "enum": [ "document" ] }, "url": { "type": "string", "description": "Document resource guid", "x-no-tags": true } } } }, "example": { "getting_started": { "enabled": true, "type": "document", "url": "https://example.com" } } }, "consumer": { "type": "boolean", "description": "Whether to allow authenticated consumer org user access to the marketplace.", "default": false, "example": true }, "consumer_approve": { "type": "boolean", "description": "Whether to Require newly registered consumer organizations in the marketplace to require approval from an organization administrator.", "default": false, "example": true }, "description": { "type": "object", "description": "Description of the provider marketplace instance.", "default": {}, "properties": { "en-US": { "type": "string", "description": "English language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/description" } ] }, "fr-FR": { "type": "string", "description": "French language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/description" } ] }, "de-DE": { "type": "string", "description": "German language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/description" } ] }, "pt-BR": { "type": "string", "description": "Portuguese language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/description" } ] } }, "example": { "en-US": "example_value", "fr-FR": "example_value", "de-DE": "example_value", "pt-BR": "example_value" } }, "footer": { "type": "object", "description": "Appearance and content settings for the provider marketplace common footer element.", "default": { "items": { "en-US": null, "fr-FR": null, "de-DE": null, "pt-BR": null } }, "properties": { "background": { "type": [ "string", "null" ], "description": "Fill format for the footer background.", "enum": [ "solid", "gradient", null ] }, "background_direction": { "type": "string", "description": "Direction for the footer background gradient.", "enum": [ "to right", "to bottom", "to right top", "to right bottom" ] }, "background_end": { "type": "string", "description": "Ending color for footer background." }, "background_start": { "type": "string", "description": "Starting color for footer background." }, "brd": { "type": "string", "description": "Color for footer borders and dividers." }, "color": { "type": "string", "description": "Color for footer text." }, "link": { "type": "string", "description": "Color for footer links." }, "items": { "type": "object", "description": "Elements shown in the footer block.", "default": {}, "properties": { "en-US": { "type": "array", "description": "English language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/footer.items" } ] }, "fr-FR": { "type": "array", "description": "French language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/footer.items" } ] }, "de-DE": { "type": "array", "description": "German language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/footer.items" } ] }, "pt-BR": { "type": "array", "description": "Portuguese language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/footer.items" } ] } } } }, "example": { "background": "solid", "background_direction": "to right", "background_end": "example_value", "background_start": "example_value", "brd": "example_value", "color": "example_value", "link": "example_value", "items": { "en-US": [ "example_value" ], "fr-FR": [ "example_value" ], "de-DE": [ "example_value" ], "pt-BR": [ "example_value" ] } } }, "guid": { "type": "string", "description": "Identifier of the provider marketplace instance.", "example": "example_value" }, "help_menu": { "type": "object", "description": "Content shown in the navigation bar help menu.", "default": {}, "properties": { "en-US": { "type": "array", "description": "English language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/help_menu" } ] }, "fr-FR": { "type": "array", "description": "French language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/help_menu" } ] }, "de-DE": { "type": "array", "description": "German language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/help_menu" } ] }, "pt-BR": { "type": "array", "description": "Portuguese language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/help_menu" } ] } }, "example": { "en-US": [ "example_value" ], "fr-FR": [ "example_value" ], "de-DE": [ "example_value" ], "pt-BR": [ "example_value" ] } }, "help_menu_icon": { "type": "string", "description": "Icon displayed in the navigation bar to show the help menu.", "example": "example_value" }, "homepage": { "type": "object", "description": "Homepage settings for the provider marketplace.", "default": { "enabled": false, "items": [] }, "required": [ "enabled" ], "additionalProperties": false, "properties": { "enabled": { "type": "boolean", "description": "Whether homepage is enabled for the provider marketplace.", "default": false }, "default_page": { "type": [ "object", "null" ], "description": "Which path to display when homepage is not shown; `null` displays \"Browse Products\".", "default": null, "discriminator": { "propertyName": "type", "mapping": { "document": "#/components/schemas/Provider/properties/homepage/properties/default_page/oneOf/0", "url": "#/components/schemas/Provider/properties/homepage/properties/default_page/oneOf/1" } }, "oneOf": [ { "properties": { "url": { "type": "string", "description": "Document resource guid" } } }, { "properties": { "url": { "type": "string", "enum": [ "/categories", "/activity" ] } } } ], "properties": { "type": { "type": "string", "enum": [ "document", "url" ] } } }, "items": { "type": "array", "items": { "type": "object", "unevaluatedProperties": false, "discriminator": { "propertyName": "type", "mapping": { "categories": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/0", "content": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/1", "nav": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/2", "products": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/3", "separator": "#/components/schemas/Provider/properties/homepage/properties/items/items/oneOf/4" } }, "oneOf": [ { "type": "object", "additionalProperties": false, "properties": { "sort": { "type": "string", "description": "Sorting setting for the provider marketplace featured content section.", "enum": [ "alpha", "recent" ] }, "title": { "type": "object", "description": "Title for the categories.", "default": {}, "properties": { "en-US": { "type": "string", "description": "English language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/homepage_categories_title" } ] }, "fr-FR": { "type": "string", "description": "French language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/homepage_categories_title" } ] }, "de-DE": { "type": "string", "description": "German language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/homepage_categories_title" } ] }, "pt-BR": { "type": "string", "description": "Portuguese language value.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/homepage_categories_title" } ] } } }, "type": { "type": "string", "enum": [ "categories" ] } } }, { "type": "object", "additionalProperties": false, "properties": { "background": { "type": "object", "unevaluatedProperties": false, "properties": { "color_end": { "type": "string", "format": "color", "description": "Starting color for the background." }, "color_start": { "type": "string", "format": "color", "description": "Ending color for the background." }, "direction": { "type": "string", "description": "Direction for the background color gradient.", "enum": [ "to right", "to bottom", "to right top", "to right bottom" ] }, "image_position": { "type": "string", "description": "Background image position for the content.", "enum": [ "left top", "left center", "left bottom", "right top", "right center", "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 } ] } }, "idp": { "type": "boolean", "description": "Whether to allow consumer organizations in the marketplace to establish custom Identity Providers.", "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" }, "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" ] } }, "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" } }, "name_gender": { "description": "Gender of the `name` of the provider marketplace instance.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/genderedLangSchema" } ], "example": "Example Name" }, "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" ] } }, "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": "********" } } }, "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": [ {} ] } }, "org_guid": { "type": "string", "format": "uuid", "description": "`guid` of the organization the provider marketplace belongs to.", "example": "example_value" }, "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 } }, "example": { "enabled": true, "allow_external": true, "enforce_association": true } }, "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 }, "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" } }, "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 } }, "signup": { "type": "boolean", "description": "Whether to allow self-service sign up for consumer organizations in the marketplace.", "default": false, "example": true }, "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" } }, "sitename_gender": { "description": "Gender of the `sitename` of the provider marketplace instance.", "allOf": [ { "$ref": "#/components/schemas/Provider/x-defs/genderedLangSchema" } ], "example": "Example Name" }, "subdomain": { "type": "string", "description": "Subdomain on which the provider marketplace can be accessed.", "pattern": "^[a-z0-9\\-]{4,63}$", "example": "example.com" }, "terms": { "type": "boolean", "description": "Whether the provider marketplace access should be gated on acceptance of Terms & Conditions.", "default": false, "example": true }, "terms_updated": { "type": "string", "format": "date-time", "description": "Date Terms & Conditions last updated.", "example": "2026-04-21T00:00:00Z" }, "terms_url": { "type": "string", "format": "url", "description": "URL of the provider marketplace Terms & Conditions.", "example": "https://example.com" }, "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" }, "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" } } } }, "Response": { "type": "object", "properties": { "success": { "type": "boolean", "description": "Whether the request was successful.", "example": true } } }, "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 } } }, "Role": { "type": "object", "required": [ "id", "name" ], "properties": { "client": { "type": "boolean", "description": "Whether the role can be assigned to a client.", "x-deprecated": true, "example": true }, "consumer": { "type": "boolean", "description": "Whether the role is assignable on consumer org members (bypassing all other requirements for role).", "example": true }, "default": { "type": "boolean", "description": "Whether the role is default.", "example": true }, "disabled": { "type": "boolean", "description": "Indicates the role is deprecated and no longer assignable", "example": true }, "entitlement": { "type": "string", "description": "Entitlement which must be active to allow the role.", "example": "example_value" }, "id": { "type": "string", "description": "Identifier of the role.", "example": "507f1f77bcf86cd799439011" }, "name": { "type": "string", "description": "The role's name.", "minLength": 1, "maxLength": 40, "example": "Example Name" }, "order": { "type": "number", "description": "Indicates the relative access rights for the role. The lower the value, the more access the role has.", "example": 1.0 }, "org": { "type": "boolean", "description": "Whether the role can be assigned as a org-level role.", "example": true }, "partner": { "type": "string", "description": "Product name key for service to which a \"service role\" applies.", "example": "example_value" }, "platform_restricted": { "type": "boolean", "description": "Whether the user has limited platform visibility and capabilities", "example": true }, "product": { "type": "string", "description": "Partner that must be provisioned and have an active entitlement for to allow the role.", "example": "example_value" }, "required_default_roles": { "type": "array", "description": "Org-level default roles a user must be assigned in order to allow the service role.", "items": { "type": "string" }, "example": [ "example_value" ] }, "subscription": { "type": "array", "description": "Subscriptions for which one or more of is required to allow the role.", "items": { "type": "string" }, "example": [ "10.0.0.1" ] }, "team": { "type": "boolean", "description": "Whether the role can be assigned as a team-level role.", "example": true }, "web_only": { "type": "boolean", "description": "Indicates that users with the role are only able to access the platform in web contexts.", "example": true } } }, "SessionInfo": { "type": "object", "properties": { "connect.sid": { "type": "string", "description": "Signed session ID.", "example": "example_value" }, "deviceAuthRequired": { "type": "string", "description": "Whether the user is still pending device authorization.", "example": "example_value" }, "email": { "type": "string", "description": "Email address of the signed-in user.", "example": "user@example.com" }, "entitlements": { "type": "object", "description": "Entitlements of the signed-in org.", "example": {} }, "expiry": { "type": "string", "description": "Session expiry (if not accessed).", "example": "example_value" }, "firstname": { "type": "string", "description": "First name of the signed-in user.", "example": "Example Name" }, "from": { "type": "string", "description": "Type of client the session was initiated by, e.g. web/cli", "example": "example_value" }, "guid": { "type": "string", "description": "GUID of the signed-in user.", "example": "example_value" }, "idp": { "type": "string", "description": "GUID of the Identity Provider used to authenticate the session.", "example": "example_value" }, "lastname": { "type": "string", "description": "Last name of the signed-in user.", "example": "Example Name" }, "org": { "$ref": "#/components/schemas/Org" }, "org_id": { "type": "string", "description": "org_id of the signed-in org.", "example": "507f1f77bcf86cd799439011" }, "org_name": { "type": "string", "description": "Name of the signed-in org.", "example": "Example Name" }, "orgs": { "type": "string", "description": "List of orgs that the user belongs to", "example": "example_value" }, "provider_org": { "type": "object", "description": "Owning provider organization of the marketplace; included in consumer org sessions only", "properties": { "guid": { "type": "string", "format": "uuid", "description": "GUID identifier for the provider organization" }, "name": { "type": "string", "description": "Name of the provider organization." }, "org_id": { "type": "integer", "description": "Identifier for the provider organization" } }, "example": { "guid": "example_value", "name": "Example Name", "org_id": 1 } }, "redirect": { "type": "string", "description": "URL to redirect to after signing in.", "example": "example_value" }, "role": { "type": "string", "description": "Current role of the user signed-in with this session.", "enum": [ "administrator", "developer", "auditor", "consumer" ], "example": "administrator" }, "roles": { "type": "array", "description": "List of roles the user is assigned on the signed-in org.", "items": { "type": "string", "description": "The id of the role.", "enum": [ "administrator", "developer", "auditor", "consumer", "usage_reporter", "api_central_admin" ] }, "example": [ "administrator" ] }, "session": { "type": "string", "description": "Encoded session.", "example": "example_value" }, "sessionID": { "type": "string", "description": "The session ID.", "example": "example_value" }, "sid": { "type": "string", "description": "Signed session ID.", "example": "example_value" }, "teams": { "$ref": "#/components/schemas/UserTeams" }, "user": { "$ref": "#/components/schemas/User" }, "user_guid": { "type": "string", "description": "GUID of the signed-in user.", "example": "example_value" }, "username": { "type": "string", "description": "Username of the user this session belongs to.", "example": "Example Name" } } }, "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" } } }, "Success": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/Response" }, { "type": "object", "properties": { "result": { "description": "The response data" } } } ] }, "Team": { "type": "object", "required": [ "default", "guid", "name", "org_guid", "tags", "users" ], "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "properties": { "_id": { "type": "string", "description": "Document ID of the team.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "created": { "type": "string", "format": "date-time", "description": "Date created.", "example": "2026-04-21T00:00:00Z" }, "default": { "type": "boolean", "description": "Whether the team is the default for the organization. May only be set by org administrator users.", "default": false, "example": true }, "desc": { "type": [ "string", "null" ], "description": "Description of the team.", "maxLength": 200, "x-no-tags": true, "example": "example_value" }, "guid": { "type": "string", "format": "uuid", "description": "`guid` of the team.", "example": "example_value" }, "name": { "type": "string", "description": "Name of the team.", "minLength": 2, "maxLength": 100, "x-no-tags": true, "example": "Example Name" }, "org_guid": { "type": "string", "format": "uuid", "description": "`guid` of the organization the team belongs to.", "example": "example_value" }, "tags": { "type": "array", "description": "Tags assigned to the team.", "default": [], "minItems": 0, "uniqueItems": true, "maxItems": 30, "items": { "type": "string", "maxLength": 40 }, "example": [ "example_value" ] }, "updated": { "type": "string", "format": "date-time", "description": "Date updated.", "example": "2026-04-21T00:00:00Z" }, "users": { "type": "array", "description": "Members that belong to this team and their roles.", "default": [], "items": { "type": "object", "required": [ "guid", "roles" ], "additionalProperties": false, "properties": { "guid": { "type": "string", "format": "uuid", "description": "`guid` of the member." }, "roles": { "type": "array", "description": "Array of role identifiers that are assigned to the member.", "items": { "type": "string", "enum": [ "consumer", "subscription_admin", "developer", "catalog_manager", "subscription_approver", "api_access", "insights", "administrator", "marketplace_admin" ] } }, "type": { "type": "string", "description": "Type of the member.", "default": "user", "enum": [ "user", "client" ] } } }, "example": [ { "guid": "example_value", "roles": [ "consumer" ], "type": "user" } ] } } }, "UsageEntry": { "type": "object", "properties": { "created": { "type": "string", "format": "date-time", "description": "Date and time when report was created.", "example": "2026-04-21T00:00:00Z" }, "created_by": { "type": "object", "description": "Details of the user that created the organization.", "required": [ "guid", "type" ], "properties": { "client_id": { "type": "string", "description": "The client_id of the client that created the organization." }, "email": { "type": "string", "format": "email", "description": "Email address of the user that created the organization." }, "guid": { "type": "string", "description": "`guid` of the creator." }, "name": { "type": "string", "description": "The name of the user or client that created the organization." }, "type": { "type": "string", "description": "Type of the creator.", "enum": [ "user", "client" ] } }, "example": { "client_id": "507f1f77bcf86cd799439011", "email": "user@example.com", "guid": "example_value", "name": "Example Name", "type": "user" } }, "downloadable": { "type": "boolean", "description": "Indicates if the report file is available for download.", "example": true }, "endDate": { "type": "string", "format": "date-time", "description": "End of the reporting range.", "example": "2026-04-21T00:00:00Z" }, "envId": { "type": "string", "format": "uuid", "description": "`guid` of the environment the report is for.", "example": "example_value" }, "fileId": { "type": "string", "description": "Identifier of report entry file.", "example": "example_value" }, "governance": { "type": "string", "description": "Governance of the environment this report is for.", "enum": [ "Customer Managed", "Axway Managed" ], "example": "Customer Managed" }, "name": { "type": "string", "description": "Name of the report entry file.", "example": "Example Name" }, "organizationId": { "type": "string", "format": "uuid", "description": "`guid` of the organization the report is for.", "example": "example_value" }, "startDate": { "type": "string", "format": "date-time", "description": "Start of the reporting range.", "example": "2026-04-21T00:00:00Z" }, "status": { "type": "string", "description": "Status of the report.", "enum": [ "PROCESSED" ], "example": "PROCESSED" }, "unrecognized": { "type": "array", "description": "List of unrecognized metrics for reports with status `INVALID_METRIC`.", "items": { "type": "string" }, "example": [ "example_value" ] }, "uploadMethod": { "type": "string", "description": "Upload method.", "enum": [ "automatic", "manual" ], "example": "automatic" } } }, "User": { "type": "object", "required": [ "activated", "active", "email", "firstname", "guid", "lastname", "user_id" ], "unevaluatedProperties": false, "properties": { "_id": { "type": "string", "description": "ID of the user.", "readOnly": true, "deprecated": true, "example": "507f1f77bcf86cd799439011" }, "activated": { "type": "boolean", "description": "Whether the user has activated.", "default": false, "example": true }, "active": { "type": "boolean", "description": "Whether the user is active.", "default": false, "example": true }, "authenticator_enabled": { "type": "boolean", "description": "Whether an authenticator app is enavled for the user.", "example": true }, "created": { "$ref": "#/components/schemas/DefaultFields/properties/created" }, "date_activated": { "type": "string", "format": "date-time", "description": "When the user activated.", "example": "2026-04-21T00:00:00Z" }, "default_org": { "type": "number", "description": "The org_id for the organization to use when last_login is set to default.", "example": 1.0 }, "email": { "type": "string", "format": "email", "description": "Email address of the user.", "maxLength": 217, "example": "user@example.com" }, "external": { "type": "boolean", "description": "Whether the user is external.", "example": true }, "firstname": { "type": "string", "description": "First name of the user.", "default": "", "maxLength": 50, "x-allow-empty": true, "x-no-tags": true, "example": "Example Name" }, "guid": { "type": "string", "description": "GUID of the user.", "example": "example_value" }, "invited": { "type": "string", "format": "date-time", "description": "When the user was most recently invited. Only set for not-yet-activated users.", "example": "2026-04-21T00:00:00Z" }, "last_logged_in_org": { "type": "number", "description": "The org_id of the organization the user last signed into.", "example": 1.0 }, "last_login": { "type": "string", "format": "date-time", "description": "When the user last signed in.", "example": "2026-04-21T00:00:00Z" }, "lastname": { "type": "string", "description": "Last name of the user.", "default": "", "maxLength": 50, "x-allow-empty": true, "x-no-tags": true, "example": "Example Name" }, "locale": { "type": "string", "description": "Preferred display language for the user.", "enum": [ "en-US", "fr-FR", "de-DE", "pt-BR" ], "example": "en-US" }, "logged_in_count": { "type": "number", "description": "The number of times the user has signed in.", "example": 1.0 }, "logged_in_from_cli": { "type": "boolean", "description": "Whether the user has previously signed in from cli.", "example": true }, "logged_in_from_other": { "type": "boolean", "description": "Whether the user has previously signed in from an unknown source.", "example": true }, "logged_in_from_studio": { "type": "boolean", "description": "Whether the user has previously signed in from studio.", "example": true }, "logged_in_from_web": { "type": "boolean", "description": "Whether the user has previously signed in from web.", "example": true }, "login_org": { "type": "string", "description": "Which organization is used when the user signs in.", "enum": [ "last_logged", "default", "ask" ], "example": "last_logged" }, "mfa": { "type": "boolean", "description": "Whether multi-factor authentication is enabled for the user.", "example": true }, "oauth": { "type": "array", "description": "Which social login services are associated with the user.", "items": { "type": "string", "description": "The name of the social login service" }, "example": [ "example_value" ] }, "password_updated": { "type": "string", "format": "date-time", "description": "Date the password was last updated", "example": "********" }, "prefs": { "type": "object", "description": "User preferences.", "example": {} }, "provider_guid": { "type": "string", "format": "uuid", "description": "GUID identifier of the owning provider if a consumer of a marketplace.", "example": "example_value" }, "terms_updated": { "type": "string", "format": "date-time", "description": "Date the user accepted terms & conditions.", "example": "2026-04-21T00:00:00Z" }, "timezone": { "type": "string", "description": "The timezone used to display dates for the user.", "example": "example_value" }, "updated": { "$ref": "#/components/schemas/DefaultFields/properties/updated" }, "user_id": { "type": "number", "example": 1.0 }, "username": { "type": "string", "example": "Example Name" } } }, "UserDevice": { "type": "object", "properties": { "authorized": { "type": "boolean", "description": "Whether the device has been authorized.", "example": true }, "authorized_date": { "type": "string", "format": "date-time", "description": "Timestamp of when the device was authorized.", "example": "2026-04-21T00:00:00Z" }, "browserVersion": { "type": "string", "description": "Device browser version identified from the devices user agent.", "example": "example_value" }, "created": { "type": "string", "format": "date-time", "description": "Timestamp of when the record was created.", "example": "2026-04-21T00:00:00Z" }, "ipaddress": { "type": "string", "description": "Anonymized device IP address.", "example": "10.0.0.1" }, "origin": { "type": "string", "description": "Origin of the MFA code used to authenticate the device.", "enum": [ "email", "app" ], "example": "email" }, "osVersion": { "type": "string", "description": "Device operating system version identified from the devices user agent.", "example": "example_value" }, "updated": { "type": "string", "format": "date-time", "description": "Timestamp of the most recent sign in on the device.", "example": "2026-04-21T00:00:00Z" }, "user_device": { "type": "object", "description": "user-device relation.", "properties": { "browserFamily": { "type": "string", "description": "Device browser family identified from the devices user agent." }, "device_id": { "type": "string", "description": "GUID of the device record." }, "osFamily": { "type": "string", "description": "Device operating system family identified from the devices user agent." }, "user": { "type": "string", "description": "_id of the user the record is associated to." } }, "example": { "browserFamily": "example_value", "device_id": "507f1f77bcf86cd799439011", "osFamily": "example_value", "user": "example_value" } } } }, "UserTeams": { "type": "array", "description": "List of teams the user belongs to.", "items": { "type": "object", "description": "Teams a user belongs to.", "properties": { "default": { "$ref": "#/components/schemas/Team/properties/default" }, "guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "name": { "$ref": "#/components/schemas/Team/properties/name" }, "roles": { "type": "array", "description": "A list of roles the user has in the team", "items": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/Role/properties/id" }, "name": { "$ref": "#/components/schemas/Role/properties/name" } } } }, "tags": { "$ref": "#/components/schemas/Team/properties/tags" } } } }, "EventDataActionClient": { "type": "object", "title": "Action Service Account", "properties": { "action_client_guid": { "description": "The `guid` of the client that performed the action.", "allOf": [ { "$ref": "#/components/schemas/Client/properties/guid" } ], "example": "example_value" }, "action_client_id": { "description": "The `client_id` of the client that performed the action.", "allOf": [ { "$ref": "#/components/schemas/Client/properties/client_id" } ], "example": "507f1f77bcf86cd799439011" }, "action_client_name": { "description": "The `name` of the client that performed the action.", "allOf": [ { "$ref": "#/components/schemas/Client/properties/name" } ], "example": "Example Name" } } }, "EventDataActionUser": { "type": "object", "title": "Action User", "properties": { "action_user_guid": { "description": "The `guid` of the user that performed the action", "allOf": [ { "$ref": "#/components/schemas/User/properties/guid" } ], "example": "example_value" } } }, "EventDataActor": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataActionClient" } ] }, "EventDataCentral": { "type": "object", "oneOf": [ { "title": "Action User", "properties": { "action_user_guid": { "$ref": "#/components/schemas/EventDataActionUser/properties/action_user_guid" } } }, { "title": "Action Service Account", "properties": { "action_client_guid": { "$ref": "#/components/schemas/EventDataActionClient/properties/action_client_guid" } } } ], "properties": { "consumer_org_id": { "type": "string", "description": "The `org_id` of the consumer organization if applicable.", "example": "507f1f77bcf86cd799439011" }, "id": { "type": "string", "example": "507f1f77bcf86cd799439011" }, "name": { "type": "string", "example": "Example Name" }, "org_guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "org_id": { "$ref": "#/components/schemas/Org/properties/org_id" } } }, "EventDataChanges": { "type": "array", "description": "Changes that were made.", "items": { "type": "object", "required": [ "k" ], "properties": { "a": { "type": "integer", "description": "Action indication for changes to sensitive data. Values represent added, changed, and removed respectively.", "enum": [ 0, 1, 2 ] }, "k": { "type": "string", "description": "The full path to the modified value." }, "o": { "description": "The original value." }, "v": { "description": "The new value." } } } }, "EventDataClient": { "type": "object", "title": "Service Account", "properties": { "client_guid": { "$ref": "#/components/schemas/Client/properties/guid" }, "client_id": { "$ref": "#/components/schemas/Client/properties/client_id" }, "client_name": { "$ref": "#/components/schemas/Client/properties/name" } } }, "EventDataFrom": { "type": "string", "description": "Client type." }, "EventDataModifiedBy": { "type": "string", "description": "\"platform\" or received value from event's `data.lastModifiedVia`." }, "EventDataOrg": { "type": "object", "properties": { "org_guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "org_id": { "$ref": "#/components/schemas/Org/properties/org_id" }, "org_name": { "$ref": "#/components/schemas/Org/properties/name" }, "provider_guid": { "$ref": "#/components/schemas/Org/properties/provider_guid" }, "region": { "$ref": "#/components/schemas/Org/properties/region" } } }, "EventDataUser": { "type": "object", "title": "User", "properties": { "provider_guid": { "$ref": "#/components/schemas/User/properties/provider_guid" }, "user_guid": { "$ref": "#/components/schemas/User/properties/guid" } } }, "api_central.provision": { "type": "object", "description": "Published when a Engage provisioning is requested.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" } ], "properties": { "teams": { "type": "array", "description": "A list of the organization's teams.", "items": { "type": "object", "properties": { "default": { "$ref": "#/components/schemas/Team/properties/default" }, "guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "name": { "$ref": "#/components/schemas/Team/properties/name" } } }, "example": [ { "default": {}, "guid": {}, "name": {} } ] }, "trial": { "type": "boolean", "example": true } } }, "api_central.provisioned": { "type": "object", "description": "Published when a Engage is successfully provisioned.", "x-context": "org", "properties": { "org_guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "org_id": { "$ref": "#/components/schemas/Org/properties/org_id" }, "success": { "type": "boolean", "example": true }, "url": { "type": "string", "example": "https://example.com" }, "user_guid": { "$ref": "#/components/schemas/User/properties/guid" } } }, "apic.ucs.catalogitem.create": { "type": "object", "description": "Published when a catalog asset is created.\n\nAssets synced with type of \"catalogitem\".", "x-context": "catalog", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "catalogSubType": { "type": "string", "description": "Synced as `platform`.", "example": "example_value" }, "catalogType": { "type": "string", "description": "Synced as `subtype`.", "example": "example_value" }, "envId": { "$ref": "#/components/schemas/Environment/properties/guid" } } }, "apic.ucs.catalogitem.remove": { "type": "object", "description": "Published when a catalog asset is removed.", "x-context": "catalog", "allOf": [ { "$ref": "#/components/schemas/apic.ucs.catalogitem.create" } ] }, "apic.ucs.catalogitem.share": { "type": "object", "description": "Published when a catalog asset visibility or access controller list is updated.", "x-context": "catalog", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ] }, "apic.ucs.catalogitem.update": { "type": "object", "description": "Published when a catalog asset is updated.", "x-context": "catalog", "allOf": [ { "$ref": "#/components/schemas/apic.ucs.catalogitem.create" } ] }, "apic.ucs.subscription.create": { "type": "object", "description": "Published when a subscription of a catalog asset is created.", "x-context": "catalog", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "catalogItemId": { "type": "string", "example": "example_value" }, "envId": { "$ref": "#/components/schemas/Environment/properties/guid" } } }, "apic.ucs.subscription.remove": { "type": "object", "description": "Published when a subscription of a catalog asset is removed.", "x-context": "catalog", "allOf": [ { "$ref": "#/components/schemas/apic.ucs.subscription.create" } ] }, "apic.ucs.subscription.update": { "type": "object", "description": "Published when a subscription of a catalog asset is updated.", "x-context": "catalog", "allOf": [ { "$ref": "#/components/schemas/apic.ucs.subscription.create" } ] }, "apicentral._._": { "type": "object", "title": "apicentral.{resource}.{action}", "description": "Published when a Central resource is created/updated/removed.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "group": { "type": "string", "example": "example_value" } } }, "apicentral._._.update": { "type": "object", "title": "apicentral.{resource}.{subresource}.update", "description": "Published when a Central resource's subresource is updated.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "group": { "type": "string", "example": "example_value" } } }, "apicentral.agent.create": { "type": "object", "description": "Published when a Central agent is created.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "agent_type": { "type": "string", "enum": [ "DiscoveryAgent", "TraceabilityAgent" ], "example": "DiscoveryAgent" }, "dataplane_type": { "type": "string", "description": "Gateway the agent links to.", "example": "example_value" }, "envId": { "$ref": "#/components/schemas/Environment/properties/guid" }, "group": { "type": "string", "enum": [ "management" ], "example": "management" } } }, "apicentral.agent.failed": { "type": "object", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.agent.start" } ] }, "apicentral.agent.remove": { "type": "object", "description": "Published when a Central agent is removed.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.agent.create" } ] }, "apicentral.agent.start": { "type": "object", "description": "Published when a Central agent changes its state in the status resource.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "agent_type": { "type": "string", "enum": [ "DiscoveryAgent", "TraceabilityAgent" ], "example": "DiscoveryAgent" }, "agent_version": { "type": "string", "example": "example_value" }, "dataplane_type": { "type": "string", "description": "Gateway the agent links to.", "example": "example_value" }, "envId": { "$ref": "#/components/schemas/Environment/properties/guid" }, "group": { "type": "string", "enum": [ "management" ], "example": "management" } } }, "apicentral.agent.stop": { "type": "object", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.agent.start" } ] }, "apicentral.agent.unhealthy": { "type": "object", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.agent.start" } ] }, "apicentral.apiservice.create": { "type": "object", "description": "Published when a top-level Central asset is created.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "automatic": { "type": "boolean", "description": "Whether the asset is agent created.", "example": true }, "envId": { "$ref": "#/components/schemas/Environment/properties/guid" }, "group": { "type": "string", "enum": [ "management" ], "example": "management" } } }, "apicentral.apiservice.remove": { "type": "object", "description": "Published when a top-level Central asset is updated.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.apiservice.create" } ] }, "apicentral.apiservice.update": { "type": "object", "description": "Published when a top-level Central asset is updated.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.apiservice.create" } ] }, "apicentral.asset.create": { "type": "object", "description": "Published when a Central asset is created.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "envIds": { "type": "array", "items": { "$ref": "#/components/schemas/Environment/properties/guid" }, "example": [ {} ] }, "group": { "type": "string", "enum": [ "catalog" ], "example": "catalog" } } }, "apicentral.asset.remove": { "type": "object", "description": "Published when a Central asset is removed.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.asset.create" } ] }, "apicentral.asset.update": { "type": "object", "description": "Published when a Central asset is updated.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.asset.create" } ] }, "apicentral.credential.expire": { "type": "object", "description": "Published when a marketplace credential expiry notification needs to be sent.", "x-context": "api_central", "properties": { "application_id": { "type": "string", "example": "507f1f77bcf86cd799439011" }, "application_name": { "type": "string", "example": "Example Name" }, "group": { "type": "string", "enum": [ "catalog" ], "example": "catalog" }, "id": { "type": "string", "example": "507f1f77bcf86cd799439011" }, "name": { "type": "string", "example": "Example Name" }, "org_guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "org_id": { "$ref": "#/components/schemas/Org/properties/org_id" }, "product_id": { "type": "string", "example": "507f1f77bcf86cd799439011" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "timestamp": { "type": "number", "description": "When the credential is set to expire. If the timestamp is less then the current timestamp, the credential has expired.", "example": 1.0 }, "user_guid": { "description": "Email recipient", "allOf": [ { "$ref": "#/components/schemas/User/properties/guid" } ], "example": "example_value" } } }, "apicentral.documentresource.create": { "type": "object", "description": "Published when a document defined in the document library is created.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "description": { "type": "string", "maxLength": 350, "example": "An example description" }, "fileType": { "type": "string", "description": "For markdown documents the fileType will be \"markdown\". For document that respresent external URLs, we don't know the type and the fileType will be missing.", "example": "example_value" }, "group": { "type": "string", "enum": [ "catalog" ], "example": "catalog" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "type": { "type": "string", "enum": [ "text", "binary", "url" ], "example": "text" }, "version": { "type": "string", "description": "Document version", "maxLength": 30, "example": "example_value" } } }, "apicentral.documentresource.remove": { "type": "object", "description": "Published when a document defined in the document library is removed.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.documentresource.create" } ] }, "apicentral.documentresource.update": { "type": "object", "description": "Published when a document defined in the document library is updated.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.documentresource.create" } ] }, "apicentral.env.create": { "type": "object", "description": "Published when a Central environment is created.\n\nEither \"action_user_guid\" or \"user_guid\" can be provided to indicate the creator of the env. \"action_user_guid\" is preferred.\n\"governance\" is optional and assumed as \"Customer Managed\" if not passed.\n\"production\" is optional and assumed as false if not passed.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "governance": { "type": "string", "enum": [ "Axway Managed", "Customer Managed" ], "example": "Axway Managed" }, "group": { "type": "string", "enum": [ "management" ], "example": "management" }, "production": { "type": "boolean", "example": true }, "user_guid": { "$ref": "#/components/schemas/User/properties/guid" } } }, "apicentral.env.remove": { "type": "object", "description": "Published when a Central environment is removed.\n\nEither \"action_user_guid\" or \"user_guid\" can be provided to indicate the creator of the env. \"action_user_guid\" is preferred.\n\"governance\" is optional and assumed as \"Customer Managed\" if not passed.\n\"production\" is optional and assumed as false if not passed.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.env.create" } ] }, "apicentral.env.update": { "type": "object", "description": "Published when a Central environment is updated.\n\nEither \"action_user_guid\" or \"user_guid\" can be provided to indicate the creator of the env. \"action_user_guid\" is preferred.\n\"governance\" is optional and assumed as \"Customer Managed\" if not passed.\n\"production\" is optional and assumed as false if not passed.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.env.create" } ] }, "apicentral.publisheddocumentresource.create": { "type": "object", "description": "Published when a document defined in the document library is made available to be used in the marketplace content.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "document_resource_id": { "type": "string", "description": "Identifier of the document resource that is made available in the marketplace.", "example": "507f1f77bcf86cd799439011" }, "group": { "type": "string", "enum": [ "catalog" ], "example": "catalog" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" } } }, "apicentral.publisheddocumentresource.remove": { "type": "object", "description": "Published when a document defined in the document library is made unavailable for use in the marketplace content.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.publisheddocumentresource.create" } ] }, "apicentral.publishedproduct.create": { "type": "object", "description": "Published when a product is published to a given marketplace.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "group": { "type": "string", "enum": [ "catalog" ], "example": "catalog" }, "product_id": { "type": "string", "example": "507f1f77bcf86cd799439011" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" } } }, "apicentral.publishedproduct.remove": { "type": "object", "description": "Published when a product is unpublished from a given marketplace.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.publishedproduct.create" } ] }, "apicentral.subscription.create": { "type": "object", "description": "Published when a marketplace subscription is created.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/EventDataCentral" } ], "properties": { "group": { "type": "string", "enum": [ "catalog" ], "example": "catalog" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" } } }, "apicentral.subscription.remove": { "type": "object", "description": "Published when a marketplace subscription is removed.", "x-context": "api_central", "allOf": [ { "$ref": "#/components/schemas/apicentral.subscription.create" } ] }, "com.appcelerator.platform.org.user.create": { "type": "object", "description": "Published when a user is added or invited to an org.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "idp": { "type": "object", "description": "Identity Provider the user is required to authenticate with to access the organization", "properties": { "id": { "$ref": "#/components/schemas/IdentityProvider/properties/guid" }, "name": { "$ref": "#/components/schemas/IdentityProvider/properties/name" } }, "example": { "id": {}, "name": {} } }, "role": { "type": "string", "description": "Identifier of the invited users default role in the organization.", "enum": [ "administrator", "developer", "auditor", "consumer" ], "example": "administrator" }, "roles": { "type": "array", "description": "User's roles within the organization.", "items": { "$ref": "#/components/schemas/Org/properties/users/items/properties/roles/items" }, "example": [ {} ] }, "user_activated": { "$ref": "#/components/schemas/User/properties/activated" }, "user_active": { "$ref": "#/components/schemas/User/properties/active" } } }, "com.appcelerator.platform.org.user.remove": { "type": "object", "description": "Published when a user is removed/uninvited from an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataUser" } ] }, "marketplace.ai.disable": { "type": "object", "description": "Published when AI integration is disabled for a marketplace.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" } } }, "marketplace.ai.enable": { "type": "object", "description": "Published when AI integration is enabled for a marketplace.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.ai.disable" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "embedded": { "$ref": "#/components/schemas/Provider/properties/ai/properties/embedded" }, "stream": { "$ref": "#/components/schemas/Provider/properties/ai/properties/stream" }, "url": { "$ref": "#/components/schemas/Provider/properties/ai/properties/url" } } }, "marketplace.ai.update": { "type": "object", "description": "Published when marketplace AI integration settings are changed.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.ai.enable" } ] }, "marketplace.appearance.update": { "type": "object", "description": "Published when a marketplace appearance is set or changed.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" } } }, "marketplace.billing.disable": { "type": "object", "description": "Published when a marketplace billing integration is disabled.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" } } }, "marketplace.billing.enable": { "type": "object", "description": "Published when a marketplace billing integration is enabled.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.billing.disable" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" }, "vendor": { "$ref": "#/components/schemas/Provider/properties/billing/properties/vendor" } } }, "marketplace.billing.update": { "type": "object", "description": "Published when a marketplace billing settings are changed.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.billing.enable" } ] }, "marketplace.consumer.active": { "type": "object", "description": "Published when a consumer organization is set active.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.consumer.approve" } ] }, "marketplace.consumer.approve": { "type": "object", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "consumer_org_guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "consumer_org_id": { "$ref": "#/components/schemas/Org/properties/org_id" }, "consumer_org_name": { "$ref": "#/components/schemas/Org/properties/name" }, "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" } } }, "marketplace.consumer.deny": { "type": "object", "description": "Published when a consumer organization sign-up denied.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.consumer.approve" } ] }, "marketplace.consumer.inactive": { "type": "object", "description": "Published when a consumer organization is set inactive.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.consumer.approve" } ] }, "marketplace.consumer.remove": { "type": "object", "description": "Published when a consumer organization is deleted.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.consumer.approve" } ] }, "marketplace.consumer.signup": { "type": "object", "description": "Published when a new organization signs up to a marketplace.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" } ], "properties": { "consumer_org_guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "consumer_org_id": { "$ref": "#/components/schemas/Org/properties/org_id" }, "consumer_org_name": { "$ref": "#/components/schemas/Org/properties/name" }, "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" }, "pending": { "type": "boolean", "description": "Whether the signup is pending approval.", "example": true } } }, "marketplace.create": { "type": "object", "description": "Published when a marketplace is created.\n\n`subdomain` prop will always be included. Once `url` is established, `subdomain` prop value will be passed as the `guid`.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "admin_teams": { "$ref": "#/components/schemas/Provider/properties/admin_teams" }, "certificate_expires": { "$ref": "#/components/schemas/Provider/properties/certificate_expires" }, "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" }, "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "help_menu": { "$ref": "#/components/schemas/Provider/properties/help_menu" }, "idp": { "$ref": "#/components/schemas/Provider/properties/idp" }, "idp_hint": { "$ref": "#/components/schemas/Provider/properties/idp_hint" }, "lang_default": { "$ref": "#/components/schemas/Provider/properties/lang/properties/default" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" }, "oauth": { "type": "object", "properties": { "github": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/github/properties/enabled" }, "secret_updated": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/github/properties/secret_updated" } } }, "gitlab": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/gitlab/properties/enabled" }, "secret_updated": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/gitlab/properties/secret_updated" } } }, "google": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/google/properties/enabled" }, "secret_updated": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/google/properties/secret_updated" } } } }, "example": { "github": { "enabled": {}, "secret_updated": {} }, "gitlab": { "enabled": {}, "secret_updated": {} }, "google": { "enabled": {}, "secret_updated": {} } } }, "public": { "$ref": "#/components/schemas/Provider/properties/public" }, "publish_teams": { "$ref": "#/components/schemas/Provider/properties/publish_teams" }, "reviews": { "$ref": "#/components/schemas/Provider/properties/reviews" }, "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_updated": { "$ref": "#/components/schemas/Provider/properties/terms_updated" }, "terms_url": { "$ref": "#/components/schemas/Provider/properties/terms_url" }, "url": { "$ref": "#/components/schemas/Provider/properties/url" }, "versions": { "$ref": "#/components/schemas/Provider/properties/versions" } } }, "marketplace.idp.create": { "type": "object", "description": "Published when an Identity Provider is created for a marketplace.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "idp": { "type": "object", "description": "Identity Provider associated to the marketplace.", "properties": { "id": { "$ref": "#/components/schemas/IdentityProvider/properties/guid" }, "name": { "$ref": "#/components/schemas/IdentityProvider/properties/name" } }, "example": { "id": {}, "name": {} } }, "name": { "$ref": "#/components/schemas/Provider/properties/name" } } }, "marketplace.idp.remove": { "type": "object", "description": "Published when an Identity Provider is removed from a marketplace.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.idp.create" } ] }, "marketplace.idp.update": { "type": "object", "description": "Published when an Identity Provider is updated for a marketplace.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.idp.create" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" } } }, "marketplace.lang.update": { "type": "object", "description": "Published when marketplace language settings updated.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "lang_default": { "$ref": "#/components/schemas/Provider/properties/lang/properties/default" }, "lang_products": { "$ref": "#/components/schemas/Provider/properties/lang/properties/products" }, "lang_supported": { "$ref": "#/components/schemas/Provider/properties/lang/properties/supported" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" } } }, "marketplace.onboarding.disable": { "type": "object", "description": "Published when marketplace onboarding data capture is disabled.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" } } }, "marketplace.onboarding.enable": { "type": "object", "description": "Published when marketplace onboarding data capture is enabled.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.onboarding.disable" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" } } }, "marketplace.onboarding.update": { "type": "object", "description": "Published when marketplace onboarding data capture is changed.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/marketplace.onboarding.enable" } ] }, "marketplace.publisheddocumentresource.add": { "type": "object", "description": "Published when a published document resource is selected for use in Marketplace settings.", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "id": { "type": "string", "description": "Published id, same as apicentral.publisheddocumentresource.* event `id`.", "example": "507f1f77bcf86cd799439011" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" } } }, "marketplace.publisheddocumentresource.remove": { "type": "object", "description": "Published when a published document resource is removed from use in Marketplace settings.", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "id": { "type": "string", "description": "Published id, same as apicentral.publisheddocumentresource.* event `id`.", "example": "507f1f77bcf86cd799439011" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" } } }, "marketplace.remove": { "type": "object", "description": "Published when a marketplace is removed.\n\n`subdomain` prop will always be included. Once url is established, `subdomain` prop value will be passed as the `guid`.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" }, "subdomain": { "$ref": "#/components/schemas/Provider/properties/subdomain" }, "url": { "$ref": "#/components/schemas/Provider/properties/url" } } }, "marketplace.settings.update": { "type": "object", "description": "Published when marketplace settings are changed.\n\n`subdomain` prop will always be included. Once url is established, `subdomain` prop value will be passed as the `guid`.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "admin_teams": { "$ref": "#/components/schemas/Provider/properties/admin_teams" }, "certificate_expires": { "$ref": "#/components/schemas/Provider/properties/certificate_expires" }, "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "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" }, "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "help_menu": { "$ref": "#/components/schemas/Provider/properties/help_menu" }, "idp": { "$ref": "#/components/schemas/Provider/properties/idp" }, "idp_hint": { "$ref": "#/components/schemas/Provider/properties/idp_hint" }, "lang_default": { "$ref": "#/components/schemas/Provider/properties/lang/properties/default" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" }, "oauth": { "type": "object", "properties": { "github": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/github/properties/enabled" }, "secret_updated": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/github/properties/secret_updated" } } }, "gitlab": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/gitlab/properties/enabled" }, "secret_updated": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/gitlab/properties/secret_updated" } } }, "google": { "type": "object", "properties": { "enabled": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/google/properties/enabled" }, "secret_updated": { "$ref": "#/components/schemas/Provider/properties/oauth/properties/google/properties/secret_updated" } } } }, "example": { "github": { "enabled": {}, "secret_updated": {} }, "gitlab": { "enabled": {}, "secret_updated": {} }, "google": { "enabled": {}, "secret_updated": {} } } }, "public": { "$ref": "#/components/schemas/Provider/properties/public" }, "publish_teams": { "$ref": "#/components/schemas/Provider/properties/publish_teams" }, "reviews": { "$ref": "#/components/schemas/Provider/properties/reviews" }, "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_updated": { "$ref": "#/components/schemas/Provider/properties/terms_updated" }, "terms_url": { "$ref": "#/components/schemas/Provider/properties/terms_url" }, "url": { "$ref": "#/components/schemas/Provider/properties/url" }, "versions": { "$ref": "#/components/schemas/Provider/properties/versions" } } }, "marketplace.user.remove": { "type": "object", "description": "Published when a consumer organization user is deleted.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "guid": { "$ref": "#/components/schemas/Provider/properties/guid" }, "name": { "$ref": "#/components/schemas/Provider/properties/name" }, "orgs": { "type": "array", "description": "Array of orgs the user was a member of", "items": { "type": "object", "properties": { "guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "name": { "$ref": "#/components/schemas/Org/properties/name" }, "org_id": { "$ref": "#/components/schemas/Org/properties/org_id" } } }, "example": [ { "guid": {}, "name": {}, "org_id": {} } ] } } }, "platform.activation.access": { "type": "object", "description": "Published when an activation link is accessed.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "activation_guid": { "$ref": "#/components/schemas/Activation/properties/guid" }, "activation_type": { "$ref": "#/components/schemas/Activation/properties/type" } } }, "platform.activation.complete": { "type": "object", "description": "Published when a user activates their account.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "orgs": { "type": "array", "description": "Array of orgs the user is a member of", "items": { "type": "object", "properties": { "guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "name": { "$ref": "#/components/schemas/Org/properties/name" }, "org_id": { "$ref": "#/components/schemas/Org/properties/org_id" } } }, "example": [ { "guid": {}, "name": {}, "org_id": {} } ] } } }, "platform.activation.send": { "type": "object", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "activation_type": { "$ref": "#/components/schemas/Activation/properties/type" } } }, "platform.app.create": { "type": "object", "description": "Published when an application is created.", "x-context": "app", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "app": { "type": "object", "description": "The created application", "properties": { "guid": { "$ref": "#/components/schemas/Application/properties/guid" }, "name": { "$ref": "#/components/schemas/Application/then/properties/name" }, "platform": { "$ref": "#/components/schemas/Application/properties/platform" }, "provider_guid": { "$ref": "#/components/schemas/Application/properties/provider_guid" }, "source": { "$ref": "#/components/schemas/Application/properties/source" }, "type": { "$ref": "#/components/schemas/Application/properties/type" } }, "example": { "guid": {}, "name": {}, "platform": {}, "provider_guid": {}, "source": {}, "type": {} } } } }, "platform.app.remove": { "type": "object", "description": "Published when an application is removed.", "x-context": "app", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "app_guid": { "$ref": "#/components/schemas/Application/properties/guid" }, "app_name": { "$ref": "#/components/schemas/Application/then/properties/name" } } }, "platform.app.update": { "type": "object", "description": "Published when an application is updated.", "x-context": "app", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "app": { "type": "object", "description": "The updated application", "properties": { "guid": { "$ref": "#/components/schemas/Application/properties/guid" }, "name": { "$ref": "#/components/schemas/Application/then/properties/name" }, "platform": { "$ref": "#/components/schemas/Application/properties/platform" }, "provider_guid": { "$ref": "#/components/schemas/Application/properties/provider_guid" }, "source": { "$ref": "#/components/schemas/Application/properties/source" }, "type": { "$ref": "#/components/schemas/Application/properties/type" } }, "example": { "guid": {}, "name": {}, "platform": {}, "provider_guid": {}, "source": {}, "type": {} } }, "changes": { "$ref": "#/components/schemas/EventDataChanges" } } }, "platform.client.create": { "type": "object", "description": "Published when an organization admin creates a Service Account client.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataClient" } ], "properties": { "roles": { "$ref": "#/components/schemas/Client/properties/roles" } } }, "platform.client.remove": { "type": "object", "description": "Published when an organization admin removes a Service Account client.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataClient" } ] }, "platform.client.update": { "type": "object", "description": "Published when an organization admin updates a Service Account client.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataClient" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" } } }, "platform.documentresource.add": { "type": "object", "description": "Published when a document resource is selected for use in the organization.", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "id": { "type": "string", "description": "Published id, same as apicentral.documentresource.* event `id`.", "example": "507f1f77bcf86cd799439011" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" } } }, "platform.documentresource.remove": { "type": "object", "description": "Published when a document resource is removed from use in the organization.", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "id": { "type": "string", "description": "Published id, same as apicentral.documentresource.* event `id`.", "example": "507f1f77bcf86cd799439011" }, "provider_guid": { "$ref": "#/components/schemas/Provider/properties/guid" } } }, "platform.env.create": { "type": "object", "description": "Published when an environment is created.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "governance": { "$ref": "#/components/schemas/Environment/properties/governance" }, "guid": { "$ref": "#/components/schemas/Environment/properties/guid" }, "name": { "$ref": "#/components/schemas/Environment/properties/name" }, "type": { "$ref": "#/components/schemas/Environment/properties/type" } } }, "platform.env.remove": { "type": "object", "description": "Published when an environment is removed.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.env.create" } ] }, "platform.env.update": { "type": "object", "description": "Published when an environment is updated.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.env.create" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" } } }, "platform.login.failed": { "type": "object", "description": "Published when a user sign in fails.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "from": { "$ref": "#/components/schemas/EventDataFrom" }, "ip": { "type": "string", "description": "Anonymized IP address.", "example": "10.0.0.1" } } }, "platform.login": { "type": "object", "description": "Published when a user signs in from any client type (tooling vs. browser).", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "from": { "$ref": "#/components/schemas/EventDataFrom" }, "ip": { "type": "string", "description": "Anonymized IP address.", "example": "10.0.0.1" } } }, "platform.logout": { "type": "object", "description": "Published when a user signs out from any client.", "x-context": "auth", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "from": { "$ref": "#/components/schemas/EventDataFrom" }, "ip": { "type": "string", "description": "Anonymized IP address.", "example": "10.0.0.1" } } }, "platform.org.active": { "type": "object", "description": "Published when `orgs.active` flag changes.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.org.create" } ] }, "platform.org.branding.update": { "type": "object", "description": "Published when org branding is changed.\n\nBranding attributes added, changed, or removed are indicated in changes array.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" } } }, "platform.org.create": { "type": "object", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" }, { "$ref": "#/components/schemas/EventDataActionUser" } ], "properties": { "from": { "$ref": "#/components/schemas/EventDataFrom" }, "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" } } }, "platform.org.delete": { "type": "object", "x-context": "staff", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" } ], "properties": { "from": { "$ref": "#/components/schemas/EventDataFrom" }, "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" } } }, "platform.org.idp.create": { "type": "object", "description": "Published when an Identity Provider is created for an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "idp": { "type": "object", "description": "Identity Provider associated to the organization.", "properties": { "id": { "$ref": "#/components/schemas/IdentityProvider/properties/guid" }, "name": { "$ref": "#/components/schemas/IdentityProvider/properties/name" } }, "example": { "id": {}, "name": {} } }, "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" } } }, "platform.org.idp.domain.associate": { "type": "object", "description": "Published when an Identity Provider is enabled for users on a domain in an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "idp": { "type": "object", "description": "Identity Provider associated to the organization.", "properties": { "id": { "$ref": "#/components/schemas/IdentityProvider/properties/guid" }, "name": { "$ref": "#/components/schemas/IdentityProvider/properties/name" } }, "example": { "id": {}, "name": {} } }, "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" }, "tld": { "$ref": "#/components/schemas/Domain/properties/tld" } } }, "platform.org.idp.domain.confirm": { "type": "object", "description": "Published when ownership of a domain is verified for an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.org.idp.domain.associate" } ] }, "platform.org.idp.domain.create": { "type": "object", "description": "Published when an domain is added to an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" }, "tld": { "$ref": "#/components/schemas/Domain/properties/tld" } } }, "platform.org.idp.domain.dissociate": { "type": "object", "description": "Published when an Identity Provider is disabled for users on a domain in an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.org.idp.domain.associate" } ] }, "platform.org.idp.domain.remove": { "type": "object", "description": "Published when an domain is removed from an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.org.idp.domain.create" } ] }, "platform.org.idp.remove": { "type": "object", "description": "Published when an Identity Provider is removed from an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.org.idp.create" } ] }, "platform.org.idp.update": { "type": "object", "description": "Published when an identity provider is updated for an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.org.idp.create" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" } } }, "platform.org.inactive": { "type": "object", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/platform.org.active" } ] }, "platform.org.security.update": { "type": "object", "description": "Published when organization security settings are updated.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "from": { "$ref": "#/components/schemas/EventDataFrom" }, "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" } } }, "platform.org.update": { "type": "object", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "from": { "$ref": "#/components/schemas/EventDataFrom" }, "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" } } }, "platform.org.user.idp.update": { "type": "object", "description": "Published when an Identity Provider requirement is made for a user in an organization.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "idp": { "type": "object", "description": "Identity Provider associated to the organization.", "properties": { "id": { "$ref": "#/components/schemas/IdentityProvider/properties/guid" }, "name": { "$ref": "#/components/schemas/IdentityProvider/properties/name" } }, "example": { "id": {}, "name": {} } }, "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" } } }, "platform.org.user.primary": { "type": "object", "description": "Published when org primary contact is changed.\n\nUser guid of prior and new primary user is reflected in changes array entry in \"o\" and \"v\" fields respectively.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" } } }, "platform.org.user.resent": { "type": "object", "description": "Published when a user activation is resent.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "activation_type": { "$ref": "#/components/schemas/Activation/properties/type" } } }, "platform.org.user.role.update": { "type": "object", "description": "Published when a user's role in an organization is changed.\n\nChanges array as a single entry for roles containing new and previous values.\n\n`added_roles` and `removed_role`s sets added to the event to more clearly identify changes to assigned roles. These can also be inferred from the difference between new and previous and vice versa.\n\n`role` and `previous_role` are only included if the user's Platform role is changed.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "added_roles": { "type": "array", "description": "Set of roles newly assigned to the user.", "items": { "type": "string", "enum": [ "administrator", "developer", "auditor", "consumer", "usage_reporter", "api_central_admin" ] }, "example": [ "administrator" ] }, "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "previous_role": { "type": "string", "description": "Identifier of the users previous default role in the organization. Only set if the default role is changed.", "enum": [ "administrator", "developer", "auditor", "consumer" ], "example": "administrator" }, "removed_roles": { "type": "array", "description": "Set of roles no longer assigned to the user.", "items": { "type": "string", "enum": [ "administrator", "developer", "auditor", "consumer", "usage_reporter", "api_central_admin" ] }, "example": [ "administrator" ] }, "role": { "type": "string", "description": "Identifier of the users default role in the organization. Only set if the default role is changed.", "enum": [ "administrator", "developer", "auditor", "consumer" ], "example": "administrator" } } }, "platform.session.create": { "type": "object", "description": "Published when a session is created from an access token or external IdP, or a user switches platform org.", "x-context": "auth", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "from": { "$ref": "#/components/schemas/EventDataFrom" }, "idp": { "type": "object", "description": "Identity Provider used to authenticate the session", "properties": { "id": { "type": "string", "oneOf": [ { "enum": [ "360", "github", "gitlab", "google" ] }, { "$ref": "#/components/schemas/IdentityProvider/properties/guid" } ] }, "name": { "$ref": "#/components/schemas/IdentityProvider/properties/name" } }, "example": { "id": "507f1f77bcf86cd799439011", "name": {} } }, "ip": { "type": "string", "description": "Anonymized IP address.", "example": "10.0.0.1" }, "role": { "type": "string", "description": "Identifier of the invited users default role in the organization.", "enum": [ "administrator", "developer", "auditor", "consumer" ], "example": "administrator" }, "roles": { "type": "array", "description": "User's roles within the organization.", "items": { "$ref": "#/components/schemas/Org/properties/users/items/properties/roles/items" }, "example": [ {} ] } } }, "platform.subscription.create": { "type": "object", "description": "Published when a subscription for an org is created.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" } ], "properties": { "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" }, "subscription": { "$ref": "#/components/schemas/Subscription" } } }, "platform.subscription.delete": { "type": "object", "description": "Published when a subscription for an org is deleted.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" } ], "properties": { "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" }, "subscription": { "$ref": "#/components/schemas/Subscription" } } }, "platform.subscription.expired": { "type": "object", "description": "Published when a subscription expires past its end date and any dunning period.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" } ], "properties": { "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" }, "subscription": { "$ref": "#/components/schemas/Subscription" } } }, "platform.subscription.update": { "type": "object", "description": "Published when a subscription for an org is updated.", "x-context": "org", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "modified_by": { "$ref": "#/components/schemas/EventDataModifiedBy" }, "subscription": { "$ref": "#/components/schemas/Subscription" } } }, "platform.team.app.add": { "type": "object", "description": "Published when an asset is added to a team.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "app_id": { "$ref": "#/components/schemas/Application/properties/guid" }, "app_name": { "$ref": "#/components/schemas/Application/then/properties/name" }, "team_guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "team_name": { "$ref": "#/components/schemas/Team/properties/name" } } }, "platform.team.app.remove": { "type": "object", "description": "Published when an asset is removed from a team.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "app_id": { "$ref": "#/components/schemas/Application/properties/guid" }, "app_name": { "$ref": "#/components/schemas/Application/then/properties/name" }, "team_guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "team_name": { "$ref": "#/components/schemas/Team/properties/name" } } }, "platform.team.create": { "type": "object", "description": "Published when a new team is created in an org.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "team": { "type": "object", "description": "The created team", "properties": { "default": { "$ref": "#/components/schemas/Team/properties/default" }, "guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "name": { "$ref": "#/components/schemas/Team/properties/name" } }, "example": { "default": {}, "guid": {}, "name": {} } } } }, "platform.team.default": { "type": "object", "description": "Published when a team is changed to the default within an org.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "team": { "type": "object", "description": "The created team", "properties": { "default": { "$ref": "#/components/schemas/Team/properties/default" }, "guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "name": { "$ref": "#/components/schemas/Team/properties/name" } }, "example": { "default": {}, "guid": {}, "name": {} } } } }, "platform.team.remove": { "type": "object", "description": "Published when an existing team is modified.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "reassign_team": { "type": "object", "description": "If provided the team where the resources are reassigned.", "properties": { "default": { "$ref": "#/components/schemas/Team/properties/default" }, "guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "name": { "$ref": "#/components/schemas/Team/properties/name" } }, "example": { "default": {}, "guid": {}, "name": {} } }, "team": { "type": "object", "description": "The updated team", "properties": { "default": { "$ref": "#/components/schemas/Team/properties/default" }, "guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "name": { "$ref": "#/components/schemas/Team/properties/name" } }, "example": { "default": {}, "guid": {}, "name": {} } } } }, "platform.team.update": { "type": "object", "description": "Published when an existing team is modified.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" }, "team": { "type": "object", "description": "The updated team", "properties": { "default": { "$ref": "#/components/schemas/Team/properties/default" }, "guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "name": { "$ref": "#/components/schemas/Team/properties/name" } }, "example": { "default": {}, "guid": {}, "name": {} } } } }, "platform.team.user.add": { "type": "object", "description": "Published when a user or client is added to a team.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "oneOf": [ { "$ref": "#/components/schemas/EventDataUser" }, { "$ref": "#/components/schemas/EventDataClient" } ] } ], "properties": { "roles": { "$ref": "#/components/schemas/Team/properties/users/items/properties/roles" }, "team_guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "team_name": { "$ref": "#/components/schemas/Team/properties/name" } } }, "platform.team.user.remove": { "type": "object", "description": "Published when a user or client is removed from a team.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "oneOf": [ { "$ref": "#/components/schemas/EventDataUser" }, { "$ref": "#/components/schemas/EventDataClient" } ] } ], "properties": { "team_guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "team_name": { "$ref": "#/components/schemas/Team/properties/name" } } }, "platform.team.user.role.update": { "type": "object", "description": "Published when user's role is changed within team.", "x-context": "team", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActor" }, { "oneOf": [ { "$ref": "#/components/schemas/EventDataUser" }, { "$ref": "#/components/schemas/EventDataClient" } ] } ], "properties": { "roles": { "$ref": "#/components/schemas/Team/properties/users/items/properties/roles" }, "team_guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "team_name": { "$ref": "#/components/schemas/Team/properties/name" } } }, "platform.terms.accept": { "type": "object", "description": "Published when Terms of Use are accepted by a user.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ] }, "platform.usage.report": { "type": "object", "description": "Published when usage is reported.", "allOf": [ { "$ref": "#/components/schemas/EventDataActor" } ], "properties": { "end_date": { "type": "integer", "description": "End date of the report.", "example": 1714000000000 }, "env_guid": { "type": "string", "description": "Environment guid for which the report was uploaded.", "example": "example_value" }, "guid": { "type": "string", "description": "Unique identifier of the report.", "example": "example_value" }, "name": { "type": "string", "description": "Name of the uploaded usage report file.", "example": "Example Name" }, "org_guid": { "type": "string", "description": "Organization guid for which the report was uploaded.", "example": "example_value" }, "product_name": { "type": "string", "description": "(Optional) Product name for which the usage was reported.", "example": "Example Name" }, "product_version": { "type": "string", "description": "(Optional) Product version for which the usage was reported.", "example": "example_value" }, "start_date": { "type": "integer", "description": "Start date of the report.", "example": 1714000000000 }, "status": { "type": "string", "description": "Status of the report.", "enum": [ "VALIDATING", "VALIDATED", "PROCESSED", "INVALIDATED", "PARTIALLY_ACCEPTED", "MISSING_EVENTS", "INVALID_METRICS", "ENRICHMENT_ERROR", "ANALYTICS_UPLOAD_FAILED", "ANALYTICS_MISSMATCH", "ANALYTICS_ERROR", "INVALID_ENVIRONMENT", "MISSING_FILE" ], "example": "VALIDATING" }, "upload_method": { "type": "string", "description": "Method used to upload the usage report file.", "enum": [ "automatic", "manual", "entry" ], "example": "automatic" } } }, "platform.user.impersonate": { "type": "object", "description": "Published when a user is impersonated.", "x-context": "staff", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ] }, "platform.user.mfa.app.add": { "type": "object", "description": "Published when an MFA application is added for a user.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ] }, "platform.user.mfa.app.remove": { "type": "object", "description": "Published when an MFA application is removed for a user.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ] }, "platform.user.mfa.disabled": { "type": "object", "description": "Published when multi-factor authentication is disabled for a user.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/platform.user.mfa.enabled" } ] }, "platform.user.mfa.enabled": { "type": "object", "description": "Published when multi-factor authentication is enabled for a user.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ] }, "platform.user.password.change": { "type": "object", "description": "Published when a users password is updated.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "ip": { "type": "string", "description": "Anonymized IP address.", "example": "10.0.0.1" } } }, "platform.user.password.reset": { "type": "object", "description": "Published when a users password is reset.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataUser" } ] }, "platform.user.remove": { "type": "object", "description": "Published when a user is deleted from Platform.", "x-context": "staff", "allOf": [ { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "orgs": { "type": "array", "description": "Array of orgs the user was a member of", "items": { "type": "object", "properties": { "guid": { "$ref": "#/components/schemas/Org/properties/guid" }, "name": { "$ref": "#/components/schemas/Org/properties/name" }, "org_id": { "$ref": "#/components/schemas/Org/properties/org_id" } } }, "example": [ { "guid": {}, "name": {}, "org_id": {} } ] } } }, "platform.user.social.disable": { "type": "object", "description": "Published when an OAuth service provider is removed for a user.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/platform.user.social.enable" } ] }, "platform.user.social.enable": { "type": "object", "description": "Published when an OAuth service provider is added for a user.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "service": { "type": "string", "description": "An identifier for the service.", "enum": [ "github", "gitlab", "google" ], "example": "github" }, "service_name": { "type": "string", "description": "Name of the service.", "enum": [ "GitHub", "GitLab", "Google" ], "example": "GitHub" } } }, "platform.user.unimpersonate": { "type": "object", "description": "Published when a user is unimpersonated.", "x-context": "staff", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ] }, "platform.user.update": { "type": "object", "description": "Published when user account/meta data is updated.", "x-context": "user", "allOf": [ { "$ref": "#/components/schemas/EventDataOrg" }, { "$ref": "#/components/schemas/EventDataActionUser" }, { "$ref": "#/components/schemas/EventDataUser" } ], "properties": { "changes": { "$ref": "#/components/schemas/EventDataChanges" } } }, "CustomQueryList": { "title": "CustomQueryList", "type": "array", "description": "A list of CustomQuery objects.", "items": { "$ref": "#/components/schemas/CustomQuery" } }, "ApplicationList": { "title": "ApplicationList", "type": "array", "description": "A list of Application objects.", "items": { "$ref": "#/components/schemas/Application" } }, "UserDeviceList": { "title": "UserDeviceList", "type": "array", "description": "A list of UserDevice objects.", "items": { "$ref": "#/components/schemas/UserDevice" } }, "ClientList": { "title": "ClientList", "type": "array", "description": "A list of Client objects.", "items": { "$ref": "#/components/schemas/Client" } }, "EntitlementList": { "title": "EntitlementList", "type": "array", "description": "A list of Entitlement objects.", "items": { "$ref": "#/components/schemas/Entitlement" } }, "DataExportList": { "title": "DataExportList", "type": "array", "description": "A list of DataExport objects.", "items": { "$ref": "#/components/schemas/DataExport" } }, "DomainList": { "title": "DomainList", "type": "array", "description": "A list of Domain objects.", "items": { "$ref": "#/components/schemas/Domain" } }, "IdentityProviderList": { "title": "IdentityProviderList", "type": "array", "description": "A list of IdentityProvider objects.", "items": { "$ref": "#/components/schemas/IdentityProvider" } }, "SubscriptionList": { "title": "SubscriptionList", "type": "array", "description": "A list of Subscription objects.", "items": { "$ref": "#/components/schemas/Subscription" } }, "EnvironmentList": { "title": "EnvironmentList", "type": "array", "description": "A list of Environment objects.", "items": { "$ref": "#/components/schemas/Environment" } }, "RoleList": { "title": "RoleList", "type": "array", "description": "A list of Role objects.", "items": { "$ref": "#/components/schemas/Role" } }, "TeamList": { "title": "TeamList", "type": "array", "description": "A list of Team objects.", "items": { "$ref": "#/components/schemas/Team" } }, "UsageEntryList": { "title": "UsageEntryList", "type": "array", "description": "A list of UsageEntry objects.", "items": { "$ref": "#/components/schemas/UsageEntry" } } }, "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" } }, "examples": { "ITEM_NOT_FOUND": { "value": { "success": false, "description": "\"%s\" Not Found", "code": 404 } }, "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 } }, "USER_NOT_ADMIN": { "value": { "success": false, "description": "You are not authorized to perform this action. Please contact your organization administrator.", "code": 403 } }, "NOT_FOUND": { "value": { "success": false, "description": "Resource Not Found", "code": 404 } }, "PARAM_REQUIRED": { "value": { "success": false, "description": "\"%s\" is a required parameter.", "code": 400, "internalCode": 77 } }, "FORBIDDEN": { "value": { "success": false, "description": "You do not have access privileges to view this content.", "code": 403 } }, "LOGIN_REQUIRED": { "value": { "success": false, "description": "Sign-in Required", "code": 401 } }, "PARAM_INVALID": { "value": { "success": false, "description": "\"%s\" contained an invalid value.", "code": 400, "internalCode": 74 } } } }, "paths": { "/user/query": { "parameters": [] }, "/user/pref": { "parameters": [], "put": { "summary": "Axway Update a Single User Preference", "description": "This will store a user preference setting on the user record\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "tags": [ "user" ], "operationId": "user_updatePref", "responses": { "204": { "description": "No Content" }, "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" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "pref": { "type": "string", "description": "The preference you are saving" }, "value": { "type": "string", "description": "The value of the preference you are saving" } }, "required": [ "pref", "value" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/user/organizations": { "parameters": [], "get": { "summary": "Axway Get Organizations", "description": "Returns all the organizations that the signed-in user belongs to.\n\n___Auth Requirement___\n\nStaff, support, or auth token access for a guid or email to be given.\n\n_Allows consumer organization access_\n", "tags": [ "user" ], "operationId": "user_findOrgs", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "title": "OrgList", "type": "array", "description": "A list of Org objects.", "items": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Active state of the organization. Organizations become inactive after passing their end date.", "default": true }, "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 } } }, "guid": { "type": "string", "format": "uuid", "description": "GUID identifier for the organization" }, "name": { "type": "string", "description": "Name of the organization.", "minLength": 2, "maxLength": 64, "x-no-tags": true }, "org_id": { "type": "integer", "description": "Identifier for the organization" }, "support_access_code": { "type": "integer", "description": "Support Access Code for the org.", "minimum": 10000, "maximum": 999999 }, "current_users_role": { "type": "string", "description": "Default role of requesting user in the organization." }, "current_users_roles": { "type": "string", "description": "Roles of requesting user in the organization." }, "deletable": { "type": "boolean", "description": "Whether the organization can be deleted by administrator user." }, "multiuser": { "type": "boolean", "description": "Whether the organization contains more than one user." }, "primary": { "type": "boolean", "description": "Whether the requesting user is primary contact of the organization." } } } } } } ] }, "examples": { "UserFindorgs200Example": { "summary": "Default user_findOrgs 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/value" } }, "FORBIDDEN": { "value": { "$ref": "#/components/examples/FORBIDDEN/value" } }, "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/value" } }, "INVALID_EMAIL_DOMAIN": { "value": { "success": false, "description": "Sign-up is not allowed for this email domain.", "code": 400, "internalCode": 14 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "email", "required": false, "schema": { "type": "string", "description": "Optional user email to look up organizations for; otherwise, the signed-in user is used." }, "example": "user@example.com" }, { "in": "query", "name": "guid", "required": false, "schema": { "type": "string", "description": "Optional user guid to look up organizations for; otherwise, the signed-in user is used." }, "example": "example_value" }, { "in": "query", "name": "include_inactive", "required": false, "schema": { "type": "boolean", "description": "Optional boolean for including orgs that are inactive" }, "example": true }, { "in": "query", "name": "provider_guid", "required": false, "schema": { "type": "string", "description": "Optional provider_guid for looking up a user by email." }, "example": "example_value" }, { "in": "query", "name": "roles", "required": false, "schema": { "type": "string", "description": "Optional list for including only orgs where the user is a given role", "enum": [ "administrator", "developer", "auditor", "consumer", "usage_reporter", "api_central_admin" ] }, "example": "administrator" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/user/credentials": { "parameters": [], "put": { "summary": "Axway Set Credentials for Tooling", "description": "Sets the password to be used for tooling access for externally provisioned users.\n\n___Auth Requirement___\n - Signed-in user.\n", "externalDocs": { "description": "Managing Credentials", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html" }, "tags": [ "user" ], "operationId": "user_updateCredentials", "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" } }, "PASSWORD_IN_HISTORY": { "value": { "success": false, "description": "Passwords should not be used recently.", "code": 400 } }, "PASSWORD_USER_INFO": { "value": { "success": false, "description": "Passwords should not contain your name, email address, or other personally identifiable information.", "code": 400, "internalCode": 411 } }, "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": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "force_logout": { "type": "boolean", "description": "Whether to logout other existing sessions for the user" }, "password": { "type": "string", "description": "Password" } }, "required": [ "force_logout", "password" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/usage/automatic": { "parameters": [], "post": { "summary": "Axway Uploads an Automatic Usage Report", "description": "Uploads an automatic usage report for org\n\n___Auth Requirement___\n - _One of_\n - Support access.\n - `administrator`, `api_central_admin`, or `usage_reporter` access to the organization.\n", "externalDocs": { "description": "Usage Reporting Documentation", "url": "https://docs.axway.com/csh?context=222126025" }, "tags": [ "usage" ], "operationId": "usage_uploadAutomatic", "x-max-content-length": 512000, "x-publishes": [ "platform.usage.report" ], "responses": { "202": { "description": "Accepted" }, "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 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_INVALID_REASON": { "value": { "success": false, "description": "\"%s\" contained an invalid value: errors.reasons.undefined.", "code": 400, "internalCode": 747 } }, "USAGE_EVENT_COUNT": { "value": { "success": false, "description": "Usage report file must contain no greater than %d entries.", "code": 400 } }, "FILE_INVALID_TYPE": { "value": { "success": false, "description": "\"file\" contained an invalid value: Not a valid json file.", "code": 400, "internalCode": 747 } }, "FILE_POSSIBLE_XSS": { "value": { "success": false, "description": "\"file\" contained an invalid value: Possible XSS data in the file content.", "code": 400, "internalCode": 747 } }, "USAGE_INVALID_DATE": { "value": { "success": false, "description": "\"file.report\" contained an invalid value: Invalid date in `report` keys.", "code": 400, "internalCode": 747 } }, "USAGE_META_TYPE": { "value": { "success": false, "description": "\"%s\" contained an invalid value: Type \"%s\" is not supported for the field \"%s\".", "code": 400, "internalCode": 747 } }, "USAGE_NO_METRICS": { "value": { "success": false, "description": "\"file\" contained an invalid value: `report` did not include any valid metrics.", "code": 400, "internalCode": 747 } }, "FILE_MISSING": { "value": { "success": false, "description": "\"file\" contained an invalid value: No file attached.", "code": 400, "internalCode": 747 } }, "FILE_MULTIPLE": { "value": { "success": false, "description": "\"file\" contained an invalid value: Multiple files attached.", "code": 400, "internalCode": 747 } }, "FILE_INVALID_MIMETYPE": { "value": { "success": false, "description": "\"file\" contained an invalid value: File type should be application/json.", "code": 400, "internalCode": 747 } }, "FILE_EMPTY": { "value": { "success": false, "description": "\"file\" contained an invalid value: Empty files not allowed.", "code": 400, "internalCode": 747 } }, "FILE_INVALID_EXTENSION": { "value": { "success": false, "description": "\"file\" contained an invalid value: The file extension %s is not allowed.", "code": 400, "internalCode": 747 } }, "FILE_NAME_TOO_LONG": { "value": { "success": false, "description": "\"file\" contained an invalid value: The provided file name too long. Maximum allowed file name length is %d symbols.", "code": 400, "internalCode": 747 } }, "FILE_INVALID_FILENAME": { "value": { "success": false, "description": "\"file\" contained an invalid value: Invalid symbols in the file name.", "code": 400, "internalCode": 747 } }, "FILE_MISSING_FIELDS": { "value": { "success": false, "description": "\"file\" contained an invalid value: Content is missing the required fields: [ %s ].", "code": 400, "internalCode": 747 } }, "FILE_INVALID_DATA_TYPE": { "value": { "success": false, "description": "\"file\" contained an invalid value: Metrics data type invalid for %s: entitlement type %s.", "code": 400, "internalCode": 747 } }, "FORBIDDEN": { "value": { "$ref": "#/components/examples/FORBIDDEN/value" } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/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" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] }, { "BearerClient": [] } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "description": "The usage report file. Max file size is 500 KiB or 4000 reported metrics.", "format": "binary" }, "organizationId": { "type": "string", "description": "Optional guid of an org to upload usage for." }, "uploadMethod": { "type": "string", "description": "Method for usage report upload or entry. Forbidden for automatic reporting.", "enum": [ "automatic", "manual", "entry" ], "default": "automatic" }, "userId": { "type": "string", "description": "Optional user guid for user uploading usage. Defaults to signed-in user." } }, "required": [ "file" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/usage": { "parameters": [], "get": { "summary": "Axway Fetches Usage Reports", "description": "Fetches usage reports for an org\n\n___Auth Requirement___\n - _One of_\n - Support access.\n - `administrator`, `auditor`, or `usage_reporter` access to the organization.\n", "tags": [ "usage" ], "operationId": "usage_find", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/UsageEntryList" } } }, { "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadata" } } } ] }, "examples": { "UsageFind200Example": { "summary": "Default usage_find 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "DATE_RANGE_INVALID": { "value": { "success": false, "description": "startDate must be before endDate", "code": 400 } }, "FORBIDDEN": { "value": { "$ref": "#/components/examples/FORBIDDEN/value" } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/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" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] }, { "BearerClient": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "endDate", "required": false, "schema": { "type": "number", "description": "End of the reporting range; defaults to current time." }, "example": 1.0 }, { "in": "query", "name": "env_guid", "required": false, "schema": { "type": "string", "description": "Environment id", "default": null }, "example": "example_value" }, { "in": "query", "name": "org_id", "required": false, "schema": { "type": "string", "description": "Optional id of an org to find usage reports for. Defaults to finding for the session org." }, "example": "507f1f77bcf86cd799439011" }, { "in": "query", "name": "received", "required": false, "schema": { "type": "boolean", "description": "Whether to query usage uploads based on date received instead of reported period", "default": false }, "example": true }, { "in": "query", "name": "startDate", "required": false, "schema": { "type": "number", "description": "Start of the reporting range; defaults to last 24 hours." }, "example": 1.0 }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string", "description": "Status", "enum": [ "VALIDATING", "VALIDATED", "PROCESSED", "INVALIDATED", "PARTIALLY_ACCEPTED", "MISSING_EVENTS", "INVALID_METRICS", "ENRICHMENT_ERROR", "ANALYTICS_UPLOAD_FAILED", "ANALYTICS_MISSMATCH", "ANALYTICS_ERROR", "INVALID_ENVIRONMENT", "MISSING_FILE" ], "default": null }, "example": "VALIDATING" }, { "in": "query", "name": "uploadMethod", "required": false, "schema": { "type": "string", "description": "Upload method to filter reports by.", "enum": [ "automatic", "manual", "entry" ] }, "example": "automatic" }, { "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": 10 }, "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" } }, "post": { "summary": "Axway Uploads a Usage Report", "description": "Uploads usage report for org\n\n___Auth Requirement___\n - _One of_\n - Support access.\n - `administrator`, `api_central_admin`, or `usage_reporter` access to the organization.\n", "externalDocs": { "description": "Usage Reporting Documentation", "url": "https://docs.axway.com/csh?context=222126025" }, "tags": [ "usage" ], "operationId": "usage_upload", "x-max-content-length": 512000, "x-publishes": [ "platform.usage.report" ], "responses": { "202": { "description": "Accepted" }, "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 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_INVALID_REASON": { "value": { "success": false, "description": "\"%s\" contained an invalid value: errors.reasons.undefined.", "code": 400, "internalCode": 747 } }, "USAGE_EVENT_COUNT": { "value": { "success": false, "description": "Usage report file must contain no greater than %d entries.", "code": 400 } }, "FILE_INVALID_TYPE": { "value": { "success": false, "description": "\"file\" contained an invalid value: Not a valid json file.", "code": 400, "internalCode": 747 } }, "FILE_POSSIBLE_XSS": { "value": { "success": false, "description": "\"file\" contained an invalid value: Possible XSS data in the file content.", "code": 400, "internalCode": 747 } }, "USAGE_INVALID_DATE": { "value": { "success": false, "description": "\"file.report\" contained an invalid value: Invalid date in `report` keys.", "code": 400, "internalCode": 747 } }, "USAGE_META_TYPE": { "value": { "success": false, "description": "\"%s\" contained an invalid value: Type \"%s\" is not supported for the field \"%s\".", "code": 400, "internalCode": 747 } }, "USAGE_NO_METRICS": { "value": { "success": false, "description": "\"file\" contained an invalid value: `report` did not include any valid metrics.", "code": 400, "internalCode": 747 } }, "FILE_MISSING": { "value": { "success": false, "description": "\"file\" contained an invalid value: No file attached.", "code": 400, "internalCode": 747 } }, "FILE_MULTIPLE": { "value": { "success": false, "description": "\"file\" contained an invalid value: Multiple files attached.", "code": 400, "internalCode": 747 } }, "FILE_INVALID_MIMETYPE": { "value": { "success": false, "description": "\"file\" contained an invalid value: File type should be application/json.", "code": 400, "internalCode": 747 } }, "FILE_EMPTY": { "value": { "success": false, "description": "\"file\" contained an invalid value: Empty files not allowed.", "code": 400, "internalCode": 747 } }, "FILE_INVALID_EXTENSION": { "value": { "success": false, "description": "\"file\" contained an invalid value: The file extension %s is not allowed.", "code": 400, "internalCode": 747 } }, "FILE_NAME_TOO_LONG": { "value": { "success": false, "description": "\"file\" contained an invalid value: The provided file name too long. Maximum allowed file name length is %d symbols.", "code": 400, "internalCode": 747 } }, "FILE_INVALID_FILENAME": { "value": { "success": false, "description": "\"file\" contained an invalid value: Invalid symbols in the file name.", "code": 400, "internalCode": 747 } }, "FILE_MISSING_FIELDS": { "value": { "success": false, "description": "\"file\" contained an invalid value: Content is missing the required fields: [ %s ].", "code": 400, "internalCode": 747 } }, "FILE_INVALID_DATA_TYPE": { "value": { "success": false, "description": "\"file\" contained an invalid value: Metrics data type invalid for %s: entitlement type %s.", "code": 400, "internalCode": 747 } }, "FORBIDDEN": { "value": { "$ref": "#/components/examples/FORBIDDEN/value" } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/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" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] }, { "BearerClient": [] } ], "requestBody": { "content": { "multipart/form-data": { "schema": { "properties": { "file": { "type": "string", "description": "The usage report file. Max file size is 500 KiB or 4000 reported metrics.", "format": "binary" }, "organizationId": { "type": "string", "description": "Optional guid of an org to upload usage for." }, "uploadMethod": { "type": "string", "description": "Method for usage report upload or entry. Forbidden for automatic reporting.", "enum": [ "automatic", "manual", "entry" ], "default": "automatic" }, "userId": { "type": "string", "description": "Optional user guid for user uploading usage. Defaults to signed-in user." } }, "required": [ "file" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/team": { "parameters": [], "post": { "summary": "Axway Create a Team", "description": "This will create a team.\n\n___Auth Requirement___\n - `administrator` access to the organization.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Teams", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_teams/index.html" }, "tags": [ "team" ], "operationId": "team_create", "x-publishes": [ "platform.team.create", "platform.team.default" ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/Team" } } } ] }, "examples": { "TeamCreate200Example": { "summary": "Default team_create 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "EXISTING_TEAM_NAME": { "value": { "success": false, "description": "That team name already exists.", "code": 400 } }, "ROLE_NOT_ENABLED": { "value": { "success": false, "description": "\"%s\" is not an allowed role for this organization.", "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": { "*/*": { "schema": { "properties": { "default": { "$ref": "#/components/schemas/Team/properties/default" }, "desc": { "$ref": "#/components/schemas/Team/properties/desc" }, "name": { "$ref": "#/components/schemas/Team/properties/name" }, "org_guid": { "$ref": "#/components/schemas/Team/properties/org_guid" }, "tags": { "$ref": "#/components/schemas/Team/properties/tags" }, "users": { "x-deprecated": "This parameter has been deprecated and will be removed in a future release.", "allOf": [ { "$ref": "#/components/schemas/Team/properties/users" } ], "deprecated": true } }, "required": [ "name" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "get": { "summary": "Axway Get Accessible Teams for the Query", "description": "Return the list of teams for the specified query parameters that can be accessed by this session.\n\n___Auth Requirement___\n - _One of_\n - Auth token.\n - Access to the organization, allowing consumer role.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Teams", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_teams/index.html" }, "tags": [ "team" ], "operationId": "team_find", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/TeamList" } } }, { "properties": { "metadata": { "type": "object", "description": "Result metadata.", "properties": { "query": { "type": "object", "description": "The team query." } } } } }, { "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadata" } } } ] }, "examples": { "TeamFind200Example": { "summary": "Default team_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": [ { "AuthToken": [] }, { "BearerClient": [] }, { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "default", "required": false, "schema": { "$ref": "#/components/schemas/Team/properties/default" }, "example": {} }, { "in": "query", "name": "name", "required": false, "schema": { "$ref": "#/components/schemas/Team/properties/name" }, "example": {} }, { "in": "query", "name": "org_id", "required": false, "schema": { "type": "string", "description": "Optional id of an org to find teams for. Defaults to finding for the session org." }, "example": "507f1f77bcf86cd799439011" }, { "in": "query", "name": "tag", "required": false, "schema": { "$ref": "#/components/schemas/Team/properties/tags/items" }, "example": {} }, { "in": "query", "name": "user_guid", "required": false, "schema": { "type": "string", "description": "Optional GUID of a user to find teams for. When called by non-admin users this will only include teams the calling user also belongs to." }, "example": "example_value" }, { "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." }, "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 }, { "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" } } }, "/session/query": { "parameters": [], "post": { "summary": "Axway Find Sessions", "description": "Return sessions matching search criteria.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Viewing Sessions", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/viewing_and_editing_accounts/index.html" }, "tags": [ "session" ], "operationId": "session_query", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "title": "SessionList", "type": "array", "description": "A list of Session objects.", "items": { "type": "object", "properties": { "dvid": { "type": "string", "description": "Identifier for the device authorized for the session." }, "from": { "type": "string", "description": "Type of client the session was initiated by, e.g. web/cli" }, "ipaddress": { "type": "object", "description": "IP Address the session was created from, anonymized to the Class C block." }, "os": { "type": "object", "description": "Name and version of the device the session is for.", "properties": { "name": { "type": "string" }, "version": { "type": "string" } } }, "software": { "type": "object", "description": "Name and version of the software session was created using.", "properties": { "name": { "type": "string" }, "version": { "type": "string" } } }, "org": { "type": "object", "required": [ "guid", "name", "org_id" ], "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "properties": { "name": { "type": "string", "description": "Name of the organization.", "minLength": 2, "maxLength": 64, "x-no-tags": true }, "org_id": { "type": "integer", "description": "Identifier for the organization" }, "guid": { "type": "string", "format": "uuid", "description": "GUID identifier for the organization" } } }, "org_id": { "type": "string", "description": "org_id of the signed-in org." }, "org_name": { "type": "string", "description": "Name of the signed-in org." }, "user": { "type": "object", "required": [ "email", "guid" ], "unevaluatedProperties": false, "properties": { "email": { "type": "string", "format": "email", "description": "Email address of the user.", "maxLength": 217 }, "guid": { "type": "string", "description": "GUID of the user." } } }, "current": { "type": "boolean", "description": "Whether this is the current session making the request." } } } } } }, { "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadata" } } } ] }, "examples": { "SessionQuery200Example": { "summary": "Default session_query 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "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" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 250, "description": "Number of results per page. Zero will return an empty result, but the matched count in meta will be returned.", "default": 10 }, "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 }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "array", "description": "Field on which to sort results, may pass multiple comma-separated. Prefix the field name with `-` for descending order.", "items": { "type": "string", "enum": [ "access_token", "created", "dvid", "from", "impersonator_guid", "ipaddress", "is_staff", "org_guid", "os.name", "os.version", "software.name", "software.version", "expires", "lastModified", "session.email", "session.user_guid" ] }, "default": [ "created" ] }, "example": [ "access_token" ] } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "access_token": { "type": "string", "description": "Search by session.access_token" }, "created": { "type": "string", "description": "Search by session.created" }, "from": { "type": "string", "description": "Search by session.from" }, "last_modified": { "type": "string", "description": "Search by lastModified" }, "org_guid": { "type": "string", "description": "Search by session.org_guid" }, "user_email": { "type": "string", "description": "Search by session.email" }, "user_id": { "type": "string", "description": "Search by session.user_guid" } } } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/session": { "parameters": [], "get": { "summary": "Axway Get Session", "description": "Retrieves the active session for the user.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "tags": [ "session" ], "operationId": "session_find", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "type": "object", "properties": { "sessionID": { "type": "string", "description": "The session ID." }, "user_guid": { "type": "string", "description": "GUID of the signed-in user." }, "idp": { "type": "string", "description": "GUID of the Identity Provider used to authenticate the session." }, "created": { "type": "string", "format": "date-time", "description": "Date/time the session was created." }, "org_guid": { "$ref": "#/components/schemas/Org/properties/guid" } } } } } ] }, "examples": { "SessionFind200Example": { "summary": "Default session_find 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/role": { "parameters": [], "get": { "summary": "Axway Get Roles Matching Query", "description": "Return the list of roles for the specified query parameters.", "externalDocs": { "description": "Roles Documentation", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/organization_roles_and_features/index.html" }, "tags": [ "role" ], "operationId": "role_find", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/RoleList" } } } ] }, "examples": { "RoleFind200Example": { "summary": "Default role_find 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/value" } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/value" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "default", "required": false, "schema": { "type": "boolean", "description": "return default roles" }, "example": true }, { "in": "query", "name": "name", "required": false, "schema": { "type": "string", "description": "return role matching this name" }, "example": "Example Name" }, { "in": "query", "name": "org", "required": false, "schema": { "type": "boolean", "description": "return roles assignable at org level" }, "example": true }, { "in": "query", "name": "team", "required": false, "schema": { "type": "boolean", "description": "return roles assignable at team level" }, "example": true } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/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" } } }, "/org/query": { "parameters": [] }, "/org/env": { "parameters": [], "get": { "summary": "Axway Find Organization Environments", "description": "Returns the environments configured for the signed-in user's organization.\n\n___Auth Requirement___\n - `administrator`, `auditor`, `developer`, or `usage_reporter` access to the organization. Developer access may be restricted by the organization environments access control setting.\n", "tags": [ "org" ], "operationId": "org_findEnvs", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/EnvironmentList" } } } ] }, "examples": { "OrgFindenvs200Example": { "summary": "Default org_findEnvs 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_id", "required": false, "schema": { "type": "string", "description": "The `guid` or `org_id` of the organization." }, "example": "507f1f77bcf86cd799439011" }, { "in": "query", "name": "target", "required": false, "schema": { "type": "string", "description": "The target in the UI that the data is being requested for. Filters the results to only environments that include the target.", "enum": [ "api_central" ] }, "example": "api_central" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/org": { "parameters": [] }, "/export": { "parameters": [], "post": { "summary": "Axway Export Data", "description": "Generates an export of the user or org data.\n\n___Auth Requirement___\n - _All of_\n - Signed-in user.\n - _If:_ The parameter `body.org_id` is given.\n - _Then:_ Access to the organization.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Exporting Data", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_organization_settings/changing_org_name_deleting_org/index.html#export-organization-data" }, "tags": [ "export" ], "operationId": "export_create", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "type": "object", "required": [ "guid", "items", "status", "user_guid" ], "additionalProperties": false, "properties": { "_id": { "type": "string", "description": "Document ID of the export.", "readOnly": true, "deprecated": true }, "completed": { "type": "string", "format": "date-time", "description": "Date the export was completed" }, "created": { "$ref": "#/components/schemas/DefaultFields/properties/created" }, "filename": { "type": "string", "format": "url", "description": "Location the export is saved to." }, "guid": { "type": "string", "format": "uuid", "description": "`guid` of the export." }, "items": { "type": "array", "description": "Items included in the export.", "items": { "type": "string", "enum": [ "user_metadata", "user_activity", "user_devices", "orgs", "org_metadata", "org_activity", "subscriptions", "envs", "teams", "apps", "providers", "idps", "domains" ] } }, "org_guid": { "type": "string", "description": "`guid` of the org for org specific exports." }, "status": { "type": "string", "description": "Status of the export.", "default": "pending", "enum": [ "pending", "complete", "failed" ] }, "updated": { "$ref": "#/components/schemas/DefaultFields/properties/updated" }, "user_guid": { "type": "string", "description": "`guid` of the user that initiated the export." } } } } } ] }, "examples": { "ExportCreate200Example": { "summary": "Default export_create 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" } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/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" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] }, { "BearerClient": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "from": { "type": "number", "description": "Starting timestamp to get activity from" }, "items": { "type": "array", "description": "What items to include in the export", "items": { "type": "string" } }, "org_id": { "type": "string", "description": "`guid` or `org_id` of an organization for and org context export" }, "to": { "type": "number", "description": "Ending timestamp to get activity from" } }, "required": [ "items" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "get": { "summary": "Axway Find Exports", "description": "Returns all the exports the user has access to.\n\n___Auth Requirement___\n - _All of_\n - Signed-in user.\n - _If:_ The parameter `query.org_id` is given.\n - _Then:_ Access to the organization.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Exporting Data", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_organization_settings/changing_org_name_deleting_org/index.html#export-organization-data" }, "tags": [ "export" ], "operationId": "export_findAll", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/DataExportList" } } } ] }, "examples": { "ExportFindall200Example": { "summary": "Default export_findAll 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" } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/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" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] }, { "BearerClient": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "org_id", "required": false, "schema": { "type": "string", "description": "`guid` or `org_id` of an organization to find exports for" }, "example": "507f1f77bcf86cd799439011" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/env": { "parameters": [], "post": { "summary": "Axway Create Environment", "description": "Creates an environment.\n\n___Auth Requirement___\n - _One of_\n - Support access.\n - `administrator` access to the organization.\n", "externalDocs": { "description": "Managing Environments", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_environments/index.html" }, "tags": [ "env" ], "operationId": "env_create", "x-publishes": [ "platform.env.create" ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/Environment" } } } ] }, "examples": { "EnvCreate200Example": { "summary": "Default env_create 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" } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/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" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] }, { "BearerClient": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "governance": { "enum": [ "Customer Managed", "Axway Managed" ], "allOf": [ { "$ref": "#/components/schemas/Environment/properties/governance" } ] }, "guid": { "type": "string", "description": "GUID of the environment." }, "isProduction": { "default": false, "allOf": [ { "$ref": "#/components/schemas/Environment/properties/isProduction" } ] }, "name": { "type": "string", "description": "Name of the environment" }, "org_guid": { "type": "string", "description": "GUID of the org" }, "type": { "default": "usage", "allOf": [ { "$ref": "#/components/schemas/Environment/properties/type" } ] }, "url": { "$ref": "#/components/schemas/Environment/properties/url" } }, "required": [ "name" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "get": { "summary": "Axway Find Environments", "description": "Returns a list of environments.\n\n___Auth Requirement___\n - _One of_\n - `administrator`, `auditor`, `developer`, or `usage_reporter` access to the organization. Developer access may be restricted by the organization environments access control setting.\n - Auth token.\n", "externalDocs": { "description": "Managing Environments", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_environments/index.html" }, "tags": [ "env" ], "operationId": "env_find", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/Environment" } } } ] }, "examples": { "EnvFind200Example": { "summary": "Default env_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": [] }, { "AuthToken": [] } ], "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 an organization for which to find environments." }, "example": "example_value" }, { "in": "query", "name": "type", "required": false, "schema": { "description": "Filter environments by type.", "allOf": [ { "$ref": "#/components/schemas/Environment/properties/type" } ] }, "example": "example_value" }, { "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" } } }, "/entitlement": { "parameters": [], "get": { "summary": "Axway Get Entitlement Meta", "description": "Returns entitlement definitions\n\n___Auth Requirement___\n - _One of_\n - Signed-in user.\n - Auth token.\n", "tags": [ "entitlement" ], "operationId": "entitlement_find", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/EntitlementList" } } } ] }, "examples": { "EntitlementFind200Example": { "summary": "Default entitlement_find 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/value" } }, "FORBIDDEN": { "value": { "$ref": "#/components/examples/FORBIDDEN/value" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] }, { "AuthToken": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "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" } } }, "/client": { "parameters": [], "post": { "summary": "Axway Add Service Account", "description": "Register a new service account\n\n___Auth Requirement___\n - `administrator` access to the organization.\n", "externalDocs": { "description": "Managing Service Accounts", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_service_accounts/index.html" }, "tags": [ "client" ], "operationId": "client_create", "x-publishes": [ "platform.client.create" ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "type": "object", "required": [ "guid", "name", "org_guid", "roles", "tags" ], "unevaluatedProperties": false, "allOf": [ { "$ref": "#/components/schemas/DefaultFields" } ], "if": { "type": "object", "title": "Certificate Auth", "required": [ "type" ], "properties": { "type": { "type": "string", "enum": [ "certificate" ] } } }, "then": { "type": "object", "additionalProperties": false, "properties": { "key_id": { "type": "string", "description": "Identifier of the public key used for the client.", "readOnly": true }, "privateKey": { "type": "string", "description": "Private key in PEM format for use with client certificate authentication. Returned when a key pair is generated." } } }, "else": { "type": "object", "title": "Secret Auth", "additionalProperties": false }, "properties": { "_id": { "type": "string", "description": "Document ID of the client.", "readOnly": true, "deprecated": true }, "client_id": { "type": "string", "description": "Identifier of the client to use for authentication." }, "guid": { "type": "string", "format": "uuid", "description": "`guid` of the client." }, "name": { "type": "string", "description": "Name of the client.", "x-no-tags": true }, "org_guid": { "type": "string", "format": "uuid", "description": "`guid` of the organization the client belongs to." }, "roles": { "type": "array", "description": "Array of org-level role identifiers that are assigned to the client.", "default": [], "items": { "type": "string", "enum": [ "administrator", "developer", "auditor", "consumer", "usage_reporter", "api_central_admin" ] } }, "tags": { "type": "array", "description": "Tags assigned to the client.", "default": [], "minItems": 0, "uniqueItems": true, "maxItems": 30, "items": { "type": "string", "maxLength": 40 } }, "type": { "type": "string", "description": "Authentication method for the client.", "default": "secret", "enum": [ "secret", "certificate" ] } } } } } ] }, "examples": { "ClientCreate200Example": { "summary": "Default client_create 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "CLIENT_DUPLICATE_ID": { "value": { "success": false, "description": "A client with this Client ID already exists.", "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": { "*/*": { "schema": { "properties": { "description": { "type": "string", "description": "Description for the use of the client." }, "generateKey": { "type": "boolean", "description": "Whether to generate a keypair to use with client certificate authentication." }, "name": { "$ref": "#/components/schemas/Client/properties/name" }, "org_guid": { "$ref": "#/components/schemas/Client/properties/org_guid" }, "publicKey": { "type": "string", "description": "Public key in PEM format for use with client certificate authentication, used to validate JWT issued by the service account and signed by the private key." }, "roles": { "$ref": "#/components/schemas/Client/properties/roles" }, "secret": { "type": "string", "description": "Secret to use when authenticating using client-secret authentication." }, "tags": { "$ref": "#/components/schemas/Client/properties/tags" }, "teams": { "type": "array", "description": "List of teams and roles to assign the client to.", "items": { "properties": { "guid": { "$ref": "#/components/schemas/Team/properties/guid" }, "roles": { "$ref": "#/components/schemas/Team/properties/users/items/properties/roles" } } } }, "type": { "$ref": "#/components/schemas/Client/properties/type" } }, "required": [ "name", "org_guid", "type" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "get": { "summary": "Axway Get Service Accounts", "description": "Returns all the service accounts for an organization.\n\n___Auth Requirement___\n - Access to the organization. Developer access may be restricted by the organization service accounts access control setting.\n", "externalDocs": { "description": "Managing Service Accounts", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/organizations/managing_organizations/managing_service_accounts/index.html" }, "tags": [ "client" ], "operationId": "client_find", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/ClientList" } } }, { "properties": { "metadata": { "$ref": "#/components/schemas/ResponseMetadata" } } } ] }, "examples": { "ClientFind200Example": { "summary": "Default client_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" } }, "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": "query", "name": "org_id", "required": true, "schema": { "type": "string", "description": "`guid` or `org_id` of the org whose service accounts to return" }, "example": "507f1f77bcf86cd799439011" }, { "in": "query", "name": "roles", "required": false, "schema": { "type": "array", "description": "Search for roles", "items": { "type": "string" }, "default": null }, "example": [ "example_value" ] }, { "in": "query", "name": "term", "required": false, "schema": { "type": "string", "description": "Search term, matches name, email id and role", "default": null }, "example": "example_value" }, { "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." }, "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 }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "array", "description": "Field on which to sort results, may pass multiple comma-separated. Prefix the field name with `-` for descending order.", "items": { "type": "string", "enum": [ "client_id", "name", "role" ] }, "default": [ "name" ] }, "example": [ "client_id" ] } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/validatePassword": { "parameters": [], "post": { "summary": "Axway Validates a User Password", "description": "Validates the supplied password is valid for the signed-in user.\n\n___Auth Requirement___\n - User password.\n\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_validatePassword", "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" } }, "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": [ { "Password": [] }, { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "in": "header", "name": "x-auth-password", "required": true, "schema": { "type": "string", "description": "Password to authorize the request." }, "example": "********" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/terms": { "parameters": [], "put": { "summary": "Axway Accept Terms & Conditions", "description": "Marks acceptance of Terms & Conditions.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_acceptTerms", "x-publishes": [ "platform.terms.accept" ], "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" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "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" } } }, "/auth/switchLoggedInOrg": { "parameters": [], "post": { "summary": "Axway Switch Signed-in Organization", "description": "Changes the current session's organization to another that the signed-in user can access.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_sessionSwitchOrg", "x-publishes": [ "platform.session.create" ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/SessionInfo" } } } ] }, "examples": { "AuthSessionswitchorg200Example": { "summary": "Default auth_sessionSwitchOrg 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/value" } }, "INVALID_SWITCH_ORG": { "value": { "success": false, "description": "You are not a member of this organization or it is no longer active. Please contact your administrator or the Amplify Platform support team.", "code": 400 } }, "USER_NOT_ACTIVATED": { "value": { "success": false, "description": "Your account has not been activated yet. Please check your email.", "code": 400, "internalCode": 3 } }, "IDP_REQUIRED": { "value": { "$ref": "#/components/examples/IDP_REQUIRED/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" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "NO_ACTIVE_ORGS": { "value": { "success": false, "description": "You are not a member of any active organizations. Please contact your administrator or the Amplify Platform support team.", "code": 403, "internalCode": 626 } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "org_id": { "type": "string", "description": "`guid` or `org_id` of the organization to switch the user to." } }, "required": [ "org_id" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/signup": { "parameters": [], "post": { "summary": "Axway Sign Up", "description": "Sign up org and user.\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_signup", "x-publishes": [ "platform.org.create", "platform.activation.send", "platform.subscription.create", "marketplace.consumer.signup" ], "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" } }, "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 } }, "NEW_USER_SIGNUP_INACTIVE": { "value": { "success": false, "description": "You must be a new user to sign up.", "code": 400 } }, "PASSWORD_USER_INFO": { "value": { "success": false, "description": "Passwords should not contain your name, email address, or other personally identifiable information.", "code": 400, "internalCode": 411 } }, "SIGNUP_DISABLED": { "value": { "success": false, "description": "User signup attempts are temporarily disabled.", "code": 400, "internalCode": 430 } }, "PROVIDER_SIGNUP_DISABLED": { "value": { "success": false, "description": "User signups are disabled.", "code": 400, "internalCode": 430 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "requestBody": { "content": { "*/*": { "schema": { "properties": { "admin": { "type": "string", "description": "Email address of the person who will be the org administrator. It cannot be an email address already registered in the platform." }, "firstname": { "type": "string", "description": "First name of org administrator." }, "from": { "type": "string", "description": "Optional flag saying where the request is coming from." }, "lastname": { "type": "string", "description": "Last name of org administrator." }, "onboarding": { "$ref": "#/components/schemas/Org/properties/onboarding" }, "org_name": { "type": "string", "description": "Name of the organization." }, "password": { "type": "string", "description": "Password." }, "provider_guid": { "type": "string", "description": "Optional GUID of a provider marketplace to which the org and user are a consumer." }, "redirect": { "type": "string", "description": "URL to which admin user should be redirected after activation." }, "region": { "type": "string", "description": "Data residency region.", "enum": [ "US", "EU", "AP" ], "default": "US" } }, "required": [ "admin", "firstname", "lastname", "org_name", "password", "provider_guid", "region" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/password_policy": { "parameters": [], "get": { "summary": "Axway Get Effective Password Policy", "description": "Returns the combined most restrictive values for password policies along all organizations a user or provider belongs to and system wide password policy.\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_findPasswordPolicy", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/PasswordPolicy" } } } ] }, "examples": { "AuthFindpasswordpolicy200Example": { "summary": "Default auth_findPasswordPolicy 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" } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "provider_guid", "required": false, "schema": { "type": "string", "description": "Optional GUID of an owning provider if for marketplace consumer context" }, "example": "example_value" }, { "in": "query", "name": "user_guid", "required": false, "schema": { "type": "string", "description": "Optional user guid to look up password policy for." }, "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/onboarding": { "parameters": [], "put": { "summary": "Axway Onboarding Capture", "description": "Capture required onboarding data prior to sessionc creation.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_onboarding", "x-publishes": [ "platform.org.update" ], "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" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "grant", "required": false, "schema": { "type": "string", "description": "Optional grant value for use with Platform IdP" }, "example": "example_value" } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "onboarding": { "type": "object" } }, "required": [ "onboarding" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/mfa/verify": { "parameters": [], "post": { "summary": "Axway Verify an Authorization Code", "description": "Verify an authorization code. The code is expired once verified.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Multi-factor Authentication", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication" }, "tags": [ "auth" ], "operationId": "auth_mfaVerify", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "properties": { "valid": { "type": "boolean" }, "expired": { "type": "boolean" } } } } } ] }, "examples": { "AuthMfaverify200Example": { "summary": "Default auth_mfaVerify 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "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" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "authcode": { "type": "string", "description": "Authorization code to verify." }, "authcode_id": { "type": "string", "description": "guid of the authorization code to verify." }, "purpose": { "type": "string", "description": "Purpose of the authorization code to verify." }, "user_id": { "type": "string", "description": "`guid` of the user to send an authorization code for. Staff only." } }, "required": [ "authcode", "user_id" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/mfa/send": { "parameters": [], "post": { "summary": "Axway Send an Authorization Code", "description": "Send a code for the user to verify using their configured mfa method.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Multi-factor Authentication", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication" }, "tags": [ "auth" ], "operationId": "auth_mfaSend", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "properties": { "guid": { "type": "string", "description": "Identifier for the auth code." } } } } } ] }, "examples": { "AuthMfasend200Example": { "summary": "Default auth_mfaSend 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "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" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "purpose": { "type": "string", "description": "Purpose for the auth code being sent. Any existing auth code for the same purpose will be replaced." }, "template": { "type": "string", "description": "Name of the template for the message sent to the user." }, "user_id": { "type": "string", "description": "`guid` of the user to send an authorization code for. Staff only." } } } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/logout": { "parameters": [], "get": { "summary": "Axway Sign-out", "description": "Destroys the current session and signs the user out.\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_logout", "x-publishes": [ "platform.logout" ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "type": "string", "description": "Signed-in state" } } } ] }, "examples": { "AuthLogout200Example": { "summary": "Default auth_logout 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "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" } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "msg", "required": false, "schema": { "type": "string", "description": "Sign-in message" }, "example": "example_value" }, { "in": "query", "name": "redirect", "required": false, "schema": { "type": "string", "description": "Redirect URL for browsers" }, "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/login": { "parameters": [], "post": { "summary": "Axway Sign-in", "description": "Attempts to sign a user in, creating a session for the user.", "externalDocs": { "description": "Sign In Documentation", "url": "https://docs.axway.com/bundle/platform-management/page/docs/getting_started_with_amplify_platform_management/sign_in/index.html" }, "tags": [ "auth" ], "operationId": "auth_login", "x-publishes": [ "platform.login", "platform.session.create", { "event": "platform.login.failed", "text": "If the sign in is unsuccessful." } ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/SessionInfo" } } } ] }, "examples": { "AuthLogin200Example": { "summary": "Default auth_login 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" } }, "INVALID_LOGIN": { "value": { "success": false, "description": "Invalid username or password.", "code": 400, "internalCode": 2 } }, "INVALID_LOGIN_HOSTNAME": { "value": { "success": false, "description": "Sign-in not supported on this hostname.", "code": 400 } }, "INVALID_LOGIN_USERNAME": { "value": { "success": false, "description": "Username must be a valid email address.", "code": 400, "internalCode": 2 } }, "LOGIN_EXTERNAL_CLI": { "value": { "success": false, "description": "Your account is associated with an external identity provider. Please visit /user/credentials to set tooling credentials for your account.", "code": 400, "internalCode": 12 } }, "LOGIN_EXTERNAL_USER": { "value": { "success": false, "description": "Your account is associated with an external identity provider. Please sign in via the service you created your account with.", "code": 400 } }, "MISSING_PASSWORD": { "value": { "success": false, "description": "User must reset password.", "code": 400, "internalCode": 13 } }, "USER_NOT_ACTIVATED": { "value": { "success": false, "description": "Your account has not been activated yet. Please check your email.", "code": 400, "internalCode": 3 } }, "INVALID_SWITCH_ORG": { "value": { "success": false, "description": "You are not a member of this organization or it is no longer active. Please contact your administrator or the Amplify Platform support team.", "code": 400 } }, "IDP_REQUIRED": { "value": { "$ref": "#/components/examples/IDP_REQUIRED/value" } }, "PROVIDER_CONSUMER_DISABLED": { "value": { "success": false, "description": "Consumer organization access is disabled.", "code": 400, "internalCode": 431 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "USER_NOT_ACTIVE": { "value": { "success": false, "description": "Your account is not active. Please contact your administrator or the Amplify Platform support team.", "code": 401, "internalCode": 4 } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "NO_ACTIVE_ORGS": { "value": { "success": false, "description": "You are not a member of any active organizations. Please contact your administrator or the Amplify Platform support team.", "code": 403, "internalCode": 626 } }, "PENDING_ORG": { "value": { "success": false, "description": "Your organization requires approval. You will be notified by email when the organization is approved.", "code": 403, "internalCode": 7 } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "grant", "required": false, "schema": { "type": "string", "description": "Optional grant value for use with Platform IdP" }, "example": "example_value" } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "from": { "type": "string", "description": "Flag indicating where the sign-in is coming from" }, "org_hint": { "type": "string", "description": "`guid` or `org_id` of an organization to sign in to" }, "password": { "type": "string", "description": "Password" }, "provider_guid": { "type": "string", "description": "guid of an owning provider if for marketplace consumer context" }, "username": { "type": "string", "description": "Username" } }, "required": [ "password", "username" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/impersonate": { "parameters": [], "delete": { "summary": "Axway Unimpersonate User", "description": "Restores session of user impersonating another; accessible by staff or support only.\n\n___Auth Requirement___\n - Signed-in user.\n", "tags": [ "auth" ], "operationId": "auth_unimpersonate", "x-publishes": [ "platform.user.unimpersonate" ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/SessionInfo" } } } ] }, "examples": { "AuthUnimpersonate200Example": { "summary": "Default auth_unimpersonate 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" } }, "INVALID_SWITCH_ORG": { "value": { "success": false, "description": "You are not a member of this organization or it is no longer active. Please contact your administrator or the Amplify Platform support team.", "code": 400 } }, "USER_NOT_ACTIVATED": { "value": { "success": false, "description": "Your account has not been activated yet. Please check your email.", "code": 400, "internalCode": 3 } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/value" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "SOCKET_NOT_ALLOWED": { "value": { "success": false, "description": "This API cannot be accessed via sockets; please use HTTPS.", "code": 403 } }, "NO_ACTIVE_ORGS": { "value": { "success": false, "description": "You are not a member of any active organizations. Please contact your administrator or the Amplify Platform support team.", "code": 403, "internalCode": 626 } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/forgot": { "parameters": [], "post": { "summary": "Axway Send Forgot Password Link", "description": "Send a forgot password link to the user. This will also remove any previous forgot password links for the user.", "tags": [ "auth" ], "operationId": "auth_forgot", "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "PASSWORD_RESET_DISABLED": { "value": { "success": false, "description": "Password reset attempts temporarily disabled.", "code": 400, "internalCode": 429 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "requestBody": { "content": { "*/*": { "schema": { "properties": { "provider_guid": { "type": "string", "description": "GUID of the provider for the user." }, "username": { "type": "string", "description": "Email of the user to request a password reset for" } }, "required": [ "username" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/findSession": { "parameters": [], "get": { "summary": "Axway Retrieves the Current Session", "description": "Returns the current session information.\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Viewing Sessions", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/viewing_and_editing_accounts/index.html" }, "tags": [ "auth" ], "operationId": "auth_sessionFind", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "type": "object", "properties": { "from": { "type": "string", "description": "Type of client the session was initiated by, e.g. web/cli" }, "guid": { "type": "string", "description": "GUID of the signed-in user." }, "idp": { "type": "string", "description": "GUID of the Identity Provider used to authenticate the session." }, "org": { "$ref": "#/components/schemas/Org" }, "org_id": { "type": "string", "description": "org_id of the signed-in org." }, "orgs": { "type": "string", "description": "List of orgs that the user belongs to" }, "provider_org": { "type": "object", "description": "Owning provider organization of the marketplace; included in consumer org sessions only", "properties": { "guid": { "type": "string", "format": "uuid", "description": "GUID identifier for the provider organization" }, "name": { "type": "string", "description": "Name of the provider organization." }, "org_id": { "type": "integer", "description": "Identifier for the provider organization" } } }, "role": { "type": "string", "description": "Current role of the user signed-in with this session.", "enum": [ "administrator", "developer", "auditor", "consumer" ] }, "roles": { "type": "array", "description": "List of roles the user is assigned on the signed-in org.", "items": { "type": "string", "description": "The id of the role.", "enum": [ "administrator", "developer", "auditor", "consumer", "usage_reporter", "api_central_admin" ] } }, "sessionID": { "type": "string", "description": "The session ID." }, "sid": { "type": "string", "description": "Signed session ID." }, "teams": { "$ref": "#/components/schemas/UserTeams" }, "user": { "$ref": "#/components/schemas/User" }, "username": { "type": "string", "description": "Username of the user this session belongs to." } } } } } ] }, "examples": { "AuthSessionfind200Example": { "summary": "Default auth_sessionFind 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "DEVICE_AUTH_REQUIRED": { "value": { "success": false, "description": "Device authorization required.", "code": 400, "internalCode": 232 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } } } } } } }, "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "from", "required": false, "schema": { "type": "string", "description": "Optional flag to limit session look to specific client type." }, "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/deviceauth/resend": { "parameters": [], "post": { "summary": "Axway Resends Device Authorization", "description": "Reset and resend the device authorization.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Multi-factor Authentication", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication" }, "tags": [ "auth" ], "operationId": "auth_deviceauthResend", "responses": { "200": { "$ref": "#/components/responses/SuccessResponse" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "DEVICE_AUTH_DISABLED": { "value": { "success": false, "description": "Multi-factor authentication is disabled", "code": 400 } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/value" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "AUTH_CODE_DISABLED": { "value": { "success": false, "description": "Auth code generation temporarily disabled.", "code": 403 } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/deviceauth": { "parameters": [], "post": { "summary": "Axway Validates a New Sessions Device Authorization", "description": "Validate a new device to the system for the first time\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Multi-factor Authentication", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication" }, "tags": [ "auth" ], "operationId": "auth_deviceauthValidate", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "properties": { "expired": { "type": "boolean" }, "valid": { "type": "boolean" }, "redirect": { "type": "string" } } } } } ] }, "examples": { "AuthDeviceauthvalidate200Example": { "summary": "Default auth_deviceauthValidate 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/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" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "AUTH_CODE_DISABLED": { "value": { "success": false, "description": "Auth code generation temporarily disabled.", "code": 403 } }, "AUTH_CODE_INVALIDATED": { "value": { "success": false, "description": "Auth code validation temporarily disabled.", "code": 403 } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "in": "query", "name": "grant", "required": false, "schema": { "type": "string", "description": "Optional grant value for use with Platform IdP" }, "example": "example_value" } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "code": { "type": "string", "description": "The activation code" }, "remember": { "type": "boolean", "description": "Whether the device authorization should persist for future sign in." } }, "required": [ "code", "remember" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/checkSession": { "parameters": [], "get": { "summary": "Axway Checks if the User is Signed in", "description": "Based on the current session, checks if the user is signed in or not.\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_sessionCheck", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "properties": { "user_id": { "type": "integer" }, "guid": { "type": "string" }, "email": { "type": "string" }, "org_id": { "type": "integer" }, "is_staff": { "type": "boolean" }, "expiry": { "type": "integer" }, "openid": { "type": "string" }, "lastname": { "type": "string" }, "_id": { "type": "string" }, "firstname": { "type": "string" }, "username": { "type": "string" } } } } } ] }, "examples": { "AuthSessioncheck200Example": { "summary": "Default auth_sessionCheck 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/value" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/authenticator": { "parameters": [], "post": { "summary": "Axway Confirm Authenticator App", "description": "Confirms the authenticator app is generating correct auth codes\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Multi-factor Authentication", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication" }, "tags": [ "auth" ], "operationId": "auth_deviceauthConfirm", "x-publishes": [ "platform.user.mfa.app.add" ], "responses": { "204": { "description": "No Content" }, "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" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "code": { "type": "number", "description": "Code generated from the authenticator app." } }, "required": [ "code" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "get": { "summary": "Axway Initiate Authenticator App Setup", "description": "Initiate the setup process for an authenticator app\n\n___Auth Requirement___\n - Signed-in user.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Multi-factor Authentication", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication" }, "tags": [ "auth" ], "operationId": "auth_deviceauthCreate", "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" } } } } } } }, "security": [ { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "$ref": "#/components/parameters/fields", "example": "example_value" }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "delete": { "summary": "Axway Remove Authenticator App", "description": "Removes the current configured authenticator application\n\n___Auth Requirement___\n - User password.\n\n\n_Allows consumer organization access_\n", "externalDocs": { "description": "Managing Multi-factor Authentication", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_accounts/managing_credentials/index.html#manage-multi-factor-authentication" }, "tags": [ "auth" ], "operationId": "auth_deviceauthRemoveApp", "x-publishes": [ "platform.user.mfa.app.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" } }, "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": [ { "Password": [] }, { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "in": "header", "name": "x-auth-password", "required": true, "schema": { "type": "string", "description": "Password to authorize the request." }, "example": "********" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/activate/signup": { "parameters": [], "post": { "summary": "Axway Activate a Signup User", "description": "Attempts to activate a user from signup.", "tags": [ "auth" ], "operationId": "auth_activationSignup", "x-publishes": [ "platform.activation.complete" ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ITEM_NOT_FOUND": { "value": { "$ref": "#/components/examples/ITEM_NOT_FOUND/value" } }, "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/value" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "requestBody": { "content": { "*/*": { "schema": { "properties": { "id": { "type": "string", "description": "GUID of the activation." } }, "required": [ "id" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/activate/resend": { "parameters": [], "post": { "summary": "Axway Resend Activation Link", "description": "Resend an activation link to a user. This will also remove any previous activation records for that user. Either `username` and `org_id` or the `activation_id` params are required.\n\n_Allows consumer organization access_\n", "tags": [ "auth" ], "operationId": "auth_activationResend", "x-publishes": [ "platform.activation.send", "platform.org.user.resent" ], "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_ALREADY_ACTIVATED": { "value": { "success": false, "description": "Your account has already been activated.", "code": 400 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } } } } } } }, "requestBody": { "content": { "*/*": { "schema": { "properties": { "activation_id": { "type": "string", "description": "Guid of the activation record that we want to resend for." }, "org_id": { "type": "string", "description": "Organization from which the activation was resent." }, "provider_guid": { "type": "string", "description": "Provider guid for resending via username." }, "suppressEmail": { "type": "boolean", "description": "Whether to suppress the activation email (requires elevated privileges).", "default": false }, "username": { "type": "string", "description": "Email of the user that needs to be activated." } } } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/activate/forgot": { "parameters": [], "post": { "summary": "Axway Reset User Password", "description": "Attempts to change a user password.", "tags": [ "auth" ], "operationId": "auth_activationForgot", "x-publishes": [ "platform.user.password.change" ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ITEM_NOT_FOUND": { "value": { "$ref": "#/components/examples/ITEM_NOT_FOUND/value" } }, "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/value" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "requestBody": { "content": { "*/*": { "schema": { "properties": { "id": { "type": "string", "description": "GUID of the activation." }, "password": { "type": "string", "description": "New password for the user." } }, "required": [ "id", "password" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/auth/activate": { "parameters": [], "post": { "summary": "Axway Activate a User", "description": "Attempts to activate a user.", "tags": [ "auth" ], "operationId": "auth_activationConfirm", "x-publishes": [ "platform.activation.complete" ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "ITEM_NOT_FOUND": { "value": { "$ref": "#/components/examples/ITEM_NOT_FOUND/value" } }, "USER_REQUIRED": { "value": { "success": false, "description": "User is required.", "code": 400 } }, "FIRSTNAME_LENGTH": { "value": { "success": false, "description": "First name must be at most 50 characters.", "code": 400 } }, "LASTNAME_LENGTH": { "value": { "success": false, "description": "Last name must be at most 50 characters.", "code": 400 } }, "EXPIRED_LINK": { "value": { "success": false, "description": "Link has expired.", "code": 400, "internalCode": 9 } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "requestBody": { "content": { "*/*": { "schema": { "properties": { "firstname": { "type": "string", "description": "First name of the activating user." }, "from": { "type": "string", "description": "Where the request is being made from, for example \"web\"." }, "id": { "type": "string", "description": "GUID of the activation." }, "lastname": { "type": "string", "description": "Last name of the activating user." }, "password": { "type": "string", "description": "New password for the user." } }, "required": [ "firstname", "id", "lastname", "password" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/app": { "parameters": [], "post": { "summary": "Axway Create App", "description": "Adds an app to the platform.\n\n___Auth Requirement___\n - _All of_\n - `administrator` access to the organization.\n - The organization `partners` entitlement includes `analytics`.\n", "tags": [ "app" ], "operationId": "app_create", "x-publishes": [ "platform.app.create" ], "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/Application" } } } ] }, "examples": { "AppCreate200Example": { "summary": "Default app_create 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" } }, "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": { "*/*": { "schema": { "properties": { "description": { "$ref": "#/components/schemas/Application/else/properties/description" }, "guid": { "$ref": "#/components/schemas/Application/properties/guid" }, "name": { "$ref": "#/components/schemas/Application/else/properties/name" }, "org_guid": { "$ref": "#/components/schemas/Application/properties/org_guid" }, "platform": { "$ref": "#/components/schemas/Application/properties/platform" }, "type": { "$ref": "#/components/schemas/Application/properties/type" } }, "required": [ "name", "org_guid", "platform", "type" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } }, "get": { "summary": "Axway Find Apps", "description": "Returns a list of applications for the signed-in user\n\n___Auth Requirement___\n - Access to the organization.\n", "tags": [ "app" ], "operationId": "app_find", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/ApplicationList" } } } ] }, "examples": { "AppFind200Example": { "summary": "Default app_find 200 response", "x-microcks-default": true, "value": "example_value" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/value" } }, "FORBIDDEN": { "value": { "$ref": "#/components/examples/FORBIDDEN/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": [ { "name": "fields", "in": "query", "description": "A list of fields to include in the response.", "schema": { "type": "array", "items": { "type": "string" }, "default": "guid,name,created,created_by,type" }, "example": [ "example_value" ] }, { "$ref": "#/components/parameters/exclude_fields", "example": "example_value" }, { "$ref": "#/components/parameters/add_fields", "example": "example_value" }, { "in": "query", "name": "org_id", "required": false, "schema": { "type": "integer", "description": "Optional org_id to override the signed-in organization." }, "example": 1 }, { "in": "query", "name": "provider_guid", "required": false, "schema": { "type": "string", "description": "Find apps associated to a given marketplace" }, "example": "example_value" }, { "in": "query", "name": "subtype", "required": false, "schema": { "type": "string", "description": "Find apps of a given subtype" }, "example": "example_value" }, { "in": "query", "name": "type", "required": false, "schema": { "type": "string", "description": "Find apps of a given type" }, "example": "example_value" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/analytics/query": { "parameters": [], "get": { "summary": "Axway Analytics Query Using Lexus", "description": "Requests analytics data using lexus queries\n\n___Auth Requirement___\n - _If:_ The parameter `query.app_guid` is given.\n - _Then:_ `write` access to the organization to which the application belongs.\n - _Else:_ Access to the organization.\n", "tags": [ "analytics" ], "operationId": "analytics_query", "responses": { "200": { "$ref": "#/components/responses/AnalyticsResponse" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "FORBIDDEN": { "value": { "$ref": "#/components/examples/FORBIDDEN/value" } }, "PARAM_INVALID": { "value": { "$ref": "#/components/examples/PARAM_INVALID/value" } }, "METHOD_UNSUPPORTED_AGGREGATE": { "value": { "success": false, "description": "\"%s\" contained an invalid value: \"{method}\" is not supported for the field \"{field}\".", "code": 400, "internalCode": 747 } }, "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/value" } }, "LOGIN_REQUIRED": { "value": { "$ref": "#/components/examples/LOGIN_REQUIRED/value" } }, "IDP_REQUIRED": { "value": { "$ref": "#/components/examples/IDP_REQUIRED/value" } }, "USER_NOT_ADMIN": { "value": { "$ref": "#/components/examples/USER_NOT_ADMIN/value" } }, "PARAM_REQUIRED": { "value": { "$ref": "#/components/examples/PARAM_REQUIRED/value" } } } } } } }, "security": [ { "BearerClient": [] }, { "SessionCookie": [] }, { "BearerUser": [] } ], "parameters": [ { "in": "query", "name": "apim_tier", "required": false, "schema": { "type": "string", "description": "Filter tier for APIM subscriptions; for use with apim-orgs preprocessor.", "enum": [ "paid", "trial" ] }, "example": "paid" }, { "in": "query", "name": "app_guid", "required": false, "schema": { "type": "string", "description": "Applications guid to get data for." }, "example": "example_value" }, { "in": "query", "name": "clients", "required": false, "schema": { "type": "array", "description": "Set of publishing clients to query events for; accessible by staff only.", "items": { "type": "string" } }, "example": [ "example_value" ] }, { "in": "query", "name": "cross_org", "required": false, "schema": { "type": "boolean", "description": "Flag to enable cross org queries; accessible by staff only.", "default": false }, "example": true }, { "in": "query", "name": "custom_query", "required": false, "schema": { "type": "string", "description": "Custom query, used for \"custom\" template." }, "example": "example_value" }, { "in": "query", "name": "debug", "required": false, "schema": { "type": "boolean", "description": "Send debug flag with query; accessible by staff only.", "default": false }, "example": true }, { "in": "query", "name": "endpoint", "required": false, "schema": { "type": "string", "description": "Which analytics endpoint to query; accessible by staff only." }, "example": "example_value" }, { "in": "query", "name": "events", "required": false, "schema": { "type": "string", "description": "Comma-separated list of events to match." }, "example": "example_value" }, { "in": "query", "name": "field", "required": false, "schema": { "type": "string", "description": "Field to use for disctinct queries." }, "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": "granularity", "required": false, "schema": { "type": "string", "description": "Type of time granularity", "enum": [ "month", "day", "hour", "minute" ] }, "example": "month" }, { "in": "query", "name": "group_by", "required": false, "schema": { "type": "string", "description": "How the results are grouped, can be an array. A given granularity will be the top level grouping unless its order is specified in `group_by` as \"granularity\"." }, "example": "example_value" }, { "in": "query", "name": "grquantity", "required": false, "schema": { "type": "number", "description": "Interval to use for the granularity" }, "example": 1.0 }, { "in": "query", "name": "include_query", "required": false, "schema": { "type": "string", "description": "Flag to enable inclusion of the lexus query." }, "example": "example_value" }, { "in": "query", "name": "org_id", "required": false, "schema": { "type": "string", "description": "`guid` or `org_id` of the org to query." }, "example": "507f1f77bcf86cd799439011" }, { "in": "query", "name": "platform", "required": false, "schema": { "type": "string", "description": "Platform to get data for." }, "example": "example_value" }, { "in": "query", "name": "post_process", "required": false, "schema": { "type": "boolean", "description": "Flag to enable opting out of post processing." }, "example": true }, { "in": "query", "name": "prefix", "required": false, "schema": { "type": "string", "description": "Prefix for events to query." }, "example": "example_value" }, { "in": "query", "name": "preprocessor", "required": false, "schema": { "type": "string", "description": "Name of preprocessor to run." }, "example": "example_value" }, { "in": "query", "name": "processor", "required": false, "schema": { "type": "string", "description": "Name of processor to run." }, "example": "example_value" }, { "in": "query", "name": "query", "required": true, "schema": { "type": "string", "description": "Named lexus query to make, e.g. installs. Accepts an array of names." }, "example": "example_value" }, { "in": "query", "name": "region", "required": false, "schema": { "type": "string", "description": "Filter cross-org queries by region; for use with apim-orgs preprocessor.", "enum": [ "US", "EU", "AP" ] }, "example": "US" }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string", "description": "Status filtering for Crash Analytics." }, "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": "type", "required": false, "schema": { "type": "string", "description": "Crash type filtering for Crash Analytics." }, "example": "example_value" }, { "in": "query", "name": "username", "required": false, "schema": { "type": "string", "description": "Filter crash events by username." }, "example": "Example Name" } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/analytics/error": { "parameters": [], "post": { "summary": "Axway Report an Error", "description": "Report an error to platform analytics\n\n_Allows consumer organization access_\n", "tags": [ "analytics" ], "operationId": "analytics_error", "responses": { "204": { "description": "No Content" }, "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" } } } } } } }, "requestBody": { "content": { "*/*": { "schema": { "properties": { "message": { "type": "string", "description": "Error message" }, "meta": { "type": "object", "description": "Extra data to include in the report meta" }, "stack": { "type": "string", "description": "Stack trace of the error to report" } }, "required": [ "message", "meta", "stack" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/analytics/custom_query": { "parameters": [], "post": { "summary": "Axway Create a Custom Query", "description": "Creates a custom query for an app/org.\n\n___Auth Requirement___\n - `write` access to the organization.\n", "externalDocs": { "description": "Managing Custom Queries", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_applications/creating_custom_queries/index.html" }, "tags": [ "analytics" ], "operationId": "analytics_customCreate", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/CustomQuery" } } } ] }, "examples": { "AnalyticsCustomcreate200Example": { "summary": "Default analytics_customCreate 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" } }, "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": "query", "name": "org_id", "required": false, "schema": { "type": "integer", "description": "Optional org_id to override the signed-in organization." }, "example": 1 } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "cross_org": { "$ref": "#/components/schemas/CustomQuery/properties/cross_org" }, "field": { "$ref": "#/components/schemas/CustomQuery/properties/field" }, "filters": { "$ref": "#/components/schemas/CustomQuery/properties/filters" }, "granularity": { "$ref": "#/components/schemas/CustomQuery/properties/granularity" }, "groupings": { "$ref": "#/components/schemas/CustomQuery/properties/groupings" }, "grquantity": { "$ref": "#/components/schemas/CustomQuery/properties/grquantity" }, "include": { "$ref": "#/components/schemas/CustomQuery/properties/include" }, "limit": { "$ref": "#/components/schemas/CustomQuery/properties/limit" }, "method": { "$ref": "#/components/schemas/CustomQuery/properties/method" }, "name": { "$ref": "#/components/schemas/CustomQuery/properties/name" }, "offset": { "$ref": "#/components/schemas/CustomQuery/properties/offset" }, "sortField": { "$ref": "#/components/schemas/CustomQuery/properties/sortField" }, "sortOrder": { "$ref": "#/components/schemas/CustomQuery/properties/sortOrder" }, "span": { "$ref": "#/components/schemas/CustomQuery/properties/span" }, "type": { "$ref": "#/components/schemas/CustomQuery/properties/type" }, "unit": { "$ref": "#/components/schemas/CustomQuery/properties/unit" }, "valueFormat": { "$ref": "#/components/schemas/CustomQuery/properties/valueFormat" }, "yAxis": { "$ref": "#/components/schemas/CustomQuery/properties/yAxis" } }, "required": [ "field", "filters", "granularity", "grquantity", "method", "name", "span", "unit" ] } } } }, "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/analytics/custom_queries": { "parameters": [], "get": { "summary": "Axway Find Custom Queries", "description": "Finds all the custom queries a user has access to for a given org.\n\n___Auth Requirement___\n - Access to the organization.\n", "externalDocs": { "description": "Managing Custom Queries", "url": "https://docs.axway.com/bundle/platform-management/page/docs/management_guide/managing_applications/creating_custom_queries/index.html" }, "tags": [ "analytics" ], "operationId": "analytics_customFind", "responses": { "200": { "description": "Response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/Response" }, { "properties": { "result": { "$ref": "#/components/schemas/CustomQueryList" } } } ] }, "examples": { "AnalyticsCustomfind200Example": { "summary": "Default analytics_customFind 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_id", "required": false, "schema": { "type": "integer", "description": "Optional org_id to override the signed-in organization." }, "example": 1 } ], "x-microcks-operation": { "delay": 0, "dispatcher": "FALLBACK" } } }, "/analytics": { "parameters": [], "post": { "summary": "Axway Send Events", "description": "Send analytics events\n\n___Auth Requirement___\n - Service account access token.\n", "tags": [ "telemetry" ], "operationId": "analytics_create", "x-max-content-length": 10240, "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "NOT_FOUND": { "value": { "$ref": "#/components/examples/NOT_FOUND/value" } }, "EVENT_COUNT": { "value": { "success": false, "description": "\"event\" contained an invalid value: Maximum number of %d exceeded.", "code": 400, "internalCode": 747 } }, "EVENT_TYPE": { "value": { "success": false, "description": "\"%s\" contained an invalid value: Only telemetry events are accepted.", "code": 400, "internalCode": 747 } }, "EVENT_INVALID_PRODUCT": { "value": { "success": false, "description": "\"%s\" contained an invalid value: Event %s is not allowed, product \"%s\" is not purchased.", "code": 400, "internalCode": 747 } }, "FORBIDDEN": { "value": { "$ref": "#/components/examples/FORBIDDEN/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" } } } } } }, "413": { "description": "Payload Too Large", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "CONTENT_TOO_LARGE": { "value": { "success": false, "description": "Request content length exceeds %d byte limit.", "code": 413 } } } } } } }, "security": [ { "BearerClient": [] } ], "requestBody": { "content": { "*/*": { "schema": { "properties": { "events": { "type": "array", "description": "List of `v4 Event Spec` events", "items": { "allOf": [ { "$ref": "#/components/schemas/Event" } ], "properties": { "event": { "description": "The name of the event. Must start with `telemetry..`.
Where `` corresponds to a product for which the organization has a subscription or license.
Allowed values are `ACT`, `AEM`, `AIG`, `AISuite`, `AMP`, `AMPI`, `AOB`, `APIB`, `APIM`, `APIMG`, `APIP`, `AWS`, `Automator`, `Azure`, `B2Bi`, `BN`, `Bundle`, `CFT`, `CSOS`, `DI`, `DS`, `DV`, `EBICSC`, `EBICSCORP`, `EBICSG`, `EI`, `EN`, `ESUB`, `FAH`, `FU`, `HBS`, `Hub`, `INTP`, `MFT`, `PEPPOL`, `SC`, `SFC`, `ST`, `STL`, `SV`, `Streams`, `TNT`, `TSIM`, `VA`, `VRS`, `WebEDI`, `ai`, `fc`, `ib`", "pattern": "^telemetry\\.\\w+\\.[\\w.]+(?